ruby_raider 3.13.0 → 4.0.0

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

@@ -1,21 +0,0 @@
-<%- if web? -%>
-Feature: Login Page
-
-Scenario: A user can login
-    Given I'm a registered user on the login page
-    When I login with my credentials
-    Then I'm logged in
-
-@logged_in
-Scenario: A logged-in user opens the account page
-    Given I'm a registered user
-    Then I'm logged in
-
-<%- else -%>
-Feature: Home Page
-
-Scenario: A user can go to the product details page
-    Given I'm an anonymous user on the home page
-    When I select one of the products
-    Then I'm redirected to the product details page
-<%- end %>

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'raider_reporter/cucumber'
-require 'tmpdir'
-require_relative '../../helpers/video_helper'
-
-Before do
-  driver.start_driver
-  @video_recorder = VideoHelper.recorder_for(driver)
-  @video_recorder.start
-end
-
-After do |scenario|
-  video_path = @video_recorder&.stop(keep: scenario.failed?)
-  RaiderReporter.attach('video', video_path, type: :mp4) if video_path
-  if scenario.failed?
-    Dir.mktmpdir do |temp_folder|
-      screenshot_path = File.join(temp_folder, 'screenshot.png')
-      driver.screenshot(screenshot_path)
-      RaiderReporter.attach('screenshot', screenshot_path, type: :png)
-    end
-  end
-ensure
-  @video_recorder&.cleanup
-  driver.quit_driver
-end

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

@@ -1,18 +0,0 @@
-require_relative '../../helpers/driver_helper'
-<%- if wait_helper? -%>
-require_relative '../../helpers/wait_helper'
-<%- end -%>
-<%- if selenium_based? -%>
-<%- if examples? -%>
-require_relative '../../models/user_factory'
-<%- end -%>
-
-World(DriverHelper)
-World(WaitHelper)
-<%- else -%>
-
-World(DriverHelper)
-<%- if wait_helper? -%>
-World(WaitHelper)
-<%- end -%>
-<%- end -%>

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-<%- if cross_platform? -%>
-require_relative '../../helpers/appium_helper'
-<%- end -%>
-require_relative '../../page_objects/pages/home'
-require_relative '../../page_objects/pages/pdp'
-
-Given("I'm an anonymous user on the home page") do
-  @home_page = Home.new(driver)
-end
-
-When('I select one of the products') do
-  @home_page.go_to_product_detail
-end
-
-Then("I'm redirected to the product details page") do
-  pdp_page = Pdp.new(driver)
-  eventually { expect(pdp_page.add_to_cart_text).to eq 'Add to Cart' }
-end

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

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-<%- if axe_addon? && cucumber? -%>
-require 'axe-rspec'
-<%- end -%>
-require 'rspec'
-require 'raider_reporter/cucumber'
-require 'tmpdir'
-require 'yaml'
-require_relative '../../helpers/video_helper'
-<%- if trace_helper? -%>
-require_relative '../../helpers/trace_helper'
-<%- end -%>
-require_relative '../../helpers/session_state'
-<%- if examples? -%>
-require_relative '../../models/user_factory'
-require_relative '../../page_objects/pages/account'
-require_relative '../../page_objects/pages/login'
-<%- end -%>
-
-<%- if trace_helper? -%>
-# Attempts per scenario across --retry, keyed on the scenario's location, for the trace of each attempt.
-TRACE_ATTEMPTS = Hash.new(0) unless defined?(TRACE_ATTEMPTS)
-
-# Each Gherkin step becomes a group in the trace, named by its keyword and text; hook steps are not steps.
-InstallPlugin do |config, _registry|
-  if defined?(TraceHelper)
-    begin
-      ast_lookup = Cucumber::Formatter::AstLookup.new(config)
-      groups = {}
-      config.on_event(:test_step_started) do |event|
-        next if event.test_step.hook?
-
-        step = event.test_step
-        keyword = begin
-          ast_lookup.step_source(step).step.keyword.strip
-        rescue StandardError
-          nil
-        end
-        location = { file: step.location.file, line: step.location.lines.min }
-        groups[step.id] = TraceHelper.active_recorder&.step_started(name: [keyword, step.text].compact.join(' '), source: location)
-      rescue StandardError => e
-        TraceHelper.disable!("step groups failed: #{e.message}") if defined?(TraceHelper)
-      end
-      config.on_event(:test_step_finished) do |event|
-        next if event.test_step.hook?
-
-        status = %i[passed failed].include?(event.result.to_sym) ? event.result.to_sym : :skipped
-        error = event.result.failed? ? event.result.exception : nil
-        TraceHelper.active_recorder&.step_finished(groups.delete(event.test_step.id), status: status, error: error)
-      rescue StandardError => e
-        TraceHelper.disable!("step groups failed: #{e.message}") if defined?(TraceHelper)
-      end
-    rescue StandardError => e
-      TraceHelper.warn_once("Gherkin step groups unavailable: #{e.message}")
-    end
-  end
-end
-
-<%- end -%>
-Before do<%= trace_helper? ? ' |scenario|' : '' %>
-  viewport = YAML.load_file('config/config.yml')['viewport']
-  if viewport
-    driver.manage.window.resize_to(viewport['width'], viewport['height'])
-  else
-    driver.manage.window.maximize
-  end
-  @video_recorder = VideoHelper.recorder_for(driver)
-  @video_recorder.start
-<%- if trace_helper? -%>
-  if defined?(TraceHelper)
-    @trace_attempt = (TRACE_ATTEMPTS[scenario.location.to_s] += 1)
-    @trace_test = { identifier: scenario.location.to_s, full_name: scenario.name, attempt: @trace_attempt }
-    @trace_recorder = TraceHelper.recorder_for(driver)
-    @trace_recorder.start
-  end
-<%- end -%>
-end
-
-<%- if examples? -%>
-Before('@logged_in') do
-  user = UserFactory.for('registered user')
-  account = Account.new(driver)
-  SessionState.new(driver).reuse(
-    valid: -> { account.tap(&:visit).header.customer_name == "Welcome back #{user['name']}" }
-  ) do
-    login = Login.new(driver)
-    login.visit
-    login.login(user['username'], user['password'])
-  end
-end
-
-<%- end -%>
-After do |scenario|
-<%- if trace_helper? -%>
-  if defined?(TraceHelper)
-    keep_trace = TraceHelper.keep_all? || scenario.failed?
-    trace_test = @trace_test&.merge(status: scenario.failed? ? 'failed' : 'passed', error: scenario.exception)
-    trace_path = @trace_recorder&.stop(keep: keep_trace, test: trace_test)
-  end
-<%- end -%>
-  video_path = @video_recorder&.stop(keep: scenario.failed?)
-  RaiderReporter.attach('video', video_path, type: :webm) if video_path
-<%- if trace_helper? -%>
-  RaiderReporter.attach('trace', trace_path, type: :trace, attempt: @trace_attempt) if trace_path
-<%- end -%>
-  if scenario.failed?
-    Dir.mktmpdir do |temp_folder|
-      screenshot_path = File.join(temp_folder, 'screenshot.png')
-      driver.save_screenshot(screenshot_path)
-      RaiderReporter.attach('screenshot', screenshot_path, type: :png)
-    end
-  end
-ensure
-<%- if trace_helper? -%>
-  @trace_recorder&.cleanup
-<%- end -%>
-  @video_recorder&.cleanup
-  driver.quit
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'raider_reporter/cucumber'
-require 'tmpdir'
-require 'yaml'
-require_relative '../../helpers/video_helper'
-require_relative '../../helpers/session_state'
-require_relative '../../models/user_factory'
-require_relative '../../page_objects/pages/account'
-require_relative '../../page_objects/pages/login'
-
-Before do
-  viewport = YAML.load_file('config/config.yml')['viewport']
-  if viewport
-    browser.window.resize_to(viewport['width'], viewport['height'])
-  else
-    browser.window.maximize
-  end
-  @video_recorder = VideoHelper.recorder_for(browser)
-  @video_recorder.start
-end
-
-Before('@logged_in') do
-  user = UserFactory.for('registered user')
-  account = Account.new(browser)
-  SessionState.new(browser.driver).reuse(
-    valid: -> { account.tap(&:visit).header.customer_name == "Welcome back #{user['name']}" }
-  ) do
-    login = Login.new(browser)
-    login.visit
-    login.login(user['username'], user['password'])
-  end
-end
-
-After do |scenario|
-  video_path = @video_recorder&.stop(keep: scenario.failed?)
-  RaiderReporter.attach('video', video_path, type: :webm) if video_path
-  if scenario.failed?
-    Dir.mktmpdir do |temp_folder|
-      screenshot_path = File.join(temp_folder, 'screenshot.png')
-      browser.screenshot.save(screenshot_path)
-      RaiderReporter.attach('screenshot', screenshot_path, type: :png)
-    end
-  end
-ensure
-  @video_recorder&.cleanup
-  browser.quit
-end

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

@@ -1,4 +0,0 @@
-require_relative '../../helpers/browser_helper'
-require_relative '../../models/user_factory'
-
-World(BrowserHelper)

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

@@ -1,28 +0,0 @@
-# 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 = <% if watir? %>Login.new(browser)<% else %>Login.new(driver)<% end %>
-  @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 = <% if watir? %>Account.new(browser)<% else %>Account.new(driver)<% end %>
-  account_page.visit
-<%- if watir? -%>
-  expect(account_page.header.customer_name).to eq "Welcome back #{@user['name']}"
-<%- else -%>
-  eventually { expect(account_page.header.customer_name).to eq "Welcome back #{@user['name']}" }
-<%- end -%>
-end

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

@@ -1,5 +0,0 @@
-<%- if web? -%>
-<%= partial('web_steps', strip: true) %>
-<%- else -%>
-<%= partial('mobile_steps', strip: true) %>
-<%- end -%>

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'model_factory'
-
-class UserFactory < ModelFactory
-  def self.for(user)
-    super('users')[user]
-  end
-end
-
-ParameterType(
-  name: 'user',
-  regexp: /[A-Za-z0-9]+ user/,
-  transformer: ->(user) { UserFactory.for(user) }
-)

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-<%- if watir? -%>
-<%= partial('watir_world', strip: true) %>
-<%- else -%>
-<%= partial('driver_world', strip: true) %>
-<%- end -%>

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/string/inflections'
-require 'yaml'
-require 'watir'
-require_relative 'video_helper'
-
-module BrowserHelper
-  def browser(*args)
-    @browser ||= create_browser(*args)
-  end
-
-  private
-
-  def config
-    @config ||= YAML.load_file('config/config.yml')
-  end
-
-  def create_browser(*args)
-    Watir.default_timeout = config.fetch('timeout', 10)
-    browser_name = config['browser'].to_s
-    args = args.empty? ? config['browser_arguments'][browser_name] : args
-    args += ['--headless'] if (ENV['HEADLESS'] || config['headless']) && !args.include?('--headless')
-    capitalized = browser_name == 'ie' ? browser_name.upcase : browser_name.capitalize
-    browser_options = "Selenium::WebDriver::#{capitalized}::Options".constantize.new(args: args)
-    arguments = { options: browser_options }
-    listener = VideoHelper.listener
-    arguments[:listener] = listener if listener
-    Watir::Browser.new(browser_name.to_sym, **arguments)
-  end
-end

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

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-<%- if mobile? -%>
-# An element found through WaitHelper. It has the same waiting methods as the
-# mixin, minus the locator, so calls chain:
-#   find_element(accessibility_id: 'list').find_element(accessibility_id: 'row').tap
-#   find_element(accessibility_id: 'card').swipe('left')
-# Everything else (tag_name, rect, location, ...) goes to the raw Appium
-# element without waiting. APIs that type-check their argument
-# (driver.action, execute_script) need .native.
-<%- else -%>
-# An element found through WaitHelper. It has the same waiting methods as the
-# mixin, minus the locator, so calls chain:
-#   find_element(css: '.form').find_element(id: 'email').send_keys('a')
-# Everything else (tag_name, rect, property, ...) goes to the raw Selenium
-# element without waiting. Selenium APIs that type-check their argument
-# (switch_to.frame, Support::Select, driver.action, execute_script) need .native.
-<%- end -%>
-class RaiderElement
-  def initialize(driver, lookup)
-    @driver = driver
-    @lookup = lookup
-  end
-
-  def native
-    @lookup.element
-  end
-
-  def find_element(locator = nil, visible: true, timeout: nil, **by)
-    waiter(timeout).find_element(child(locator, by), visible)
-  end
-
-  def find_elements(locator = nil, timeout: nil, **by)
-    waiter(timeout).find_elements(child(locator, by))
-  end
-
-<%- if mobile? -%>
-  %i[click clear].each do |action|
-    define_method(action) do |timeout: nil|
-      perform(action, timeout) { |element| element.public_send(action) }
-      self
-    end
-  end
-
-  # tap is Appium's word for click. With a block it stays Ruby's Object#tap.
-  def tap(timeout: nil, &block)
-    return super(&block) if block
-
-    perform(:tap, timeout, &:click)
-    self
-  end
-<%- else -%>
-  %i[click clear submit].each do |action|
-    define_method(action) do |timeout: nil|
-      perform(action, timeout) { |element| element.public_send(action) }
-      self
-    end
-  end
-<%- end -%>
-
-  %i[text displayed? enabled? selected?].each do |reader|
-    define_method(reader) do |timeout: nil|
-      perform(reader, timeout) { |element| element.public_send(reader) }
-    end
-  end
-
-  def send_keys(*keys, timeout: nil)
-    perform(:send_keys, timeout, args: keys) { |element| element.send_keys(*keys) }
-    self
-  end
-
-<%- unless mobile? -%>
-  def select_by(how, what, timeout: nil)
-    perform(:select_by, timeout, args: [how, what]) { |element| Selenium::WebDriver::Support::Select.new(element).select_by(how, what) }
-    self
-  end
-
-<%- end -%>
-  def attribute(name, timeout: nil)
-    perform(:attribute, timeout) { |element| element.attribute(name) }
-  end
-
-<%- if mobile? -%>
-  # direction: 'up', 'down', 'left' or 'right'.
-  %i[swipe scroll].each do |kind|
-    define_method(kind) do |direction, timeout: nil|
-      gesture = WaitHelper::Gesture.new(@driver, kind, direction)
-      perform(kind, timeout) { |element| gesture.perform(element) }
-      self
-    end
-  end
-
-  # Scrolls the screen until this element is visible, up to max_scrolls times.
-  def scroll_to(direction: 'down', max_scrolls: 10, timeout: nil)
-    scroller = WaitHelper::Scroller.new(WaitHelper::Gesture.new(@driver, :scroll, direction), max_scrolls)
-    waiter(timeout).perform_action(:scroll_to, @lookup, WaitHelper::Waiter::CHECKS[:scroll_to], between: scroller) { nil }
-    self
-  end
-<%- else -%>
-  def hover(timeout: nil)
-    perform(:hover, timeout) { |element| @driver.action.move_to(element).perform }
-    self
-  end
-
-  def scroll_into_view(timeout: nil)
-    perform(:scroll_into_view, timeout) { |element| @driver.action.scroll_to(element).perform }
-    self
-  end
-
-  # target: a RaiderElement, a raw element, or a driver-scoped locator.
-  def drag_and_drop(target, timeout: nil)
-    drop = WaitHelper::Lookup.for(@driver, target, {})
-    waiter(timeout).perform_action(:drag_and_drop, @lookup, WaitHelper::Waiter::CHECKS[:drag_and_drop],
-                                   target: drop) do |source, destination|
-      @driver.action.drag_and_drop(source, destination).perform
-    end
-    self
-  end
-<%- end -%>
-
-  def ==(other)
-    native == (other.is_a?(RaiderElement) ? other.native : other)
-  end
-
-  def eql?(other)
-    self == other
-  end
-
-  def hash
-    native.hash
-  end
-
-  private
-
-  # WaitHelper::Lookup.for reads this to reuse how a wrapper was found.
-  attr_reader :lookup
-
-  def waiter(timeout)
-    WaitHelper::Waiter.new(@driver, timeout: timeout)
-  end
-
-  def child(locator, by)
-    WaitHelper::Lookup.for(@driver, locator, by, scope: @lookup)
-  end
-
-  def perform(action, timeout, args: nil, &block)
-    waiter(timeout).perform_action(action, @lookup, WaitHelper::Waiter::CHECKS.fetch(action), args: args, &block)
-  end
-
-  def method_missing(name, *args, **options, &block)
-    return super unless native.respond_to?(name)
-
-    native.public_send(name, *args, **options, &block)
-  end
-
-  def respond_to_missing?(name, include_private = false)
-    native.respond_to?(name) || super
-  end
-end