capybara 3.29.0 → 3.36.0

data/lib/capybara/node/matchers.rb

@@ -60,15 +60,16 @@ module Capybara
       # @param styles [Hash]
       # @return [Boolean]                       If the styles match
       #
-      def matches_style?(styles, **options)
-        make_predicate(options) { assert_matches_style(styles, options) }
+      def matches_style?(styles = nil, **options)
+        styles, options = options, {} if styles.nil?
+        make_predicate(options) { assert_matches_style(styles, **options) }
       end
 
       ##
       # @deprecated Use {#matches_style?} instead.
       #
-      def has_style?(styles, **options)
-        warn 'DEPRECATED: has_style? is deprecated, please use matches_style?'
+      def has_style?(styles = nil, **options)
+        Capybara::Helpers.warn "DEPRECATED: has_style? is deprecated, please use matches_style? : #{Capybara::Helpers.filter_backtrace(caller)}"
         matches_style?(styles, **options)
       end
 
@@ -107,7 +108,9 @@ module Capybara
       #
       def assert_selector(*args, &optional_filter_block)
         _verify_selector_result(args, optional_filter_block) do |result, query|
-          raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count? && (result.any? || query.expects_none?)
+          unless result.matches_count? && (result.any? || query.expects_none?)
+            raise Capybara::ExpectationNotMet, result.failure_message
+          end
         end
       end
 
@@ -120,9 +123,10 @@ module Capybara
       # @param styles [Hash]
       # @raise [Capybara::ExpectationNotMet]    If the element doesn't have the specified styles
       #
-      def assert_matches_style(styles, **options)
-        query_args = _set_query_session_options(styles, options)
-        query = Capybara::Queries::StyleQuery.new(*query_args)
+      def assert_matches_style(styles = nil, **options)
+        styles, options = options, {} if styles.nil?
+        query_args, query_opts = _set_query_session_options(styles, options)
+        query = Capybara::Queries::StyleQuery.new(*query_args, **query_opts)
         synchronize(query.wait) do
           raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
         end
@@ -132,7 +136,7 @@ module Capybara
       ##
       # @deprecated Use {#assert_matches_style} instead.
       #
-      def assert_style(styles, **options)
+      def assert_style(styles = nil, **options)
         warn 'assert_style is deprecated, please use assert_matches_style instead'
         assert_matches_style(styles, **options)
       end
@@ -153,7 +157,7 @@ module Capybara
       # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, **options)
       #
       def assert_all_of_selectors(*args, **options, &optional_filter_block)
-        _verify_multiple(*args, options) do |selector, locator, opts|
+        _verify_multiple(*args, **options) do |selector, locator, opts|
           assert_selector(selector, locator, opts, &optional_filter_block)
         end
       end
@@ -174,7 +178,7 @@ module Capybara
       # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, **options)
       #
       def assert_none_of_selectors(*args, **options, &optional_filter_block)
-        _verify_multiple(*args, options) do |selector, locator, opts|
+        _verify_multiple(*args, **options) do |selector, locator, opts|
           assert_no_selector(selector, locator, opts, &optional_filter_block)
         end
       end
@@ -199,12 +203,10 @@ module Capybara
         selector = extract_selector(args)
         synchronize(wait) do
           res = args.map do |locator|
-            begin
-              assert_selector(selector, locator, options, &optional_filter_block)
-              break nil
-            rescue Capybara::ExpectationNotMet => e
-              e.message
-            end
+            assert_selector(selector, locator, options, &optional_filter_block)
+            break nil
+          rescue Capybara::ExpectationNotMet => e
+            e.message
           end
           raise Capybara::ExpectationNotMet, res.join(' or ') if res
 
@@ -266,7 +268,7 @@ module Capybara
       # @return [Boolean]                         If the expression exists
       #
       def has_xpath?(path, **options, &optional_filter_block)
-        has_selector?(:xpath, path, options, &optional_filter_block)
+        has_selector?(:xpath, path, **options, &optional_filter_block)
       end
 
       ##
@@ -278,7 +280,7 @@ module Capybara
       # @return [Boolean]
       #
       def has_no_xpath?(path, **options, &optional_filter_block)
-        has_no_selector?(:xpath, path, options, &optional_filter_block)
+        has_no_selector?(:xpath, path, **options, &optional_filter_block)
       end
 
       ##
@@ -305,7 +307,7 @@ module Capybara
       # @return [Boolean]                         If the selector exists
       #
       def has_css?(path, **options, &optional_filter_block)
-        has_selector?(:css, path, options, &optional_filter_block)
+        has_selector?(:css, path, **options, &optional_filter_block)
       end
 
       ##
@@ -317,7 +319,7 @@ module Capybara
       # @return [Boolean]
       #
       def has_no_css?(path, **options, &optional_filter_block)
-        has_no_selector?(:css, path, options, &optional_filter_block)
+        has_no_selector?(:css, path, **options, &optional_filter_block)
       end
 
       ##
@@ -330,7 +332,7 @@ module Capybara
       # @return [Boolean]                 Whether it exists
       #
       def has_link?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:link, locator, options, &optional_filter_block)
+        has_selector?(:link, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -342,7 +344,7 @@ module Capybara
       # @return [Boolean]            Whether it doesn't exist
       #
       def has_no_link?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:link, locator, options, &optional_filter_block)
+        has_no_selector?(:link, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -354,7 +356,7 @@ module Capybara
       # @return [Boolean]            Whether it exists
       #
       def has_button?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:button, locator, options, &optional_filter_block)
+        has_selector?(:button, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -366,7 +368,7 @@ module Capybara
       # @return [Boolean]            Whether it doesn't exist
       #
       def has_no_button?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:button, locator, options, &optional_filter_block)
+        has_no_selector?(:button, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -384,7 +386,7 @@ module Capybara
       #
       #     page.has_field?('Email', type: 'email')
       #
-      # Note: 'textarea' and 'select' are valid type values, matching the associated tag names.
+      # NOTE: 'textarea' and 'select' are valid type values, matching the associated tag names.
       #
       # @param [String] locator                  The label, name or id of a field to check for
       # @option options [String, Regexp] :with   The text content of the field or a Regexp to match
@@ -392,7 +394,7 @@ module Capybara
       # @return [Boolean]                        Whether it exists
       #
       def has_field?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:field, locator, options, &optional_filter_block)
+        has_selector?(:field, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -406,7 +408,7 @@ module Capybara
       # @return [Boolean]                        Whether it doesn't exist
       #
       def has_no_field?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:field, locator, options, &optional_filter_block)
+        has_no_selector?(:field, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -419,7 +421,7 @@ module Capybara
       # @return [Boolean]                 Whether it exists
       #
       def has_checked_field?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
+        has_selector?(:field, locator, **options.merge(checked: true), &optional_filter_block)
       end
 
       ##
@@ -432,7 +434,7 @@ module Capybara
       # @return [Boolean]                 Whether it doesn't exist
       #
       def has_no_checked_field?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
+        has_no_selector?(:field, locator, **options.merge(checked: true), &optional_filter_block)
       end
 
       ##
@@ -445,7 +447,7 @@ module Capybara
       # @return [Boolean]                 Whether it exists
       #
       def has_unchecked_field?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
+        has_selector?(:field, locator, **options.merge(unchecked: true), &optional_filter_block)
       end
 
       ##
@@ -458,7 +460,7 @@ module Capybara
       # @return [Boolean]                 Whether it doesn't exist
       #
       def has_no_unchecked_field?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
+        has_no_selector?(:field, locator, **options.merge(unchecked: true), &optional_filter_block)
       end
 
       ##
@@ -491,7 +493,7 @@ module Capybara
       # @return [Boolean]                               Whether it exists
       #
       def has_select?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:select, locator, options, &optional_filter_block)
+        has_selector?(:select, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -503,7 +505,7 @@ module Capybara
       # @return [Boolean]     Whether it doesn't exist
       #
       def has_no_select?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:select, locator, options, &optional_filter_block)
+        has_no_selector?(:select, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -525,7 +527,7 @@ module Capybara
       # @return [Boolean]        Whether it exists
       #
       def has_table?(locator = nil, **options, &optional_filter_block)
-        has_selector?(:table, locator, options, &optional_filter_block)
+        has_selector?(:table, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -537,7 +539,7 @@ module Capybara
       # @return [Boolean]       Whether it doesn't exist
       #
       def has_no_table?(locator = nil, **options, &optional_filter_block)
-        has_no_selector?(:table, locator, options, &optional_filter_block)
+        has_no_selector?(:table, locator, **options, &optional_filter_block)
       end
 
       ##
@@ -595,7 +597,7 @@ module Capybara
       # @return [Boolean]
       #
       def matches_xpath?(xpath, **options, &optional_filter_block)
-        matches_selector?(:xpath, xpath, options, &optional_filter_block)
+        matches_selector?(:xpath, xpath, **options, &optional_filter_block)
       end
 
       ##
@@ -606,7 +608,7 @@ module Capybara
       # @return [Boolean]
       #
       def matches_css?(css, **options, &optional_filter_block)
-        matches_selector?(:css, css, options, &optional_filter_block)
+        matches_selector?(:css, css, **options, &optional_filter_block)
       end
 
       ##
@@ -629,7 +631,7 @@ module Capybara
       # @return [Boolean]
       #
       def not_matches_xpath?(xpath, **options, &optional_filter_block)
-        not_matches_selector?(:xpath, xpath, options, &optional_filter_block)
+        not_matches_selector?(:xpath, xpath, **options, &optional_filter_block)
       end
 
       ##
@@ -640,7 +642,7 @@ module Capybara
       # @return [Boolean]
       #
       def not_matches_css?(css, **options, &optional_filter_block)
-        not_matches_selector?(:css, css, options, &optional_filter_block)
+        not_matches_selector?(:css, css, **options, &optional_filter_block)
       end
 
       ##
@@ -670,8 +672,8 @@ module Capybara
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #
-      def assert_text(*args)
-        _verify_text(args) do |count, query|
+      def assert_text(type_or_text, *args, **opts)
+        _verify_text(type_or_text, *args, **opts) do |count, query|
           unless query.matches_count?(count) && (count.positive? || query.expects_none?)
             raise Capybara::ExpectationNotMet, query.failure_message
           end
@@ -686,8 +688,8 @@ module Capybara
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #
-      def assert_no_text(*args)
-        _verify_text(args) do |count, query|
+      def assert_no_text(type_or_text, *args, **opts)
+        _verify_text(type_or_text, *args, **opts) do |count, query|
           if query.matches_count?(count) && (count.positive? || query.expects_none?)
             raise Capybara::ExpectationNotMet, query.negative_failure_message
           end
@@ -709,7 +711,7 @@ module Capybara
       # @return [Boolean]                            Whether it exists
       #
       def has_text?(*args, **options)
-        make_predicate(options) { assert_text(*args, options) }
+        make_predicate(options) { assert_text(*args, **options) }
       end
       alias_method :has_content?, :has_text?
 
@@ -721,7 +723,7 @@ module Capybara
       # @return [Boolean]  Whether it doesn't exist
       #
       def has_no_text?(*args, **options)
-        make_predicate(options) { assert_no_text(*args, options) }
+        make_predicate(options) { assert_no_text(*args, **options) }
       end
       alias_method :has_no_content?, :has_no_text?
 
@@ -738,7 +740,9 @@ module Capybara
       #
       def assert_ancestor(*args, &optional_filter_block)
         _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query|
-          raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count? && (result.any? || query.expects_none?)
+          unless result.matches_count? && (result.any? || query.expects_none?)
+            raise Capybara::ExpectationNotMet, result.failure_message
+          end
         end
       end
 
@@ -779,7 +783,9 @@ module Capybara
       #
       def assert_sibling(*args, &optional_filter_block)
         _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|
-          raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count? && (result.any? || query.expects_none?)
+          unless result.matches_count? && (result.any? || query.expects_none?)
+            raise Capybara::ExpectationNotMet, result.failure_message
+          end
         end
       end
 
@@ -826,8 +832,14 @@ module Capybara
       end
 
       def _verify_selector_result(query_args, optional_filter_block, query_type = Capybara::Queries::SelectorQuery)
-        query_args = _set_query_session_options(*query_args)
-        query = query_type.new(*query_args, &optional_filter_block)
+        # query_args, query_opts = if query_args[0].is_a? Symbol
+        #   a,o = _set_query_session_options(*query_args.slice(2..))
+        #   [query_args.slice(0..1).concat(a), o]
+        # else
+        #   _set_query_session_options(*query_args)
+        # end
+        query_args, query_opts = _set_query_session_options(*query_args)
+        query = query_type.new(*query_args, **query_opts, &optional_filter_block)
         synchronize(query.wait) do
           yield query.resolve_for(self), query
         end
@@ -835,26 +847,29 @@ module Capybara
       end
 
       def _verify_match_result(query_args, optional_filter_block)
-        query_args = _set_query_session_options(*query_args)
-        query = Capybara::Queries::MatchQuery.new(*query_args, &optional_filter_block)
+        query_args, query_opts = _set_query_session_options(*query_args)
+        query = Capybara::Queries::MatchQuery.new(*query_args, **query_opts, &optional_filter_block)
         synchronize(query.wait) do
           yield query.resolve_for(parent || session&.document || query_scope)
         end
         true
       end
 
-      def _verify_text(query_args)
-        query_args = _set_query_session_options(*query_args)
-        query = Capybara::Queries::TextQuery.new(*query_args)
+      def _verify_text(type = nil, expected_text, **query_options) # rubocop:disable Style/OptionalArguments
+        query_options[:session_options] = session_options
+        query = Capybara::Queries::TextQuery.new(type, expected_text, **query_options)
         synchronize(query.wait) do
           yield query.resolve_for(self), query
         end
         true
       end
 
-      def _set_query_session_options(*query_args, **query_options)
+      def _set_query_session_options(*query_args)
+        query_args, query_options = query_args.dup, {}
+        # query_options = query_args.pop if query_options.empty? && query_args.last.is_a?(Hash)
+        query_options = query_args.pop if query_args.last.is_a?(Hash)
         query_options[:session_options] = session_options
-        query_args.push(query_options)
+        [query_args, query_options]
       end
 
       def make_predicate(options)

data/lib/capybara/node/simple.rb

@@ -100,7 +100,7 @@ module Capybara
       # @param  [Boolean] check_ancestors  Whether to inherit visibility from ancestors
       # @return [Boolean]     Whether the element is visible
       #
-      def visible?(check_ancestors = true)
+      def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter
         return false if (tag_name == 'input') && (native[:type] == 'hidden')
         return false if tag_name == 'template'
 
@@ -108,7 +108,9 @@ module Capybara
           !find_xpath(VISIBILITY_XPATH)
         else
           # No need for an xpath if only checking the current element
-          !(native.key?('hidden') || (/display:\s?none/.match? native[:style]) || %w[script head].include?(tag_name))
+          !(native.key?('hidden') ||
+            /display:\s?none/.match?(native[:style] || '') ||
+            %w[script head style].include?(tag_name))
         end
       end
 
@@ -146,11 +148,15 @@ module Capybara
         native.has_attribute?('multiple')
       end
 
+      def readonly?
+        native.has_attribute?('readonly')
+      end
+
       def synchronize(_seconds = nil)
         yield # simple nodes don't need to wait
       end
 
-      def allow_reload!
+      def allow_reload!(*)
         # no op
       end
 
@@ -185,6 +191,10 @@ module Capybara
         {}
       end
 
+      def ==(other)
+        eql?(other) || (other.respond_to?(:native) && native == other.native)
+      end
+
     private
 
       def option_value(option)

data/lib/capybara/queries/active_element_query.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Capybara
+  # @api private
+  module Queries
+    class ActiveElementQuery < BaseQuery
+      def initialize(**options)
+        @options = options
+        super(@options)
+      end
+
+      def resolve_for(session)
+        node = session.driver.active_element
+        [Capybara::Node::Element.new(session, node, nil, self)]
+      end
+    end
+  end
+end

data/lib/capybara/queries/ancestor_query.rb

@@ -8,15 +8,16 @@ module Capybara
         @child_node = node
 
         node.synchronize do
-          match_results = super(node.session.current_scope, exact)
+          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')
+          match_results = super(scope, exact)
           ancestors = node.find_xpath(XPath.ancestor.to_s)
                           .map(&method(:to_element))
                           .select { |el| match_results.include?(el) }
-          Capybara::Result.new(ancestors, self)
+          Capybara::Result.new(ordered_results(ancestors), self)
         end
       end
 
-      def description(applied = false)
+      def description(applied = false) # rubocop:disable Style/OptionalBooleanParameter
         child_query = @child_node&.instance_variable_get(:@query)
         desc = super
         desc += " that is an ancestor of #{child_query.description}" if child_query

data/lib/capybara/queries/base_query.rb

@@ -79,7 +79,8 @@ module Capybara
         if count
           message << " #{occurrences count}"
         elsif between
-          message << " between #{between.first} and #{between.end ? between.last : 'infinite'} times"
+          message << " between #{between.begin ? between.first : 1} and" \
+                     " #{between.end ? between.last : 'infinite'} times"
         elsif maximum
           message << " at most #{occurrences maximum}"
         elsif minimum

data/lib/capybara/queries/current_path_query.rb

@@ -6,26 +6,30 @@ module Capybara
   # @api private
   module Queries
     class CurrentPathQuery < BaseQuery
-      def initialize(expected_path, **options)
+      def initialize(expected_path, **options, &optional_filter_block)
         super(options)
         @expected_path = expected_path
         @options = {
           url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || '').hostname.nil?,
           ignore_query: false
         }.merge(options)
+        @filter_block = optional_filter_block
         assert_valid_keys
       end
 
       def resolves_for?(session)
         uri = ::Addressable::URI.parse(session.current_url)
-        uri&.query = nil if options[:ignore_query]
-        @actual_path = options[:url] ? uri&.to_s : uri&.request_uri
+        @actual_path = (options[:ignore_query] ? uri&.omit(:query) : uri).then do |u|
+          options[:url] ? u&.to_s : u&.request_uri
+        end
 
-        if @expected_path.is_a? Regexp
+        res = if @expected_path.is_a? Regexp
           @actual_path.to_s.match?(@expected_path)
         else
           ::Addressable::URI.parse(@expected_path) == ::Addressable::URI.parse(@actual_path)
         end
+
+        res && matches_filter_block?(uri)
       end
 
       def failure_message
@@ -38,6 +42,12 @@ module Capybara
 
     private
 
+      def matches_filter_block?(url)
+        return true unless @filter_block
+
+        @filter_block.call(url)
+      end
+
       def failure_message_helper(negated = '')
         verb = @expected_path.is_a?(Regexp) ? 'match' : 'equal'
         "expected #{@actual_path.inspect}#{negated} to #{verb} #{@expected_path.inspect}"