capybara 3.21.0 → 3.22.0

data/lib/capybara/node/matchers.rb

@@ -19,21 +19,20 @@ module Capybara
       # This will check if the expression occurs exactly 4 times.
       #
       # It also accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
       #     page.has_selector?('li', text: 'Horse', visible: true)
       #
-      # has_selector? can also accept XPath expressions generated by the
+      # {#has_selector?} can also accept XPath expressions generated by the
       # XPath gem:
       #
       #     page.has_selector?(:xpath, XPath.descendant(:p))
       #
       # @param (see Capybara::Node::Finders#all)
-      # @param args
-      # @option args [Integer] :count (nil)     Number of times the text should occur
-      # @option args [Integer] :minimum (nil)   Minimum number of times the text should occur
-      # @option args [Integer] :maximum (nil)   Maximum number of times the text should occur
-      # @option args [Range]   :between (nil)   Range of times that should contain number of times text occurs
+      # @option options [Integer] :count (nil)     Number of matching elements that should exist
+      # @option options [Integer] :minimum (nil)   Minimum number of matching elements that should exist
+      # @option options [Integer] :maximum (nil)   Maximum number of matching elements that should exist
+      # @option options [Range]   :between (nil)   Range of number of matching elements that should exist
       # @return [Boolean]                       If the expression exists
       #
       def has_selector?(*args, **options, &optional_filter_block)
@@ -43,9 +42,9 @@ module Capybara
       ##
       #
       # Checks if a given selector is not on the page or a descendant of the current node.
-      # Usage is identical to Capybara::Node::Matchers#has_selector?
+      # Usage is identical to {#has_selector?}.
       #
-      # @param (see Capybara::Node::Finders#has_selector?)
+      # @param (see #has_selector?)
       # @return [Boolean]
       #
       def has_no_selector?(*args, **options, &optional_filter_block)
@@ -54,7 +53,7 @@ module Capybara
 
       ##
       #
-      # Checks if a an element has the specified CSS styles
+      # Checks if a an element has the specified CSS styles.
       #
       #     element.matches_style?( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )
       #
@@ -66,7 +65,7 @@ module Capybara
       end
 
       ##
-      # @deprecated
+      # @deprecated Use {#matches_style?} instead.
       #
       def has_style?(styles, **options)
         warn 'DEPRECATED: has_style? is deprecated, please use matches_style?'
@@ -89,15 +88,15 @@ module Capybara
       # This will check if the expression occurs exactly 4 times. See
       # {Capybara::Node::Finders#all} for other available result size options.
       #
-      # If a :count of 0 is specified, it will behave like {#assert_no_selector};
+      # If a `:count` of 0 is specified, it will behave like {#assert_no_selector};
       # however, use of that method is preferred over this one.
       #
       # It also accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
       #     page.assert_selector('li', text: 'Horse', visible: true)
       #
-      # `assert_selector` can also accept XPath expressions generated by the
+      # {#assert_selector} can also accept XPath expressions generated by the
       # XPath gem:
       #
       #     page.assert_selector(:xpath, XPath.descendant(:p))
@@ -114,7 +113,7 @@ module Capybara
 
       ##
       #
-      # Asserts that an element has the specified CSS styles
+      # Asserts that an element has the specified CSS styles.
       #
       #     element.assert_matches_style( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )
       #
@@ -131,7 +130,8 @@ module Capybara
       end
 
       ##
-      # @deprecated
+      # @deprecated Use {#assert_matches_style} instead.
+      #
       def assert_style(styles, **options)
         warn 'assert_style is deprecated, please use assert_matches_style instead'
         assert_matches_style(styles, **options)
@@ -139,16 +139,16 @@ module Capybara
 
       # Asserts that all of the provided selectors are present on the given page
       # or descendants of the current node.  If options are provided, the assertion
-      # will check that each locator is present with those options as well (other than :wait).
+      # will check that each locator is present with those options as well (other than `:wait`).
       #
       #   page.assert_all_of_selectors(:custom, 'Tom', 'Joe', visible: all)
       #   page.assert_all_of_selectors(:css, '#my_div', 'a.not_clicked')
       #
       # It accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
-      # The :wait option applies to all of the selectors as a group, so all of the locators must be present
-      # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
+      # The `:wait` option applies to all of the selectors as a group, so all of the locators must be present
+      # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.
       #
       # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, **options)
       #
@@ -160,16 +160,16 @@ module Capybara
 
       # Asserts that none of the provided selectors are present on the given page
       # or descendants of the current node. If options are provided, the assertion
-      # will check that each locator is present with those options as well (other than :wait).
+      # will check that each locator is not present with those options as well (other than `:wait`).
       #
       #   page.assert_none_of_selectors(:custom, 'Tom', 'Joe', visible: all)
       #   page.assert_none_of_selectors(:css, '#my_div', 'a.not_clicked')
       #
       # It accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
-      # The :wait option applies to all of the selectors as a group, so none of the locators must be present
-      # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
+      # The `:wait` option applies to all of the selectors as a group, so none of the locators must be present
+      # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.
       #
       # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, **options)
       #
@@ -180,17 +180,17 @@ module Capybara
       end
 
       # Asserts that any of the provided selectors are present on the given page
-      # or descendants of the current node.  If options are provided, the assertion
-      # will check that each locator is present with those options as well (other than :wait).
+      # or descendants of the current node. If options are provided, the assertion
+      # will check that each locator is present with those options as well (other than `:wait`).
       #
       #   page.assert_any_of_selectors(:custom, 'Tom', 'Joe', visible: all)
       #   page.assert_any_of_selectors(:css, '#my_div', 'a.not_clicked')
       #
       # It accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
-      # The :wait option applies to all of the selectors as a group, so any of the locators must be present
-      # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
+      # The `:wait` option applies to all of the selectors as a group, so any of the locators must be present
+      # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.
       #
       # @overload assert_any_of_selectors([kind = Capybara.default_selector], *locators, **options)
       #
@@ -215,17 +215,17 @@ module Capybara
       ##
       #
       # Asserts that a given selector is not on the page or a descendant of the current node.
-      # Usage is identical to Capybara::Node::Matchers#assert_selector
+      # Usage is identical to {#assert_selector}.
       #
-      # Query options such as :count, :minimum, :maximum, and :between are
+      # Query options such as `:count`, `:minimum`, `:maximum`, and `:between` are
       # considered to be an integral part of the selector. This will return
-      # true, for example, if a page contains 4 anchors but the query expects 5:
+      # `true`, for example, if a page contains 4 anchors but the query expects 5:
       #
       #     page.assert_no_selector('a', minimum: 1) # Found, raises Capybara::ExpectationNotMet
       #     page.assert_no_selector('a', count: 4)   # Found, raises Capybara::ExpectationNotMet
       #     page.assert_no_selector('a', count: 5)   # Not Found, returns true
       #
-      # @param (see Capybara::Node::Finders#assert_selector)
+      # @param (see #assert_selector)
       # @raise [Capybara::ExpectationNotMet]      If the selector exists
       #
       def assert_no_selector(*args, &optional_filter_block)
@@ -250,11 +250,11 @@ module Capybara
       # This will check if the expression occurs exactly 4 times.
       #
       # It also accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
       #     page.has_xpath?('.//li', text: 'Horse', visible: true)
       #
-      # has_xpath? can also accept XPath expressions generate by the
+      # {#has_xpath?} can also accept XPath expressions generated by the
       # XPath gem:
       #
       #     xpath = XPath.generate { |x| x.descendant(:p) }
@@ -272,9 +272,9 @@ module Capybara
       ##
       #
       # Checks if a given XPath expression is not on the page or a descendant of the current node.
-      # Usage is identical to Capybara::Node::Matchers#has_xpath?
+      # Usage is identical to {#has_xpath?}.
       #
-      # @param (see Capybara::Node::Finders#has_xpath?)
+      # @param (see #has_xpath?)
       # @return [Boolean]
       #
       def has_no_xpath?(path, **options, &optional_filter_block)
@@ -295,7 +295,7 @@ module Capybara
       # This will check if the selector occurs exactly 4 times.
       #
       # It also accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
       #     page.has_css?('li', text: 'Horse', visible: true)
       #
@@ -311,9 +311,9 @@ module Capybara
       ##
       #
       # Checks if a given CSS selector is not on the page or a descendant of the current node.
-      # Usage is identical to Capybara::Node::Matchers#has_css?
+      # Usage is identical to {#has_css?}.
       #
-      # @param (see Capybara::Node::Finders#has_css?)
+      # @param (see #has_css?)
       # @return [Boolean]
       #
       def has_no_css?(path, **options, &optional_filter_block)
@@ -326,7 +326,6 @@ module Capybara
       # text or id.
       #
       # @param [String] locator           The text or id of a link to check for
-      # @param options
       # @option options [String, Regexp] :href    The value the href attribute must be
       # @return [Boolean]                 Whether it exists
       #
@@ -339,7 +338,7 @@ module Capybara
       # Checks if the page or current node has no link with the given
       # text or id.
       #
-      # @param (see Capybara::Node::Finders#has_link?)
+      # @param (see #has_link?)
       # @return [Boolean]            Whether it doesn't exist
       #
       def has_no_link?(locator = nil, **options, &optional_filter_block)
@@ -376,7 +375,7 @@ module Capybara
       # label, name or id.
       #
       # For text fields and other textual fields, such as textareas and
-      # HTML5 email/url/etc. fields, it's possible to specify a :with
+      # HTML5 email/url/etc. fields, it's possible to specify a `:with`
       # option to specify the text the field should contain:
       #
       #     page.has_field?('Name', with: 'Jonas')
@@ -399,7 +398,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no form field with the given
-      # label, name or id. See {Capybara::Node::Matchers#has_field?}.
+      # label, name or id. See {#has_field?}.
       #
       # @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
@@ -413,7 +412,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has a radio button or
-      # checkbox with the given label, value, id, or Capybara.test_id attribute that is currently
+      # checkbox with the given label, value, id, or {Capybara.configure test_id} attribute that is currently
       # checked.
       #
       # @param [String] locator           The label, name or id of a checked field
@@ -426,7 +425,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no radio button or
-      # checkbox with the given label, value or id, or Capybara.test_id attribute that is currently
+      # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently
       # checked.
       #
       # @param [String] locator           The label, name or id of a checked field
@@ -439,7 +438,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has a radio button or
-      # checkbox with the given label, value or id, or Capybara.test_id attribute that is currently
+      # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently
       # unchecked.
       #
       # @param [String] locator           The label, name or id of an unchecked field
@@ -452,7 +451,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no radio button or
-      # checkbox with the given label, value or id, or Capybara.test_id attribute that is currently
+      # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently
       # unchecked.
       #
       # @param [String] locator           The label, name or id of an unchecked field
@@ -498,9 +497,9 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no select field with the
-      # given label, name or id. See {Capybara::Node::Matchers#has_select?}.
+      # given label, name or id. See {#has_select?}.
       #
-      # @param (see Capybara::Node::Matchers#has_select?)
+      # @param (see #has_select?)
       # @return [Boolean]     Whether it doesn't exist
       #
       def has_no_select?(locator = nil, **options, &optional_filter_block)
@@ -532,9 +531,9 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no table with the given id
-      # or caption. See {Capybara::Node::Matchers#has_table?}.
+      # or caption. See {#has_table?}.
       #
-      # @param (see Capybara::Node::Matchers#has_table?)
+      # @param (see #has_table?)
       # @return [Boolean]       Whether it doesn't exist
       #
       def has_no_table?(locator = nil, **options, &optional_filter_block)
@@ -543,14 +542,14 @@ module Capybara
 
       ##
       #
-      # Asserts that the current_node matches a given selector
+      # Asserts that the current node matches a given selector.
       #
       #     node.assert_matches_selector('p#foo')
       #     node.assert_matches_selector(:xpath, '//p[@id="foo"]')
       #     node.assert_matches_selector(:foo)
       #
       # It also accepts all options that {Capybara::Node::Finders#all} accepts,
-      # such as :text and :visible.
+      # such as `:text` and `:visible`.
       #
       #     node.assert_matches_selector('li', text: 'Horse', visible: true)
       #
@@ -563,6 +562,14 @@ module Capybara
         end
       end
 
+      ##
+      #
+      # Asserts that the current node does not match a given selector.
+      # Usage is identical to {#assert_matches_selector}.
+      #
+      # @param (see #assert_matches_selector)
+      # @raise [Capybara::ExpectationNotMet]      If the selector matches
+      #
       def assert_not_matches_selector(*args, &optional_filter_block)
         _verify_match_result(args, optional_filter_block) do |result|
           raise Capybara::ExpectationNotMet, 'Item matched the provided selector' if result.include? self
@@ -571,9 +578,9 @@ module Capybara
 
       ##
       #
-      # Checks if the current node matches given selector
+      # Checks if the current node matches given selector.
       #
-      # @param (see Capybara::Node::Finders#has_selector?)
+      # @param (see #has_selector?)
       # @return [Boolean]
       #
       def matches_selector?(*args, **options, &optional_filter_block)
@@ -582,7 +589,7 @@ module Capybara
 
       ##
       #
-      # Checks if the current node matches given XPath expression
+      # Checks if the current node matches given XPath expression.
       #
       # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
       # @return [Boolean]
@@ -593,7 +600,7 @@ module Capybara
 
       ##
       #
-      # Checks if the current node matches given CSS selector
+      # Checks if the current node matches given CSS selector.
       #
       # @param [String] css The CSS selector to match against the current code
       # @return [Boolean]
@@ -604,10 +611,10 @@ module Capybara
 
       ##
       #
-      # Checks if the current node does not match given selector
-      # Usage is identical to Capybara::Node::Matchers#has_selector?
+      # Checks if the current node does not match given selector.
+      # Usage is identical to {#has_selector?}.
       #
-      # @param (see Capybara::Node::Finders#has_selector?)
+      # @param (see #has_selector?)
       # @return [Boolean]
       #
       def not_matches_selector?(*args, **options, &optional_filter_block)
@@ -616,7 +623,7 @@ module Capybara
 
       ##
       #
-      # Checks if the current node does not match given XPath expression
+      # Checks if the current node does not match given XPath expression.
       #
       # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
       # @return [Boolean]
@@ -627,7 +634,7 @@ module Capybara
 
       ##
       #
-      # Checks if the current node does not match given CSS selector
+      # Checks if the current node does not match given CSS selector.
       #
       # @param [String] css The CSS selector to match against the current code
       # @return [Boolean]
@@ -642,24 +649,24 @@ module Capybara
       #
       # @!macro text_query_params
       #   @overload $0(type, text, **options)
-      #     @param [:all, :visible] type               Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of `Capybara.ignore_hidden_elements`, which defaults to `true`, corresponding to `:visible`.
+      #     @param [:all, :visible] type               Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of {Capybara.configure ignore_hidden_elements}, which defaults to `true`, corresponding to `:visible`.
       #     @param [String, Regexp] text               The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.
       #     @option options [Integer] :count (nil)     Number of times the text is expected to occur
       #     @option options [Integer] :minimum (nil)   Minimum number of times the text is expected to occur
       #     @option options [Integer] :maximum (nil)   Maximum number of times the text is expected to occur
       #     @option options [Range]   :between (nil)   Range of times that is expected to contain number of times text occurs
-      #     @option options [Numeric] :wait (Capybara.default_max_wait_time)      Maximum time that Capybara will wait for text to eq/match given string/regexp argument
-      #     @option options [Boolean] :exact (Capybara.exact_text) Whether text must be an exact match or just substring
-      #     @option options [Boolean] :normalize_ws (false) When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space
+      #     @option options [Numeric] :wait            Maximum time that Capybara will wait for text to eq/match given string/regexp argument. Defaults to {Capybara.configure default_max_wait_time}.
+      #     @option options [Boolean] :exact           Whether text must be an exact match or just substring. Defaults to {Capybara.configure exact_text}.
+      #     @option options [Boolean] :normalize_ws (false) When `true` replace all whitespace with standard spaces and collapse consecutive whitespace to a single space
       #   @overload $0(text, **options)
       #     @param [String, Regexp] text               The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.
       #     @option options [Integer] :count (nil)     Number of times the text is expected to occur
       #     @option options [Integer] :minimum (nil)   Minimum number of times the text is expected to occur
       #     @option options [Integer] :maximum (nil)   Maximum number of times the text is expected to occur
       #     @option options [Range]   :between (nil)   Range of times that is expected to contain number of times text occurs
-      #     @option options [Numeric] :wait (Capybara.default_max_wait_time)      Maximum time that Capybara will wait for text to eq/match given string/regexp argument
-      #     @option options [Boolean] :exact (Capybara.exact_text) Whether text must be an exact match or just substring
-      #     @option options [Boolean] :normalize_ws (false) When true replace all whitespace with standard spaces and collapse consecutive whitespace to a single space
+      #     @option options [Numeric] :wait            Maximum time that Capybara will wait for text to eq/match given string/regexp argument. Defaults to {Capybara.configure default_max_wait_time}.
+      #     @option options [Boolean] :exact           Whether text must be an exact match or just substring. Defaults to {Capybara.configure exact_text}.
+      #     @option options [Boolean] :normalize_ws (false) When `true` replace all whitespace with standard spaces and collapse consecutive whitespace to a single space
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #
@@ -718,6 +725,88 @@ module Capybara
       end
       alias_method :has_no_content?, :has_no_text?
 
+      ##
+      #
+      # Asserts that a given selector matches an ancestor of the current node.
+      #
+      #     element.assert_ancestor('p#foo')
+      #
+      # Accepts the same options as {#assert_selector}
+      #
+      # @param (see Capybara::Node::Finders#find)
+      # @raise [Capybara::ExpectationNotMet]      If the selector does not exist
+      #
+      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?)
+        end
+      end
+
+      def assert_no_ancestor(*args, &optional_filter_block)
+        _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|
+          if result.matches_count? && (!result.empty? || query.expects_none?)
+            raise Capybara::ExpectationNotMet, result.negative_failure_message
+          end
+        end
+      end
+
+      ##
+      #
+      # Predicate version of {#assert_ancestor}
+      #
+      def has_ancestor?(*args, **options, &optional_filter_block)
+        make_predicate(options) { assert_ancestor(*args, options, &optional_filter_block) }
+      end
+
+      ##
+      #
+      # Predicate version of {#assert_no_ancestor}
+      #
+      def has_no_ancestor?(*args, **options, &optional_filter_block)
+        make_predicate(options) { assert_no_ancestor(*args, options, &optional_filter_block) }
+      end
+
+      ##
+      #
+      # Asserts that a given selector matches a sibling of the current node.
+      #
+      #     element.assert_sibling('p#foo')
+      #
+      # Accepts the same options as {#assert_selector}
+      #
+      # @param (see Capybara::Node::Finders#find)
+      # @raise [Capybara::ExpectationNotMet]      If the selector does not exist
+      #
+      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?)
+        end
+      end
+
+      def assert_no_sibling(*args, &optional_filter_block)
+        _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|
+          if result.matches_count? && (!result.empty? || query.expects_none?)
+            raise Capybara::ExpectationNotMet, result.negative_failure_message
+          end
+        end
+      end
+
+      ##
+      #
+      # Predicate version of {#assert_sibling}
+      #
+      def has_sibling?(*args, **options, &optional_filter_block)
+        make_predicate(options) { assert_sibling(*args, options, &optional_filter_block) }
+      end
+
+      ##
+      #
+      # Predicate version of {#assert_no_sibling}
+      #
+      def has_no_sibling?(*args, **options, &optional_filter_block)
+        make_predicate(options) { assert_no_sibling(*args, options, &optional_filter_block) }
+      end
+
       def ==(other)
         eql?(other) || (other.respond_to?(:base) && base == other.base)
       end
@@ -736,9 +825,9 @@ module Capybara
         end
       end
 
-      def _verify_selector_result(query_args, optional_filter_block)
+      def _verify_selector_result(query_args, optional_filter_block, query_type = Capybara::Queries::SelectorQuery)
         query_args = _set_query_session_options(*query_args)
-        query = Capybara::Queries::SelectorQuery.new(*query_args, &optional_filter_block)
+        query = query_type.new(*query_args, &optional_filter_block)
         synchronize(query.wait) do
           yield query.resolve_for(self), query
         end