capybara 3.29.0 → 3.36.0

data/lib/capybara/node/base.rb

@@ -103,19 +103,19 @@ module Capybara
 
       # @api private
       def find_css(css, **options)
-        if base.method(:find_css).arity != 1
-          base.find_css(css, **options)
-        else
+        if base.method(:find_css).arity == 1
           base.find_css(css)
+        else
+          base.find_css(css, **options)
         end
       end
 
       # @api private
       def find_xpath(xpath, **options)
-        if base.method(:find_xpath).arity != 1
-          base.find_xpath(xpath, **options)
-        else
+        if base.method(:find_xpath).arity == 1
           base.find_xpath(xpath)
+        else
+          base.find_xpath(xpath, **options)
         end
       end
 

data/lib/capybara/node/document.rb

@@ -40,8 +40,8 @@ module Capybara
         find(:xpath, '/html').evaluate_script(*args)
       end
 
-      def scroll_to(*args)
-        find(:xpath, '//body').scroll_to(*args)
+      def scroll_to(*args, quirks: false, **options)
+        find(:xpath, quirks ? '//body' : '/html').scroll_to(*args, **options)
       end
     end
   end

data/lib/capybara/node/document_matchers.rb

@@ -42,7 +42,7 @@ module Capybara
       # @return [Boolean]
       #
       def has_title?(title, **options)
-        make_predicate(options) { assert_title(title, options) }
+        make_predicate(options) { assert_title(title, **options) }
       end
 
       ##
@@ -52,13 +52,13 @@ module Capybara
       # @return [Boolean]
       #
       def has_no_title?(title, **options)
-        make_predicate(options) { assert_no_title(title, options) }
+        make_predicate(options) { assert_no_title(title, **options) }
       end
 
     private
 
       def _verify_title(title, options)
-        query = Capybara::Queries::TitleQuery.new(title, options)
+        query = Capybara::Queries::TitleQuery.new(title, **options)
         synchronize(query.wait) { yield(query) }
         true
       end

data/lib/capybara/node/element.rb

@@ -27,9 +27,11 @@ module Capybara
         @query_scope = query_scope
         @query = query
         @allow_reload = false
+        @query_idx = nil
       end
 
-      def allow_reload!
+      def allow_reload!(idx = nil)
+        @query_idx = idx
         @allow_reload = true
       end
 
@@ -113,10 +115,12 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element
       def set(value, **options)
-        raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}" if ENV['CAPYBARA_THOROUGH'] && readonly?
+        if ENV['CAPYBARA_THOROUGH'] && readonly?
+          raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}"
+        end
 
         options = session_options.default_set_options.to_h.merge(options)
-        synchronize { base.set(value, options) }
+        synchronize { base.set(value, **options) }
         self
       end
 
@@ -161,10 +165,11 @@ module Capybara
       #       offset will be from the element center, otherwise it will be from the top left corner of the element
       #     @option options [Integer] y  Y coordinate to offset the click location. If {Capybara.configure w3c_click_offset} is `true` the
       #       offset will be from the element center, otherwise it will be from the top left corner of the element
+      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)
       # @return [Capybara::Node::Element]  The element
       def click(*keys, **options)
-        perform_click_action(keys, options) do |k, opts|
-          base.click(k, opts)
+        perform_click_action(keys, **options) do |k, opts|
+          base.click(k, **opts)
         end
       end
 
@@ -174,10 +179,11 @@ module Capybara
       #
       # @macro action_waiting_behavior
       # @macro click_modifiers
+      # @option options [Float] delay  Delay between the mouse down and mouse up events in seconds (0)
       # @return [Capybara::Node::Element]  The element
       def right_click(*keys, **options)
-        perform_click_action(keys, options) do |k, opts|
-          base.right_click(k, opts)
+        perform_click_action(keys, **options) do |k, opts|
+          base.right_click(k, **opts)
         end
       end
 
@@ -189,8 +195,8 @@ module Capybara
       # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
       def double_click(*keys, **options)
-        perform_click_action(keys, options) do |k, opts|
-          base.double_click(k, opts)
+        perform_click_action(keys, **options) do |k, opts|
+          base.double_click(k, **opts)
         end
       end
 
@@ -405,6 +411,8 @@ module Capybara
       # @option options [Boolean] :html5   When using Chrome/Firefox with Selenium enables to force the use of HTML5
       #                                    (true) or legacy (false) dragging. If not specified the driver will attempt to
       #                                    detect the correct method to use.
+      # @option options [Array<Symbol>,Symbol] :drop_modifiers   Modifier keys which should be held while the dragged element is dropped.
+      #
       #
       # @return [Capybara::Node::Element]  The dragged element
       def drag_to(node, **options)
@@ -427,11 +435,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element
       def drop(*args)
-        options = args.map do |arg|
-          return arg.to_path if arg.respond_to?(:to_path)
-
-          arg
-        end
+        options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }
         synchronize { base.drop(*options) }
         self
       end
@@ -543,14 +547,13 @@ module Capybara
 
       # @api private
       def reload
-        if @allow_reload
-          begin
-            reloaded = @query.resolve_for(query_scope.reload)&.first
+        return self unless @allow_reload
 
-            @base = reloaded.base if reloaded
-          rescue StandardError => e
-            raise e unless catch_error?(e)
-          end
+        begin
+          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]
+          @base = reloaded.base if reloaded
+        rescue StandardError => e
+          raise e unless catch_error?(e)
         end
         self
       end

data/lib/capybara/node/finders.rb

@@ -22,14 +22,15 @@ module Capybara
       #     When String the elements contained text must match exactly, when Boolean controls whether the `text` option must match exactly.
       #     Defaults to {Capybara.configure exact_text}.
       #   @option options [Boolean] normalize_ws
-      #     Whether the `text`/`exact_text` options are compared against elment text with whitespace normalized or as returned by the driver.
+      #     Whether the `text`/`exact_text` options are compared against element text with whitespace normalized or as returned by the driver.
       #     Defaults to {Capybara.configure default_normalize_ws}.
-      #   @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
-      #                                              * true - only finds visible elements.
-      #                                              * false - finds invisible _and_ visible elements.
-      #                                              * :all - same as false; finds visible and invisible elements.
-      #                                              * :hidden - only finds invisible elements.
-      #                                              * :visible - same as true; only finds visible elements.
+      #   @option options [Boolean, Symbol] visible
+      #     Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.
+      #       * true - only finds visible elements.
+      #       * false - finds invisible _and_ visible elements.
+      #       * :all - same as false; finds visible and invisible elements.
+      #       * :hidden - only finds invisible elements.
+      #       * :visible - same as true; only finds visible elements.
       #   @option options [Boolean] obscured  Only find elements with the specified obscured state:
       #                                       * true - only find elements whose centerpoint is not in the viewport or is obscured by another non-descendant element.
       #                                       * false - only find elements whose centerpoint is in the viewport and is not obscured by other non-descendant elements.
@@ -49,7 +50,7 @@ module Capybara
       #
       def find(*args, **options, &optional_filter_block)
         options[:session_options] = session_options
-        synced_resolve Capybara::Queries::SelectorQuery.new(*args, options, &optional_filter_block)
+        synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)
       end
 
       ##
@@ -72,7 +73,7 @@ module Capybara
       #
       def ancestor(*args, **options, &optional_filter_block)
         options[:session_options] = session_options
-        synced_resolve Capybara::Queries::AncestorQuery.new(*args, options, &optional_filter_block)
+        synced_resolve Capybara::Queries::AncestorQuery.new(*args, **options, &optional_filter_block)
       end
 
       ##
@@ -95,7 +96,7 @@ module Capybara
       #
       def sibling(*args, **options, &optional_filter_block)
         options[:session_options] = session_options
-        synced_resolve Capybara::Queries::SiblingQuery.new(*args, options, &optional_filter_block)
+        synced_resolve Capybara::Queries::SiblingQuery.new(*args, **options, &optional_filter_block)
       end
 
       ##
@@ -125,7 +126,7 @@ module Capybara
       # @return [Capybara::Node::Element]   The found element
       #
       def find_field(locator = nil, **options, &optional_filter_block)
-        find(:field, locator, options, &optional_filter_block)
+        find(:field, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -145,7 +146,7 @@ module Capybara
       # @return [Capybara::Node::Element]   The found element
       #
       def find_link(locator = nil, **options, &optional_filter_block)
-        find(:link, locator, options, &optional_filter_block)
+        find(:link, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -172,7 +173,7 @@ module Capybara
       # @return [Capybara::Node::Element]   The found element
       #
       def find_button(locator = nil, **options, &optional_filter_block)
-        find(:button, locator, options, &optional_filter_block)
+        find(:button, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -186,7 +187,7 @@ module Capybara
       # @return [Capybara::Node::Element]   The found element
       #
       def find_by_id(id, **options, &optional_filter_block)
-        find(:id, id, options, &optional_filter_block)
+        find(:id, id, **options, &optional_filter_block)
       end
 
       ##
@@ -235,21 +236,25 @@ module Capybara
       # @option options [Integer] maximum          Maximum number of matches that are expected to be found
       # @option options [Integer] minimum          Minimum number of matches that are expected to be found
       # @option options [Range]   between          Number of matches found must be within the given range
+      # @option options [Boolean] allow_reload     Beta feature - May be removed in any version.
+      #   When `true` allows elements to be reloaded if they become stale. This is an advanced behavior and should only be used
+      #   if you fully understand the potential ramifications. The results can be confusing on dynamic pages. Defaults to `false`
       # @overload all([kind = Capybara.default_selector], locator = nil, **options)
       # @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)
       #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results
       #   @yieldreturn [Boolean]                     Should the element be considered in the results?
       # @return [Capybara::Result]                   A collection of found elements
       # @raise [Capybara::ExpectationNotMet]         The number of elements found doesn't match the specified conditions
-      def all(*args, **options, &optional_filter_block)
+      def all(*args, allow_reload: false, **options, &optional_filter_block)
         minimum_specified = options_include_minimum?(options)
         options = { minimum: 1 }.merge(options) unless minimum_specified
         options[:session_options] = session_options
-        query = Capybara::Queries::SelectorQuery.new(*args, options, &optional_filter_block)
+        query = Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)
         result = nil
         begin
           synchronize(query.wait) do
             result = query.resolve_for(self)
+            result.allow_reload! if allow_reload
             raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
 
             result
@@ -278,7 +283,7 @@ module Capybara
       #
       def first(*args, **options, &optional_filter_block)
         options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)
-        all(*args, options, &optional_filter_block).first
+        all(*args, **options, &optional_filter_block).first
       end
 
     private
@@ -292,7 +297,9 @@ module Capybara
             result = query.resolve_for(self)
           end
 
-          raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.applied_description}" if ambiguous?(query, result)
+          if ambiguous?(query, result)
+            raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.applied_description}"
+          end
           raise Capybara::ElementNotFound, "Unable to find #{query.applied_description}" if result.empty?
 
           result.first