Module: Capybara
- Extended by:
- DSL
- Defined in:
- lib/capybara.rb,
lib/capybara/dsl.rb,
lib/capybara/query.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/selector.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/node/document.rb,
lib/capybara/node/matchers.rb,
lib/capybara/rspec/features.rb,
lib/capybara/rspec/matchers.rb,
lib/capybara/session/matchers.rb,
lib/capybara/spec/spec_helper.rb,
lib/capybara/queries/base_query.rb,
lib/capybara/queries/text_query.rb,
lib/capybara/queries/title_query.rb,
lib/capybara/node/document_matchers.rb,
lib/capybara/queries/current_path_query.rb
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, Query, ReadOnlyElementError, Result, ScopeError, Selector, Server, Session, UnselectNotAllowed, Window, WindowError
Constant Summary collapse
- VERSION =
'2.5.0'
Class Attribute Summary collapse
-
.always_include_port ⇒ Object
Returns the value of attribute always_include_port.
-
.app ⇒ Object
Returns the value of attribute app.
-
.app_host ⇒ Object
Returns the value of attribute app_host.
-
.asset_host ⇒ Object
Returns the value of attribute asset_host.
-
.automatic_reload ⇒ Object
Returns the value of attribute automatic_reload.
-
.current_driver ⇒ Symbol
(also: mode)
The name of the driver currently in use.
-
.default_driver ⇒ Symbol
The name of the driver to use by default.
-
.default_host ⇒ Object
Returns the value of attribute default_host.
-
.default_max_wait_time ⇒ Object
Returns the value of attribute default_max_wait_time.
-
.default_selector ⇒ Object
Returns the value of attribute default_selector.
-
.exact ⇒ Object
Returns the value of attribute exact.
-
.exact_options ⇒ Object
Returns the value of attribute exact_options.
-
.ignore_hidden_elements ⇒ Object
Returns the value of attribute ignore_hidden_elements.
-
.javascript_driver ⇒ Symbol
The name of the driver used when JavaScript is needed.
-
.match ⇒ Object
Returns the value of attribute match.
-
.raise_server_errors ⇒ Object
Returns the value of attribute raise_server_errors.
-
.run_server ⇒ Object
Returns the value of attribute run_server.
-
.save_and_open_page_path ⇒ Object
Returns the value of attribute save_and_open_page_path.
-
.server_errors ⇒ Object
Returns the value of attribute server_errors.
-
.server_host ⇒ String
The IP address bound by default server.
-
.server_port ⇒ Object
Returns the value of attribute server_port.
-
.session_name ⇒ Symbol
The current session name.
-
.visible_text_only ⇒ Object
Returns the value of attribute visible_text_only.
-
.wait_on_first_by_default ⇒ Object
Returns the value of attribute wait_on_first_by_default.
Class Method Summary collapse
-
.add_selector(name) { ... } ⇒ Object
Add a new selector to Capybara.
-
.configure {|_self| ... } ⇒ Object
Configure Capybara to suit your needs.
-
.current_session ⇒ Capybara::Session
The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver.
-
.default_wait_time ⇒ Object
deprecated
Deprecated.
Use default_max_wait_time instead
-
.default_wait_time=(t) ⇒ Object
deprecated
Deprecated.
Use default_max_wait_time= instead
- .deprecate(method, alternate_method, once = false) ⇒ Object
- .drivers ⇒ Object
-
.HTML(html) ⇒ Nokogiri::HTML::Document
Parse raw html into a document using Nokogiri, and adjust textarea contents as defined by the spec.
- .included(base) ⇒ Object
-
.register_driver(name) {|app| ... } ⇒ Object
Register a new driver for Capybara.
-
.reset_sessions! ⇒ Object
(also: reset!)
Reset sessions, cleaning out the pool of sessions.
-
.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 {|app, port| ... } ⇒ Object
Register a proc that Capybara will call to run the Rack application.
-
.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.
-
.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) ⇒ Object
Yield a block using a specific session name.
-
.using_wait_time(seconds) ⇒ Object
Yield a block using a specific wait time.
Methods included from DSL
extended, page, using_session, using_wait_time
Class Attribute Details
.always_include_port ⇒ Object
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 |
.app ⇒ Object
Returns the value of attribute app.
27 28 29 |
# File 'lib/capybara.rb', line 27 def app @app end |
.app_host ⇒ Object
Returns the value of attribute app_host.
22 23 24 |
# File 'lib/capybara.rb', line 22 def app_host @app_host end |
.asset_host ⇒ Object
Returns the value of attribute asset_host.
22 23 24 |
# File 'lib/capybara.rb', line 22 def asset_host @asset_host end |
.automatic_reload ⇒ Object
Returns the value of attribute automatic_reload.
25 26 27 |
# File 'lib/capybara.rb', line 25 def automatic_reload @automatic_reload end |
.current_driver ⇒ Symbol Also known as: mode
Returns The name of the driver currently in use.
190 191 192 |
# File 'lib/capybara.rb', line 190 def current_driver @current_driver || default_driver end |
.default_driver ⇒ Symbol
Returns The name of the driver to use by default.
182 183 184 |
# File 'lib/capybara.rb', line 182 def default_driver @default_driver || :rack_test end |
.default_host ⇒ Object
Returns the value of attribute default_host.
22 23 24 |
# File 'lib/capybara.rb', line 22 def default_host @default_host end |
.default_max_wait_time ⇒ Object
Returns the value of attribute default_max_wait_time.
24 25 26 |
# File 'lib/capybara.rb', line 24 def default_max_wait_time @default_max_wait_time end |
.default_selector ⇒ Object
Returns the value of attribute default_selector.
24 25 26 |
# File 'lib/capybara.rb', line 24 def default_selector @default_selector end |
.exact ⇒ Object
Returns the value of attribute exact.
23 24 25 |
# File 'lib/capybara.rb', line 23 def exact @exact end |
.exact_options ⇒ Object
Returns the value of attribute exact_options.
23 24 25 |
# File 'lib/capybara.rb', line 23 def @exact_options end |
.ignore_hidden_elements ⇒ Object
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_driver ⇒ Symbol
Returns The name of the driver used when JavaScript is needed.
199 200 201 |
# File 'lib/capybara.rb', line 199 def javascript_driver @javascript_driver || :selenium end |
.match ⇒ Object
Returns the value of attribute match.
23 24 25 |
# File 'lib/capybara.rb', line 23 def match @match end |
.raise_server_errors ⇒ Object
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_server ⇒ Object
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_path ⇒ Object
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_errors ⇒ Object
Returns the value of attribute server_errors.
25 26 27 |
# File 'lib/capybara.rb', line 25 def server_errors @server_errors end |
.server_host ⇒ String
Returns The IP address bound by default server.
227 228 229 |
# File 'lib/capybara.rb', line 227 def server_host @server_host || '127.0.0.1' end |
.server_port ⇒ Object
Returns the value of attribute server_port.
23 24 25 |
# File 'lib/capybara.rb', line 23 def server_port @server_port end |
.session_name ⇒ Symbol
The current session name.
269 270 271 |
# File 'lib/capybara.rb', line 269 def session_name @session_name ||= :default end |
.visible_text_only ⇒ Object
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 |
.wait_on_first_by_default ⇒ Object
Returns the value of attribute wait_on_first_by_default.
25 26 27 |
# File 'lib/capybara.rb', line 25 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.
108 109 110 |
# File 'lib/capybara.rb', line 108 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)
- 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_and_open_page_path = String
-
Where to put pages saved through save_and_open_page (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)
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)
59 60 61 |
# File 'lib/capybara.rb', line 59 def configure yield self end |
.current_session ⇒ Capybara::Session
The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver
249 250 251 |
# File 'lib/capybara.rb', line 249 def current_session session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app) end |
.default_wait_time ⇒ Object
Use default_max_wait_time instead
301 302 303 304 |
# File 'lib/capybara.rb', line 301 def default_wait_time deprecate('default_wait_time', 'default_max_wait_time', true) default_max_wait_time end |
.default_wait_time=(t) ⇒ Object
Use default_max_wait_time= instead
307 308 309 310 |
# File 'lib/capybara.rb', line 307 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
317 318 319 320 321 |
# File 'lib/capybara.rb', line 317 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 ⇒ Object
112 113 114 |
# File 'lib/capybara.rb', line 112 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.
292 293 294 295 296 297 298 |
# File 'lib/capybara.rb', line 292 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
312 313 314 315 |
# File 'lib/capybara.rb', line 312 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
76 77 78 |
# File 'lib/capybara.rb', line 76 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.
258 259 260 |
# File 'lib/capybara.rb', line 258 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.
173 174 175 176 |
# File 'lib/capybara.rb', line 173 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.
129 130 131 132 133 134 135 |
# File 'lib/capybara.rb', line 129 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'
160 161 162 |
# File 'lib/capybara.rb', line 160 def string(html) Capybara::Node::Simple.new(html) end |
.use_default_driver ⇒ Object
Use the default driver as the current driver
207 208 209 |
# File 'lib/capybara.rb', line 207 def use_default_driver @current_driver = nil end |
.using_driver(driver) ⇒ Object
Yield a block using a specific driver
215 216 217 218 219 220 221 |
# File 'lib/capybara.rb', line 215 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.
277 278 279 280 281 282 283 |
# File 'lib/capybara.rb', line 277 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
235 236 237 238 239 240 241 |
# File 'lib/capybara.rb', line 235 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 |