class Capybara::Session

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')

When Capybara.threadsafe == true the sessions options will be initially set to the current values of the global options and a configuration block can be passed to the session initializer. For available options see {Capybara::SessionConfig::OPTIONS}

session = Capybara::Session.new(:driver, MyRackApp) do |config|
  config.app_host = "http://my_host.dev"
end

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')
expect(session).to have_content('Capybara')

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

Constants

DOCUMENT_METHODS

@api private

DSL_METHODS
NODE_METHODS
SESSION_METHODS

Attributes

app[R]
mode[R]
server[R]
synchronized[RW]

Public Class Methods

instance_created?() click to toggle source
# File lib/capybara/session.rb, line 831
def self.instance_created?
  @@instance_created
end
new(mode, app=nil) { |config| ... } click to toggle source
# File lib/capybara/session.rb, line 77
def initialize(mode, app=nil)
  raise TypeError, "The second parameter to Session::new should be a rack app if passed." if app && !app.respond_to?(:call)
  @@instance_created = true
  @mode = mode
  @app = app
  if block_given?
    raise "A configuration block is only accepted when Capybara.threadsafe == true" unless Capybara.threadsafe
    yield config if block_given?
  end
  if config.run_server and @app and driver.needs_server?
    @server = Capybara::Server.new(@app, config.server_port, config.server_host, config.server_errors).boot
  else
    @server = nil
  end
  @touched = false
end

Public Instance Methods

accept_alert(text_or_options=nil, options={}, &blk) click to toggle source

Execute the block, accepting a alert.

@!macro modal_params

@overload $0(text, options = {}, &blk)
  @param text [String, Regexp]  Text or regex to match against the text in the modal.  If not provided any modal is matched
@overload $0(options = {}, &blk)
@option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time to wait for the modal to appear after executing the block.
@return [String]  the message shown in the modal
@raise [Capybara::ModalNotFound]  if modal dialog hasn't been found
# File lib/capybara/session.rb, line 657
def accept_alert(text_or_options=nil, options={}, &blk)
  accept_modal(:alert, text_or_options, options, &blk)
end
accept_confirm(text_or_options=nil, options={}, &blk) click to toggle source

Execute the block, accepting a confirm.

@macro modal_params

# File lib/capybara/session.rb, line 667
def accept_confirm(text_or_options=nil, options={}, &blk)
  accept_modal(:confirm, text_or_options, options, &blk)
end
accept_prompt(text_or_options=nil, options={}, &blk) click to toggle source

Execute the block, accepting a prompt, optionally responding to the prompt.

@macro modal_params @option options [String] :with Response to provide to the prompt

# File lib/capybara/session.rb, line 688
def accept_prompt(text_or_options=nil, options={}, &blk)
  accept_modal(:prompt, text_or_options, options, &blk)
end
body()
Alias for: html
cleanup!()
Alias for: reset!
config() click to toggle source
# File lib/capybara/session.rb, line 835
def config
  @config ||= if Capybara.threadsafe
    Capybara.session_options.dup
  else
    Capybara::ReadOnlySessionConfig.new(Capybara.session_options)
  end
end
configure() { |config| ... } click to toggle source

Accepts a block to set the configuration options if Capybara.threadsafe == true. Note that some options only have an effect if set at initialization time, so look at the configuration block that can be passed to the initializer too

# File lib/capybara/session.rb, line 826
def configure
  raise "Session configuration is only supported when Capybara.threadsafe == true" unless Capybara.threadsafe
  yield config
end
current_host() click to toggle source

@return [String] Host of the current page

# File lib/capybara/session.rb, line 206
def current_host
  uri = URI.parse(current_url)
  "#{uri.scheme}://#{uri.host}" if uri.host
end
current_path() click to toggle source

@return [String] Path of the current page, without any domain information

# File lib/capybara/session.rb, line 189
def current_path
  # Addressable parsing is more lenient than URI
  uri = ::Addressable::URI.parse(current_url)

  # If current_url ends up being nil, won't be able to call .path on a NilClass.
  return nil if uri.nil?

  # Addressable doesn't support opaque URIs - we want nil here
  return nil if uri.scheme == "about"
  path = uri.path
  path if path and not path.empty?
end
current_scope() click to toggle source
# File lib/capybara/session.rb, line 797
def current_scope
  scope = scopes.last
  scope = document if [nil, :frame].include? scope
  scope
end
current_url() click to toggle source

@return [String] Fully qualified URL of the current page

# File lib/capybara/session.rb, line 215
def current_url
  driver.current_url
end
current_window() click to toggle source

@return [Capybara::Window] current window

# File lib/capybara/session.rb, line 435
def current_window
  Window.new(self, driver.current_window_handle)
end
dismiss_confirm(text_or_options=nil, options={}, &blk) click to toggle source

Execute the block, dismissing a confirm.

@macro modal_params

# File lib/capybara/session.rb, line 677
def dismiss_confirm(text_or_options=nil, options={}, &blk)
  dismiss_modal(:confirm, text_or_options, options, &blk)
end
dismiss_prompt(text_or_options=nil, options={}, &blk) click to toggle source

Execute the block, dismissing a prompt.

@macro modal_params

# File lib/capybara/session.rb, line 698
def dismiss_prompt(text_or_options=nil, options={}, &blk)
  dismiss_modal(:prompt, text_or_options, options, &blk)
end
document() click to toggle source
# File lib/capybara/session.rb, line 776
def document
  @document ||= Capybara::Node::Document.new(self, driver)
end
driver() click to toggle source
# File lib/capybara/session.rb, line 94
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
    driver = Capybara.drivers[mode].call(app)
    driver.session = self if driver.respond_to?(:session=)
    driver
  end
end
evaluate_script(script, *args) click to toggle source

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 634
def evaluate_script(script, *args)
  @touched = true
  result = if args.empty?
    driver.evaluate_script(script)
  else
    raise Capybara::NotSupportedByDriverError, "The current driver does not support evaluate_script arguments" if driver.method(:evaluate_script).arity == 1
    driver.evaluate_script(script, *args.map { |arg| arg.is_a?(Capybara::Node::Element) ?  arg.base : arg} )
  end
  element_script_result(result)
end
execute_script(script, *args) click to toggle source

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

@param [String] script A string of JavaScript to execute @param args Optional arguments that will be passed to the script. Driver support for this is optional and types of objects supported may differ between drivers

# File lib/capybara/session.rb, line 615
def execute_script(script, *args)
  @touched = true
  if args.empty?
    driver.execute_script(script)
  else
    raise Capybara::NotSupportedByDriverError, "The current driver does not support execute_script arguments" if driver.method(:execute_script).arity == 1
    driver.execute_script(script, *args.map { |arg| arg.is_a?(Capybara::Node::Element) ?  arg.base : arg} )
  end
end
go_back() click to toggle source

Move back a single entry in the browser's history.

# File lib/capybara/session.rb, line 275
def go_back
  driver.go_back
end
go_forward() click to toggle source

Move forward a single entry in the browser's history.

# File lib/capybara/session.rb, line 283
def go_forward
  driver.go_forward
end
html() click to toggle source

@return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).

# File lib/capybara/session.rb, line 179
def html
  driver.html
end
Also aliased as: body, source
inspect() click to toggle source
# File lib/capybara/session.rb, line 793
def inspect
  %Q(#<Capybara::Session>)
end
open_new_window() click to toggle source

Open new window. Current window doesn't change as the result of this call. It should be switched to explicitly.

@return [Capybara::Window] window that has been opened

# File lib/capybara/session.rb, line 459
def open_new_window
  window_opened_by do
    driver.open_new_window
  end
end
raise_server_error!() click to toggle source

Raise errors encountered in the server

# File lib/capybara/session.rb, line 139
def raise_server_error!
  if @server and @server.error
    # Force an explanation for the error being raised as the exception cause
    begin
      if config.raise_server_errors
        raise CapybaraError, "Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true"
      end
    rescue CapybaraError
      #needed to get the cause set correctly in JRuby -- otherwise we could just do raise @server.error
      raise @server.error, @server.error.message, @server.error.backtrace
    ensure
      @server.reset_error!
    end
  end
end
reset!() click to toggle source

Reset the session (i.e. remove cookies and navigate to blank page)

This method does not:

* accept modal dialogs if they are present (Selenium driver now does, others may not)
* clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.
* modify state of the driver/underlying browser in any other way

as doing so will result in performance downsides and it's not needed to do everything from the list above for most apps.

If you want to do anything from the list above on a general basis you can:

* write RSpec/Cucumber/etc. after hook
* monkeypatch this method
* use Ruby's `prepend` method
# File lib/capybara/session.rb, line 124
def reset!
  if @touched
    driver.reset!
    @touched = false
  end
  @server.wait_for_pending_requests if @server
  raise_server_error!
end
Also aliased as: cleanup!, reset_session!
reset_session!()
Alias for: reset!
response_headers() click to toggle source

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 161
def response_headers
  driver.response_headers
end
save_and_open_page(path = nil) click to toggle source

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

If invoked without arguments it will save file to `Capybara.save_path`

and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`, which is different from
the previous behavior with `Capybara.save_and_open_page_path` where the relative path was
relative to Dir.pwd

@param [String] path the path to where it should be saved

# File lib/capybara/session.rb, line 734
def save_and_open_page(path = nil)
  path = save_page(path)
  open_file(path)
end
save_and_open_screenshot(path = nil, options = {}) click to toggle source

Save a screenshot of the page and open it for inspection.

If invoked without arguments it will save file to `Capybara.save_path`

and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`, which is different from
the previous behavior with `Capybara.save_and_open_page_path` where the relative path was
relative to Dir.pwd

@param [String] path the path to where it should be saved @param [Hash] options a customizable set of options

# File lib/capybara/session.rb, line 771
def save_and_open_screenshot(path = nil, options = {})
  path = save_screenshot(path, options)
  open_file(path)
end
save_page(path = nil) click to toggle source

Save a snapshot of the page. If `Capybara.asset_host` is set it will inject `base` tag

pointing to `asset_host`.

If invoked without arguments it will save file to `Capybara.save_path`

and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`, which is different from
the previous behavior with `Capybara.save_and_open_page_path` where the relative path was
relative to Dir.pwd

@param [String] path the path to where it should be saved @return [String] the path to which the file was saved

# File lib/capybara/session.rb, line 716
def save_page(path = nil)
  path = prepare_path(path, 'html')
  File.write(path, Capybara::Helpers.inject_asset_host(body, config.asset_host), mode: 'wb')
  path
end
save_screenshot(path = nil, options = {}) click to toggle source

Save a screenshot of page.

If invoked without arguments it will save file to `Capybara.save_path`

and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`, which is different from
the previous behavior with `Capybara.save_and_open_page_path` where the relative path was
relative to Dir.pwd

@param [String] path the path to where it should be saved @param [Hash] options a customizable set of options @return [String] the path to which the file was saved

# File lib/capybara/session.rb, line 752
def save_screenshot(path = nil, options = {})
  path = prepare_path(path, 'png')
  driver.save_screenshot(path, options)
  path
end
source()
Alias for: html
status_code() click to toggle source

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 171
def status_code
  driver.status_code
end
switch_to_frame(frame) click to toggle source

Switch to the given frame

If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to. #within_frame is preferred over this method and should be used when possible. May not be supported by all drivers.

@overload #switch_to_frame(element)

@param [Capybara::Node::Element]  iframe/frame element to switch to

@overload #switch_to_frame(:parent)

Switch to the parent element

@overload #switch_to_frame(:top)

Switch to the top level document
# File lib/capybara/session.rb, line 372
def switch_to_frame(frame)
  case frame
  when Capybara::Node::Element
    driver.switch_to_frame(frame)
    scopes.push(:frame)
  when :parent
    raise Capybara::ScopeError, "`switch_to_frame(:parent)` cannot be called from inside a descendant frame's "                                     "`within` block." if scopes.last() != :frame
    scopes.pop
    driver.switch_to_frame(:parent)
  when :top
    idx = scopes.index(:frame)
    if idx
      raise Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's "                                       "`within` block." if scopes.slice(idx..-1).any? {|scope| ![:frame, nil].include?(scope)}
      scopes.slice!(idx..-1)
      driver.switch_to_frame(:top)
    end
  end
end
switch_to_window(window = nil, options= {}) { || ... } click to toggle source

@overload #switch_to_window(&block)

Switches to the first window for which given block returns a value other than false or nil.
If window that matches block can't be found, the window will be switched back and `WindowError` will be raised.
@example
  window = switch_to_window { title == 'Page title' }
@raise [Capybara::WindowError]     if no window matches given block

@overload #switch_to_window(window)

@param window [Capybara::Window]   window that should be switched to
@raise [Capybara::Driver::Base#no_such_window_error] if unexistent (e.g. closed) window was passed

@return [Capybara::Window] window that has been switched to @raise [Capybara::ScopeError] if this method is invoked inside `within`,

`within_frame` or `within_window` methods

@raise [ArgumentError] if both or neither arguments were provided

# File lib/capybara/session.rb, line 481
def switch_to_window(window = nil, options= {})
  options, window = window, nil if window.is_a? Hash

  block_given = block_given?
  if window && block_given
    raise ArgumentError, "`switch_to_window` can take either a block or a window, not both"
  elsif !window && !block_given
    raise ArgumentError, "`switch_to_window`: either window or block should be provided"
  elsif scopes.size > 1
    raise Capybara::ScopeError, "`switch_to_window` is not supposed to be invoked from "                                     "`within`'s, `within_frame`'s' or `within_window`'s' block."
  end

  if window
    driver.switch_to_window(window.handle)
    window
  else
    wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)
    document.synchronize(wait_time, errors: [Capybara::WindowError]) do
      original_window_handle = driver.current_window_handle
      begin
        driver.window_handles.each do |handle|
          driver.switch_to_window handle
          if yield
            return Window.new(self, handle)
          end
        end
      rescue => e
        driver.switch_to_window(original_window_handle)
        raise e
      else
        driver.switch_to_window(original_window_handle)
        raise Capybara::WindowError, "Could not find a window matching block/lambda"
      end
    end
  end
end
using_wait_time(seconds) { || ... } click to toggle source

Yield a block using a specific wait time

# File lib/capybara/session.rb, line 807
def using_wait_time(seconds)
  if Capybara.threadsafe
    begin
      previous_wait_time = config.default_max_wait_time
      config.default_max_wait_time = seconds
      yield
    ensure
      config.default_max_wait_time = previous_wait_time
    end
  else
    Capybara.using_wait_time(seconds) { yield }
  end
end
visit(visit_uri) click to toggle source

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 the selenium driver 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

If {Capybara.always_include_port} is set to true and this session is running against a rack application, then the port that the rack application is running on will automatically be inserted into the URL. Supposing the app is running on port `4567`, doing something like:

visit("http://google.com/test")

Will actually navigate to `google.com:4567/test`.

@param [#to_s] visit_uri The URL to navigate to. The parameter will be cast to a String.

# File lib/capybara/session.rb, line 245
def visit(visit_uri)
  raise_server_error!
  @touched = true

  visit_uri = URI.parse(visit_uri.to_s)

  uri_base = if @server
    visit_uri.port = @server.port if config.always_include_port && (visit_uri.port == visit_uri.default_port)
    URI.parse(config.app_host || "http://#{@server.host}:#{@server.port}")
  else
    config.app_host && URI.parse(config.app_host)
  end

  # TODO - this is only for compatability with previous 2.x behavior that concatenated
  # Capybara.app_host and a "relative" path - Consider removing in 3.0
  # @abotalov brought up a good point about this behavior potentially being useful to people
  # deploying to a subdirectory and/or single page apps where only the url fragment changes
  if visit_uri.scheme.nil? && uri_base
    visit_uri.path = uri_base.path + visit_uri.path
  end

  visit_uri = uri_base.merge(visit_uri) unless uri_base.nil?

  driver.visit(visit_uri.to_s)
end
window_opened_by(options = {}, &block) click to toggle source

Get the window that has been opened by the passed block. It will wait for it to be opened (in the same way as other Capybara methods wait). It's better to use this method than `windows.last` {dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html#h_note_10 as order of windows isn't defined in some drivers}

@param options [Hash] @option options [Numeric] :wait (Capybara.default_max_wait_time) maximum wait time @return [Capybara::Window] the window that has been opened within a block @raise [Capybara::WindowError] if block passed to window hasn't opened window

or opened more than one window
# File lib/capybara/session.rb, line 591
def window_opened_by(options = {}, &block)
  old_handles = driver.window_handles
  block.call

  wait_time = Capybara::Queries::BaseQuery.wait(options, config.default_max_wait_time)
  document.synchronize(wait_time, errors: [Capybara::WindowError]) do
    opened_handles = (driver.window_handles - old_handles)
    if opened_handles.size != 1
      raise Capybara::WindowError, "block passed to #window_opened_by "                                        "opened #{opened_handles.size} windows instead of 1"
    end
    Window.new(self, opened_handles.first)
  end
end
windows() click to toggle source

Get all opened windows. The order of windows in returned array is not defined. The driver may sort windows by their creation time but it's not required.

@return [Array<Capybara::Window>] an array of all windows

# File lib/capybara/session.rb, line 446
def windows
  driver.window_handles.map do |handle|
    Window.new(self, handle)
  end
end
within(*args) { || ... } click to toggle source

Executes the given block within the context of a node. `within` takes the same options as `find`, as well as a block. For the duration of the block, any command to Capybara will be handled as though it were scoped to the given element.

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

Just as with `find`, if multiple elements match the selector given to `within`, an error will be raised, and just as with `find`, this behaviour can be controlled through the `:match` and `:exact` options.

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

Note that a lot of uses of `within` can be replaced more succinctly with chaining:

find('div#delivery-address').fill_in('Street', with: '12 Main Street')

@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 322
def within(*args)
  new_scope = if args.first.is_a?(Capybara::Node::Base) then args.first else find(*args) end
  begin
    scopes.push(new_scope)
    yield
  ensure
    scopes.pop
  end
end
Also aliased as: within_element
within_element(*args)
Alias for: within
within_fieldset(locator) { || ... } click to toggle source

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 339
def within_fieldset(locator)
  within :fieldset, locator do
    yield
  end
end
within_frame(*args) { || ... } click to toggle source

Execute the given block within the given iframe using given frame, frame name/id or index. May not be supported by all drivers.

@overload #within_frame(element)

@param [Capybara::Node::Element]  frame element

@overload #within_frame([kind = :frame], locator, options = {})

@param [Symobl] kind      Optional selector type (:css, :xpath, :field, etc.) - Defaults to :frame
@param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element

@overload #within_frame(index)

@param [Integer] index         index of a frame (0 based)
# File lib/capybara/session.rb, line 405
def within_frame(*args)
  frame = _find_frame(*args)

  begin
    switch_to_frame(frame)
    begin
      yield
    ensure
      switch_to_frame(:parent)
    end
  rescue Capybara::NotSupportedByDriverError
    # Support older driver frame API for now
    if driver.respond_to?(:within_frame)
      begin
        scopes.push(:frame)
        driver.within_frame(frame) do
          yield
        end
      ensure
        scopes.pop
      end
    else
      raise
    end
  end
end
within_table(locator) { || ... } click to toggle source

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 351
def within_table(locator)
  within :table, locator do
    yield
  end
end
within_window(window_or_handle) { || ... } click to toggle source

This method does the following:

  1. Switches to the given window (it can be located by window instance/lambda/string).

  2. Executes the given block (within window located at previous step).

  3. Switches back (this step will be invoked even if exception will happen at second step)

@overload #within_window(window) { do_something }

@param window [Capybara::Window]       instance of `Capybara::Window` class
  that will be switched to
@raise [driver#no_such_window_error] if unexistent (e.g. closed) window was passed

@overload #within_window(proc_or_lambda) { do_something }

@param lambda [Proc]                  lambda. First window for which lambda
  returns a value other than false or nil will be switched to.
@example
  within_window(->{ page.title == 'Page title' }) { click_button 'Submit' }
@raise [Capybara::WindowError]         if no window matching lambda was found

@overload #within_window(string) { do_something }

@deprecated                            Pass window or lambda instead
@param [String]                        handle, name, url or title of the window

@raise [Capybara::ScopeError] if this method is invoked inside `within`,

`within_frame` or `within_window` methods

@return value returned by the block

# File lib/capybara/session.rb, line 544
def within_window(window_or_handle)
  if window_or_handle.instance_of?(Capybara::Window)
    original = current_window
    switch_to_window(window_or_handle) unless original == window_or_handle
    scopes << nil
    begin
      yield
    ensure
      @scopes.pop
      switch_to_window(original) unless original == window_or_handle
    end
  elsif window_or_handle.is_a?(Proc)
    original = current_window
    switch_to_window { window_or_handle.call }
    scopes << nil
    begin
      yield
    ensure
      @scopes.pop
      switch_to_window(original)
    end
  else
    offending_line = caller.first
    file_line = offending_line.match(/^(.+?):(\d+)/)[0]
    warn "DEPRECATION WARNING: Passing string argument to #within_window is deprecated. "              "Pass window object or lambda. (called from #{file_line})"
    begin
      scopes << nil
      driver.within_window(window_or_handle) { yield }
    ensure
      @scopes.pop
    end
  end
end

Private Instance Methods

_find_frame(*args) click to toggle source
# File lib/capybara/session.rb, line 904
def _find_frame(*args)
  within(document) do  # Previous 2.x versions ignored current scope when finding frames - consider changing in 3.0
    case args[0]
    when Capybara::Node::Element
      args[0]
    when String, Hash
      find(:frame, *args)
    when Symbol
      find(*args)
    when Integer
      idx = args[0]
      all(:frame, minimum: idx+1)[idx]
    else
      raise TypeError
    end
  end
end
accept_modal(type, text_or_options, options, &blk) click to toggle source
# File lib/capybara/session.rb, line 846
def accept_modal(type, text_or_options, options, &blk)
  driver.accept_modal(type, modal_options(text_or_options, options), &blk)
end
default_fn(extension) click to toggle source
# File lib/capybara/session.rb, line 882
def default_fn(extension)
  timestamp = Time.new.strftime("%Y%m%d%H%M%S")
  "capybara-#{timestamp}#{rand(10**10)}.#{extension}"
end
dismiss_modal(type, text_or_options, options, &blk) click to toggle source
# File lib/capybara/session.rb, line 850
def dismiss_modal(type, text_or_options, options, &blk)
  driver.dismiss_modal(type, modal_options(text_or_options, options), &blk)
end
element_script_result(arg) click to toggle source
# File lib/capybara/session.rb, line 891
def element_script_result(arg)
  case arg
  when Array
    arg.map { |e| element_script_result(e) }
  when Hash
    arg.each { |k, v| arg[k] = element_script_result(v) }
  when Capybara::Driver::Node
    Capybara::Node::Element.new(self, arg, nil, nil)
  else
    arg
  end
end
modal_options(text_or_options, options) click to toggle source
open_file(path) click to toggle source
# File lib/capybara/session.rb, line 862
def open_file(path)
  begin
    require "launchy"
    Launchy.open(path)
  rescue LoadError
    warn "File saved to #{path}."
    warn "Please install the launchy gem to open the file automatically."
  end
end
prepare_path(path, extension) click to toggle source
# File lib/capybara/session.rb, line 872
def prepare_path(path, extension)
  if config.save_path || config.save_and_open_page_path.nil?
    path = File.expand_path(path || default_fn(extension), config.save_path)
  else
    path = File.expand_path(default_fn(extension), config.save_and_open_page_path) if path.nil?
  end
  FileUtils.mkdir_p(File.dirname(path))
  path
end
scopes() click to toggle source
# File lib/capybara/session.rb, line 887
def scopes
  @scopes ||= [nil]
end