ruby_raider 0.3.3 → 0.3.6

data/lib/generators/templates/helpers/driver_helper.tt

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'yaml'
 <% if automation == 'selenium' -%>
+require 'active_support/inflector'
 require 'webdrivers'
 <% else -%>
 require 'appium_lib'
@@ -9,10 +10,8 @@ require_relative 'driver_helper'
 
 module Raider
   module DriverHelper
-    class << self
       attr_reader :driver
 
-      <%= ERB.new(File.read(File.expand_path('./partials/new_driver.tt', __dir__))).result(binding).strip! %>
-    end
+      <%= ERB.new(File.read(File.expand_path('./partials/driver_and_options.tt', __dir__))).result(binding).strip! %>
   end
 end

data/lib/generators/templates/helpers/partials/driver_and_options.tt

@@ -0,0 +1,25 @@
+<% if automation == 'selenium' %>
+      def new_driver(*opts)
+        @config = YAML.load_file('config/config.yml')
+        browser = @config['browser'].to_sym
+        @driver = Selenium::WebDriver.for(browser, capabilities: browser_options(*opts))
+      end
+
+      def browser_options(*opts)
+        opts = opts.empty? ? @config['browser_options'] : opts
+        create_options(*opts)
+      end
+
+      def create_options(*opts)
+        browser = @config['browser'] == :ie ? @config['browser'].to_s.upcase : @config['browser'].to_s.capitalize
+        caps = "Selenium::WebDriver::#{browser}::Options".constantize.new
+        opts.each {|option| caps.add_argument(option) }
+        caps
+      end
+<% else %>
+      def new_driver
+        appium_file = File.join(Dir.pwd, 'appium.txt')
+        caps = Appium.load_appium_txt(file: appium_file)
+        @driver = Appium::Driver.new(caps)
+      end
+<% end %>

data/lib/generators/templates/helpers/partials/quit_driver.tt

@@ -1,8 +1,8 @@
 <% case automation
  when 'selenium' %>
-DriverHelper.driver.quit
+driver.quit
 <% when 'watir' %>
-BrowserHelper.browser.quit
+browser.quit
 <% else %>
-DriverHelper.driver.quit_driver
+driver.quit_driver
 <% end %>

data/lib/generators/templates/helpers/partials/screenshot.tt

@@ -1,8 +1,8 @@
 <% case automation
  when 'selenium' %>
-@driver.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+driver.save_screenshot("allure-results/screenshots/#{example_name}.png")
 <% when 'watir' %>
-@browser.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+browser.screenshot.save("allure-results/screenshots/#{example_name}.png")
 <% else %>
-@driver.screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+driver.screenshot("allure-results/screenshots/#{example_name}.png")
 <% end %>

data/lib/generators/templates/helpers/partials/select_driver.tt

@@ -1,8 +1,8 @@
 <% if automation == 'watir' %>
-@browser = BrowserHelper.new_browser
+new_browser
 <% else %>
-@driver = DriverHelper.new_driver
+new_driver
 <% end %>
 <% if %w[appium_ios].include? automation %>
-@driver.start_driver
+start_driver
 <% end %>

data/lib/generators/templates/helpers/spec_helper.tt

@@ -14,15 +14,15 @@ module Raider
     AllureHelper.configure
     RSpec.configure do |config|
       config.formatter = AllureHelper.formatter
+      <% if automation == 'watir' %>config.include(BrowserHelper)<% else %>config.include(DriverHelper)<% end %>
       config.before(:each) do
         <%= ERB.new(File.read(File.expand_path('./partials/select_driver.tt', __dir__))).result(binding).strip! %>
       end
 
       config.after(:each) do
         example_name = self.class.descendant_filtered_examples.first.description
-        status = self.class.descendant_filtered_examples.first.execution_result.status
         <%= ERB.new(File.read(File.expand_path('./partials/screenshot.tt', __dir__))).result(binding).strip! %>
-        AllureHelper.add_screenshot example_name if status == :failed
+        AllureHelper.add_screenshot example_name
         <%= ERB.new(File.read(File.expand_path('./partials/quit_driver.tt', __dir__))).result(binding).strip! %>
       end
     end

data/lib/ruby_raider.rb

@@ -1,124 +1,9 @@
 # frozen_string_literal: true
 
-require 'thor'
-require 'yaml'
-require_relative 'generators/menu_generator'
-require_relative '../lib/scaffolding/scaffolding'
-require_relative '../lib/utilities/utilities'
+require_relative '../lib/commands/scaffolding_commands'
 
-class RubyRaider < Thor
-  desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
-
-  def new(project_name)
-    MenuGenerator.generate_choice_menu(project_name)
-  end
-
-  desc 'page [PAGE_NAME]', 'Creates a new page object'
-  option :path,
-         type: :string, required: false, desc: 'The path where your page will be created', aliases: '-p'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete the selected page', aliases: '-d'
-
-  def page(name)
-    path = options[:path].nil? ? load_config_path('page') : options[:path]
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_class
-    else
-      Scaffolding.new([name, path]).generate_class
-    end
-  end
-
-  desc 'feature [FEATURE_NAME]', 'Creates a new feature'
-  option :path,
-         type: :string, required: false, desc: 'The path where your feature will be created', aliases: '-p'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete the selected feature', aliases: '-d'
-
-  def feature(name)
-    path = options[:path].nil? ? load_config_path('feature') : options[:path]
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_feature
-    else
-      Scaffolding.new([name, path]).generate_feature
-    end
-  end
-
-  desc 'spec [SPEC_NAME]', 'Creates a new spec'
-  option :path,
-         type: :string, required: false, desc: 'The path where your spec will be created', aliases: '-p'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete the selected spec', aliases: '-d'
-
-  def spec(name)
-    path = options[:path].nil? ? load_config_path('spec') : options[:path]
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_spec
-    else
-      Scaffolding.new([name, path]).generate_spec
-    end
-  end
-
-  desc 'helper [HELPER_NAME]', 'Creates a new helper'
-  option :path,
-         type: :string, required: false, desc: 'The path where your helper will be created', aliases: '-p'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete the selected helper', aliases: '-d'
-
-  def helper(name)
-    path = options[:path].nil? ? load_config_path('helper') : options[:path]
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_helper
-    else
-      Scaffolding.new([name, path]).generate_helper
-    end
-  end
-
-  desc 'path [PATH]', 'Sets the default path for scaffolding'
-  option :feature,
-         type: :boolean, required: false, desc: 'The default path for your features', aliases: '-f'
-  option :helper,
-         type: :boolean, required: false, desc: 'The default path for your helpers', aliases: '-h'
-  option :spec,
-         type: :boolean, required: false, desc: 'The default path for your specs', aliases: '-s'
-  def path(default_path)
-    type = options.empty? ? 'page' : options.keys.first
-    Utilities.new.send("#{type}_path=", default_path)
-  end
-
-  desc 'url [URL]', 'Sets the default url for a project'
-
-  def url(default_url)
-    Utilities.new.url = default_url
-  end
-
-  desc 'browser [BROWSER]', 'Sets the default browser for a project'
-
-  def browser(default_browser)
-    Utilities.new.browser = default_browser
-  end
-
-  desc 'raid', 'It runs all the tests in a project'
-
-  def raid
-    Utilities.new.run
-  end
-
-  desc 'scaffold [SCAFFOLD_NAME]', 'It generates everything needed to start automating'
-  def scaffold(name)
-    if Pathname.new('spec').exist? && !Pathname.new('features').exist?
-      Scaffolding.new([name, load_config_path('spec')]).generate_spec
-      Scaffolding.new([name, load_config_path('page')]).generate_class
-    elsif Pathname.new('features').exist?
-      Scaffolding.new([name, load_config_path('feature')]).generate_feature
-      Scaffolding.new([name, load_config_path('page')]).generate_class
-    else
-      raise 'No features or spec folders where found. We are not sure which type of project you are running'
-    end
-  end
-
-  no_commands do
-    def load_config_path(type)
-      YAML.load_file('config/config.yml')["#{type}_path"] unless YAML.load_file('config/config.yml').nil?
-    end
+class RubyRaider
+  def self.start
+    ScaffoldingCommands.start
   end
 end

data/lib/scaffolding/scaffolding.rb

@@ -5,7 +5,7 @@ require 'thor'
 class Scaffolding < Thor::Group
   include Thor::Actions
 
-  argument :name
+  argument :name, optional: true
   argument :path, optional: true
 
   def self.source_root
@@ -28,6 +28,11 @@ class Scaffolding < Thor::Group
     template('helper.tt', default_path("helpers/#{name}_helper.rb", '_helper.rb'))
   end
 
+  def generate_config
+    template('../../generators/templates/common/config.tt',
+             default_path('config/config.yml', '.yml'))
+  end
+
   def delete_class
     remove_file(default_path("page_objects/pages/#{name}_page.rb", '_page.rb'))
   end
@@ -44,7 +49,11 @@ class Scaffolding < Thor::Group
     remove_file(default_path("helpers/#{name}_helper.rb", '_helper.rb'))
   end
 
+  def delete_config
+    remove_file(default_path('config/config.yml', '.yml'))
+  end
+
   def default_path(standard_path, file_type)
-    path.nil? ? standard_path : "#{path}/#{name}#{file_type}"
+    path ? "#{path}/#{name}#{file_type}" : standard_path
   end
 end

data/lib/utilities/utilities.rb

@@ -38,6 +38,16 @@ class Utilities
     overwrite_yaml
   end
 
+  def browser_options=(*opts)
+    @config['browser_options'] = opts.flatten
+    overwrite_yaml
+  end
+
+  def delete_browser_options
+    @config.delete('browser_options')
+    overwrite_yaml
+  end
+
   def run
     if File.directory? 'spec'
       system 'rspec spec/'

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.3.3'
+  s.version     = '0.3.6'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem has everything you need to start working with test automation'
   s.authors     = ['Agustin Pequeno']

data/spec/scaffolding_spec.rb

@@ -0,0 +1,234 @@
+require 'pathname'
+require 'yaml'
+require_relative '../lib/generators/common_generator'
+require_relative '../lib/commands/scaffolding_commands'
+require_relative 'spec_helper'
+
+describe ScaffoldingCommands do
+  let(:scaffold) { ScaffoldingCommands }
+  let(:name) { 'test' }
+
+  context 'with a spec folder' do
+    before(:all) do
+      ScaffoldingCommands.new.invoke(:config)
+    end
+
+    it 'scaffolds for rspec' do
+      scaffold.new.invoke(:scaffold, nil, %W[#{name}])
+      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+      expect(Pathname.new("spec/#{name}_spec.rb")).to be_file
+    end
+  end
+
+  context 'with a features folder' do
+    it 'scaffolds for cucumber' do
+      FileUtils.mkdir 'features'
+      scaffold.new.invoke(:scaffold, nil, %W[#{name}])
+      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+      expect(Pathname.new("features/#{name}.feature")).to be_file
+    end
+  end
+
+  after(:all) do
+    folders = %w[test config page_objects features]
+    folders.each do |folder|
+      FileUtils.rm_rf(folder)
+    end
+    FileUtils.rm('spec/test_spec.rb') if Pathname.new('spec/test_spec.rb').exist?
+  end
+
+  context 'with path from config file' do
+    before(:all) do
+      ScaffoldingCommands.new.invoke(:config)
+    end
+
+    it 'creates a page' do
+      scaffold.new.invoke(:page, nil, %W[#{name}])
+      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+    end
+
+    it 'creates a feature' do
+      scaffold.new.invoke(:feature, nil, %W[#{name}])
+      expect(Pathname.new("features/#{name}.feature")).to be_file
+    end
+
+    it 'creates a spec' do
+      scaffold.new.invoke(:spec, nil, %W[#{name}])
+      expect(Pathname.new("spec/#{name}_spec.rb")).to be_file
+    end
+
+    it 'creates a helper' do
+      scaffold.new.invoke(:helper, nil, %W[#{name}])
+      expect(Pathname.new("helpers/#{name}_helper.rb")).to be_file
+    end
+
+    it 'deletes a page' do
+      scaffold.new.invoke(:page, nil, %W[#{name}])
+      scaffold.new.invoke(:page, nil, %W[#{name} --delete])
+      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to_not be_file
+    end
+
+    it 'deletes a feature' do
+      scaffold.new.invoke(:feature, nil, %W[#{name}])
+      scaffold.new.invoke(:feature, nil, %W[#{name} --delete])
+      expect(Pathname.new("features/#{name}.feature")).to_not be_file
+    end
+
+    it 'deletes a spec' do
+      scaffold.new.invoke(:spec, nil, %W[#{name}])
+      scaffold.new.invoke(:spec, nil, %W[#{name} --delete])
+      expect(Pathname.new("spec/#{name}_spec.rb")).to_not be_file
+    end
+
+    it 'deletes a helper' do
+      scaffold.new.invoke(:helper, nil, %W[#{name}])
+      scaffold.new.invoke(:helper, nil, %W[#{name} --delete])
+      expect(Pathname.new("helpers/#{name}_helper.rb")).to_not be_file
+    end
+
+    after(:all) do
+      folders = %w[test config page_objects features helpers]
+      folders.each do |folder|
+        FileUtils.rm_rf(folder)
+      end
+      FileUtils.rm('spec/test_spec.rb') if Pathname.new('spec/test_spec.rb').exist?
+    end
+  end
+
+  context 'with path option' do
+    let(:path) { 'test_folder' }
+
+    it 'creates a page' do
+      scaffold.new.invoke(:page, nil, %W[#{name} --path #{path}])
+      expect(Pathname.new("#{path}/#{name}_page.rb")).to be_file
+    end
+
+    it 'creates a feature' do
+      scaffold.new.invoke(:feature, nil, %W[#{name} --path #{path}])
+      expect(Pathname.new("#{path}/#{name}.feature")).to be_file
+    end
+
+    it 'creates a spec' do
+      scaffold.new.invoke(:spec, nil, %W[#{name} --path #{path}])
+      expect(Pathname.new("#{path}/#{name}_spec.rb")).to be_file
+    end
+
+    it 'creates a helper' do
+      scaffold.new.invoke(:helper, nil, %W[#{name} --path #{path}])
+      expect(Pathname.new("#{path}/#{name}_helper.rb")).to be_file
+    end
+
+    after(:each) do
+      FileUtils.rm_rf(path)
+    end
+  end
+
+  context 'changes the default path' do
+    let(:path) { 'test_folder' }
+
+    before(:all) do
+      ScaffoldingCommands.new.invoke(:config)
+    end
+
+    it 'changes the path for pages' do
+      scaffold.new.invoke(:path, nil, %W[#{path}])
+      config = YAML.load_file('config/config.yml')
+      expect(config['page_path']).to eql path
+    end
+
+    it 'changes the path for features' do
+      scaffold.new.invoke(:path, nil, %W[#{path} -f])
+      config = YAML.load_file('config/config.yml')
+      expect(config['feature_path']).to eql path
+    end
+
+    it 'changes the path for specs' do
+      scaffold.new.invoke(:path, nil, %W[#{path} -s])
+      config = YAML.load_file('config/config.yml')
+      expect(config['spec_path']).to eql path
+    end
+
+    it 'creates page' do
+      scaffold.new.invoke(:path, nil, %W[#{path}])
+      scaffold.new.invoke(:page, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}_page.rb")).to be_file
+    end
+
+    it 'creates feature' do
+      scaffold.new.invoke(:path, nil, %W[#{path} -f])
+      scaffold.new.invoke(:feature, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}.feature")).to be_file
+    end
+
+    it 'creates spec' do
+      scaffold.new.invoke(:path, nil, %W[#{path} -s])
+      scaffold.new.invoke(:spec, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}_spec.rb")).to be_file
+    end
+
+    it 'creates spec' do
+      scaffold.new.invoke(:path, nil, %W[#{path} -h])
+      scaffold.new.invoke(:helper, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}_helper.rb")).to be_file
+    end
+
+    after(:all) do
+      folders = %w[test_folder test config]
+      folders.each do |folder|
+        FileUtils.rm_rf(folder)
+      end
+    end
+  end
+
+  context 'updates the config file' do
+    before(:all) do
+      CommonGenerator.new(%w[rspec selenium test]).invoke(:generate_config_file)
+      FileUtils.cp_lr('test/config', './')
+    end
+
+    it 'updates the url' do
+      scaffold.new.invoke(:url, nil, %W[test.com])
+      config = YAML.load_file('config/config.yml')
+      expect(config['url']).to eql 'test.com'
+    end
+
+    it 'updates the browser' do
+      scaffold.new.invoke(:browser, nil, %W[:firefox])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser']).to eql ':firefox'
+    end
+
+    it 'updates the browser and the browser options' do
+      scaffold.new.invoke(:browser, nil, %W[:firefox --opts headless start-maximized start-fullscreen])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser']).to eql ':firefox'
+      expect(config['browser_options']).to eql %W[headless start-maximized start-fullscreen]
+    end
+
+    it 'updates only the browser options' do
+      scaffold.new.invoke(:browser, nil, %W[:firefox --opts headless])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to eql %w[headless]
+    end
+
+    it 'deletes the browser options when passed with the delete parameter' do
+      scaffold.new.invoke(:browser, nil, %W[:firefox --opts headless --delete])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to be_nil
+    end
+
+    it 'deletes the browser options' do
+      scaffold.new.invoke(:browser, nil, %W[:firefox --opts headless])
+      scaffold.new.invoke(:browser, nil, %W[--delete])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to be_nil
+    end
+
+    after(:all) do
+      folders = %w[test config]
+      folders.each do |folder|
+        FileUtils.rm_rf(folder)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.6
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-05 00:00:00.000000000 Z
+date: 2022-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -117,6 +117,9 @@ extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/reek.yml"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
@@ -127,6 +130,8 @@ files:
 - README.md
 - Rakefile
 - bin/raider
+- lib/commands/scaffolding_commands.rb
+- lib/commands/utility_commands.rb
 - lib/generators/automation_generator.rb
 - lib/generators/common_generator.rb
 - lib/generators/cucumber_generator.rb
@@ -167,7 +172,7 @@ files:
 - lib/generators/templates/helpers/driver_helper.tt
 - lib/generators/templates/helpers/partials/allure_imports.tt
 - lib/generators/templates/helpers/partials/allure_requirements.tt
-- lib/generators/templates/helpers/partials/new_driver.tt
+- lib/generators/templates/helpers/partials/driver_and_options.tt
 - lib/generators/templates/helpers/partials/quit_driver.tt
 - lib/generators/templates/helpers/partials/require_automation.tt
 - lib/generators/templates/helpers/partials/screenshot.tt
@@ -190,7 +195,7 @@ files:
 - spec/cucumber_generator_spec.rb
 - spec/helpers_generator_spec.rb
 - spec/rspec_generator_spec.rb
-- spec/ruby_raider_spec.rb
+- spec/scaffolding_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/RubyRaider/ruby_raider
 licenses:

data/lib/generators/templates/helpers/partials/new_driver.tt

@@ -1,12 +0,0 @@
-<% if automation == 'selenium' %>
-      def new_driver(caps = {})
-        browser = YAML.load_file('config/config.yml')['browser'].to_sym
-        @driver = Selenium::WebDriver.for(browser, desired_capabilities: caps)
-      end
-<% else %>
-      def new_driver
-        appium_file = File.join(Dir.pwd, 'appium.txt')
-        caps = Appium.load_appium_txt(file: appium_file)
-        @driver = Appium::Driver.new(caps)
-      end
-<% end %>