Module: Capybara

Extended by:
DSL
Defined in:
lib/capybara.rb,
lib/capybara/dsl.rb,
lib/capybara/query.rb,
lib/capybara/server.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/util/timeout.rb,
lib/capybara/node/document.rb,
lib/capybara/node/matchers.rb,
lib/capybara/rspec/features.rb,
lib/capybara/rspec/matchers.rb,
lib/capybara/util/save_and_open_page.rb

Defined Under Namespace

Modules: DSL, Driver, Features, Node, RSpecMatchers, RackTest, Selenium Classes: CapybaraError, DriverNotFoundError, ElementNotFound, ExpectationNotMet, FileNotFound, FrozenInTime, InfiniteRedirectError, LocateHiddenElementError, NotSupportedByDriverError, Query, Selector, Server, Session, TimeoutError, UnselectNotAllowed

Constant Summary collapse

VERSION = 
'1.1.2'

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from DSL

page, using_session, using_wait_time

Class Attribute Details

.app ⇒ Object

Returns the value of attribute app.



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

def app
  @app
end

.app_host ⇒ Object

Returns the value of attribute app_host.



19
20
21
 
# File 'lib/capybara.rb', line 19

def app_host
  @app_host
end

.asset_root ⇒ Object

Returns the value of attribute asset_root.



19
20
21
 
# File 'lib/capybara.rb', line 19

def asset_root
  @asset_root
end

.automatic_reload ⇒ Object

Returns the value of attribute automatic_reload.



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

def automatic_reload
  @automatic_reload
end

.current_driver ⇒ Symbol Also known as: mode

Returns The name of the driver currently in use.

Returns:

  • (Symbol) —

    The name of the driver currently in use



199
200
201
 
# File 'lib/capybara.rb', line 199

def current_driver
  @current_driver || default_driver
end

.default_driver ⇒ Symbol

Returns The name of the driver to use by default.

Returns:

  • (Symbol) —

    The name of the driver to use by default



191
192
193
 
# File 'lib/capybara.rb', line 191

def default_driver
  @default_driver || :rack_test
end

.default_host ⇒ Object

Returns the value of attribute default_host.



19
20
21
 
# File 'lib/capybara.rb', line 19

def default_host
  @default_host
end

.default_selector ⇒ Object

Returns the value of attribute default_selector.



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

def default_selector
  @default_selector
end

.default_wait_time ⇒ Object

Returns the value of attribute default_wait_time.



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

def default_wait_time
  @default_wait_time
end

.ignore_hidden_elements ⇒ Object

Returns the value of attribute ignore_hidden_elements.



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

def ignore_hidden_elements
  @ignore_hidden_elements
end

.javascript_driver ⇒ Symbol

Returns The name of the driver used when JavaScript is needed.

Returns:

  • (Symbol) —

    The name of the driver used when JavaScript is needed



208
209
210
 
# File 'lib/capybara.rb', line 208

def javascript_driver
  @javascript_driver || :selenium
end

.prefer_visible_elements ⇒ Object

Returns the value of attribute prefer_visible_elements.



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

def prefer_visible_elements
  @prefer_visible_elements
end

.run_server ⇒ Object

Returns the value of attribute run_server.



19
20
21
 
# File 'lib/capybara.rb', line 19

def run_server
  @run_server
end

.save_and_open_page_path ⇒ Object

Returns the value of attribute save_and_open_page_path.



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

def save_and_open_page_path
  @save_and_open_page_path
end

.server_host ⇒ Object

Returns the value of attribute server_host.



20
21
22
 
# File 'lib/capybara.rb', line 20

def server_host
  @server_host
end

.server_port ⇒ Object

Returns the value of attribute server_port.



20
21
22
 
# File 'lib/capybara.rb', line 20

def server_port
  @server_port
end

.session_name ⇒ Symbol

The current session name.

Returns:

  • (Symbol) —

    The name of the currently used session.



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

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.

Parameters:

  • name (Symbol) —

    The name of the selector to add

Yields:

  • A block executed in the context of the new Selector



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

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

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)

prefer_visible_elements = Boolean

Whether to prefer visible elements over hidden elements (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



54
55
56
 
# File 'lib/capybara.rb', line 54

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

Returns:



250
251
252
 
# File 'lib/capybara.rb', line 250

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

.deprecate(method, alternate_method) ⇒ Object 



290
291
292
 
# File 'lib/capybara.rb', line 290

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

.drivers ⇒ Object 



115
116
117
 
# File 'lib/capybara.rb', line 115

def drivers
  @drivers ||= {}
end

.included(base) ⇒ Object 



285
286
287
288
 
# File 'lib/capybara.rb', line 285

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::Driver::RackTest.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:



71
72
73
 
# File 'lib/capybara.rb', line 71

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.



259
260
261
 
# File 'lib/capybara.rb', line 259

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



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

def run_default_server(app, port)
  begin
    require 'rack/handler/thin'
    Thin::Logging.silent = true
    Rack::Handler::Thin.run(app, :Port => port)
  rescue LoadError
    require 'rack/handler/webrick'
    Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
  end
end

.save_and_open_page(html, file_name = nil) ⇒ Object 



18
19
20
 
# File 'lib/capybara/util/save_and_open_page.rb', line 18

def save_and_open_page(html, file_name=nil)
  open_in_browser save_page(html, file_name)
end

.save_page(html, file_name = nil) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/capybara/util/save_and_open_page.rb', line 3

def save_page(html, file_name=nil)
  file_name ||= "capybara-#{Time.new.strftime("%Y%m%d%H%M%S")}#{rand(10**10)}.html"
  name = File.join(*[Capybara.save_and_open_page_path, file_name].compact)

  unless Capybara.save_and_open_page_path.nil? || File.directory?(Capybara.save_and_open_page_path )
    FileUtils.mkdir_p(Capybara.save_and_open_page_path)
  end
  FileUtils.touch(name) unless File.exist?(name)

  tempfile = File.new(name,'w')
  tempfile.write(rewrite_css_and_image_references(html))
  tempfile.close
  tempfile.path
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.

Yields:

  • (app, port) —

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



132
133
134
135
136
137
138
 
# File 'lib/capybara.rb', line 132

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'

Parameters:

  • html (String) —

    An html fragment or document

Returns:



163
164
165
 
# File 'lib/capybara.rb', line 163

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

.timeout(seconds = 1, driver = nil, error_message = nil, &block) ⇒ Object

Provides timeout similar to standard library Timeout, but avoids threads



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/capybara/util/timeout.rb', line 7

def timeout(seconds = 1, driver = nil, error_message = nil, &block)
  start_time = Time.now

  result = nil

  until result
    return result if result = yield

    delay = seconds - (Time.now - start_time)
    if delay <= 0
      raise TimeoutError, error_message || "timed out"
    end

    driver && driver.wait_until(delay)

    sleep(0.05)
  end
end

.use_default_driver ⇒ Object

Use the default driver as the current driver



216
217
218
 
# File 'lib/capybara.rb', line 216

def use_default_driver
  @current_driver = nil
end

.using_driver(driver) ⇒ Object

Yield a block using a specific driver



224
225
226
227
228
229
230
 
# File 'lib/capybara.rb', line 224

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.



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

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



236
237
238
239
240
241
242
 
# File 'lib/capybara.rb', line 236

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