class Capybara::Selenium::Driver

Constants

DEFAULT_OPTIONS
SPECIAL_OPTIONS

Attributes

app[R]
options[R]

Public Class Methods

new(app, options={}) click to toggle source
# File lib/capybara/selenium/driver.rb, line 24
def initialize(app, options={})
  begin
    require 'selenium-webdriver'
  rescue LoadError => e
    if e.message =~ /selenium-webdriver/
      raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
    else
      raise e
    end
  end

  @app = app
  @browser = nil
  @exit_status = nil
  @frame_handles = {}
  @options = DEFAULT_OPTIONS.merge(options)
end

Public Instance Methods

browser() click to toggle source
# File lib/capybara/selenium/driver.rb, line 9
def browser
  unless @browser
    @browser = Selenium::WebDriver.for(options[:browser], options.reject { |key,val| SPECIAL_OPTIONS.include?(key) })

    main = Process.pid
    at_exit do
      # Store the exit status of the test run since it goes away after calling the at_exit proc...
      @exit_status = $!.status if $!.is_a?(SystemExit)
      quit if Process.pid == main
      exit @exit_status if @exit_status # Force exit with stored status
    end
  end
  @browser
end
current_url() click to toggle source
# File lib/capybara/selenium/driver.rb, line 54
def current_url
  browser.current_url
end
evaluate_script(script) click to toggle source
# File lib/capybara/selenium/driver.rb, line 73
def evaluate_script(script)
  browser.execute_script "return #{script}"
end
execute_script(script) click to toggle source
# File lib/capybara/selenium/driver.rb, line 69
def execute_script(script)
  browser.execute_script script
end
find_css(selector) click to toggle source
# File lib/capybara/selenium/driver.rb, line 62
def find_css(selector)
  browser.find_elements(:css, selector).map { |node| Capybara::Selenium::Node.new(self, node) }
end
find_window( selector ) click to toggle source
# File lib/capybara/selenium/driver.rb, line 119
def find_window( selector )
  original_handle = browser.window_handle
  browser.window_handles.each do |handle|
    browser.switch_to.window handle
    if( selector == browser.execute_script("return window.name") ||
        browser.title.include?(selector) ||
        browser.current_url.include?(selector) ||
        (selector == handle) )
      browser.switch_to.window original_handle
      return handle
    end
  end
  raise Capybara::ElementNotFound, "Could not find a window identified by #{selector}"
end
find_xpath(selector) click to toggle source
# File lib/capybara/selenium/driver.rb, line 58
def find_xpath(selector)
  browser.find_elements(:xpath, selector).map { |node| Capybara::Selenium::Node.new(self, node) }
end
html() click to toggle source
# File lib/capybara/selenium/driver.rb, line 46
def html
  browser.page_source
end
invalid_element_errors() click to toggle source
# File lib/capybara/selenium/driver.rb, line 145
def invalid_element_errors
  [Selenium::WebDriver::Error::StaleElementReferenceError, Selenium::WebDriver::Error::UnhandledError, Selenium::WebDriver::Error::ElementNotVisibleError]
end
needs_server?() click to toggle source
# File lib/capybara/selenium/driver.rb, line 67
def needs_server?; true; end
quit() click to toggle source
# File lib/capybara/selenium/driver.rb, line 139
def quit
  @browser.quit
rescue Errno::ECONNREFUSED
  # Browser must have already gone
end
reset!() click to toggle source
# File lib/capybara/selenium/driver.rb, line 81
def reset!
  # Use instance variable directly so we avoid starting the browser just to reset the session
  if @browser
    begin @browser.manage.delete_all_cookies
    rescue Selenium::WebDriver::Error::UnhandledError
      # delete_all_cookies fails when we've previously gone
      # to about:blank, so we rescue this error and do nothing
      # instead.
    end
    @browser.navigate.to('about:blank')
  end
end
save_screenshot(path, options={}) click to toggle source
# File lib/capybara/selenium/driver.rb, line 77
def save_screenshot(path, options={})
  browser.save_screenshot(path)
end
title() click to toggle source
# File lib/capybara/selenium/driver.rb, line 50
def title
  browser.title
end
visit(path) click to toggle source
# File lib/capybara/selenium/driver.rb, line 42
def visit(path)
  browser.navigate.to(path)
end
wait?() click to toggle source
# File lib/capybara/selenium/driver.rb, line 66
def wait?; true; end
within_frame(frame_handle) { || ... } click to toggle source

Webdriver supports frame name, id, index(zero-based) or {Capybara::Element} to find iframe

@overload #within_frame(index)

@param [Integer] index                 index of a frame

@overload #within_frame(name_or_id)

@param [String] name_or_id             name or id of a frame

@overload #within_frame(element)

@param [Capybara::Node::Base] a_node   frame element
# File lib/capybara/selenium/driver.rb, line 105
def within_frame(frame_handle)
  @frame_handles[browser.window_handle] ||= []
  frame_handle = frame_handle.native if frame_handle.is_a?(Capybara::Node::Base)
  @frame_handles[browser.window_handle] << frame_handle
  a=browser.switch_to.frame(frame_handle)
  yield
ensure
  # There doesnt appear to be any way in Webdriver to move back to a parent frame
  # other than going back to the root and then reiterating down
  @frame_handles[browser.window_handle].pop
  browser.switch_to.default_content
  @frame_handles[browser.window_handle].each { |fh| browser.switch_to.frame(fh) }
end
within_window(selector, &blk) click to toggle source
# File lib/capybara/selenium/driver.rb, line 134
def within_window(selector, &blk)
  handle = find_window( selector )
  browser.switch_to.window(handle, &blk)
end