ruby_raider 0.8.6 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd92fae06515596d875be2a1c9d05b2335574839da3269de1c598d4287e9fd9
-  data.tar.gz: 8cc4c5922b36406b33d5e5df4c897ab0ce3a0d3a7036395293e634eeccbb27a2
+  metadata.gz: a3fe29e41e6594c06a03da48fdd3481af4706a6cf4e5c344bb3f78db1e48cec8
+  data.tar.gz: 3b53ca1421e02300c0edb463cd4ca7c373992afdb41caa70318fc9df213fec90
 SHA512:
-  metadata.gz: c521e8d445f0490f04349ede87a4fd56552dd13ac1261735792b82a5ab3c064202120fc1bd4fb64c18d05f7575d5dd5b94dde68d186c3cb7b27e54ceeb095390
-  data.tar.gz: 2d4f842b0214f55d11a6711353dd059d21085ee636cd1d6c81bd2d143b2fcee92d236f27906f1a8caa3bbc9b44dcb9a6151c2dd29f7720228a873480f9922742
+  metadata.gz: 2b684e1ebcca1611a9593f3b77039bfd66e21656e6746f6e31a5240f9fdb032527e29f63d5aab3caf770c472c4c8810f50c587a61375568d6db4d93258454c49
+  data.tar.gz: da691e9de5d1128eb1aa0d99fbbde682afb70d0be3bf3d29a75b88bbc2af7c771b19a1aa29295fa4c1f5bd8d56082f7659284aff7484c6f284d6891ae21ff9c9

data/.github/workflows/integration.yml

@@ -20,6 +20,4 @@ jobs:
         run: bundle install
 
       - name: Build and run integration tests
-        env:
-          OPENAI_ACCESS_TOKEN: ${{ secrets.OPENAI_ACCESS_TOKEN }}
         run: rake integration

data/.github/workflows/push_gem.yml

@@ -0,0 +1,37 @@
+name: Push Gem
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'RubyRaider/ruby_raider'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/ruby_raider
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      # Set up
+      - name: Harden Runner
+        uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@cacc9f1c0b3f4eb8a16a6bb0ed10897b43b9de49 # v1.176.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31 # v1

data/.github/workflows/system.yml

@@ -26,6 +26,4 @@ jobs:
         run: bundle install
 
       - name: Build and run system tests
-        env:
-          OPENAI_ACCESS_TOKEN: ${{ secrets.OPENAI_ACCESS_TOKEN }}
         run: rake system

data/.gitignore

@@ -1,5 +1,4 @@
 ruby_raider-*.gem
 .idea/
 ruby_raider.iml
-Gemfile.lock
-.env
+Gemfile.lock

data/.rubocop.yml

@@ -87,4 +87,4 @@ Style/SafeNavigation:
 
 Style/SingleLineBlockParams:
   Description: 'Enforces the names of some block params.'
-  Enabled: false
+  Enabled: false

data/README.md

@@ -88,10 +88,9 @@ Select the ones you will like to work with.
 
 ```ruby
 Commands:
-  raider generate # Provides access to all the generators 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 open_ai # Provides access to all the open ai commands
   raider utility # Provides access to all the utility commands 
   raider version # It shows the version of Ruby Raider you are currently using
 ```
@@ -100,33 +99,38 @@ All the basic commands have their corresponding shortcut:
 
 * g for generate
 * n for new
-* o for open_ai
 * u for utility
 * v for version
 
+### Scaffolding Commands
+Ruby Raider also supports scaffolding:
+
+* To create a new page object you do: ```raider g page [PAGE_NAME]```
+* To create a new spec you do: ```raider g spec [SPEC_NAME]```
+* To create a new feature you do: ```raider g feature [FEATURE_NAME]```
+* 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
+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
+```
+
+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
 ```
 
-### Open AI Commands
+### Sponsors
 
-```ruby
-# Will print the result of the request on the terminal
-raider o make [REQUEST]
-# Will create a file with the result of your request as content
-raider o make [REQUEST] - -path or -p [PATH]
-# Will input the content of the chosen file into open ai and will edit it based on the result
-raider o make [PATH_NAME] - -edit or -e [FILE_PATH]
-# Creates a cucumber file and uses it to input into open ai and create a steps file
-# The prompt is required
-raider o cucumber [NAME] - -prompt or -p [PROMPT]
-# Creates a cucumber step definitions file based on an scenario file
-raider open_ai steps [NAME]
-Options : 
-  -p, [--path = PATH] # The path where your steps will be created
-  -pr, [--prompt = PROMPT] # This will create the selected steps based on your prompt using open ai
-  -i, [--input = INPUT] # It uses a file as input to create the steps
-
-```
+This project is tested with BrowserStack.

data/lib/commands/scaffolding_commands.rb

@@ -7,6 +7,7 @@ require_relative '../commands/utility_commands'
 
 # :reek:FeatureEnvy { enabled: false }
 # :reek:UtilityFunction { enabled: false }
+# :reek:RepeatedConditional { enabled: false }
 class ScaffoldingCommands < Thor
   desc 'page [PAGE_NAME]', 'Creates a new page object'
   option :path,
@@ -15,7 +16,9 @@ class ScaffoldingCommands < Thor
          type: :boolean, required: false, desc: 'This will delete the selected page', aliases: '-d'
 
   def page(name)
-    handle_scaffolding(name, 'page')
+    return delete_scaffolding(name, 'page') if options[:delete]
+
+    generate_scaffolding(name, 'page', options[:path])
   end
 
   desc 'feature [NAME]', 'Creates a new feature'
@@ -27,7 +30,9 @@ class ScaffoldingCommands < Thor
          required: false, desc: 'This will delete the selected feature', aliases: '-d'
 
   def feature(name)
-    handle_scaffolding(name, 'feature')
+    return delete_scaffolding(name, 'feature') if options[:delete]
+
+    generate_scaffolding(name, 'feature', options[:path])
   end
 
   desc 'spec [SPEC_NAME]', 'Creates a new spec'
@@ -37,7 +42,9 @@ class ScaffoldingCommands < Thor
          type: :boolean, required: false, desc: 'This will delete the selected spec', aliases: '-d'
 
   def spec(name)
-    handle_scaffolding(name, 'spec')
+    return delete_scaffolding(name, 'spec') if options[:delete]
+
+    generate_scaffolding(name, 'spec', options[:path])
   end
 
   desc 'helper [HELPER_NAME]', 'Creates a new helper'
@@ -47,7 +54,21 @@ class ScaffoldingCommands < Thor
          type: :boolean, required: false, desc: 'This will delete the selected helper', aliases: '-d'
 
   def helper(name)
-    handle_scaffolding(name, 'helper')
+    return delete_scaffolding(name, 'helper') if options[:delete]
+
+    generate_scaffolding(name, 'helper', options[:path])
+  end
+
+  desc 'steps [STEPS_NAME]', 'Creates a new steps definition'
+  option :path,
+         type: :string, required: false, desc: 'The path where your steps will be created', aliases: '-p'
+  option :delete,
+         type: :boolean, required: false, desc: 'This will delete the selected steps', aliases: '-d'
+
+  def steps(name)
+    return delete_scaffolding(name, 'steps') if options[:delete]
+
+    generate_scaffolding(name, 'steps', options[:path])
   end
 
   desc 'scaffold [SCAFFOLD_NAME]', 'It generates everything needed to start automating'
@@ -57,46 +78,23 @@ class ScaffoldingCommands < Thor
       Scaffolding.new([name, load_config_path('spec')]).generate_spec
     else
       Scaffolding.new([name, load_config_path('feature')]).generate_feature
+      Scaffolding.new([name, load_config_path('steps')]).generate_steps
     end
-    Scaffolding.new([name, load_config_path('page')]).generate_class
+    Scaffolding.new([name, load_config_path('page')]).generate_page
   end
 
-  desc 'config', 'Creates configuration file'
-  option :delete,
-         type: :boolean, required: false, desc: 'This will delete the config file', aliases: '-d'
-
   no_commands do
     def load_config_path(type)
       YAML.load_file('config/config.yml')["#{type}_path"] if Pathname.new('config/config.yml').exist?
     end
 
-    def handle_scaffolding(name, type)
-      path = options[:path] || load_config_path(type)
-      scaffolding = Scaffolding.new([name, path])
-
-      if options[:delete]
-        case type
-        when 'page'
-          scaffolding.delete_class
-        when 'feature'
-          scaffolding.delete_feature
-        when 'spec'
-          scaffolding.delete_spec
-        when 'helper'
-          scaffolding.delete_helper
-        end
-      else
-        case type
-        when 'page'
-          scaffolding.generate_class
-        when 'feature'
-          scaffolding.generate_feature
-        when 'spec'
-          scaffolding.generate_spec
-        when 'helper'
-          scaffolding.generate_helper
-        end
-      end
+    def delete_scaffolding(name, type)
+      Scaffolding.new([name]).send("delete_#{type}")
+    end
+
+    def generate_scaffolding(name, type, path)
+      path ||= load_config_path(type)
+      Scaffolding.new([name, path]).send("generate_#{type}")
     end
   end
 end

data/lib/generators/automation/templates/partials/initialize_selector.tt

@@ -4,6 +4,13 @@
   def initialize(browser)
     @browser = browser
   end
+<% elsif axe? %>
+  attr_reader :driver
+  alias page driver
+
+  def initialize(driver)
+    @driver = driver
+  end
 <% else %>
   attr_reader :driver
 

data/lib/generators/automation/templates/partials/selenium_login.tt

@@ -14,6 +14,7 @@ class Login < Page
     password_field.send_keys password
     login_button.click
   end
+  alias log_as login
 
   private
 

data/lib/generators/generator.rb

@@ -9,6 +9,7 @@ class Generator < Thor::Group
   argument :framework
   argument :name
   argument :visual_automation, optional: true
+  argument :axe_support, optional: true
 
   def self.source_paths
     base_path = File.dirname(__FILE__)
@@ -46,7 +47,7 @@ class Generator < Thor::Group
   end
 
   def visual?
-    initializer.first.last
+    args[3]
   end
 
   def watir?
@@ -57,6 +58,10 @@ class Generator < Thor::Group
     (args & (%w[selenium watir])).count.positive?
   end
 
+  def axe?
+    args.last
+  end
+
   private
 
   def _initializer

data/lib/generators/invoke_generators.rb

@@ -18,7 +18,8 @@ module InvokeGenerators
                          framework: framework,
                          generator: generator,
                          name: structure[:name],
-                         visual: structure[:visual]
+                         visual: structure[:visual],
+                         axe_support: structure[:axe_support]
                        })
     end
   end
@@ -32,6 +33,7 @@ module InvokeGenerators
           .new([structure[:automation],
                 structure[:framework],
                 structure[:name],
-                structure[:visual]]).invoke_all
+                structure[:visual],
+                structure[:axe_support]]).invoke_all
   end
 end

data/lib/generators/menu_generator.rb

@@ -22,7 +22,11 @@ class MenuGenerator
   end
 
   def choose_visual_automation
-    prompt.select('Do you want to add visual automation with applitools?', visual_automation_menu_choices)
+    prompt.select('Do you want to add visual automation with Applitools?', yes_no_menu_choices)
+  end
+
+  def choose_axe_support
+    prompt.select('Do you want to add Axe accessibility testing tool?', yes_no_menu_choices)
   end
 
   def choose_test_framework(automation)
@@ -37,7 +41,8 @@ class MenuGenerator
       automation: options[:automation],
       framework: options[:framework],
       name: @name,
-      visual: options[:visual_automation]
+      visual: options[:visual_automation],
+      axe_support: options[:axe_support]
     }
     generate_framework(structure)
     system "cd #{name} && gem install bundler && bundle install"
@@ -69,22 +74,32 @@ class MenuGenerator
     end
   end
 
-  FrameworkOptions = Struct.new(:automation, :framework, :visual_automation)
+  FrameworkOptions = Struct.new(:automation, :framework, :visual_automation, :axe_support)
 
   def create_framework_options(params)
-    FrameworkOptions.new(params[:automation], params[:framework], params[:visual_automation])
+    FrameworkOptions.new(params[:automation], params[:framework], params[:visual_automation], params[:axe_support])
   end
 
   def create_framework(framework, automation_type)
     visual_automation = choose_visual_automation if %w[selenium].include?(automation_type)
+    axe = choose_axe_support if automation_type == 'selenium' && framework == 'Rspec' && visual_automation == false
     options = create_framework_options(automation: automation_type,
                                        framework: framework.downcase,
-                                       visual_automation: visual_automation)
+                                       visual_automation: visual_automation,
+                                       axe_support: axe)
+
+    # Print the chosen options
+    puts 'Chosen Options:'
+    puts "  Automation Type: #{options[:automation]}"
+    puts "  Framework: #{options[:framework]}"
+    puts "  Visual Automation: #{options[:visual_automation]}"
+    puts "  Axe Support: #{options[:axe_support]}"
+
     set_up_framework(options)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
   end
 
-  def visual_automation_menu_choices
+  def yes_no_menu_choices
     {
       Yes: -> { true },
       No: -> { false },

data/lib/generators/rspec/rspec_generator.rb

@@ -14,4 +14,10 @@ class RspecGenerator < Generator
 
     template('spec.tt', "#{name}/spec/pdp_page_spec.rb")
   end
+
+  def generate_account_spec
+    return unless visual?
+
+    template('spec.tt', "#{name}/spec/account_page_spec.rb")
+  end
 end

data/lib/generators/rspec/templates/spec.tt

@@ -6,6 +6,34 @@ require_relative '../models/model_factory'
 require_relative '../page_objects/pages/account'
 require_relative '../page_objects/pages/login'
 
+<%- if axe? %>
+describe 'Login' do
+  let(:login) { Login.new(driver) }
+  let(:account) { Account.new(driver) }
+  let(:user) { ModelFactory.for('users')['registered user'] }
+
+  before do
+    login.visit
+    login.log_as(user['username'], user['password'])
+  end
+
+  context 'with a login user on the account page' do
+    it 'no accessibility errors are present on the page' do
+      expect(account.page).to be_axe_clean
+    end
+
+    it 'no accessibility errors are present on the transaction history' do
+      transaction_history = '.dash-tile.dash-tile-balloon.clearfix'
+      expect(account.page).to be_axe_clean.within transaction_history
+    end
+
+    it 'no accessibility errors are present on the heading' do
+      heading = '.maintext'
+      expect(account.page).to be_axe_clean.within heading
+    end
+  end
+end
+<%- elsif %w[selenium watir].include? automation -%>
 describe 'Login' do
   subject(:header) { account_page.header.customer_name }
 
@@ -42,6 +70,7 @@ describe 'Login' do
     end
   end
 end
+<%- end -%>
 <%- elsif automation == 'sparkling_ios' -%>
 require_relative '../helpers/spec_helper'
 require_relative '../page_objects/pages/home'

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

@@ -7,6 +7,10 @@ gem 'allure-cucumber'
 gem 'allure-rspec'
 gem 'allure-ruby-commons'
 <% end -%>
+<% if axe? -%>
+gem 'axe-core-rspec'
+gem 'axe-core-selenium'
+<% end -%>
 <% if visual_automation -%>
 gem 'eyes_selenium', '~> 4.6', '>= 4.6.1'
 gem 'eyes_universal', '~> 3.3', '>= 3.3.1'

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

@@ -1,8 +1,4 @@
-require 'yaml'
-
-desc 'Selects browser for automation run'
-task :select_browser, [:browser] do |_t, args|
-  config = YAML.load_file('config/config.yml')
-  config['browser'] = args.browser
-  File.write('config/config.yml', config.to_yaml)
-end
+desc 'Print Ruby Raider version'
+task :raider do
+  system 'raider version'
+end

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

@@ -1,29 +1,25 @@
 # Ruby Raider
 
-[![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)
-[![Gitter](https://badges.gitter.im/RubyRaider/community.svg)](https://gitter.im/RubyRaider/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-
 <!-- PROJECT LOGO -->
 <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">
-   </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 />
-      <a href="https://rubygems.org/gems/ruby_raider">Rubygems</a>
-      ·
-      <a href="https://github.com/RubyRaider/ruby_raider/issues">Report Bug</a>
-      ·
-      <a href="https://github.com/RubyRaider/ruby_raider/issues">Request Feature</a>
-   </p>
-   <p align="center"> For more information and updates on releases, see <a href="https://ruby-raider.com">https://ruby-raider.com</a></p>
+  <a href="https://github.com/RubyRaider/ruby_raider">
+    <img src="https://rubyraiderdotcom.files.wordpress.com/2022/05/logo_transparent_background-1.png" alt="Logo">
+  </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 />
+    <a href="https://rubygems.org/gems/ruby_raider">Rubygems</a>
+    ·
+    <a href="https://github.com/RubyRaider/ruby_raider/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/RubyRaider/ruby_raider/issues">Request Feature</a>
+  </p>
+  <p align="center"> For more information and updates on releases, see <a href="https://ruby-raider.com">https://ruby-raider.com</a></p>
 </div>
 
 ## What is Ruby Raider?
@@ -39,7 +35,7 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 | Rspec and Watir            |                                             | Rspec and Appium for Android              |
 |                            |                                             | Cucumber and Appium Cross-platform        |
 |                            |                                             | Rspec and Appium Cross-platform           |
-|                            |                                             | Cucumber and Sparkling Watir for IOS      |
+|                            |                                             |  Cucumber and Sparkling Watir for IOS     |
 |                            |                                             | Rspec and Sparkling Watir for IOS         |
 
 
@@ -86,46 +82,45 @@ Select the ones you will like to work with.
 
 ```ruby
 Commands:
-  raider generate # Provides access to all the generators commands
-  raider help [COMMAND] # Describe available commands or one specific command
-  raider new [PROJECT_NAME] # Creates a new framework based on settings picked
-  raider open_ai # Provides access to all the open ai commands
-  raider utility # Provides access to all the utility commands
-  raider version # It shows the version of Ruby Raider you are currently using
+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:
 
 * g for generate
 * n for new
-* o for open_ai
 * u for utility
 * v for version
 
+### Scaffolding Commands
+Ruby Raider also supports scaffolding:
+
+* To create a new page object you do: ```raider g page [PAGE_NAME]```
+* To create a new spec you do: ```raider g spec [SPEC_NAME]```
+* To create a new feature you do: ```raider g feature [FEATURE_NAME]```
+* 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
+specs.
+
+If you want to set the default path for the creation of your features, helpers and specs:
 
-### Appium Server Command
-To initialise Appium server run this command:
 ```ruby
-raider u start_appium
+raider u path [PATH_NAME] - -feature or -f
+raider u path [PATH_NAME] - -spec or -s
+raider u path [PATH_NAME] - -helper or -h
 ```
 
-### Open AI Commands
+If you don't specify an option, path will assume you want to change the default path for pages.
 
-```ruby
-# Will print the result of the request on the terminal
-raider o make [REQUEST]
-# Will create a file with the result of your request as content
-raider o make [REQUEST] - -path or -p [PATH]
-# Will input the content of the chosen file into open ai and will edit it based on the result
-raider o make [PATH_NAME] - -edit or -e [FILE_PATH]
-# Creates a cucumber file and uses it to input into open ai and create a steps file
-# The prompt is required
-raider o cucumber [NAME] - -prompt or -p [PROMPT]
-# Creates a cucumber step definitions file based on an scenario file
-raider open_ai steps [NAME]
-Options :
-  -p, [--path = PATH] # The path where your steps will be created
-  -pr, [--prompt = PROMPT] # This will create the selected steps based on your prompt using open ai
-  -i, [--input = INPUT] # It uses a file as input to create the steps
 
+### Appium Server Command
+To initialise Appium server run this command:
+```ruby
+raider u start_appium
 ```

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

@@ -21,6 +21,9 @@ module DriverHelper
 end
 <%- else -%>
 # frozen_string_literal: true
+<% if axe? -%>
+require 'axe-selenium'
+<% end -%>
 require 'yaml'
 <% if automation == 'selenium' -%>
 require 'active_support/inflector'
@@ -30,10 +33,14 @@ require 'appium_lib'
 <% end -%>
 
 module DriverHelper
-  <% if automation == 'selenium' -%>
+  <% if automation == 'selenium' && axe? == false -%>
   def driver(*opts)
     @driver ||= create_driver(*opts)
   end
+  <% elsif axe? == true -%>
+  def driver(browser = :chrome, js_path = nil, skip_iframes = nil)
+    @driver ||= create_driver(browser, js_path, skip_iframes)
+  end
   <% else -%>
   def driver
       @driver ||= create_driver

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

@@ -1,4 +1,11 @@
-<% if automation == 'selenium' -%>
+<% if automation == 'selenium' && axe? == true -%>
+  def create_driver(browser, js_path, skip_iframes)
+    AxeSelenium.configure(browser) do |config|
+      config.jslib_path = js_path if js_path
+      config.skip_iframes = skip_iframes if skip_iframes
+    end.page
+  end
+<% elsif automation == 'selenium' -%>
   def create_driver(*opts)
     @config = YAML.load_file('config/config.yml')
     browser = @config['browser'].to_sym
@@ -22,7 +29,6 @@
     driver_options.each { |opt| options.add_option(opt.first, opt.last) }
     options
   end
-
 <% elsif automation == 'cross_platform' -%>
   def create_driver
     platform = config['platform'].to_s

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

@@ -30,6 +30,9 @@ end
 <%- else -%>
 # frozen_string_literal: true
 
+<%- if axe? %>
+require 'axe-rspec'
+<%- end -%>
 require 'rspec'
 require 'tmpdir'
 require_relative 'allure_helper'

data/lib/ruby_raider.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../lib/commands/open_ai_commands'
 require_relative '../lib/commands/scaffolding_commands'
 require_relative '../lib/commands/utility_commands'
 
@@ -19,26 +18,21 @@ module RubyRaider
     desc 'version', 'It shows the version of Ruby Raider you are currently using'
 
     def version
-      puts "The version is #{parsed_version}, happy testing!"
+      puts "The version is #{current_version}, happy testing!"
     end
 
     map 'v' => 'version'
 
-    desc 'generate', 'Provides access to all the generator commands'
+    desc 'generate', 'Provides access to all the scaffolding commands'
     subcommand 'generate', ScaffoldingCommands
     map 'g' => 'generate'
 
-    desc 'open_ai', 'Provides access to all the open ai commands'
-    subcommand 'open_ai', OpenAiCommands
-    map 'o' => 'open_ai'
-
     desc 'utility', 'Provides access to all the utility commands'
     subcommand 'utility', UtilityCommands
     map 'u' => 'utility'
 
     no_commands do
-      def gemspec = Gem::Specification.load('ruby_raider.gemspec')
-      def parsed_version = Gem::Version.new(gemspec.version)
+      def current_version = File.read(File.expand_path('version', __dir__)).strip
     end
   end
 end

data/lib/scaffolding/scaffolding.rb

@@ -12,8 +12,8 @@ class Scaffolding < Thor::Group
     "#{File.dirname(__FILE__)}/templates"
   end
 
-  def generate_class
-    template('page_object.tt', default_path("page_objects/pages/#{name}_page.rb", '_page.rb'))
+  def generate_page
+    template('page_object.tt', default_path("page_objects/pages/#{name}.rb", '_page.rb'))
   end
 
   def generate_feature
@@ -21,20 +21,24 @@ class Scaffolding < Thor::Group
   end
 
   def generate_spec
-    template('spec.tt', default_path("spec/#{name}_spec.rb", '_spec.rb'))
+    template('spec.tt', default_path("spec/#{name}_page_spec.rb", '_spec.rb'))
   end
 
   def generate_helper
     template('helper.tt', default_path("helpers/#{name}_helper.rb", '_helper.rb'))
   end
 
+  def generate_steps
+    template('steps.tt', default_path("features/step_definitions/#{name}_steps.rb", '_steps.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'))
+  def delete_page
+    remove_file(default_path("page_objects/pages/#{name}.rb", '_page.rb'))
   end
 
   def delete_feature
@@ -42,13 +46,17 @@ class Scaffolding < Thor::Group
   end
 
   def delete_spec
-    remove_file(default_path("spec/#{name}_spec.rb", '_spec.rb'))
+    remove_file(default_path("spec/#{name}_page_spec.rb", '_spec.rb'))
   end
 
   def delete_helper
     remove_file(default_path("helpers/#{name}_helper.rb", '_helper.rb'))
   end
 
+  def delete_steps
+    remove_file(default_path("features/step_definitions/#{name}_steps.rb", '_steps.rb'))
+  end
+
   def delete_config
     remove_file(default_path('config/config.yml', '.yml'))
   end

data/lib/scaffolding/templates/feature.tt

@@ -1,4 +1,4 @@
-Feature: <%= name %>
+Feature: <%= name.capitalize %>
 
 Scenario: Scenario name
     Given I am

data/lib/scaffolding/templates/page_object.tt

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../abstract/abstract_page'
+require_relative '../abstract/page'
 
-class <%= name.split('_').map {|word| word.capitalize }.join + 'Page' %> < AbstractPage
+class <%= name.split('_').map {|word| word.capitalize }.join %> < Page
 
   # Actions
 

data/lib/scaffolding/templates/spec.tt

@@ -1,5 +1,4 @@
-require_relative 'base_spec'
-require_relative '../page_objects/pages/<%= name %>_page'
+require_relative '../page_objects/pages/<%= name %>'
 
-describe <%= name.split('_').map {|word| word.capitalize }.join + 'Page' %> do
+describe '<%= name.split('_').map {|word| word.capitalize }.join %>' do
 end

data/lib/scaffolding/templates/steps.tt

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative '../../page_objects/pages/<%= name %>'
+
+Given ('') do
+end
+
+When ('') do
+end
+
+Then ('') do
+end

data/lib/version

@@ -0,0 +1 @@
+0.8.8

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.8.6'
+  s.version     = File.read(File.expand_path('lib/version', __dir__)).strip
   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']
@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
 
   s.add_runtime_dependency 'faraday', '~> 1.10.0'
-  s.add_runtime_dependency 'ruby-openai', '~> 3.5'
   s.add_runtime_dependency 'thor', '~> 1.2.1'
   s.add_runtime_dependency 'tty-prompt', '~> 0.23.1'
 end

data/spec/integration/commands/scaffolding_commands_spec.rb

@@ -27,12 +27,12 @@ describe ScaffoldingCommands do
 
     it 'scaffolds for rspec creating a spec' do
       scaffold.new.invoke(:scaffold, nil, %W[#{name}])
-      expect(Pathname.new("spec/#{name}_spec.rb")).to be_file
+      expect(Pathname.new("spec/#{name}_page_spec.rb")).to be_file
     end
 
     it 'scaffolds for rspec creating a page' do
       scaffold.new.invoke(:scaffold, nil, %W[#{name}])
-      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+      expect(Pathname.new("page_objects/pages/#{name}.rb")).to be_file
     end
 
     it 'deletes a spec' do
@@ -47,7 +47,7 @@ describe ScaffoldingCommands do
 
     it 'creates a page' do
       scaffold.new.invoke(:page, nil, %W[#{name}])
-      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+      expect(Pathname.new("page_objects/pages/#{name}.rb")).to be_file
     end
 
     it 'creates a page with a path' do
@@ -77,7 +77,12 @@ describe ScaffoldingCommands do
 
     it 'scaffolds for cucumber creating a page' do
       scaffold.new.invoke(:scaffold, nil, %W[#{name}])
-      expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+      expect(Pathname.new("page_objects/pages/#{name}.rb")).to be_file
+    end
+
+    it 'scaffolds for cucumber creating a steps definition' do
+      scaffold.new.invoke(:scaffold, nil, %W[#{name}])
+      expect(Pathname.new("features/step_definitions/#{name}_steps.rb")).to be_file
     end
 
     it 'creates a helper' do
@@ -85,6 +90,11 @@ describe ScaffoldingCommands do
       expect(Pathname.new("helpers/#{name}_helper.rb")).to be_file
     end
 
+    it 'creates a steps definition' do
+      scaffold.new.invoke(:steps, nil, %W[#{name}])
+      expect(Pathname.new("features/step_definitions/#{name}_steps.rb")).to be_file
+    end
+
     it 'deletes a page' do
       scaffold.new.invoke(:page, nil, %w[login --delete])
       expect(Pathname.new('page_objects/pages/login_page.rb')).not_to be_file

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ RSpec.configure do |config|
     FRAMEWORKS.each do |framework|
       AUTOMATION_TYPES.each do |automation|
         [true, false].each do |visual|
-          settings = create_settings(framework: framework, automation: automation, visual: visual)
+          settings = create_settings(framework: framework, automation: automation, visual: visual, axe: axe_support)
           generate_framework(settings)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.8
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.0
-- !ruby/object:Gem::Dependency
-  name: ruby-openai
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +162,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/auto_assign-issues.yml"
 - ".github/workflows/integration.yml"
+- ".github/workflows/push_gem.yml"
 - ".github/workflows/reek.yml"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/system.yml"
@@ -189,7 +176,6 @@ files:
 - README.md
 - Rakefile
 - bin/raider
-- lib/commands/open_ai_commands.rb
 - lib/commands/scaffolding_commands.rb
 - lib/commands/utility_commands.rb
 - lib/generators/actions/actions_generator.rb
@@ -262,17 +248,17 @@ files:
 - lib/generators/templates/helpers/spec_helper.tt
 - lib/generators/templates/helpers/visual_helper.tt
 - lib/generators/templates/helpers/visual_spec_helper.tt
-- lib/open_ai/open_ai.rb
 - lib/ruby_raider.rb
 - lib/scaffolding/scaffolding.rb
 - lib/scaffolding/templates/feature.tt
 - lib/scaffolding/templates/helper.tt
 - lib/scaffolding/templates/page_object.tt
 - lib/scaffolding/templates/spec.tt
+- lib/scaffolding/templates/steps.tt
 - lib/utilities/logger.rb
 - lib/utilities/utilities.rb
+- lib/version
 - ruby_raider.gemspec
-- spec/integration/commands/open_ai_commands_spec.rb
 - spec/integration/commands/scaffolding_commands_spec.rb
 - spec/integration/commands/utility_commands_spec.rb
 - spec/integration/generators/actions_generator_spec.rb
@@ -303,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A gem to make setup and start of UI automation projects easier

data/lib/commands/open_ai_commands.rb

@@ -1,85 +0,0 @@
-require 'thor'
-require 'faraday'
-require_relative '../open_ai/open_ai'
-
-class OpenAiCommands < Thor
-  desc 'make [REQUEST]', 'Uses open AI to create a file or generate output'
-  option :path,
-         type: :string, required: false, desc: 'The path where your file will be created', aliases: '-p'
-  option :edit,
-         type: :string, required: false, desc: 'Path to the file you want to edit', aliases: '-e'
-
-  def make(request, path = nil)
-    path ||= options[:path]
-    edit_path = options[:edit]
-    if edit_path
-      pp 'Editing File...'
-      OpenAi.edit_file(path: edit_path, request: request)
-      pp "File #{edit_path} edited"
-    elsif path
-      pp 'Generating File...'
-      OpenAi.create_file(path: path, request: request)
-      pp "File created in #{path}"
-    else
-      puts OpenAi.output(request: request)
-    end
-  end
-
-  desc 'cucumber [NAME]', 'Creates feature and step files only using open ai'
-  option :prompt,
-         type: :string,
-         required: true, desc: 'The prompt for open ai', aliases: '-p'
-
-  def cucumber(name)
-    feature_path = "features/#{name}.feature"
-    make(options[:prompt], feature_path)
-    prompt_step = "create cucumber steps for the following scenarios in ruby #{File.read(feature_path)}"
-    make(prompt_step, "features/step_definitions/#{name}_steps.rb")
-  end
-
-  desc 'steps [NAME]', 'Creates a new step definitions file'
-  option :path,
-         type: :string,
-         required: false, desc: 'The path where your steps will be created', aliases: '-p'
-  option :prompt,
-         type: :string, required: false,
-         desc: 'This will create the selected steps based on your prompt using open ai', aliases: '-pr'
-  option :input,
-         type: :string,
-         required: false, desc: 'It uses a file as input to create the steps', aliases: '-i'
-
-  def steps(name)
-    path = 'features/step_definitions'
-    input = options[:input]
-    if input
-      prompt = options[:prompt] || 'create cucumber steps for the following scenarios in ruby'
-      content = "#{prompt} #{File.read(input)}"
-      make(content, "#{path}/#{name}_steps.rb")
-    else
-      make(options[:open_ai], "#{path}/#{name}_steps.rb")
-    end
-  end
-
-  desc 'test', 'Uses open AI to create a file or generate output'
-  def test
-    conn = Faraday.new(url: 'https://api.openai.com') do |faraday|
-      faraday.headers['Content-Type'] = 'application/json'
-      faraday.headers['Authorization'] = "Bearer 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"
-      faraday.headers['OpenAI-Beta'] = 'assistants=v1'
-    end
-
-    # Data payload for the POST request
-    payload = {
-      instructions: "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
-      name: "Math Tutor",
-      tools: [{ type: "code_interpreter" }],
-      model: "gpt-4-1106-preview"
-    }
-
-    # Perform the POST request
-    response = conn.post('/v1/assistants', payload.to_json)
-
-    # Output the response body
-    puts response.body
-  end
-end

data/lib/open_ai/open_ai.rb

@@ -1,67 +0,0 @@
-require 'openai'
-require 'fileutils'
-
-module OpenAi
-  class << self
-    def client
-      @client ||= create_client
-    end
-
-    def create_client
-      configure_client
-      OpenAI::Client.new
-    end
-
-    def configure_client
-      OpenAI.configure do |config|
-        config.access_token = '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'
-        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID', nil)
-      end
-    end
-
-    def input(request, model = 'gpt-4', temperature = 0.7)
-      client.chat(
-        parameters: {
-          model: model,
-          messages: [{ role: 'user', content: request }],
-          temperature: temperature
-        })
-    end
-
-    def create_file(options)
-      path, request, choice = options.values_at(:path, :request, :choice)
-      File.write(path, output(request: request, choice: choice))
-    end
-
-    def output(options)
-      request, choice = options.values_at(:request, :choice)
-      choice ||= 0
-      extract_text(input(request), 'choices', choice, 'message', 'content')
-    end
-
-    def edit_file(options)
-      path, request, choice = options.values_at(:path, :request, :choice)
-      content = File.read(path)
-      response = edit(content: content, request: request)
-      File.write(path, extract_text(response, 'choices', choice, 'text'))
-    end
-
-    def edit(options)
-      content, request, model = options.values_at(:content, :request, :model)
-      model ||= 'text-davinci-edit-001'
-      client.edits(
-        parameters: {
-          model: model,
-          input: content,
-          instruction: request
-        }
-      )
-    end
-
-    private
-
-    def extract_text(response, *keys)
-      response.dig(*keys)
-    end
-  end
-end

data/spec/integration/commands/open_ai_commands_spec.rb

@@ -1,37 +0,0 @@
-# require 'dotenv'
-# require 'fileutils'
-# require 'pathname'
-# require 'yaml'
-# require_relative '../../../lib/generators/common_generator'
-# require_relative '../../../lib/integration.commands/open_ai_commands'
-# require_relative '../../../lib/scaffolding/scaffolding'
-# require_relative '../../spec_helper'
-#
-# describe OpenAiCommands do
-#   let(:open_ai) { described_class }
-#   let(:name) { 'test' }
-#
-#   orig_dir = Dir.pwd
-#   Dotenv.load
-#
-#   after do
-#     Dir.chdir orig_dir
-#   end
-#
-#   context 'without any project' do
-#     after do
-#       FileUtils.rm_rf('joke.txt')
-#     end
-#
-#     # TODO: Enable test once the paid account is setup
-#     # it 'creates a file using open ai' do
-#     #   open_ai.new.invoke(:make, nil, ['tell me a joke', '--path', 'joke.txt'])
-#     #   expect(File).to be_size('joke.txt')
-#     # end
-#
-#     # it 'edits an existing file using open ai' do
-#     # FileUtils.touch('joke.txt')
-#     # open_ai.new.invoke(:make, nil, ['tell me a better joke', '--edit', 'joke.txt'])
-#     # end
-#   end
-# end