Class: Capybara::Selenium::Driver
Defined Under Namespace
Modules: ChromeDriver, EdgeDriver, FirefoxDriver, InternetExplorerDriver, SafariDriver, W3CFirefoxDriver
Constant Summary
collapse
- DEFAULT_OPTIONS =
{
browser: :firefox,
clear_local_storage: nil,
clear_session_storage: nil
}.freeze
- SPECIAL_OPTIONS =
%i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze
- CAPS_VERSION =
Gem::Requirement.new('< 4.8.0')
Class Attribute Summary collapse
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
-
#accept_modal(_type, **options) ⇒ Object
-
#active_element ⇒ Object
-
#browser ⇒ Object
-
#close_window(handle) ⇒ Object
-
#current_url ⇒ Object
-
#current_window_handle ⇒ Object
-
#dismiss_modal(_type, **options) ⇒ Object
-
#evaluate_async_script(script, *args) ⇒ Object
-
#evaluate_script(script, *args) ⇒ Object
-
#execute_script(script, *args) ⇒ Object
-
#frame_obscured_at?(x:, y:) ⇒ Boolean
-
#fullscreen_window(handle) ⇒ Object
-
#go_back ⇒ Object
-
#go_forward ⇒ Object
-
#html ⇒ Object
-
#initialize(app, **options) ⇒ Driver
constructor
A new instance of Driver.
-
#invalid_element_errors ⇒ Object
-
#maximize_window(handle) ⇒ Object
-
#needs_server? ⇒ Boolean
-
#no_such_window_error ⇒ Object
-
#open_new_window(kind = :tab) ⇒ Object
-
#quit ⇒ Object
-
#refresh ⇒ Object
-
#reset! ⇒ Object
-
#resize_window_to(handle, width, height) ⇒ Object
-
#save_screenshot(path, **_options) ⇒ Object
-
#send_keys(*args) ⇒ Object
-
#switch_to_frame(frame) ⇒ Object
-
#switch_to_window(handle) ⇒ Object
-
#title ⇒ Object
-
#visit(path) ⇒ Object
-
#wait? ⇒ Boolean
-
#window_handles ⇒ Object
-
#window_size(handle) ⇒ Object
Methods included from Find
#find_css, #find_xpath
#find_css, #find_xpath, #frame_title, #frame_url, #response_headers, #session_options, #status_code
Constructor Details
#initialize(app, **options) ⇒ Driver
Returns a new instance of Driver.
84
85
86
87
88
89
90
91
92
93
|
# File 'lib/capybara/selenium/driver.rb', line 84
def initialize(app, **options)
super()
self.class.load_selenium
@app = app
@browser = nil
@exit_status = nil
@frame_handles = Hash.new { |hash, handle| hash[handle] = [] }
@options = DEFAULT_OPTIONS.merge(options)
@node_class = ::Capybara::Selenium::Node
end
|
Class Attribute Details
.selenium_webdriver_version ⇒ Object
Returns the value of attribute selenium_webdriver_version.
20
21
22
|
# File 'lib/capybara/selenium/driver.rb', line 20
def selenium_webdriver_version
@selenium_webdriver_version
end
|
.specializations ⇒ Object
Returns the value of attribute specializations.
56
57
58
|
# File 'lib/capybara/selenium/driver.rb', line 56
def specializations
@specializations
end
|
Instance Attribute Details
#app ⇒ Object
Returns the value of attribute app.
17
18
19
|
# File 'lib/capybara/selenium/driver.rb', line 17
def app
@app
end
|
#options ⇒ Object
Returns the value of attribute options.
17
18
19
|
# File 'lib/capybara/selenium/driver.rb', line 17
def options
@options
end
|
Class Method Details
.load_selenium ⇒ Object
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# File 'lib/capybara/selenium/driver.rb', line 22
def load_selenium
require 'selenium-webdriver'
require 'capybara/selenium/patches/atoms'
require 'capybara/selenium/patches/is_displayed'
require 'capybara/selenium/patches/action_pauser'
@selenium_webdriver_version =
if Gem.loaded_specs['selenium-webdriver']
Gem.loaded_specs['selenium-webdriver'].version
else
Gem::Version.new(Selenium::WebDriver::VERSION)
end
unless Gem::Requirement.new('>= 4.1').satisfied_by? @selenium_webdriver_version
warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade."
end
@selenium_webdriver_version
rescue LoadError => e
raise e unless e.message.include?('selenium-webdriver')
raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
end
|
.register_specialization(browser_name, specialization) ⇒ Object
58
59
60
61
|
# File 'lib/capybara/selenium/driver.rb', line 58
def register_specialization(browser_name, specialization)
@specializations ||= {}
@specializations[browser_name] = specialization
end
|
Instance Method Details
#accept_modal(_type, **options) ⇒ Object
265
266
267
268
269
270
271
272
273
274
|
# File 'lib/capybara/selenium/driver.rb', line 265
def accept_modal(_type, **options)
yield if block_given?
modal = find_modal(**options)
modal.send_keys options[:with] if options[:with]
message = modal.text
modal.accept
message
end
|
#active_element ⇒ Object
143
144
145
|
# File 'lib/capybara/selenium/driver.rb', line 143
def active_element
build_node(native_active_element)
end
|
#browser ⇒ Object
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
# File 'lib/capybara/selenium/driver.rb', line 64
def browser
unless @browser
options[:http_client] ||= begin
require 'capybara/selenium/patches/persistent_client'
if options[:timeout]
::Capybara::Selenium::PersistentClient.new(read_timeout: options[:timeout])
else
::Capybara::Selenium::PersistentClient.new
end
end
processed_options = options.except(*SPECIAL_OPTIONS)
@browser = Selenium::WebDriver.for(options[:browser], processed_options)
specialize_driver
setup_exit_handler
end
@browser
end
|
#close_window(handle) ⇒ Object
236
237
238
239
240
241
242
|
# File 'lib/capybara/selenium/driver.rb', line 236
def close_window(handle)
raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first
within_given_window(handle) do
browser.close
end
end
|
#current_url ⇒ Object
121
122
123
|
# File 'lib/capybara/selenium/driver.rb', line 121
def current_url
browser.current_url
end
|
#current_window_handle ⇒ Object
206
207
208
|
# File 'lib/capybara/selenium/driver.rb', line 206
def current_window_handle
browser.window_handle
end
|
#dismiss_modal(_type, **options) ⇒ Object
276
277
278
279
280
281
282
|
# File 'lib/capybara/selenium/driver.rb', line 276
def dismiss_modal(_type, **options)
yield if block_given?
modal = find_modal(**options)
message = modal.text
modal.dismiss
message
end
|
#evaluate_async_script(script, *args) ⇒ Object
137
138
139
140
141
|
# File 'lib/capybara/selenium/driver.rb', line 137
def evaluate_async_script(script, *args)
browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time
result = browser.execute_async_script(script, *native_args(args))
unwrap_script_result(result)
end
|
#evaluate_script(script, *args) ⇒ Object
132
133
134
135
|
# File 'lib/capybara/selenium/driver.rb', line 132
def evaluate_script(script, *args)
result = execute_script("return #{script}", *args)
unwrap_script_result(result)
end
|
#execute_script(script, *args) ⇒ Object
128
129
130
|
# File 'lib/capybara/selenium/driver.rb', line 128
def execute_script(script, *args)
browser.execute_script(script, *native_args(args))
end
|
#frame_obscured_at?(x:, y:) ⇒ Boolean
179
180
181
182
183
184
185
186
187
188
189
|
# File 'lib/capybara/selenium/driver.rb', line 179
def frame_obscured_at?(x:, y:)
frame = @frame_handles[current_window_handle].last
return false unless frame
switch_to_frame(:parent)
begin
frame.base.obscured?(x: x, y: y)
ensure
switch_to_frame(frame)
end
end
|
#fullscreen_window(handle) ⇒ Object
230
231
232
233
234
|
# File 'lib/capybara/selenium/driver.rb', line 230
def fullscreen_window(handle)
within_given_window(handle) do
browser.manage.window.full_screen
end
end
|
#go_back ⇒ Object
103
104
105
|
# File 'lib/capybara/selenium/driver.rb', line 103
def go_back
browser.navigate.back
end
|
#go_forward ⇒ Object
107
108
109
|
# File 'lib/capybara/selenium/driver.rb', line 107
def go_forward
browser.navigate.forward
end
|
#html ⇒ Object
111
112
113
114
115
|
# File 'lib/capybara/selenium/driver.rb', line 111
def html
browser.page_source
rescue Selenium::WebDriver::Error::JavascriptError => e
raise unless e.message.include?('documentElement is null')
end
|
#invalid_element_errors ⇒ Object
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
# File 'lib/capybara/selenium/driver.rb', line 298
def invalid_element_errors
@invalid_element_errors ||=
[
::Selenium::WebDriver::Error::StaleElementReferenceError,
::Selenium::WebDriver::Error::ElementNotInteractableError,
::Selenium::WebDriver::Error::InvalidSelectorError, ::Selenium::WebDriver::Error::ElementClickInterceptedError,
::Selenium::WebDriver::Error::NoSuchElementError, ::Selenium::WebDriver::Error::InvalidArgumentError ].tap do |errors|
if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)
errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)
end
end
end
|
#maximize_window(handle) ⇒ Object
223
224
225
226
227
228
|
# File 'lib/capybara/selenium/driver.rb', line 223
def maximize_window(handle)
within_given_window(handle) do
browser.manage.window.maximize
end
sleep 0.1 end
|
#needs_server? ⇒ Boolean
126
|
# File 'lib/capybara/selenium/driver.rb', line 126
def needs_server?; true; end
|
#no_such_window_error ⇒ Object
314
315
316
|
# File 'lib/capybara/selenium/driver.rb', line 314
def no_such_window_error
Selenium::WebDriver::Error::NoSuchWindowError
end
|
#open_new_window(kind = :tab) ⇒ Object
248
249
250
251
252
253
254
255
256
257
258
259
|
# File 'lib/capybara/selenium/driver.rb', line 248
def open_new_window(kind = :tab)
if browser.switch_to.respond_to?(:new_window)
handle = current_window_handle
browser.switch_to.new_window(kind)
switch_to_window(handle)
else
browser.manage.new_window(kind)
end
rescue NoMethodError, Selenium::WebDriver::Error::WebDriverError
browser.execute_script('window.open();')
end
|
#quit ⇒ Object
284
285
286
287
288
289
290
291
292
293
294
295
296
|
# File 'lib/capybara/selenium/driver.rb', line 284
def quit
@browser&.quit
rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,
Selenium::WebDriver::Error::InvalidSessionIdError
rescue Selenium::WebDriver::Error::UnknownError => e
unless silenced_unknown_error_message?(e.message) warn "Ignoring Selenium UnknownError during driver quit: #{e.message}"
end
ensure
@browser = nil
end
|
#refresh ⇒ Object
99
100
101
|
# File 'lib/capybara/selenium/driver.rb', line 99
def refresh
browser.navigate.refresh
end
|
#reset! ⇒ Object
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
# File 'lib/capybara/selenium/driver.rb', line 156
def reset!
return unless @browser
navigated = false
timer = Capybara::Helpers.timer(expire_in: 10)
begin
reset_browser_state unless navigated
navigated = true
wait_for_empty_page(timer)
rescue *unhandled_alert_errors
accept_unhandled_reset_alert
retry
end
end
|
#resize_window_to(handle, width, height) ⇒ Object
217
218
219
220
221
|
# File 'lib/capybara/selenium/driver.rb', line 217
def resize_window_to(handle, width, height)
within_given_window(handle) do
browser.manage.window.resize_to(width, height)
end
end
|
#save_screenshot(path, **_options) ⇒ Object
152
153
154
|
# File 'lib/capybara/selenium/driver.rb', line 152
def save_screenshot(path, **_options)
browser.save_screenshot(path)
end
|
#send_keys(*args) ⇒ Object
147
148
149
150
|
# File 'lib/capybara/selenium/driver.rb', line 147
def send_keys(*args)
native_active_element.send_keys(*args)
end
|
#switch_to_frame(frame) ⇒ Object
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
# File 'lib/capybara/selenium/driver.rb', line 191
def switch_to_frame(frame)
handles = @frame_handles[current_window_handle]
case frame
when :top
handles.clear
browser.switch_to.default_content
when :parent
handles.pop
browser.switch_to.parent_frame
else
handles << frame
browser.switch_to.frame(frame.native)
end
end
|
#switch_to_window(handle) ⇒ Object
261
262
263
|
# File 'lib/capybara/selenium/driver.rb', line 261
def switch_to_window(handle)
browser.switch_to.window handle
end
|
#title ⇒ Object
117
118
119
|
# File 'lib/capybara/selenium/driver.rb', line 117
def title
browser.title
end
|
#visit(path) ⇒ Object
95
96
97
|
# File 'lib/capybara/selenium/driver.rb', line 95
def visit(path)
browser.navigate.to(path)
end
|
#wait? ⇒ Boolean
125
|
# File 'lib/capybara/selenium/driver.rb', line 125
def wait?; true; end
|
#window_handles ⇒ Object
244
245
246
|
# File 'lib/capybara/selenium/driver.rb', line 244
def window_handles
browser.window_handles
end
|
#window_size(handle) ⇒ Object
210
211
212
213
214
215
|
# File 'lib/capybara/selenium/driver.rb', line 210
def window_size(handle)
within_given_window(handle) do
size = browser.manage.window.size
[size.width, size.height]
end
end
|