Module: Capybara

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

Defined Under Namespace

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

Constant Summary

VERSION =
'2.4.1'

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



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

def always_include_port
  @always_include_port
end

.appObject

Returns the value of attribute app



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

def app
  @app
end

.app_hostObject

Returns the value of attribute app_host



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

def app_host
  @app_host
end

.asset_hostObject

Returns the value of attribute asset_host



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

def asset_host
  @asset_host
end

.automatic_reloadObject

Returns the value of attribute automatic_reload



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

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



188
189
190
# File 'lib/capybara.rb', line 188

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



180
181
182
# File 'lib/capybara.rb', line 180

def default_driver
  @default_driver || :rack_test
end

.default_hostObject

Returns the value of attribute default_host



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

def default_host
  @default_host
end

.default_selectorObject

Returns the value of attribute default_selector



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

def default_selector
  @default_selector
end

.default_wait_timeObject

Returns the value of attribute default_wait_time



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

def default_wait_time
  @default_wait_time
end

.exactObject

Returns the value of attribute exact



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

def exact
  @exact
end

.exact_optionsObject

Returns the value of attribute exact_options



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

def exact_options
  @exact_options
end

.ignore_hidden_elementsObject

Returns the value of attribute ignore_hidden_elements



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

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



197
198
199
# File 'lib/capybara.rb', line 197

def javascript_driver
  @javascript_driver || :selenium
end

.matchObject

Returns the value of attribute match



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

def match
  @match
end

.raise_server_errorsObject

Returns the value of attribute raise_server_errors



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

def raise_server_errors
  @raise_server_errors
end

.run_serverObject

Returns the value of attribute run_server



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

def run_server
  @run_server
end

.save_and_open_page_pathObject

Returns the value of attribute save_and_open_page_path



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

def save_and_open_page_path
  @save_and_open_page_path
end

.server_hostString

Returns The IP address bound by default server

Returns:

  • (String)

    The IP address bound by default server



225
226
227
# File 'lib/capybara.rb', line 225

def server_host
  @server_host || '127.0.0.1'
end

.server_portObject

Returns the value of attribute server_port



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

def server_port
  @server_port
end

.session_nameSymbol

The current session name.

Returns:

  • (Symbol)

    The name of the currently used session.



267
268
269
# File 'lib/capybara.rb', line 267

def session_name
  @session_name ||= :default
end

.visible_text_onlyObject

Returns the value of attribute visible_text_only



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

def visible_text_only
  @visible_text_only
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



106
107
108
# File 'lib/capybara.rb', line 106

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

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)

default_selector = :css/:xpath

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

default_wait_time = Integer

The 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_and_open_page_path = String

Where to put pages saved through save_and_open_page (Default: Dir.pwd)

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



57
58
59
# File 'lib/capybara.rb', line 57

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:



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

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

.deprecate(method, alternate_method) ⇒ Object



302
303
304
# File 'lib/capybara.rb', line 302

def deprecate(method, alternate_method)
  warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
end

.driversObject



110
111
112
# File 'lib/capybara.rb', line 110

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



289
290
291
292
293
294
295
# File 'lib/capybara.rb', line 289

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



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

def included(base)
  base.send(:include, Capybara::DSL)
  warn "`include Capybara` is deprecated. Please use `include Capybara::DSL` instead."
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 agains. May be nil.

Yield Returns:



74
75
76
# File 'lib/capybara.rb', line 74

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



256
257
258
# File 'lib/capybara.rb', line 256

def reset_sessions!
  session_pool.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



171
172
173
174
# File 'lib/capybara.rb', line 171

def run_default_server(app, port)
  require 'rack/handler/webrick'
  Rack::Handler::WEBrick.run(app, :Host => server_host, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
end

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

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

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

By default, Capybara will try to run webrick.

Yields:

  • (app, port)

    This block receives a rack app and port and should run a Rack handler



127
128
129
130
131
132
133
# File 'lib/capybara.rb', line 127

def server(&block)
  if block_given?
    @server = block
  else
    @server
  end
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. For example:

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:



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

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

.use_default_driverObject

Use the default driver as the current driver



205
206
207
# File 'lib/capybara.rb', line 205

def use_default_driver
  @current_driver = nil
end

.using_driver(driver) ⇒ Object

Yield a block using a specific driver



213
214
215
216
217
218
219
# File 'lib/capybara.rb', line 213

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.



275
276
277
278
279
280
# File 'lib/capybara.rb', line 275

def using_session(name)
  self.session_name = name
  yield
ensure
  self.session_name = :default
end

.using_wait_time(seconds) ⇒ Object

Yield a block using a specific wait time



233
234
235
236
237
238
239
# File 'lib/capybara.rb', line 233

def using_wait_time(seconds)
  previous_wait_time = Capybara.default_wait_time
  Capybara.default_wait_time = seconds
  yield
ensure
  Capybara.default_wait_time = previous_wait_time
end