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
21
 
# 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! }
  # Test in 3.5+ where metadata doesn't autotrigger shared context inclusion - will be only behavior in RSpec 4
  config.shared_context_metadata_behavior = :apply_to_host_groups if config.respond_to?(:shared_context_metadata_behavior=)
end

.filter(requires, metadata) ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/capybara/spec/spec_helper.rb', line 40

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

.reset! ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/capybara/spec/spec_helper.rb', line 23

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
  reset_threadsafe
end

.reset_threadsafe(bool = false, session = nil) ⇒ Object 



91
92
93
94
95
96
 
# File 'lib/capybara/spec/spec_helper.rb', line 91

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 



55
56
57
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
 
# File 'lib/capybara/spec/spec_helper.rb', line 55

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 



50
51
52
53
 
# File 'lib/capybara/spec/spec_helper.rb', line 50

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

Instance Method Details

#chrome?(session) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/capybara/spec/spec_helper.rb', line 133

def chrome?(session)
  session.respond_to?(:driver) && session.driver.respond_to?(:chrome?, true) && session.driver.send(:chrome?)
end

#chrome_gte?(version, session) ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/capybara/spec/spec_helper.rb', line 141

def chrome_gte?(version, session)
  chrome?(session) && (session.driver.browser.capabilities[:version].to_f >= version)
end

#chrome_lt?(version, session) ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/capybara/spec/spec_helper.rb', line 137

def chrome_lt?(version, session)
  chrome?(session) && (session.driver.browser.capabilities[:version].to_f < version)
end

#edge?(session) ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/capybara/spec/spec_helper.rb', line 145

def edge?(session)
  session.respond_to?(:driver) && session.driver.respond_to?(:edge?, true) && session.driver.send(:edge?)
end

#extract_results(session) ⇒ Object 



116
117
118
119
 
# File 'lib/capybara/spec/spec_helper.rb', line 116

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
end

#ie?(session) ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/capybara/spec/spec_helper.rb', line 149

def ie?(session)
  session.respond_to?(:driver) && session.driver.respond_to?(:ie?, true) && session.driver.send(:ie?)
end

#marionette?(session) ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/capybara/spec/spec_helper.rb', line 121

def marionette?(session)
  session.respond_to?(:driver) && session.driver.respond_to?(:marionette?, true) && session.driver.send(:marionette?)
end

#marionette_gte?(version, session) ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/capybara/spec/spec_helper.rb', line 129

def marionette_gte?(version, session)
  marionette?(session) && (session.driver.browser.capabilities[:browser_version].to_f >= version)
end

#marionette_lt?(version, session) ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/capybara/spec/spec_helper.rb', line 125

def marionette_lt?(version, session)
  marionette?(session) && (session.driver.browser.capabilities[:browser_version].to_f < version)
end

#quietly ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/capybara/spec/spec_helper.rb', line 108

def quietly
  silence_stream(STDOUT) do
    silence_stream(STDERR) do
      yield
    end
  end
end

#silence_stream(stream) ⇒ Object 



99
100
101
102
103
104
105
106
 
# File 'lib/capybara/spec/spec_helper.rb', line 99

def silence_stream(stream)
  old_stream = stream.dup
  stream.reopen(RbConfig::CONFIG['host_os'] =~ /rmswin|mingw/ ? 'NUL:' : '/dev/null')
  stream.sync = true
  yield
ensure
  stream.reopen(old_stream)
end