Class: Selenium::WebDriver::Driver

Inherits:
Object
  • Object
show all
Includes:
SearchContext, TakesScreenshot
Defined in:
rb/lib/selenium/webdriver/common/driver.rb

Overview

The main class through which you control the browser.

See Also:

Constant Summary

Constants included from SearchContext

SearchContext::FINDERS

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TakesScreenshot

#save_screenshot, #screenshot_as

Methods included from SearchContext

#find_element, #find_elements, finders

Constructor Details

#initialize(bridge: nil, listener: nil, **opts) ⇒ Driver

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A new Driver instance with the given bridge. End users should use Selenium::WebDriver.for instead of using this directly.



71
72
73
74
75
76
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 71

def initialize(bridge: nil, listener: nil, **opts)
  @devtools = nil
  bridge ||= create_bridge(**opts)
  @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
  add_extensions(@bridge.browser)
end

Class Method Details

.for(browser, opts = {}) ⇒ Driver

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

See Also:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 44

def for(browser, opts = {})
  case browser
  when :chrome, :chrome_headless_shell
    Chrome::Driver.new(**opts)
  when :internet_explorer, :ie
    IE::Driver.new(**opts)
  when :safari
    Safari::Driver.new(**opts)
  when :firefox, :ff
    Firefox::Driver.new(**opts)
  when :edge, :microsoftedge, :msedge
    Edge::Driver.new(**opts)
  when :remote
    Remote::Driver.new(**opts)
  else
    raise ArgumentError, "unknown driver: #{browser.inspect}"
  end
end

Instance Method Details

#[](sel) ⇒ WebDriver::Element

Get the first element matching the given selector. If given a String or Symbol, it will be used as the id of the element.

Examples:

driver['someElementId']    #=> #<WebDriver::Element:0x1011c3b88>
driver[:tag_name => 'div'] #=> #<WebDriver::Element:0x1011c3b88>

Parameters:

  • sel (String, Hash) —

    id or selector

Returns:



293
294
295
296
297
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 293

def [](sel)
  sel = {id: sel} if sel.is_a?(String) || sel.is_a?(Symbol)

  find_element sel
end

#action(**opts) ⇒ ActionBuilder

Returns:

See Also:



141
142
143
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 141

def action(**opts)
  bridge.action(**opts)
end

#add_virtual_authenticator(options) ⇒ VirtualAuthenticator

Returns:

See Also:



263
264
265
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 263

def add_virtual_authenticator(options)
  bridge.add_virtual_authenticator(options)
end

#browser ⇒ Object 



299
300
301
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 299

def browser
  bridge.browser
end

#capabilities ⇒ Object 



303
304
305
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 303

def capabilities
  bridge.capabilities
end

#close ⇒ Object

Close the current window, or the browser if no windows are left.



198
199
200
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 198

def close
  bridge&.close
end

#current_url ⇒ String

Get the URL of the current page

Returns:

  • (String) 


159
160
161
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 159

def current_url
  bridge.url
end

#execute_async_script(script, *args) ⇒ WebDriver::Element, ...

Execute an asynchronous piece of JavaScript in the context of the currently selected frame or window. Unlike executing execute_script (synchronous JavaScript), scripts executed with this method must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.

Parameters:

  • script (String) —

    JavaScript source to execute

  • args (WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array) —

    Arguments to the script. May be empty.

Returns:



254
255
256
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 254

def execute_async_script(script, *args)
  bridge.execute_async_script(script, *args)
end

#execute_script(script, *args) ⇒ WebDriver::Element, ...

Execute the given JavaScript

Parameters:

  • script (String) —

    JavaScript source to execute

  • args (WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array) —

    Arguments will be available in the given script in the ‘arguments’ pseudo-array.

Returns:

  • (WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array) —

    The value returned from the script.



235
236
237
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 235

def execute_script(script, *args)
  bridge.execute_script(script, *args)
end

#get(url) ⇒ Object

Opens the specified URL in the browser.



149
150
151
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 149

def get(url)
  navigate.to(url)
end

#inspect ⇒ Object 



78
79
80
81
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 78

def inspect
  format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2,
                                                        browser: bridge.browser.inspect
end

#manage ⇒ Manager

Returns:

See Also:



132
133
134
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 132

def manage
  bridge.manage
end

#navigate ⇒ Navigation

Returns:

See Also:



98
99
100
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 98

def navigate
  @navigate ||= WebDriver::Navigation.new(bridge)
end

#page_source ⇒ String

Get the source of the current page

Returns:

  • (String) 


179
180
181
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 179

def page_source
  bridge.page_source
end

#quit ⇒ Object

Quit the browser



187
188
189
190
191
192
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 187

def quit
  bridge.quit
ensure
  @service_manager&.stop
  @devtools&.close
end

#ref ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:



312
313
314
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 312

def ref
  [:driver, nil]
end

#script(*args) ⇒ Script

Returns:

See Also:



107
108
109
110
111
112
113
114
115
116
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 107

def script(*args)
  if args.any?
    WebDriver.logger.deprecate('`Driver#script` as an alias for `#execute_script`',
                               '`Driver#execute_script`',
                               id: :driver_script)
    execute_script(*args)
  else
    @script ||= WebDriver::Script.new(bridge)
  end
end

#status ⇒ Hash

information about whether a remote end is in a state in which it can create new sessions, and may include additional meta information.

Returns:

  • (Hash) 


89
90
91
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 89

def status
  @bridge.status
end

#switch_to ⇒ TargetLocator

Returns:

See Also:



123
124
125
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 123

def switch_to
  @switch_to ||= WebDriver::TargetLocator.new(bridge)
end

#title ⇒ String

Get the title of the current page

Returns:

  • (String) 


169
170
171
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 169

def title
  bridge.title
end

#window_handle ⇒ String

Get the current window handle

Returns:

  • (String) 


219
220
221
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 219

def window_handle
  bridge.window_handle
end

#window_handles ⇒ Array

Get the window handles of open browser windows.

Returns:

  • (Array)

See Also:



209
210
211
 
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 209

def window_handles
  bridge.window_handles
end