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/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/spec/spec_helper.rb
Defined Under Namespace
Modules: DSL, Driver, Features, Helpers, Node, RSpecMatchers, RackTest, Selenium, SpecHelper Classes: Ambiguous, CapybaraError, DriverNotFoundError, ElementNotFound, ExpectationNotMet, FileNotFound, FrozenInTime, InfiniteRedirectError, NotSupportedByDriverError, Query, Result, Selector, Server, Session, UnselectNotAllowed
Constant Summary collapse
- VERSION =
'2.0.3'
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_root ⇒ Object
Returns the value of attribute asset_root.
-
.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_selector ⇒ Object
Returns the value of attribute default_selector.
-
.default_wait_time ⇒ Object
Returns the value of attribute default_wait_time.
-
.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.
-
.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_host ⇒ Object
Returns the value of attribute server_host.
-
.server_port ⇒ Object
Returns the value of attribute server_port.
-
.session_name ⇒ Symbol
The current session name.
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.
- .deprecate(method, alternate_method) ⇒ Object
- .drivers ⇒ Object
- .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 and Node::Finders.
-
.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.
18 19 20 |
# File 'lib/capybara.rb', line 18 def always_include_port @always_include_port end |
.app ⇒ Object
Returns the value of attribute app.
23 24 25 |
# File 'lib/capybara.rb', line 23 def app @app end |
.app_host ⇒ Object
Returns the value of attribute app_host.
18 19 20 |
# File 'lib/capybara.rb', line 18 def app_host @app_host end |
.asset_root ⇒ Object
Returns the value of attribute asset_root.
18 19 20 |
# File 'lib/capybara.rb', line 18 def asset_root @asset_root end |
.automatic_reload ⇒ Object
Returns the value of attribute automatic_reload.
21 22 23 |
# File 'lib/capybara.rb', line 21 def automatic_reload @automatic_reload end |
.current_driver ⇒ Symbol Also known as: mode
Returns The name of the driver currently in use.
192 193 194 |
# File 'lib/capybara.rb', line 192 def current_driver @current_driver || default_driver end |
.default_driver ⇒ Symbol
Returns The name of the driver to use by default.
184 185 186 |
# File 'lib/capybara.rb', line 184 def default_driver @default_driver || :rack_test end |
.default_host ⇒ Object
Returns the value of attribute default_host.
18 19 20 |
# File 'lib/capybara.rb', line 18 def default_host @default_host end |
.default_selector ⇒ Object
Returns the value of attribute default_selector.
20 21 22 |
# File 'lib/capybara.rb', line 20 def default_selector @default_selector end |
.default_wait_time ⇒ Object
Returns the value of attribute default_wait_time.
20 21 22 |
# File 'lib/capybara.rb', line 20 def default_wait_time @default_wait_time end |
.ignore_hidden_elements ⇒ Object
Returns the value of attribute ignore_hidden_elements.
20 21 22 |
# File 'lib/capybara.rb', line 20 def ignore_hidden_elements @ignore_hidden_elements end |
.javascript_driver ⇒ Symbol
Returns The name of the driver used when JavaScript is needed.
201 202 203 |
# File 'lib/capybara.rb', line 201 def javascript_driver @javascript_driver || :selenium end |
.run_server ⇒ Object
Returns the value of attribute run_server.
18 19 20 |
# File 'lib/capybara.rb', line 18 def run_server @run_server end |
.save_and_open_page_path ⇒ Object
Returns the value of attribute save_and_open_page_path.
21 22 23 |
# File 'lib/capybara.rb', line 21 def save_and_open_page_path @save_and_open_page_path end |
.server_host ⇒ Object
Returns the value of attribute server_host.
19 20 21 |
# File 'lib/capybara.rb', line 19 def server_host @server_host end |
.server_port ⇒ Object
Returns the value of attribute server_port.
19 20 21 |
# File 'lib/capybara.rb', line 19 def server_port @server_port end |
.session_name ⇒ Symbol
The current session name.
263 264 265 |
# File 'lib/capybara.rb', line 263 def session_name @session_name ||= :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) { page.should have_content('$100.000') }
It might be convenient to specify that the selector is automatically chosen for certain values. This way you don’t have to explicitly specify that you are looking for a row, or an id. Let’s say we want Capybara to treat any Symbols sent into methods like find to be treated as though they were element ids. We could achieve this like so:
Capybara.add_selector(:id) do
xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
match { |value| value.is_a?(Symbol) }
end
Now we can retrieve elements by id like this:
find(:post_123)
Note that this particular selector already ships with Capybara.
110 111 112 |
# File 'lib/capybara.rb', line 110 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
- asset_root = String
-
Where static assets are located, used by save_and_open_page
- 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)
- 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: false)
- 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)
53 54 55 |
# File 'lib/capybara.rb', line 53 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
243 244 245 |
# File 'lib/capybara.rb', line 243 def current_session session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app) end |
.deprecate(method, alternate_method) ⇒ Object
283 284 285 |
# File 'lib/capybara.rb', line 283 def deprecate(method, alternate_method) warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" end |
.drivers ⇒ Object
114 115 116 |
# File 'lib/capybara.rb', line 114 def drivers @drivers ||= {} end |
.included(base) ⇒ Object
278 279 280 281 |
# File 'lib/capybara.rb', line 278 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
70 71 72 |
# File 'lib/capybara.rb', line 70 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.
252 253 254 |
# File 'lib/capybara.rb', line 252 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.
175 176 177 178 |
# File 'lib/capybara.rb', line 175 def run_default_server(app, port) require 'rack/handler/webrick' Rack::Handler::WEBrick.run(app, :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 thin, falling back to webrick.
131 132 133 134 135 136 137 |
# File 'lib/capybara.rb', line 131 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 and Capybara::Node::Finders. 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').text # => 'Home'
162 163 164 |
# File 'lib/capybara.rb', line 162 def string(html) Capybara::Node::Simple.new(html) end |
.use_default_driver ⇒ Object
Use the default driver as the current driver
209 210 211 |
# File 'lib/capybara.rb', line 209 def use_default_driver @current_driver = nil end |
.using_driver(driver) ⇒ Object
Yield a block using a specific driver
217 218 219 220 221 222 223 |
# File 'lib/capybara.rb', line 217 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.
271 272 273 274 275 276 |
# File 'lib/capybara.rb', line 271 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
229 230 231 232 233 234 235 |
# File 'lib/capybara.rb', line 229 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 |