capybara 0.4.1.2 → 1.0.0.beta1

data/lib/capybara.rb

@@ -5,6 +5,7 @@ module Capybara
   class CapybaraError < StandardError; end
   class DriverNotFoundError < CapybaraError; end
   class ElementNotFound < CapybaraError; end
+  class FileNotFound < CapybaraError; end
   class UnselectNotAllowed < CapybaraError; end
   class NotSupportedByDriverError < CapybaraError; end
   class TimeoutError < CapybaraError; end
@@ -14,7 +15,7 @@ module Capybara
   class << self
     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
+    attr_accessor :default_selector, :default_wait_time, :ignore_hidden_elements, :prefer_visible_elements
     attr_accessor :save_and_open_page_path
 
     ##
@@ -34,6 +35,7 @@ module Capybara
     # [default_selector = :css/:xpath]    Methods which take a selector use the given type by default (Default: CSS)
     # [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)
     #
     # === DSL Options
     #
@@ -198,10 +200,30 @@ module Capybara
   module Driver
     autoload :Base,     'capybara/driver/base'
     autoload :Node,     'capybara/driver/node'
-    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'
+
+    class Selenium
+      def initialize(*args)
+        raise "Capybara::Driver::Selenium has been renamed to Capybara::Selenium::Driver"
+      end
+    end
+
+    class RackTest
+      def initialize(*args)
+        raise "Capybara::Driver::RackTest has been renamed to Capybara::RackTest::Driver"
+      end
+    end
+  end
+
+  module RackTest
+    autoload :Driver,  'capybara/rack_test/driver'
+    autoload :Node,    'capybara/rack_test/node'
+    autoload :Form,    'capybara/rack_test/form'
+    autoload :Browser, 'capybara/rack_test/browser'
+  end
+
+  module Selenium
+    autoload :Node,    'capybara/selenium/node'
+    autoload :Driver,  'capybara/selenium/driver'
   end
 end
 
@@ -212,20 +234,14 @@ Capybara.configure do |config|
   config.default_selector = :css
   config.default_wait_time = 2
   config.ignore_hidden_elements = false
+  config.prefer_visible_elements = true
+  config.default_host = "http://www.example.com"
 end
 
 Capybara.register_driver :rack_test do |app|
-  Capybara::Driver::RackTest.new(app)
-end
-
-Capybara.register_driver :celerity do |app|
-  Capybara::Driver::Celerity.new(app)
-end
-
-Capybara.register_driver :culerity do |app|
-  Capybara::Driver::Culerity.new(app)
+  Capybara::RackTest::Driver.new(app)
 end
 
 Capybara.register_driver :selenium do |app|
-  Capybara::Driver::Selenium.new(app)
+  Capybara::Selenium::Driver.new(app)
 end

data/lib/capybara/cucumber.rb

@@ -1,30 +1,26 @@
 require 'capybara'
+
 require 'capybara/dsl'
+require 'capybara/rspec/matchers'
 
-World(Capybara)
+World(Capybara::DSL)
+World(Capybara::RSpecMatchers)
 
 After do
   Capybara.reset_sessions!
 end
 
-Before('@javascript') do
+Before '@javascript' do
   Capybara.current_driver = Capybara.javascript_driver
 end
 
-Before('@selenium') do
-  Capybara.current_driver = :selenium
-end
-
-Before('@celerity') do
-  Capybara.current_driver = :celerity
-end
-
-Before('@culerity') do
-  Capybara.current_driver = :culerity
-end
-
-Before('@rack_test') do
-  Capybara.current_driver = :rack_test
+Before do |scenario|
+  scenario.source_tag_names.each do |tag|
+    driver_name = tag.sub(/^@/, '').to_sym
+    if Capybara.drivers.has_key?(driver_name)
+      Capybara.current_driver = driver_name
+    end
+  end
 end
 
 After do

data/lib/capybara/dsl.rb

@@ -1,8 +1,13 @@
 require 'capybara'
 
 module Capybara
+  def self.included(base)
+    base.send(:include, Capybara::DSL)
+    warn "`include Capybara` is deprecated please use `include Capybara::DSL` instead."
+  end
+
   class << self
-    attr_writer :default_driver, :current_driver, :javascript_driver
+    attr_writer :default_driver, :current_driver, :javascript_driver, :session_name
 
     attr_accessor :app
 
@@ -57,7 +62,7 @@ module Capybara
     # @return [Capybara::Session]     The currently used session
     #
     def current_session
-      session_pool["#{current_driver}#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
+      session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
     end
 
     ##
@@ -70,6 +75,27 @@ module Capybara
     end
     alias_method :reset!, :reset_sessions!
 
+    ##
+    #
+    # The current session name.
+    #
+    # @return [Symbol]    The name of the currently used session.
+    #
+    def session_name
+      @session_name ||= :default
+    end
+
+    ##
+    #
+    # Yield a block using a specific session name.
+    #
+    def using_session(name)
+      self.session_name = name
+      yield
+    ensure
+      self.session_name = :default
+    end
+
   private
 
     def session_pool
@@ -77,33 +103,44 @@ module Capybara
     end
   end
 
-  extend(self)
-
-  ##
-  #
-  # Shortcut to accessing the current session. This is useful when Capybara is included in a
-  # class or module.
-  #
-  #     class MyClass
-  #       include Capybara
-  #
-  #       def has_header?
-  #         page.has_css?('h1')
-  #       end
-  #     end
-  #
-  # @return [Capybara::Session] The current session object
-  #
-  def page
-    Capybara.current_session
-  end
+  module DSL
+
+    ##
+    #
+    # Shortcut to working in a different session. This is useful when Capybara is included
+    # in a class or module.
+    #
+    def using_session(name, &block)
+      Capybara.using_session(name, &block)
+    end
 
-  Session::DSL_METHODS.each do |method|
-    class_eval <<-RUBY, __FILE__, __LINE__+1
-      def #{method}(*args, &block)
-        page.#{method}(*args, &block)
-      end
-    RUBY
+    ##
+    #
+    # Shortcut to accessing the current session. This is useful when Capybara is included in a
+    # class or module.
+    #
+    #     class MyClass
+    #       include Capybara::DSL
+    #
+    #       def has_header?
+    #         page.has_css?('h1')
+    #       end
+    #     end
+    #
+    # @return [Capybara::Session] The current session object
+    #
+    def page
+      Capybara.current_session
+    end
+
+    Session::DSL_METHODS.each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__+1
+        def #{method}(*args, &block)
+          page.#{method}(*args, &block)
+        end
+      RUBY
+    end
   end
 
+  extend(Capybara::DSL)
 end

data/lib/capybara/node/actions.rb

@@ -104,7 +104,7 @@ module Capybara
       #
       #     page.select 'March', :from => 'Month'
       #
-      # @param [String] locator           Which check box to uncheck
+      # @param [String] value             Which option to select
       # @param [Hash{:from => String}]    The id, name or label of the select box
       #
       def select(value, options={})
@@ -121,13 +121,14 @@ module Capybara
 
       ##
       #
-      # Find a select box on the page and select a particular option from it. If the select
-      # box is a multiple select, +select+ can be called multiple times to select more than
+      # Find a select box on the page and unselect a particular option from it. If the select
+      # box is a multiple select, +unselect+ can be called multiple times to unselect more than
       # one option. The select box can be found via its name, id or label text.
       #
-      #     page.uncheck('German')
+      #     page.unselect 'March', :from => 'Month'
       #
-      # @param [String] locator           Which check box to uncheck
+      # @param [String] value             Which option to unselect
+      # @param [Hash{:from => String}]    The id, name or label of the select box
       #
       def unselect(value, options={})
         if options.has_key?(:from)
@@ -152,6 +153,7 @@ module Capybara
       # @param [String] path          The path of the file that will be attached
       #
       def attach_file(locator, path)
+        raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
         msg = "cannot attach file, no file field with id, name, or label '#{locator}' found"
         find(:xpath, XPath::HTML.file_field(locator), :message => msg).set(path)
       end

data/lib/capybara/node/document.rb

@@ -12,6 +12,14 @@ module Capybara
       def inspect
         %(#<Capybara::Document>)
       end
+
+      ##
+      #
+      # @return [String]    The text of the document
+      #
+      def text
+        find(:xpath, '/html').text
+      end
     end
   end
 end

data/lib/capybara/node/finders.rb

@@ -29,8 +29,11 @@ module Capybara
         rescue TimeoutError
         end
         unless node
-          options = if args.last.is_a?(Hash) then args.last else {} end
-          raise Capybara::ElementNotFound, options[:message] || "Unable to find '#{args[1] || args[0]}'"
+          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
       end
@@ -117,7 +120,7 @@ module Capybara
       def all(*args)
         options = extract_normalized_options(args)
 
-        Capybara::Selector.normalize(*args).
+        Capybara::Selector.normalize(*args).xpaths.
           map    { |path| find_in_base(path) }.flatten.
           select { |node| matches_options(node, options) }.
           map    { |node| convert_element(node) }
@@ -138,16 +141,17 @@ module Capybara
       #
       def first(*args)
         options = extract_normalized_options(args)
+        found_elements = []
 
-        Capybara::Selector.normalize(*args).each do |path|
+        Capybara::Selector.normalize(*args).xpaths.each do |path|
           find_in_base(path).each do |node|
             if matches_options(node, options)
-              return convert_element(node)
+              found_elements << convert_element(node)
+              return found_elements.last if not Capybara.prefer_visible_elements or node.visible?
             end
           end
         end
-
-        nil
+        found_elements.first
       end
 
     protected

data/lib/capybara/node/matchers.rb

@@ -43,11 +43,11 @@ module Capybara
           when options[:between]
             options[:between] === results.size
           when options[:count]
-            options[:count] == results.size
+            options[:count].to_i == results.size
           when options[:maximum]
-            options[:maximum] >= results.size
+            options[:maximum].to_i >= results.size
           when options[:minimum]
-            options[:minimum] <= results.size
+            options[:minimum].to_i <= results.size
           else
             results.size > 0
           end
@@ -75,11 +75,11 @@ module Capybara
           when options[:between]
             not(options[:between] === results.size)
           when options[:count]
-            not(options[:count] == results.size)
+            not(options[:count].to_i == results.size)
           when options[:maximum]
-            not(options[:maximum] >= results.size)
+            not(options[:maximum].to_i >= results.size)
           when options[:minimum]
-            not(options[:minimum] <= results.size)
+            not(options[:minimum].to_i <= results.size)
           else
             results.empty?
           end
@@ -293,6 +293,19 @@ module Capybara
         has_xpath?(XPath::HTML.field(locator), :checked => true)
       end
 
+      ##
+      #
+      # Checks if the page or current node has no radio button or
+      # checkbox with the given label, value or id, that is currently
+      # checked.
+      #
+      # @param [String] locator           The label, name or id of a checked field
+      # @return [Boolean]                 Whether it doesn't exists
+      #
+      def has_no_checked_field?(locator)
+        has_no_xpath?(XPath::HTML.field(locator), :checked => true)
+      end
+
       ##
       #
       # Checks if the page or current node has a radio button or
@@ -306,6 +319,19 @@ module Capybara
         has_xpath?(XPath::HTML.field(locator), :unchecked => true)
       end
 
+      ##
+      #
+      # Checks if the page or current node has no radio button or
+      # checkbox with the given label, value or id, that is currently
+      # unchecked.
+      #
+      # @param [String] locator           The label, name or id of an unchecked field
+      # @return [Boolean]                 Whether it doesn't exists
+      #
+      def has_no_unchecked_field?(locator)
+        has_no_xpath?(XPath::HTML.field(locator), :unchecked => true)
+      end
+
       ##
       #
       # Checks if the page or current node has a select field with the

data/lib/capybara/node/simple.rb

@@ -98,6 +98,26 @@ module Capybara
         native.xpath("./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none')]").size == 0
       end
 
+      ##
+      #
+      # Whether or not the element is checked.
+      #
+      # @return [Boolean]     Whether the element is checked
+      #
+      def checked?
+        native[:checked]
+      end
+
+      ##
+      #
+      # Whether or not the element is selected.
+      #
+      # @return [Boolean]     Whether the element is selected
+      #
+      def selected?
+        native[:selected]
+      end
+
     protected
 
       def find_in_base(xpath)

data/lib/capybara/rack_test/browser.rb

@@ -0,0 +1,115 @@
+class Capybara::RackTest::Browser
+  include ::Rack::Test::Methods
+
+  attr_reader :app, :options
+  attr_accessor :current_host
+
+  def initialize(app, options={})
+    @app = app
+    @options = options
+  end
+
+  def visit(path, attributes = {})
+    reset_host!
+    process(:get, path, attributes)
+  end
+
+  def submit(method, path, attributes)
+    path = request_path if not path or path.empty?
+    process(method, path, attributes)
+  end
+
+  def follow(method, path, attributes = {})
+    return if path.gsub(/^#{request_path}/, '').start_with?('#')
+    process(method, path, attributes)
+  end
+
+  def follow_redirects!
+    5.times do
+      follow_redirect! if last_response.redirect?
+    end
+    raise Capybara::InfiniteRedirectError, "redirected more than 5 times, check for infinite redirects." if last_response.redirect?
+  end
+
+  def process(method, path, attributes = {})
+    new_uri = URI.parse(path)
+    current_uri = URI.parse(current_url)
+
+    path = request_path + path if path.start_with?('?')
+    path = current_host + path if path.start_with?('/')
+
+    if new_uri.host
+      @current_host = new_uri.scheme + '://' + new_uri.host
+    end
+
+    reset_cache!
+    send(method, to_binary(path), to_binary( attributes ), env)
+    follow_redirects!
+  end
+
+  def current_url
+    last_request.url
+  rescue Rack::Test::Error
+    ""
+  end
+
+  def reset_host!
+    @current_host = (Capybara.app_host || Capybara.default_host)
+  end
+
+  def reset_cache!
+    @dom = nil
+  end
+
+  def body
+    dom.to_xml
+  end
+
+  def dom
+    @dom ||= Nokogiri::HTML(source)
+  end
+
+  def find(selector)
+    dom.xpath(selector).map { |node| Capybara::RackTest::Node.new(self, node) }
+  end
+
+  def source
+    last_response.body
+  rescue Rack::Test::Error
+    nil
+  end
+
+protected
+
+  def to_binary(object)
+    return object unless Kernel.const_defined?(:Encoding)
+
+    if object.respond_to?(:force_encoding)
+      object.dup.force_encoding(Encoding::ASCII_8BIT)
+    elsif object.respond_to?(:each_pair) #Hash
+      {}.tap { |x| object.each_pair {|k,v| x[to_binary(k)] = to_binary(v) } }
+    elsif object.respond_to?(:each) #Array
+      object.map{|x| to_binary(x)}
+    else
+      object
+    end
+  end
+
+  def request_path
+    last_request.path
+  rescue Rack::Test::Error
+    ""
+  end
+
+  def env
+    env = {}
+    begin
+      env["HTTP_REFERER"] = last_request.url
+    rescue Rack::Test::Error
+      # no request yet
+    end
+    env.merge!(options[:headers]) if options[:headers]
+    env
+  end
+
+end