ruby_raider 0.3.3 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07240bddaf0b3edae4d1d8202df31ac428c143941680f02fb51ea54a8b478d37
-  data.tar.gz: 887a4fc52c2c5899cc5999292a1edd3a357d1ecedbac9dea691edb06f980c6f5
+  metadata.gz: aa0c6d643c3cde2157842b7627cd91377aab6e76d47f6f4136c14a6999eacedf
+  data.tar.gz: 94105992da2846eb8585d10d8b2c471418b6c8544ef2db948ea3a62c950006d8
 SHA512:
-  metadata.gz: d4cf0f65241e104cb96ee22ee79e61a24e049cf834aed0ea0098ea801f64cabe0a037d3846f50c5d60148b50e4a2621fa06329f1a697ea2ee8750b6656c78a49
-  data.tar.gz: ed34541a0df8cf638630d6db03617e1aff99a0fb7432378971ccd371242be91624c3940e94769acc9d5058194b27a946d40c15a955291ff2d5dee5de5d413e55
+  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,39 +15,52 @@ 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:
+
+* Generating a framework with Cucumber and Selenium
+
+* Generating a framework with Rspec and Selenium
 
-Currently we only support:
+* Generating a framework with Cucumber and Watir
 
-* Gerating a Selenium with both Cucumber and Rspec framework
-* Gerating a Watir with both Cucumber and Rspec framework
-* Generating an Appium project with Rspec and Cucumber on IOS
+* Generating a framework with Rspec and Watir
 
-In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
+* Generating a framework with Rspec and Appium for IOS
 
-This works in all the platforms (Tested on Mac OS, Linux and Windows)
+* 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).
+
+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 browser_options [OPTIONS]  # Sets the browser options for the project
 
-  raider feature [FEATURE_NAME]  # Creates a new feature
+  raider feature [FEATURE_NAME]    # Creates a new feature
+  
+  raider help [COMMAND]            # Describes 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                      # Runs all the tests in a project
   
-  raider raid                    # It runs all the tests in a project
+  raider scaffold [SCAFFOLD_NAME]  # 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
@@ -57,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/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/env.tt

@@ -1,8 +1,8 @@
 <% case automation
  when 'selenium' -%>
-<%= ERB.new(File.read(File.expand_path('./partials/selenium_appium_env.tt', __dir__))).result(binding).strip! -%>
+<%= ERB.new(File.read(File.expand_path('./partials/selenium_appium_env.tt', __dir__))).result(binding) %>
 <% when 'watir' -%>
-<%= ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__))).result(binding).strip! -%>
+<%= ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__))).result(binding) %>
 <% else -%>
-<%= ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__))).result(binding).strip! -%>
+<%= ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__))).result(binding) %>
 <% end -%>

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.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  @browser.quit
-end
+  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

@@ -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(*args)
+        @config = YAML.load_file('config/config.yml')
+        browser = @config['browser'].to_sym
+        args = args.empty? ? @config['browser_options'] : args
+        @browser = Watir::Browser.new(browser, options: { args: args })
       end
-    end
   end
 end