Module: Capybara

Extended by:
DSL
Defined in:
lib/capybara/window.rb,
lib/capybara.rb,
lib/capybara/dsl.rb,
lib/capybara/query.rb,
lib/capybara/result.rb,
lib/capybara/server.rb,
lib/capybara/helpers.rb,
lib/capybara/version.rb,
lib/capybara/session.rb,
lib/capybara/selector.rb,
lib/capybara/node/base.rb,
lib/capybara/node/simple.rb,
lib/capybara/driver/node.rb,
lib/capybara/node/finders.rb,
lib/capybara/node/element.rb,
lib/capybara/node/actions.rb,
lib/capybara/node/document.rb,
lib/capybara/node/matchers.rb,
lib/capybara/rspec/features.rb,
lib/capybara/rspec/matchers.rb,
lib/capybara/selector/filter.rb,
lib/capybara/session/matchers.rb,
lib/capybara/spec/spec_helper.rb,
lib/capybara/queries/text_query.rb,
lib/capybara/queries/base_query.rb,
lib/capybara/queries/match_query.rb,
lib/capybara/queries/title_query.rb,
lib/capybara/selector/filter_set.rb,
lib/capybara/node/document_matchers.rb,
lib/capybara/queries/selector_query.rb,
lib/capybara/queries/current_path_query.rb

Overview

frozen_string_literal: true

Defined Under Namespace

Modules: DSL, Driver, Features, Helpers, Node, Queries, RSpecMatchers, RackTest, Selenium, SessionMatchers, SpecHelper Classes: Ambiguous, CapybaraError, DriverNotFoundError, ElementNotFound, ExpectationNotMet, FileNotFound, FrozenInTime, InfiniteRedirectError, ModalNotFound, NotSupportedByDriverError, ReadOnlyElementError, Result, ScopeError, Selector, Server, Session, UnselectNotAllowed, Window, WindowError

Constant Summary

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.

Queries::SelectorQuery
VERSION =
'2.8.0.dev'

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from DSL

extended, page, using_session, using_wait_time

Class Attribute Details

.always_include_portObject

Returns the value of attribute always_include_port



24
25
26
# File 'lib/capybara.rb', line 24

def always_include_port
  @always_include_port
end

.appObject

Returns the value of attribute app



31
32
33
# File 'lib/capybara.rb', line 31

def app
  @app
end

.app_hostObject

Returns the value of attribute app_host



23
24
25
# File 'lib/capybara.rb', line 23

def app_host
  @app_host
end

.asset_hostObject

Returns the value of attribute asset_host



24
25
26
# File 'lib/capybara.rb', line 24

def asset_host
  @asset_host
end

.automatic_reloadObject

Returns the value of attribute automatic_reload



27
28
29
# File 'lib/capybara.rb', line 27

def automatic_reload
  @automatic_reload
end

.current_driverSymbol Also known as: mode

Returns The name of the driver currently in use

Returns:

  • (Symbol)

    The name of the driver currently in use



262
263
264
# File 'lib/capybara.rb', line 262

def current_driver
  @current_driver || default_driver
end

.default_driverSymbol

Returns The name of the driver to use by default

Returns:

  • (Symbol)

    The name of the driver to use by default



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

def default_driver
  @default_driver || :rack_test
end

.default_hostObject

Returns the value of attribute default_host



23
24
25
# File 'lib/capybara.rb', line 23

def default_host
  @default_host
end

.default_max_wait_timeObject

Returns the value of attribute default_max_wait_time



26
27
28
# File 'lib/capybara.rb', line 26

def default_max_wait_time
  @default_max_wait_time
end

.default_selectorObject

Returns the value of attribute default_selector



26
27
28
# File 'lib/capybara.rb', line 26

def default_selector
  @default_selector
end

.exactObject

Returns the value of attribute exact



25
26
27
# File 'lib/capybara.rb', line 25

def exact
  @exact
end

.exact_optionsObject

Returns the value of attribute exact_options



25
26
27
# File 'lib/capybara.rb', line 25

def exact_options
  @exact_options
end

.ignore_hidden_elementsObject

Returns the value of attribute ignore_hidden_elements



26
27
28
# File 'lib/capybara.rb', line 26

def ignore_hidden_elements
  @ignore_hidden_elements
end

.javascript_driverSymbol

Returns The name of the driver used when JavaScript is needed

Returns:

  • (Symbol)

    The name of the driver used when JavaScript is needed



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

def javascript_driver
  @javascript_driver || :selenium
end

.matchObject

Returns the value of attribute match



25
26
27
# File 'lib/capybara.rb', line 25

def match
  @match
end

.raise_server_errorsObject

Returns the value of attribute raise_server_errors



28
29
30
# File 'lib/capybara.rb', line 28

def raise_server_errors
  @raise_server_errors
end

.reuse_serverObject

Returns the value of attribute reuse_server



28
29
30
# File 'lib/capybara.rb', line 28

def reuse_server
  @reuse_server
end

.run_serverObject

Returns the value of attribute run_server



24
25
26
# File 'lib/capybara.rb', line 24

def run_server
  @run_server
end

.save_and_open_page_pathObject

Returns the value of attribute save_and_open_page_path



30
31
32
# File 'lib/capybara.rb', line 30

def save_and_open_page_path
  @save_and_open_page_path
end

.save_pathObject

Returns the value of attribute save_path



27
28
29
# File 'lib/capybara.rb', line 27

def save_path
  @save_path
end

.server_errorsObject

Returns the value of attribute server_errors



28
29
30
# File 'lib/capybara.rb', line 28

def server_errors
  @server_errors
end

.server_hostString

Returns The IP address bound by default server

Returns:

  • (String)

    The IP address bound by default server



299
300
301
# File 'lib/capybara.rb', line 299

def server_host
  @server_host || '127.0.0.1'
end

.server_portObject

Returns the value of attribute server_port



25
26
27
# File 'lib/capybara.rb', line 25

def server_port
  @server_port
end

.session_nameSymbol

The current session name.

Returns:

  • (Symbol)

    The name of the currently used session.



342
343
344
# File 'lib/capybara.rb', line 342

def session_name
  @session_name ||= :default
end

.visible_text_onlyObject

Returns the value of attribute visible_text_only



25
26
27
# File 'lib/capybara.rb', line 25

def visible_text_only
  @visible_text_only
end

.wait_on_first_by_defaultObject

Returns the value of attribute wait_on_first_by_default



27
28
29
# File 'lib/capybara.rb', line 27

def wait_on_first_by_default
  @wait_on_first_by_default
end

Class Method Details

.add_selector(name) { ... } ⇒ Object

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.

Parameters:

  • name (Symbol)

    The name of the selector to add

Yields:

  • A block executed in the context of the new Selector



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

def add_selector(name, &block)
  Capybara::Selector.add(name, &block)
end

.configure {|_self| ... } ⇒ Object

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

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)

Yields:

  • (_self)

Yield Parameters:

  • _self (Capybara)

    the object that the method was called on



64
65
66
# File 'lib/capybara.rb', line 64

def configure
  yield self
end

.current_sessionCapybara::Session

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

Returns:



321
322
323
# File 'lib/capybara.rb', line 321

def current_session
  session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
end

.default_wait_timeObject

Deprecated.

Use default_max_wait_time instead



374
375
376
377
# File 'lib/capybara.rb', line 374

def default_wait_time
  deprecate('default_wait_time', 'default_max_wait_time', true)
  default_max_wait_time
end

.default_wait_time=(t) ⇒ Object

Deprecated.

Use default_max_wait_time= instead



380
381
382
383
# File 'lib/capybara.rb', line 380

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) ⇒ Object



411
412
413
414
415
# File 'lib/capybara.rb', line 411

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

.driversObject



154
155
156
# File 'lib/capybara.rb', line 154

def drivers
  @drivers ||= {}
end

.HTML(html) ⇒ Nokogiri::HTML::Document

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

Parameters:

  • html (String)

    The raw html

Returns:

  • (Nokogiri::HTML::Document)

    HTML document



365
366
367
368
369
370
371
# File 'lib/capybara.rb', line 365

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

.included(base) ⇒ Object



401
402
403
404
# File 'lib/capybara.rb', line 401

def included(base)
  base.send(:include, Capybara::DSL)
  warn "`include Capybara` is deprecated. Please use `include Capybara::DSL` instead."
end

.modify_selector(name) { ... } ⇒ Object

Modify a selector previously created by 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

Parameters:

  • name (Symbol)

    The name of the selector to modify

Yields:

  • A block executed in the context of the existing Selector



150
151
152
# File 'lib/capybara.rb', line 150

def modify_selector(name, &block)
  Capybara::Selector.update(name, &block)
end

.register_driver(name) {|app| ... } ⇒ Object

Register a new driver for Capybara.

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

Parameters:

  • name (Symbol)

    The name of the new driver

Yields:

  • (app)

    This block takes a rack app and returns a Capybara driver

Yield Parameters:

  • app (<Rack>)

    The rack application that this driver runs against. May be nil.

Yield Returns:



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

def register_driver(name, &block)
  drivers[name] = block
end

.register_server(name) {|app, port, host| ... } ⇒ Object

Register a new server for Capybara.

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

Parameters:

  • name (Symbol)

    The name of the new driver

Yields:

  • (app, port, host)

    This block takes a rack app and a port and returns a rack server listening on that port

Yield Parameters:

  • app (<Rack>)

    The rack application that this server will contain.

  • port

    The port number the server should listen on

  • host

    The host/ip to bind to

Yield Returns:



101
102
103
# File 'lib/capybara.rb', line 101

def register_server(name, &block)
  servers[name.to_sym] = block
end

.reset_sessions!Object Also known as: reset!

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



330
331
332
333
# File 'lib/capybara.rb', line 330

def reset_sessions!
  #reset in reverse so sessions that started servers are reset last
  session_pool.reverse_each { |mode, session| session.reset! }
end

.run_default_server(app, port) ⇒ Object

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

Parameters:

  • app (Rack Application)

    The rack application to run

  • port (Fixnum)

    The port to run the application on



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

def run_default_server(app, port)
  servers[:webrick].call(app, port, server_host)
end

.server {|app, port, host| ... } ⇒ Object

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.

Yields:

  • (app, port, host)

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



175
176
177
178
179
180
181
182
# File 'lib/capybara.rb', line 175

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) ⇒ Object

Set the server to use.

Capybara.server = :webrick

Parameters:

  • name (Symbol)

    Name of the server type to use

See Also:



193
194
195
196
197
198
199
# File 'lib/capybara.rb', line 193

def server=(name)
  @server = if name.respond_to? :call
    name
  else
    servers[name.to_sym]
  end
end

.serversObject



158
159
160
# File 'lib/capybara.rb', line 158

def servers
  @servers ||= {}
end

.string(html) ⇒ Capybara::Node::Simple

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'

Parameters:

  • html (String)

    An html fragment or document

Returns:



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

def string(html)
  Capybara::Node::Simple.new(html)
end

.use_default_driverObject

Use the default driver as the current driver



279
280
281
# File 'lib/capybara.rb', line 279

def use_default_driver
  @current_driver = nil
end

.using_driver(driver) ⇒ Object

Yield a block using a specific driver



287
288
289
290
291
292
293
# File 'lib/capybara.rb', line 287

def using_driver(driver)
  previous_driver = Capybara.current_driver
  Capybara.current_driver = driver
  yield
ensure
  @current_driver = previous_driver
end

.using_session(name) ⇒ Object

Yield a block using a specific session name.



350
351
352
353
354
355
356
# File 'lib/capybara.rb', line 350

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) ⇒ Object

Yield a block using a specific wait time



307
308
309
310
311
312
313
# File 'lib/capybara.rb', line 307

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