ruby_raider 0.3.4 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8241d616546918759f985468cc03ff74220a13e2f14215b5a95d8338ae25ce59
-  data.tar.gz: bfd3346375daade458db2d5ff5a0071abe6ddeb6ba48e664a3aef2cccc2258b6
+  metadata.gz: 33e1928965aa6bf627bbfcf504be2873c8c21b749e15ba58a25031edc3247e8b
+  data.tar.gz: d0616127c4d73bfe475df99036a49ad3a412b795ac84f5514ba018ad9fa902ca
 SHA512:
-  metadata.gz: 3a16cdbf3e0dd35cdfa3b68c5a9833083510484673f34fad911adc57be61939a8131ed75119d0e4ba95c4240da4cb997f7d09070bd53212248ebd1224919a563
-  data.tar.gz: 4a575ffc9c5ef8c21a4bf53730e36aa3c0575dd4094dc17992302c369b9ccab307368650cf71ea33ff00d1ca23e7892ec57810df1bec18fba66e96ab468e696a
+  metadata.gz: 32f18b8f33d9beb299bf130e407bad5ca17814e5fa283b87d2eec193c69191b7e9f00a2dfa201a847c3117fd18612ac195c379fbac3655982e4f1b9803694a24
+  data.tar.gz: f3d61d8d65fd5edde333cd9044a3d16e7d37169d1fdbc204996b843fa1f830aa51b303ddad9a37327cf083ea70da5d8d027105805462690b881ad413d9149c06

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/.reek.yml

@@ -1,3 +1,9 @@
 detectors:
   IrresponsibleModule:
-    enabled: false
+    enabled: false
+
+  TooManyStatements:
+    enabled: true
+    exclude:
+      - initialize
+    max_statements: 10

data/.rubocop.yml

@@ -1,6 +1,93 @@
+require: rubocop-rspec
+
 AllCops:
   Exclude:
     - './spec/*'
 
+# Layout
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 999
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  StyleGuide: '#spaces-operators'
+  Enabled: false
+
+# Lint
+
+# Metrics
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/BlockLength:
+  Max: 150
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 500
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 600
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+# Migration
+
+# Naming
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - 'is_'
+
+# Security
+
+# Styles
+
+Style/AsciiComments:
+  Enabled: false
+
 Style/Documentation:
-  Enabled: false
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SafeNavigation:
+  Description: "Use &. instead of checking if an object exists"
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  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,26 +15,36 @@ 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
 
-Currently we only support:
+* Generating a framework with Rspec and Selenium
 
-* 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 Cucumber 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 Watir
 
-This works in all the platforms (Tested on Mac OS, Linux and Windows)
+* Generating a framework with Rspec and Appium for IOS
+
+* 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**
 ```
 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
   
@@ -40,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
   
@@ -60,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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'highline'
+require 'tty-prompt'
 require_relative 'automation_generator'
 require_relative 'common_generator'
 require_relative 'cucumber_generator'
@@ -8,64 +8,70 @@ 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
-    end
+  attr_reader :prompt, :name, :generators
+
+  def initialize(project_name)
+    @prompt = TTY::Prompt.new
+    @name = project_name
+    @generators = %w[Automation Common Helpers]
+  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 generate_choice_menu
+    prompt.select('Please select your automation framework') do |menu|
+      menu.choice :Appium, -> { choose_test_framework('appium') }
+      menu.choice :Selenium, -> { choose_test_framework('selenium') }
+      menu.choice :Watir, -> { choose_test_framework('watir') }
+      menu.choice :Quit, -> { exit }
     end
+  end
+
+  def choose_test_framework(automation)
+    return choose_mobile_platform if automation == 'appium'
 
-    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"
+    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_mobile_platform
+    prompt.select('Please select your mobile platform') do |menu|
+      menu.choice :iOS, -> { choose_test_framework 'appium_ios' }
+      menu.choice :Android, -> { error_handling('Android') }
+      menu.choice :Cross_Platform, -> { error_handling('Cross Platform') }
+      menu.choice :Quit, -> { exit }
     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
+  protected
+
+  def add_generator(*opts)
+    opts.each { |opt| @generators.push opt }
+  end
+
+  private
+
+  def framework_choice(framework, automation_type)
+    set_framework(automation_type, framework.downcase)
+    prompt.say("You have chosen to use #{framework} with #{automation_type}")
+  end
+
+  def error_handling(platform)
+    pp "#{platform} appium is coming soon. Thank you for the interest"
+  end
+
+  def select_test_framework(automation)
+    prompt.select('Please select your test framework') do |menu|
+      menu.choice :Cucumber, -> { framework_choice('Rspec', automation) }
+      menu.choice :Rspec, -> { framework_choice('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/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/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