Class: Capybara::Selenium::Driver

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

Constant Summary collapse

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

#initialize(app, options = {}) ⇒ Driver

Returns a new instance of Driver.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/capybara/selenium/driver.rb', line 26

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

#app ⇒ Object (readonly)

Returns the value of attribute app.



9
10
11
 
# File 'lib/capybara/selenium/driver.rb', line 9

def app
  @app
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



9
10
11
 
# File 'lib/capybara/selenium/driver.rb', line 9

def options
  @options
end

Instance Method Details

#browser ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/capybara/selenium/driver.rb', line 11

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

#close_window(handle) ⇒ Object 



153
154
155
156
157
 
# File 'lib/capybara/selenium/driver.rb', line 153

def close_window(handle)
  within_given_window(handle) do
    browser.close
  end
end

#current_url ⇒ Object 



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

def current_url
  browser.current_url
end

#current_window_handle ⇒ Object 



129
130
131
 
# File 'lib/capybara/selenium/driver.rb', line 129

def current_window_handle
  browser.window_handle
end

#evaluate_script(script) ⇒ Object 



83
84
85
 
# File 'lib/capybara/selenium/driver.rb', line 83

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

#execute_script(script) ⇒ Object 



79
80
81
 
# File 'lib/capybara/selenium/driver.rb', line 79

def execute_script(script)
  browser.execute_script script
end

#find_css(selector) ⇒ Object 



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

def find_css(selector)
  browser.find_elements(:css, selector).map { |node| Capybara::Selenium::Node.new(self, node) }
end

#find_window(locator) ⇒ 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.

Raises:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/capybara/selenium/driver.rb', line 172

def find_window(locator)
  handles = browser.window_handles
  return locator if handles.include? locator

  original_handle = browser.window_handle
  handles.each do |handle|
    switch_to_window(handle)
    if (locator == browser.execute_script("return window.name") ||
        browser.title.include?(locator) ||
        browser.current_url.include?(locator))
      switch_to_window(original_handle)
      return handle
    end
  end
  raise Capybara::ElementNotFound, "Could not find a window identified by #{locator}"
end

#find_xpath(selector) ⇒ Object 



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

def find_xpath(selector)
  browser.find_elements(:xpath, selector).map { |node| Capybara::Selenium::Node.new(self, node) }
end

#go_back ⇒ Object 



48
49
50
 
# File 'lib/capybara/selenium/driver.rb', line 48

def go_back
  browser.navigate.back
end

#go_forward ⇒ Object 



52
53
54
 
# File 'lib/capybara/selenium/driver.rb', line 52

def go_forward
  browser.navigate.forward
end

#html ⇒ Object 



56
57
58
 
# File 'lib/capybara/selenium/driver.rb', line 56

def html
  browser.page_source
end

#invalid_element_errors ⇒ Object 



202
203
204
 
# File 'lib/capybara/selenium/driver.rb', line 202

def invalid_element_errors
  [Selenium::WebDriver::Error::StaleElementReferenceError, Selenium::WebDriver::Error::UnhandledError, Selenium::WebDriver::Error::ElementNotVisibleError]
end

#maximize_window(handle) ⇒ Object 



146
147
148
149
150
151
 
# File 'lib/capybara/selenium/driver.rb', line 146

def maximize_window(handle)
  within_given_window(handle) do
    browser.manage.window.maximize
  end
  sleep 0.1 # work around for https://code.google.com/p/selenium/issues/detail?id=7405
end

#needs_server? ⇒ Boolean

Returns:

  • (Boolean) 


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

def needs_server?; true; end

#no_such_window_error ⇒ Object 



206
207
208
 
# File 'lib/capybara/selenium/driver.rb', line 206

def no_such_window_error
  Selenium::WebDriver::Error::NoSuchWindowError
end

#open_new_window ⇒ Object 



163
164
165
 
# File 'lib/capybara/selenium/driver.rb', line 163

def open_new_window
  browser.execute_script('window.open();')
end

#quit ⇒ Object 



194
195
196
197
198
199
200
 
# File 'lib/capybara/selenium/driver.rb', line 194

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

#reset! ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/capybara/selenium/driver.rb', line 91

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

#resize_window_to(handle, width, height) ⇒ Object 



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

def resize_window_to(handle, width, height)
  within_given_window(handle) do
    browser.manage.window.resize_to(width, height)
  end
end

#save_screenshot(path, options = {}) ⇒ Object 



87
88
89
 
# File 'lib/capybara/selenium/driver.rb', line 87

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

#switch_to_window(handle) ⇒ Object 



167
168
169
 
# File 'lib/capybara/selenium/driver.rb', line 167

def switch_to_window(handle)
  browser.switch_to.window handle
end

#title ⇒ Object 



60
61
62
 
# File 'lib/capybara/selenium/driver.rb', line 60

def title
  browser.title
end

#visit(path) ⇒ Object 



44
45
46
 
# File 'lib/capybara/selenium/driver.rb', line 44

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

#wait? ⇒ Boolean

Returns:

  • (Boolean) 


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

def wait?; true; end

#window_handles ⇒ Object 



159
160
161
 
# File 'lib/capybara/selenium/driver.rb', line 159

def window_handles
  browser.window_handles
end

#window_size(handle) ⇒ Object 



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

def window_size(handle)
  within_given_window(handle) do
    size = browser.manage.window.size
    [size.width, size.height]
  end
end

#within_frame(index) ⇒ Object #within_frame(name_or_id) ⇒ Object #within_frame(element) ⇒ Object

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

Overloads:

  • #within_frame(index) ⇒ Object

    Parameters:

    • index (Integer) —

      index of a frame

  • #within_frame(name_or_id) ⇒ Object

    Parameters:

    • name_or_id (String) —

      name or id of a frame

  • #within_frame(element) ⇒ Object

    Parameters:



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/capybara/selenium/driver.rb', line 115

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(locator) ⇒ Object 



189
190
191
192
 
# File 'lib/capybara/selenium/driver.rb', line 189

def within_window(locator)
  handle = find_window(locator)
  browser.switch_to.window(handle) { yield }
end