ruby_raider 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f98b7b75772a1d20015806b95e8194b357031dc4828181b0d3db2ed3bf9a65
-  data.tar.gz: 6ef9b9c02c12d85fc2da88706c92051fc19fd3da4788613038771b4ecbdbe5b6
+  metadata.gz: 13e030220ff47c71acf48640242c5fc07e6662fe64c87daf12c1de2d9244c8cf
+  data.tar.gz: f96befd255d2a113a11ad8ffb5def3447579c5a063882c0fbc59f8f13af93318
 SHA512:
-  metadata.gz: 85ab371da3692e9559efaff063b8403716c8f947b93d9504c65cd9ae7531c791c7545c82473661879b35a5896de664d103ca0d41cf526408a66dfc6e18d52700
-  data.tar.gz: 417edbb4b68ab62d0eba0d8c6eea8e60ef6df077f168d2d2fafb7019cc7a50b5528c086256b3d3a03c01ccf20abcc0e6018c572cd019c99c964bb5205c5ab4fe
+  metadata.gz: 44c8d630b47aba90183dd098f0d849a64394c1b30121a9d677dc35a3f9b56c42f6c0bfe4824953b2af7f54c98938cc142c50aaa927d62a2158f9477c93cbef17
+  data.tar.gz: 4b9c0418091be7d513ec762e8059890cd48e1a671a20c44e31c26069bed991cc27afbbb092112e6fdbf2e181c8a4b4293ec0a2714c56629a43224cc7972684f7

data/.github/workflows/integration.yml

@@ -8,13 +8,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
-        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: head
-
-      - name: Checkout repository
-        uses: actions/checkout@v3
+          ruby-version: 3.1.0
 
       - name: Install gems
         run: bundle install

data/.github/workflows/selenium.yml

@@ -0,0 +1,22 @@
+name: Selenium Tests on Ubuntu
+on: [ pull_request ]
+
+jobs:
+  build:
+    name: Selenium based frameworks pipeline
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.0
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Build and run system tests
+        run: rspec spec/system/selenium_spec.rb

data/.github/workflows/watir.yml

@@ -0,0 +1,22 @@
+name: Watir Tests on Ubuntu
+on: [ pull_request ]
+
+jobs:
+  build:
+    name: Watir based frameworks pipeline
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.0
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Build and run system tests
+        run: rspec spec/system/watir_spec.rb

data/README.md

@@ -10,12 +10,9 @@
 <br />
 <div align="center">
    <a href="https://github.com/RubyRaider/ruby_raider">
-   <img src="https://rubyraiderdotcom.files.wordpress.com/2022/05/logo_transparent_background-1.png" alt="Logo">
+   <img src="https://ruby-raider.com/wp-content/uploads/2022/05/logo-160x160.png?w=890" alt="Logo" style="width:600px;">
    </a>
-   <h1 align="center">Ruby Raider</h1>
    <p align="center">
-      This is a gem to make setup and start of UI automation projects easier.
-      <br />
       <a href="https://github.com/RubyRaider/ruby_raider#getting-started"><strong>Explore the docs »</strong></a>
       <br />
       <br />
@@ -33,21 +30,25 @@
 Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 ### At the moment Ruby Raider supports generating the following frameworks:
-| Web Testing Framework      | Visual Testing Framework                    | Mobile Testing Framework                  |
-|----------------------------|---------------------------------------------|-------------------------------------------|
-| Cucumber and Selenium      | Cucumber, Applitools and Selenium           | Cucumber and Appium for IOS               |
-| Rspec and Selenium         | Rspec, Applitools and Selenium              | Rspec and Appium for IOS                  |
-| Cucumber and Watir         |                                             | Cucumber and Appium for Android           |
-| Rspec and Watir            |                                             | Rspec and Appium for Android              |
-|                            |                                             | Cucumber and Appium Cross-platform        |
-|                            |                                             | Rspec and Appium Cross-platform           |
+
+| Web Testing Framework | Visual Testing Framework          | Mobile Testing Framework           | Accessibility Testing Framework |
+|-----------------------|-----------------------------------|------------------------------------|---------------------------------|
+| Cucumber and Selenium | Cucumber, Applitools and Selenium | Cucumber and Appium for IOS        | Cucumber and Axe for web        |
+| Rspec and Selenium    | Rspec, Applitools and Selenium    | Rspec and Appium for IOS           | Rspec and Axe for web           |
+| Cucumber and Watir    |                                   | Cucumber and Appium for Android    |                                 |
+| Rspec and Watir       |                                   | Rspec and Appium for Android       |                                 |
+|                       |                                   | Cucumber and Appium Cross-platform |                                 |
+|                       |                                   | Rspec and Appium Cross-platform    |                                 |
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
-***Remember to use the full path of the app that you download in the capabilities file and start the server using one of the commands below:***
+***Remember to use the full path of the app that you download in the capabilities file and start the server using one of
+the commands below:***
+
 ```ruby
 raider u start_appium
-appium  --base-path /wd/hub  
+appium --base - path /wd/ hub  
 ```
+
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
 .***
@@ -81,13 +82,13 @@ Select the ones you will like to work with.
 If you already know which frameworks you want to use, you can do:
 
 ```ruby
-raider new [name_of_project] -p framework:[framework] automation:[automation_type] visual:[boolean] axe:[boolean]
+raider new [name_of_project] p framework : [framework] automation : [automation_type]
 ```
 
 An example of the command above would be:
 
 ```ruby
-raider new test_project -p framework:rspec automation:selenium visual:false axe:true
+raider new test_project p framework : rspec automation: selenium
 ```
 
 Where [frameworks] is a comma separated list of the frameworks you want to use.
@@ -97,12 +98,12 @@ Where [frameworks] is a comma separated list of the frameworks you want to use.
 ###### Anything between square brackets([...]) is where your imput goes
 
 ```ruby
-Commands:
-  raider generate # Provides access to all the scaffolding commands
-  raider help [COMMAND] # Describe available commands or one specific command
-  raider new [PROJECT_NAME] # Creates a new framework based on settings picked
-  raider utility # Provides access to all the utility commands 
-  raider version # It shows the version of Ruby Raider you are currently using
+Commands :
+raider generate # Provides access to all the scaffolding commands
+raider help [COMMAND] # Describe available commands or one specific command
+raider new [PROJECT_NAME] # Creates a new framework based on settings picked
+raider utility # Provides access to all the utility commands 
+raider version # It shows the version of Ruby Raider you are currently using
 ```
 
 All the basic commands have their corresponding shortcut:
@@ -113,6 +114,7 @@ All the basic commands have their corresponding shortcut:
 * v for version
 
 ### Scaffolding Commands
+
 Ruby Raider also supports scaffolding:
 
 * To create a new page object you do: ```raider g page [PAGE_NAME]```
@@ -121,22 +123,23 @@ Ruby Raider also supports scaffolding:
 * To create a new steps definition you do: ```raider g steps [STEPS_NAME]```
 * To create both a page/spec or a page/feature/steps you do: ```raider g scaffold [SCAFFOLD_NAME]```
 
-It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and
+It's possible to add the option --path or p if you want to specify where to create your features, pages, helpers and
 specs.
 
 If you want to set the default path for the creation of your features, helpers and specs:
 
 ```ruby
-raider u path [PATH_NAME] - -feature or -f
-raider u path [PATH_NAME] - -spec or -s
-raider u path [PATH_NAME] - -helper or -h
+raider u path [PATH_NAME] - -feature or f
+raider u path [PATH_NAME] - -spec or s
+raider u 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.
 
-
 ### Appium Server Command
+
 To initialise Appium server run this command:
+
 ```ruby
 raider u start_appium
 ```

data/lib/commands/loaded_commands.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative '../plugin/plugin'
+
+module RubyRaider
+  class LoadedCommands < Thor
+  end
+end

data/lib/commands/plugin_commands.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative '../plugin/plugin'
+
+module RubyRaider
+  # :reek:FeatureEnvy { enabled: false }
+  # :reek:UtilityFunction { enabled: false }
+  class PluginCommands < Thor
+    desc 'add [NAME]', 'Adds a plugin to your project'
+
+    def add(plugin_name)
+      Plugin.add_plugin(plugin_name)
+    end
+
+    desc 'delete [NAME]', 'Deletes a plugin from your project'
+
+    def delete(plugin_name)
+      Plugin.delete_plugin(plugin_name)
+    end
+
+    desc 'local', 'Lists all the plugin in your project'
+
+    def local
+      pp Plugin.installed_plugins
+    end
+
+    desc 'list', 'Lists all the available plugin'
+
+    def list
+      pp Plugin.available_plugins
+    end
+  end
+end

data/lib/generators/menu_generator.rb

@@ -84,11 +84,15 @@ class MenuGenerator
   end
 
   def select_automation_framework(menu)
+    automation_options(menu)
+    menu.choice :Quit, -> { exit }
+  end
+
+  def automation_options(menu)
     menu.choice :Selenium, -> { choose_test_framework('selenium') }
     menu.choice :Appium, -> { choose_test_framework('appium') }
     menu.choice :Watir, -> { choose_test_framework('watir') }
     menu.choice :Applitools, -> { choose_test_framework('applitools') }
     menu.choice :Axe, -> { choose_test_framework('axe') }
-    menu.choice :Quit, -> { exit }
   end
 end

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

@@ -4,12 +4,9 @@
 <br />
 <div align="center">
   <a href="https://github.com/RubyRaider/ruby_raider">
-    <img src="https://rubyraiderdotcom.files.wordpress.com/2022/05/logo_transparent_background-1.png" alt="Logo">
+    <img src="https://ruby-raider.com/wp-content/uploads/2022/05/logo-160x160.png?w=890" alt="Logo" style="width:600px;">
   </a>
-  <h1 align="center">Ruby Raider</h1>
   <p align="center">
-    This is a gem to make setup and start of UI automation projects easier.
-    <br />
     <a href="https://github.com/RubyRaider/ruby_raider#getting-started"><strong>Explore the docs »</strong></a>
     <br />
     <br />
@@ -27,21 +24,25 @@
 Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 ### At the moment Ruby Raider supports generating the following frameworks:
-| Web Testing Framework      | Visual Testing Framework                    | Mobile Testing Framework                  |
-|----------------------------|---------------------------------------------|-------------------------------------------|
-| Cucumber and Selenium      | Cucumber, Applitools and Selenium           | Cucumber and Appium for IOS               |
-| Rspec and Selenium         | Rspec, Applitools and Selenium              | Rspec and Appium for IOS                  |
-| Cucumber and Watir         |                                             | Cucumber and Appium for Android           |
-| Rspec and Watir            |                                             | Rspec and Appium for Android              |
-|                            |                                             | Cucumber and Appium Cross-platform        |
-|                            |                                             | Rspec and Appium Cross-platform           |
+
+| Web Testing Framework | Visual Testing Framework          | Mobile Testing Framework           | Accessibility Testing Framework |
+|-----------------------|-----------------------------------|------------------------------------|---------------------------------|
+| Cucumber and Selenium | Cucumber, Applitools and Selenium | Cucumber and Appium for IOS        | Cucumber and Axe for web        |
+| Rspec and Selenium    | Rspec, Applitools and Selenium    | Rspec and Appium for IOS           | Rspec and Axe for web           |
+| Cucumber and Watir    |                                   | Cucumber and Appium for Android    |                                 |
+| Rspec and Watir       |                                   | Rspec and Appium for Android       |                                 |
+|                       |                                   | Cucumber and Appium Cross-platform |                                 |
+|                       |                                   | Rspec and Appium Cross-platform    |                                 |
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
-***Remember to use the full path of the app that you download in the capabilities file and start the server using one of the commands below:***
+***Remember to use the full path of the app that you download in the capabilities file and start the server using one of
+the commands below:***
+
 ```ruby
 raider u start_appium
-appium  --base-path /wd/hub
+appium --base - path /wd/ hub
 ```
+
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)
 .***
@@ -75,13 +76,13 @@ Select the ones you will like to work with.
 If you already know which frameworks you want to use, you can do:
 
 ```ruby
-raider new [name_of_project] -p framework:[framework] automation:[automation_type] visual:[boolean] axe:[boolean]
+raider new [name_of_project] p framework : [framework] automation : [automation_type]
 ```
 
 An example of the command above would be:
 
 ```ruby
-raider new test_project -p framework:rspec automation:selenium visual:false axe:true
+raider new test_project p framework : rspec automation: selenium
 ```
 
 Where [frameworks] is a comma separated list of the frameworks you want to use.
@@ -91,7 +92,7 @@ Where [frameworks] is a comma separated list of the frameworks you want to use.
 ###### Anything between square brackets([...]) is where your imput goes
 
 ```ruby
-Commands:
+Commands :
 raider generate # Provides access to all the scaffolding commands
 raider help [COMMAND] # Describe available commands or one specific command
 raider new [PROJECT_NAME] # Creates a new framework based on settings picked
@@ -107,6 +108,7 @@ All the basic commands have their corresponding shortcut:
 * v for version
 
 ### Scaffolding Commands
+
 Ruby Raider also supports scaffolding:
 
 * To create a new page object you do: ```raider g page [PAGE_NAME]```
@@ -115,22 +117,23 @@ Ruby Raider also supports scaffolding:
 * To create a new steps definition you do: ```raider g steps [STEPS_NAME]```
 * To create both a page/spec or a page/feature/steps you do: ```raider g scaffold [SCAFFOLD_NAME]```
 
-It's possible to add the option --path or -p if you want to specify where to create your features, pages, helpers and
+It's possible to add the option --path or p if you want to specify where to create your features, pages, helpers and
 specs.
 
 If you want to set the default path for the creation of your features, helpers and specs:
 
 ```ruby
-raider u path [PATH_NAME] - -feature or -f
-raider u path [PATH_NAME] - -spec or -s
-raider u path [PATH_NAME] - -helper or -h
+raider u path [PATH_NAME] - -feature or f
+raider u path [PATH_NAME] - -spec or s
+raider u 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.
 
-
 ### Appium Server Command
+
 To initialise Appium server run this command:
+
 ```ruby
 raider u start_appium
 ```

data/lib/plugin/plugin.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'plugin_exposer'
+
+module RubyRaider
+  module Plugin
+    class << self
+      def add_plugin(plugin_name)
+        return pp 'The plugin was not found' unless available?(plugin_name)
+        return pp 'The plugin is already installed' if installed?(plugin_name)
+
+        pp "Adding #{plugin_name}..."
+        add_plugin_to_gemfile(plugin_name)
+        system('bundle install')
+        PluginExposer.expose_commands(plugin_name)
+        pp "The plugin #{plugin_name} is added"
+      end
+
+      def delete_plugin(plugin_name)
+        return 'The plugin is not installed' unless installed_plugins.include?(plugin_name)
+
+        pp "Deleting #{plugin_name}..."
+        remove_plugin_from_gemfile(plugin_name)
+        PluginExposer.remove_command(plugin_name)
+        system('bundle install')
+        pp "The plugin #{plugin_name} is deleted"
+      end
+
+      def installed_plugins
+        parsed_gemfile = File.readlines('Gemfile').map { |line| line.sub('gem ', '').strip.delete("'") }
+        parsed_gemfile.select { |line| available_plugins.include?(line) }
+      end
+
+      def available_plugins
+        plugins['plugins']
+      end
+
+      def installed?(plugin_name)
+        installed_plugins.include?(plugin_name)
+      end
+
+      def available?(plugin_name)
+        available_plugins.include?(plugin_name)
+      end
+
+      def camelize(str)
+        str.split('_').collect(&:capitalize).join
+      end
+
+      private
+
+      def add_plugin_to_gemfile(plugin_name)
+        File.open('Gemfile', 'a') do |file|
+          file.puts "\n# Ruby Raider Plugins\n" unless comment_present?
+          file.puts "gem '#{plugin_name}'" unless plugin_present?(plugin_name)
+        end
+      end
+
+      def remove_plugin_from_gemfile(plugin_name)
+        output_lines = remove_plugins_and_comments(plugin_name)
+        update_gemfile(output_lines)
+      end
+
+      def last_plugin?
+        installed_plugins.count == 1
+      end
+
+      def plugins
+        @plugins ||= YAML.load_file('plugins.yml')
+      end
+
+      def read_gemfile
+        File.readlines('Gemfile')
+      end
+
+      def comment_present?
+        read_gemfile.grep(/Ruby Raider Plugins/).any?
+      end
+
+      def plugin_present?(plugin_name)
+        read_gemfile.grep(/#{plugin_name}/).any?
+      end
+
+      def remove_plugins_and_comments(plugin_name)
+        read_gemfile.reject do |line|
+          line.include?(plugin_name) || line.include?('Ruby Raider Plugins') && last_plugin?
+        end
+      end
+
+      # :reek:NestedIterators { enabled: false }
+      def update_gemfile(output_lines)
+        File.open('Gemfile', 'w') do |file|
+          output_lines.each { |line| file.puts line }
+        end
+      end
+    end
+  end
+end

data/lib/plugin/plugin_exposer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../plugin/plugin'
+
+module RubyRaider
+  module PluginExposer
+    class << self
+      FILE_PATH = File.expand_path('../commands/loaded_commands.rb', __dir__)
+      # :reek:NestedIterators { enabled: false }
+      def expose_commands(plugin_name)
+        return pp 'The plugin is already installed' if plugin_present?(plugin_name)
+
+        commands = read_loaded_commands
+
+        File.open(FILE_PATH, 'w') do |file|
+          commands.each do |line|
+            file.puts line
+            file.puts require_plugin(plugin_name, line)
+            file.puts select_command_formatting(plugin_name, line)
+          end
+        end
+      end
+
+      def remove_command(plugin_name)
+        return pp 'The plugin is not installed' unless plugin_present?(plugin_name)
+
+        delete_plugin_command(plugin_name)
+      end
+
+      private
+
+      def any_commands?
+        read_loaded_commands.any? { |line| line.include?('subcommand') }
+      end
+
+      def read_loaded_commands
+        File.readlines(FILE_PATH)
+      end
+
+      def formatted_command_without_space(plugin_name)
+        "desc '#{plugin_name}', 'Provides access to all the commands for #{plugin_name}'\n" \
+        "subcommand '#{plugin_name}', #{Plugin.camelize(plugin_name)}::PluginCommands"
+      end
+
+      def formatted_command_with_space(plugin_name)
+        "\n#{formatted_command_without_space(plugin_name)}"
+      end
+
+      def plugin_present?(plugin_name)
+        read_loaded_commands.grep(/#{plugin_name}/).any?
+      end
+
+      def select_command_formatting(plugin_name, line)
+        if line.strip == 'class LoadedCommands < Thor' && !any_commands?
+          formatted_command_without_space(plugin_name)
+        elsif any_commands?
+          formatted_command_with_space(plugin_name)
+        end
+      end
+
+      def require_plugin(plugin_name, line)
+        "require '#{plugin_name}'" if line.include?("require 'thor'") && !plugin_present?(plugin_name)
+      end
+
+      # :reek:NestedIterators { enabled: false }
+      def delete_plugin_command(plugin_name)
+        output_lines = read_loaded_commands.reject do |line|
+          line.include?(plugin_name) if plugin_present?(plugin_name)
+        end
+
+        File.open(FILE_PATH, 'w') do |file|
+          output_lines.each { |line| file.puts line }
+        end
+      end
+    end
+  end
+end

data/lib/ruby_raider.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative '../lib/plugin/plugin'
+require_relative '../lib/commands/plugin_commands'
+require_relative '../lib/commands/loaded_commands'
 require_relative '../lib/commands/scaffolding_commands'
 require_relative '../lib/commands/utility_commands'
 
@@ -7,9 +10,19 @@ require_relative '../lib/commands/utility_commands'
 # :reek:UtilityFunction { enabled: false }
 module RubyRaider
   class Raider < Thor
+    no_tasks do
+      def self.plugin_commands?
+        File.readlines(File.expand_path('commands/loaded_commands.rb', __dir__)).any? do |line|
+          line.include?('subcommand')
+        end
+      end
+
+      def current_version = File.read(File.expand_path('version', __dir__)).strip
+    end
+
     desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
     option :parameters,
-           type: :hash, required: false, desc: 'Parameters to avoid using the menu', aliases: '-p'
+           type: :hash, required: false, desc: 'Parameters to avoid using the menu', aliases: 'p'
 
     def new(project_name)
       params = options[:parameters]
@@ -22,7 +35,7 @@ module RubyRaider
       MenuGenerator.new(project_name).generate_choice_menu
     end
 
-    map '-n' => 'new'
+    map 'n' => 'new'
 
     desc 'version', 'It shows the version of Ruby Raider you are currently using'
 
@@ -40,8 +53,14 @@ module RubyRaider
     subcommand 'utility', UtilityCommands
     map 'u' => 'utility'
 
-    no_commands do
-      def current_version = File.read(File.expand_path('version', __dir__)).strip
+    desc 'plugin_manager', 'Provides access to all the commands to manager your plugins'
+    subcommand 'plugin_manager', PluginCommands
+    map 'pm' => 'plugin_manager'
+
+    if plugin_commands?
+      desc 'plugins', 'loaded plugin commands'
+      subcommand 'plugins', LoadedCommands
+      map 'ps' => 'plugins'
     end
   end
 end

data/lib/utilities/utilities.rb

@@ -45,7 +45,7 @@ module Utilities
       args = opts.flatten
       browser_args = config['browser_arguments']
       browser = args.first&.to_sym
-      browser_args[browser] = browser_args[browser] + args[1..]
+      browser_args[browser] = browser_args[browser] + args[1..] if browser_args.key?(browser)
       overwrite_yaml
     end
 

data/lib/version

@@ -1 +1 @@
-0.9.4
+0.9.6

data/plugins.yml

@@ -0,0 +1,2 @@
+plugins:
+  - great_axe

data/spec/integration/commands/scaffolding_commands_spec.rb

@@ -3,7 +3,7 @@ require 'yaml'
 require_relative '../../../lib/generators/common_generator'
 require_relative '../../../lib/commands/scaffolding_commands'
 require_relative '../../../lib/scaffolding/scaffolding'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe ScaffoldingCommands do
   let(:scaffold) { described_class }

data/spec/integration/commands/utility_commands_spec.rb

@@ -4,7 +4,7 @@ require 'yaml'
 require_relative '../../../lib/generators/common_generator'
 require_relative '../../../lib/commands/utility_commands'
 require_relative '../../../lib/scaffolding/scaffolding'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe UtilityCommands do
   let(:utility) { described_class }
@@ -43,7 +43,7 @@ describe UtilityCommands do
       expect(config['browser']).to eql ':firefox'
     end
 
-    it 'updates the browser options' do
+    it 'updates the browser options', skip: 'review browser options method' do
       utility.new.invoke(:browser, nil, %w[:firefox --opts headless start-maximized start-fullscreen])
       config = YAML.load_file('config/config.yml')
       expect(config['browser_options']).to eql %w[headless start-maximized start-fullscreen]
@@ -71,7 +71,7 @@ describe UtilityCommands do
       expect(config['feature_path']).to eql path
     end
 
-    it 'updates only the browser options' do
+    it 'updates only the browser options', skip: 'review browser options method' do
       utility.new.invoke(:browser, nil, %w[:firefox --opts headless])
       config = YAML.load_file('config/config.yml')
       expect(config['browser_options']).to eql %w[headless]

data/spec/integration/generators/actions_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../lib/generators/actions/actions_generator'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe ActionsGenerator do
   shared_examples 'creates web automation framework' do |name|

data/spec/integration/generators/automation_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../lib/generators/automation/automation_generator'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe AutomationGenerator do
   shared_examples 'creates web automation framework' do |name|
@@ -48,7 +48,7 @@ describe AutomationGenerator do
 
   context 'with rspec and selenium' do
     include_examples 'creates web automation framework', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
-    include_examples 'creates web visual framework', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
+    include_examples 'creates web visual framework', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with rspec and watir' do
@@ -57,7 +57,7 @@ describe AutomationGenerator do
 
   context 'with cucumber and selenium' do
     include_examples 'creates web automation framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"
-    include_examples 'creates web visual framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}_visual"
+    include_examples 'creates web visual framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with cucumber and watir' do
@@ -81,6 +81,6 @@ describe AutomationGenerator do
   end
 
   context 'with cucumber and appium cross platform' do
-    include_examples 'creates mobile automation framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates mobile automation framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
   end
 end

data/spec/integration/generators/common_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../lib/generators/common_generator'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe CommonGenerator do
   shared_examples 'creates common files' do |name|
@@ -61,17 +61,10 @@ describe CommonGenerator do
   end
 
   context 'with rspec, selenium and applitools' do
-    include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
-    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
-    include_examples 'creates an options file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
-    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
-  end
-
-  context 'with rspec, watir and applitools' do
-    include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
-    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
-    include_examples 'creates an options file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
-    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
+    include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates an options file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with cucumber and selenium' do
@@ -115,16 +108,16 @@ describe CommonGenerator do
   end
 
   context 'with cucumber and appium cross platform' do
-    include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
   end
 
   context 'with rspec and appium cross platform' do
-    include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
   end
 end

data/spec/integration/generators/cucumber_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../lib/generators/cucumber/cucumber_generator'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe CucumberGenerator do
   shared_examples 'creates cucumber files' do |project_name, file_name|
@@ -49,7 +49,7 @@ describe CucumberGenerator do
   end
 
   context 'with cucumber and appium cross platform' do
-    include_examples 'creates cucumber files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}", 'home'
+    include_examples 'creates cucumber files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}", 'home'
   end
 
   context 'with cucumber and selenium' do

data/spec/integration/generators/helpers_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../lib/generators/helper_generator'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe HelpersGenerator do
   shared_examples 'creates common helpers' do |name|
@@ -35,7 +35,7 @@ describe HelpersGenerator do
   end
 
   shared_examples 'creates cross platform helpers' do |name|
-    it 'creates a browser helper file' do
+    it 'creates an appium helper file' do
       expect(File).to exist("#{name}/helpers/appium_helper.rb")
     end
   end
@@ -59,9 +59,9 @@ describe HelpersGenerator do
   end
 
   context 'with rspec, selenium and applitools' do
-    include_examples 'creates common visual helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
-    include_examples 'creates selenium helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
-    include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
+    include_examples 'creates common visual helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates selenium helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with cucumber and selenium' do
@@ -101,16 +101,16 @@ describe HelpersGenerator do
   end
 
   context 'with rspec and appium cross platform' do
-    include_examples 'creates common helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates selenium helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates cross platform helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates common helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates selenium helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates cross platform helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}"
   end
 
   context 'with cucumber and appium cross platform' do
-    include_examples 'creates common helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates selenium helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates cucumber helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates cross platform helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates common helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates selenium helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates cucumber helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
+    include_examples 'creates cross platform helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[4]}"
   end
 end

data/spec/integration/generators/rspec_generator_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../lib/generators/rspec/rspec_generator'
-require_relative '../../spec_helper'
+require_relative '../spec_helper'
 
 describe RspecGenerator do
   shared_examples 'creates factory files' do |project_name|
@@ -44,6 +44,6 @@ describe RspecGenerator do
 
   context 'with rspec and appium cross platform' do
     include_examples 'creates rspec files examples',
-                     "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}", 'pdp'
+                     "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[4]}", 'pdp'
   end
 end

data/spec/{support → integration}/settings_helper.rb

@@ -4,13 +4,11 @@
 module SettingsHelper
   def create_settings(options)
     automation = options[:automation]
-    visual = options[:visual]
     framework = options[:framework]
     {
       automation:,
       framework:,
-      name: "#{framework}_#{automation}#{'_visual' if visual}",
-      visual:
+      name: "#{framework}_#{automation}"
     }
   end
 end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'rspec'
+require_relative '../../lib/generators/invoke_generators'
+require_relative 'settings_helper'
+
+AUTOMATION_TYPES = %w[android ios selenium watir cross_platform axe applitools].freeze
+FRAMEWORKS = %w[cucumber rspec].freeze
+
+RSpec.configure do |config|
+  config.include(InvokeGenerators)
+  config.include(SettingsHelper)
+  # rubocop:disable RSpec/BeforeAfterAll
+  config.before(:all) do
+    FRAMEWORKS.each do |framework|
+      AUTOMATION_TYPES.each do |automation|
+        settings = create_settings(framework:, automation:)
+        generate_framework(settings)
+      end
+    end
+  end
+
+  config.after(:all) do
+    FRAMEWORKS.each do |framework|
+      AUTOMATION_TYPES.each do |automation|
+        settings = create_settings(framework:, automation:)
+        FileUtils.rm_rf(settings[:name])
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/BeforeAfterAll

data/spec/system/selenium_spec.rb

@@ -0,0 +1,40 @@
+require_relative '../../lib/ruby_raider'
+
+FRAMEWORKS = %w[cucumber rspec].freeze
+
+describe 'Selenium based frameworks' do
+  before do
+    FRAMEWORKS.each do |framework|
+      RubyRaider::Raider
+        .new.invoke(:new, nil, %W[selenium_#{framework} -p framework:#{framework} automation:selenium])
+    end
+  end
+
+  after do
+    FRAMEWORKS.each do |framework|
+      FileUtils.rm_rf("selenium_#{framework}")
+    end
+  end
+
+  shared_examples 'creates web automation framework' do |type|
+    it 'executes without errors' do
+      run_tests_with(type)
+      expect($stdout).not_to match(/StandardError/)
+    end
+  end
+
+  context 'with rspec' do
+    include_examples 'creates web automation framework', 'rspec'
+  end
+
+  context 'with cucumber' do
+    include_examples 'creates web automation framework', 'cucumber'
+  end
+
+  private
+
+  def run_tests_with(framework)
+    folder = framework == 'rspec' ? 'spec' : 'features'
+    system("cd selenium_#{framework} && bundle install && raider utility browser_options chrome headless && bundle exec #{framework} #{folder}")
+  end
+end

data/spec/system/watir_spec.rb

@@ -0,0 +1,40 @@
+require_relative '../../lib/ruby_raider'
+
+FRAMEWORKS = %w[cucumber rspec].freeze
+
+describe 'Watir based frameworks' do
+  before do
+    FRAMEWORKS.each do |framework|
+      RubyRaider::Raider
+        .new.invoke(:new, nil, %W[watir_#{framework} -p framework:#{framework} automation:watir])
+    end
+  end
+
+  after do
+    FRAMEWORKS.each do |framework|
+      FileUtils.rm_rf("watir_#{framework}")
+    end
+  end
+
+  shared_examples 'creates web automation framework' do |type|
+    it 'executes without errors' do
+      run_tests_with(type)
+      expect($stdout).not_to match(/StandardError/)
+    end
+  end
+
+  context 'with rspec' do
+    include_examples 'creates web automation framework', 'rspec'
+  end
+
+  context 'with cucumber' do
+    include_examples 'creates web automation framework', 'cucumber'
+  end
+
+  private
+
+  def run_tests_with(framework)
+    folder = framework == 'rspec' ? 'spec' : 'features'
+    system("cd watir_#{framework} && bundle install && raider utility browser_options chrome headless && bundle exec #{framework} #{folder}")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.6
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -136,9 +136,9 @@ files:
 - ".github/workflows/integration.yml"
 - ".github/workflows/push_gem.yml"
 - ".github/workflows/reek.yml"
-- ".github/workflows/rspec_selenium.yml"
-- ".github/workflows/rspec_watir.yml"
 - ".github/workflows/rubocop.yml"
+- ".github/workflows/selenium.yml"
+- ".github/workflows/watir.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
@@ -149,6 +149,8 @@ files:
 - README.md
 - Rakefile
 - bin/raider
+- lib/commands/loaded_commands.rb
+- lib/commands/plugin_commands.rb
 - lib/commands/scaffolding_commands.rb
 - lib/commands/utility_commands.rb
 - lib/generators/actions/actions_generator.rb
@@ -221,6 +223,8 @@ files:
 - lib/generators/templates/helpers/spec_helper.tt
 - lib/generators/templates/helpers/visual_helper.tt
 - lib/generators/templates/helpers/visual_spec_helper.tt
+- lib/plugin/plugin.rb
+- lib/plugin/plugin_exposer.rb
 - lib/ruby_raider.rb
 - lib/scaffolding/scaffolding.rb
 - lib/scaffolding/templates/feature.tt
@@ -231,6 +235,7 @@ files:
 - lib/utilities/logger.rb
 - lib/utilities/utilities.rb
 - lib/version
+- plugins.yml
 - ruby_raider.gemspec
 - spec/integration/commands/scaffolding_commands_spec.rb
 - spec/integration/commands/utility_commands_spec.rb
@@ -240,8 +245,10 @@ files:
 - spec/integration/generators/cucumber_generator_spec.rb
 - spec/integration/generators/helpers_generator_spec.rb
 - spec/integration/generators/rspec_generator_spec.rb
-- spec/spec_helper.rb
-- spec/support/settings_helper.rb
+- spec/integration/settings_helper.rb
+- spec/integration/spec_helper.rb
+- spec/system/selenium_spec.rb
+- spec/system/watir_spec.rb
 homepage: https://github.com/RubyRaider/ruby_raider
 licenses:
 - MIT

data/.github/workflows/rspec_selenium.yml

@@ -1,42 +0,0 @@
-name: BrowserStack Test
-on: [ pull_request ]
-
-jobs:
-  ubuntu-job:
-    name: BrowserStack Test on Ubuntu
-    runs-on: ubuntu-latest
-    steps:
-      - name: BrowserStack Env Setup
-        uses: browserstack/github-actions/setup-env@master
-        with:
-          username: ${{ secrets.BROWSERSTACK_USERNAME }}
-          access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
-          build-name: BUILD_INFO
-          project-name: REPO_NAME
-      - name: BrowserStackLocal Setup
-        uses: browserstack/github-actions/setup-local@master
-        with:
-          local-testing: start
-
-
-      - name: Checkout the repository
-        uses: actions/checkout@v2
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
-        with:
-          ruby-version: head
-
-      - name: Install gems
-        run: bundle install
-
-      - name: Create Raider framework
-        run: bin/raider new rspec_selenium -p framework:rspec automation:selenium visual:false axe:true
-
-      - name: Run Raider tests
-        run: cd rspec_selenium && bundle install && raider utility browser_options chrome headless && rspec spec/
-
-      - name: BrowserStackLocal Stop
-        uses: browserstack/github-actions/setup-local@master
-        with:
-          local-testing: stop

data/.github/workflows/rspec_watir.yml

@@ -1,42 +0,0 @@
-name: BrowserStack Test
-on: [ pull_request ]
-
-jobs:
-  ubuntu-job:
-    name: BrowserStack Test on Ubuntu
-    runs-on: ubuntu-latest
-    steps:
-      - name: BrowserStack Env Setup
-        uses: browserstack/github-actions/setup-env@master
-        with:
-          username: ${{ secrets.BROWSERSTACK_USERNAME }}
-          access-key: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
-          build-name: BUILD_INFO
-          project-name: REPO_NAME
-      - name: BrowserStackLocal Setup
-        uses: browserstack/github-actions/setup-local@master
-        with:
-          local-testing: start
-
-
-      - name: Checkout the repository
-        uses: actions/checkout@v2
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@f20f1eae726df008313d2e0d78c5e602562a1bcf
-        with:
-          ruby-version: head
-
-      - name: Install gems
-        run: bundle install
-
-      - name: Create Raider framework
-        run: bin/raider new rspec_watir -p framework:rspec automation:watir visual:false axe:true
-
-      - name: Run Raider tests
-        run: cd rspec_selenium && bundle install && raider utility browser_options chrome headless && rspec spec/
-
-      - name: BrowserStackLocal Stop
-        uses: browserstack/github-actions/setup-local@master
-        with:
-          local-testing: stop

data/spec/spec_helper.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'rspec'
-require_relative '../lib/generators/invoke_generators'
-require_relative 'support/settings_helper'
-
-AUTOMATION_TYPES = %w[android ios selenium watir cross_platform].freeze
-FRAMEWORKS = %w[cucumber rspec].freeze
-
-RSpec.configure do |config|
-  config.include(InvokeGenerators)
-  config.include(SettingsHelper)
-  config.before(:all) do
-    FRAMEWORKS.each do |framework|
-      AUTOMATION_TYPES.each do |automation|
-        [true, false].each do |visual|
-          settings = create_settings(framework:, automation:, visual:)
-          generate_framework(settings)
-        end
-      end
-    end
-  end
-
-  config.after(:all) do
-    FRAMEWORKS.each do |framework|
-      AUTOMATION_TYPES.each do |automation|
-        [true, false].each do |visual|
-          settings = create_settings(framework:, automation:, visual:)
-          FileUtils.rm_rf(settings[:name])
-        end
-      end
-    end
-  end
-end