module Capybara::SpecHelper

Public Class Methods

configure(config) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 15
def configure(config)
  config.filter_run_excluding requires: method(:filter).to_proc
  config.before { Capybara::SpecHelper.reset! }
  config.after { Capybara::SpecHelper.reset! }
  config.shared_context_metadata_behavior = :apply_to_host_groups
end
filter(requires, metadata) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 43
def filter(requires, metadata)
  if requires && metadata[:capybara_skip]
    requires.any? do |require|
      metadata[:capybara_skip].include?(require)
    end
  else
    false
  end
end
reset!() click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 22
def reset!
  Capybara.app = TestApp
  Capybara.app_host = nil
  Capybara.default_selector = :xpath
  Capybara.default_max_wait_time = 1
  Capybara.ignore_hidden_elements = true
  Capybara.exact = false
  Capybara.raise_server_errors = true
  Capybara.visible_text_only = false
  Capybara.match = :smart
  Capybara.enable_aria_label = false
  Capybara.default_set_options = {}
  Capybara.disable_animation = false
  Capybara.test_id = nil
  Capybara.predicates_wait = true
  Capybara.default_normalize_ws = false
  Capybara.allow_gumbo = true
  Capybara.w3c_click_offset = false
  reset_threadsafe
end
reset_threadsafe(bool = false, session = nil) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 94
def reset_threadsafe(bool = false, session = nil)
  Capybara::Session.class_variable_set(:@@instance_created, false) # Work around limit on when threadsafe can be changed
  Capybara.threadsafe = bool
  session = session.current_session if session.respond_to?(:current_session)
  session&.instance_variable_set(:@config, nil)
end
run_specs(session, name, **options, &filter_block) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 58
def run_specs(session, name, **options, &filter_block)
  specs = @specs
  RSpec.describe Capybara::Session, name, options do # rubocop:disable RSpec/EmptyExampleGroup
    include Capybara::SpecHelper
    include Capybara::RSpecMatchers
    # rubocop:disable RSpec/ScatteredSetup
    before do |example|
      @session = session
      instance_exec(example, &filter_block) if filter_block
    end

    after do
      session.reset_session!
    end

    before :each, psc: true do
      SpecHelper.reset_threadsafe(true, session)
    end

    after psc: true do
      SpecHelper.reset_threadsafe(false, session)
    end

    before :each, :exact_false do
      Capybara.exact = false
    end
    # rubocop:enable RSpec/ScatteredSetup

    specs.each do |spec_name, spec_options, block|
      describe spec_name, *spec_options do # rubocop:disable RSpec/EmptyExampleGroup
        class_eval(&block)
      end
    end
  end
end
spec(name, *options, &block) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 53
def spec(name, *options, &block)
  @specs ||= []
  @specs << [name, options, block]
end

Public Instance Methods

be_an_invalid_element_error(session) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 125
def be_an_invalid_element_error(session)
  satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
end
extract_results(session) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 119
def extract_results(session)
  expect(session).to have_xpath("//pre[@id='results']")
  # YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
  YAML.load Capybara::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
end
quietly() { || ... } click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 111
def quietly
  silence_stream(STDOUT) do
    silence_stream(STDERR) do
      yield
    end
  end
end
silence_stream(stream) { || ... } click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 102
def silence_stream(stream)
  old_stream = stream.dup
  stream.reopen(RbConfig::CONFIG['host_os'].match?(/rmswin|mingw/) ? 'NUL:' : '/dev/null')
  stream.sync = true
  yield
ensure
  stream.reopen(old_stream)
end
with_os_path_separators(path) click to toggle source
# File lib/capybara/spec/spec_helper.rb, line 129
def with_os_path_separators(path)
  Gem.win_platform? ? path.to_s.tr('/', '\\') : path.to_s
end