ruby_raider 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07240bddaf0b3edae4d1d8202df31ac428c143941680f02fb51ea54a8b478d37
-  data.tar.gz: 887a4fc52c2c5899cc5999292a1edd3a357d1ecedbac9dea691edb06f980c6f5
+  metadata.gz: 8241d616546918759f985468cc03ff74220a13e2f14215b5a95d8338ae25ce59
+  data.tar.gz: bfd3346375daade458db2d5ff5a0071abe6ddeb6ba48e664a3aef2cccc2258b6
 SHA512:
-  metadata.gz: d4cf0f65241e104cb96ee22ee79e61a24e049cf834aed0ea0098ea801f64cabe0a037d3846f50c5d60148b50e4a2621fa06329f1a697ea2ee8750b6656c78a49
-  data.tar.gz: ed34541a0df8cf638630d6db03617e1aff99a0fb7432378971ccd371242be91624c3940e94769acc9d5058194b27a946d40c15a955291ff2d5dee5de5d413e55
+  metadata.gz: 3a16cdbf3e0dd35cdfa3b68c5a9833083510484673f34fad911adc57be61939a8131ed75119d0e4ba95c4240da4cb997f7d09070bd53212248ebd1224919a563
+  data.tar.gz: 4a575ffc9c5ef8c21a4bf53730e36aa3c0575dd4094dc17992302c369b9ccab307368650cf71ea33ff00d1ca23e7892ec57810df1bec18fba66e96ab468e696a

data/README.md

@@ -25,25 +25,28 @@ This works in all the platforms (Tested on Mac OS, Linux and Windows)
 
 **Ruby raider provides the following list of commands**
 ```
-  raider browser [BROWSER]       # Sets the default browser for a project
-
-  raider feature [FEATURE_NAME]  # Creates a new feature
+Commands:
+  raider browser [BROWSER]         # Sets the default browser for a project
+  
+  raider feature [FEATURE_NAME]    # Creates a new feature
+  
+  raider help [COMMAND]            # Describe available commands or one specific command
   
-  raider help [COMMAND]          # Describe available commands or one specific command
+  raider helper [HELPER_NAME]      # Creates a new helper
   
-  raider helper [HELPER_NAME]    # Creates a new helper
+  raider new [PROJECT_NAME]        # Creates a new framework based on settings picked
   
-  raider new [PROJECT_NAME]      # Creates a new framework based on settings picked
+  raider page [PAGE_NAME]          # Creates a new page object
   
-  raider page [PAGE_NAME]        # Creates a new page object
+  raider path [PATH]               # Sets the default path for scaffolding
   
-  raider path [PATH]             # Sets the default path for scaffolding
+  raider raid                      # It runs all the tests in a project
   
-  raider raid                    # It runs all the tests in a project
+  raider scaffold [SCAFFOLD_NAME]  # It generates everything needed to start automating
   
-  raider spec [SPEC_NAME]        # Creates a new spec
+  raider spec [SPEC_NAME]          # Creates a new spec
   
-  raider url [URL]               # Sets the default url for a project
+  raider url [URL]                 # Sets the default url for a project
 ```
 
 It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and

data/lib/generators/templates/common/read_me.tt

@@ -25,25 +25,28 @@ This works in all the platforms (Tested on Mac OS, Linux and Windows)
 
 **Ruby raider provides the following list of commands**
 ```
-  raider browser [BROWSER]       # Sets the default browser for a project
+Commands:
+  raider browser [BROWSER]         # Sets the default browser for a project
 
-  raider feature [FEATURE_NAME]  # Creates a new feature
+  raider feature [FEATURE_NAME]    # Creates a new feature
 
-  raider help [COMMAND]          # Describe available commands or one specific command
+  raider help [COMMAND]            # Describe available commands or one specific command
 
-  raider helper [HELPER_NAME]    # Creates a new helper
+  raider helper [HELPER_NAME]      # Creates a new helper
 
-  raider new [PROJECT_NAME]      # Creates a new framework based on settings picked
+  raider new [PROJECT_NAME]        # Creates a new framework based on settings picked
 
-  raider page [PAGE_NAME]        # Creates a new page object
+  raider page [PAGE_NAME]          # Creates a new page object
 
-  raider path [PATH]             # Sets the default path for scaffolding
+  raider path [PATH]               # Sets the default path for scaffolding
 
-  raider raid                    # It runs all the tests in a project
+  raider raid                      # It runs all the tests in a project
 
-  raider spec [SPEC_NAME]        # Creates a new spec
+  raider scaffold [SCAFFOLD_NAME]  # It generates everything needed to start automating
 
-  raider url [URL]               # Sets the default url for a project
+  raider spec [SPEC_NAME]          # Creates a new spec
+
+  raider url [URL]                 # Sets the default url for a project
 ```
 
 It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and

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

@@ -1,11 +1,13 @@
 require_relative '../../helpers/driver_helper'
 
+include Raider::DriverHelper
+
 Before do
-  @driver = Raider::DriverHelper.new_driver
+  new_driver
 end
 
 After do |scenario|
-  @driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
+  driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  @driver.quit
-end
+  driver.quit
+end

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

@@ -1,12 +1,13 @@
 require_relative '../../helpers/browser_helper'
 
+include Raider::BrowserHelper
+
 Before do
-  Raider::AllureHelper.configure
-  @browser = Raider::BrowserHelper.new_browser
+  new_browser
 end
 
 After do |scenario|
-  @browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
+  browser.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  @browser.quit
-end
+  browser.quit
+end

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

@@ -7,13 +7,13 @@ require 'webdrivers'
 
 module Raider
   module BrowserHelper
-    class << self
       attr_reader :browser
 
-      def new_browser(options = {})
-        browser = YAML.load_file('config/config.yml')['browser'].to_sym
-        @browser = Watir::Browser.new(browser, options: options)
+      def new_browser(opts = {})
+        @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)
       end
-    end
   end
 end

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

@@ -9,10 +9,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
   end
 end

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

@@ -1,6 +1,8 @@
 <% if automation == 'selenium' %>
       def new_driver(caps = {})
-        browser = YAML.load_file('config/config.yml')['browser'].to_sym
+        @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 %>

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") if status == :failed
 <% when 'watir' %>
-@browser.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+browser.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
 <% else %>
-@driver.screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+driver.screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
 <% 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,6 +14,7 @@ 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

data/lib/ruby_raider.rb

@@ -12,6 +12,7 @@ class RubyRaider < Thor
   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,
@@ -27,6 +28,7 @@ class RubyRaider < Thor
       Scaffolding.new([name, path]).generate_class
     end
   end
+  map '-pg' => "page"
 
   desc 'feature [FEATURE_NAME]', 'Creates a new feature'
   option :path,
@@ -42,6 +44,7 @@ class RubyRaider < Thor
       Scaffolding.new([name, path]).generate_feature
     end
   end
+  map '-f' => "feature"
 
   desc 'spec [SPEC_NAME]', 'Creates a new spec'
   option :path,
@@ -57,6 +60,7 @@ class RubyRaider < Thor
       Scaffolding.new([name, path]).generate_spec
     end
   end
+  map '-s' => "spec"
 
   desc 'helper [HELPER_NAME]', 'Creates a new helper'
   option :path,
@@ -72,6 +76,7 @@ class RubyRaider < Thor
       Scaffolding.new([name, path]).generate_helper
     end
   end
+  map '-h' => "helper"
 
   desc 'path [PATH]', 'Sets the default path for scaffolding'
   option :feature,
@@ -84,24 +89,32 @@ class RubyRaider < Thor
     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'
-
-  def browser(default_browser)
-    Utilities.new.browser = default_browser
+  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)
@@ -115,6 +128,21 @@ class RubyRaider < Thor
       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)

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,6 +49,10 @@ 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}"
   end

data/lib/utilities/utilities.rb

@@ -38,6 +38,16 @@ class Utilities
     overwrite_yaml
   end
 
+  def browser_options=(opts)
+    @config['browser_options'] = opts
+    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.4'
   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

@@ -171,6 +171,32 @@ describe RubyRaider do
       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])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser']).to eql ':firefox'
+      expect(config['browser_options']).to eql "headless" => "test"
+    end
+
+    it 'updates only the browser options' do
+      raider.new.invoke(:browser, nil, %W[:firefox --opts headless:test])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser_options']).to eql "headless" => "test"
+    end
+
+    it 'deletes the browser options when passed with the delete parameter' do
+      raider.new.invoke(:browser, nil, %W[:firefox --opts headless:test --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])
+      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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-05 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake