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.0.0.alpha6', '< 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.
92
93
94
95
96
97
98
99
100
101
|
# File 'lib/capybara/selenium/driver.rb', line 92
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.
57
58
59
|
# File 'lib/capybara/selenium/driver.rb', line 57
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
55
|
# File 'lib/capybara/selenium/driver.rb', line 22
def load_selenium
require 'selenium-webdriver'
require 'capybara/selenium/logger_suppressor'
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('>= 3.142.7').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
59
60
61
62
|
# File 'lib/capybara/selenium/driver.rb', line 59
def register_specialization(browser_name, specialization)
@specializations ||= {}
@specializations[browser_name] = specialization
end
|
Instance Method Details
#accept_modal(_type, **options) ⇒ Object
273
274
275
276
277
278
279
280
281
282
|
# File 'lib/capybara/selenium/driver.rb', line 273
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
151
152
153
|
# File 'lib/capybara/selenium/driver.rb', line 151
def active_element
build_node(native_active_element)
end
|
#browser ⇒ Object
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
|
# File 'lib/capybara/selenium/driver.rb', line 65
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.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
@browser = if options[:browser] == :firefox &&
RUBY_VERSION >= '3.0' &&
Capybara::Selenium::Driver.selenium_webdriver_version <= Gem::Version.new('4.0.0.alpha1')
Selenium::WebDriver::Firefox::Driver.new(**processed_options)
else
Selenium::WebDriver.for(options[:browser], processed_options)
end
specialize_driver
setup_exit_handler
end
@browser
end
|
#close_window(handle) ⇒ Object
244
245
246
247
248
249
250
|
# File 'lib/capybara/selenium/driver.rb', line 244
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
129
130
131
|
# File 'lib/capybara/selenium/driver.rb', line 129
def current_url
browser.current_url
end
|
#current_window_handle ⇒ Object
214
215
216
|
# File 'lib/capybara/selenium/driver.rb', line 214
def current_window_handle
browser.window_handle
end
|
#dismiss_modal(_type, **options) ⇒ Object
284
285
286
287
288
289
290
|
# File 'lib/capybara/selenium/driver.rb', line 284
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
145
146
147
148
149
|
# File 'lib/capybara/selenium/driver.rb', line 145
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
140
141
142
143
|
# File 'lib/capybara/selenium/driver.rb', line 140
def evaluate_script(script, *args)
result = execute_script("return #{script}", *args)
unwrap_script_result(result)
end
|
#execute_script(script, *args) ⇒ Object
136
137
138
|
# File 'lib/capybara/selenium/driver.rb', line 136
def execute_script(script, *args)
browser.execute_script(script, *native_args(args))
end
|
#frame_obscured_at?(x:, y:) ⇒ Boolean
187
188
189
190
191
192
193
194
195
196
197
|
# File 'lib/capybara/selenium/driver.rb', line 187
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
238
239
240
241
242
|
# File 'lib/capybara/selenium/driver.rb', line 238
def fullscreen_window(handle)
within_given_window(handle) do
browser.manage.window.full_screen
end
end
|
#go_back ⇒ Object
111
112
113
|
# File 'lib/capybara/selenium/driver.rb', line 111
def go_back
browser.navigate.back
end
|
#go_forward ⇒ Object
115
116
117
|
# File 'lib/capybara/selenium/driver.rb', line 115
def go_forward
browser.navigate.forward
end
|
#html ⇒ Object
119
120
121
122
123
|
# File 'lib/capybara/selenium/driver.rb', line 119
def html
browser.page_source
rescue Selenium::WebDriver::Error::JavascriptError => e
raise unless e.message.include?('documentElement is null')
end
|
#invalid_element_errors ⇒ Object
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
|
# File 'lib/capybara/selenium/driver.rb', line 306
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|
unless selenium_4?
::Selenium::WebDriver.logger.suppress_deprecations do
errors.push(
::Selenium::WebDriver::Error::UnhandledError,
::Selenium::WebDriver::Error::ElementNotVisibleError,
::Selenium::WebDriver::Error::InvalidElementStateError,
::Selenium::WebDriver::Error::ElementNotSelectableError
)
end
end
if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)
errors.push(::Selenium::WebDriver::Error::DetachedShadowRootError)
end
end
end
|
#maximize_window(handle) ⇒ Object
231
232
233
234
235
236
|
# File 'lib/capybara/selenium/driver.rb', line 231
def maximize_window(handle)
within_given_window(handle) do
browser.manage.window.maximize
end
sleep 0.1 end
|
#needs_server? ⇒ Boolean
134
|
# File 'lib/capybara/selenium/driver.rb', line 134
def needs_server?; true; end
|
#no_such_window_error ⇒ Object
332
333
334
|
# File 'lib/capybara/selenium/driver.rb', line 332
def no_such_window_error
Selenium::WebDriver::Error::NoSuchWindowError
end
|
#open_new_window(kind = :tab) ⇒ Object
256
257
258
259
260
261
262
263
264
265
266
267
|
# File 'lib/capybara/selenium/driver.rb', line 256
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
292
293
294
295
296
297
298
299
300
301
302
303
304
|
# File 'lib/capybara/selenium/driver.rb', line 292
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
107
108
109
|
# File 'lib/capybara/selenium/driver.rb', line 107
def refresh
browser.navigate.refresh
end
|
#reset! ⇒ Object
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# File 'lib/capybara/selenium/driver.rb', line 164
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
225
226
227
228
229
|
# File 'lib/capybara/selenium/driver.rb', line 225
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
160
161
162
|
# File 'lib/capybara/selenium/driver.rb', line 160
def save_screenshot(path, **_options)
browser.save_screenshot(path)
end
|
#send_keys(*args) ⇒ Object
155
156
157
158
|
# File 'lib/capybara/selenium/driver.rb', line 155
def send_keys(*args)
native_active_element.send_keys(*args)
end
|
#switch_to_frame(frame) ⇒ Object
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
# File 'lib/capybara/selenium/driver.rb', line 199
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
269
270
271
|
# File 'lib/capybara/selenium/driver.rb', line 269
def switch_to_window(handle)
browser.switch_to.window handle
end
|
#title ⇒ Object
125
126
127
|
# File 'lib/capybara/selenium/driver.rb', line 125
def title
browser.title
end
|
#visit(path) ⇒ Object
103
104
105
|
# File 'lib/capybara/selenium/driver.rb', line 103
def visit(path)
browser.navigate.to(path)
end
|
#wait? ⇒ Boolean
133
|
# File 'lib/capybara/selenium/driver.rb', line 133
def wait?; true; end
|
#window_handles ⇒ Object
252
253
254
|
# File 'lib/capybara/selenium/driver.rb', line 252
def window_handles
browser.window_handles
end
|
#window_size(handle) ⇒ Object
218
219
220
221
222
223
|
# File 'lib/capybara/selenium/driver.rb', line 218
def window_size(handle)
within_given_window(handle) do
size = browser.manage.window.size
[size.width, size.height]
end
end
|