ruby_raider 1.1.4 → 2.0.0

data/lib/generators/template_renderer.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative 'template_renderer/partial_cache'
+require_relative 'template_renderer/partial_resolver'
+require_relative 'template_renderer/template_error'
+
+# Template rendering module for Ruby Raider generators
+#
+# Provides a clean partial() helper for including ERB templates with:
+# - Automatic caching of compiled ERB objects (10x performance improvement)
+# - Context-aware path resolution (relative to caller, then all source_paths)
+# - Helpful error messages when partials are missing
+# - Flexible whitespace handling (trim_mode, strip options)
+#
+# Usage in templates:
+#   <%= partial('screenshot') %>                    # Default: trim_mode: '-', no strip
+#   <%= partial('screenshot', strip: true) %>       # With .strip!
+#   <%= partial('screenshot', trim: false) %>       # No trim_mode
+#   <%= partial('driver_config', trim_mode: '<>') %> # Custom trim_mode
+#
+# The partial() method automatically has access to all generator instance
+# variables and methods (cucumber?, mobile?, selenium?, etc.) through binding.
+module TemplateRenderer
+  # Render a partial template with caching and smart path resolution
+  #
+  # @param name [String] Partial name without .tt extension (e.g., 'screenshot')
+  # @param options [Hash] Rendering options
+  # @option options [String, nil] :trim_mode ERB trim mode (default: '-')
+  #   - '-'  : Trim lines ending with -%>
+  #   - '<>' : Omit newlines for lines starting with <% and ending with %>
+  #   - nil  : No trimming
+  # @option options [Boolean] :strip Whether to call .strip! on result (default: false)
+  # @option options [Boolean] :trim Whether to use trim_mode (default: true)
+  #
+  # @return [String] Rendered template content
+  #
+  # @example Basic usage
+  #   <%= partial('screenshot') %>
+  #
+  # @example With strip
+  #   <%= partial('screenshot', strip: true) %>
+  #
+  # @example No trim mode
+  #   <%= partial('quit_driver', trim: false) %>
+  #
+  # @raise [TemplateNotFoundError] If partial cannot be found
+  # @raise [TemplateRenderError] If rendering fails
+  def partial(name, options = {})
+    # Default options
+    options = {
+      trim_mode: '-',
+      strip: false,
+      trim: true
+    }.merge(options)
+
+    # Handle trim: false by setting trim_mode to nil
+    options[:trim_mode] = nil if options[:trim] == false
+
+    # Render the partial through the cache
+    result = self.class.template_renderer.render_partial(name, binding, options)
+
+    # Apply strip if requested
+    options[:strip] ? result.strip : result
+  end
+
+  # Module hook for including in classes
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Class methods added to the including class
+  module ClassMethods
+    # Get the shared template renderer instance
+    # Each generator class gets its own cache instance
+    def template_renderer
+      @template_renderer ||= PartialCache.new(self)
+    end
+
+    # Clear the template cache (useful for testing)
+    def clear_template_cache
+      @template_renderer&.clear
+      @template_renderer = nil
+    end
+
+    # Get cache statistics (useful for debugging)
+    def template_cache_stats
+      @template_renderer&.stats || { size: 0, entries: [], memory_estimate: 0 }
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 <% if mobile? -%>
-<%= ERB.new(File.read(File.expand_path('./partials/mobile_config.tt', __dir__))).result(binding) %>
+<%= partial('mobile_config', trim: false) %>
 <% else -%>
-<%= ERB.new(File.read(File.expand_path('./partials/web_config.tt', __dir__)), trim_mode: '-').result(binding) %>
+<%= partial('web_config') %>
 <% end -%>

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

@@ -6,10 +6,16 @@ gem 'appium_lib'
 gem 'appium_console'
 <% end %>
 <%- if cucumber? -%>
-gem 'allure-cucumber', '2.23.0'
+gem 'allure-cucumber', '2.28.0'
+<%- elsif minitest? -%>
+gem 'allure-ruby-commons', '2.28.0'
 <%- else -%>
-gem 'allure-rspec', '2.23.0'
-gem 'allure-ruby-commons', '2.23.0'
+gem 'allure-rspec', '2.28.0'
+gem 'allure-ruby-commons', '2.28.0'
+<%- end -%>
+<%- if capybara? -%>
+gem 'capybara'
+gem 'selenium-webdriver'
 <%- end -%>
 <%- if axe? -%>
 gem 'axe-core-rspec'
@@ -29,10 +35,16 @@ gem '<%= framework %>'
 <%- if cucumber? -%>
 gem 'rspec'
 <%- end -%>
+<%- if minitest? -%>
+gem 'minitest-reporters'
+<%- end -%>
 gem 'rubocop'
 <%- if rspec? -%>
 gem 'rubocop-rspec'
 <%- end -%>
+<%- if minitest? -%>
+gem 'rubocop-minitest'
+<%- end -%>
 gem 'ruby_raider', '~> 1.1.0'
 <%- if selenium_based? %>
 gem 'selenium-webdriver'

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

@@ -1,5 +1,5 @@
 browser: chrome
-url: 'https://automationteststore.com/'
+url: 'https://raider-test-site.onrender.com/'
 
 <%- if selenium_based? -%>
 driver_options:

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

@@ -34,7 +34,9 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 |                       |                                   | Cucumber and Appium Cross-platform |                                 |
 |                       |                                   | Rspec and Appium Cross-platform    |                                 |
 
-***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
+***The web tests run against the [Raider Test Store](https://raider-test-site.onrender.com/).***
+
+***In order to run the Appium tests, download the example [app](https://github.com/RaiderHQ/raider_test_app).***
 ***Remember to use the full path of the app that you download in the capabilities file and start the server using one of
 the commands below:***
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-<%=- ERB.new(File.read(File.expand_path('./partials/allure_requirements.tt', __dir__))).result(binding).strip! -%>
-<%- allure = ERB.new(File.read(File.expand_path('./partials/allure_imports.tt', __dir__))).result(binding).strip! -%>
+<%=- partial('allure_requirements', trim: false, strip: true) -%>
+<%- allure = partial('allure_imports', trim: false, strip: true) -%>
 
 
 module AllureHelper

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

@@ -17,6 +17,7 @@ module BrowserHelper
 
   def create_browser(*args)
     args = args.empty? ? config['browser_arguments'][config['browser']] : args
+    args += ['--headless'] if ENV['HEADLESS'] && !args.include?('--headless')
     Watir::Browser.new(config['browser'], options: { args: args })
   end
 end

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

@@ -0,0 +1,28 @@
+# 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 = 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'] && !args.include?('--headless')
+      options = Selenium::WebDriver::Chrome::Options.new(args:)
+      Capybara::Selenium::Driver.new(app, browser:, options:)
+    end
+  end
+end

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

@@ -29,5 +29,5 @@ module DriverHelper
 
   private
 
-  <%= ERB.new(File.read(File.expand_path('./partials/driver_and_options.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
+  <%= partial('driver_and_options', strip: true) %>
 end

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

@@ -1,5 +1,7 @@
 <% if rspec? %>
 AllureRspec
-<% else %>
+<% elsif cucumber? %>
 AllureCucumber
+<% else %>
+Allure
 <% end %>

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

@@ -1,6 +1,8 @@
 <% if cucumber? %>
 require 'allure-cucumber'
-<% else %>
+<% elsif rspec? %>
 require 'allure-ruby-commons'
 require 'allure-rspec'
+<% else %>
+require 'allure-ruby-commons'
 <% end %>

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

@@ -0,0 +1,46 @@
+  def create_driver
+    @driver = configure_driver
+  end
+<%- if cross_platform? -%>
+
+  def platform
+    @platform ||= YAML.load_file('config/config.yml')['platform'].to_s
+  end
+
+  def platform_caps
+    @platform_caps ||= YAML.load_file('config/capabilities.yml')[platform]
+  end
+
+  # :reek:UtilityFunction
+  def parsed_caps
+    platform_caps['appium:options']['app'] = parse_app_path(platform_caps['appium:options']['app'])
+    platform_caps
+  end
+
+  def parse_app_path(path)
+    File.expand_path(path, Dir.pwd)
+  end
+<%- else -%>
+
+  # :reek:UtilityFunction
+  def parsed_caps
+    caps = YAML.load_file('config/capabilities.yml')
+    caps['appium:options']['app'] = app_path(caps['appium:options']['app'])
+    caps
+  end
+
+  def app_path(path)
+    File.expand_path(path, Dir.pwd)
+  end
+<%- end -%>
+
+<%= partial('browserstack_config', strip: true) %>
+
+  def configure_driver
+    if browserstack?
+      Appium::Driver.new({ caps: browserstack_caps,
+                           'appium_lib': { server_url: parsed_browserstack_url}}, true)
+    else
+      Appium::Driver.new({ caps: parsed_caps })
+    end
+  end

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

@@ -0,0 +1,10 @@
+  def create_driver(browser, js_path, skip_iframes)
+    if ENV['HEADLESS']
+      options = Selenium::WebDriver::Chrome::Options.new(args: ['--headless'])
+      @driver = Selenium::WebDriver.for(browser, options:)
+    end
+    AxeSelenium.configure(@driver || browser) do |config|
+      config.jslib_path = js_path if js_path
+      config.skip_iframes = skip_iframes if skip_iframes
+    end.page
+  end

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

@@ -0,0 +1,13 @@
+  def browserstack?
+    ENV['TEST_ENV'] == 'browserstack'
+  end
+
+  def browserstack_caps
+    @browserstack_caps ||= YAML.load_file('config/capabilities.yml')['browserstack']
+  end
+
+  def parsed_browserstack_url
+    username = ENV['BROWSERSTACK_USER']
+    access_key = ENV['BROWSERSTACK_KEY']
+    "https://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
+  end

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

@@ -1,115 +1,7 @@
 <% if axe? -%>
-  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 selenium_based? -%>
-  def create_driver(*opts)
-    @config = YAML.load_file('config/config.yml')
-    browser = @config['browser']
-    Selenium::WebDriver.for(browser.to_sym, options: create_webdriver_options(*opts))
-  end
-
-  def browser_arguments(*opts)
-    opts.empty? ? @config['browser_arguments'][@config['browser']] : opts
-  end
-
-  def driver_options
-    @config['driver_options']
-  end
-
-  # :reek:FeatureEnvy
-  def create_webdriver_options(*opts)
-    load_browser = @config['browser'].to_s
-    browser = load_browser == 'ie' ? load_browser.upcase : load_browser.capitalize
-    options = "Selenium::WebDriver::#{browser}::Options".constantize.new
-    browser_arguments(*opts).each { |arg| options.add_argument(arg) }
-    driver_options.each { |opt| options.add_option(opt.first, opt.last) }
-    options
-  end
-<% elsif cross_platform? -%>
-  def create_driver
-    @driver = configure_driver
-  end
-
-  def platform
-    @platform ||= YAML.load_file('config/config.yml')['platform'].to_s
-  end
-
-  def platform_caps
-    @platform_caps ||= YAML.load_file('config/capabilities.yml')[platform]
-  end
-
-  # :reek:UtilityFunction
-  def parsed_caps
-    platform_caps['appium:options']['app'] = parse_app_path(platform_caps['appium:options']['app'])
-    platform_caps
-  end
-
-  def parse_app_path(path)
-    File.expand_path(path, Dir.pwd)
-  end
-
-  def browserstack?
-    ENV['TEST_ENV'] == 'browserstack'
-  end
-
-  def browserstack_caps
-    @browserstack_caps ||= YAML.load_file('config/capabilities.yml')['browserstack']
-  end
-
-  def configure_driver
-    if browserstack?
-      Appium::Driver.new({ caps: browserstack_caps,
-                           'appium_lib': { server_url: parsed_browserstack_url}}, true)
-    else
-      Appium::Driver.new({ caps: parsed_caps })
-    end
-  end
-
-  def parsed_browserstack_url
-    username = ENV['BROWSERSTACK_USER']
-    access_key = ENV['BROWSERSTACK_KEY']
-    "https://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
-  end
-<% else -%>
-    def create_driver
-      @driver = configure_driver
-    end
-
-     # :reek:UtilityFunction
-     def parsed_caps
-       caps = YAML.load_file('config/capabilities.yml')
-       caps['appium:options']['app'] = app_path(caps['appium:options']['app'])
-       caps
-     end
-
-     def app_path(path)
-       File.expand_path(path, Dir.pwd)
-     end
-
-    def browserstack?
-      ENV['TEST_ENV'] == 'browserstack'
-    end
-
-    def browserstack_caps
-      @browserstack_caps ||= YAML.load_file('config/capabilities.yml')['browserstack']
-    end
-
-    def configure_driver
-      if browserstack?
-        Appium::Driver.new({ caps: browserstack_caps,
-                             'appium_lib': { server_url: parsed_browserstack_url}}, true)
-      else
-        Appium::Driver.new({ caps: parsed_caps })
-      end
-    end
-
-    def parsed_browserstack_url
-      username = ENV['BROWSERSTACK_USER']
-      access_key = ENV['BROWSERSTACK_KEY']
-      "https://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub"
-    end
-<% end -%>
+<%= partial('axe_driver', strip: true) %>
+<%- elsif selenium_based? -%>
+<%= partial('selenium_driver', strip: true) %>
+<%- else -%>
+<%= partial('appium_driver', strip: true) %>
+<%- end -%>

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

@@ -1,4 +1,6 @@
-<% if selenium_based? %>
+<% if capybara? %>
+  Capybara.reset_sessions!
+<% elsif selenium_based? %>
   driver.quit
 <% elsif watir? %>
   browser.quit

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

@@ -1,4 +1,6 @@
-<% if selenium_based? %>
+<% if capybara? %>
+  screenshot = Capybara.page.save_screenshot("#{temp_folder}/#{example_name}.png")
+<% elsif selenium_based? %>
   screenshot = driver.save_screenshot("#{temp_folder}/#{example_name}.png")
 <% elsif watir? %>
   screenshot = browser.screenshot.save("#{temp_folder}/#{example_name}.png")

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

@@ -0,0 +1,25 @@
+  def create_driver(*opts)
+    @config = YAML.load_file('config/config.yml')
+    browser = @config['browser']
+    Selenium::WebDriver.for(browser.to_sym, options: create_webdriver_options(*opts))
+  end
+
+  def browser_arguments(*opts)
+    args = opts.empty? ? @config['browser_arguments'][@config['browser']] : opts
+    args += ['--headless'] if ENV['HEADLESS'] && !args.include?('--headless')
+    args
+  end
+
+  def driver_options
+    @config['driver_options']
+  end
+
+  # :reek:FeatureEnvy
+  def create_webdriver_options(*opts)
+    load_browser = @config['browser'].to_s
+    browser = load_browser == 'ie' ? load_browser.upcase : load_browser.capitalize
+    options = "Selenium::WebDriver::#{browser}::Options".constantize.new
+    browser_arguments(*opts).each { |arg| options.add_argument(arg) }
+    driver_options.each { |opt| options.add_option(opt.first, opt.last) }
+    options
+  end

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

@@ -6,7 +6,9 @@ require 'axe-rspec'
 require 'rspec'
 require 'tmpdir'
 require_relative 'allure_helper'
-<%- if watir? -%>
+<%- if capybara? -%>
+require_relative 'capybara_helper'
+<%- elsif watir? -%>
 require_relative 'browser_helper'
 <%- else -%>
 require_relative 'driver_helper'
@@ -17,11 +19,22 @@ module SpecHelper
   AllureHelper.configure
   RSpec.configure do |config|
     config.formatter = AllureHelper.formatter
-    <% if watir? %>config.include(BrowserHelper)<% else %>config.include(DriverHelper)<% end %>
+    <%- if capybara? -%>
+    config.include(Capybara::DSL)
+    CapybaraHelper.configure
+    <%- elsif watir? -%>
+    config.include(BrowserHelper)
+    <%- else -%>
+    config.include(DriverHelper)
+    <%- end -%>
     <%- if mobile? -%>
     config.before(:each) do
       driver.start_driver
     end
+    <%- elsif capybara? -%>
+    config.before(:each) do
+      Capybara.current_session.driver.browser.manage.window.maximize
+    end
     <%- elsif selenium_based? -%>
     config.before(:each) do
       driver.manage.window.maximize
@@ -35,10 +48,10 @@ module SpecHelper
     config.after(:each) do |example|
       example_name = example.description
       Dir.mktmpdir do |temp_folder|
-        <%= ERB.new(File.read(File.expand_path('./partials/screenshot.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
+        <%= partial('screenshot', strip: true) %>
         AllureHelper.add_screenshot(example_name, screenshot)
       end
-      <%= ERB.new(File.read(File.expand_path('./partials/quit_driver.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
+      <%= partial('quit_driver', strip: true) %>
     end
   end
 end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+<%- if axe? %>
+require 'axe-minitest'
+<%- end -%>
+require 'minitest/autorun'
+require 'tmpdir'
+require_relative 'allure_helper'
+<%- if watir? -%>
+require_relative 'browser_helper'
+<%- elsif capybara? -%>
+require_relative 'capybara_helper'
+<%- else -%>
+require_relative 'driver_helper'
+<%- end -%>
+
+AllureHelper.configure
+<%- if capybara? -%>
+CapybaraHelper.configure
+<%- end -%>
+
+module TestHelper
+  <% if watir? %>include BrowserHelper<% elsif capybara? %>include Capybara::DSL<% else %>include DriverHelper<% end %>
+end
+
+Minitest::Test.include(TestHelper)

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

@@ -22,7 +22,7 @@ module SpecHelper
       config.after(:each) do |example|
         example_name = example.description
         Dir.mktmpdir do |temp_folder|
-          <%= ERB.new(File.read(File.expand_path('./partials/screenshot.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
+          <%= partial('screenshot', strip: true) %>
           AllureHelper.add_screenshot(example_name, screenshot)
         end
         @eyes.close

data/lib/ruby_raider.rb

@@ -3,6 +3,7 @@
 require_relative '../lib/plugin/plugin'
 require_relative '../lib/commands/plugin_commands'
 require_relative '../lib/commands/loaded_commands'
+require_relative '../lib/commands/adopt_commands'
 require_relative '../lib/commands/scaffolding_commands'
 require_relative '../lib/commands/utility_commands'
 
@@ -45,6 +46,10 @@ module RubyRaider
 
     map 'v' => 'version'
 
+    desc 'adopt', 'Adopts an existing test project into Ruby Raider conventions'
+    subcommand 'adopt', AdoptCommands
+    map 'a' => 'adopt'
+
     desc 'generate', 'Provides access to all the scaffolding commands'
     subcommand 'generate', ScaffoldingCommands
     map 'g' => 'generate'

data/lib/version

@@ -1 +1 @@
-1.1.4
+2.0.0