Class: Selenium::WebDriver::Driver

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

Overview

The main class through which you control the browser.

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

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
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 71

def initialize(bridge: nil, listener: nil, **opts)
  @service = nil
  bridge ||= create_bridge(**opts)
  @bridge = listener ? Support::EventFiringBridge.new(bridge, listener) : bridge
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 'build/rb/lib/selenium/webdriver/common/driver.rb', line 44

def for(browser, opts = {})
  case browser
  when :chrome
    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
    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:



279
280
281
282
283
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 279

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

  find_element sel
end

#actionActionBuilder

Returns:

See Also:



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

def action
  bridge.action
end

#browserObject



285
286
287
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 285

def browser
  bridge&.browser
end

#capabilitiesObject



289
290
291
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 289

def capabilities
  bridge.capabilities
end

#closeObject

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



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

def close
  bridge.close
end

#current_urlString

Get the URL of the current page

Returns:

  • (String)


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

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:



243
244
245
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 243

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

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

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.



224
225
226
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 224

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

#get(url) ⇒ Object

Opens the specified URL in the browser.



139
140
141
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 139

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

#inspectObject



77
78
79
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 77

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

#keyboardObject



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

def keyboard
  bridge.keyboard
end

#manageManager

Returns:

See Also:



114
115
116
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 114

def manage
  bridge.manage
end

#mouseObject



127
128
129
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 127

def mouse
  bridge.mouse
end

Returns:

See Also:



96
97
98
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 96

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

#page_sourceString

Get the source of the current page

Returns:

  • (String)


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

def page_source
  bridge.page_source
end

#quitObject

Quit the browser



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

def quit
  bridge.quit
ensure
  @service&.stop
end

#refObject

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:



298
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 298

def ref; end

#statusHash

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)


87
88
89
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 87

def status
  @bridge.status
end

#switch_toTargetLocator

Returns:

See Also:



105
106
107
# File 'build/rb/lib/selenium/webdriver/common/driver.rb', line 105

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

#titleString

Get the title of the current page

Returns:

  • (String)


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

def title
  bridge.title
end

#window_handleString

Get the current window handle

Returns:

  • (String)


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

def window_handle
  bridge.window_handle
end

#window_handlesArray

Get the window handles of open browser windows.

Returns:

  • (Array)

See Also:



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

def window_handles
  bridge.window_handles
end