module Capybara

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 365
def HTML(html) # rubocop:disable Naming/MethodName
  Nokogiri::HTML(html).tap do |document|
    document.xpath('//textarea').each do |textarea|
      textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '')
    end
  end
end

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 165
def add_selector(name, &block)
  Capybara::Selector.add(name, &block)
end

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/nil

The default host to use when giving a relative URL to visit, must be a valid URL e.g. www.example.com

always_include_port = Boolean

Whether the Rack server's port should automatically be inserted into every visited URL unless another port is explicitly specified (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 Capybara.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)

automatic_label_click = Boolean

Whether Node#choose, Node#check, Node#uncheck will attempt to click the associated label element if the checkbox/radio button are non-visible (Default: false)

enable_aria_label = Boolean

Whether fields, links, and buttons will match against aria-label attribute (Default: false)

reuse_server = Boolean

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

threadsafe = Boolean

Whether sessions can be configured individually (Default: false)

server = Symbol

The name of the registered server to use when running the app under test (Default: :webrick)

default_set_options = Hash

The default options passed to Node::set (Default: {})

test_id = Symbol/String/nil

Optional attribute to match locator aginst with builtin selectors along with id (Default: nil)

predicates_wait = Boolean

Whether Capybaras predicate matchers use waiting behavior by default (Default: true)

default_normalize_ws = Boolean

Whether text predicates and matchers use normalize whitespace behaviour (Default: false)

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 97
def configure
  yield config
end

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

# File lib/capybara.rb, line 246
def current_driver
  if threadsafe
    Thread.current['capybara_current_driver']
  else
    @current_driver
  end || default_driver
end

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

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

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

Modify a selector previously created by {Capybara.add_selector}. For example, adding a new filter to the :button selector to filter based on button style (a class) might look like this

Capybara.modify_selector(:button) do
  filter (:style, valid_values: [:primary, :secondary]) { |node, style| node[:class].split.include? "btn-#{style}" }
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 183
def modify_selector(name, &block)
  Capybara::Selector.update(name, &block)
end

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 114
def register_driver(name, &block)
  drivers[name] = block
end

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

# File lib/capybara.rb, line 133
def register_server(name, &block)
  servers[name.to_sym] = block
end

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

# File lib/capybara.rb, line 310
def reset_sessions!
  # reset in reverse so sessions that started servers are reset last
  session_pool.reverse_each { |_mode, session| session.reset! }
end

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 [Integer] port The port to run the application on

# File lib/capybara.rb, line 238
def run_default_server(app, port)
  servers[:puma].call(app, port, server_host)
end

The current session name.

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

# File lib/capybara.rb, line 322
def session_name
  if threadsafe
    Thread.current['capybara_session_name'] ||= :default
  else
    @session_name ||= :default
  end
end

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 225
def string(html)
  Capybara::Node::Simple.new(html)
end

Use the default driver as the current driver

# File lib/capybara.rb, line 267
def use_default_driver
  self.current_driver = nil
end

Yield a block using a specific driver

# File lib/capybara.rb, line 275
def using_driver(driver)
  previous_driver = Capybara.current_driver
  Capybara.current_driver = driver
  yield
ensure
  self.current_driver = previous_driver
end

Yield a block using a specific session name.

# File lib/capybara.rb, line 342
def using_session(name)
  previous_session_info = {
    session_name: session_name,
    current_driver: current_driver,
    app: app
  }
  self.session_name = name
  yield
ensure
  self.session_name = previous_session_info[:session_name]
  if threadsafe
    self.current_driver = previous_session_info[:current_driver]
    self.app = previous_session_info[:app]
  end
end

Yield a block using a specific wait time

# File lib/capybara.rb, line 287
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