module Capybara

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

Constants

Query

@deprecated This class and its methods are not supposed to be used by users of Capybara's public API.

It may be removed in future versions of Capybara.
VERSION

Attributes

always_include_port[RW]
app[RW]
app_host[RW]
asset_host[RW]
automatic_reload[RW]
current_driver[W]
default_driver[W]
default_host[RW]
default_max_wait_time[RW]
default_selector[RW]
exact[RW]
exact_options[RW]
ignore_hidden_elements[RW]
javascript_driver[W]
match[RW]
raise_server_errors[RW]
reuse_server[RW]
run_server[RW]
save_and_open_page_path[R]
save_path[RW]
server_errors[RW]
server_host[W]
server_port[RW]
session_name[W]
visible_text_only[RW]
wait_on_first_by_default[RW]

Public Class Methods

HTML(html) click to toggle source

Parse raw html into a document using Nokogiri, and adjust textarea contents as defined by the spec.

@param [String] html The raw html @return [Nokogiri::HTML::Document] ::HTML document

# File lib/capybara.rb, line 364
def HTML(html)
  Nokogiri::HTML(html).tap do |document|
    document.xpath('//textarea').each do |textarea|
      textarea.content=textarea.content.sub(/\A\n/,'')
    end
  end
end
add_selector(name, &block) click to toggle source

Add a new selector to Capybara. Selectors can be used by various methods in Capybara to find certain elements on the page in a more convenient way. For example adding a selector to find certain table rows might look like this:

Capybara.add_selector(:row) do
  xpath { |num| ".//tbody/tr[#{num}]" }
end

This makes it possible to use this selector in a variety of ways:

find(:row, 3)
page.find('table#myTable').find(:row, 3).text
page.find('table#myTable').has_selector?(:row, 3)
within(:row, 3) { expect(page).to have_content('$100.000') }

Here is another example:

Capybara.add_selector(:id) do
  xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
end

Note that this particular selector already ships with Capybara.

@param [Symbol] name The name of the selector to add @yield A block executed in the context of the new {Capybara::Selector}

# File lib/capybara.rb, line 132
def add_selector(name, &block)
  Capybara::Selector.add(name, &block)
end
configure() { |self| ... } click to toggle source

Configure Capybara to suit your needs.

Capybara.configure do |config|
  config.run_server = false
  config.app_host   = 'http://www.google.com'
end

Configurable options

::app_host = String

The default host to use when giving a relative URL to visit

::always_include_port = Boolean

Whether the Rack server's port should automatically be inserted into every visited URL (Default: false)

::asset_host = String

Where dynamic assets are hosted - will be prepended to relative asset locations if present (Default: nil)

::run_server = Boolean

Whether to start a Rack server for the given Rack app (Default: true)

::raise_server_errors = Boolean

Should errors raised in the server be raised in the tests? (Default: true)

::server_errors = Array<Class>

Error classes that should be raised in the tests if they are raised in the server and ::raise_server_errors is true (Default: [StandardError])

::default_selector = :css/:xpath

Methods which take a selector use the given type by default (Default: :css)

::default_max_wait_time = Numeric

The maximum number of seconds to wait for asynchronous processes to finish (Default: 2)

::ignore_hidden_elements = Boolean

Whether to ignore hidden elements on the page (Default: true)

::automatic_reload = Boolean

Whether to automatically reload elements as Capybara is waiting (Default: true)

::save_path = String

Where to put pages saved through save_(page|screenshot), save_and_open_(page|screenshot) (Default: Dir.pwd)

::wait_on_first_by_default = Boolean

Whether Node#first defaults to Capybara waiting behavior for at least 1 element to match (Default: false)

::reuse_server = Boolean

Reuse the server thread between multiple sessions using the same app object (Default: true)

DSL Options

when using capybara/dsl, the following options are also available:

::default_driver = Symbol

The name of the driver to use by default. (Default: :rack_test)

::javascript_driver = Symbol

The name of a driver to use for JavaScript enabled tests. (Default: :selenium)

# File lib/capybara.rb, line 63
def configure
  yield self
end
current_driver() click to toggle source

@return [Symbol] The name of the driver currently in use

# File lib/capybara.rb, line 261
def current_driver
  @current_driver || default_driver
end
Also aliased as: mode
current_session() click to toggle source

The current Capybara::Session based on what is set as ::app and ::current_driver

@return [Capybara::Session] The currently used session

# File lib/capybara.rb, line 320
def current_session
  session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
end
default_driver() click to toggle source

@return [Symbol] The name of the driver to use by default

# File lib/capybara.rb, line 253
def default_driver
  @default_driver || :rack_test
end
default_wait_time() click to toggle source

@deprecated Use ::default_max_wait_time instead

# File lib/capybara.rb, line 373
def default_wait_time
  deprecate('default_wait_time', 'default_max_wait_time', true)
  default_max_wait_time
end
default_wait_time=(t) click to toggle source

@deprecated Use ::default_max_wait_time= instead

# File lib/capybara.rb, line 379
def default_wait_time=(t)
  deprecate('default_wait_time=', 'default_max_wait_time=')
  self.default_max_wait_time = t
end
deprecate(method, alternate_method, once=false) click to toggle source
# File lib/capybara.rb, line 400
def deprecate(method, alternate_method, once=false)
  @deprecation_notified ||= {}
  warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once and @deprecation_notified[method]
  @deprecation_notified[method]=true
end
drivers() click to toggle source
# File lib/capybara.rb, line 153
def drivers
  @drivers ||= {}
end
included(base) click to toggle source
# File lib/capybara.rb, line 390
def included(base)
  base.send(:include, Capybara::DSL)
  warn "`include Capybara` is deprecated. Please use `include Capybara::DSL` instead."
end
javascript_driver() click to toggle source

@return [Symbol] The name of the driver used when JavaScript is needed

# File lib/capybara.rb, line 270
def javascript_driver
  @javascript_driver || :selenium
end
mode()
Alias for: current_driver
modify_selector(name, &block) click to toggle source

Modify a selector previously created by {Capybara.add_selector}. For example modifying the :button selector to also find divs styled to look like buttons might look like this

Capybara.modify_selector(:button) do
  xpath { |locator| XPath::HTML.button(locator).or(XPath::css('div.btn')[XPath::string.n.is(locator)]) }
end

@param [Symbol] name The name of the selector to modify @yield A block executed in the context of the existing {Capybara::Selector}

# File lib/capybara.rb, line 149
def modify_selector(name, &block)
  Capybara::Selector.update(name, &block)
end
register_driver(name, &block) click to toggle source

Register a new driver for Capybara.

Capybara.register_driver :rack_test do |app|
  Capybara::RackTest::Driver.new(app)
end

@param [Symbol] name The name of the new driver @yield [app] This block takes a rack app and returns a Capybara driver @yieldparam [<Rack>] app The rack application that this driver runs against. May be nil. @yieldreturn [Capybara::Driver::Base] A Capybara driver instance

# File lib/capybara.rb, line 80
def register_driver(name, &block)
  drivers[name] = block
end
register_server(name, &block) click to toggle source

Register a new server for Capybara.

Capybara.register_server :webrick do |app, port, host|
  require 'rack/handler/webrick'
  Rack::Handler::WEBrick.run(app, ...)
end

@param [Symbol] name The name of the new driver @yield [app, port, host] This block takes a rack app and a port and returns a rack server listening on that port @yieldparam [<Rack>] app The rack application that this server will contain. @yieldparam port The port number the server should listen on @yieldparam host The host/ip to bind to @yieldreturn [Capybara::Driver::Base] A Capybara driver instance

# File lib/capybara.rb, line 100
def register_server(name, &block)
  servers[name.to_sym] = block
end
reset!()
Alias for: reset_sessions!
reset_sessions!() click to toggle source

Reset sessions, cleaning out the pool of sessions. This will remove any session information such as cookies.

# File lib/capybara.rb, line 329
def reset_sessions!
  #reset in reverse so sessions that started servers are reset last
  session_pool.reverse_each { |mode, session| session.reset! }
end
Also aliased as: reset!
reuse_server=(bool) click to toggle source
# File lib/capybara.rb, line 395
def reuse_server=(bool)
  warn "Capybara.reuse_server == false is a BETA feature and may change in a future version" unless bool
  @reuse_server = bool
end
run_default_server(app, port) click to toggle source

Runs Capybara's default server for the given application and port under most circumstances you should not have to call this method manually.

@param [Rack Application] app The rack application to run @param [Fixnum] port The port to run the application on

# File lib/capybara.rb, line 245
def run_default_server(app, port)
  servers[:webrick].call(app, port, server_host)
end
save_and_open_page_path=(path) click to toggle source
# File lib/capybara.rb, line 384
def save_and_open_page_path=(path)
  warn "DEPRECATED: #save_and_open_page_path is deprecated, please use #save_path instead. \n"            "Note: Behavior is slightly different with relative paths - see documentation" unless path.nil?
  @save_and_open_page_path = path
end
server(&block) click to toggle source

Register a proc that Capybara will call to run the Rack application.

Capybara.server do |app, port, host|
  require 'rack/handler/mongrel'
  Rack::Handler::Mongrel.run(app, :Port => port)
end

By default, Capybara will try to run webrick.

@yield [app, port, host] This block receives a rack app, port, and host/ip and should run a Rack handler

# File lib/capybara.rb, line 174
def server(&block)
  if block_given?
    warn "DEPRECATED: Passing a block to Capybara::server is deprecated, please use Capybara::register_server instead"
    @server = block
  else
    @server
  end
end
server=(name) click to toggle source

Set the server to use.

Capybara.server = :webrick

@param [Symbol] name Name of the server type to use @see ::register_server

# File lib/capybara.rb, line 192
def server=(name)
  @server = if name.respond_to? :call
    name
  else
    servers[name.to_sym]
  end
end
server_host() click to toggle source

@return [String] The IP address bound by default server

# File lib/capybara.rb, line 298
def server_host
  @server_host || '127.0.0.1'
end
servers() click to toggle source
# File lib/capybara.rb, line 157
def servers
  @servers ||= {}
end
session_name() click to toggle source

The current session name.

@return [Symbol] The name of the currently used session.

# File lib/capybara.rb, line 341
def session_name
  @session_name ||= :default
end
string(html) click to toggle source

Wraps the given string, which should contain an ::HTML document or fragment in a {Capybara::Node::Simple} which exposes all {Capybara::Node::Matchers}, {Capybara::Node::Finders} and {Capybara::Node::DocumentMatchers}. This allows you to query any string containing ::HTML in the exact same way you would query the current document in a Capybara session.

Example: A single element

node = Capybara.string('<a href="foo">bar</a>')
anchor = node.first('a')
anchor[:href] #=> 'foo'
anchor.text #=> 'bar'

Example: Multiple elements

node = Capybara.string <<-HTML
  <ul>
    <li id="home">Home</li>
    <li id="projects">Projects</li>
  </ul>
HTML

node.find('#projects').text # => 'Projects'
node.has_selector?('li#home', :text => 'Home')
node.has_selector?('#projects')
node.find('ul').find('li:first-child').text # => 'Home'

@param [String] html An html fragment or document @return [Capybara::Node::Simple] A node which has Capybara's finders and matchers

# File lib/capybara.rb, line 232
def string(html)
  Capybara::Node::Simple.new(html)
end
use_default_driver() click to toggle source

Use the default driver as the current driver

# File lib/capybara.rb, line 278
def use_default_driver
  @current_driver = nil
end
using_driver(driver) { || ... } click to toggle source

Yield a block using a specific driver

# File lib/capybara.rb, line 286
def using_driver(driver)
  previous_driver = Capybara.current_driver
  Capybara.current_driver = driver
  yield
ensure
  @current_driver = previous_driver
end
using_session(name) { || ... } click to toggle source

Yield a block using a specific session name.

# File lib/capybara.rb, line 349
def using_session(name)
  previous_session_name = self.session_name
  self.session_name = name
  yield
ensure
  self.session_name = previous_session_name
end
using_wait_time(seconds) { || ... } click to toggle source

Yield a block using a specific wait time

# File lib/capybara.rb, line 306
def using_wait_time(seconds)
  previous_wait_time = Capybara.default_max_wait_time
  Capybara.default_max_wait_time = seconds
  yield
ensure
  Capybara.default_max_wait_time = previous_wait_time
end

Private Class Methods

session_pool() click to toggle source
# File lib/capybara.rb, line 408
def session_pool
  @session_pool ||= {}
end