ruby_raider 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 045a0c59f5595a6598342955964d1f666dd5a7366794c88e2250f0817fd47558
-  data.tar.gz: 264214ab1455c81dab39b71a96a810d65169eaa8a385c254048a0f4926a7ac35
+  metadata.gz: aa0c6d643c3cde2157842b7627cd91377aab6e76d47f6f4136c14a6999eacedf
+  data.tar.gz: 94105992da2846eb8585d10d8b2c471418b6c8544ef2db948ea3a62c950006d8
 SHA512:
-  metadata.gz: e3bac2468b6064901f66259f96d9b3296a7bc3ccd60636f134b25512522f030327b1999d3bcc0ad5a6802ec69abde7caab7f4fca94e720875eb9625bed9b43a1
-  data.tar.gz: 73d5ef7d7aa9b04e0960457ab750f549302ea087e043e08c4f745364a12cbcb0cd21abfd2b8baf5bf8c040ef50c3e7b623ed8cfa20203e86d27ff9d5ea941e5b
+  metadata.gz: 9ab37f89743262fa6fddfa3a72791e118bfb46f01596177cc488f9900207835ddf4478dd16f53d017ca58d1e11a72f7e4431a64035f25c8958949e1d2934bef9
+  data.tar.gz: ea715071ad366384139705627bf4ad0b5bee9665d3ee3dc4853debc735acea6ebc1ae32860188cf235bb62da47463bb97ac3c17d2509a99f76067fe4500270c5

data/.github/workflows/reek.yml

@@ -0,0 +1,23 @@
+name: Reek Code Review
+
+on: [pull_request]
+
+jobs:
+  reek:
+    name: runner / reek
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
+        with:
+          ruby-version: head
+
+      - name: Check out code
+        uses: actions/checkout@v1
+          
+      - name: reek
+        uses: reviewdog/action-reek@v1
+        with:
+          reek_version: gemfile
+          reporter: github-pr-review # Default is github-pr-check
+          fail_on_error: true

data/.github/workflows/rspec.yml

@@ -0,0 +1,27 @@
+name: Rspec Tests
+
+on:
+  push:
+    branches: [ "*" ]
+  pull_request:
+    branches: [ "*" ]
+
+jobs:
+  build:
+    name: CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
+        with:
+          ruby-version: head
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Build and test with rspec
+        run: bundle exec rspec spec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,28 @@
+name: Rubocop
+
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
+        with:
+          ruby-version: head
+
+      - name: Check out code
+        uses: actions/checkout@v1
+
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v2
+        with:
+          rubocop_version: gemfile
+          rubocop_extensions: rubocop-rspec:gemfile
+          reporter: github-pr-review # Default is github-pr-check
+          fail_on_error: true

data/.rubocop.yml

@@ -1,6 +1,8 @@
+require: rubocop-rspec
+
 AllCops:
   Exclude:
     - './spec/*'
 
 Style/Documentation:
-  Enabled: false
+  Enabled: false

data/README.md

@@ -1,7 +1,11 @@
 # Ruby Raider
 
-This is a gem to make setup and start of UI automation projects easier
-You can find more information and updates on releases in : https://ruby-raider.com/
+[![Gem Version](https://badge.fury.io/rb/ruby_raider.svg)](https://badge.fury.io/rb/ruby_raider)
+[![Rubocop](https://github.com/RubyRaider/ruby_raider/actions/workflows/rspec.yml/badge.svg)](https://github.com/RubyRaider/ruby_raider/actions/workflows/rspec.yml)
+
+This is a gem to make setup and start of UI automation projects easier.
+
+You can find more information and updates on releases in : [https://ruby-raider.com/](https://ruby-raider.com/)
 
 Just do:
 
@@ -11,11 +15,11 @@ then do:
 
 **raider new [name_of_project]**
 
-and you will have a new project in the folder you are in
+and you will have a new project in the folder you are in.
 
 Currently we support:
 
-* Gerating a framework with Cucumber and Selenium
+* Generating a framework with Cucumber and Selenium
 
 * Generating a framework with Rspec and Selenium
 
@@ -27,18 +31,20 @@ Currently we support:
 
 * Generating a framework with Cucumber and Appium for IOS
 
-In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
+In order to run the Appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0).
 
-This works in all the platforms (Tested on Mac OS, Linux and Windows)
+This works in all the platforms (Tested on Mac OS, Linux and Windows).
 
 **Ruby raider provides the following list of commands**
 ```
 Commands:
   raider browser [BROWSER]         # Sets the default browser for a project
   
+  raider browser_options [OPTIONS]  # Sets the browser options for the project
+
   raider feature [FEATURE_NAME]    # Creates a new feature
   
-  raider help [COMMAND]            # Describe available commands or one specific command
+  raider help [COMMAND]            # Describes available commands or one specific command
   
   raider helper [HELPER_NAME]      # Creates a new helper
   
@@ -48,9 +54,9 @@ Commands:
   
   raider path [PATH]               # Sets the default path for scaffolding
   
-  raider raid                      # It runs all the tests in a project
+  raider raid                      # Runs all the tests in a project
   
-  raider scaffold [SCAFFOLD_NAME]  # It generates everything needed to start automating
+  raider scaffold [SCAFFOLD_NAME]  # Generates everything needed to start automating
   
   raider spec [SPEC_NAME]          # Creates a new spec
   
@@ -68,4 +74,4 @@ raider path [PATH_NAME] --spec or -s
 raider path [PATH_NAME] --helper or -h
 ```
 
-If you don't specify an option path will assume you want to change the default path for pages
+If you don't specify an option, path will assume you want to change the default path for pages.

data/Rakefile

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
 require_relative 'lib/ruby_raider'
+require_relative 'lib/commands/scaffolding_commands'
 
-desc 'Create a new test projects'
-task :new, [:name] do |_t, args|
+desc 'Creates a new test project'
+task :new do
   RubyRaider.start
-  RubyRaider.new(args.name)
 end
 
-desc 'Create a page'
-task :page, [:name] do |_t, args|
-  RubyRaider.start
-  RubyRaider.page(args.page)
+desc 'Creates a page'
+task :page, [:name, :path] do |_t, args|
+  ScaffoldingCommands.new.invoke(:page, nil, %W[:#{args.name} --path #{args.path}])
+end
+
+desc 'Sets a browser'
+task :browser, [:type, :options] do |_t, args|
+  ScaffoldingCommands.new.invoke(:browser, nil, %W[:#{args.type} --opts #{args.options}])
 end

data/lib/commands/scaffolding_commands.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative '../generators/menu_generator'
+require_relative '../scaffolding/scaffolding'
+require_relative '../commands/utility_commands'
+
+class ScaffoldingCommands < UtilityCommands
+  desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
+
+  def new(project_name)
+    MenuGenerator.new(project_name).generate_choice_menu
+  end
+
+  map '-n' => 'new'
+
+  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] || load_config_path('page')
+    if options[:delete]
+      Scaffolding.new([name, path]).delete_class
+    else
+      Scaffolding.new([name, path]).generate_class
+    end
+  end
+
+  map '-pg' => 'page'
+
+  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] || load_config_path('feature')
+    if options[:delete]
+      Scaffolding.new([name, path]).delete_feature
+    else
+      Scaffolding.new([name, path]).generate_feature
+    end
+  end
+
+  map '-f' => 'feature'
+
+  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] || load_config_path('spec')
+    if options[:delete]
+      Scaffolding.new([name, path]).delete_spec
+    else
+      Scaffolding.new([name, path]).generate_spec
+    end
+  end
+
+  map '-s' => 'spec'
+
+  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] || load_config_path('helper')
+    if options[:delete]
+      Scaffolding.new([name, path]).delete_helper
+    else
+      Scaffolding.new([name, path]).generate_helper
+    end
+  end
+
+  map '-h' => 'helper'
+
+  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
+    elsif Pathname.new('features').exist?
+      Scaffolding.new([name, load_config_path('feature')]).generate_feature
+    end
+    Scaffolding.new([name, load_config_path('page')]).generate_class
+  end
+
+  map '-sf' => 'scaffold'
+
+  desc 'config', 'Creates configuration file'
+  option :delete,
+         type: :boolean, required: false, desc: 'This will delete the config file', aliases: '-d'
+
+  def config
+    if options[:delete]
+      Scaffolding.new.delete_config
+    else
+      Scaffolding.new.generate_config
+    end
+  end
+
+  map '-c' => 'config'
+
+  no_commands do
+    def load_config_path(type)
+      YAML.load_file('config/config.yml')["#{type}_path"] if YAML.load_file('config/config.yml')
+    end
+  end
+end

data/lib/commands/utility_commands.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative '../utilities/utilities'
+
+class UtilityCommands < Thor
+  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
+
+  map '-p' => 'path'
+
+  desc 'url [URL]', 'Sets the default url for a project'
+
+  def url(default_url)
+    Utilities.new.url = default_url
+  end
+
+  map '-u' => 'url'
+
+  desc 'browser [BROWSER]', 'Sets the default browser for a project'
+  option :opts,
+         type: :array, required: false, desc: 'The options you want your browser to run with', aliases: '-o'
+  option :delete,
+         type: :boolean, required: false, desc: 'This will delete your browser options', aliases: '-d'
+
+  def browser(default_browser = nil)
+    Utilities.new.browser = default_browser if default_browser
+    browser_options(options[:opts]) if options[:opts] || options[:delete]
+  end
+
+  map '-b' => 'browser'
+
+  desc 'browser_options [OPTIONS]', 'Sets the browser options for the project'
+  option :delete,
+         type: :boolean, required: false, desc: 'This will delete your browser options', aliases: '-d'
+
+  def browser_options(*opts)
+    Utilities.new.browser_options = opts unless opts.empty?
+    Utilities.new.delete_browser_options if options[:delete]
+  end
+
+  map '-bo' => 'browser_options'
+
+  desc 'raid', 'It runs all the tests in a project'
+
+  def raid
+    Utilities.new.run
+  end
+
+  map '-r' => 'raid'
+
+  desc 'config', 'Creates a new config file'
+  option :path,
+         type: :string, required: false, desc: 'The path where your config file will be created', aliases: '-p'
+  option :delete,
+         type: :boolean, required: false, desc: 'This will delete the selected config file', aliases: '-d'
+end

data/lib/generators/menu_generator.rb

@@ -8,64 +8,79 @@ require_relative 'helper_generator'
 require_relative 'rspec_generator'
 
 class MenuGenerator
-  class << self
-    def generate_choice_menu(project_name)
-      @cli = HighLine.new
-      @cli.choose do |menu|
-        menu.prompt = 'Please select your automation framework'
-        menu.choice('Selenium') { choose_test_framework('selenium', project_name) }
-        menu.choice('Watir') { choose_test_framework('watir', project_name) }
-        menu.choice('Appium') { choose_test_framework('appium', project_name) }
-        menu.choice('Quit') { exit }
-      end
+  attr_reader :cli, :name, :generators
+
+  def initialize(project_name)
+    @cli = HighLine.new
+    @name = project_name
+    @generators = %w[Automation Common Helpers]
+  end
+
+  def generate_choice_menu
+    @cli.choose do |menu|
+      menu.prompt = 'Please select your automation framework'
+      menu.choice('Selenium') { choose_test_framework('selenium') }
+      menu.choice('Watir') { choose_test_framework('watir') }
+      menu.choice('Appium') { choose_test_framework('appium') }
+      menu.choice('Quit') { exit }
     end
+  end
+
+  def choose_test_framework(automation)
+    system('clear') || system('cls')
+    sleep 0.3
+    automation = automation == 'appium' ? choose_mobile_platform : automation
+    select_test_framework(automation)
+  end
+
+  def set_framework(automation, framework)
+    add_generator framework.capitalize
+    generators.each { |generator| invoke_generator(automation, framework, generator) }
+    system "cd #{name} && gem install bundler && bundle install"
+  end
 
-    def choose_test_framework(automation, project_name)
-      system('clear') || system('cls')
-      sleep 0.3
-      automation = automation == 'appium' ? choose_mobile_platform : automation
-      framework = ''
-      @cli.choose do |menu|
-        menu.prompt = 'Please select your test framework'
-        menu.choice('Rspec') do
-          framework = 'rspec'
-          set_framework(automation, framework, project_name)
-        end
-        menu.choice('Cucumber') do
-          framework = 'cucumber'
-          set_framework(automation, framework, project_name)
-        end
-        menu.choice('Quit') { exit }
-      end
-      @cli.say("You have chosen to use #{framework} with #{automation}")
+  def choose_mobile_platform
+    @cli.choose do |menu|
+      menu.prompt = 'Please select your mobile platform'
+      menu.choice('iOS') { 'appium_ios' }
+      error_handling(menu, 'Android')
+      error_handling(menu, 'Cross Platform')
+      menu.choice('Quit') { exit }
     end
+  end
+
+  protected
 
-    def set_framework(automation, framework, project_name)
-      if framework == 'rspec'
-        RspecGenerator.new([automation, framework, project_name]).invoke_all
-      else
-        CucumberGenerator.new([automation, framework, project_name]).invoke_all
-      end
-      AutomationGenerator.new([automation, framework, project_name]).invoke_all
-      CommonGenerator.new([automation, framework, project_name]).invoke_all
-      HelpersGenerator.new([automation, framework, project_name]).invoke_all
-      system "cd #{project_name} && gem install bundler && bundle install"
+  def add_generator(*opts)
+    opts.each { |opt| @generators.push opt }
+  end
+
+  private
+
+  def framework_choice(invoker, framework, automation_type)
+    invoker.choice(framework) do
+      set_framework(automation_type, framework.downcase)
+      @cli.say("You have chosen to use #{framework} with #{automation_type}")
     end
+  end
 
-    def choose_mobile_platform
-      @cli.choose do |menu|
-        menu.prompt = 'Please select your mobile platform'
-        menu.choice('iOS') { 'appium_ios' }
-        menu.choice('Android') do
-          pp 'Android appium is coming soon. Thank you for the interest'
-          exit
-        end
-        menu.choice('Cross Platform') do
-          pp 'Cross platform appium is coming soon. Thank you for the interest'
-          exit
-        end
-        menu.choice('Quit') { exit }
-      end
+  def error_handling(invoker, platform)
+    invoker.choice(platform) do
+      pp "#{platform} appium is coming soon. Thank you for the interest"
+      exit
     end
   end
+
+  def select_test_framework(automation)
+    @cli.choose do |menu|
+      menu.prompt = 'Please select your test framework'
+      framework_choice(menu, 'Rspec', automation)
+      framework_choice(menu, 'Cucumber', automation)
+      menu.choice('Quit') { exit }
+    end
+  end
+
+  def invoke_generator(automation, framework, generator)
+    Object.const_get("#{generator}Generator").new([automation, framework, name]).invoke_all
+  end
 end

data/lib/generators/templates/cucumber/partials/watir_env.tt

@@ -7,7 +7,7 @@ Before do
 end
 
 After do |scenario|
-  browser.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
+  browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
   browser.quit
 end

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

@@ -16,7 +16,7 @@ module Raider
       def add_screenshot(screenshot_name)
         Allure.add_attachment(
           name: name,
-          source: "File.open(allure-results/screenshots/#{screenshot_name}.png)",
+          source: File.open("allure-results/screenshots/#{screenshot_name}.png"),
           type: Allure::ContentType::PNG,
           test_case: true
         )

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

@@ -9,11 +9,11 @@ module Raider
   module BrowserHelper
       attr_reader :browser
 
-      def new_browser(opts = {})
+      def new_browser(*args)
         @config = YAML.load_file('config/config.yml')
         browser = @config['browser'].to_sym
-        opts = opts.nil? ? @config['browser_options'] : opts
-        @browser = Watir::Browser.new(browser, options: opts)
+        args = args.empty? ? @config['browser_options'] : args
+        @browser = Watir::Browser.new(browser, options: { args: args })
       end
   end
 end

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'
@@ -11,6 +12,6 @@ module Raider
   module DriverHelper
       attr_reader :driver
 
-      <%= ERB.new(File.read(File.expand_path('./partials/new_driver.tt', __dir__))).result(binding).strip! %>
+      <%= 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/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/spec_helper.tt

@@ -21,9 +21,8 @@ module Raider
 
       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,152 +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
-  map '-n' => "new"
-
-  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
-  map '-pg' => "page"
-
-  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
-  map '-f' => "feature"
-
-  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
-  map '-s' => "spec"
-
-  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
-  map '-h' => "helper"
-
-  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
-  map '-p' => "path"
-
-  desc 'url [URL]', 'Sets the default url for a project'
-
-  def url(default_url)
-    Utilities.new.url = default_url
-  end
-  map '-u' => "url"
-
-  desc 'browser [BROWSER]', 'Sets the default browser for a project'
-  option :opts,
-         type: :hash, required: false, desc: 'The options you want your browser to run with', aliases: '-o'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete your browser options', aliases: '-d'
-  def browser(default_browser = nil)
-    Utilities.new.browser = default_browser unless default_browser.nil?
-    Utilities.new.browser_options = options[:opts] unless options[:opts].nil?
-    Utilities.new.delete_browser_options if options[:delete]
-  end
-  map '-b' => "browser"
-
-  desc 'raid', 'It runs all the tests in a project'
-  def raid
-    Utilities.new.run
-  end
-  map '-r' => "raid"
-
-  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
-  map '-sf' => "scaffold"
-
-  desc 'config', 'Creates a new config file'
-  option :path,
-         type: :string, required: false, desc: 'The path where your config file will be created', aliases: '-p'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete the selected config file', aliases: '-d'
-  def config
-    if options[:delete]
-      Scaffolding.new.delete_config
-    else
-      Scaffolding.new.generate_config
-    end
-  end
-  map '-c' => "config"
-
-  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

@@ -30,7 +30,7 @@ class Scaffolding < Thor::Group
 
   def generate_config
     template('../../generators/templates/common/config.tt',
-             default_path("config/config.yml", '.yml'))
+             default_path('config/config.yml', '.yml'))
   end
 
   def delete_class
@@ -50,10 +50,10 @@ class Scaffolding < Thor::Group
   end
 
   def delete_config
-    remove_file(default_path("config/config.yml", '.yml'))
+    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,8 +38,8 @@ class Utilities
     overwrite_yaml
   end
 
-  def browser_options=(opts)
-    @config['browser_options'] = opts
+  def browser_options=(*opts)
+    @config['browser_options'] = opts.flatten
     overwrite_yaml
   end
 

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.3.5'
+  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/{ruby_raider_spec.rb → scaffolding_spec.rb}

@@ -1,60 +1,88 @@
 require 'pathname'
 require 'yaml'
-require_relative 'spec_helper'
-require_relative '../lib/ruby_raider'
 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
 
-describe RubyRaider do
-  let(:raider) { RubyRaider }
-  let(:name) {'test'}
+  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
-      CommonGenerator.new(%w[rspec cucumber test]).invoke(:generate_config_file)
-      FileUtils.cp_lr('test/config', './')
+      ScaffoldingCommands.new.invoke(:config)
     end
 
     it 'creates a page' do
-      raider.new.invoke(:page, nil, %W[#{name}])
+      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
-      raider.new.invoke(:feature, nil, %W[#{name}])
+      scaffold.new.invoke(:feature, nil, %W[#{name}])
       expect(Pathname.new("features/#{name}.feature")).to be_file
     end
 
     it 'creates a spec' do
-      raider.new.invoke(:spec, nil, %W[#{name}])
+      scaffold.new.invoke(:spec, nil, %W[#{name}])
       expect(Pathname.new("spec/#{name}_spec.rb")).to be_file
     end
 
     it 'creates a helper' do
-      raider.new.invoke(:helper, nil, %W[#{name}])
+      scaffold.new.invoke(:helper, nil, %W[#{name}])
       expect(Pathname.new("helpers/#{name}_helper.rb")).to be_file
     end
 
     it 'deletes a page' do
-      raider.new.invoke(:page, nil, %W[#{name}])
-      raider.new.invoke(:page, nil, %W[#{name} --delete])
+      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
-      raider.new.invoke(:feature, nil, %W[#{name}])
-      raider.new.invoke(:feature, nil, %W[#{name} --delete])
+      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
-      raider.new.invoke(:spec, nil, %W[#{name}])
-      raider.new.invoke(:spec, nil, %W[#{name} --delete])
+      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
-      raider.new.invoke(:helper, nil, %W[#{name}])
-      raider.new.invoke(:helper, nil, %W[#{name} --delete])
+      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
 
@@ -71,22 +99,22 @@ describe RubyRaider do
     let(:path) { 'test_folder' }
 
     it 'creates a page' do
-      raider.new.invoke(:page, nil, %W[#{name} --path #{path}])
+      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
-      raider.new.invoke(:feature, nil, %W[#{name} --path #{path}])
+      scaffold.new.invoke(:feature, nil, %W[#{name} --path #{path}])
       expect(Pathname.new("#{path}/#{name}.feature")).to be_file
     end
 
     it 'creates a spec' do
-      raider.new.invoke(:spec, nil, %W[#{name} --path #{path}])
+      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
-      raider.new.invoke(:helper, nil, %W[#{name} --path #{path}])
+      scaffold.new.invoke(:helper, nil, %W[#{name} --path #{path}])
       expect(Pathname.new("#{path}/#{name}_helper.rb")).to be_file
     end
 
@@ -99,49 +127,48 @@ describe RubyRaider do
     let(:path) { 'test_folder' }
 
     before(:all) do
-      CommonGenerator.new(%w[rspec cucumber test]).invoke(:generate_config_file)
-      FileUtils.cp_lr('test/config', './')
+      ScaffoldingCommands.new.invoke(:config)
     end
 
     it 'changes the path for pages' do
-      raider.new.invoke(:path, nil, %W[#{path}])
+      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
-      raider.new.invoke(:path, nil, %W[#{path} -f])
+      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
-      raider.new.invoke(:path, nil, %W[#{path} -s])
+      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
-      raider.new.invoke(:path, nil, %W[#{path}])
-      raider.new.invoke(:page, nil, %W[#{name}])
+      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
-      raider.new.invoke(:path, nil, %W[#{path} -f])
-      raider.new.invoke(:feature, nil, %W[#{name}])
+      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
-      raider.new.invoke(:path, nil, %W[#{path} -s])
-      raider.new.invoke(:spec, nil, %W[#{name}])
+      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
-      raider.new.invoke(:path, nil, %W[#{path} -h])
-      raider.new.invoke(:helper, nil, %W[#{name}])
+      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
 
@@ -160,39 +187,39 @@ describe RubyRaider do
     end
 
     it 'updates the url' do
-      raider.new.invoke(:url, nil, %W[test.com])
+      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
-      raider.new.invoke(:browser, nil, %W[:firefox])
+      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
-      raider.new.invoke(:browser, nil, %W[:firefox --opts headless:test])
+      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 "headless" => "test"
+      expect(config['browser_options']).to eql %W[headless start-maximized start-fullscreen]
     end
 
     it 'updates only the browser options' do
-      raider.new.invoke(:browser, nil, %W[:firefox --opts headless:test])
+      scaffold.new.invoke(:browser, nil, %W[:firefox --opts headless])
       config = YAML.load_file('config/config.yml')
-      expect(config['browser_options']).to eql "headless" => "test"
+      expect(config['browser_options']).to eql %w[headless]
     end
 
     it 'deletes the browser options when passed with the delete parameter' do
-      raider.new.invoke(:browser, nil, %W[:firefox --opts headless:test --delete])
+      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
-      raider.new.invoke(:browser, nil, %W[:firefox --opts headless:test])
-      raider.new.invoke(:browser, nil, %W[--delete])
+      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
@@ -204,36 +231,4 @@ describe RubyRaider do
       end
     end
   end
-
-  context 'scaffolding' do
-    before(:all) do
-      CommonGenerator.new(%w[rspec selenium test]).invoke(:generate_config_file)
-      FileUtils.cp_lr('test/config', './')
-    end
-
-    context 'with a spec folder' do
-      it 'scaffolds for rspec' do
-        raider.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'
-        raider.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
-  end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-17 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,14 +0,0 @@
-<% if automation == 'selenium' %>
-      def new_driver(caps = {})
-        @config = YAML.load_file('config/config.yml')
-        browser = @config['browser'].to_sym
-        caps = caps.nil? ? @config['browser_options'] : caps
-        @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 %>