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.



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

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.

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
 
# 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 :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>



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

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

  find_element sel
end

#browser ⇒ Object 



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

def browser
  bridge.browser
end

#capabilities ⇒ Object 



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

def capabilities
  bridge.capabilities
end

#close ⇒ Object

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



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

def close
  bridge.close
end

#current_url ⇒ String

Get the URL of the current page



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

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.



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

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



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

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

#get(url) ⇒ Object

Opens the specified URL in the browser.



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

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

#inspect ⇒ Object 



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

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

#manage ⇒ Options

See Also:



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

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

#navigate ⇒ Navigation

See Also:



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

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

#page_source ⇒ String

Get the source of the current page



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

def page_source
  bridge.getPageSource
end

#quit ⇒ Object

Quit the browser



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

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:



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

def ref
  nil
end

#switch_to ⇒ TargetLocator

See Also:



109
110
111
 
# File 'lib/selenium/webdriver/common/driver.rb', line 109

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

#title ⇒ String

Get the title of the current page



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

def title
  bridge.getTitle
end

#window_handle ⇒ String

Get the current window handle



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

def window_handle
  bridge.getCurrentWindowHandle
end

#window_handles ⇒ Array

Get the window handles of open browser windows.

See Also:



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

def window_handles
  bridge.getWindowHandles
end