ruby_raider 3.11.0 → 3.12.0

data/lib/generators/menu_generator.rb

@@ -31,6 +31,7 @@ class MenuGenerator
       framework: options[:framework],
       accessibility: options[:accessibility],
       ci: options[:ci],
+      examples: options[:examples],
       name: @name
     }
     generate_framework(structure)
@@ -70,32 +71,43 @@ class MenuGenerator
 
   def select_test_framework(automation)
     prompt.select('Please select your test framework') do |menu|
-      menu.choice :Cucumber, -> { select_accessibility('Cucumber', automation) }
-      menu.choice :Rspec, -> { select_accessibility('Rspec', automation) }
+      menu.choice :Cucumber, -> { select_examples('Cucumber', automation) }
+      menu.choice :Rspec, -> { select_examples('Rspec', automation) }
       menu.choice :Quit, -> { exit }
     end
   end
 
-  FrameworkOptions = Struct.new(:automation, :framework, :accessibility, :ci)
+  def select_examples(framework, automation_type)
+    prompt.select('Do you want example tests?') do |menu|
+      menu.choice :Yes, -> { select_accessibility(framework, automation_type, examples: true) }
+      menu.choice :No, -> { select_accessibility(framework, automation_type, examples: false) }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
+  FrameworkOptions = Struct.new(:automation, :framework, :accessibility, :ci, :examples)
 
   def create_framework_options(params)
-    FrameworkOptions.new(params[:automation], params[:framework], params[:accessibility], params[:ci])
+    FrameworkOptions.new(params[:automation], params[:framework], params[:accessibility], params[:ci],
+                         params[:examples])
   end
 
-  def select_accessibility(framework, automation_type)
-    return create_framework(framework, automation_type) if mobile_automation?(automation_type)
+  def select_accessibility(framework, automation_type, examples: true)
+    return create_framework(framework, automation_type, examples:) if mobile_automation?(automation_type)
 
     prompt.select('Add accessibility testing (axe)?') do |menu|
-      menu.choice :Yes, -> { select_ci(framework, automation_type, accessibility: true) }
-      menu.choice :No, -> { select_ci(framework, automation_type, accessibility: false) }
+      menu.choice :Yes, -> { select_ci(framework, automation_type, accessibility: true, examples:) }
+      menu.choice :No, -> { select_ci(framework, automation_type, accessibility: false, examples:) }
       menu.choice :Quit, -> { exit }
     end
   end
 
-  def select_ci(framework, automation_type, accessibility:)
+  def select_ci(framework, automation_type, accessibility:, examples: true)
     prompt.select('Which CI provider?') do |menu|
-      menu.choice 'GitHub Actions', -> { create_framework(framework, automation_type, accessibility:) }
-      menu.choice 'Azure Pipelines', -> { create_framework(framework, automation_type, accessibility:, ci_provider: 'azure') }
+      menu.choice 'GitHub Actions', -> { create_framework(framework, automation_type, accessibility:, examples:) }
+      menu.choice 'Azure Pipelines', lambda {
+        create_framework(framework, automation_type, accessibility:, ci_provider: 'azure', examples:)
+      }
       menu.choice :Quit, -> { exit }
     end
   end
@@ -104,16 +116,17 @@ class MenuGenerator
     %w[ios android cross_platform].include?(automation_type)
   end
 
-  def create_framework(framework, automation_type, accessibility: false, ci_provider: nil)
+  def create_framework(framework, automation_type, accessibility: false, ci_provider: nil, examples: true)
     options = create_framework_options(automation: automation_type,
                                        framework: framework.downcase,
-                                       accessibility:, ci: ci_provider)
+                                       accessibility:, ci: ci_provider, examples:)
 
     puts 'Chosen Options:'
     puts "  Automation Type: #{options[:automation]}"
     puts "  Framework: #{options[:framework]}"
     puts '  Accessibility: enabled' if options[:accessibility]
     puts '  CI: Azure Pipelines' if options[:ci] == 'azure'
+    puts '  Example tests: none' unless options[:examples]
 
     set_up_framework(options)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
@@ -135,6 +148,5 @@ class MenuGenerator
   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') }
   end
 end

data/lib/generators/rspec/rspec_generator.rb

@@ -3,20 +3,27 @@
 require_relative '../generator'
 
 class RspecGenerator < Generator
+  # A skeleton has an empty spec/ (the generated CI runs `rspec spec`), and no example specs
+  def generate_empty_spec_folder
+    return if examples?
+
+    create_file("#{name}/spec/.keep", '')
+  end
+
   def generate_login_spec
-    return unless web?
+    return unless web? && examples?
 
     template('spec.tt', "#{name}/spec/login_page_spec.rb")
   end
 
   def generate_pdp_spec
-    return unless mobile?
+    return unless mobile? && examples?
 
     template('spec.tt', "#{name}/spec/pdp_page_spec.rb")
   end
 
   def generate_accessibility_spec
-    return unless axe_addon? && web?
+    return unless axe_addon? && web? && examples?
 
     template('accessibility_spec.tt', "#{name}/spec/accessibility_spec.rb")
   end

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

@@ -8,8 +8,10 @@ require_relative '../page_objects/pages/login'
 
 # rubocop:disable RSpec/MultipleDescribes
 describe 'Login' do
+<%- if watir? -%>
   subject(:header) { account_page.header.customer_name }
 
+<%- end -%>
   let(:user) { ModelFactory.for('users')['registered user'] }
   let(:login_page) { <% if watir? -%>Login.new(browser)<% else -%>Login.new(driver)<% end -%> }
   let(:account_page) { <% if watir? -%>Account.new(browser)<% else -%>Account.new(driver)<% end -%> }
@@ -24,7 +26,11 @@ describe 'Login' do
 
     it 'can successfully log in' do
       account_page.visit
+<%- if watir? -%>
       expect(header).to eq "Welcome back #{user['name']}"
+<%- else -%>
+      eventually { expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}" }
+<%- end -%>
     end
   end
 
@@ -33,7 +39,11 @@ describe 'Login' do
 
     it 'cannot log in' do
       login_page.visit
+<%- if watir? -%>
       expect(header).to eq 'Login or register'
+<%- else -%>
+      eventually { expect(account_page.header.customer_name).to eq 'Login or register' }
+<%- end -%>
     end
   end
 end
@@ -44,7 +54,11 @@ describe 'Account', :logged_in do
 
   it 'opens the account page with the saved login' do
     account_page.visit
+<%- if watir? -%>
     expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}"
+<%- else -%>
+    eventually { expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}" }
+<%- end -%>
   end
 end
 # rubocop:enable RSpec/MultipleDescribes
@@ -64,7 +78,7 @@ class PdpSpec
 
     it 'shows add to cart button' do
       home_page.go_to_product_detail
-      expect(pdp_page.add_to_cart_text).to eq 'Add to Cart'
+      eventually { expect(pdp_page.add_to_cart_text).to eq 'Add to Cart' }
     end
   end
 end

data/lib/generators/template_renderer/template_error.rb

@@ -16,11 +16,11 @@ module TemplateRenderer
   # Raised when a partial template cannot be found
   class TemplateNotFoundError < TemplateError
     def to_s
-      message_parts = ["Partial '#{@partial_name}' not found."]
+      message_parts = ["Partial '#{partial_name}' not found."]
 
-      if @searched_paths.any?
+      if searched_paths.any?
         message_parts << "\nSearched in:"
-        message_parts.concat(@searched_paths.map { |path| "  - #{path}" })
+        message_parts.concat(searched_paths.map { |path| "  - #{path}" })
       end
 
       message_parts.join("\n")
@@ -34,13 +34,13 @@ module TemplateRenderer
     end
 
     def to_s
-      message_parts = ["Error rendering partial '#{@partial_name}': #{super()}"]
+      message_parts = ["Error rendering partial '#{partial_name}': #{super()}"]
 
-      if @original_error
-        message_parts << "\nOriginal error: #{@original_error.class}: #{@original_error.message}"
-        if @original_error.backtrace
+      if original_error
+        message_parts << "\nOriginal error: #{original_error.class}: #{original_error.message}"
+        if original_error.backtrace
           message_parts << "\nBacktrace:"
-          message_parts.concat(@original_error.backtrace.first(5).map { |line| "  #{line}" })
+          message_parts.concat(original_error.backtrace.first(5).map { |line| "  #{line}" })
         end
       end
 

data/lib/generators/templates/common/partials/mobile_config.tt

@@ -1,4 +1,5 @@
 platform: :ios
+timeout: 10 # seconds that actions and eventually wait before failing
 
 video:
   enabled: true

data/lib/generators/templates/common/partials/web_config.tt

@@ -1,6 +1,6 @@
 browser: chrome
 url: 'https://raider-test-site.onrender.com/'
-timeout: 10 # seconds — used for implicit waits and max wait time
+timeout: 10 # <%= wait_helper? ? 'seconds that actions and eventually wait before failing' : 'seconds — used for implicit waits and max wait time' %>
 viewport:
   width: 1920
   height: 1080