Class: Capybara::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/capybara/session.rb

Overview

The Session class represents a single user’s interaction with the system. The Session can use any of the underlying drivers. A session can be initialized manually like this:

session = Capybara::Session.new(:culerity, MyRackApp)

The application given as the second argument is optional. When running Capybara against an external page, you might want to leave it out:

session = Capybara::Session.new(:culerity)
session.visit('http://www.google.com')

Session provides a number of methods for controlling the navigation of the page, such as visit, +current_path, and so on. It also delegate a number of methods to a Capybara::Document, representing the current HTML document. This allows interaction:

session.fill_in('q', :with => 'Capybara')
session.click_button('Search')
session.should have_content('Capybara')

When using capybara/dsl, the Session is initialized automatically for you.

Constant Summary collapse

DSL_METHODS = 
[
  :all, :attach_file, :body, :check, :choose, :click_link_or_button, :click_button, :click_link, :current_url, :drag, :evaluate_script,
  :field_labeled, :fill_in, :find, :find_button, :find_by_id, :find_field, :find_link, :has_content?, :has_css?,
  :has_no_content?, :has_no_css?, :has_no_xpath?, :has_xpath?, :locate, :save_and_open_page, :select, :source, :uncheck,
  :visit, :wait_until, :within, :within_fieldset, :within_table, :within_frame, :within_window, :has_link?, :has_no_link?, :has_button?,
  :has_no_button?, :has_field?, :has_no_field?, :has_checked_field?, :has_unchecked_field?, :has_no_table?, :has_table?,
  :unselect, :has_select?, :has_no_select?, :current_path, :click, :has_selector?, :has_no_selector?
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mode, app = nil) ⇒ Session

Returns a new instance of Session.



40
41
42
43
 
# File 'lib/capybara/session.rb', line 40

def initialize(mode, app=nil)
  @mode = mode
  @app = app
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(*args) ⇒ Object 



272
273
274
 
# File 'lib/capybara/session.rb', line 272

def method_missing(*args)
  current_node.send(*args)
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



38
39
40
 
# File 'lib/capybara/session.rb', line 38

def app
  @app
end

#mode ⇒ Object (readonly)

Returns the value of attribute mode.



38
39
40
 
# File 'lib/capybara/session.rb', line 38

def mode
  @mode
end

Instance Method Details

#body ⇒ String

Returns A snapshot of the HTML of the current document, as it looks right now.

Returns:

  • (String) —

    A snapshot of the HTML of the current document, as it looks right now



88
89
90
 
# File 'lib/capybara/session.rb', line 88

def body
  driver.body
end

#click(locator) ⇒ Object

Deprecated.

click is deprecated, please use Node::Actions#click_link_or_button instead



254
255
256
257
 
# File 'lib/capybara/session.rb', line 254

def click(locator)
  Capybara.deprecate("click", "click_link_or_button")
  current_node.click_link_or_button(locator)
end

#current_path ⇒ String

Returns Path of the current page, without any domain information.

Returns:

  • (String) —

    Path of the current page, without any domain information



104
105
106
 
# File 'lib/capybara/session.rb', line 104

def current_path
  URI.parse(current_url).path
end

#current_url ⇒ String

Returns Fully qualified URL of the current page.

Returns:

  • (String) —

    Fully qualified URL of the current page



112
113
114
 
# File 'lib/capybara/session.rb', line 112

def current_url
  driver.current_url
end

#document ⇒ Object 



268
269
270
 
# File 'lib/capybara/session.rb', line 268

def document
  Capybara::Document.new(self, driver)
end

#driver ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'lib/capybara/session.rb', line 45

def driver
  @driver ||= begin
    unless Capybara.drivers.has_key?(mode)
      other_drivers = Capybara.drivers.keys.map { |key| key.inspect }
      raise Capybara::DriverNotFoundError, "no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}"
    end
    Capybara.drivers[mode].call(app)
  end
end

#evaluate_script(script) ⇒ Object

Evaluate the given JavaScript and return the result. Be careful when using this with scripts that return complex objects, such as jQuery statements. execute_script might be a better alternative.

Parameters:

  • script (String) —

    A string of JavaScript to evaluate

Returns:

  • (Object) —

    The result of the evaluated JavaScript (may be driver specific)



246
247
248
 
# File 'lib/capybara/session.rb', line 246

def evaluate_script(script)
  driver.evaluate_script(script)
end

#execute_script(script) ⇒ Object

Execute the given script, not returning a result. This is useful for scripts that return complex objects, such as jQuery statements. execute_script should always be used over evaluate_script whenever possible.

Parameters:

  • script (String) —

    A string of JavaScript to execute



233
234
235
 
# File 'lib/capybara/session.rb', line 233

def execute_script(script)
  driver.execute_script(script)
end

#reset! ⇒ Object Also known as: cleanup!

Reset the session, removing all cookies.



59
60
61
 
# File 'lib/capybara/session.rb', line 59

def reset!
  driver.reset!
end

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/capybara/session.rb', line 276

def respond_to?(method)
  super || current_node.respond_to?(method)
end

#response_headers ⇒ Hash{String => String}

Returns a hash of response headers. Not supported by all drivers (e.g. Selenium)

Returns:

  • (Hash{String => String}) —

    A hash of response headers.



70
71
72
 
# File 'lib/capybara/session.rb', line 70

def response_headers
  driver.response_headers
end

#save_and_open_page ⇒ Object

Save a snapshot of the page and open it in a browser for inspection



263
264
265
266
 
# File 'lib/capybara/session.rb', line 263

def save_and_open_page
  require 'capybara/util/save_and_open_page'
  Capybara.save_and_open_page(body)
end

#source ⇒ String

Returns HTML source of the document, before being modified by JavaScript.

Returns:

  • (String) —

    HTML source of the document, before being modified by JavaScript.



96
97
98
 
# File 'lib/capybara/session.rb', line 96

def source
  driver.source
end

#status_code ⇒ Integer

Returns the current HTTP status code as an Integer. Not supported by all drivers (e.g. Selenium)

Returns:

  • (Integer) —

    Current HTTP status code



80
81
82
 
# File 'lib/capybara/session.rb', line 80

def status_code
  driver.status_code
end

#visit(url) ⇒ Object

Navigate to the given URL. The URL can either be a relative URL or an absolute URL The behaviour of either depends on the driver.

session.visit('/foo')
session.visit('http://google.com')

For drivers which can run against an external application, such as culerity and selenium giving an absolute URL will navigate to that page. This allows testing applications running on remote servers. For these drivers, setting Capybara.app_host will make the remote server the default. For example:

Capybara.app_host = 'http://google.com'
session.visit('/') # visits the google homepage

Parameters:

  • url (String) —

    The URL to navigate to



134
135
136
 
# File 'lib/capybara/session.rb', line 134

def visit(url)
  driver.visit(url)
end

#wait_until(timeout = Capybara.default_wait_time) ⇒ Object

Retry executing the block until a truthy result is returned or the timeout time is exceeded

Parameters:

  • timeout (Integer) (defaults to: Capybara.default_wait_time) —

    The amount of seconds to retry executing the given block



221
222
223
 
# File 'lib/capybara/session.rb', line 221

def wait_until(timeout = Capybara.default_wait_time)
  Capybara.timeout(timeout,driver) { yield }
end

#within(kind, selector = nil) ⇒ Object

Execute the given block for a particular scope on the page. Within will find the first element matching the given selector and execute the block scoped to that element:

within(:xpath, '//div[@id="delivery-address"]') do
  fill_in('Street', :with => '12 Main Street')
end

It is possible to omit the first parameter, in that case, the selector is assumed to be of the type set in Capybara.default_selector.

within('div#delivery-address') do
  fill_in('Street', :with => '12 Main Street')
end

Parameters:

  • kind (:css, :xpath, String) —

    The type of selector or the selector if the second argument is blank

  • selector (String) (defaults to: nil) —

    The selector within which to execute the given block



157
158
159
160
161
162
163
164
165
 
# File 'lib/capybara/session.rb', line 157

def within(kind, selector=nil)
  new_scope = find(kind, selector, :message => "scope '#{selector || kind}' not found on page")
  begin
    scopes.push(new_scope)
    yield
  ensure
    scopes.pop
  end
end

#within_fieldset(locator) ⇒ Object

Execute the given block within the a specific fieldset given the id or legend of that fieldset.

Parameters:

  • locator (String) —

    Id or legend of the fieldset



173
174
175
176
177
 
# File 'lib/capybara/session.rb', line 173

def within_fieldset(locator)
  within :xpath, XPath::HTML.fieldset(locator) do
    yield
  end
end

#within_frame(frame_id) ⇒ Object

Execute the given block within the given iframe given the id of that iframe. Only works on some drivers (e.g. Selenium)

Parameters:

  • locator (String) —

    Id of the frame



198
199
200
201
202
 
# File 'lib/capybara/session.rb', line 198

def within_frame(frame_id)
  driver.within_frame(frame_id) do
    yield
  end
end

#within_table(locator) ⇒ Object

Execute the given block within the a specific table given the id or caption of that table.

Parameters:

  • locator (String) —

    Id or caption of the table



185
186
187
188
189
 
# File 'lib/capybara/session.rb', line 185

def within_table(locator)
  within :xpath, XPath::HTML.table(locator) do
    yield
  end
end

#within_window(handle, &blk) ⇒ Object

Execute the given block within the given window. Only works on some drivers (e.g. Selenium)

Parameters:

  • locator (String) —

    of the window



211
212
213
 
# File 'lib/capybara/session.rb', line 211

def within_window(handle, &blk)
  driver.within_window(handle, &blk)
end