Class: Capybara::Selenium::Driver

Inherits:
Driver::Base show all
Defined in:
lib/capybara/selenium/driver.rb

Constant Summary

DEFAULT_OPTIONS = 
{
  :browser => :firefox
}
SPECIAL_OPTIONS = 
[:browser]

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Driver::Base

#response_headers, #status_code

Constructor Details

- (Driver) initialize(app, options = {})

A new instance of Driver



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# 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

Instance Attribute Details

- (Object) app (readonly)

Returns the value of attribute app



7
8
9
 
# File 'lib/capybara/selenium/driver.rb', line 7

def app
  @app
end

- (Object) options (readonly)

Returns the value of attribute options



7
8
9
 
# File 'lib/capybara/selenium/driver.rb', line 7

def options
  @options
end

Instance Method Details

- (Object) browser 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# 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

- (Object) current_url 



54
55
56
 
# File 'lib/capybara/selenium/driver.rb', line 54

def current_url
  browser.current_url
end

- (Object) evaluate_script(script) 



73
74
75
 
# File 'lib/capybara/selenium/driver.rb', line 73

def evaluate_script(script)
  browser.execute_script "return #{script}"
end

- (Object) execute_script(script) 



69
70
71
 
# File 'lib/capybara/selenium/driver.rb', line 69

def execute_script(script)
  browser.execute_script script
end

- (Object) find_css(selector) 



62
63
64
 
# 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

- (Object) find_window(selector)

Raises:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# 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

- (Object) find_xpath(selector) 



58
59
60
 
# 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

- (Object) html 



46
47
48
 
# File 'lib/capybara/selenium/driver.rb', line 46

def html
  browser.page_source
end

- (Object) invalid_element_errors 



145
146
147
 
# 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

- (Boolean) needs_server?

Returns:

  • (Boolean) 


67
 
# File 'lib/capybara/selenium/driver.rb', line 67

def needs_server?; true; end

- (Object) quit 



139
140
141
142
143
 
# File 'lib/capybara/selenium/driver.rb', line 139

def quit
  @browser.quit
rescue Errno::ECONNREFUSED
  # Browser must have already gone
end

- (Object) reset! 



81
82
83
84
85
86
87
88
89
90
91
92
 
# 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

- (Object) save_screenshot(path, options = {}) 



77
78
79
 
# File 'lib/capybara/selenium/driver.rb', line 77

def save_screenshot(path, options={})
  browser.save_screenshot(path)
end

- (Object) title 



50
51
52
 
# File 'lib/capybara/selenium/driver.rb', line 50

def title
  browser.title
end

- (Object) visit(path) 



42
43
44
 
# File 'lib/capybara/selenium/driver.rb', line 42

def visit(path)
  browser.navigate.to(path)
end

- (Boolean) wait?

Returns:

  • (Boolean) 


66
 
# File 'lib/capybara/selenium/driver.rb', line 66

def wait?; true; end

- (Object) within_frame(index) - (Object) within_frame(name_or_id) - (Object) within_frame(element)

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

Overloads:

  • - (Object) within_frame(index)

    Parameters:

    • index (Integer) —

      index of a frame

  • - (Object) within_frame(name_or_id)

    Parameters:

    • name_or_id (String) —

      name or id of a frame

  • - (Object) within_frame(element)

    Parameters:



105
106
107
108
109
110
111
112
113
114
115
116
117
 
# 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

- (Object) within_window(selector, &blk) 



134
135
136
137
 
# File 'lib/capybara/selenium/driver.rb', line 134

def within_window(selector, &blk)
  handle = find_window( selector )
  browser.switch_to.window(handle, &blk)
end