capybara 0.2.0 → 0.3.0

data/Manifest.txt

@@ -2,9 +2,11 @@ History.txt
 Manifest.txt
 README.rdoc
 Rakefile
+config.ru
 lib/capybara.rb
 lib/capybara/cucumber.rb
 lib/capybara/driver/base.rb
+lib/capybara/driver/celerity_driver.rb
 lib/capybara/driver/culerity_driver.rb
 lib/capybara/driver/rack_test_driver.rb
 lib/capybara/driver/selenium_driver.rb
@@ -12,33 +14,70 @@ lib/capybara/dsl.rb
 lib/capybara/node.rb
 lib/capybara/rails.rb
 lib/capybara/save_and_open_page.rb
+lib/capybara/searchable.rb
 lib/capybara/server.rb
 lib/capybara/session.rb
+lib/capybara/wait_until.rb
 lib/capybara/xpath.rb
 script/console
 script/destroy
 script/generate
+spec/capybara_spec.rb
+spec/driver/celerity_driver_spec.rb
 spec/driver/culerity_driver_spec.rb
 spec/driver/rack_test_driver_spec.rb
+spec/driver/remote_culerity_driver_spec.rb
+spec/driver/remote_selenium_driver_spec.rb
 spec/driver/selenium_driver_spec.rb
 spec/drivers_spec.rb
+spec/dsl/all_spec.rb
+spec/dsl/attach_file_spec.rb
+spec/dsl/check_spec.rb
+spec/dsl/choose_spec.rb
+spec/dsl/click_button_spec.rb
+spec/dsl/click_link_spec.rb
+spec/dsl/click_spec.rb
+spec/dsl/current_url_spec.rb
+spec/dsl/fill_in_spec.rb
+spec/dsl/find_button_spec.rb
+spec/dsl/find_field_spec.rb
+spec/dsl/find_link_spec.rb
+spec/dsl/find_spec.rb
+spec/dsl/has_content_spec.rb
+spec/dsl/has_css_spec.rb
+spec/dsl/has_xpath_spec.rb
+spec/dsl/locate_spec.rb
+spec/dsl/select_spec.rb
+spec/dsl/uncheck_spec.rb
+spec/dsl/within_spec.rb
 spec/dsl_spec.rb
+spec/fixtures/capybara.jpg
 spec/fixtures/test_file.txt
 spec/public/jquery-ui.js
 spec/public/jquery.js
+spec/public/test.js
 spec/save_and_open_page_spec.rb
+spec/searchable_spec.rb
+spec/server_spec.rb
+spec/session/celerity_session_spec.rb
 spec/session/culerity_session_spec.rb
 spec/session/rack_test_session_spec.rb
 spec/session/selenium_session_spec.rb
 spec/session_spec.rb
+spec/session_with_headers_support_spec.rb
+spec/session_with_javascript_support_spec.rb
+spec/session_without_headers_support_spec.rb
+spec/session_without_javascript_support_spec.rb
 spec/spec_helper.rb
 spec/test_app.rb
 spec/views/buttons.erb
 spec/views/fieldsets.erb
 spec/views/form.erb
+spec/views/postback.erb
 spec/views/tables.erb
 spec/views/with_html.erb
 spec/views/with_js.erb
 spec/views/with_scope.erb
 spec/views/with_simple_html.erb
+spec/wait_until_spec.rb
 spec/xpath_spec.rb

data/README.rdoc

@@ -7,8 +7,8 @@
 Capybara aims to simplify the process of integration testing Rack applications,
 such as Rails, Sinatra or Merb. It is inspired by and aims to replace Webrat as
 a DSL for interacting with a webapplication. It is agnostic about the driver
-running your tests and currently comes bundled with rack-test, Culerity and
-Selenium support built in.
+running your tests and currently comes bundled with rack-test, Culerity,
+Celerity and Selenium support built in.
 
 == Install:
 
@@ -26,18 +26,15 @@ Capybara is hosted on Gemcutter, install it with:
 == Using Capybara with Cucumber
 
 Capybara is built to work nicely with Cucumber. The API is very similar to
-Webrat, so if you know Webrat you should feel right at home. Remove any
-references to Webrat from your <tt>env.rb</tt>, if you're using Rails, make sure to set
+Webrat, so if you know Webrat you should feel right at home. Support for
+Capybara is built into cucumber-rails 0.2. In your Rails app, just run:
 
-    Cucumber::Rails::World.use_transactional_fixtures = false
+    script/generate cucumber --capybara
 
-Capybara uses DatabaseCleaner to truncate the database. Require Capybara in your
-env.rb. For Rails do this:
+And everything should be set up and ready to go.
 
-    require 'capybara/rails'
-    require 'capybara/cucumber'
-
-For other frameworks, you'll need to set the Rack app manually:
+If you want to use Capybara with Cucumber outside Rails (for example with Merb
+or Sinatra), you'll need require capybara and set the Rack app manually:
 
     require 'capybara/cucumber'
     Capybara.app = MyRackApp
@@ -66,11 +63,15 @@ You can change the driver temporarily:
     Capybara.current_driver = :culerity
     Capybara.use_default_driver
 
+You can do this in Before and After blocks to temporarily switch to a different
+driver. Note that switching driver creates a new session, so you may not be able
+to switch in the middle of a Scenario.
+
 == Cucumber and Tags
 
 Capybara sets up some {tags}[http://wiki.github.com/aslakhellesoy/cucumber/tags]
-for you to use in Cucumber. Often you'll want to use run only some scenarios
-with a driver that supports JavaScript, Capybara makes this easy: simply tag the
+for you to use in Cucumber. Often you'll want to run only some scenarios with a
+driver that supports JavaScript, Capybara makes this easy: simply tag the
 scenario (or feature) with <tt>@javascript</tt>:
 
     @javascript
@@ -82,51 +83,182 @@ You can change which driver Capybara uses for JavaScript:
 
     Capybara.javascript_driver = :culerity
 
-There are also explicit <tt>@selenium</tt>, <tt>@culerity</tt> and <tt>@rack_test</tt> tags set up
-for you.
+There are also explicit <tt>@selenium</tt>, <tt>@culerity</tt> and
+<tt>@rack_test</tt> tags set up for you.
+
+== Selenium
+
+At the moment, Capybara supports Webdriver, also called Selenium 2.0, *not*
+Selenium RC. Provided Firefox is installed, everything is set up for you, and
+you should be able to start using Selenium right away.
+
+== Celerity
+
+Celerity only runs on JRuby, so you'll need to install the celerity gem under
+JRuby:
+
+   jruby -S gem install celerity
+
+Note that some specs currently fail on celerity 0.7.5, due to a bug in recent
+versions of HTMLUnit. It is recommended you use celerity 0.7.4 for the time
+being.
+
+== Culerity
+
+Install celerity as noted above, make sure JRuby is in your path. Note that
+Culerity doesn't seem to be working under Ruby 1.9 at the moment.
+
+== The DSL
+
+Capybara's DSL is inspired by Webrat. While backwards compatibility is retained 
+in a lot of cases, there are certain important differences.
+
+Unlike in Webrat, all searches in Capybara are *case sensitive*. This is because
+Capybara heavily uses XPath, which doesn't support case insensitivity.
+
+=== Navigating
+
+You can use the <tt>visit</tt> method to navigate to other pages:
+
+    visit('/projects')
+    visit(post_comments_path(post))
+
+The visit method only takes a single parameter, the request method is *always*
+GET.
+
+=== Clicking links and buttons
+
+You can interact with the webapp by following links and buttons. Capybara
+automatically follows any redirects, and submits forms associated with buttons.
+
+    click_link('id-of-link')
+    click_link('Link Text')
+    click_button('Save')
+    click('Link Text') # Click either a link or a button
+    click('Button Value')
+
+=== Interacting with forms
+
+Forms are everywhere in webapps, there are a number of tools for interacting
+with the various form elements:
+
+    fill_in('First Name', :with => 'John')
+    fill_in('Password', :with => 'Seekrit')
+    fill_in('Description', :with => 'Really Long Text…')
+    choose('An Option')
+    check('A Checkbox')
+    uncheck('A Checkbox')
+    attach_file('Image', '/path/to/image.jpg')
+    select('Option', :from => 'Select Box')
 
-== The API
+=== Scoping
 
-Navigation:
+Capybara makes it possible to restrict certain actions, such as interacting with
+forms or clicking links and buttons, to within a specific area of the page. For
+this purpose you can use the generic <tt>within</tt> method. Optionally you can
+specify which kind of selector (CSS or XPath to use).
 
-    visit – The only way to get to anywhere.
+    within("//li[@id='employee']") do
+      fill_in 'Name', :with => 'Jimmy'
+    end
+
+    within(:css, "li#employee") do
+      fill_in 'Name', :with => 'Jimmy'
+    end
+
+You can choose which kind of selector Capybara uses by default, by setting
+<tt>Capybara.default_selector</tt>.
 
-Scoping:
+There are special methods for restricting the scope to a specific fieldset,
+identified by either an id or the text of the fieldet's legend tag, and to a
+specific table, identified by either idea or text of the table's caption tag.
 
-    within – Takes a block which executes in the given scope
-    within_fieldset – Execute the block in the fieldset given by id or legend
-    within_table – Execute the block in the table given by id or caption
+    within_fieldset('Employee') do
+      fill_in 'Name', :with => 'Jimmy'
+    end
+
+    within_table('Employee') do
+      fill_in 'Name', :with => 'Jimmy'
+    end
 
-Interaction:
+=== Querying
 
-    click_link
-    click_button
-    fill_in
-    choose
-    check
-    uncheck
-    attach_file
-    select
+Capybara has a rich set of options for querying the page for the existence of
+certain elements, and working with and manipulating those elements.
 
-Querying:
+    page.has_xpath?('//table/tr')
+    page.has_css?('table tr.foo')
+    page.has_content?('foo')
+    
+You can use with RSpecs magic matchers:
 
-    body
-    has_xpath? – Checks if given XPath exists, takes text and count options
-    has_css? – Checks if given CSS exists, takes text and count options
-    has_content? – Checks if the given content is on the page
-    find_field
-    find_link
-    find_button
-    field_labeled
+    page.should have_xpath('//table/tr')
+    page.should have_css('table tr.foo')
+    page.should have_content('foo')
+    page.should have_no_content('foo')
 
-Scripting:
+Note that <tt>page.should have_no_xpath</tt> is preferred over
+<tt>page.should_not have_xpath</tt>. Read the section on asynchronous JavaScript
+for an explanation.
 
-    evaluate_script – Returns the value of the executed javascript (only works on javascript supported drivers)
+You can also find specific elements, in order to manipulate them:
 
-Debugging:
+    find_field('First Name').value
+    find_link('Hello').visible?
+    find_button('Send').click
+    
+    find('//table/tr').click
+    wait_for("//*[@id='overlay'").find("//h1").click
+    all('a').each { |a| a[:href] }
+
+=== Scripting
+
+In drivers which support it, you can easily evaluate JavaScript:
+
+    result = page.evaluate_script('4 + 4');
+
+=== Debugging
+
+It can be useful to take a snapshot of the page as it currently is and take a
+look at it:
 
     save_and_open_page
 
+== Asynchronous JavaScript (AJAX and friends)
+
+When working with asynchronous JavaScript, you might come across situations
+where you are attempting to interact with an element which is not yet present
+on the page. Capybara automatically deals with this by waiting for elements
+to appear on the page.
+
+When issuing instructions to the DSL such as:
+
+    click_link('foo')
+    click_link('bar')
+    page.should have_content('baz')
+
+If clicking on the *foo* link causes triggers an asynchronous process, such as
+an AJAX request, which, when complete will add the *bar* link to the page,
+clicking on the *bar* link would be expeced to fail, since that link doesn't
+exist yet. However Capybara is smart enought to retry finding the link for a
+brief period of time before giving up and throwing an error. The same is true of
+the next line, which looks for the content *baz* on the page; it will retry
+looking for that content for a brief time. You can adjust how long this period
+is (the default is 2 seconds):
+
+    Capybara.default_wait_time = 5
+
+Be aware that because of this behaviour, the following two statements are *not*
+identical, and you should *always* use the latter!
+
+    page.should_not have_xpath('//a')
+    page.should have_no_xpath('//a')
+
+The former would incorrectly wait for the content to appear, since the
+asynchronous process has not yet removed the element from the page, it would
+therefore fail, even though the code might be working correctly. The latter
+correctly wait for the element to disappear from the page.
+
 == Using the DSL outside cucumber
 
 You can mix the DSL into any context, for example you could use it in RSpec
@@ -173,26 +305,12 @@ moving from Webrat and used CSS a lot, or simply generally prefer CSS:
 
 == Gotchas:
 
-* Install JRuby and the 'celerity' gem, version 0.7.4 (0.7.5 has a bug with
-  password fields) under JRuby for Culerity support.
-
-* Everything is *case sensitive*. Capybara heavily relies on XPath, which
-  doesn't support case insensitive searches.
-
-* The <tt>have_tag</tt> and <tt>have_text</tt> matchers in RSpec-Rails are not
-  supported. You should use <tt>page.should have_css('#header p')</tt>,
-  <tt>page.should have_xpath('//ul/li')</tt> and <tt>page.should
-  have_content('Monkey')</tt> instead.
-
 * 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. You might use
   {default_url_options}[https://gist.github.com/643a758320a2926bd2ed] in Rails
   for example.
 
-* The <tt>set_hidden_field</tt> 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.
@@ -214,6 +332,12 @@ The following people have dedicated their time and effort to Capybara:
 * Wincent Colaiuta
 * Andrea Fazzi
 * Aslak Hellesøy
+* Andrew Brown
+* Lenny Marks
+* Aaron Patterson
+* Dan Dofter
+* Thorbjørn Hermansen
+* Louis T.
 
 == License:
 

data/Rakefile

@@ -1,23 +1,21 @@
 require 'rubygems'
+
 gem 'hoe', '>= 2.1.0'
 require 'hoe'
-require 'fileutils'
-require './lib/capybara'
 
 Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'capybara' do
-  self.developer 'Jonas Nicklas', 'jonas.nicklas@gmail.com'
-  self.rubyforge_name = self.name # TODO this is default value
-  self.readme_file   = 'README.rdoc'
-  self.extra_rdoc_files = ['README.rdoc']
+Hoe.spec 'capybara' do
+  developer 'Jonas Nicklas', 'jonas.nicklas@gmail.com'
+
+  self.readme_file      = 'README.rdoc'
+  self.extra_rdoc_files = Dir['*.rdoc']
 
   self.extra_deps = [
     ['nokogiri', '>= 1.3.3'],
+    ['mime-types', '>= 1.16'],
     ['culerity', '>= 0.2.4'],
     ['selenium-webdriver', '>= 0.0.3'],
     ['rack', '>= 1.0.0'],
@@ -29,10 +27,3 @@ $hoe = Hoe.spec 'capybara' do
     ['rspec', '>= 1.2.9']
   ]
 end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]

data/config.ru

@@ -0,0 +1,6 @@
+## This is not needed for Thin > 1.0.0
+ENV['RACK_ENV'] = "production"
+
+require File.expand_path('spec/test_app', File.dirname(__FILE__))
+
+run TestApp

data/lib/capybara.rb

@@ -1,20 +1,28 @@
+require 'timeout'
 require 'nokogiri'
 
 module Capybara
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 
   class CapybaraError < StandardError; end
   class DriverNotFoundError < CapybaraError; end
   class ElementNotFound < CapybaraError; end
   class NotSupportedByDriverError < CapybaraError; end
-
+  class TimeoutError < CapybaraError; end
+  class InfiniteRedirectError < TimeoutError; end
+  
   class << self
-    attr_accessor :debug, :asset_root
-    attr_writer :default_selector
+    attr_accessor :debug, :asset_root, :app_host
+    attr_writer :default_selector, :default_wait_time
+    
 
     def default_selector
       @default_selector ||= :xpath
     end
+    
+    def default_wait_time
+      @default_wait_time ||= 2
+    end
 
     def log(message)
       puts "[capybara] #{message}" if debug
@@ -22,14 +30,16 @@ module Capybara
     end
   end
   
-  autoload :Server,  'capybara/server'
-  autoload :Session, 'capybara/session'
-  autoload :Node,    'capybara/node'
-  autoload :XPath,   'capybara/xpath'
-
+  autoload :Server,     'capybara/server'
+  autoload :Session,    'capybara/session'
+  autoload :Node,       'capybara/node'
+  autoload :XPath,      'capybara/xpath'
+  autoload :Searchable, 'capybara/searchable'
+  
   module Driver
     autoload :Base,     'capybara/driver/base'
     autoload :RackTest, 'capybara/driver/rack_test_driver'
+    autoload :Celerity, 'capybara/driver/celerity_driver'
     autoload :Culerity, 'capybara/driver/culerity_driver'
     autoload :Selenium, 'capybara/driver/selenium_driver'
   end