ruby_raider 3.0.1 → 3.2.0

data/lib/adopter/project_detector.rb

@@ -1,157 +0,0 @@
-# frozen_string_literal: true
-
-module Adopter
-  module ProjectDetector
-    GEM_AUTOMATION_MAP = {
-      'site_prism' => 'capybara',
-      'capybara' => 'capybara',
-      'selenium-webdriver' => 'selenium',
-      'watir' => 'watir',
-      'appium_lib' => 'appium',
-      'eyes_selenium' => 'selenium',
-      'axe-core-selenium' => 'selenium',
-      'axe-core-rspec' => 'selenium'
-    }.freeze
-
-    GEM_FRAMEWORK_MAP = {
-      'cucumber' => 'cucumber',
-      'rspec' => 'rspec',
-      'minitest' => 'minitest'
-    }.freeze
-
-    BROWSERS = %w[chrome firefox safari edge].freeze
-
-    module_function
-
-    def detect(path = '.')
-      {
-        automation: detect_automation(path),
-        framework: detect_framework(path),
-        page_path: detect_page_path(path),
-        spec_path: detect_spec_path(path),
-        feature_path: detect_feature_path(path),
-        helper_path: detect_helper_path(path),
-        browser: detect_browser(path),
-        url: detect_url(path),
-        ci_platform: detect_ci_platform(path)
-      }.compact
-    end
-
-    def detect_automation(path)
-      gems = parse_gemfile(path)
-      GEM_AUTOMATION_MAP.each do |gem_name, automation|
-        return automation if gems.include?(gem_name)
-      end
-      detect_automation_from_requires(path)
-    end
-
-    def detect_framework(path)
-      gems = parse_gemfile(path)
-      GEM_FRAMEWORK_MAP.each do |gem_name, framework|
-        return framework if gems.include?(gem_name)
-      end
-      return 'rspec' if Dir.exist?(File.join(path, 'spec'))
-      return 'cucumber' if Dir.exist?(File.join(path, 'features'))
-      return 'minitest' if Dir.exist?(File.join(path, 'test'))
-
-      nil
-    end
-
-    def detect_page_path(path)
-      candidates = %w[page_objects/pages page_objects pages page]
-      find_existing_dir(path, candidates)
-    end
-
-    def detect_spec_path(path)
-      candidates = %w[spec spec/features spec/tests test tests]
-      find_existing_dir(path, candidates)
-    end
-
-    def detect_feature_path(path)
-      candidates = %w[features features/scenarios]
-      find_existing_dir(path, candidates)
-    end
-
-    def detect_helper_path(path)
-      candidates = %w[helpers support spec/support features/support]
-      find_existing_dir(path, candidates)
-    end
-
-    def detect_browser(path)
-      config_files = helper_and_config_files(path)
-      config_files.each do |file|
-        next unless File.exist?(file)
-
-        content = File.read(file)
-        BROWSERS.each do |browser|
-          return browser if content.match?(/(?:browser|driver)\s*[:=]\s*[:'"]?#{browser}\b/i)
-        end
-      end
-      nil
-    end
-
-    def detect_url(path)
-      config_files = helper_and_config_files(path)
-      config_files.each do |file|
-        next unless File.exist?(file)
-
-        content = File.read(file)
-        match = content.match(%r{(?:base_url|url|app_host)\s*[:=]\s*['"]?(https?://[^\s'"]+)})
-        return match[1] if match
-      end
-      nil
-    end
-
-    def detect_ci_platform(path)
-      return 'github' if Dir.exist?(File.join(path, '.github', 'workflows'))
-      return 'gitlab' if File.exist?(File.join(path, '.gitlab-ci.yml'))
-
-      nil
-    end
-
-    def parse_gemfile(path)
-      gemfile = File.join(path, 'Gemfile')
-      return [] unless File.exist?(gemfile)
-
-      File.readlines(gemfile).filter_map do |line|
-        match = line.match(/^\s*gem\s+['"]([^'"]+)['"]/)
-        match[1] if match
-      end
-    end
-
-    def detect_automation_from_requires(path)
-      ruby_files = Dir.glob(File.join(path, '**', '*.rb'))
-      ruby_files.first(50).each do |file|
-        content = File.read(file)
-        return 'capybara' if content.include?("require 'capybara'") || content.include?("require 'site_prism'")
-        return 'selenium' if content.include?("require 'selenium-webdriver'")
-        return 'watir' if content.include?("require 'watir'")
-        return 'appium' if content.include?("require 'appium_lib'")
-      end
-      nil
-    end
-
-    def find_existing_dir(path, candidates)
-      candidates.each do |candidate|
-        return candidate if Dir.exist?(File.join(path, candidate))
-      end
-      nil
-    end
-
-    def helper_and_config_files(path)
-      explicit = [
-        File.join(path, 'config', 'config.yml'),
-        File.join(path, 'spec', 'spec_helper.rb'),
-        File.join(path, 'test', 'test_helper.rb'),
-        File.join(path, 'features', 'support', 'env.rb'),
-        File.join(path, 'support', 'env.rb'),
-        File.join(path, '.env')
-      ]
-      helpers = Dir.glob(File.join(path, '**', '*helper*.rb')).first(10)
-      explicit + helpers
-    end
-
-    private_class_method :detect_automation_from_requires, :find_existing_dir,
-                         :helper_and_config_files, :parse_gemfile
-  end
-end

data/lib/generators/cucumber/templates/partials/capybara_env.tt

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec'
-require 'tmpdir'
-require_relative '../../helpers/allure_helper'
-require_relative '../../helpers/capybara_helper'
-require_relative '../../helpers/video_helper'
-require_relative '../../helpers/debug_helper'
-
-CapybaraHelper.configure
-
-Before do
-  viewport = YAML.load_file('config/config.yml')['viewport']
-  if viewport
-    Capybara.current_session.driver.browser.manage.window.resize_to(viewport['width'], viewport['height'])
-  else
-    Capybara.current_session.driver.browser.manage.window.maximize
-  end
-  @video_recorder = VideoHelper.recorder_for(Capybara.current_session.driver)
-  @video_recorder&.start(self.class.to_s)
-  DebugHelper.enable_network_logging(Capybara.current_session.driver)
-  @debug_action_logger = DebugHelper.action_logger_for(self.class.to_s)
-end
-
-After do |scenario|
-  if scenario.failed?
-    DebugHelper.capture_failure_diagnostics(Capybara.current_session.driver, scenario.name, exception: scenario.exception)
-    DebugHelper.capture_network_logs(DebugHelper.resolve_selenium_driver(Capybara.current_session.driver), DebugHelper.sanitize(scenario.name))
-  end
-  @debug_action_logger&.close
-  video_file = @video_recorder&.stop
-  AllureHelper.add_video(scenario.name, video_file)
-  Dir.mktmpdir do |temp_folder|
-    screenshot = Capybara.page.save_screenshot("#{temp_folder}/#{scenario.name}.png")
-    AllureHelper.add_screenshot(scenario.name, screenshot)
-  end
-  Capybara.reset_sessions!
-end

data/lib/generators/cucumber/templates/partials/capybara_world.tt

@@ -1,6 +0,0 @@
-require 'capybara/dsl'
-require_relative '../../helpers/capybara_helper'
-require_relative '../../models/user_factory'
-
-CapybaraHelper.configure
-World(Capybara::DSL)

data/lib/generators/cucumber/templates/performance_feature.tt

@@ -1,5 +0,0 @@
-Feature: Performance Audit
-
-Scenario: Page meets performance threshold
-    Given I audit the home page performance
-    Then the performance score should be above the threshold

data/lib/generators/cucumber/templates/performance_steps.tt

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../helpers/performance_helper'
-
-include PerformanceHelper
-
-Given('I audit the home page performance') do
-  @result = assert_performance_above('https://raider-test-site.onrender.com/', threshold: 0.7)
-end
-
-Then('the performance score should be above the threshold') do
-  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

data/lib/generators/cucumber/templates/visual_feature.tt

@@ -1,5 +0,0 @@
-Feature: Visual Regression
-
-Scenario: Login page matches baseline
-    Given I'm on the login page
-    Then the page should match the visual baseline "login_page"

data/lib/generators/cucumber/templates/visual_steps.tt

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../helpers/visual_helper'
-require_relative '../../page_objects/pages/login'
-
-include VisualHelper
-
-Given("I'm on the login page") do
-  @login_page = <% if capybara? %>Login.new<% elsif watir? %>Login.new(browser)<% else %>Login.new(driver)<% end %>
-  @login_page.<% if capybara? %>visit_page<% else %>visit<% end %>
-end
-
-Then('the page should match the visual baseline {string}') do |baseline_name|
-  screenshot_path = <% if capybara? %>page.save_screenshot("tmp/visual_#{baseline_name}.png")<% elsif watir? %>browser.screenshot.save("tmp/visual_#{baseline_name}.png")<% else %>driver.save_screenshot("tmp/visual_#{baseline_name}.png")<% end %>
-  result = compare_screenshot(baseline_name, screenshot_path)
-
-  expect(result[:status]).not_to eq(:mismatch),
-    "Visual diff: #{(result[:diff].to_f * 100).round(2)}% difference. See: #{result[:diff_path]}"
-end

data/lib/generators/infrastructure/gitlab_generator.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../generator'
-
-class GitlabGenerator < Generator
-  def generate_gitlab_file
-    return unless web?
-
-    template('gitlab.tt', "#{name}/gitlab-ci.yml")
-  end
-end

data/lib/generators/infrastructure/templates/gitlab.tt

@@ -1,46 +0,0 @@
-stages:
-  - setup
-  - test
-  - report
-
-variables:
-  RUBY_VERSION: "<%= ruby_version %>.0"
-  HEADLESS: "true"
-
-setup_ruby:
-  stage: setup
-  image: ruby:${RUBY_VERSION}
-  script:
-    - bundle install --jobs $(nproc) --retry 3
-  cache:
-    paths:
-      - vendor/bundle
-
-run_tests:
-  stage: test
-  image: ruby:${RUBY_VERSION}
-  before_script:
-    - apt-get update -qq && apt-get install -y -qq chromium chromium-driver
-    - mkdir -p allure-results
-  script:
-    - <%- if framework == 'cucumber' -%>bundle exec cucumber features --format pretty<%- elsif minitest? -%>bundle exec ruby -Itest test/test_login_page.rb<%- else -%>bundle exec rspec spec --format documentation<%- end %>
-  artifacts:
-    paths:
-      - allure-results/
-    when: always
-
-pages:
-  stage: report
-  image: alpine/git
-  dependencies:
-    - run_tests
-  script:
-    - apk add --no-cache curl unzip
-    - curl -o allure.zip -L https://github.com/allure-framework/allure2/releases/latest/download/allure-commandline.zip
-    - unzip allure.zip -d /tmp/
-    - /tmp/allure-*/bin/allure generate allure-results --clean -o public
-  artifacts:
-    paths:
-      - public
-  only:
-    - main

data/lib/generators/minitest/minitest_generator.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../generator'
-
-class MinitestGenerator < Generator
-  def generate_login_test
-    return unless web?
-
-    template('test.tt', "#{name}/test/test_login_page.rb")
-  end
-
-  def generate_pdp_test
-    return unless mobile?
-
-    template('test.tt', "#{name}/test/test_pdp_page.rb")
-  end
-
-  def generate_visual_test
-    return unless visual_addon? && web?
-
-    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

@@ -1,26 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,64 +0,0 @@
-<%- if selenium_based? || watir? || capybara? -%>
-# frozen_string_literal: true
-
-require_relative '../helpers/test_helper'
-require_relative '../models/model_factory'
-require_relative '../page_objects/pages/account'
-require_relative '../page_objects/pages/login'
-
-# Uncomment for interactive debugging:
-# require 'debug'    # Ruby's built-in debugger (binding.break)
-# require 'pry'      # Pry debugger (binding.pry)
-
-<%- if selenium_based? || watir? || capybara? -%>
-class TestLogin < Minitest::Test
-  def setup
-    @user = ModelFactory.for('users')['registered user']
-    @login_page = <% if capybara? -%>Login.new<% elsif watir? -%>Login.new(browser)<% else -%>Login.new(driver)<% end %>
-    @account_page = <% if capybara? -%>Account.new<% elsif watir? -%>Account.new(browser)<% else -%>Account.new(driver)<% end %>
-  end
-
-  def teardown
-    <%= partial('quit_driver', strip: true) %>
-  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'])
-    @account_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
-    assert_equal "Welcome back #{@user['name']}", @account_page.header.customer_name
-  end
-
-  def test_login_with_wrong_credentials
-    @login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
-    @login_page.login(@user['username'], 'wrongPassword')
-    @login_page.<% if capybara? -%>visit_page<% else -%>visit<% end %>
-    assert_equal 'Login or register', @account_page.header.customer_name
-  end
-end
-<%- end -%>
-<%- else -%>
-<% if cross_platform? -%>
-require_relative '../helpers/appium_helper'
-<%- end -%>
-require_relative '../helpers/test_helper'
-require_relative '../page_objects/pages/home'
-require_relative '../page_objects/pages/pdp'
-
-class TestPdp < Minitest::Test
-  def setup
-    @home_page = Home.new(driver)
-    @pdp_page = Pdp.new(driver)
-  end
-
-  def teardown
-    driver.quit_driver
-  end
-
-  def test_shows_add_to_cart_button
-    @home_page.go_to_product_detail
-    assert_equal 'Add to Cart', @pdp_page.add_to_cart_text
-  end
-end
-<%- end -%>

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

@@ -1,23 +0,0 @@
-# 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/templates/performance_spec.tt

@@ -1,18 +0,0 @@
-# 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/visual_spec.tt

@@ -1,20 +0,0 @@
-# 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/templates/common/ruby_version.tt

@@ -1 +0,0 @@
-<%= ruby_version %>

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'capybara'
-require 'capybara/dsl'
-require 'selenium-webdriver'
-require 'yaml'
-
-module CapybaraHelper
-  def self.configure
-    config = YAML.load_file('config/config.yml')
-
-    Capybara.configure do |capybara_config|
-      capybara_config.default_driver = :selenium
-      capybara_config.javascript_driver = :selenium
-      capybara_config.app_host = config['url']
-      capybara_config.default_max_wait_time = config.fetch('timeout', 10)
-      capybara_config.run_server = false
-    end
-
-    Capybara.register_driver :selenium do |app|
-      browser = config['browser'].to_sym
-      args = config['browser_arguments'][config['browser']] || []
-      args += ['--headless'] if (ENV['HEADLESS'] || config['headless']) && !args.include?('--headless')
-      options = Selenium::WebDriver::Chrome::Options.new(args:)
-      debug_cfg = config['debug'] || {}
-      if debug_cfg.fetch('enabled', false) || ENV['DEBUG']&.downcase == 'true'
-        options.add_option('goog:loggingPrefs', { browser: 'ALL', performance: 'ALL' })
-      end
-      Capybara::Selenium::Driver.new(app, browser:, options:)
-    end
-  end
-end