capybara 1.0.1 → 1.1.0.rc1

data/History.txt

@@ -1,3 +1,28 @@
+# Version 1.1.0
+
+Release date:
+
+### Fixed
+
+* Sensible inspect for Capybara::Session [Jo Liss]
+* Fix headers and host on redirect [Matt Colyer, Jonas Nicklas, Kim Burgestrand]
+* using_driver now restores the old driver instead of reverting to the default [Carol Nichols]
+* Errors when following links relative to the root path under rack-test [Jonas Nicklas, Kim Burgestrand]
+* Make sure exit codes are propagated properly [Edgar Beigarts]
+
+### Changed
+
+* resynchronization is off by default under Selenium
+
+### Added
+
+* Elements are automatically reloaded (including parents) during wait [Jonas Nicklas]
+* Rescue driver specific element errors, such as the dreaded ObsoleteElementError and retry [Jonas Nicklas]
+* Raise an error if something has frozen time [Jonas Nicklas]
+* Allow within to take a node instead of a selector [Peter Williams]
+* Using wait_time_time to change wait time for a block of code [Jonas Nicklas, Kim Burgestrand]
+* Option for rack-test driver to disable data-method hack [Jonas Nicklas, Kim Burgestrand]
+
 # Version 1.0.1
 
 Release date: 2011-08-12

data/README.rdoc

@@ -8,7 +8,7 @@ Capybara aims to simplify the process of integration testing Rack applications,
 such as Rails, Sinatra or Merb. Capybara simulates how a real user would
 interact with a web application. It is agnostic about the driver running your
 tests and currently comes with Rack::Test and Selenium support built in.
-HtmlUnit and env.js are supported through external gems.
+HtmlUnit, WebKit and env.js are supported through external gems.
 
 A complete reference is available at
 {at rubydoc.info}[http://rubydoc.info/github/jnicklas/capybara/master].
@@ -36,7 +36,7 @@ create a topic branch for every separate change you make.
 Capybara uses bundler in development. To set up a development environment, simply do:
 
     git submodule update --init
-    gem install bundler --pre
+    gem install bundler
     bundle install
 
 == Using Capybara with Cucumber
@@ -282,6 +282,21 @@ Ruby 1.8.7 at this time.
 Note: Envjs does not support transactional fixtures; see the section
 "Transactional Fixtures" below.
 
+=== Capybara-webkit
+
+The {capybara-webkit drive}[https://github.com/thoughtbot/capybara-webkit] is for true headless
+testing. It uses WebKitQt to start a rendering engine process. It can execute JavaScript as well. 
+It is significantly faster than drivers like Selenium since it does not load an entire browser.
+
+You can install it with:
+
+  gem install capybara-webkit
+
+And you can use it by:
+
+  Capybara.javascript_driver = :webkit
+
+
 == The DSL
 
 Capybara's DSL (domain-specific language) is inspired by Webrat. While
@@ -470,7 +485,7 @@ When issuing instructions to the DSL such as:
 
 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
+clicking on the *bar* link would be expected 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

data/lib/capybara.rb

@@ -4,7 +4,9 @@ require 'xpath'
 module Capybara
   class CapybaraError < StandardError; end
   class DriverNotFoundError < CapybaraError; end
+  class FrozenInTime < CapybaraError; end
   class ElementNotFound < CapybaraError; end
+  class ExpectationNotMet < ElementNotFound; end
   class FileNotFound < CapybaraError; end
   class UnselectNotAllowed < CapybaraError; end
   class NotSupportedByDriverError < CapybaraError; end
@@ -16,7 +18,7 @@ module Capybara
     attr_accessor :asset_root, :app_host, :run_server, :default_host
     attr_accessor :server_port, :server_boot_timeout
     attr_accessor :default_selector, :default_wait_time, :ignore_hidden_elements, :prefer_visible_elements
-    attr_accessor :save_and_open_page_path
+    attr_accessor :save_and_open_page_path, :automatic_reload
 
     ##
     #
@@ -36,6 +38,8 @@ module Capybara
     # [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: false)
     # [prefer_visible_elements = Boolean] Whether to prefer visible elements over hidden elements (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
     #
@@ -236,6 +240,7 @@ Capybara.configure do |config|
   config.ignore_hidden_elements = false
   config.prefer_visible_elements = true
   config.default_host = "http://www.example.com"
+  config.automatic_reload = true
 end
 
 Capybara.register_driver :rack_test do |app|

data/lib/capybara/driver/base.rb

@@ -43,6 +43,10 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError
   end
 
+  def invalid_element_errors
+    []
+  end
+
   def wait?
     false
   end

data/lib/capybara/dsl.rb

@@ -49,10 +49,23 @@ module Capybara
     # Yield a block using a specific driver
     #
     def using_driver(driver)
+      previous_driver = Capybara.current_driver
       Capybara.current_driver = driver
       yield
     ensure
-      Capybara.use_default_driver
+      @current_driver = previous_driver
+    end
+
+    ##
+    #
+    # Yield a block using a specific wait time
+    #
+    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
 
     ##
@@ -114,6 +127,15 @@ module Capybara
       Capybara.using_session(name, &block)
     end
 
+    ##
+    #
+    # Shortcut to working in a different session. This is useful when Capybara is included
+    # in a class or module.
+    #
+    def using_wait_time(seconds, &block)
+      Capybara.using_wait_time(seconds, &block)
+    end
+
     ##
     #
     # Shortcut to accessing the current session. This is useful when Capybara is included in a

data/lib/capybara/node/base.rb

@@ -22,7 +22,7 @@ module Capybara
     #     session.has_css?('#foobar')               # from Capybara::Node::Matchers
     #
     class Base
-      attr_reader :session, :base
+      attr_reader :session, :base, :parent
 
       include Capybara::Node::Finders
       include Capybara::Node::Actions
@@ -33,10 +33,26 @@ module Capybara
         @base = base
       end
 
+      def reload
+        self
+      end
+
     protected
 
-      def wait?
-        driver.wait?
+      def wait_until(seconds=Capybara.default_wait_time)
+        start_time = Time.now
+
+        begin
+          yield
+        rescue => e
+          raise e unless driver.wait?
+          raise e unless (driver.respond_to?(:invalid_element_errors) and driver.invalid_element_errors.include?(e.class)) or e.is_a?(Capybara::ElementNotFound)
+          raise e if (Time.now - start_time) >= seconds
+          sleep(0.05)
+          raise Capybara::FrozenInTime, "time appears to be frozen, Capybara does not work with libraries which freeze time, consider using time travelling instead" if Time.now == start_time
+          reload if Capybara.automatic_reload
+          retry
+        end
       end
 
       def driver

data/lib/capybara/node/element.rb

@@ -22,12 +22,18 @@ module Capybara
     #
     class Element < Base
 
+      def initialize(session, base, parent, selector)
+        super(session, base)
+        @parent = parent
+        @selector = selector
+      end
+
       ##
       #
       # @return [Object]    The native element from the driver, this allows access to driver specific methods
       #
       def native
-        base.native
+        wait_until { base.native }
       end
 
       ##
@@ -35,7 +41,7 @@ module Capybara
       # @return [String]    The text of the element
       #
       def text
-        base.text
+        wait_until { base.text }
       end
 
       ##
@@ -48,7 +54,7 @@ module Capybara
       # @return [String]               The value of the attribute
       #
       def [](attribute)
-        base[attribute]
+        wait_until { base[attribute] }
       end
 
       ##
@@ -56,7 +62,7 @@ module Capybara
       # @return [String]    The value of the form element
       #
       def value
-        base.value
+        wait_until { base.value }
       end
 
       ##
@@ -66,7 +72,7 @@ module Capybara
       # @param [String] value    The new value
       #
       def set(value)
-        base.set(value)
+        wait_until { base.set(value) }
       end
 
       ##
@@ -74,7 +80,7 @@ module Capybara
       # Select this node if is an option element inside a select tag
       #
       def select_option
-        base.select_option
+        wait_until { base.select_option }
       end
 
       ##
@@ -82,7 +88,7 @@ module Capybara
       # Unselect this node if is an option element inside a multiple select tag
       #
       def unselect_option
-        base.unselect_option
+        wait_until { base.unselect_option }
       end
 
       ##
@@ -90,7 +96,7 @@ module Capybara
       # Click the Element
       #
       def click
-        base.click
+        wait_until { base.click }
       end
 
       ##
@@ -98,7 +104,7 @@ module Capybara
       # @return [String]      The tag name of the element
       #
       def tag_name
-        base.tag_name
+        wait_until { base.tag_name }
       end
 
       ##
@@ -109,7 +115,7 @@ module Capybara
       # @return [Boolean]     Whether the element is visible
       #
       def visible?
-        base.visible?
+        wait_until { base.visible? }
       end
 
       ##
@@ -119,7 +125,7 @@ module Capybara
       # @return [Boolean]     Whether the element is checked
       #
       def checked?
-        base.checked?
+        wait_until { base.checked? }
       end
 
       ##
@@ -129,7 +135,7 @@ module Capybara
       # @return [Boolean]     Whether the element is selected
       #
       def selected?
-        base.selected?
+        wait_until { base.selected? }
       end
 
       ##
@@ -139,7 +145,7 @@ module Capybara
       # @return [String]      An XPath expression
       #
       def path
-        base.path
+        wait_until { base.path }
       end
 
       ##
@@ -150,7 +156,7 @@ module Capybara
       # @param [String] event       The name of the event to trigger
       #
       def trigger(event)
-        base.trigger(event)
+        wait_until { base.trigger(event) }
       end
 
       ##
@@ -164,7 +170,25 @@ module Capybara
       # @param [Capybara::Element] node     The element to drag to
       #
       def drag_to(node)
-        base.drag_to(node.base)
+        wait_until { base.drag_to(node.base) }
+      end
+
+      def find(*args)
+        wait_until { super }
+      end
+
+      def first(*args)
+        wait_until { super }
+      end
+
+      def all(*args)
+        wait_until { super }
+      end
+
+      def reload
+        reloaded = parent.reload.first(@selector.name, @selector.locator, @selector.options)
+        @base = reloaded.base if reloaded
+        self
       end
 
       def inspect
@@ -172,7 +196,6 @@ module Capybara
       rescue NotSupportedByDriverError
         %(#<Capybara::Element tag="#{tag_name}">)
       end
-
     end
   end
 end

data/lib/capybara/node/finders.rb

@@ -15,7 +15,7 @@ module Capybara
       # +find+ takes the same options as +all+.
       #
       #     page.find('#foo').find('.bar')
-      #     page.find(:xpath, '//div[contains("bar")]')
+      #     page.find(:xpath, '//div[contains(., "bar")]')
       #     page.find('li', :text => 'Quox').click_link('Delete')
       #
       # @param (see Capybara::Node::Finders#all)
@@ -24,18 +24,7 @@ module Capybara
       # @raise  [Capybara::ElementNotFound]   If the element can't be found before time expires
       #
       def find(*args)
-        begin
-          node = wait_conditionally_until { first(*args) }
-        rescue TimeoutError
-        end
-        unless node
-          options = extract_normalized_options(args)
-          normalized = Capybara::Selector.normalize(*args)
-          message = options[:message] || "Unable to find #{normalized.name} #{normalized.locator.inspect}"
-          message = normalized.failure_message.call(self, normalized) if normalized.failure_message
-          raise Capybara::ElementNotFound, message
-        end
-        return node
+        wait_until { first(*args) or raise_find_error(*args) }
       end
 
       ##
@@ -120,10 +109,10 @@ module Capybara
       def all(*args)
         options = extract_normalized_options(args)
 
-        Capybara::Selector.normalize(*args).xpaths.
-          map    { |path| find_in_base(path) }.flatten.
-          select { |node| matches_options(node, options) }.
-          map    { |node| convert_element(node) }
+        selector = Capybara::Selector.normalize(*args)
+        selector.xpaths.
+          map    { |path| find_in_base(selector, path) }.flatten.
+          select { |node| matches_options(node, options) }
       end
 
       ##
@@ -143,10 +132,11 @@ module Capybara
         options = extract_normalized_options(args)
         found_elements = []
 
-        Capybara::Selector.normalize(*args).xpaths.each do |path|
-          find_in_base(path).each do |node|
+        selector = Capybara::Selector.normalize(*args)
+        selector.xpaths.each do |path|
+          find_in_base(selector, path).each do |node|
             if matches_options(node, options)
-              found_elements << convert_element(node)
+              found_elements << node
               return found_elements.last if not Capybara.prefer_visible_elements or node.visible?
             end
           end
@@ -156,16 +146,18 @@ module Capybara
 
     protected
 
-      def find_in_base(xpath)
-        base.find(xpath)
-      end
-
-      def convert_element(element)
-        Capybara::Node::Element.new(session, element)
+      def raise_find_error(*args)
+        options = extract_normalized_options(args)
+        normalized = Capybara::Selector.normalize(*args)
+        message = options[:message] || "Unable to find #{normalized.name} #{normalized.locator.inspect}"
+        message = normalized.failure_message.call(self, normalized) if normalized.failure_message
+        raise Capybara::ElementNotFound, message
       end
 
-      def wait_conditionally_until
-        if wait? then session.wait_until { yield } else yield end
+      def find_in_base(selector, xpath)
+        base.find(xpath).map do |node|
+          Capybara::Node::Element.new(session, node, self, selector)
+        end
       end
 
       def extract_normalized_options(args)
@@ -197,7 +189,7 @@ module Capybara
       end
 
       def has_selected_options?(node, expected)
-        actual = node.find('.//option').select { |option| option.selected? }.map { |option| option.text }
+        actual = node.all(:xpath, './/option').select { |option| option.selected? }.map { |option| option.text }
         (expected - actual).empty?
       end
     end