Module: Capybara::SpecHelper

Defined in:
lib/capybara/spec/spec_helper.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.configure(config) ⇒ Object


15
16
17
18
19
20
# 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. = :apply_to_host_groups
end

.filter(requires, metadata) ⇒ Object


43
44
45
46
47
48
49
50
51
# File 'lib/capybara/spec/spec_helper.rb', line 43

def filter(requires, )
  if requires && [:capybara_skip]
    requires.any? do |require|
      [:capybara_skip].include?(require)
    end
  else
    false
  end
end

.reset!Object


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# 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) ⇒ Object


94
95
96
97
98
99
# 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) ⇒ Object


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# 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) ⇒ Object


53
54
55
56
# File 'lib/capybara/spec/spec_helper.rb', line 53

def spec(name, *options, &block)
  @specs ||= []
  @specs << [name, options, block]
end

Instance Method Details

#be_an_invalid_element_error(session) ⇒ Object


125
126
127
# 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) ⇒ Object


119
120
121
122
123
# 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

#quietlyObject


111
112
113
114
115
116
117
# 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) ⇒ Object


102
103
104
105
106
107
108
109
# 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) ⇒ Object


129
130
131
# 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