capybara 0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-11-04
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,42 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+examples/webcat.rb
+lib/capybara.rb
+lib/capybara/core_ext/tcp_socket.rb
+lib/capybara/cucumber.rb
+lib/capybara/driver/culerity_driver.rb
+lib/capybara/driver/firewatir_driver.rb
+lib/capybara/driver/rack_test_driver.rb
+lib/capybara/driver/safariwatir_driver.rb
+lib/capybara/driver/selenium_driver.rb
+lib/capybara/dsl.rb
+lib/capybara/node.rb
+lib/capybara/rails.rb
+lib/capybara/save_and_open_page.rb
+lib/capybara/server.rb
+lib/capybara/session.rb
+script/console
+script/destroy
+script/generate
+spec/driver/culerity_driver_spec.rb
+spec/driver/firewatir_driver_spec.rb
+spec/driver/rack_test_driver_spec.rb
+spec/driver/safariwarit_driver_spec.rb
+spec/driver/selenium_driver_spec.rb
+spec/drivers_spec.rb
+spec/dsl_spec.rb
+spec/fixtures/test_file.txt
+spec/public/jquery.js
+spec/session/culerity_session_spec.rb
+spec/session/rack_test_session_spec.rb
+spec/session/selenium_session_spec.rb
+spec/session_spec.rb
+spec/spec_helper.rb
+spec/test_app.rb
+spec/views/form.erb
+spec/views/with_html.erb
+spec/views/with_js.erb
+spec/views/with_scope.erb
+spec/views/with_simple_html.erb

data/README.rdoc

@@ -0,0 +1,208 @@
+= capybara
+
+* http://github.com/jnicklas/capybara
+
+== Description:
+
+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.
+
+== Disclaimer:
+
+Capybara is alpha level software, don't use it unless you're prepared to get
+your hands dirty.
+
+== 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
+
+    Cucumber::Rails::World.use_transactional_fixtures = false
+
+Capybara uses DatabaseCleaner to truncate the database. Require Capybara in your
+env.rb. For Rails do this:
+
+    require 'capybara/rails'
+    require 'capybara/cucumber'
+
+For other frameworks, you'll need to set the Rack app manually:
+
+    require 'capybara/cucumber'
+    Capybara.app = MyRackApp
+
+Now you can use it in your steps:
+
+    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
+
+== Default and current driver
+
+You can set up a default driver for your features. For example if you'd prefer
+to run Selenium, you could do:
+
+    require 'capybara/rails'
+    require 'capybara/cucumber'
+    Capybara.default_driver = :selenium
+
+You can change the driver temporarily:
+
+    Capybara.current_driver = :culerity
+    Capybara.use_default_driver
+
+== 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
+scenario (or feature) with <tt>@javascript</tt>:
+
+    @javascript
+    Scenario: do something AJAXy
+      When I click the AJAX link
+      ...
+
+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.
+
+== The API
+
+Navigation:
+
+    visit – The only way to get to anywhere.
+
+Scoping:
+
+    within – Takes a block which executes in the given scope
+
+Interaction:
+
+    click_link
+    click_button
+    fill_in – Currently broken with password fields under Culerity
+    choose
+    check
+    uncheck – Currently broken under Culerity
+    attach_file
+    select
+
+Querying:
+
+    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
+
+Debugging:
+
+    save_and_open_page
+
+== Using the DSL outside cucumber
+
+You can mix the DSL into any context, for example you could use it in RSpec
+examples. Just load the dsl and include it anywhere:
+
+    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'
+
+== Using the sessions manually
+
+For ultimate control, you can instantiate and use a session manually.
+
+    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'
+
+== Install:
+
+Capybara is hosted on Gemcutter, install it with:
+
+    sudo gem install capybara
+
+== Gotchas:
+
+* 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.
+
+* 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. 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.
+
+* Access to Rails specific stuff (such as <tt>controller</tt>) is unavailable,
+  since we're not using Rails' integration testing.
+
+* <tt><a href="#"></tt> Will cause problems under rack-test, please do
+  <tt><a href="/same/url#"></tt> instead. You can achieve this in Rails with
+  <tt>link_to('foo', :anchor => '')</tt>
+
+== 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.

data/Rakefile

@@ -0,0 +1,33 @@
+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']
+
+  self.extra_deps = [
+    ['nokogiri', '>= 1.3.3'],
+    ['culerity', '>= 0.2.3'],
+    ['selenium-webdriver', '>= 0.0.3'],
+    ['rack', '>= 1.0.0'],
+    ['database_cleaner', '>= 0.2.3']
+  ]
+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/examples/webcat.rb

@@ -0,0 +1,36 @@
+session = Capybara::Session.new('http://localhost:3000')
+
+session.visit '/'
+
+session.driver.trigger :click, '//div[@id=foo]//a'
+session.driver.trigger :mouseover, '#foo a.bar' # will be ignored by drivers who do not support it
+
+nodelist = session.find 'li#foo a'
+nodelist.empty?
+nodelist.first.tag_name   # => 'a'
+nodelist.first.text       # => 'a cute link'
+nodelist.first.html       # => 'a <em>cute</em> link'
+nodelist.first.attributes # => { :href => '/blah' }
+nodelist.first.trigger :click
+
+session.request.url # => '/blah'
+session.response.ok? # => true
+
+# fancy stuff, just builds on the stuff above!
+
+session.click_link 'a cute link'
+session.click_button 'an awesome button'
+session.within '#foo' do
+  click_link 'a cute link'
+end
+session.fill_in 'foo', :with => 'bar'
+session.choose 'Monkey'
+session.check 'I am awesome'
+session.wait_for '#fooo"
+
+# In cuke:
+
+When 'I am awesome' do
+  page.check 'I am awesome'
+  page.click_button 'FooBar'
+end

data/lib/capybara.rb

@@ -0,0 +1,30 @@
+require 'nokogiri'
+
+module Capybara
+  VERSION = '0.1'
+
+  class CapybaraError < StandardError; end
+  class DriverNotFoundError < CapybaraError; end
+  class ElementNotFound < CapybaraError; end
+
+  class << self
+    attr_accessor :debug, :asset_root
+    
+    def log(message)
+      puts "[capybara] #{message}" if debug
+      true
+    end
+  end
+  
+  autoload :Server, 'capybara/server'
+  autoload :Session, 'capybara/session'
+  autoload :Node, 'capybara/node'
+
+  module Driver
+    autoload :RackTest, 'capybara/driver/rack_test_driver'
+    autoload :Culerity, 'capybara/driver/culerity_driver'
+    autoload :SafariWatir, 'capybara/driver/safariwatir_driver'
+    autoload :FireWatir, 'capybara/driver/firewatir_driver'
+    autoload :Selenium, 'capybara/driver/selenium_driver'
+  end
+end

data/lib/capybara/core_ext/tcp_socket.rb

@@ -0,0 +1,26 @@
+class TCPSocket
+  def self.wait_for_service_with_timeout(options)
+    start_time = Time.now
+
+    until listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not open within #{options[:timeout]} seconds")
+      end
+    end
+  end
+
+  def self.wait_for_service_termination_with_timeout(options)
+    start_time = Time.now
+
+    while listening_service?(options)
+      verbose_wait
+
+      if options[:timeout] && (Time.now > start_time + options[:timeout])
+        raise SocketError.new("Socket did not terminate within #{options[:timeout]} seconds")
+      end
+    end
+  end
+end
+

data/lib/capybara/cucumber.rb

@@ -0,0 +1,32 @@
+require 'capybara'
+require 'capybara/dsl'
+
+World(Capybara)
+
+After do
+  Capybara.reset_sessions!
+end
+
+require 'database_cleaner'
+require 'database_cleaner/cucumber'
+DatabaseCleaner.strategy = :truncation
+
+Before('@javascript') do
+  Capybara.current_driver = Capybara.javascript_driver
+end
+
+Before('@selenium') do
+  Capybara.current_driver = :selenium
+end
+
+Before('@culerity') do
+  Capybara.current_driver = :culerity
+end
+
+Before('@rack_test') do
+  Capybara.current_driver = :rack_test
+end
+
+After do
+  Capybara.use_default_driver
+end

data/lib/capybara/driver/culerity_driver.rb

@@ -0,0 +1,83 @@
+require 'culerity'
+
+class Capybara::Driver::Culerity
+  class Node < Capybara::Node
+    def text
+      node.text
+    end
+    
+    def [](name)
+      value = if name.to_sym == :class
+        node.class_name
+      else
+        node.send(name.to_sym)
+      end
+      return value if value and not value.empty?
+    end
+
+    def set(value)
+      node.set(value.to_s)
+    end
+    
+    def select(option)
+      node.select(option)
+    end
+    
+    def click
+      node.click
+    end
+    
+    def tag_name
+      # FIXME: this might be the dumbest way ever of getting the tag name
+      # there has to be something better...
+      node.to_xml[/^\s*<([a-z0-9\-\:]+)/, 1]
+    end
+  end
+  
+  attr_reader :app, :rack_server
+
+  def self.server
+    unless @_server
+      @_server = ::Culerity::run_server
+      at_exit do
+        @_server.close
+      end
+    end
+    @_server
+  end
+
+  def initialize(app)
+    @app = app
+    @rack_server = Capybara::Server.new(@app)
+    @rack_server.boot
+  end
+  
+  def visit(path)
+    browser.goto(url(path))
+  end
+  
+  def body
+    browser.html
+  end
+  
+  def find(selector)
+    browser.elements_by_xpath(selector).map { |node| Node.new(self, node) }
+  end
+
+private
+
+  def url(path)
+    rack_server.url(path)
+  end
+  
+  def browser
+    unless @_browser
+      @_browser = ::Culerity::RemoteBrowserProxy.new self.class.server, {:browser => :firefox, :log_level => :off}
+      at_exit do
+        @_browser.exit
+      end
+    end
+    @_browser
+  end
+
+end