ruby_raider 3.11.0 → 3.12.1

data/spec/commands/raider_commands_spec.rb

@@ -16,6 +16,54 @@ RSpec.describe RubyRaider::Raider do # rubocop:disable RSpec/FilePath
           hash_including(framework: 'rspec', automation: 'selenium', name: 'my_project')
         )
       end
+
+      it 'passes examples:false through as false' do
+        allow(InvokeGenerators).to receive(:generate_framework)
+
+        described_class.new.invoke(:new, nil, %w[my_project -p framework:rspec automation:selenium examples:false])
+
+        expect(InvokeGenerators).to have_received(:generate_framework).with(hash_including(examples: false))
+      end
+
+      it 'keeps the examples by default' do
+        allow(InvokeGenerators).to receive(:generate_framework)
+
+        described_class.new.invoke(:new, nil, %w[my_project -p framework:rspec automation:selenium])
+
+        expect(InvokeGenerators).to have_received(:generate_framework).with(hash_excluding(:examples))
+      end
+
+      it 'accepts examples:FALSE in any case as false' do
+        allow(InvokeGenerators).to receive(:generate_framework)
+
+        described_class.new.invoke(:new, nil, %w[my_project -p framework:rspec automation:selenium examples:FALSE])
+
+        expect(InvokeGenerators).to have_received(:generate_framework).with(hash_including(examples: false))
+      end
+
+      it 'accepts examples:True in any case as true' do
+        allow(InvokeGenerators).to receive(:generate_framework)
+
+        described_class.new.invoke(:new, nil, %w[my_project -p framework:rspec automation:selenium examples:True])
+
+        expect(InvokeGenerators).to have_received(:generate_framework).with(hash_including(examples: true))
+      end
+
+      it 'rejects any other examples value before generating' do
+        allow(InvokeGenerators).to receive(:generate_framework)
+
+        expect { described_class.new.invoke(:new, nil, %w[my_project -p framework:rspec automation:selenium examples:no]) }
+          .to raise_error(Thor::Error, 'Invalid examples "no". Allowed values: true, false')
+        expect(InvokeGenerators).not_to have_received(:generate_framework)
+      end
+
+      it 'keeps the examples for true' do
+        allow(InvokeGenerators).to receive(:generate_framework)
+
+        described_class.new.invoke(:new, nil, %w[my_project -p framework:rspec automation:selenium examples:true])
+
+        expect(InvokeGenerators).to have_received(:generate_framework).with(hash_including(examples: true))
+      end
     end
 
     context 'without parameters' do

data/spec/fixtures/watir_master/cucumber_watir/Readme.md.snapshot

@@ -0,0 +1,175 @@
+# Ruby Raider
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+   <a href="https://github.com/RubyRaider/ruby_raider">
+   <img src="https://www.ruby-raider.com/assets/icon-DYY74ofR.png" alt="Logo" style="width:200px;">
+   </a>
+   <p align="center">
+      <a href="https://github.com/RubyRaider/ruby_raider#getting-started"><strong>Explore the docs</strong></a>
+      <br />
+      <br />
+      <a href="https://rubygems.org/gems/ruby_raider">Rubygems</a>
+      ·
+      <a href="https://github.com/RubyRaider/ruby_raider/issues">Report Bug</a>
+      ·
+      <a href="https://github.com/RubyRaider/ruby_raider/issues">Request Feature</a>
+   </p>
+   <p align="center"> For more information and updates on releases, see <a href="https://ruby-raider.com">https://ruby-raider.com</a></p>
+</div>
+
+> **Deprecated:** Watir is deprecated and will be removed in the next major version of ruby_raider; new projects should use Selenium. Watir is only available through `-p automation:watir`. See [Migrating from Watir](https://github.com/RaiderHQ/ruby_raider#migrating-from-watir).
+
+## What is Ruby Raider?
+
+Ruby Raider is a generator and scaffolding gem to make UI test automation easier.
+
+### Supported Frameworks
+
+| Web Testing Framework | Mobile Testing Framework           |
+|-----------------------|------------------------------------|
+| Cucumber and Selenium | Cucumber and Appium for iOS        |
+| RSpec and Selenium    | RSpec and Appium for iOS           |
+| Cucumber and Watir    | Cucumber and Appium for Android    |
+| RSpec and Watir       | RSpec and Appium for Android       |
+|                       | Cucumber and Appium Cross-platform |
+|                       | RSpec and Appium Cross-platform    |
+
+**Optional add-on for web projects:**
+- **Accessibility testing (axe)**: `--accessibility` flag
+
+***The web tests run against the [Raider Test Store](https://raider-test-site.onrender.com/).***
+
+***To run Appium tests, 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
+
+```bash
+gem install ruby_raider
+raider new [name_of_project]
+```
+
+Or with parameters:
+
+```bash
+raider new [name_of_project] -p framework:[framework] automation:[automation_type]
+```
+
+### Commands
+
+```
+raider generate         # Scaffolding commands
+raider utility          # Utility commands
+raider new [NAME]       # Create new project
+raider version          # Show version
+raider help [COMMAND]   # Describe commands
+```
+
+Shortcuts: `g` (generate), `n` (new), `u` (utility), `v` (version)
+
+### Scaffolding
+
+```
+raider g page [NAME]      # Create page object
+raider g spec [NAME]      # Create RSpec test
+raider g feature [NAME]   # Create Cucumber feature
+raider g steps [NAME]     # Create step definitions
+raider g scaffold [NAME]  # Create page + test + steps
+```
+
+## Reusing the login
+
+Tag an example `:logged_in` (RSpec) or a scenario `@logged_in` (Cucumber) and the suite logs in once, saves the
+session, and restores it for the next tagged example or run instead of filling in the login form again. The generated
+account example shows it. If the saved session no longer works, the real login runs again and the state is saved anew.
+
+For another role, call it yourself with its own name:
+
+```ruby
+SessionState.new(driver, name: 'admin').reuse(valid: -> { dashboard.tap(&:visit).admin? }) do
+  # the real login for the admin
+end
+```
+
+With Watir, pass `browser.driver`, the Selenium driver underneath the browser.
+
+- `login_state: max_age:` in `config/config.yml` is how many seconds a saved login stays valid (default 3600).
+- `RAIDER_LOGIN_STATE=off` always does the real login and saves nothing; `RAIDER_LOGIN_STATE=refresh` ignores the saved
+  file, logs in and saves again.
+- The state lives in `.raider/auth/` and is git-ignored. It holds live session tokens, so it must not be committed,
+  cached or uploaded as a CI artifact. Nothing in it is ever printed.
+
+## Reporting
+
+Every run writes machine-readable results to `raider-results/` (including `run.json`) and a browsable report,
+`raider-results/index.html`. The reporter runs in plugin mode:
+`features/support/env.rb` requires `raider_reporter/cucumber`, so no extra Cucumber formatter flag is needed.
+
+To upload runs to Raider, set these environment variables before running the suite.
+`RAIDER_TOKEN` and `RAIDER_ENDPOINT` come from your Raider Hideout server (its setup page, or `bin/rails hideout:setup` /
+`hideout:token`):
+
+```bash
+export RAIDER_TOKEN=your-token
+export RAIDER_ENDPOINT=https://hideout.example.com
+```
+
+Without `RAIDER_TOKEN`, nothing is uploaded and the suite output is unchanged. Failure screenshots are attached to the
+report and to Raider. See the [raider_reporter README](https://github.com/RaiderHQ/raider_reporter) for details.
+
+### Video replay
+
+Every test is recorded, and the video is kept only for failing tests. It is attached
+to the report as `video` and saved under `raider-results/attachments/`, next to the failure screenshot.
+The video is a `video.webm` built from page screenshots with ffmpeg.
+
+- Video is on by default: `video:` in `config/config.yml` (`enabled: true`, `fps: 5`, `max_width: 1280`).
+- Turn it off for one run with `VIDEO=off bundle exec cucumber`, or for the project with
+  `raider u video off` (`raider u video on` turns it back on).
+- ffmpeg is downloaded on first use, checked against a pinned SHA-256 and cached in `~/.cache/raider`
+  (`%LOCALAPPDATA%\raider` on Windows). `raider u video install` downloads it ahead of time (CI does this before the
+  tests and caches the folder), and `raider u video status` prints the binary in use.
+- `RAIDER_FFMPEG_PATH` uses your own ffmpeg (it needs libvpx) instead of the download, and `RAIDER_CACHE_DIR` moves
+  the cache.
+- The RaiderHQ `ffmpeg-7.1` release that the download comes from is not published yet. Until it is, set
+  `RAIDER_FFMPEG_PATH` to get videos; without it the suite runs as usual and prints one `[video]` line.
+- If ffmpeg is missing or recording fails, the suite still runs and its exit code is unchanged; you get one `[video]`
+  line on stderr and no video.
+- Known limits: a frame is taken after each page load, click and text change, plus one at the end of a failing test,
+  so changes the page makes on its own between actions show up in the next frame. There is one recorded driver per
+  process.
+
+### Quarantine
+
+CI runs the suite through `bundle exec raider-reporter exec -- …` with `RAIDER_QUARANTINE` set. Tests quarantined in
+Raider still run and are still reported (as `quarantined`), and a build whose only failures are quarantined stays green.
+Local runs keep quarantine off. To turn it off in CI, remove `RAIDER_QUARANTINE` from the pipeline.
+
+### Quality gate
+
+The `raider-gate` CI job runs `bundle exec raider-reporter gate` after the tests and
+fails the pipeline when the Raider quality gate fails. It is off until you turn it on:
+
+- set the CI variable `RAIDER_GATE=1` (a repository variable under Settings → Secrets and variables → Actions → Variables);
+- turn on rules under the project's Gate page in Raider: a minimum pass rate, no new failures against the default
+  branch, no new flaky tests;
+- optionally require the `raider/gate` check in branch protection.
+
+`raider-reporter gate` exits 1 when the gate fails, naming the failed rules, and 2 when it gets no verdict (timeout,
+Raider unreachable, token rejected, build not found). `RAIDER_GATE_TIMEOUT` sets how long it waits, in seconds
+(default 600). The job stays off by default because a project without `RAIDER_TOKEN`, or a pull request from a fork,
+would exit 2 on every run.
+
+Parallel test jobs that upload to one build must each set `RAIDER_SHARD_TOTAL` (the number of jobs) and
+`RAIDER_SHARD_INDEX` (1 to that number), so the gate waits for all of them instead of judging the first one to finish.
+
+### Sponsors
+
+This project is tested with BrowserStack.

data/spec/fixtures/watir_master/cucumber_watir/features/step_definitions/login_steps.rb.snapshot

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../../page_objects/pages/account'
+require_relative '../../page_objects/pages/login'
+
+Given("I'm a {user} on the login page") do |user|
+  @user = user
+  @login_page = Login.new(browser)
+  @login_page.visit
+end
+
+Given("I'm a {user}") do |user|
+  @user = user
+end
+
+When('I login with my credentials') do
+  @login_page.login(@user['username'], @user['password'])
+end
+
+Then("I'm logged in") do
+  account_page = Account.new(browser)
+  account_page.visit
+  expect(account_page.header.customer_name).to eq "Welcome back #{@user['name']}"
+end

data/spec/fixtures/watir_master/cucumber_watir/page_objects/abstract/page.rb.snapshot

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../components/header'
+
+class Page
+  attr_reader :browser
+
+  def initialize(browser)
+    @browser = browser
+  end
+
+  def visit(*page)
+    @browser.goto full_url(page.first)
+  end
+
+  def full_url(*page)
+    "#{base_url}#{url(*page)}"
+  end
+
+  def base_url
+    YAML.load_file('config/config.yml')['url']
+  end
+
+  def url(_page)
+    raise 'Url must be defined on child pages'
+  end
+
+  def to_s
+    self.class.to_s.sub('Page', ' Page')
+  end
+
+  # Components
+
+  def header
+    Header.new(browser.element(css: '.welcome-msg'))
+  end
+end

data/spec/fixtures/watir_master/cucumber_watir/page_objects/pages/login.rb.snapshot

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/page'
+
+class Login < Page
+  def url(_page)
+    'index.php?rt=account/login'
+  end
+
+  # Actions
+
+  def login(username, password)
+    username_field.set username
+    password_field.set password
+    login_button.click
+  end
+
+  private
+
+  # Elements
+
+  def username_field
+    browser.text_field(id: 'loginFrm_loginname')
+  end
+
+  def password_field
+    browser.text_field(id: 'loginFrm_password')
+  end
+
+  def login_button
+    browser.button(xpath: "//button[@title='Login']")
+  end
+end

data/spec/fixtures/watir_master/rspec_watir/Readme.md.snapshot

@@ -0,0 +1,174 @@
+# Ruby Raider
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+   <a href="https://github.com/RubyRaider/ruby_raider">
+   <img src="https://www.ruby-raider.com/assets/icon-DYY74ofR.png" alt="Logo" style="width:200px;">
+   </a>
+   <p align="center">
+      <a href="https://github.com/RubyRaider/ruby_raider#getting-started"><strong>Explore the docs</strong></a>
+      <br />
+      <br />
+      <a href="https://rubygems.org/gems/ruby_raider">Rubygems</a>
+      ·
+      <a href="https://github.com/RubyRaider/ruby_raider/issues">Report Bug</a>
+      ·
+      <a href="https://github.com/RubyRaider/ruby_raider/issues">Request Feature</a>
+   </p>
+   <p align="center"> For more information and updates on releases, see <a href="https://ruby-raider.com">https://ruby-raider.com</a></p>
+</div>
+
+> **Deprecated:** Watir is deprecated and will be removed in the next major version of ruby_raider; new projects should use Selenium. Watir is only available through `-p automation:watir`. See [Migrating from Watir](https://github.com/RaiderHQ/ruby_raider#migrating-from-watir).
+
+## What is Ruby Raider?
+
+Ruby Raider is a generator and scaffolding gem to make UI test automation easier.
+
+### Supported Frameworks
+
+| Web Testing Framework | Mobile Testing Framework           |
+|-----------------------|------------------------------------|
+| Cucumber and Selenium | Cucumber and Appium for iOS        |
+| RSpec and Selenium    | RSpec and Appium for iOS           |
+| Cucumber and Watir    | Cucumber and Appium for Android    |
+| RSpec and Watir       | RSpec and Appium for Android       |
+|                       | Cucumber and Appium Cross-platform |
+|                       | RSpec and Appium Cross-platform    |
+
+**Optional add-on for web projects:**
+- **Accessibility testing (axe)**: `--accessibility` flag
+
+***The web tests run against the [Raider Test Store](https://raider-test-site.onrender.com/).***
+
+***To run Appium tests, 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
+
+```bash
+gem install ruby_raider
+raider new [name_of_project]
+```
+
+Or with parameters:
+
+```bash
+raider new [name_of_project] -p framework:[framework] automation:[automation_type]
+```
+
+### Commands
+
+```
+raider generate         # Scaffolding commands
+raider utility          # Utility commands
+raider new [NAME]       # Create new project
+raider version          # Show version
+raider help [COMMAND]   # Describe commands
+```
+
+Shortcuts: `g` (generate), `n` (new), `u` (utility), `v` (version)
+
+### Scaffolding
+
+```
+raider g page [NAME]      # Create page object
+raider g spec [NAME]      # Create RSpec test
+raider g feature [NAME]   # Create Cucumber feature
+raider g steps [NAME]     # Create step definitions
+raider g scaffold [NAME]  # Create page + test + steps
+```
+
+## Reusing the login
+
+Tag an example `:logged_in` (RSpec) or a scenario `@logged_in` (Cucumber) and the suite logs in once, saves the
+session, and restores it for the next tagged example or run instead of filling in the login form again. The generated
+account example shows it. If the saved session no longer works, the real login runs again and the state is saved anew.
+
+For another role, call it yourself with its own name:
+
+```ruby
+SessionState.new(driver, name: 'admin').reuse(valid: -> { dashboard.tap(&:visit).admin? }) do
+  # the real login for the admin
+end
+```
+
+With Watir, pass `browser.driver`, the Selenium driver underneath the browser.
+
+- `login_state: max_age:` in `config/config.yml` is how many seconds a saved login stays valid (default 3600).
+- `RAIDER_LOGIN_STATE=off` always does the real login and saves nothing; `RAIDER_LOGIN_STATE=refresh` ignores the saved
+  file, logs in and saves again.
+- The state lives in `.raider/auth/` and is git-ignored. It holds live session tokens, so it must not be committed,
+  cached or uploaded as a CI artifact. Nothing in it is ever printed.
+
+## Reporting
+
+Every run writes machine-readable results to `raider-results/` (including `run.json`) and a browsable report,
+`raider-results/index.html`. Open it in a browser after a run; `bundle exec raider-reporter report` rebuilds it.
+
+To upload runs to Raider, set these environment variables before running the suite.
+`RAIDER_TOKEN` and `RAIDER_ENDPOINT` come from your Raider Hideout server (its setup page, or `bin/rails hideout:setup` /
+`hideout:token`):
+
+```bash
+export RAIDER_TOKEN=your-token
+export RAIDER_ENDPOINT=https://hideout.example.com
+```
+
+Without `RAIDER_TOKEN`, nothing is uploaded and the suite output is unchanged. Failure screenshots are attached to the
+report and to Raider. See the [raider_reporter README](https://github.com/RaiderHQ/raider_reporter) for details.
+
+### Video replay
+
+Every test is recorded, and the video is kept only for failing tests (on the last retry attempt). It is attached
+to the report as `video` and saved under `raider-results/attachments/`, next to the failure screenshot.
+The video is a `video.webm` built from page screenshots with ffmpeg.
+
+- Video is on by default: `video:` in `config/config.yml` (`enabled: true`, `fps: 5`, `max_width: 1280`).
+- Turn it off for one run with `VIDEO=off bundle exec rspec`, or for the project with
+  `raider u video off` (`raider u video on` turns it back on).
+- ffmpeg is downloaded on first use, checked against a pinned SHA-256 and cached in `~/.cache/raider`
+  (`%LOCALAPPDATA%\raider` on Windows). `raider u video install` downloads it ahead of time (CI does this before the
+  tests and caches the folder), and `raider u video status` prints the binary in use.
+- `RAIDER_FFMPEG_PATH` uses your own ffmpeg (it needs libvpx) instead of the download, and `RAIDER_CACHE_DIR` moves
+  the cache.
+- The RaiderHQ `ffmpeg-7.1` release that the download comes from is not published yet. Until it is, set
+  `RAIDER_FFMPEG_PATH` to get videos; without it the suite runs as usual and prints one `[video]` line.
+- If ffmpeg is missing or recording fails, the suite still runs and its exit code is unchanged; you get one `[video]`
+  line on stderr and no video.
+- Known limits: a frame is taken after each page load, click and text change, plus one at the end of a failing test,
+  so changes the page makes on its own between actions show up in the next frame. There is one recorded driver per
+  process.
+
+### Quarantine
+
+CI runs the suite through `bundle exec raider-reporter exec -- …` with `RAIDER_QUARANTINE` set. Tests quarantined in
+Raider still run and are still reported (as `quarantined`), and a build whose only failures are quarantined stays green.
+Local runs keep quarantine off. To turn it off in CI, remove `RAIDER_QUARANTINE` from the pipeline.
+
+### Quality gate
+
+The `raider-gate` CI job runs `bundle exec raider-reporter gate` after the tests and
+fails the pipeline when the Raider quality gate fails. It is off until you turn it on:
+
+- set the CI variable `RAIDER_GATE=1` (a repository variable under Settings → Secrets and variables → Actions → Variables);
+- turn on rules under the project's Gate page in Raider: a minimum pass rate, no new failures against the default
+  branch, no new flaky tests;
+- optionally require the `raider/gate` check in branch protection.
+
+`raider-reporter gate` exits 1 when the gate fails, naming the failed rules, and 2 when it gets no verdict (timeout,
+Raider unreachable, token rejected, build not found). `RAIDER_GATE_TIMEOUT` sets how long it waits, in seconds
+(default 600). The job stays off by default because a project without `RAIDER_TOKEN`, or a pull request from a fork,
+would exit 2 on every run.
+
+Parallel test jobs that upload to one build must each set `RAIDER_SHARD_TOTAL` (the number of jobs) and
+`RAIDER_SHARD_INDEX` (1 to that number), so the gate waits for all of them instead of judging the first one to finish.
+
+### Sponsors
+
+This project is tested with BrowserStack.

data/spec/fixtures/watir_master/rspec_watir/page_objects/abstract/page.rb.snapshot

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../components/header'
+
+class Page
+  attr_reader :browser
+
+  def initialize(browser)
+    @browser = browser
+  end
+
+  def visit(*page)
+    @browser.goto full_url(page.first)
+  end
+
+  def full_url(*page)
+    "#{base_url}#{url(*page)}"
+  end
+
+  def base_url
+    YAML.load_file('config/config.yml')['url']
+  end
+
+  def url(_page)
+    raise 'Url must be defined on child pages'
+  end
+
+  def to_s
+    self.class.to_s.sub('Page', ' Page')
+  end
+
+  # Components
+
+  def header
+    Header.new(browser.element(css: '.welcome-msg'))
+  end
+end

data/spec/fixtures/watir_master/rspec_watir/page_objects/pages/login.rb.snapshot

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/page'
+
+class Login < Page
+  def url(_page)
+    'index.php?rt=account/login'
+  end
+
+  # Actions
+
+  def login(username, password)
+    username_field.set username
+    password_field.set password
+    login_button.click
+  end
+
+  private
+
+  # Elements
+
+  def username_field
+    browser.text_field(id: 'loginFrm_loginname')
+  end
+
+  def password_field
+    browser.text_field(id: 'loginFrm_password')
+  end
+
+  def login_button
+    browser.button(xpath: "//button[@title='Login']")
+  end
+end

data/spec/fixtures/watir_master/rspec_watir/spec/login_page_spec.rb.snapshot

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/spec_helper'
+require_relative '../models/model_factory'
+require_relative '../page_objects/pages/account'
+require_relative '../page_objects/pages/login'
+
+# rubocop:disable RSpec/MultipleDescribes
+describe 'Login' do
+  subject(:header) { account_page.header.customer_name }
+
+  let(:user) { ModelFactory.for('users')['registered user'] }
+  let(:login_page) { Login.new(browser) }
+  let(:account_page) { Account.new(browser) }
+
+  before do
+    login_page.visit
+    login_page.login(user['username'], password)
+  end
+
+  context 'with right credentials' do
+    let(:password) { user['password'] }
+
+    it 'can successfully log in' do
+      account_page.visit
+      expect(header).to eq "Welcome back #{user['name']}"
+    end
+  end
+
+  context 'with wrong credentials' do
+    let(:password) { 'wrongPassword' }
+
+    it 'cannot log in' do
+      login_page.visit
+      expect(header).to eq 'Login or register'
+    end
+  end
+end
+
+describe 'Account', :logged_in do
+  let(:user) { ModelFactory.for('users')['registered user'] }
+  let(:account_page) { Account.new(browser) }
+
+  it 'opens the account page with the saved login' do
+    account_page.visit
+    expect(account_page.header.customer_name).to eq "Welcome back #{user['name']}"
+  end
+end
+# rubocop:enable RSpec/MultipleDescribes

data/spec/integration/commands/scaffolding_commands_spec.rb

@@ -94,4 +94,53 @@ describe ScaffoldingCommands do
       expect(Pathname.new("#{new_path}/#{name}_helper.rb")).to be_file
     end
   end
+
+  describe 'waiting examples' do
+    let(:tmp_dir) { 'tmp_scaffold_wait_helper_test' }
+    let(:selenium_example) { "driver.find_element(id: 'element_id')" }
+    let(:waiting_example) { "click({ id: 'element_id' })" }
+
+    def scaffold_in_project(gem_name, kind, wait_helper:)
+      FileUtils.mkdir_p("#{tmp_dir}/helpers")
+      File.write("#{tmp_dir}/Gemfile", "gem 'rspec'\ngem '#{gem_name}'\n")
+      File.write("#{tmp_dir}/helpers/wait_helper.rb", '') if wait_helper
+      Dir.chdir(tmp_dir) { scaffold.new.invoke(kind, nil, %w[foo]) }
+    end
+
+    after do
+      Dir.chdir orig_dir
+      FileUtils.rm_rf(tmp_dir)
+    end
+
+    it 'shows the waiting example in a page when the project has the wait helper' do
+      scaffold_in_project('selenium-webdriver', :page, wait_helper: true)
+      content = File.read("#{tmp_dir}/page_objects/pages/foo.rb")
+      expect(content).to include(waiting_example)
+      expect(content).not_to include(selenium_example)
+    end
+
+    it 'keeps the driver example in a page without the wait helper' do
+      scaffold_in_project('selenium-webdriver', :page, wait_helper: false)
+      content = File.read("#{tmp_dir}/page_objects/pages/foo.rb")
+      expect(content).to include(selenium_example)
+      expect(content).not_to include(waiting_example)
+    end
+
+    it 'shows the waiting example in a component when the project has the wait helper' do
+      scaffold_in_project('selenium-webdriver', :component, wait_helper: true)
+      expect(File.read("#{tmp_dir}/page_objects/components/foo.rb")).to include("component.find_element(css: '.selector').click")
+    end
+
+    it 'keeps the driver example in a component without the wait helper' do
+      scaffold_in_project('selenium-webdriver', :component, wait_helper: false)
+      expect(File.read("#{tmp_dir}/page_objects/components/foo.rb")).to include("driver.find_element(css: '.selector')")
+    end
+
+    it 'leaves Watir output unchanged even with a wait helper present' do
+      scaffold_in_project('watir', :page, wait_helper: true)
+      content = File.read("#{tmp_dir}/page_objects/pages/foo.rb")
+      expect(content).to include("browser.text_field(id: 'element_id')")
+      expect(content).not_to include(waiting_example)
+    end
+  end
 end