ruby_raider 2.0.0 → 3.0.0

data/lib/generators/menu_generator.rb

@@ -3,8 +3,6 @@
 require 'tty-prompt'
 require_relative '../generators/invoke_generators'
 
-# :reek:FeatureEnvy { enabled: false }
-# :reek:UtilityFunction { enabled: false }
 class MenuGenerator
   attr_reader :prompt, :name
 
@@ -32,10 +30,16 @@ class MenuGenerator
       automation: options[:automation],
       framework: options[:framework],
       ci_platform: options[:ci_platform],
+      reporter: options[:reporter],
+      accessibility: options[:accessibility],
+      visual: options[:visual],
+      performance: options[:performance],
+      ruby_version: options[:ruby_version],
       name: @name
     }
     generate_framework(structure)
     system "cd #{name} && gem install bundler && bundle install"
+    offer_desktop_download
   end
 
   def choose_mobile_platform
@@ -49,6 +53,25 @@ class MenuGenerator
 
   private
 
+  def offer_desktop_download
+    return unless prompt.yes?('Would you like to download Raider Desktop (GUI companion app)?')
+
+    require_relative '../utilities/desktop_downloader'
+    version = DesktopDownloader.latest_version
+    unless version
+      prompt.warn('Could not reach GitHub releases. You can download it later with: raider u desktop')
+      return
+    end
+
+    prompt.say("Downloading Raider Desktop v#{version} for #{DesktopDownloader.platform_display_name}...")
+    result = DesktopDownloader.download
+    if result
+      prompt.ok("Downloaded to: #{result}")
+    else
+      prompt.warn('No release found for your platform. Visit: https://github.com/RaiderHQ/raider_desktop/releases')
+    end
+  end
+
   def select_test_framework(automation)
     prompt.select('Please select your test framework') do |menu|
       menu.choice :Cucumber, -> { select_ci_platform('Cucumber', automation) }
@@ -58,21 +81,109 @@ class MenuGenerator
     end
   end
 
-  FrameworkOptions = Struct.new(:automation, :framework, :ci_platform)
+  FrameworkOptions = Struct.new(:automation, :framework, :ci_platform, :reporter, :accessibility, :visual, :performance,
+                                :ruby_version)
 
   def create_framework_options(params)
-    FrameworkOptions.new(params[:automation], params[:framework], params[:ci_platform])
+    FrameworkOptions.new(params[:automation], params[:framework], params[:ci_platform], params[:reporter],
+                         params[:accessibility], params[:visual], params[:performance], params[:ruby_version])
+  end
+
+  def select_reporter(framework, automation_type, ci_platform = nil)
+    prompt.select('Select your test reporter') do |menu|
+      menu.choice :Allure, -> { select_accessibility(framework, automation_type, ci_platform, 'allure') }
+      menu.choice :JUnit, -> { select_accessibility(framework, automation_type, ci_platform, 'junit') }
+      menu.choice :JSON, -> { select_accessibility(framework, automation_type, ci_platform, 'json') }
+      menu.choice :Both, -> { select_accessibility(framework, automation_type, ci_platform, 'both') }
+      menu.choice :All, -> { select_accessibility(framework, automation_type, ci_platform, 'all') }
+      menu.choice :None, -> { select_accessibility(framework, automation_type, ci_platform, 'none') }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
+  def select_accessibility(framework, automation_type, ci_platform = nil, reporter = nil)
+    return create_framework(framework, automation_type, ci_platform:, reporter:) if mobile_automation?(automation_type)
+
+    prompt.select('Add accessibility testing (axe)?') do |menu|
+      menu.choice :Yes, -> { select_visual(framework, automation_type, ci_platform, reporter, accessibility: true) }
+      menu.choice :No, -> { select_visual(framework, automation_type, ci_platform, reporter) }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
+  def select_visual(framework, automation_type, ci_platform = nil, reporter = nil, accessibility: false)
+    prompt.select('Add visual regression testing?') do |menu|
+      menu.choice :Yes, lambda {
+        select_performance(framework, automation_type, ci_platform, reporter, accessibility:, visual: true)
+      }
+      menu.choice :No, lambda {
+        select_performance(framework, automation_type, ci_platform, reporter, accessibility:)
+      }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
+  def select_performance(framework, automation_type, ci_platform = nil, reporter = nil, accessibility: false,
+                         visual: false)
+    prompt.select('Add Lighthouse performance auditing?') do |menu|
+      menu.choice :Yes, lambda {
+        select_ruby_version(framework, automation_type, ci_platform:, reporter:, accessibility:, visual:,
+                            performance: true)
+      }
+      menu.choice :No, lambda {
+        select_ruby_version(framework, automation_type, ci_platform:, reporter:, accessibility:, visual:)
+      }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
+  def select_ruby_version(framework, automation_type, ci_platform: nil, reporter: nil, accessibility: false,
+                          visual: false, performance: false)
+    prompt.select('Select Ruby version for your project') do |menu|
+      menu.choice :'3.4 (latest)', lambda {
+        create_framework(framework, automation_type, ci_platform:, reporter:, accessibility:, visual:, performance:,
+                         ruby_version: '3.4')
+      }
+      menu.choice :'3.3', lambda {
+        create_framework(framework, automation_type, ci_platform:, reporter:, accessibility:, visual:, performance:,
+                         ruby_version: '3.3')
+      }
+      menu.choice :'3.2', lambda {
+        create_framework(framework, automation_type, ci_platform:, reporter:, accessibility:, visual:, performance:,
+                         ruby_version: '3.2')
+      }
+      menu.choice :'3.1', lambda {
+        create_framework(framework, automation_type, ci_platform:, reporter:, accessibility:, visual:, performance:,
+                         ruby_version: '3.1')
+      }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
+  def mobile_automation?(automation_type)
+    %w[ios android cross_platform].include?(automation_type)
   end
 
-  def create_framework(framework, automation_type, ci_platform = nil)
+  def create_framework(framework, automation_type, ci_platform: nil, reporter: nil, accessibility: false,
+                       visual: false, performance: false, ruby_version: nil)
     options = create_framework_options(automation: automation_type,
                                        framework: framework.downcase,
-                                       ci_platform:)
+                                       ci_platform:,
+                                       reporter:,
+                                       accessibility:,
+                                       visual:,
+                                       performance:,
+                                       ruby_version:)
 
     puts 'Chosen Options:'
     puts "  Automation Type: #{options[:automation]}"
     puts "  Framework: #{options[:framework]}"
     puts "  CI Platform: #{options[:ci_platform]}" if options[:ci_platform]
+    puts "  Reporter: #{options[:reporter]}" if options[:reporter]
+    puts '  Accessibility: enabled' if options[:accessibility]
+    puts '  Visual Testing: enabled' if options[:visual]
+    puts '  Performance Auditing: enabled' if options[:performance]
+    puts "  Ruby Version: #{options[:ruby_version]}" if options[:ruby_version]
 
     set_up_framework(options)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
@@ -96,15 +207,13 @@ class MenuGenerator
     menu.choice :Capybara, -> { choose_test_framework('capybara') }
     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') }
   end
 
   def select_ci_platform(framework, automation)
     prompt.select('Would you like to configure CI?') do |menu|
-      menu.choice :'Github Actions', -> { create_framework(framework, automation, 'github') }
-      menu.choice :'Gitlab CI/CD', -> { create_framework(framework, automation, 'gitlab') }
-      menu.choice :No, -> { create_framework(framework, automation) }
+      menu.choice :'Github Actions', -> { select_reporter(framework, automation, 'github') }
+      menu.choice :'Gitlab CI/CD', -> { select_reporter(framework, automation, 'gitlab') }
+      menu.choice :No, -> { select_reporter(framework, automation) }
       menu.choice :Quit, -> { exit }
     end
   end

data/lib/generators/minitest/minitest_generator.rb

@@ -4,7 +4,7 @@ require_relative '../generator'
 
 class MinitestGenerator < Generator
   def generate_login_test
-    return unless web? && !visual?
+    return unless web?
 
     template('test.tt', "#{name}/test/test_login_page.rb")
   end
@@ -15,9 +15,21 @@ class MinitestGenerator < Generator
     template('test.tt', "#{name}/test/test_pdp_page.rb")
   end
 
-  def generate_account_test
-    return unless visual?
+  def generate_visual_test
+    return unless visual_addon? && web?
 
-    template('test.tt', "#{name}/test/test_account_page.rb")
+    template('visual_test.tt', "#{name}/test/test_visual.rb")
+  end
+
+  def generate_accessibility_test
+    return unless axe_addon? && web?
+
+    template('accessibility_test.tt', "#{name}/test/test_accessibility.rb")
+  end
+
+  def generate_performance_test
+    return unless lighthouse_addon? && web?
+
+    template('performance_test.tt', "#{name}/test/test_performance.rb")
   end
 end

data/lib/generators/minitest/templates/accessibility_test.tt

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/test_helper'
+
+class TestAccessibility < Minitest::Test
+  def setup
+    super
+    <% if capybara? -%>
+visit '/'
+    <% elsif watir? -%>
+browser.goto 'https://raider-test-site.onrender.com/'
+    <% else -%>
+driver.get 'https://raider-test-site.onrender.com/'
+    <% end -%>
+  end
+
+  def test_no_accessibility_violations_on_page
+    <% if capybara? -%>
+assert_axe_clean page
+    <% elsif watir? -%>
+assert_axe_clean browser.driver
+    <% else -%>
+assert_axe_clean driver
+    <% end -%>
+  end
+end

data/lib/generators/minitest/templates/performance_test.tt

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/test_helper'
+require_relative '../helpers/performance_helper'
+
+class TestPerformance < Minitest::Test
+  include PerformanceHelper
+
+  def test_meets_performance_threshold
+    result = assert_performance_above('https://raider-test-site.onrender.com/', threshold: 0.7)
+
+    refute_equal :error, result[:status],
+      "Lighthouse error: #{result[:message]}"
+
+    assert result[:passed],
+      "Performance below threshold (#{result[:threshold]}): #{result[:scores]}"
+  end
+end

data/lib/generators/minitest/templates/test.tt

@@ -6,33 +6,11 @@ require_relative '../models/model_factory'
 require_relative '../page_objects/pages/account'
 require_relative '../page_objects/pages/login'
 
-<%- if axe? %>
-class TestLogin < Minitest::Test
-  def setup
-    @login = Login.new(driver)
-    @account = Account.new(driver)
-    @user = ModelFactory.for('users')['registered user']
-    @login.visit
-    @login.log_as(@user['username'], @user['password'])
-  end
-
-  def teardown
-    driver.quit
-  end
+# Uncomment for interactive debugging:
+# require 'debug'    # Ruby's built-in debugger (binding.break)
+# require 'pry'      # Pry debugger (binding.pry)
 
-  def test_no_accessibility_errors_on_page
-    assert_axe_clean @account.page
-  end
-
-  def test_no_accessibility_errors_on_transaction_history
-    assert_axe_clean @account.page, within: '.account-card'
-  end
-
-  def test_no_accessibility_errors_on_heading
-    assert_axe_clean @account.page, within: '.page-title'
-  end
-end
-<%- elsif selenium_based? || watir? || capybara? -%>
+<%- if selenium_based? || watir? || capybara? -%>
 class TestLogin < Minitest::Test
   def setup
     @user = ModelFactory.for('users')['registered user']
@@ -45,25 +23,18 @@ class TestLogin < Minitest::Test
   end
 
   def test_login_with_right_credentials
+    # binding.break  # Uncomment to pause here and inspect state
     @login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
     @login_page.login(@user['username'], @user['password'])
-  <%- if visual? -%>
-    check_page @account_page
-  <%- else -%>
     @account_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
     assert_equal "Welcome back #{@user['name']}", @account_page.header.customer_name
-  <%- end -%>
   end
 
   def test_login_with_wrong_credentials
     @login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
     @login_page.login(@user['username'], 'wrongPassword')
-  <%- if visual? -%>
-    check_page @login_page
-  <%- else -%>
     @login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
     assert_equal 'Login or register', @account_page.header.customer_name
-  <%- end -%>
   end
 end
 <%- end -%>

data/lib/generators/minitest/templates/visual_test.tt

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/test_helper'
+require_relative '../helpers/visual_helper'
+require_relative '../page_objects/pages/login'
+
+class TestVisualRegression < Minitest::Test
+  include VisualHelper
+
+  def setup
+    super
+    @login_page = <% if capybara? -%>Login.new<% elsif watir? -%>Login.new(browser)<% else -%>Login.new(driver)<% end %>
+  end
+
+  def test_login_page_matches_baseline
+    @login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
+    screenshot_path = <% if capybara? -%>page.save_screenshot('tmp/visual_login.png')<% elsif watir? -%>browser.screenshot.save('tmp/visual_login.png')<% else -%>driver.save_screenshot('tmp/visual_login.png')<% end %>
+    result = compare_screenshot('login_page', screenshot_path)
+
+    refute_equal :mismatch, result[:status],
+      "Visual diff: #{(result[:diff].to_f * 100).round(2)}% difference. See: #{result[:diff_path]}"
+  end
+end

data/lib/generators/rspec/rspec_generator.rb

@@ -4,7 +4,7 @@ require_relative '../generator'
 
 class RspecGenerator < Generator
   def generate_login_spec
-    return unless web? && !visual?
+    return unless web?
 
     template('spec.tt', "#{name}/spec/login_page_spec.rb")
   end
@@ -15,9 +15,21 @@ class RspecGenerator < Generator
     template('spec.tt', "#{name}/spec/pdp_page_spec.rb")
   end
 
-  def generate_account_spec
-    return unless visual?
+  def generate_visual_spec
+    return unless visual_addon? && web?
 
-    template('spec.tt', "#{name}/spec/account_page_spec.rb")
+    template('visual_spec.tt', "#{name}/spec/visual_spec.rb")
+  end
+
+  def generate_accessibility_spec
+    return unless axe_addon? && web?
+
+    template('accessibility_spec.tt', "#{name}/spec/accessibility_spec.rb")
+  end
+
+  def generate_performance_spec
+    return unless lighthouse_addon? && web?
+
+    template('performance_spec.tt', "#{name}/spec/performance_spec.rb")
   end
 end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/spec_helper'
+
+describe 'Accessibility' do
+  before do
+    <% if capybara? -%>
+visit '/'
+    <% elsif watir? -%>
+browser.goto 'https://raider-test-site.onrender.com/'
+    <% else -%>
+driver.get 'https://raider-test-site.onrender.com/'
+    <% end -%>
+  end
+
+  it 'has no accessibility violations on the page' do
+    <% if capybara? -%>
+expect(page).to be_axe_clean
+    <% elsif watir? -%>
+expect(browser.driver).to be_axe_clean
+    <% else -%>
+expect(driver).to be_axe_clean
+    <% end -%>
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/spec_helper'
+require_relative '../helpers/performance_helper'
+
+describe 'Performance Audit' do
+  include PerformanceHelper
+
+  it 'meets performance threshold' do
+    result = assert_performance_above('https://raider-test-site.onrender.com/', threshold: 0.7)
+
+    expect(result[:status]).not_to eq(:error),
+      "Lighthouse error: #{result[:message]}"
+
+    expect(result[:passed]).to be(true),
+      "Performance below threshold (#{result[:threshold]}): #{result[:scores]}"
+  end
+end

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

@@ -6,34 +6,11 @@ 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
+# Uncomment for interactive debugging:
+# require 'debug'    # Ruby's built-in debugger (binding.break)
+# require 'pry'      # Pry debugger (binding.pry)
 
-    it 'no accessibility errors are present on the transaction history' do
-      account_details = '.account-card'
-      expect(account.page).to be_axe_clean.within account_details
-    end
-
-    it 'no accessibility errors are present on the heading' do
-      heading = '.page-title'
-      expect(account.page).to be_axe_clean.within heading
-    end
-  end
-end
-<%- elsif selenium_based? || watir? || capybara? -%>
+<%- if selenium_based? || watir? || capybara? -%>
 describe 'Login' do
   subject(:header) { account_page.header.customer_name }
 
@@ -50,12 +27,9 @@ describe 'Login' do
     let(:password) { user['password'] }
 
     it 'can successfully log in' do
-    <%- if visual? -%>
-      check_page account_page
-    <%- else -%>
+      # binding.break  # Uncomment to pause here and inspect state
       account_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
       expect(header).to eq "Welcome back #{user['name']}"
-    <%- end -%>
     end
   end
 
@@ -63,12 +37,8 @@ describe 'Login' do
     let(:password) { 'wrongPassword' }
 
     it 'cannot log in' do
-    <%- if visual? -%>
-      check_page login_page
-    <%- else -%>
       login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
       expect(header).to eq 'Login or register'
-    <%- end -%>
     end
   end
 end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/spec_helper'
+require_relative '../helpers/visual_helper'
+require_relative '../page_objects/pages/login'
+
+describe 'Visual Regression' do
+  include VisualHelper
+
+  let(:login_page) { <% if capybara? -%>Login.new<% elsif watir? -%>Login.new(browser)<% else -%>Login.new(driver)<% end -%> }
+
+  it 'login page matches baseline' do
+    login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
+    screenshot_path = <% if capybara? -%>page.save_screenshot('tmp/visual_login.png')<% elsif watir? -%>browser.screenshot.save('tmp/visual_login.png')<% else -%>driver.save_screenshot('tmp/visual_login.png')<% end %>
+    result = compare_screenshot('login_page', screenshot_path)
+
+    expect(result[:status]).not_to eq(:mismatch),
+      "Visual diff: #{(result[:diff].to_f * 100).round(2)}% difference. See: #{result[:diff_path]}"
+  end
+end

data/lib/generators/template_renderer/partial_cache.rb

@@ -16,9 +16,13 @@ module TemplateRenderer
   #
   # Performance: ~10x speedup on cached renders (135ms → ~13.5ms)
   class PartialCache
+    # Set to true during batch generation to skip File.mtime syscalls on cache hits
+    attr_accessor :batch_mode
+
     def initialize(generator_class)
       @cache = {}
       @resolver = PartialResolver.new(generator_class)
+      @batch_mode = false
     end
 
     # Render a partial with caching
@@ -81,9 +85,15 @@ module TemplateRenderer
       "#{name}:#{trim_mode}"
     end
 
-    # Get cached ERB or compile and cache it
+    # Get cached ERB or compile and cache it.
+    # In batch_mode, skip File.mtime syscalls on cache hits since templates
+    # don't change mid-generation (~2-5ms saved per partial render).
     def get_or_compile(cache_key, path, trim_mode)
       cached = @cache[cache_key]
+
+      # Fast path: batch mode cache hit (skip mtime check)
+      return cached[:erb] if cached && @batch_mode
+
       current_mtime = File.mtime(path)
 
       # Cache miss or stale cache (file modified)

data/lib/generators/template_renderer/partial_resolver.rb

@@ -78,18 +78,13 @@ module TemplateRenderer
       nil
     end
 
-    # Search all Generator.source_paths for the partial
-    # Checks both source_path/partials/ and source_path/*/partials/
+    # Search all Generator.source_paths for the partial.
+    # Uses a cached directory index to avoid repeated Dir.glob calls.
     def search_source_paths(partial_filename)
-      source_paths.each do |source_path|
-        # First try direct partials directory
-        full_path = File.join(source_path, PARTIALS_DIR, partial_filename)
+      # Check the pre-built index first (fast path)
+      partial_dirs.each do |dir|
+        full_path = File.join(dir, partial_filename)
         return { found: File.expand_path(full_path), searched: [full_path] } if File.exist?(full_path)
-
-        # Then try subdirectories (e.g., templates/common/partials/, templates/helpers/partials/)
-        Dir.glob(File.join(source_path, '*', PARTIALS_DIR, partial_filename)).each do |path|
-          return { found: File.expand_path(path), searched: [path] } if File.exist?(path)
-        end
       end
 
       { found: nil, searched: [] }
@@ -99,5 +94,17 @@ module TemplateRenderer
     def source_paths
       @source_paths ||= @generator_class.source_paths || []
     end
+
+    # Pre-built index of all directories that could contain partials.
+    # Scanned once via Dir.glob, then reused for every partial lookup.
+    def partial_dirs
+      @partial_dirs ||= source_paths.flat_map do |source_path|
+        dirs = []
+        direct = File.join(source_path, PARTIALS_DIR)
+        dirs << direct if File.directory?(direct)
+        Dir.glob(File.join(source_path, '*', PARTIALS_DIR)).each { |d| dirs << d }
+        dirs
+      end
+    end
   end
 end

data/lib/generators/template_renderer.rb

@@ -77,14 +77,30 @@ module TemplateRenderer
     end
 
     # Clear the template cache (useful for testing)
+    # Clears cache for this class and all subclasses
     def clear_template_cache
       @template_renderer&.clear
       @template_renderer = nil
+      subclasses.each do |subclass|
+        subclass.clear_template_cache if subclass.respond_to?(:clear_template_cache)
+      end
     end
 
     # Get cache statistics (useful for debugging)
+    # Aggregates stats across this class and all subclasses
     def template_cache_stats
-      @template_renderer&.stats || { size: 0, entries: [], memory_estimate: 0 }
+      own = @template_renderer&.stats || { size: 0, entries: [], memory_estimate: 0 }
+      subclasses.each do |subclass|
+        next unless subclass.respond_to?(:template_cache_stats)
+
+        sub_stats = subclass.instance_variable_get(:@template_renderer)&.stats
+        next unless sub_stats
+
+        own[:size] += sub_stats[:size]
+        own[:entries].concat(sub_stats[:entries])
+        own[:memory_estimate] += sub_stats[:memory_estimate]
+      end
+      own
     end
   end
 end