capybara 1.1.4 → 2.0.0.beta2

data/lib/capybara.rb

@@ -1,11 +1,13 @@
 require 'timeout'
 require 'nokogiri'
 require 'xpath'
+
 module Capybara
   class CapybaraError < StandardError; end
   class DriverNotFoundError < CapybaraError; end
   class FrozenInTime < CapybaraError; end
   class ElementNotFound < CapybaraError; end
+  class Ambiguous < ElementNotFound; end
   class ExpectationNotMet < ElementNotFound; end
   class FileNotFound < CapybaraError; end
   class UnselectNotAllowed < CapybaraError; end
@@ -15,10 +17,12 @@ module Capybara
   class InfiniteRedirectError < TimeoutError; end
 
   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, :prefer_visible_elements
+    attr_accessor :asset_root, :app_host, :run_server, :default_host, :always_include_port
+    attr_accessor :server_host, :server_port
+    attr_accessor :default_selector, :default_wait_time, :ignore_hidden_elements
     attr_accessor :save_and_open_page_path, :automatic_reload
+    attr_writer :default_driver, :current_driver, :javascript_driver, :session_name
+    attr_accessor :app
 
     ##
     #
@@ -33,11 +37,11 @@ module Capybara
     #
     # [asset_root = String]               Where static assets are located, used by save_and_open_page
     # [app_host = String]                 The default host to use when giving a relative URL to visit
+    # [always_include_port = Boolean]     Whether the Rack server's port should automatically be inserted into every visited URL (Default: false)
     # [run_server = Boolean]              Whether to start a Rack server for the given Rack app (Default: true)
     # [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)
     # [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)
     #
@@ -181,14 +185,129 @@ module Capybara
       end
     end
 
+    ##
+    #
+    # @return [Symbol]    The name of the driver to use by default
+    #
+    def default_driver
+      @default_driver || :rack_test
+    end
+
+    ##
+    #
+    # @return [Symbol]    The name of the driver currently in use
+    #
+    def current_driver
+      @current_driver || default_driver
+    end
+    alias_method :mode, :current_driver
+
+    ##
+    #
+    # @return [Symbol]    The name of the driver used when JavaScript is needed
+    #
+    def javascript_driver
+      @javascript_driver || :selenium
+    end
+
+    ##
+    #
+    # Use the default driver as the current driver
+    #
+    def use_default_driver
+      @current_driver = nil
+    end
+
+    ##
+    #
+    # Yield a block using a specific driver
+    #
+    def using_driver(driver)
+      previous_driver = Capybara.current_driver
+      Capybara.current_driver = driver
+      yield
+    ensure
+      @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
+
+    ##
+    #
+    # The current Capybara::Session based on what is set as Capybara.app and Capybara.current_driver
+    #
+    # @return [Capybara::Session]     The currently used session
+    #
+    def current_session
+      session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
+    end
+
+    ##
+    #
+    # Reset sessions, cleaning out the pool of sessions. This will remove any session information such
+    # as cookies.
+    #
+    def reset_sessions!
+      session_pool.each { |mode, session| session.reset! }
+    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
+
+    def included(base)
+      base.send(:include, Capybara::DSL)
+      warn "`include Capybara` is deprecated. Please use `include Capybara::DSL` instead."
+    end
+
     def deprecate(method, alternate_method)
       warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
     end
+
+  private
+
+    def session_pool
+      @session_pool ||= {}
+    end
   end
 
+  self.default_driver = nil
+  self.current_driver = nil
+
+  autoload :DSL,        'capybara/dsl'
   autoload :Server,     'capybara/server'
   autoload :Session,    'capybara/session'
   autoload :Selector,   'capybara/selector'
+  autoload :Query,      'capybara/query'
+  autoload :Result,     'capybara/result'
   autoload :VERSION,    'capybara/version'
 
   module Node
@@ -232,13 +351,12 @@ module Capybara
 end
 
 Capybara.configure do |config|
+  config.always_include_port = false
   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
-  config.prefer_visible_elements = true
   config.default_host = "http://www.example.com"
   config.automatic_reload = true
 end

data/lib/capybara/cucumber.rb

@@ -6,8 +6,9 @@ require 'capybara/rspec/matchers'
 World(Capybara::DSL)
 World(Capybara::RSpecMatchers)
 
-After do
+Before do
   Capybara.reset_sessions!
+  Capybara.use_default_driver
 end
 
 Before '@javascript' do
@@ -22,7 +23,3 @@ Before do |scenario|
     end
   end
 end
-
-After do
-  Capybara.use_default_driver
-end

data/lib/capybara/driver/base.rb

@@ -27,6 +27,10 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError
   end
 
+  def save_screenshot(path, options={})
+    raise Capybara::NotSupportedByDriverError
+  end
+
   def response_headers
     raise Capybara::NotSupportedByDriverError
   end
@@ -51,14 +55,10 @@ class Capybara::Driver::Base
     false
   end
 
-  def wait_until(*args)
-  end
-
   def reset!
   end
 
-  def has_shortcircuit_timeout?
+  def needs_server?
     false
   end
-
 end

data/lib/capybara/driver/node.rb

@@ -65,9 +65,9 @@ module Capybara
       end
 
       def inspect
-        %(#<Capybara::Driver::Node tag="#{tag_name}" path="#{path}">)
+        %(#<#{self.class} tag="#{tag_name}" path="#{path}">)
       rescue NotSupportedByDriverError
-        %(#<Capybara::Driver::Node tag="#{tag_name}">)
+        %(#<#{self.class} tag="#{tag_name}">)
       end
     end
   end

data/lib/capybara/dsl.rb

@@ -1,127 +1,11 @@
 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, :session_name
-
-    attr_accessor :app
-
-    ##
-    #
-    # @return [Symbol]    The name of the driver to use by default
-    #
-    def default_driver
-      @default_driver || :rack_test
-    end
-
-    ##
-    #
-    # @return [Symbol]    The name of the driver currently in use
-    #
-    def current_driver
-      @current_driver || default_driver
-    end
-    alias_method :mode, :current_driver
-
-    ##
-    #
-    # @return [Symbol]    The name of the driver used when JavaScript is needed
-    #
-    def javascript_driver
-      @javascript_driver || :selenium
-    end
-
-    ##
-    #
-    # Use the default driver as the current driver
-    #
-    def use_default_driver
-      @current_driver = nil
-    end
-
-    ##
-    #
-    # Yield a block using a specific driver
-    #
-    def using_driver(driver)
-      previous_driver = Capybara.current_driver
-      Capybara.current_driver = driver
-      yield
-    ensure
-      @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
-
-    ##
-    #
-    # The current Capybara::Session base on what is set as Capybara.app and Capybara.current_driver
-    #
-    # @return [Capybara::Session]     The currently used session
-    #
-    def current_session
-      session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
-    end
-
-    ##
-    #
-    # Reset sessions, cleaning out the pool of sessions. This will remove any session information such
-    # as cookies.
-    #
-    def reset_sessions!
-      session_pool.each { |mode, session| session.reset! }
-    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
-      @session_pool ||= {}
-    end
-  end
-
   module DSL
 
     ##
     #
-    # Shortcut to working in a different session. This is useful when Capybara is included
-    # in a class or module.
+    # Shortcut to working in a different session.
     #
     def using_session(name, &block)
       Capybara.using_session(name, &block)
@@ -129,8 +13,7 @@ module Capybara
 
     ##
     #
-    # Shortcut to working in a different session. This is useful when Capybara is included
-    # in a class or module.
+    # Shortcut to using a different wait time.
     #
     def using_wait_time(seconds, &block)
       Capybara.using_wait_time(seconds, &block)
@@ -138,8 +21,7 @@ module Capybara
 
     ##
     #
-    # Shortcut to accessing the current session. This is useful when Capybara is included in a
-    # class or module.
+    # Shortcut to accessing the current session.
     #
     #     class MyClass
     #       include Capybara::DSL

data/lib/capybara/node/actions.rb

@@ -10,8 +10,7 @@ module Capybara
       # @param [String] locator      Text, id or value of link or button
       #
       def click_link_or_button(locator)
-        msg = "no link or button '#{locator}' found"
-        find(:xpath, XPath::HTML.link_or_button(locator), :message => msg).click
+        find(:link_or_button, locator).click
       end
       alias_method :click_on, :click_link_or_button
 
@@ -23,8 +22,7 @@ module Capybara
       # @param [String] locator      Text, id or text of link
       #
       def click_link(locator)
-        msg = "no link with title, id or text '#{locator}' found"
-        find(:xpath, XPath::HTML.link(locator), :message => msg).click
+        find(:link, locator).click
       end
 
       ##
@@ -34,8 +32,7 @@ module Capybara
       # @param [String] locator      Text, id or value of button
       #
       def click_button(locator)
-        msg = "no button with value or id or text '#{locator}' found"
-        find(:xpath, XPath::HTML.button(locator), :message => msg).click
+        find(:button, locator).click
       end
 
       ##
@@ -49,9 +46,8 @@ module Capybara
       # @param [Hash{:with => String}]    The value to fill in
       #
       def fill_in(locator, options={})
-        msg = "cannot fill in, no text field, text area or password field with id, name, or label '#{locator}' found"
         raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
-        find(:xpath, XPath::HTML.fillable_field(locator), :message => msg).set(options[:with])
+        find(:fillable_field, locator).set(options[:with])
       end
 
       ##
@@ -64,8 +60,7 @@ module Capybara
       # @param [String] locator           Which radio button to choose
       #
       def choose(locator)
-        msg = "cannot choose field, no radio button with id, name, or label '#{locator}' found"
-        find(:xpath, XPath::HTML.radio_button(locator), :message => msg).set(true)
+        find(:radio_button, locator).set(true)
       end
 
       ##
@@ -78,8 +73,7 @@ module Capybara
       # @param [String] locator           Which check box to check
       #
       def check(locator)
-        msg = "cannot check field, no checkbox with id, name, or label '#{locator}' found"
-        find(:xpath, XPath::HTML.checkbox(locator), :message => msg).set(true)
+        find(:checkbox, locator).set(true)
       end
 
       ##
@@ -92,8 +86,7 @@ module Capybara
       # @param [String] locator           Which check box to uncheck
       #
       def uncheck(locator)
-        msg = "cannot uncheck field, no checkbox with id, name, or label '#{locator}' found"
-        find(:xpath, XPath::HTML.checkbox(locator), :message => msg).set(false)
+        find(:checkbox, locator).set(false)
       end
 
       ##
@@ -109,13 +102,9 @@ module Capybara
       #
       def select(value, options={})
         if options.has_key?(:from)
-          no_select_msg = "cannot select option, no select box with id, name, or label '#{options[:from]}' found"
-          no_option_msg = "cannot select option, no option with text '#{value}' in select box '#{options[:from]}'"
-          select = find(:xpath, XPath::HTML.select(options[:from]), :message => no_select_msg)
-          select.find(:xpath, XPath::HTML.option(value), :message => no_option_msg).select_option
+          find(:select, options[:from]).find(:option, value).select_option
         else
-          no_option_msg = "cannot select option, no option with text '#{value}'"
-          find(:xpath, XPath::HTML.option(value), :message => no_option_msg).select_option
+          find(:option, value).select_option
         end
       end
 
@@ -132,13 +121,9 @@ module Capybara
       #
       def unselect(value, options={})
         if options.has_key?(:from)
-          no_select_msg = "cannot unselect option, no select box with id, name, or label '#{options[:from]}' found"
-          no_option_msg = "cannot unselect option, no option with text '#{value}' in select box '#{options[:from]}'"
-          select = find(:xpath, XPath::HTML.select(options[:from]), :message => no_select_msg)
-          select.find(:xpath, XPath::HTML.option(value), :message => no_option_msg).unselect_option
+          find(:select, options[:from]).find(:option, value).unselect_option
         else
-          no_option_msg = "cannot unselect option, no option with text '#{value}'"
-          find(:xpath, XPath::HTML.option(value), :message => no_option_msg).unselect_option
+          find(:option, value).unselect_option
         end
       end
 
@@ -154,8 +139,7 @@ module Capybara
       #
       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)
+        find(:file_field, locator).set(path)
       end
     end
   end