Module: Capybara

### Home Classes Methods

### In Files

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

### Namespace

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

### Methods

- ::HTML
- ::add_selector
- ::configure
- ::current_driver
- ::current_session
- ::default_driver
- ::deprecate
- ::drivers
- ::included
- ::javascript_driver
- ::mode
- ::register_driver
- ::reset!
- ::reset_sessions!
- ::run_default_server
- ::server
- ::server_host
- ::session_name
- ::string
- ::use_default_driver
- ::using_driver
- ::using_session
- ::using_wait_time

### Files

- another_test_file.txt
- test_file.txt

### Class/Module Index

Quicksearch

- Capybara
- Capybara::Ambiguous
- Capybara::CapybaraError
- Capybara::DSL
- Capybara::Driver
- Capybara::Driver::Base
- Capybara::Driver::Node
- Capybara::DriverNotFoundError
- Capybara::ElementNotFound
- Capybara::ExpectationNotMet
- Capybara::Features
- Capybara::FileNotFound
- Capybara::FrozenInTime
- Capybara::Helpers
- Capybara::InfiniteRedirectError
- Capybara::ModalNotFound
- Capybara::Node
- Capybara::Node::Actions
- Capybara::Node::Base
- Capybara::Node::Document
- Capybara::Node::DocumentMatchers
- Capybara::Node::Element
- Capybara::Node::Finders
- Capybara::Node::Matchers
- Capybara::Node::Simple
- Capybara::NotSupportedByDriverError
- Capybara::Queries
- Capybara::Queries::BaseQuery
- Capybara::Queries::TextQuery
- Capybara::Queries::TitleQuery
- Capybara::Query
- Capybara::RSpecMatchers
- Capybara::RSpecMatchers::BecomeClosed
- Capybara::RSpecMatchers::HaveSelector
- Capybara::RSpecMatchers::HaveText
- Capybara::RSpecMatchers::HaveTitle
- Capybara::RSpecMatchers::Matcher
- Capybara::RackTest
- Capybara::RackTest::Browser
- Capybara::RackTest::CSSHandlers
- Capybara::RackTest::Driver
- Capybara::RackTest::Form
- Capybara::RackTest::Form::NilUploadedFile
- Capybara::RackTest::Node
- Capybara::ReadOnlyElementError
- Capybara::Result
- Capybara::ScopeError
- Capybara::Selector
- Capybara::Selector::Filter
- Capybara::Selenium
- Capybara::Selenium::Driver
- Capybara::Selenium::Node
- Capybara::Server
- Capybara::Server::Middleware
- Capybara::Session
- Capybara::SpecHelper
- Capybara::UnselectNotAllowed
- Capybara::Window
- Capybara::WindowError
- TestApp
- TestApp::TestAppError
- Object

No matching classes.

# Capybara

### Constants

VERSION

### Attributes

always_include_port[RW]
app[RW]
app_host[RW]
asset_host[RW]
automatic_reload[RW]
current_driver[W]
default_driver[W]
default_host[RW]
default_selector[RW]
default_wait_time[RW]
exact[RW]
exact_options[RW]
ignore_hidden_elements[RW]
javascript_driver[W]
match[RW]
raise_server_errors[RW]
run_server[RW]
save_and_open_page_path[RW]
server_host[W]
server_port[RW]
session_name[W]
visible_text_only[RW]

### Public Class Methods

HTML(html) click to toggle source

Parse raw html into a document using Nokogiri, and adjust textarea contents as defined by the spec.

@param [String] html The raw html @return [Nokogiri::HTML::Document] HTML document

    # 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

add_selector(name, &block) click to toggle source

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.

@param [Symbol] name The name of the selector to add @yield A block executed in the context of the new {Capybara::Selector}

    # File lib/capybara.rb, line 106
    def add_selector(name, &block)
      Capybara::Selector.add(name, &block)
    end

configure() click to toggle source

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)

    # File lib/capybara.rb, line 57
    def configure
      yield self
    end

current_driver() click to toggle source

@return [Symbol] The name of the driver currently in use

    # File lib/capybara.rb, line 188
    def current_driver
      @current_driver || default_driver
    end

Also aliased as: mode
current_session() click to toggle source

The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver

@return [Capybara::Session] The currently used session

    # 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

default_driver() click to toggle source

@return [Symbol] The name of the driver to use by default

    # File lib/capybara.rb, line 180
    def default_driver
      @default_driver || :rack_test
    end

deprecate(method, alternate_method) click to toggle source

    # File lib/capybara.rb, line 302
    def deprecate(method, alternate_method)
      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
    end

drivers() click to toggle source

    # File lib/capybara.rb, line 110
    def drivers
      @drivers ||= {}
    end

included(base) click to toggle source

    # 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

javascript_driver() click to toggle source

@return [Symbol] The name of the driver used when JavaScript is needed

    # File lib/capybara.rb, line 197
    def javascript_driver
      @javascript_driver || :selenium
    end

mode() click to toggle source
Alias for: current_driver
register_driver(name, &block) click to toggle source

Register a new driver for Capybara.

    Capybara.register_driver :rack_test do |app|
      Capybara::Driver::RackTest.new(app)
    end

@param [Symbol] name The name of the new driver @yield [app] This block takes a rack app and returns a Capybara driver @yieldparam [<Rack>] app The rack application that this driver runs agains. May be nil. @yieldreturn [Capybara::Driver::Base] A Capybara driver instance

    # File lib/capybara.rb, line 74
    def register_driver(name, &block)
      drivers[name] = block
    end

reset!() click to toggle source
Alias for: reset_sessions!
reset_sessions!() click to toggle source

Reset sessions, cleaning out the pool of sessions. This will remove any session information such as cookies.

    # File lib/capybara.rb, line 256
    def reset_sessions!
      session_pool.each { |mode, session| session.reset! }
    end

Also aliased as: reset!
run_default_server(app, port) click to toggle source

Runs Capybara's default server for the given application and port under most circumstances you should not have to call this method manually.

@param [Rack Application] app The rack application to run @param [Fixnum] port The port to run the application on

    # 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(&block) click to toggle source

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.

@yield [app, port] This block receives a rack app and port and should run a Rack handler

    # File lib/capybara.rb, line 127
    def server(&block)
      if block_given?
        @server = block
      else
        @server
      end
    end

server_host() click to toggle source

@return [String] The IP address bound by default server

    # File lib/capybara.rb, line 225
    def server_host
      @server_host || '127.0.0.1'
    end

session_name() click to toggle source

The current session name.

@return [Symbol] The name of the currently used session.

    # File lib/capybara.rb, line 267
    def session_name
      @session_name ||= :default
    end

string(html) click to toggle source

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'

@param [String] html An html fragment or document @return [Capybara::Node::Simple] A node which has Capybara's finders and matchers

    # File lib/capybara.rb, line 158
    def string(html)
      Capybara::Node::Simple.new(html)
    end

use_default_driver() click to toggle source

Use the default driver as the current driver

    # File lib/capybara.rb, line 205
    def use_default_driver
      @current_driver = nil
    end

using_driver(driver) click to toggle source

Yield a block using a specific driver

    # 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) click to toggle source

Yield a block using a specific session name.

    # 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) click to toggle source

Yield a block using a specific wait time

    # 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

[Validate]

Generated with the Darkfish Rdoc Generator 2.