Class: Selenium::WebDriver::Driver

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

Overview

The main class through which you control the browser.

See Also:

Constant Summary

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

- (Driver) initialize(bridge)

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.



63
64
65
66
67
68
69
70
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 63

def initialize(bridge)
  @bridge = bridge

  # TODO: refactor this away
  unless bridge.driver_extensions.empty?
    extend(*bridge.driver_extensions)
  end
end

Class Method Details

+ (Driver) for(browser, opts = {})

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:



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

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 :android
             Android::Bridge.new(opts)
           when :iphone
             IPhone::Bridge.new(opts)
           when :opera
             Opera::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

- (WebDriver::Element) [](sel)

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:



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

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

  find_element sel
end

- (Object) browser



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

def browser
  bridge.browser
end

- (Object) capabilities



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

def capabilities
  bridge.capabilities
end

- (Object) close

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



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

def close
  bridge.close
end

- (String) current_url

Get the URL of the current page

Returns:



117
118
119
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 117

def current_url
  bridge.getCurrentUrl
end

- (WebDriver::Element, ...) execute_async_script(script, *args)

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:



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

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

- (WebDriver::Element, ...) execute_script(script, *args) 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:



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

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

- (Object) get(url)

Opens the specified URL in the browser.



107
108
109
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 107

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

- (Object) inspect



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

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

- (Options) manage

Returns:

See Also:



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

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

Returns:

See Also:



81
82
83
# File 'rb/lib/selenium/webdriver/common/driver.rb', line 81

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

- (String) page_source

Get the source of the current page

Returns:



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

def page_source
  bridge.getPageSource
end

- (Object) quit

Quit the browser



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

def quit
  bridge.quit
end

- (Object) ref

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:



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

def ref
  nil
end

- (TargetLocator) switch_to

Returns:

See Also:



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

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

- (String) title

Get the title of the current page

Returns:



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

def title
  bridge.getTitle
end

- (Object) visible=(bool)

Set the visibility of the browser. Not applicable for all browsers.

Parameters:

  • (Boolean)


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

def visible=(bool)
  bridge.setBrowserVisible bool
end

- (Boolean) visible?

Get the visibility of the browser. Not applicable for all browsers.

Returns:

  • (Boolean)


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

def visible?
  bridge.getBrowserVisible
end

- (String) window_handle

Get the current window handle

Returns:



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

def window_handle
  bridge.getCurrentWindowHandle
end

- (Array) window_handles

Get the window handles of open browser windows.

Returns:

  • (Array)

See Also:



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

def window_handles
  bridge.getWindowHandles
end