ruby_raider 3.2.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65823e49f5a2bf2e0f338b0f3fa22c9825a665d11d688a2e4a6e29172c7bab36
-  data.tar.gz: 3acd00fe4a06957f50c559d1c92825cc0d576ff475bb00168e899ae54068f7d5
+  metadata.gz: 5141b6656f193315dce72afc9a7096ea48e63eed8a23c348cf38be0978627e90
+  data.tar.gz: b47a32013c49843ac2511f4bb0188adfcd50a83294fdbe692f8e483f3215ca67
 SHA512:
-  metadata.gz: 6d2954689ece744a1421e0cedf2c34dc03b95cf11486ff8e574c7c376b6338649c5c3dc03d0b91bb2de86c70878b34bbf8b1e7951b94e2017cf4b21a5e14bdbd
-  data.tar.gz: 752fcf37ecc86bbb60f6cb7e501df42b5721c39d94a05b798d15720eca473e0718d72c88d55d24b67cfd35467f65060c13832b51b48737a390a9aaf59597bf24
+  metadata.gz: 4840894d57645404ac69faf2ebe7985e59b5df8e653ec8746fb40d23a45e082b0f2708b1d2cc275f7cfa3ce250a009dea61d2022ed6ca96f6c835ac36ed04bca
+  data.tar.gz: f0eee8de1a42d7ff1440ee7d6700c9d6ffa9370fe53a811b2c99ba03147eed8101edeff5a8e9df0849fe25fb5189d5fd34aab9e07b5ee0642d575d46739f487c

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.1.0
+  TargetRubyVersion: 3.2.0
 
 # Layout
 Layout/CaseIndentation:

data/README.md

@@ -51,18 +51,30 @@ Ruby Raider is a CLI gem and API backend for scaffolding and generating UI test
 |--------|------|-------------|
 | Accessibility | `--accessibility` | Adds axe gem + example accessibility tests |
 
-All generated projects include a **GitHub Actions** CI pipeline out of the box.
+This works on all platforms (Mac OS, Linux and Windows).
+
+## What's Included
+
+Every generated project comes with:
 
-***The web tests run against the [Raider Test Store](https://raider-test-site.onrender.com/).***
+- **Page Object Model** — Base page and component classes with example pages
+- **Test examples** — Working login tests against the [Raider Test Store](https://raider-test-site.onrender.com/)
+- **Allure reporting** — Pre-configured with screenshot capture on failure
+- **Raider reporting** — RSpec projects include [raider_reporter](https://github.com/RaiderHQ/raider_reporter), which writes results to `raider-results/` and uploads runs when `RAIDER_TOKEN` and `RAIDER_ENDPOINT` are set
+- **GitHub Actions CI** — Ready-to-use test pipeline
+- **Rake tasks** — Default, smoke, and regression tasks with tag-based filtering
+- **Retry support** — RSpec retry with configurable retry count via `RETRY_COUNT` env var
+- **Re-run failed tests** — Persistence file for tracking example status
+- **Parallel execution** — parallel_tests and parallel_split_test gems included
+- **Configurable browser** — Chrome/Firefox with customizable arguments, viewport, timeout, and headless mode
+- **Linting** — RuboCop and Reek configs included
 
-***To run Appium tests, download the example [app](https://github.com/RaiderHQ/raider_test_app) and start the server:***
+For Appium projects, download the example [app](https://github.com/RaiderHQ/raider_test_app) and start the server:
 
 ```bash
 raider u start_appium
 ```
 
-This works on all platforms (Mac OS, Linux and Windows).
-
 ## Getting Started
 
 Install the gem:
@@ -83,7 +95,7 @@ Or skip the menu with parameters:
 raider new [project_name] -p framework:rspec automation:selenium
 ```
 
-Add optional features:
+Add accessibility testing:
 
 ```bash
 raider new my_project -p framework:rspec automation:selenium --accessibility
@@ -119,7 +131,6 @@ raider g scaffold [NAME(S)]     # Create page + test + steps
 
 Options:
 
-* `--uses [PAGES]` — Specify page dependencies
 * `--path [PATH]` — Custom output path
 
 ### Utility Commands
@@ -128,8 +139,9 @@ Options:
 raider u path [PATH]            # Set default paths for scaffolding
 raider u url [URL]              # Set default project URL
 raider u browser [BROWSER]      # Set default browser
-raider u browser_options [OPTS] # Set browser options
-raider u raid                   # Run all tests
+raider u browser_options [OPTS] # Set browser arguments (e.g., no-sandbox, headless)
+raider u headless [on/off]      # Toggle headless mode
+raider u raid                   # Run all tests (-p for parallel)
 raider u timeout [SECONDS]      # Set test timeout
 raider u viewport [DIMENSIONS]  # Set viewport size (e.g., 1920x1080)
 raider u platform [PLATFORM]    # Set platform for cross-platform tests

data/RELEASE.md

@@ -1,5 +1,23 @@
 # Release Process Documentation
 
+## Release Notes
+
+### 3.4.0
+
+- Generated RSpec projects with GitHub CI now include a `raider-comment` job that comments Raider test results on pull requests via `raider-reporter comment`. It runs after every test job, only on pull requests, and needs the `RAIDER_TOKEN` secret and `RAIDER_ENDPOINT` variable. Cucumber projects are unchanged.
+- The job needs `contents: read`, `pull-requests: write` and `statuses: write` permissions; it reports a `raider/tests` status, and pull requests from forks are skipped.
+- Generated Gemfiles now require `raider_reporter` `~> 0.3`.
+- Ruby Raider now requires Ruby 3.2.0 or newer.
+
+### 3.3.0
+
+- Generated RSpec projects now include `raider_reporter`: results are written to `raider-results/` and uploaded when `RAIDER_TOKEN` and `RAIDER_ENDPOINT` are set. Allure is still produced. Cucumber projects are unchanged.
+- Screenshots (Allure too) are now taken only when an example fails, and are attached to both Allure and Raider.
+- Generated GitHub CI now runs on push (main, master), pull requests and manual dispatch, passes the Raider settings to RSpec runs and uploads `raider-results/` as an artifact.
+- Fixed the generated Gemfile `ruby_raider` pin so it follows the gem's own major.minor version.
+
+---
+
 ## Overview
 
 Ruby Raider uses a **fully automated release process**. You only need to run a single command, and everything else happens automatically via GitHub Actions.

data/lib/commands/scaffolding_commands.rb

@@ -13,11 +13,9 @@ class ScaffoldingCommands < Thor
   desc 'page [PAGE_NAME]', 'Creates a new page object'
   option :path, type: :string, required: false,
                 desc: 'The path where your page will be created', aliases: '-p'
-  option :uses, type: :array, required: false,
-                desc: 'Dependent pages to require', aliases: '-u'
 
   def page(name)
-    generate_scaffolding(name, 'page', options[:path], uses: options[:uses])
+    generate_scaffolding(name, 'page', options[:path])
   end
 
   desc 'feature [NAME]', 'Creates a new feature'
@@ -31,11 +29,9 @@ class ScaffoldingCommands < Thor
   desc 'spec [SPEC_NAME]', 'Creates a new spec'
   option :path, type: :string, required: false,
                 desc: 'The path where your spec will be created', aliases: '-p'
-  option :uses, type: :array, required: false,
-                desc: 'Dependent pages to require', aliases: '-u'
 
   def spec(name)
-    generate_scaffolding(name, 'spec', options[:path], uses: options[:uses])
+    generate_scaffolding(name, 'spec', options[:path])
   end
 
   desc 'helper [HELPER_NAME]', 'Creates a new helper'
@@ -63,8 +59,6 @@ class ScaffoldingCommands < Thor
   end
 
   desc 'scaffold [NAMES...]', 'Generates pages, specs/features, and helpers for one or more names'
-  option :uses, type: :array, required: false,
-                desc: 'Dependent pages to require', aliases: '-u'
 
   def scaffold(*names)
     names.each { |name| generate_default_scaffold(name) }
@@ -95,23 +89,21 @@ class ScaffoldingCommands < Thor
       end
     end
 
-    def generate_scaffolding(name, type, path, uses: nil)
+    def generate_scaffolding(name, type, path)
       path ||= load_config_path(type)
       scaffolding = Scaffolding.new([name, path])
-      scaffolding.uses = Array(uses) if uses
       scaffolding.send("generate_#{type}")
     end
 
     def generate_default_scaffold(name)
       validate_project!
-      uses = options[:uses]
       if Pathname.new('spec').exist? && !Pathname.new('features').exist?
-        generate_scaffolding(name, 'spec', load_config_path('spec'), uses:)
+        generate_scaffolding(name, 'spec', load_config_path('spec'))
       else
         generate_scaffolding(name, 'feature', load_config_path('feature'))
-        generate_scaffolding(name, 'steps', load_config_path('steps'), uses:)
+        generate_scaffolding(name, 'steps', load_config_path('steps'))
       end
-      generate_scaffolding(name, 'page', load_config_path('page'), uses:)
+      generate_scaffolding(name, 'page', load_config_path('page'))
     end
   end
 end

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 Given('I am on the home page') do
-  <% if watir? -%>
-browser.goto 'https://raider-test-site.onrender.com/'
-  <% else -%>
-driver.get 'https://raider-test-site.onrender.com/'
-  <% end -%>
+  <%- if watir? -%>
+  browser.goto 'https://raider-test-site.onrender.com/'
+  <%- else -%>
+  driver.get 'https://raider-test-site.onrender.com/'
+  <%- end -%>
 end
 
 Then('the page should be accessible') do
-  <% if watir? -%>
-expect(browser.driver).to be_axe_clean
-  <% else -%>
-expect(driver).to be_axe_clean
-  <% end -%>
+  <%- if watir? -%>
+  expect(browser.driver).to be_axe_clean
+  <%- else -%>
+  expect(driver).to be_axe_clean
+  <%- end -%>
 end

data/lib/generators/generator.rb

@@ -71,6 +71,11 @@ class Generator < Thor::Group
     args.include?('selenium')
   end
 
+  def ruby_raider_version_requirement
+    major, minor = File.read(File.expand_path('../version', __dir__)).strip.split('.')
+    "~> #{major}.#{minor}"
+  end
+
   private
 
   def _initializer

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

@@ -1,6 +1,9 @@
 name: <%- if framework == 'cucumber' -%>Cucumber Tests<%- else -%>Rspec Tests<%- end -%>
 
 on:
+  push:
+    branches: [ main, master ]
+  pull_request:
   workflow_dispatch:
     inputs:
       browser:
@@ -37,6 +40,21 @@ jobs:
         run: <%- if framework == 'cucumber' -%>bundle exec cucumber features --format pretty<%- else -%>bundle exec rspec spec --format documentation<%- end %>
         env:
           HEADLESS: true
+<%- unless framework == 'cucumber' -%>
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+<%- end -%>
+
+<%- unless framework == 'cucumber' -%>
+      - name: Upload Raider results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: raider-results
+          path: raider-results/
+          if-no-files-found: ignore
+
+<%- end -%>
 
       - name: Get Allure history
         uses: actions/checkout@v2
@@ -63,3 +81,24 @@ jobs:
           PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PUBLISH_BRANCH: gh-pages
           PUBLISH_DIR: allure-history
+
+<%- unless framework == 'cucumber' -%>
+  raider-comment:
+    needs: [build]
+    if: always() && github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.4.0, bundler-cache: true }
+      - name: Comment Raider results on the pull request
+        run: bundle exec raider-reporter comment
+        env:
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+<%- end -%>

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

@@ -2,9 +2,9 @@ name: Appium Tests
 
 on:
   push:
-    branches: [ main ]
+    branches: [ main, master ]
   pull_request:
-    branches: [ main ]
+  workflow_dispatch:
 
 jobs:
 <%- if ios? || cross_platform? -%>
@@ -52,6 +52,18 @@ jobs:
 <%- end -%>
         env:
           APP_PATH: ${{ github.workspace }}/apps/RaiderTestApp.app
+<%- unless cucumber? -%>
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+
+      - name: Upload Raider results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: raider-results-ios
+          path: raider-results/
+          if-no-files-found: ignore
+<%- end -%>
 <%- end -%>
 
 <%- if android? || cross_platform? -%>
@@ -101,4 +113,37 @@ jobs:
 <%- end -%>
         env:
           APP_PATH: ${{ github.workspace }}/apps/app-release.apk
+<%- unless cucumber? -%>
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+
+      - name: Upload Raider results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: raider-results-android
+          path: raider-results/
+          if-no-files-found: ignore
+<%- end -%>
+<%- end -%>
+
+<%- unless cucumber? -%>
+  raider-comment:
+    needs: [<%= [('ios-tests' if ios? || cross_platform?), ('android-tests' if android? || cross_platform?)].compact.join(', ') %>]
+    if: always() && github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with: { ruby-version: 3.4.0, bundler-cache: true }
+      - name: Comment Raider results on the pull request
+        run: bundle exec raider-reporter comment
+        env:
+          RAIDER_TOKEN: ${{ secrets.RAIDER_TOKEN }}
+          RAIDER_ENDPOINT: ${{ vars.RAIDER_ENDPOINT }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 <%- end -%>

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

@@ -20,6 +20,7 @@ gem 'parallel_tests'
 gem 'rake'
 gem 'reek'
 <%- if rspec? -%>
+gem 'raider_reporter', '~> 0.3'
 gem 'rspec-retry'
 <%- end -%>
 gem '<%= framework %>'
@@ -30,7 +31,7 @@ gem 'rubocop'
 <%- if rspec? -%>
 gem 'rubocop-rspec'
 <%- end -%>
-gem 'ruby_raider', '~> 1.1.0'
+gem 'ruby_raider', '<%= ruby_raider_version_requirement %>'
 <%- if selenium_based? %>
 gem 'selenium-webdriver'
 <%- end -%>

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

@@ -1,4 +1,5 @@
 allure-results
 <%- if rspec? -%>
+raider-results
 spec/examples.txt
 <%- end -%>

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

@@ -82,6 +82,23 @@ raider g steps [NAME]     # Create step definitions
 raider g scaffold [NAME]  # Create page + test + steps
 ```
 
+<%- if rspec? -%>
+## Reporting
+
+Every run writes machine-readable results to `raider-results/` (including `run.json`), next to the usual Allure results.
+Allure reports are still produced.
+
+To upload runs to Raider, set these environment variables before running the suite:
+
+```bash
+export RAIDER_TOKEN=your-token
+export RAIDER_ENDPOINT=https://your-raider-endpoint
+```
+
+Without `RAIDER_TOKEN`, nothing is uploaded and the suite output is unchanged. Failure screenshots are attached to both
+Allure and Raider. See the [raider_reporter README](https://github.com/RaiderHQ/raider_reporter) for details.
+
+<%- end -%>
 ### Sponsors
 
 This project is tested with BrowserStack.

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

@@ -1,7 +1,7 @@
 <% if selenium_based? %>
-  screenshot = driver.save_screenshot("#{temp_folder}/#{example_name}.png")
+  screenshot = driver.save_screenshot(screenshot_path)
 <% elsif watir? %>
-  screenshot = browser.screenshot.save("#{temp_folder}/#{example_name}.png")
+  screenshot = browser.screenshot.save(screenshot_path)
 <% else %>
-  screenshot = driver.screenshot("#{temp_folder}/#{example_name}.png")
+  screenshot = driver.screenshot(screenshot_path)
 <% end %>

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

@@ -5,6 +5,8 @@ require 'axe-rspec'
 <%- end -%>
 require 'rspec'
 require 'rspec/retry'
+require 'digest'
+require 'raider_reporter/rspec'
 require 'tmpdir'
 require_relative 'allure_helper'
 <%- if watir? -%>
@@ -21,7 +23,8 @@ module SpecHelper
     config.verbose_retry = true
     config.display_try_failure_messages = true
     config.default_retry_count = ENV.fetch('RETRY_COUNT', 0).to_i
-    config.formatter = AllureHelper.formatter
+    config.add_formatter(AllureHelper.formatter)
+    config.add_formatter(RaiderReporter::RSpec::Formatter)
     <%- if watir? -%>
     config.include(BrowserHelper)
     <%- else -%>
@@ -53,10 +56,12 @@ module SpecHelper
       example_name = example.description
       if example.exception
         @_exception = example.exception
-      end
-      Dir.mktmpdir do |temp_folder|
-        <%= partial('screenshot', strip: true) %>
-        AllureHelper.add_screenshot(example_name, screenshot)
+        Dir.mktmpdir do |temp_folder|
+          screenshot_path = "#{temp_folder}/#{example_name}.png"
+          <%= partial('screenshot', strip: true) %>
+          AllureHelper.add_screenshot(example_name, screenshot)
+          RaiderReporter.attach('screenshot', screenshot_path, type: :png)
+        end
       end
       <%= partial('quit_driver', strip: true) %>
     end

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

@@ -74,6 +74,7 @@ module TestHelper
     <%- end -%>
     <%- end -%>
     Dir.mktmpdir do |temp_folder|
+      screenshot_path = "#{temp_folder}/#{example_name}.png"
       <%= partial('screenshot', strip: true) %>
       <%- if allure_reporter? -%>
       AllureHelper.add_screenshot(example_name, screenshot)

data/lib/scaffolding/scaffolding.rb

@@ -11,8 +11,6 @@ class Scaffolding < Thor::Group
   argument :name, optional: true
   argument :path, optional: true
 
-  attr_writer :uses
-
   def self.source_root
     "#{File.dirname(__FILE__)}/templates"
   end
@@ -94,10 +92,6 @@ class Scaffolding < Thor::Group
     automation_type == 'watir'
   end
 
-  def uses_list
-    Array(@uses).reject(&:empty?)
-  end
-
   def default_path(standard_path, file_type)
     path ? "#{path}/#{normalized_name}#{file_type}" : standard_path
   end

data/lib/scaffolding/templates/page_object.tt

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/page'
-<%- uses_list.each do |dep| -%>
-require_relative '<%= dep %>'
-<%- end -%>
 <% if nested? -%>
 <% module_parts.each_with_index do |mod, i| -%>
 <%= '  ' * i %>module <%= mod %>

data/lib/scaffolding/templates/spec.tt

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../page_objects/pages/<%= normalized_name %>'
-<%- uses_list.each do |dep| -%>
-require_relative '../page_objects/pages/<%= dep %>'
-<%- end -%>
 
 describe '<%= page_class_name %>' do
 <%- if selenium? -%>
@@ -11,9 +8,6 @@ describe '<%= page_class_name %>' do
 <%- elsif watir? -%>
   let(:page) { <%= page_class_name %>.new(browser) }
 <%- end -%>
-<%- uses_list.each do |dep| -%>
-  let(:<%= dep %>) { <%= NameNormalizer.to_page_class(dep) %>.new<%= selenium? ? '(driver)' : '(browser)' %> }
-<%- end -%>
 <%- if project_config['url'] -%>
 
   before do

data/lib/scaffolding/templates/steps.tt

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../../page_objects/pages/<%= normalized_name %>'
-<%- uses_list.each do |dep| -%>
-require_relative '../../page_objects/pages/<%= dep %>'
-<%- end -%>
 
 Given('I am on the <%= normalized_name.tr("_", " ") %> page') do
 <%- if selenium? -%>

data/lib/version

@@ -1 +1 @@
-3.2.1
+3.4.0

data/ruby_raider.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = 'agustin.pe94@gmail.com'
   s.homepage = 'https://github.com/RubyRaider/ruby_raider'
   s.license = 'MIT'
-  s.required_ruby_version = '>= 3.1.0'
+  s.required_ruby_version = '>= 3.2.0'
   s.files  = `git ls-files -z`.split("\x0")
   s.bindir = 'bin'
   s.executables << 'raider'

data/sig/commands/scaffolding_commands.rbs

@@ -11,6 +11,6 @@ class ScaffoldingCommands < Thor
   private
 
   def load_config_path: (String type) -> String?
-  def generate_scaffolding: (String name, String type, String? path, ?uses: Array[String]?) -> void
+  def generate_scaffolding: (String name, String type, String? path) -> void
   def generate_default_scaffold: (String name) -> void
 end

data/sig/scaffolding/scaffolding.rbs

@@ -2,8 +2,6 @@
 class Scaffolding < Thor::Group
   include Thor::Actions
 
-  attr_writer uses: Array[String]
-
   def self.source_root: () -> String
 
   # Generation methods
@@ -27,6 +25,5 @@ class Scaffolding < Thor::Group
   def project_config: () -> Hash[String, untyped]
   def selenium?: () -> bool
   def watir?: () -> bool
-  def uses_list: () -> Array[String]
   def default_path: (String standard_path, String file_type) -> String
 end

data/spec/integration/content/ci_content_spec.rb

@@ -44,21 +44,162 @@ describe 'CI pipeline content' do
     end
   end
 
+  shared_examples 'github triggers' do |project_name, file|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    let(:triggers) { YAML.safe_load(pipeline)[true] }
+
+    it 'triggers on push to main and master' do
+      expect(triggers['push']['branches']).to include('main', 'master')
+    end
+
+    it 'triggers on pull_request' do
+      expect(triggers).to have_key('pull_request')
+    end
+
+    it 'triggers on workflow_dispatch' do
+      expect(triggers).to have_key('workflow_dispatch')
+    end
+  end
+
+  shared_examples 'github raider wiring' do |project_name, file|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    let(:steps) { YAML.safe_load(pipeline)['jobs'].values.flat_map { |job| job['steps'] } }
+
+    let(:test_steps) do
+      steps.select { |step| step['run'].to_s.include?('rspec') || step['with'].to_h['script'].to_s.include?('rspec') }
+    end
+
+    it 'passes Raider settings to every test step' do
+      expect(test_steps).not_to be_empty
+      test_steps.each do |step|
+        expect(step['env']).to include('RAIDER_TOKEN' => '${{ secrets.RAIDER_TOKEN }}',
+                                       'RAIDER_ENDPOINT' => '${{ vars.RAIDER_ENDPOINT }}')
+      end
+    end
+
+    it 'uploads raider-results as an artifact even on failure in every job' do
+      uploads = steps.select { |step| step['uses'] == 'actions/upload-artifact@v4' }
+      expect(uploads.size).to eq(YAML.safe_load(pipeline)['jobs'].except('raider-comment').size)
+      uploads.each do |upload|
+        expect(upload['with']['path']).to eq('raider-results/')
+        expect(upload['if']).to eq('always()')
+      end
+    end
+  end
+
+  shared_examples 'github raider-comment job' do |project_name, file, test_jobs|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    let(:jobs) { YAML.safe_load(pipeline)['jobs'] }
+    let(:job) { jobs['raider-comment'] }
+
+    it 'is a valid workflow with exactly the expected jobs' do
+      expect(jobs.keys).to match_array(test_jobs + ['raider-comment'])
+    end
+
+    it 'needs every test job' do
+      expect(job['needs']).to match_array(test_jobs)
+    end
+
+    it 'runs always, on pull requests only' do
+      expect(job['if']).to eq("always() && github.event_name == 'pull_request'")
+      expect(job['runs-on']).to eq('ubuntu-latest')
+    end
+
+    it 'has the least permissions required' do
+      expect(job['permissions']).to eq('contents' => 'read', 'pull-requests' => 'write', 'statuses' => 'write')
+    end
+
+    it 'checks out, sets up the same Ruby as the test jobs and comments' do
+      steps = job['steps']
+      expect(steps[0]).to eq('uses' => 'actions/checkout@v4')
+      expect(steps[1]['uses']).to eq('ruby/setup-ruby@v1')
+      test_ruby = jobs.values_at(*test_jobs).flat_map { |j| j['steps'] }
+                      .find { |step| step['uses'] == 'ruby/setup-ruby@v1' }['with']['ruby-version']
+      expect(steps[1]['with']).to eq('ruby-version' => test_ruby, 'bundler-cache' => true)
+      expect(steps[2]).to eq('name' => 'Comment Raider results on the pull request',
+                             'run' => 'bundle exec raider-reporter comment',
+                             'env' => { 'RAIDER_TOKEN' => '${{ secrets.RAIDER_TOKEN }}',
+                                        'RAIDER_ENDPOINT' => '${{ vars.RAIDER_ENDPOINT }}',
+                                        'GITHUB_TOKEN' => '${{ secrets.GITHUB_TOKEN }}' })
+      expect(steps.size).to eq(3)
+    end
+  end
+
+  shared_examples 'github without raider-comment job' do |project_name, file|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    it 'has no raider-comment job' do
+      expect(pipeline).not_to include('raider-comment')
+      expect(pipeline).not_to include('raider-reporter')
+    end
+  end
+
+  shared_examples 'github without raider wiring' do |project_name, file|
+    subject(:pipeline) { read_generated(project_name, ".github/workflows/#{file}") }
+
+    it 'has no Raider settings or artifact' do
+      expect(pipeline).not_to include('RAIDER_')
+      expect(pipeline).not_to include('raider-results')
+    end
+  end
+
+  shared_examples 'github allure steps' do |project_name|
+    subject(:pipeline) { read_generated(project_name, '.github/workflows/test_pipeline.yml') }
+
+    it 'keeps the Allure steps' do
+      expect(pipeline).to include('simple-elf/allure-report-action', 'peaceiris/actions-gh-pages')
+    end
+  end
+
   context 'with rspec and selenium' do
     name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::SELENIUM}"
     include_examples 'valid github pipeline', name
     include_examples 'github rspec pipeline', name
+    include_examples 'github triggers', name, 'test_pipeline.yml'
+    include_examples 'github raider wiring', name, 'test_pipeline.yml'
+    include_examples 'github raider-comment job', name, 'test_pipeline.yml', %w[build]
+    include_examples 'github allure steps', name
   end
 
   context 'with cucumber and selenium' do
     name = "#{FrameworkIndex::CUCUMBER}_#{AutomationIndex::SELENIUM}"
     include_examples 'valid github pipeline', name
     include_examples 'github cucumber pipeline', name
+    include_examples 'github triggers', name, 'test_pipeline.yml'
+    include_examples 'github without raider wiring', name, 'test_pipeline.yml'
+    include_examples 'github without raider-comment job', name, 'test_pipeline.yml'
+    include_examples 'github allure steps', name
   end
 
   context 'with rspec and watir' do
     name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::WATIR}"
     include_examples 'valid github pipeline', name
     include_examples 'github rspec pipeline', name
+    include_examples 'github triggers', name, 'test_pipeline.yml'
+    include_examples 'github raider wiring', name, 'test_pipeline.yml'
+    include_examples 'github raider-comment job', name, 'test_pipeline.yml', %w[build]
+    include_examples 'github allure steps', name
+  end
+
+  appium_jobs = { 'android' => %w[android-tests], 'ios' => %w[ios-tests],
+                  'cross_platform' => %w[ios-tests android-tests] }
+
+  appium_jobs.each do |automation, test_jobs|
+    context "with rspec and #{automation}" do
+      name = "#{FrameworkIndex::RSPEC}_#{automation}"
+      include_examples 'github raider-comment job', name, 'appium_pipeline.yml', test_jobs
+      include_examples 'github triggers', name, 'appium_pipeline.yml'
+      include_examples 'github raider wiring', name, 'appium_pipeline.yml'
+    end
+
+    context "with cucumber and #{automation}" do
+      name = "#{FrameworkIndex::CUCUMBER}_#{automation}"
+      include_examples 'github triggers', name, 'appium_pipeline.yml'
+      include_examples 'github without raider wiring', name, 'appium_pipeline.yml'
+      include_examples 'github without raider-comment job', name, 'appium_pipeline.yml'
+    end
   end
 end

data/spec/integration/content/common_content_spec.rb

@@ -89,6 +89,10 @@ describe 'Common file content' do
     it 'uses documentation format' do
       expect(rspec_file).to include('--format documentation')
     end
+
+    it 'leaves the raider formatter to spec_helper, since a command-line --format replaces .rspec formatters' do
+      expect(rspec_file).not_to include('RaiderReporter')
+    end
   end
 
   shared_examples 'no rspec dotfile' do |project_name|
@@ -109,6 +113,10 @@ describe 'Common file content' do
     it 'includes spec/examples.txt' do
       expect(gitignore).to include('spec/examples.txt')
     end
+
+    it 'includes raider-results' do
+      expect(gitignore).to include('raider-results')
+    end
   end
 
   shared_examples 'non-rspec gitignore' do |project_name|
@@ -121,6 +129,10 @@ describe 'Common file content' do
     it 'does not include spec/examples.txt' do
       expect(gitignore).not_to include('spec/examples.txt')
     end
+
+    it 'does not include raider-results' do
+      expect(gitignore).not_to include('raider-results')
+    end
   end
 
   # --- Spec helper retry config (C4) ---
@@ -220,5 +232,4 @@ describe 'Common file content' do
     it_behaves_like 'gemfile without rspec-retry', name
     it_behaves_like 'cucumber config with retry', name
   end
-
 end

data/spec/integration/content/gemfile_content_spec.rb

@@ -119,4 +119,42 @@ describe 'Gemfile content' do
     include_examples 'contains watir gems', name
   end
 
+  describe 'raider_reporter and ruby_raider pin' do
+    major_minor = File.read('lib/version').strip.split('.').first(2).join('.')
+
+    AUTOMATION_TYPES.each do |automation|
+      context "with rspec and #{automation}" do
+        let(:gemfile) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'Gemfile') }
+
+        it 'includes raider_reporter' do
+          expect(gemfile).to include("gem 'raider_reporter', '~> 0.3'")
+        end
+
+        it 'keeps allure gems' do
+          expect(gemfile).to include("gem 'allure-rspec', '2.28.0'", "gem 'allure-ruby-commons', '2.28.0'")
+        end
+
+        it 'pins ruby_raider to the generator major.minor' do
+          expect(gemfile).to include("gem 'ruby_raider', '~> #{major_minor}'")
+        end
+      end
+
+      context "with cucumber and #{automation}" do
+        let(:gemfile) { read_generated("#{FrameworkIndex::CUCUMBER}_#{automation}", 'Gemfile') }
+
+        it 'does not include raider_reporter' do
+          expect(gemfile).not_to include('raider_reporter')
+        end
+
+        it 'keeps allure-cucumber' do
+          expect(gemfile).to include("gem 'allure-cucumber', '2.28.0'")
+        end
+
+        it 'pins ruby_raider to the generator major.minor' do
+          expect(gemfile).to include("gem 'ruby_raider', '~> #{major_minor}'")
+        end
+      end
+    end
+  end
+
 end

data/spec/integration/content/helper_content_spec.rb

@@ -109,6 +109,47 @@ describe 'Helper file content' do
     end
   end
 
+  shared_examples 'raider reporter spec helper' do |project_name, screenshot_call|
+    subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
+
+    it 'requires raider_reporter/rspec' do
+      expect(helper).to include("require 'raider_reporter/rspec'")
+    end
+
+    it 'requires digest, which allure-ruby-commons uses without requiring' do
+      expect(helper).to include("require 'digest'")
+    end
+
+    it 'adds the raider formatter in spec_helper so a command-line --format cannot drop it' do
+      expect(helper).to include('config.add_formatter(RaiderReporter::RSpec::Formatter)')
+    end
+
+    it 'does not replace the formatter' do
+      expect(helper).not_to match(/config\.formatter\s*=/)
+    end
+
+    it 'adds the allure formatter' do
+      expect(helper).to include('config.add_formatter(AllureHelper.formatter)')
+    end
+
+    it 'screenshots only on failure' do
+      lines = helper.lines
+      start = lines.index { |line| line.include?('if example.exception') }
+      expect(start).not_to be_nil
+      indent = lines[start][/\A */].size
+      body = lines[(start + 1)..].take_while { |line| line.strip.empty? || line[/\A */].size > indent }
+      guarded = body.join
+
+      expect(guarded).to include('AllureHelper.add_screenshot', 'RaiderReporter.attach', screenshot_call)
+      expect(lines.select { |line| line.include?('AllureHelper.add_screenshot') }.size).to eq(1)
+      expect(lines.select { |line| line.include?(screenshot_call) }.size).to eq(1)
+    end
+
+    it 'attaches the screenshot to raider by path' do
+      expect(helper).to include("RaiderReporter.attach('screenshot', screenshot_path, type: :png)")
+    end
+  end
+
   shared_examples 'selenium spec helper' do |project_name|
     subject(:helper) { read_generated(project_name, 'helpers/spec_helper.rb') }
 
@@ -200,4 +241,25 @@ describe 'Helper file content' do
     name = "#{FrameworkIndex::RSPEC}_#{AutomationIndex::IOS}"
 
   end
+
+  # --- Raider reporter wiring (every rspec automation) ---
+
+  AUTOMATION_TYPES.each do |automation|
+    context "with rspec and #{automation} raider reporter wiring" do
+      name = "#{FrameworkIndex::RSPEC}_#{automation}"
+      screenshot_call = {
+        'selenium' => 'driver.save_screenshot(screenshot_path)',
+        'watir' => 'browser.screenshot.save(screenshot_path)'
+      }.fetch(automation, 'driver.screenshot(screenshot_path)')
+      it_behaves_like 'raider reporter spec helper', name, screenshot_call
+    end
+
+    context "with cucumber and #{automation}" do
+      it 'has no raider reporter wiring' do
+        project = "#{FrameworkIndex::CUCUMBER}_#{automation}"
+        files = Dir.glob("#{project}/**/*", File::FNM_DOTMATCH).select { |f| File.file?(f) }
+        expect(files.select { |f| File.read(f).match?(/raider_reporter|RaiderReporter/) }).to be_empty
+      end
+    end
+  end
 end

data/spec/integration/content/readme_content_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'content_helper'
+
+describe 'Generated Readme content' do
+  AUTOMATION_TYPES.each do |automation|
+    context "with rspec and #{automation}" do
+      subject(:readme) { read_generated("#{FrameworkIndex::RSPEC}_#{automation}", 'Readme.md') }
+
+      it 'has a Reporting section' do
+        expect(readme).to include('## Reporting')
+      end
+
+      it 'documents local results, upload settings and the raider_reporter README' do
+        expect(readme).to include('raider-results/', 'RAIDER_TOKEN', 'RAIDER_ENDPOINT',
+                                  'https://github.com/RaiderHQ/raider_reporter')
+      end
+
+      it 'says Allure is still produced' do
+        expect(readme).to match(/Allure/)
+      end
+    end
+
+    context "with cucumber and #{automation}" do
+      it 'has no Reporting section' do
+        readme = read_generated("#{FrameworkIndex::CUCUMBER}_#{automation}", 'Readme.md')
+        expect(readme).not_to include('RAIDER_TOKEN')
+      end
+    end
+  end
+end

data/spec/integration/end_to_end_spec.rb

@@ -3,6 +3,7 @@
 require_relative 'spec_helper'
 require 'timeout'
 require 'open3'
+require 'json'
 
 # End-to-end integration tests that verify generated projects actually work
 # These tests:
@@ -41,9 +42,19 @@ describe 'End-to-End Project Generation and Execution' do
     result
   end
 
+  # The generated Gemfile pins ruby_raider to this gem's major.minor, which may not be
+  # published yet (a release candidate branch). Resolve it from this checkout instead;
+  # the pin itself is covered by the Gemfile content specs.
+  def use_local_ruby_raider(project_name)
+    gemfile = File.join(project_name, 'Gemfile')
+    root = File.expand_path('../..', __dir__)
+    File.write(gemfile, File.read(gemfile).sub(/^gem 'ruby_raider'.*$/, "gem 'ruby_raider', path: '#{root}'"))
+  end
+
   # Helper to install dependencies
   def bundle_install(project_name)
     puts "\n📦 Installing dependencies for #{project_name}..."
+    use_local_ruby_raider(project_name)
     result = run_in_project(project_name, 'bundle install --quiet', timeout: 180)
 
     unless result[:success]
@@ -93,6 +104,15 @@ describe 'End-to-End Project Generation and Execution' do
       expect(bundle_install(project)).to be true
     end
 
+    it 'resolves raider_reporter 0.3 from RubyGems and ships the raider-reporter executable', :aggregate_failures do
+      skip 'Bundle install failed' unless bundle_install(project)
+
+      expect(File.read(File.join(project, 'Gemfile.lock'))).to match(/^    raider_reporter \(0\.3\.\d+\)$/)
+      result = run_in_project(project, 'bundle exec raider-reporter --help', timeout: 60)
+      expect(result[:exit_code]).to eq(0), "STDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
+      expect(result[:stdout] + result[:stderr]).to include('raider-reporter comment')
+    end
+
     it 'runs generated RSpec tests successfully', :slow do
       skip 'Bundle install failed' unless bundle_install(project)
 
@@ -103,6 +123,25 @@ describe 'End-to-End Project Generation and Execution' do
                                   "STDOUT: #{result[:stdout]}\n" \
                                   "STDERR: #{result[:stderr]}"
     end
+
+    it 'writes raider-results/run.json listing every example without changing the exit status', :aggregate_failures, :slow do
+      skip 'Bundle install failed' unless bundle_install(project)
+
+      FileUtils.rm_rf(File.join(project, 'raider-results'))
+      result = run_rspec(project)
+      summary = result[:stdout].match(/(\d+) examples?, (\d+) failures?/)
+      expect(summary).not_to be_nil, "No RSpec summary line.\nSTDOUT: #{result[:stdout]}\nSTDERR: #{result[:stderr]}"
+      examples = summary[1].to_i
+      failures = summary[2].to_i
+
+      run_file = File.join(project, 'raider-results', 'run.json')
+      expect(File).to exist(run_file)
+      run = JSON.parse(File.read(run_file))
+      expect(run['schema_version']).to eq(1)
+      expect(run['results'].size).to eq(examples)
+      expect(run['results'].count { |r| r['status'] == 'failed' }).to eq(failures)
+      expect(result[:exit_code]).to eq(failures.zero? ? 0 : 1)
+    end
   end
 
   # Shared example for Cucumber-based projects
@@ -142,7 +181,6 @@ describe 'End-to-End Project Generation and Execution' do
     describe 'Watir + Cucumber' do
       include_examples 'executable cucumber project', 'cucumber_watir'
     end
-
   end
 
   # Mobile and Visual frameworks require external services, so we only verify structure

data/spec/integration/scaffolding_e2e_spec.rb

@@ -497,43 +497,6 @@ describe 'Scaffolding E2E' do # rubocop:disable RSpec/DescribeClass
           end
         end
 
-        # ── Relationships ──────────────────────
-
-        describe 'relationships' do
-          before do
-            File.write('page_objects/pages/login.rb', "class LoginPage < Page; end\n")
-          end
-
-          after do
-            FileUtils.rm_f('page_objects/pages/dashboard.rb')
-            FileUtils.rm_f('spec/dashboard_page_spec.rb')
-            FileUtils.rm_f('features/dashboard.feature')
-            FileUtils.rm_f('features/step_definitions/dashboard_steps.rb')
-            FileUtils.rm_f('page_objects/pages/login.rb')
-            FileUtils.rm_rf('features') unless framework == 'cucumber'
-            FileUtils.rm_rf('spec') unless framework == 'rspec'
-          end
-
-          it 'adds require_relative for dependent page' do
-            scaffold.new.invoke(:page, nil, %w[dashboard --uses login])
-            content = File.read('page_objects/pages/dashboard.rb')
-            expect(content).to include("require_relative 'login'")
-          end
-
-          if style == :spec
-            it 'adds dependency to spec let declarations' do
-              scaffold.new.invoke(:spec, nil, %w[dashboard --uses login])
-              content = File.read('spec/dashboard_page_spec.rb')
-              expect(content).to include('LoginPage')
-
-              case automation
-              when 'selenium' then expect(content).to include('LoginPage.new(driver)')
-              when 'watir'    then expect(content).to include('LoginPage.new(browser)')
-              end
-            end
-          end
-        end
-
       end
     end
   end

data/spec/scaffolding/scaffolding_features_spec.rb

@@ -93,26 +93,6 @@ RSpec.describe 'Scaffolding features' do
     end
   end
 
-  # --- Feature 9: Relationships ---
-
-  describe 'relationships (--uses)' do
-    before do
-      File.write('page_objects/pages/login.rb', "class LoginPage < Page; end\n")
-    end
-
-    it 'adds require_relative for dependent pages' do
-      scaffold.new.invoke(:page, nil, %w[dashboard --uses login])
-      content = File.read('page_objects/pages/dashboard.rb')
-      expect(content).to include("require_relative 'login'")
-    end
-
-    it 'adds uses to spec as let declarations' do
-      scaffold.new.invoke(:spec, nil, %w[dashboard --uses login])
-      content = File.read('spec/dashboard_page_spec.rb')
-      expect(content).to include('LoginPage')
-    end
-  end
-
   # --- Feature 1: Batch scaffold ---
 
   describe 'batch scaffolding' do

data/spec/system/support/system_test_helper.rb

@@ -15,6 +15,7 @@ module SystemTestHelper
 
     Bundler.with_unbundled_env do
       Dir.chdir(project) do
+        use_checkout_ruby_raider
         result = run_command('bundle install --quiet')
         return result unless result[:success]
 
@@ -25,6 +26,13 @@ module SystemTestHelper
 
   private
 
+  # The generated Gemfile pins ruby_raider to this gem's major.minor, which may not be
+  # published yet. Resolve it from this checkout; the pin itself is covered by content specs.
+  def use_checkout_ruby_raider(root = File.expand_path('../../..', __dir__))
+    gemfile = File.read('Gemfile')
+    File.write('Gemfile', gemfile.sub(/^gem 'ruby_raider'.*$/, "gem 'ruby_raider', path: '#{root}'"))
+  end
+
   def run_command(command, env: {})
     stdout, stderr, status = Open3.capture3(env, command)
     { success: status.success?, stdout:, stderr: }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Agustin Pequeno
 bindir: bin
 cert_chain: []
-date: 2026-03-14 00:00:00.000000000 Z
+date: 2026-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -309,6 +309,7 @@ files:
 - spec/integration/content/gemfile_content_spec.rb
 - spec/integration/content/helper_content_spec.rb
 - spec/integration/content/page_content_spec.rb
+- spec/integration/content/readme_content_spec.rb
 - spec/integration/content/syntax_validation_spec.rb
 - spec/integration/content/test_content_spec.rb
 - spec/integration/end_to_end_features_spec.rb
@@ -345,7 +346,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="