class Selenium::WebDriver::Driver

The main class through which you control the browser.

@see SearchContext @see Navigation @see TargetLocator @see Options

Attributes

bridge[R]

Public Class Methods

for(browser, opts = {}) click to toggle source

@api private

@see Selenium::WebDriver.for

@return [Driver]

# File lib/selenium/webdriver/common/driver.rb, line 42
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 :phantomjs
    PhantomJS::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
new(bridge, listener: nil) click to toggle source

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

@api private

# File lib/selenium/webdriver/common/driver.rb, line 71
def initialize(bridge, listener: nil)
  @bridge = bridge
  @bridge = Support::EventFiringBridge.new(bridge, listener) if listener
end

Public Instance Methods

[](sel) click to toggle source

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

@param [String,Hash] sel id or selector @return [WebDriver::Element]

Examples:

driver['someElementId']    #=> #<WebDriver::Element:0x1011c3b88>
driver[:tag_name => 'div'] #=> #<WebDriver::Element:0x1011c3b88>
# File lib/selenium/webdriver/common/driver.rb, line 266
def [](sel)
  sel = {id: sel} if sel.is_a?(String) || sel.is_a?(Symbol)

  find_element sel
end
action() click to toggle source

@return [ActionBuilder, W3CActionBuilder] @see ActionBuilder, W3CActionBuilder

# File lib/selenium/webdriver/common/driver.rb, line 112
def action
  bridge.action
end
browser() click to toggle source
# File lib/selenium/webdriver/common/driver.rb, line 272
def browser
  bridge.browser
end
capabilities() click to toggle source
# File lib/selenium/webdriver/common/driver.rb, line 276
def capabilities
  bridge.capabilities
end
close() click to toggle source

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

# File lib/selenium/webdriver/common/driver.rb, line 174
def close
  bridge.close
end
current_url() click to toggle source

Get the URL of the current page

@return [String]

# File lib/selenium/webdriver/common/driver.rb, line 138
def current_url
  bridge.url
end
execute_async_script(script, *args) click to toggle source

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.

@param [String] script

JavaScript source to execute

@param [WebDriver::Element,Integer, Float, Boolean, NilClass, String, Array] args

Arguments to the script. May be empty.

@return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]

# File lib/selenium/webdriver/common/driver.rb, line 230
def execute_async_script(script, *args)
  bridge.execute_async_script(script, *args)
end
execute_script(script, *args) click to toggle source

Execute the given JavaScript

@param [String] script

JavaScript source to execute

@param [WebDriver::Element, Integer, Float, Boolean, NilClass, String, Array] args

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

@return [WebDriver::Element,Integer,Float,Boolean,NilClass,String,Array]

The value returned from the script.
# File lib/selenium/webdriver/common/driver.rb, line 211
def execute_script(script, *args)
  bridge.execute_script(script, *args)
end
Also aliased as: script
get(url) click to toggle source

Opens the specified URL in the browser.

# File lib/selenium/webdriver/common/driver.rb, line 128
def get(url)
  navigate.to(url)
end
inspect() click to toggle source
# File lib/selenium/webdriver/common/driver.rb, line 76
def inspect
  format '#<%<class>s:0x%<hash>x browser=%<browser>s>', class: self.class, hash: hash * 2, browser: bridge.browser.inspect
end
keyboard() click to toggle source
# File lib/selenium/webdriver/common/driver.rb, line 120
def keyboard
  bridge.keyboard
end
manage() click to toggle source

@return [Manager] @see Manager

# File lib/selenium/webdriver/common/driver.rb, line 103
def manage
  bridge.manage
end
mouse() click to toggle source
# File lib/selenium/webdriver/common/driver.rb, line 116
def mouse
  bridge.mouse
end
navigate() click to toggle source

@return [Navigation] @see Navigation

page_source() click to toggle source

Get the source of the current page

@return [String]

# File lib/selenium/webdriver/common/driver.rb, line 158
def page_source
  bridge.page_source
end
quit() click to toggle source

Quit the browser

# File lib/selenium/webdriver/common/driver.rb, line 166
def quit
  bridge.quit
end
ref() click to toggle source

@api private @see SearchContext

# File lib/selenium/webdriver/common/driver.rb, line 285
def ref; end
script(script, *args)

driver.script('function() { … };')

Alias for: execute_script
switch_to() click to toggle source

@return [TargetLocator] @see TargetLocator

# File lib/selenium/webdriver/common/driver.rb, line 94
def switch_to
  @switch_to ||= WebDriver::TargetLocator.new(bridge)
end
title() click to toggle source

Get the title of the current page

@return [String]

# File lib/selenium/webdriver/common/driver.rb, line 148
def title
  bridge.title
end
window_handle() click to toggle source

Get the current window handle

@return [String]

# File lib/selenium/webdriver/common/driver.rb, line 195
def window_handle
  bridge.window_handle
end
window_handles() click to toggle source

Get the window handles of open browser windows.

@return [Array] @see Selenium::WebDriver::TargetLocator#window

# File lib/selenium/webdriver/common/driver.rb, line 185
def window_handles
  bridge.window_handles
end

Private Instance Methods

service_url(opts) click to toggle source
# File lib/selenium/webdriver/common/driver.rb, line 291
def service_url(opts)
  @service = opts.delete(:service)
  %i[driver_opts driver_path port].each do |key|
    next unless opts.key? key

    WebDriver.logger.deprecate(":#{key}", ':service with an instance of Selenium::WebDriver::Service')
  end
  @service ||= Service.send(browser,
                            args: opts.delete(:driver_opts),
                            path: opts.delete(:driver_path),
                            port: opts.delete(:port))
  @service.start
  @service.uri
end