Module: Capybara
- Extended by:
- DSL, Forwardable
- Defined in:
- lib/capybara.rb,
lib/capybara/dsl.rb,
lib/capybara/config.rb,
lib/capybara/result.rb,
lib/capybara/server.rb,
lib/capybara/window.rb,
lib/capybara/helpers.rb,
lib/capybara/session.rb,
lib/capybara/version.rb,
lib/capybara/minitest.rb,
lib/capybara/node/base.rb,
lib/capybara/driver/node.rb,
lib/capybara/node/simple.rb,
lib/capybara/node/actions.rb,
lib/capybara/node/element.rb,
lib/capybara/node/finders.rb,
lib/capybara/selector/css.rb,
lib/capybara/minitest/spec.rb,
lib/capybara/node/document.rb,
lib/capybara/node/matchers.rb,
lib/capybara/rspec/matchers.rb,
lib/capybara/server/checker.rb,
lib/capybara/session/config.rb,
lib/capybara/session/matchers.rb,
lib/capybara/spec/spec_helper.rb,
lib/capybara/selector/selector.rb,
lib/capybara/server/middleware.rb,
lib/capybara/queries/base_query.rb,
lib/capybara/queries/text_query.rb,
lib/capybara/queries/match_query.rb,
lib/capybara/queries/style_query.rb,
lib/capybara/queries/title_query.rb,
lib/capybara/rspec/matchers/base.rb,
lib/capybara/selector/filter_set.rb,
lib/capybara/queries/sibling_query.rb,
lib/capybara/rspec/matcher_proxies.rb,
lib/capybara/selector/filters/base.rb,
lib/capybara/node/document_matchers.rb,
lib/capybara/queries/ancestor_query.rb,
lib/capybara/queries/selector_query.rb,
lib/capybara/rspec/matchers/compound.rb,
lib/capybara/rspec/matchers/have_text.rb,
lib/capybara/rspec/matchers/have_style.rb,
lib/capybara/rspec/matchers/have_title.rb,
lib/capybara/server/animation_disabler.rb,
lib/capybara/queries/current_path_query.rb,
lib/capybara/rspec/matchers/become_closed.rb,
lib/capybara/rspec/matchers/have_selector.rb,
lib/capybara/selector/filters/node_filter.rb,
lib/capybara/selector/regexp_disassembler.rb,
lib/capybara/rspec/matchers/match_selector.rb,
lib/capybara/selector/builders/css_builder.rb,
lib/capybara/selector/builders/xpath_builder.rb,
lib/capybara/selector/filters/locator_filter.rb,
lib/capybara/rspec/matchers/have_current_path.rb,
lib/capybara/selector/filters/expression_filter.rb
Defined Under Namespace
Modules: DSL, DSLRSpecProxyInstaller, Driver, Helpers, Minitest, Node, Queries, RSpecMatcherProxies, RSpecMatcherProxyInstaller, RSpecMatchers, RackTest, Selenium, SessionMatchers, SpecHelper Classes: Ambiguous, CapybaraError, Config, DriverNotFoundError, ElementNotFound, ExpectationNotMet, FileNotFound, FrozenInTime, InfiniteRedirectError, ModalNotFound, NotSupportedByDriverError, ReadOnlyElementError, ReadOnlySessionConfig, Result, ScopeError, Selector, Server, Session, SessionConfig, UnselectNotAllowed, Window, WindowError
Constant Summary collapse
- VERSION =
'3.12.0'
Class Method Summary collapse
-
.add_selector(name) { ... } ⇒ Object
Add a new selector to Capybara.
-
.always_include_port ⇒ Object
See Capybara.configure.
-
.app ⇒ Object
See Capybara.configure.
-
.app_host ⇒ Object
See Capybara.configure.
-
.configure {|config| ... } ⇒ Object
Configure Capybara to suit your needs.
-
.current_driver ⇒ Symbol
(also: mode)
The name of the driver currently in use.
- .current_driver=(name) ⇒ Object
-
.current_session ⇒ Capybara::Session
The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver.
-
.default_driver ⇒ Object
See Capybara.configure.
-
.default_max_wait_time ⇒ Object
See Capybara.configure.
-
.default_selector ⇒ Object
See Capybara.configure.
- .drivers ⇒ Object
-
.HTML(html) ⇒ Nokogiri::HTML::Document
Parse raw html into a document using Nokogiri, and adjust textarea contents as defined by the spec.
-
.javascript_driver ⇒ Object
See Capybara.configure.
-
.modify_selector(name) { ... } ⇒ Object
Modify a selector previously created by Capybara.add_selector.
-
.register_driver(name) {|app| ... } ⇒ Object
Register a new driver for Capybara.
-
.register_server(name) {|app, port, host| ... } ⇒ Object
Register a new server for Capybara.
-
.reset_sessions! ⇒ Object
(also: reset!)
Reset sessions, cleaning out the pool of sessions.
-
.reuse_server ⇒ Object
See Capybara.configure.
-
.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.
-
.server ⇒ Object
See Capybara.configure.
- .servers ⇒ Object
-
.session_name ⇒ Symbol
The current session name.
- .session_name=(name) ⇒ Object
- .session_options ⇒ Object
-
.string(html) ⇒ Capybara::Node::Simple
Wraps the given string, which should contain an HTML document or fragment in a Node::Simple which exposes all Node::Matchers, Node::Finders and Node::DocumentMatchers.
-
.threadsafe ⇒ Object
See Capybara.configure.
-
.use_default_driver ⇒ Object
Use the default driver as the current driver.
-
.using_driver(driver) ⇒ Object
Yield a block using a specific driver.
-
.using_session(name_or_session) ⇒ Object
Yield a block using a specific session name or Capybara::Session instance.
-
.using_wait_time(seconds) ⇒ Object
Yield a block using a specific wait time.
Methods included from DSL
extended, included, page, using_session, using_wait_time
Methods included from DSLRSpecProxyInstaller
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.
165 166 167 |
# File 'lib/capybara.rb', line 165 def add_selector(name, &block) Capybara::Selector.add(name, &block) end |
.always_include_port ⇒ Object
See configure
54 55 56 |
# File 'lib/capybara.rb', line 54 SessionConfig::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.app ⇒ Object
See configure
41 42 43 |
# File 'lib/capybara.rb', line 41 Config::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.app_host ⇒ Object
See configure
54 55 56 |
# File 'lib/capybara.rb', line 54 SessionConfig::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.configure {|config| ... } ⇒ 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 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)
97 98 99 |
# File 'lib/capybara.rb', line 97 def configure yield config end |
.current_driver ⇒ Symbol Also known as: mode
Returns The name of the driver currently in use.
246 247 248 249 250 251 252 |
# File 'lib/capybara.rb', line 246 def current_driver if threadsafe Thread.current['capybara_current_driver'] else @current_driver end || default_driver end |
.current_driver=(name) ⇒ Object
255 256 257 258 259 260 261 |
# File 'lib/capybara.rb', line 255 def current_driver=(name) if threadsafe Thread.current['capybara_current_driver'] = name else @current_driver = name end end |
.current_session ⇒ Capybara::Session
The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver
301 302 303 |
# File 'lib/capybara.rb', line 301 def current_session specified_session || session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] end |
.default_driver ⇒ Object
See configure
41 42 43 |
# File 'lib/capybara.rb', line 41 Config::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.default_max_wait_time ⇒ Object
See configure
54 55 56 |
# File 'lib/capybara.rb', line 54 SessionConfig::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.default_selector ⇒ Object
See configure
54 55 56 |
# File 'lib/capybara.rb', line 54 SessionConfig::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.drivers ⇒ Object
187 188 189 |
# File 'lib/capybara.rb', line 187 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.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
# File 'lib/capybara.rb', line 368 def HTML(html) # rubocop:disable Naming/MethodName if Nokogiri.respond_to?(:HTML5) # Nokogumbo installed Nokogiri::HTML5(html).tap do |document| document.xpath('//textarea').each do |textarea| # The Nokogumbo HTML5 parser already returns spec compliant contents textarea['_capybara_raw_value'] = textarea.content end end else Nokogiri::HTML(html).tap do |document| document.xpath('//textarea').each do |textarea| textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '') end end end end |
.javascript_driver ⇒ Object
See configure
41 42 43 |
# File 'lib/capybara.rb', line 41 Config::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.modify_selector(name) { ... } ⇒ Object
Modify a selector previously created by 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
183 184 185 |
# File 'lib/capybara.rb', line 183 def modify_selector(name, &block) Capybara::Selector.update(name, &block) end |
.register_driver(name) {|app| ... } ⇒ Object
114 115 116 |
# File 'lib/capybara.rb', line 114 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
133 134 135 |
# File 'lib/capybara.rb', line 133 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.
310 311 312 313 |
# 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 |
.reuse_server ⇒ Object
See configure
41 42 43 |
# File 'lib/capybara.rb', line 41 Config::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" 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.
238 239 240 |
# File 'lib/capybara.rb', line 238 def run_default_server(app, port) servers[:puma].call(app, port, server_host) end |
.server ⇒ Object
See configure
41 42 43 |
# File 'lib/capybara.rb', line 41 Config::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.servers ⇒ Object
191 192 193 |
# File 'lib/capybara.rb', line 191 def servers @servers ||= {} end |
.session_name ⇒ Symbol
The current session name.
322 323 324 325 326 327 328 |
# File 'lib/capybara.rb', line 322 def session_name if threadsafe Thread.current['capybara_session_name'] ||= :default else @session_name ||= :default end end |
.session_name=(name) ⇒ Object
330 331 332 333 334 335 336 |
# File 'lib/capybara.rb', line 330 def session_name=(name) if threadsafe Thread.current['capybara_session_name'] = name else @session_name = name end end |
.session_options ⇒ Object
385 386 387 |
# File 'lib/capybara.rb', line 385 def config. 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'
225 226 227 |
# File 'lib/capybara.rb', line 225 def string(html) Capybara::Node::Simple.new(html) end |
.threadsafe ⇒ Object
See configure
41 42 43 |
# File 'lib/capybara.rb', line 41 Config::OPTIONS.each do |method| def_delegators :config, method, "#{method}=" end |
.use_default_driver ⇒ Object
Use the default driver as the current driver
267 268 269 |
# File 'lib/capybara.rb', line 267 def use_default_driver self.current_driver = nil end |
.using_driver(driver) ⇒ Object
Yield a block using a specific driver
275 276 277 278 279 280 281 |
# 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 |
.using_session(name_or_session) ⇒ Object
Yield a block using a specific session name or Capybara::Session instance.
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/capybara.rb', line 342 def using_session(name_or_session) previous_session_info = { specified_session: specified_session, session_name: session_name, current_driver: current_driver, app: app } self.specified_session = self.session_name = nil if name_or_session.is_a? Capybara::Session self.specified_session = name_or_session else self.session_name = name_or_session end yield ensure self.session_name, self.specified_session = previous_session_info.values_at(:session_name, :specified_session) self.current_driver, self.app = previous_session_info.values_at(:current_driver, :app) if threadsafe end |
.using_wait_time(seconds) ⇒ Object
Yield a block using a specific wait time
287 288 289 290 291 292 293 |
# 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 |