= capybara

* http://github.com/jnicklas/capybara

== Description:

Capybara is a unified API for writing web application integration tests for Rack
applications. It works with any rack application and currently has support for
Culerity, Selenium and rack-test.

== Install:

Clone and install from github for now

== Getting Started:

You can initialize a session and start issuing commands:

    require 'capybara'

    session = Capybara::Session.new(:culerity, my_rack_app)
    session.within("//form[@id='session']") do
      session.fill_in 'Login', :with => 'user@example.com'
      session.fill_in 'Password', :with => 'password'
    end
    session.click_link 'Sign in'

Capybara provides a terser DSL:

    require 'capybara'
    require 'capybara/dsl'
    
    include Capybara
    Capybara.default_driver = :culerity

    within("//form[@id='session']") do
      fill_in 'Login', :with => 'user@example.com'
      fill_in 'Password', :with => 'password'
    end
    click_link 'Sign in'

If you want to use it with Cucumber, just require:

    require 'capybara/cucumber'
    Capybara.app = my_rack_app

Then write your steps like this:

    When /I sign in/ do
      within("//form[@id='session']") do
        fill_in 'Login', :with => 'user@example.com'
        fill_in 'Password', :with => 'password'
      end
      click_link 'Sign in'
    end

If you're using Rails, webcan can set up the rack app for you. Just do:

    require 'capybara/cucumber'
    require 'capybara/rails'

== Gotchas:

* Everything is *case sensitive*. Capybara heavily relies on XPath, which doesn't
  support case insensitive searches.
* Unchecking checkboxes and filling in password fields is currently broken
  under Culerity.
* Domain names (including subdomains) don't work under rack-test. Since it's a
  pain to set up subdomains for the other drivers anyway, you should consider
  an alternate solution. See for example [GIST here].
* The set_hidden_field method from Webrat is not implemented, since it doesn't
  work in any of the browser based drivers (Culerity, Selenium)
* Access to session, request and response from the test is not possible. Maybe
  we'll do response headers at some point in the future, but the others really
  shouldn't be touched in an integration test anyway.
* Access to Rails specific stuff (such as +controller+) is unavailable, since
  we're not using Rails' integration testing.
* <a href="#"> Will cause problems under rack-test, please do
  <a href="/same/url#"> instead. You can achieve this in Rails with
  +link_to('foo', :anchor => '')+

== License:

(The MIT License)

Copyright (c) 2009 Jonas Nicklas

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.