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.
# File lib/capybara/session.rb, line 50 def initialize(mode, app=nil) @mode = mode @app = app end
@return [String] A snapshot of the HTML of the current document, as it looks right now (potentially modified by JavaScript).
# File lib/capybara/session.rb, line 99 def body driver.body end
@return [String] Host of the current page
# File lib/capybara/session.rb, line 125 def current_host uri = URI.parse(current_url) "#{uri.scheme}://#{uri.host}" if uri.host end
@return [String] Path of the current page, without any domain information
# File lib/capybara/session.rb, line 116 def current_path path = URI.parse(current_url).path path if path and not path.empty? end
@return [String] Fully qualified URL of the current page
# File lib/capybara/session.rb, line 134 def current_url driver.current_url end
# File lib/capybara/session.rb, line 295 def document @document ||= Capybara::Node::Document.new(self, driver) end
# File lib/capybara/session.rb, line 55 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 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.
@param [String] script A string of JavaScript to evaluate @return [Object] The result of the evaluated JavaScript (may be driver specific)
# File lib/capybara/session.rb, line 277 def evaluate_script(script) driver.evaluate_script(script) end
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.
@param [String] script A string of JavaScript to execute
# File lib/capybara/session.rb, line 264 def execute_script(script) driver.execute_script(script) end
# File lib/capybara/session.rb, line 307 def inspect %Q(#<Capybara::Session>) end
Reset the session, removing all cookies.
# File lib/capybara/session.rb, line 69 def reset! driver.reset! end
Returns a hash of response headers. Not supported by all drivers (e.g. Selenium)
@return [Hash{String => String}] A hash of response headers.
# File lib/capybara/session.rb, line 81 def response_headers driver.response_headers end
# File lib/capybara/session.rb, line 290 def save_and_open_page require 'capybara/util/save_and_open_page' Capybara.save_and_open_page(body) end
Save a snapshot of the page and open it in a browser for inspection
# File lib/capybara/session.rb, line 285 def save_page require 'capybara/util/save_and_open_page' Capybara.save_page(body) end
@return [String] HTML source of the document, before being modified by JavaScript.
# File lib/capybara/session.rb, line 108 def source driver.source end
Returns the current HTTP status code as an Integer. Not supported by all drivers (e.g. Selenium)
@return [Integer] Current HTTP status code
# File lib/capybara/session.rb, line 91 def status_code driver.status_code end
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
@param [String] url The URL to navigate to
# File lib/capybara/session.rb, line 156 def visit(url) driver.visit(url) end
Retry executing the block until a truthy result is returned or the timeout time is exceeded
@param [Integer] timeout The amount of seconds to retry executing the given block
# File lib/capybara/session.rb, line 252 def wait_until(timeout = Capybara.default_wait_time) Capybara.timeout(timeout,driver) { yield } end
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
@overload within(*find_args)
@param (see Capybara::Node::Finders#all)
@overload within(a_node)
@param [Capybara::Node::Base] a_node The node in whose scope the block should be evaluated
@raise [Capybara::ElementNotFound] If the scope can't be found before time expires
# File lib/capybara/session.rb, line 184 def within(*args) new_scope = if args.size == 1 && Capybara::Node::Base === args.first args.first else find(*args) end begin scopes.push(new_scope) yield ensure scopes.pop end end
Execute the given block within the a specific fieldset given the id or legend of that fieldset.
@param [String] locator Id or legend of the fieldset
# File lib/capybara/session.rb, line 204 def within_fieldset(locator) within :xpath, XPath::HTML.fieldset(locator) do yield end end
Execute the given block within the given iframe given the id of that iframe. Only works on some drivers (e.g. Selenium)
@param [String] locator Id of the frame
# File lib/capybara/session.rb, line 229 def within_frame(frame_id) driver.within_frame(frame_id) do yield end end
Execute the given block within the a specific table given the id or caption of that table.
@param [String] locator Id or caption of the table
# File lib/capybara/session.rb, line 216 def within_table(locator) within :xpath, XPath::HTML.table(locator) do yield end end
Execute the given block within the given window. Only works on some drivers (e.g. Selenium)
@param [String] locator of the window
# File lib/capybara/session.rb, line 242 def within_window(handle, &blk) driver.within_window(handle, &blk) end