capybara 2.13.0 → 2.14.0

data/lib/capybara/config.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+require 'forwardable'
+require 'capybara/session/config'
+
+module Capybara
+  class Config
+    extend Forwardable
+
+    OPTIONS = [:app, :reuse_server, :threadsafe, :default_wait_time, :server, :default_driver, :javascript_driver]
+
+    attr_accessor :app
+    attr_reader :reuse_server, :threadsafe
+    attr_reader :session_options
+    attr_writer :default_driver, :javascript_driver
+
+    SessionConfig::OPTIONS.each do |method|
+      def_delegators :session_options, method, "#{method}="
+    end
+
+    def initialize
+      @session_options = Capybara::SessionConfig.new
+    end
+
+    def reuse_server=(bool)
+      @reuse_server = bool
+    end
+
+    def threadsafe=(bool)
+      warn "Capybara.threadsafe == true is a BETA feature and may change in future minor versions" if bool
+      raise "Threadsafe setting cannot be changed once a session is created" if (bool != threadsafe) && Session.instance_created?
+      @threadsafe = bool
+    end
+
+    ##
+    #
+    # Return the proc that Capybara will call to run the Rack application.
+    # The block returned receives a rack app, port, and host/ip and should run a Rack handler
+    # By default, Capybara will try to run webrick.
+    #
+    def server(&block)
+      if block_given?
+        warn "DEPRECATED: Passing a block to Capybara::server is deprecated, please use Capybara::register_server instead"
+        @server = block
+      else
+        @server
+      end
+    end
+
+    ##
+    #
+    # Set the server to use.
+    #
+    #     Capybara.server = :webrick
+    #
+    # @param [Symbol] name     Name of the server type to use
+    # @see register_server
+    #
+    def server=(name)
+      @server = if name.respond_to? :call
+        name
+      else
+        Capybara.servers[name.to_sym]
+      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 used when JavaScript is needed
+    #
+    def javascript_driver
+      @javascript_driver || :selenium
+    end
+
+    # @deprecated Use default_max_wait_time instead
+    def default_wait_time
+      deprecate('default_wait_time', 'default_max_wait_time', true)
+      default_max_wait_time
+    end
+
+    # @deprecated Use default_max_wait_time= instead
+    def default_wait_time=(t)
+      deprecate('default_wait_time=', 'default_max_wait_time=')
+      self.default_max_wait_time = t
+    end
+
+    def deprecate(method, alternate_method, once=false)
+      @deprecation_notified ||= {}
+      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once and @deprecation_notified[method]
+      @deprecation_notified[method]=true
+    end
+  end
+
+  class ConfigureDeprecator
+    def initialize(config)
+      @config = config
+    end
+
+    def method_missing(m, *args, &block)
+      if @config.respond_to?(m)
+        @config.public_send(m, *args, &block)
+      elsif Capybara.respond_to?(m)
+        warn "Calling #{m} from Capybara.configure is deprecated - please call it on Capybara directly ( Capybara.#{m}(...) )"
+        Capybara.public_send(m, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      @config.respond_to_missing?(m, include_private) || Capybara.respond_to_missing?(m, include_private)
+    end
+  end
+end

data/lib/capybara/cucumber.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'capybara/dsl'
 require 'capybara/rspec/matchers'
+require 'capybara/rspec/matcher_proxies'
 
 World(Capybara::DSL)
 World(Capybara::RSpecMatchers)

data/lib/capybara/driver/base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 class Capybara::Driver::Base
+  attr_writer :session
+
   def current_url
     raise NotImplementedError
   end
@@ -139,6 +141,10 @@ class Capybara::Driver::Base
     false
   end
 
+  def session_options
+    (@session && @session.config) || Capybara.session_options
+  end
+
   # @deprecated This method is being removed
   def browser_initialized?
     warn "DEPRECATED: #browser_initialized? is deprecated and will be removed in the next version of Capybara"

data/lib/capybara/dsl.rb

@@ -21,12 +21,10 @@ module Capybara
       Capybara.using_session(name, &block)
     end
 
-    ##
-    #
     # Shortcut to using a different wait time.
     #
     def using_wait_time(seconds, &block)
-      Capybara.using_wait_time(seconds, &block)
+      page.using_wait_time(seconds, &block)
     end
 
     ##

data/lib/capybara/helpers.rb

@@ -46,11 +46,11 @@ module Capybara
     # @param [String] html     HTML code to inject into
     # @return [String]         The modified HTML code
     #
-    def inject_asset_host(html)
-      if Capybara.asset_host && Nokogiri::HTML(html).css("base").empty?
+    def inject_asset_host(html, asset_host = Capybara.asset_host)
+      if asset_host && Nokogiri::HTML(html).css("base").empty?
         match = html.match(/<head[^<]*?>/)
         if match
-          return html.clone.insert match.end(0), "<base href='#{Capybara.asset_host}' />"
+          return html.clone.insert match.end(0), "<base href='#{asset_host}' />"
         end
       end
 

data/lib/capybara/node/actions.rb

@@ -293,9 +293,9 @@ module Capybara
 
       def _check_with_label(selector, checked, locator, options)
         locator, options = nil, locator if locator.is_a? Hash
-        allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
+        allow_label_click = options.delete(:allow_label_click) { session_options.automatic_label_click }
 
-        synchronize(Capybara::Queries::BaseQuery::wait(options)) do
+        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
           begin
             el = find(selector, locator, options)
             el.set(checked)

data/lib/capybara/node/base.rb

@@ -74,7 +74,7 @@ module Capybara
       # @return [Object]                  The result of the given block
       # @raise  [Capybara::FrozenInTime]  If the return value of `Time.now` appears stuck
       #
-      def synchronize(seconds=Capybara.default_max_wait_time, options = {})
+      def synchronize(seconds=session_options.default_max_wait_time, options = {})
         start_time = Capybara::Helpers.monotonic_time
 
         if session.synchronized
@@ -90,7 +90,7 @@ module Capybara
             raise e if (Capybara::Helpers.monotonic_time - 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 Capybara::Helpers.monotonic_time == start_time
-            reload if Capybara.automatic_reload
+            reload if session_options.automatic_reload
             retry
           ensure
             session.synchronized = false
@@ -114,6 +114,11 @@ module Capybara
         query_scope
       end
 
+      # @api private
+      def session_options
+        session.config
+      end
+
     protected
 
       def catch_error?(error, errors = nil)

data/lib/capybara/node/element.rb

@@ -55,7 +55,7 @@ module Capybara
       # @return [String]              The text of the element
       #
       def text(type=nil)
-        type ||= :all unless Capybara.ignore_hidden_elements or Capybara.visible_text_only
+        type ||= :all unless session_options.ignore_hidden_elements or session_options.visible_text_only
         synchronize do
           if type == :all
             base.all_text
@@ -374,6 +374,12 @@ module Capybara
         %(#<Capybara::Node::Element tag="#{tag_name}" path="#{path}">)
       rescue NotSupportedByDriverError
         %(#<Capybara::Node::Element tag="#{tag_name}">)
+      rescue => e
+        if session.driver.invalid_element_errors.any? { |et| e.is_a?(et)}
+          %(Obsolete #<Capybara::Node::Element>)
+        else
+          raise
+        end
       end
     end
   end

data/lib/capybara/node/finders.rb

@@ -29,11 +29,16 @@ module Capybara
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
       #
       def find(*args, &optional_filter_block)
+        if args.last.is_a? Hash
+          args.last[:session_options] = session_options
+        else
+          args.push(session_options: session_options)
+        end
         query = Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
         synchronize(query.wait) do
-          if (query.match == :smart or query.match == :prefer_exact) and query.supports_exact?
+          if (query.match == :smart or query.match == :prefer_exact)
             result = query.resolve_for(self, true)
-            result = query.resolve_for(self, false) if result.empty? && !query.exact?
+            result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?
           else
             result = query.resolve_for(self)
           end
@@ -208,6 +213,11 @@ module Capybara
       # @return [Capybara::Result]                   A collection of found elements
       #
       def all(*args, &optional_filter_block)
+        if args.last.is_a? Hash
+          args.last[:session_options] = session_options
+        else
+          args.push(session_options: session_options)
+        end
         query = Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
         synchronize(query.wait) do
           result = query.resolve_for(self)
@@ -233,7 +243,7 @@ module Capybara
       # @return [Capybara::Node::Element]            The found element or nil
       #
       def first(*args, &optional_filter_block)
-        if Capybara.wait_on_first_by_default
+        if session_options.wait_on_first_by_default
           options = if args.last.is_a?(Hash) then args.pop.dup else {} end
           args.push({minimum: 1}.merge(options))
         end

data/lib/capybara/node/matchers.rb

@@ -114,8 +114,8 @@ module Capybara
       #
       def assert_all_of_selectors(*args, &optional_filter_block)
         options = if args.last.is_a?(Hash) then args.pop.dup else {} end
-        selector = if args.first.is_a?(Symbol) then args.shift else Capybara.default_selector end
-        wait = options.fetch(:wait, Capybara.default_max_wait_time)
+        selector = if args.first.is_a?(Symbol) then args.shift else session_options.default_selector end
+        wait = options.fetch(:wait, session_options.default_max_wait_time)
         synchronize(wait) do
           args.each do |locator|
             assert_selector(selector, locator, options, &optional_filter_block)
@@ -140,8 +140,8 @@ module Capybara
       #
       def assert_none_of_selectors(*args, &optional_filter_block)
         options = if args.last.is_a?(Hash) then args.pop.dup else {} end
-        selector = if args.first.is_a?(Symbol) then args.shift else Capybara.default_selector end
-        wait = options.fetch(:wait, Capybara.default_max_wait_time)
+        selector = if args.first.is_a?(Symbol) then args.shift else session_options.default_selector end
+        wait = options.fetch(:wait, session_options.default_max_wait_time)
         synchronize(wait) do
           args.each do |locator|
             assert_no_selector(selector, locator, options, &optional_filter_block)
@@ -680,6 +680,7 @@ module Capybara
     private
 
       def _verify_selector_result(query_args, optional_filter_block, &result_block)
+        _set_query_session_options(query_args)
         query = Capybara::Queries::SelectorQuery.new(*query_args, &optional_filter_block)
         synchronize(query.wait) do
           result = query.resolve_for(self)
@@ -689,6 +690,7 @@ module Capybara
       end
 
       def _verify_match_result(query_args, optional_filter_block, &result_block)
+        _set_query_session_options(query_args)
         query = Capybara::Queries::MatchQuery.new(*query_args, &optional_filter_block)
         synchronize(query.wait) do
           result = query.resolve_for(self.query_scope)
@@ -698,6 +700,7 @@ module Capybara
       end
 
       def _verify_text(query_args)
+        _set_query_session_options(query_args)
         query = Capybara::Queries::TextQuery.new(*query_args)
         synchronize(query.wait) do
           count = query.resolve_for(self)
@@ -706,6 +709,14 @@ module Capybara
         return true
       end
 
+      def _set_query_session_options(query_args)
+        if query_args.last.is_a? Hash
+          query_args.last[:session_options] = session_options
+        else
+          query_args.push(session_options: session_options)
+        end
+        query_args
+      end
     end
   end
 end

data/lib/capybara/node/simple.rb

@@ -173,6 +173,11 @@ module Capybara
       def find_xpath(xpath)
         native.xpath(xpath)
       end
+
+      # @api private
+      def session_options
+        Capybara.session_options
+      end
     end
   end
 end

data/lib/capybara/queries/base_query.rb

@@ -6,13 +6,18 @@ module Capybara
       COUNT_KEYS = [:count, :minimum, :maximum, :between]
 
       attr_reader :options
+      attr_writer :session_options
+
+      def session_options
+        @session_options || Capybara.session_options
+      end
 
       def wait
-        self.class.wait(options)
+        self.class.wait(options, session_options.default_max_wait_time)
       end
 
-      def self.wait(options)
-        options.fetch(:wait, Capybara.default_max_wait_time) || 0
+      def self.wait(options, default=Capybara.default_max_wait_time)
+        options.fetch(:wait, default) || 0
       end
 
       ##

data/lib/capybara/queries/selector_query.rb

@@ -9,11 +9,13 @@ module Capybara
 
       def initialize(*args, &filter_block)
         @options = if args.last.is_a?(Hash) then args.pop.dup else {} end
+        self.session_options = @options.delete(:session_options)
+
         @filter_block = filter_block
 
         if args[0].is_a?(Symbol)
           @selector = Selector.all.fetch(args.shift) do |selector_type|
-            warn "Unknown selector type (:#{selector_type}), defaulting to :#{Capybara.default_selector} - This will raise an exception in a future version of Capybara"
+            raise ArgumentError, "Unknown selector type (:#{selector_type})"
             nil
           end
           @locator = args.shift
@@ -21,16 +23,16 @@ module Capybara
           @selector = Selector.all.values.find { |s| s.match?(args[0]) }
           @locator = args.shift
         end
-        @selector ||= Selector.all[Capybara.default_selector]
+        @selector ||= Selector.all[session_options.default_selector]
 
         warn "Unused parameters passed to #{self.class.name} : #{args.to_s}" unless args.empty?
 
         # for compatibility with Capybara 2.0
-        if Capybara.exact_options and @selector == Selector.all[:option]
+        if session_options.exact_options and @selector == Selector.all[:option]
           @options[:exact] = true
         end
 
-        @expression = @selector.call(@locator, @options)
+        @expression = @selector.call(@locator, @options.merge(enable_aria_label: session_options.enable_aria_label))
 
         warn_exact_usage
 
@@ -89,12 +91,12 @@ module Capybara
           end
         end
 
-        res &&= Capybara.using_wait_time(0){ @filter_block.call(node)} unless @filter_block.nil?
+        res &&= node.session.using_wait_time(0){ @filter_block.call(node)} unless @filter_block.nil?
         res
       end
 
       def visible
-        case (vis = options.fetch(:visible){ @selector.default_visibility })
+        case (vis = options.fetch(:visible){ @selector.default_visibility(session_options.ignore_hidden_elements) })
           when true then :visible
           when false then :all
           else vis
@@ -103,11 +105,11 @@ module Capybara
 
       def exact?
         return false if !supports_exact?
-        options.fetch(:exact, Capybara.exact)
+        options.fetch(:exact, session_options.exact)
       end
 
       def match
-        options.fetch(:match, Capybara.match)
+        options.fetch(:match, session_options.match)
       end
 
       def xpath(exact=nil)
@@ -205,7 +207,7 @@ module Capybara
       end
 
       def exact_text
-        options.fetch(:exact_text, Capybara.exact_text)
+        options.fetch(:exact_text, session_options.exact_text)
       end
     end
   end