Class: Selenium::WebDriver::Driver

Inherits:
Object
  • Object
show all
Includes:
SearchContext
Defined in:
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 SearchContext

#find_element, #find_elements

Constructor Details

#initialize(bridge) ⇒ 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.



84
85
86
87
88
89
90
91
 
# File 'lib/selenium/webdriver/common/driver.rb', line 84

def initialize(bridge)
  @bridge = bridge

  # TODO: refactor this away
  unless bridge.driver_extensions.empty?
    extend(*bridge.driver_extensions)
  end
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:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/selenium/webdriver/common/driver.rb', line 45

def for(browser, opts = {})
  listener = opts.delete(:listener)

  bridge = case browser
           when :firefox, :ff
             Firefox::Bridge.new(opts)
           when :remote
             Remote::Bridge.new(opts)
           when :ie, :internet_explorer
             IE::Bridge.new(opts)
           when :chrome
             Chrome::Bridge.new(opts)
           when :edge
             Edge::Bridge.new(opts)
           when :android
             Android::Bridge.new(opts)
           when :iphone
             IPhone::Bridge.new(opts)
           when :phantomjs
             PhantomJS::Bridge.new(opts)
           when :safari
             Safari::Bridge.new(opts)
           else
             raise ArgumentError, "unknown driver: #{browser.inspect}"
           end

  bridge = Support::EventFiringBridge.new(bridge, listener) if listener

  new(bridge)
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:

  • id (String, Hash) —

    or selector

Returns:



267
268
269
270
271
272
273
 
# File 'lib/selenium/webdriver/common/driver.rb', line 267

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

  find_element sel
end

#browser ⇒ Object 



275
276
277
 
# File 'lib/selenium/webdriver/common/driver.rb', line 275

def browser
  bridge.browser
end

#capabilities ⇒ Object 



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

def capabilities
  bridge.capabilities
end

#close ⇒ Object

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



174
175
176
 
# File 'lib/selenium/webdriver/common/driver.rb', line 174

def close
  bridge.close
end

#current_url ⇒ String

Get the URL of the current page

Returns:



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

def current_url
  bridge.getCurrentUrl
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:



230
231
232
 
# File 'lib/selenium/webdriver/common/driver.rb', line 230

def execute_async_script(script, *args)
  bridge.executeAsyncScript(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:



211
212
213
 
# File 'lib/selenium/webdriver/common/driver.rb', line 211

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

#get(url) ⇒ Object

Opens the specified URL in the browser.



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

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

#inspect ⇒ Object 



93
94
95
 
# File 'lib/selenium/webdriver/common/driver.rb', line 93

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

#manage ⇒ Options

Returns:

See Also:



120
121
122
 
# File 'lib/selenium/webdriver/common/driver.rb', line 120

def manage
  @manage ||= WebDriver::Options.new(bridge)
end

#navigate ⇒ Navigation

Returns:

See Also:



102
103
104
 
# File 'lib/selenium/webdriver/common/driver.rb', line 102

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

#page_source ⇒ String

Get the source of the current page

Returns:



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

def page_source
  bridge.getPageSource
end

#quit ⇒ Object

Quit the browser



166
167
168
 
# File 'lib/selenium/webdriver/common/driver.rb', line 166

def quit
  bridge.quit
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:



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

def ref
  nil
end

#switch_to ⇒ TargetLocator

Returns:

See Also:



111
112
113
 
# File 'lib/selenium/webdriver/common/driver.rb', line 111

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

#title ⇒ String

Get the title of the current page

Returns:



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

def title
  bridge.getTitle
end

#window_handle ⇒ String

Get the current window handle

Returns:



195
196
197
 
# File 'lib/selenium/webdriver/common/driver.rb', line 195

def window_handle
  bridge.getCurrentWindowHandle
end

#window_handles ⇒ Array

Get the window handles of open browser windows.

Returns:

  • (Array)

See Also:



185
186
187
 
# File 'lib/selenium/webdriver/common/driver.rb', line 185

def window_handles
  bridge.getWindowHandles
end