capybara 0.4.0 → 0.4.1.rc

data/History.txt

@@ -1,3 +1,38 @@
+# Version 0.4.1
+
+Release date:
+
+### Added
+
+* New click_on alias for click_link_or_button, shorter yet unambiguous. [Jonas Nicklas]
+* Finders now accept :visible => false which will find all elements regardless of Capybara.ignore_hidden_elements [Jonas Nicklas]
+* Configure how the server is started via Capybara.server { |app, port| ... }. [John Firebough]
+* Added :between, :maximum and :minimum options to has_selector and friends [James B. Byrne]
+* New Capybara.string util function which allows matchers on arbitrary strings, mostly for helper and view specs [David Chelimsky and Jonas Nicklas]
+* Server boot timeout is now configurable, via Capybara.server_boot_timeout [Adam Cigánek]
+* Built in support for RSpec [Jonas Nicklas]
+* Capybara.using_driver to switch to a different driver temporarily [Jeff Kreeftmeijer]
+* Added Session#first which is somewhat speedier than Session#all, use it internally for speed boost [John Firebaugh]
+
+### Changed
+
+* Session#within now accepts the same arguments as other finders, like Session#all and Session#find [Jonas Nicklas]
+
+### Removed
+
+* All deprecations from 0.4.0 have been removed. [Jonas Nicklas]
+
+### Fixed
+
+* Don't mangle URLs in save_and_open_page when using self-closing tags [Adam Spiers]
+* Catch correct error when server boot times out [Jonas Nicklas]
+* Celerity driver now properly passes through options, making it configurable [Jonas Nicklas]
+* Better implementation of attributes in C[ue]lerity, should fix issues with attributes with strange names [Jonas Nicklas]
+* Session#find no longer swallows errors [Jonas Nicklas]
+* Fix problems with multiple file inputs [Philip Arndt]
+* Submit multipart forms as multipart under rack-test even if they contain no files [Ryan Kinderman]
+* Matchers like has_select? and has_checked_field? now work with dynamically changed values [John Firebaugh]
+
 # Version 0.4.0
 
 Release date: 2010-10-22

data/README.rdoc

@@ -64,6 +64,57 @@ Now you can use it in your steps:
       click_link 'Sign in'
     end
 
+Capybara sets up some {tags}[http://wiki.github.com/aslakhellesoy/cucumber/tags]
+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
+    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.
+
+== Using Capybara with RSpec
+
+If you prefer RSpec to using Cucumber, you can use the built in RSpec support:
+
+    require 'capybara/rspec'
+    Capybara.app = MyRackApp
+
+You can now use it in your examples:
+
+    describe "the signup process", :type => :acceptance do
+      it "signs me in" do
+        within("#session") do
+          fill_in 'Login', :with => 'user@example.com'
+          fill_in 'Password', :with => 'password'
+        end
+        click_link 'Sign in'
+      end
+    end
+
+Capybara is only included for examples which have the type
+<tt>:acceptance</tt>.
+
+RSpec's metadata feature can be used to switch to a different driver. Use
+<tt>:js => true</tt> to switch to the javascript driver, or provide a
+<tt>:driver</tt> option to switch to one specific driver. For example:
+
+    describe 'some stuff which requires js', :js => true do
+      it 'will use the default js driver'
+      it 'will switch to one specific driver', :driver => :celerity
+    end
+
+Note that Capybara's built in RSpec support only works with RSpec 2.0 or later.
+You'll need to roll your own for earlier versions of RSpec.
+
 == Default and current driver
 
 You can set up a default driver for your features. For example if you'd prefer
@@ -82,25 +133,6 @@ 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 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.
-
 == Selenium
 
 At the moment, Capybara supports Webdriver, also called Selenium 2.0, *not*
@@ -456,6 +488,9 @@ Whatever is returned from the block should conform to the API described by
 Capybara::Driver::Base, it does not however have to inherit from this class.
 Gems can use this API to add their own drivers to Capybara.
 
+The {Selenium wiki}[http://code.google.com/p/selenium/wiki/RubyBindings] has
+additional info about how the underlying driver can be configured.
+
 == Gotchas:
 
 * Access to session and request is not possible from the test, Access to
@@ -473,6 +508,12 @@ Gems can use this API to add their own drivers to Capybara.
   use plugins which allow you to travel in time, rather than freeze time.
   One such plugin is {Timecop}[http://github.com/jtrupiano/timecop].
 
+* When using Rack::Test, beware if attempting to visit absolute URLs. For
+  example, a session might not be shared between visits to <tt>posts_path</tt>
+  and <tt>posts_url</tt>. If testing an absolute URL in an Action Mailer email,
+  set <tt>default_url_options</tt> to match the Rails default of
+  <tt>www.example.com</tt>.
+
 == License:
 
 (The MIT License)

data/lib/capybara.rb

@@ -1,7 +1,6 @@
 require 'timeout'
 require 'nokogiri'
 require 'xpath'
-
 module Capybara
   class CapybaraError < StandardError; end
   class DriverNotFoundError < CapybaraError; end
@@ -14,7 +13,7 @@ module Capybara
 
   class << self
     attr_accessor :asset_root, :app_host, :run_server, :default_host
-    attr_accessor :server_port
+    attr_accessor :server_port, :server_boot_timeout
     attr_accessor :default_selector, :default_wait_time, :ignore_hidden_elements
     attr_accessor :save_and_open_page_path
 
@@ -108,6 +107,74 @@ module Capybara
       @drivers ||= {}
     end
 
+    ##
+    #
+    # 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.
+    #
+    # @yield [app, port]                      This block recieves a rack app and port and should run a Rack handler
+    #
+    def server(&block)
+      if block_given?
+        @server = block
+      else
+        @server
+      end
+    end
+
+    ##
+    #
+    # 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
+    #
+    def string(html)
+      Capybara::Node::Simple.new(html)
+    end
+
+    ##
+    #
+    # 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
+    #
+    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
+
     def deprecate(method, alternate_method)
       warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
     end
@@ -115,12 +182,19 @@ module Capybara
 
   autoload :Server,     'capybara/server'
   autoload :Session,    'capybara/session'
-  autoload :Node,       'capybara/node'
-  autoload :Document,   'capybara/node'
-  autoload :Element,    'capybara/node'
   autoload :Selector,   'capybara/selector'
   autoload :VERSION,    'capybara/version'
 
+  module Node
+    autoload :Base,       'capybara/node/base'
+    autoload :Simple,     'capybara/node/simple'
+    autoload :Element,    'capybara/node/element'
+    autoload :Document,   'capybara/node/document'
+    autoload :Finders,    'capybara/node/finders'
+    autoload :Matchers,   'capybara/node/matchers'
+    autoload :Actions,    'capybara/node/actions'
+  end
+
   module Driver
     autoload :Base,     'capybara/driver/base'
     autoload :Node,     'capybara/driver/node'
@@ -133,6 +207,8 @@ end
 
 Capybara.configure do |config|
   config.run_server = true
+  config.server {|app, port| Capybara.run_default_server(app, port)}
+  config.server_boot_timeout = 10
   config.default_selector = :css
   config.default_wait_time = 2
   config.ignore_hidden_elements = false

data/lib/capybara/driver/base.rb

@@ -30,7 +30,7 @@ class Capybara::Driver::Base
   def response_headers
     raise Capybara::NotSupportedByDriverError
   end
-  
+
   def status_code
     raise Capybara::NotSupportedByDriverError
   end
@@ -53,11 +53,6 @@ class Capybara::Driver::Base
   def reset!
   end
 
-  def cleanup!
-    Capybara.deprecate("cleanup!", "reset!")
-    reset!
-  end
-
   def has_shortcircuit_timeout?
     false
   end

data/lib/capybara/driver/celerity_driver.rb

@@ -5,19 +5,15 @@ class Capybara::Driver::Celerity < Capybara::Driver::Base
     end
 
     def [](name)
-      value = if name.to_sym == :class
-        native.class_name
-      else
-        native.send(name.to_sym)
-      end
+      value = native.attribute_value(name.to_sym)
       return value if value and not value.to_s.empty?
     end
 
     def value
       if tag_name == "select" and native.multiple?
-        find(".//option[@selected]").map { |n| n.value || n.text }
+        find(".//option[@selected]").map { |n| if n.has_value? then n.value else n.text end }
       else
-        self[:value]
+        native.value
       end
     end
 
@@ -60,6 +56,18 @@ class Capybara::Driver::Celerity < Capybara::Driver::Base
       native.visible?
     end
 
+    def checked?
+      native.checked?
+    rescue # https://github.com/langalex/culerity/issues/issue/33
+      false
+    end
+
+    def selected?
+      native.selected?
+    rescue # https://github.com/langalex/culerity/issues/issue/33
+      false
+    end
+
     def path
       native.xpath
     end
@@ -81,7 +89,9 @@ class Capybara::Driver::Celerity < Capybara::Driver::Base
       find('./ancestor::select').first
     end
 
-
+    def has_value?
+      native.object.hasAttribute('value')
+    end
   end
 
   attr_reader :app, :rack_server, :options
@@ -135,7 +145,7 @@ class Capybara::Driver::Celerity < Capybara::Driver::Base
   def browser
     unless @_browser
       require 'celerity'
-      @_browser = ::Celerity::Browser.new(:browser => :firefox, :log_level => :off)
+      @_browser = ::Celerity::Browser.new(options)
     end
 
     @_browser

data/lib/capybara/driver/node.rb

@@ -48,6 +48,14 @@ module Capybara
         raise NotImplementedError
       end
 
+      def checked?
+        raise NotImplementedError
+      end
+
+      def selected?
+        raise NotImplementedError
+      end
+
       def path
         raise NotSupportedByDriverError
       end

data/lib/capybara/driver/rack_test_driver.rb

@@ -11,28 +11,11 @@ class Capybara::Driver::RackTest < Capybara::Driver::Base
     end
 
     def [](name)
-      attr_name = name.to_s
-      case
-      when 'select' == tag_name && 'value' == attr_name
-        if native['multiple'] == 'multiple'
-          native.xpath(".//option[@selected='selected']").map { |option| option[:value] || option.content  }
-        else
-          option = native.xpath(".//option[@selected='selected']").first || native.xpath(".//option").first
-          option[:value] || option.content if option
-        end
-      when 'input' == tag_name && 'checkbox' == type && 'checked' == attr_name
-        native[attr_name] == 'checked' ? true : false
-      else
-        native[attr_name]
-      end
+      string_node[name]
     end
 
     def value
-      if tag_name == 'textarea'
-        native.content
-      else
-        self[:value]
-      end
+      string_node.value
     end
 
     def set(value)
@@ -82,7 +65,15 @@ class Capybara::Driver::RackTest < Capybara::Driver::Base
     end
 
     def visible?
-      native.xpath("./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none')]").size == 0
+      string_node.visible?
+    end
+
+    def checked?
+      self[:checked]
+    end
+
+    def selected?
+      self[:selected]
     end
 
     def path
@@ -95,6 +86,10 @@ class Capybara::Driver::RackTest < Capybara::Driver::Base
 
   private
 
+    def string_node
+      @string_node ||= Capybara::Node::Simple.new(native)
+    end
+
     # a reference to the select node if this is an option node
     def select_node
       find('./ancestor::select').first
@@ -110,10 +105,25 @@ class Capybara::Driver::RackTest < Capybara::Driver::Base
   end
 
   class Form < Node
+    # This only needs to inherit from Rack::Test::UploadedFile because Rack::Test checks for
+    # the class specifically when determing whether to consturct the request as multipart.
+    # That check should be based solely on the form element's 'enctype' attribute value,
+    # which should probably be provided to Rack::Test in its non-GET request methods.
+    class NilUploadedFile < Rack::Test::UploadedFile
+      def initialize
+        @empty_file = Tempfile.new("nil_uploaded_file")
+        @empty_file.close
+      end
+
+      def original_filename; ""; end
+      def content_type; "application/octet-stream"; end
+      def path; @empty_file.path; end
+    end
+
     def params(button)
       params = {}
 
-      native.xpath(".//input[not(@disabled) and (not(@type) or (@type!='radio' and @type!='checkbox' and @type!='submit' and @type!='image'))]").map do |input|
+      native.xpath(".//input[not(@disabled) and (not(@type) or (@type!='radio' and @type!='file' and @type!='checkbox' and @type!='submit' and @type!='image'))]").map do |input|
         merge_param!(params, input['name'].to_s, input['value'].to_s)
       end
       native.xpath(".//textarea[not(@disabled)]").map do |textarea|
@@ -135,14 +145,17 @@ class Capybara::Driver::RackTest < Capybara::Driver::Base
         end
       end
       native.xpath(".//input[not(@disabled) and @type='file']").map do |input|
-        unless input['value'].to_s.empty?
-          if multipart?
-            content_type = MIME::Types.type_for(input['value'].to_s).first.to_s
-            file = Rack::Test::UploadedFile.new(input['value'].to_s, content_type)
-            merge_param!(params, input['name'].to_s, file)
-          else
-            merge_param!(params, input['name'].to_s, File.basename(input['value'].to_s))
-          end
+        if multipart?
+          file = \
+            if (value = input['value']).to_s.empty?
+              NilUploadedFile.new
+            else
+              content_type = MIME::Types.type_for(value).first.to_s
+              Rack::Test::UploadedFile.new(value, content_type)
+            end
+          merge_param!(params, input['name'].to_s, file)
+        else
+          merge_param!(params, input['name'].to_s, File.basename(input['value'].to_s))
         end
       end
       merge_param!(params, button[:name], button[:value] || "") if button[:name]