capybara 3.21.0 → 3.22.0

data/lib/capybara/queries/ancestor_query.rb

@@ -3,12 +3,20 @@
 module Capybara
   module Queries
     class AncestorQuery < Capybara::Queries::SelectorQuery
+      def initialize(*args)
+        super
+        @count_options = {}
+        COUNT_KEYS.each do |key|
+          @count_options[key] = @options.delete(key) if @options.key?(key)
+        end
+      end
+
       # @api private
       def resolve_for(node, exact = nil)
         @child_node = node
         node.synchronize do
           match_results = super(node.session.current_scope, exact)
-          node.all(:xpath, XPath.ancestor) { |el| match_results.include?(el) }
+          node.all(:xpath, XPath.ancestor, **@count_options) { |el| match_results.include?(el) }
         end
       end
 
@@ -18,12 +26,6 @@ module Capybara
         desc += " that is an ancestor of #{child_query.description}" if child_query
         desc
       end
-
-    private
-
-      def valid_keys
-        super - COUNT_KEYS
-      end
     end
   end
 end

data/lib/capybara/queries/sibling_query.rb

@@ -2,15 +2,22 @@
 
 module Capybara
   module Queries
-    class SiblingQuery < MatchQuery
+    class SiblingQuery < SelectorQuery
+      def initialize(*args)
+        super
+        @count_options = {}
+        COUNT_KEYS.each do |key|
+          @count_options[key] = @options.delete(key) if @options.key?(key)
+        end
+      end
+
       # @api private
       def resolve_for(node, exact = nil)
         @sibling_node = node
         node.synchronize do
           match_results = super(node.session.current_scope, exact)
-          node.all(:xpath, XPath.preceding_sibling + XPath.following_sibling) do |el|
-            match_results.include?(el)
-          end
+          xpath = XPath.preceding_sibling + XPath.following_sibling
+          node.all(:xpath, xpath, **@count_options) { |el| match_results.include?(el) }
         end
       end
 

data/lib/capybara/result.rb

@@ -76,6 +76,8 @@ module Capybara
     end
 
     def compare_count
+      return 0 unless @query
+
       count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)
 
       # Only check filters for as many elements as necessary to determine result

data/lib/capybara/rspec/matchers.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'capybara/rspec/matchers/have_selector'
+require 'capybara/rspec/matchers/have_ancestor'
+require 'capybara/rspec/matchers/have_sibling'
 require 'capybara/rspec/matchers/match_selector'
 require 'capybara/rspec/matchers/have_current_path'
 require 'capybara/rspec/matchers/match_style'
@@ -138,7 +140,8 @@ module Capybara
     end
 
     %w[selector css xpath text title current_path link button
-       field checked_field unchecked_field select table].each do |matcher_type|
+       field checked_field unchecked_field select table
+       sibling ancestor].each do |matcher_type|
       define_method "have_no_#{matcher_type}" do |*args, &optional_filter_block|
         Matchers::NegatedMatcher.new(send("have_#{matcher_type}", *args, &optional_filter_block))
       end
@@ -151,6 +154,18 @@ module Capybara
       end
     end
 
+    # RSpec matcher for whether sibling element(s) matching a given selector exist
+    # See {Capybara::Node::Matcher#assert_sibling}
+    def have_sibling(*args, &optional_filter_block)
+      Matchers::HaveSibling.new(*args, &optional_filter_block)
+    end
+
+    # RSpec matcher for whether ancestor element(s) matching a given selector exist
+    # See {Capybara::Node::Matcher#assert_ancestor}
+    def have_ancestor(*args, &optional_filter_block)
+      Matchers::HaveAncestor.new(*args, &optional_filter_block)
+    end
+
     ##
     # Wait for window to become closed.
     # @example

data/lib/capybara/rspec/matchers/have_ancestor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+require 'capybara/rspec/matchers/count_sugar'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveAncestor < WrappedElementMatcher
+        include CountSugar
+
+        def element_matches?(el)
+          el.assert_ancestor(*@args, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_ancestor(*@args, &@filter_block)
+        end
+
+        def description
+          "have ancestor #{query.description}"
+        end
+
+        def query
+          @query ||= Capybara::Queries::AncestorQuery.new(*session_query_args, &@filter_block)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/rspec/matchers/have_sibling.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+require 'capybara/rspec/matchers/count_sugar'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveSibling < WrappedElementMatcher
+        include CountSugar
+
+        def element_matches?(el)
+          el.assert_sibling(*@args, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_sibling(*@args, &@filter_block)
+        end
+
+        def description
+          "have sibling #{query.description}"
+        end
+
+        def query
+          @query ||= Capybara::Queries::SiblingQuery.new(*session_query_args, &@filter_block)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/selector.rb

@@ -4,179 +4,161 @@ require 'capybara/selector/xpath_extensions'
 require 'capybara/selector/selector'
 require 'capybara/selector/definition'
 
-# rubocop:disable Style/AsciiComments
-#
-# ## Built-in Selectors
-#
-#   * **:xpath** - Select elements by XPath expression
-#     * Locator: An XPath expression
-#
-#   * **:css** - Select elements by CSS selector
-#     * Locator: A CSS selector
-#
-#   * **:id** - Select element by id
-#     * Locator: (String, Regexp, XPath::Expression) The id of the element to match
-#
-#   * **:field** - Select field elements (input [not of type submit, image, or hidden], textarea, select)
-#     * Locator: Matches against the id, Capybara.test_id attribute, name, or placeholder
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * :name (String) — Matches the name attribute
-#       * :placeholder (String) — Matches the placeholder attribute
-#       * :type (String) — Matches the type attribute of the field or element type for 'textarea' and 'select'
-#       * :readonly (Boolean)
-#       * :with (String) — Matches the current value of the field
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :checked (Boolean) — Match checked fields?
-#       * :unchecked (Boolean) — Match unchecked fields?
-#       * :disabled (Boolean) — Match disabled field?
-#       * :multiple (Boolean) — Match fields that accept multiple values
-#       * :style (String, Regexp, Hash)
-#
-#   * **:fieldset** - Select fieldset elements
-#     * Locator: Matches id or contents of wrapped legend
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches id attribute
-#       * :legend (String) — Matches contents of wrapped legend
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :style (String, Regexp, Hash)
-#
-#   * **:link** - Find links ( <a> elements with an href attribute )
-#     * Locator: Matches the id or title attributes, or the string content of the link, or the alt attribute of a contained img element
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * :title (String) — Matches the title attribute
-#       * :alt (String) — Matches the alt attribute of a contained img element
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :href (String, Regexp, nil, false) — Matches the normalized href of the link, if nil will find <a> elements with no href attribute, if false ignores href
-#       * :style (String, Regexp, Hash)
-#
-#   * **:button** - Find buttons ( input [of type submit, reset, image, button] or button elements )
-#     * Locator: Matches the id, Capybara.test_id attribute, name, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
+#
+# All Selectors below support the listed selector specific filters in addition to the following system-wide filters
+#   * :id (String, Regexp, XPath::Expression) - Matches the id attribute
+#   * :class (String, Array<String>, Regexp, XPath::Expression) - Matches the class(es) provided
+#   * :style (String, Regexp, Hash<String,String>) - Match on elements style
+#
+# ### Built-in Selectors
+#
+# * **:xpath** - Select elements by XPath expression
+#   * Locator: An XPath expression
+#
+# * **:css** - Select elements by CSS selector
+#   * Locator: A CSS selector
+#
+# * **:id** - Select element by id
+#   * Locator: (String, Regexp, XPath::Expression) The id of the element to match
+#
+# * **:field** - Select field elements (input [not of type submit, image, or hidden], textarea, select)
+#   * Locator: Matches against the id, {Capybara.configure test_id} attribute, name, or placeholder
+#   * Filters:
 #       * :name (String) - Matches the name attribute
-#       * :title (String) — Matches the title attribute
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :value (String) — Matches the value of an input button
-#       * :type
-#       * :style (String, Regexp, Hash)
-#
-#   * **:link_or_button** - Find links or buttons
-#     * Locator: See :link and :button selectors
-#
-#   * **:fillable_field** - Find text fillable fields ( textarea, input [not of type submit, image, radio, checkbox, hidden, file] )
-#     * Locator: Matches against the id, Capybara.test_id attribute, name, or placeholder
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * :name (String) — Matches the name attribute
-#       * :placeholder (String) — Matches the placeholder attribute
-#       * :with (String) — Matches the current value of the field
-#       * :type (String) — Matches the type attribute of the field or element type for 'textarea'
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :disabled (Boolean) — Match disabled field?
-#       * :multiple (Boolean) — Match fields that accept multiple values
-#       * :style (String, Regexp, Hash)
-#
-#   * **:radio_button** - Find radio buttons
-#     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * :name (String) — Matches the name attribute
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :checked (Boolean) — Match checked fields?
-#       * :unchecked (Boolean) — Match unchecked fields?
-#       * :disabled (Boolean) — Match disabled field?
-#       * :option (String) — Match the value
-#       * :style (String, Regexp, Hash)
-#
-#   * **:checkbox** - Find checkboxes
-#     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
-#     * Filters:
-#       * *:id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * *:name (String) — Matches the name attribute
-#       * *:class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * *:checked (Boolean) — Match checked fields?
-#       * *:unchecked (Boolean) — Match unchecked fields?
-#       * *:disabled (Boolean) — Match disabled field?
-#       * *:option (String) — Match the value
-#       * :style (String, Regexp, Hash)
-#
-#   * **:select** - Find select elements
-#     * Locator: Match id, Capybara.test_id attribute, name, placeholder, or associated label text
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * :name (String) — Matches the name attribute
-#       * :placeholder (String) — Matches the placeholder attribute
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :disabled (Boolean) — Match disabled field?
-#       * :multiple (Boolean) — Match fields that accept multiple values
-#       * :options (Array<String>) — Exact match options
-#       * :with_options (Array<String>) — Partial match options
-#       * :selected (String, Array<String>) — Match the selection(s)
-#       * :with_selected (String, Array<String>) — Partial match the selection(s)
-#       * :style (String, Regexp, Hash)
-#
-#   * **:option** - Find option elements
-#     * Locator: Match text of option
-#     * Filters:
-#       * :disabled (Boolean) — Match disabled option
-#       * :selected (Boolean) — Match selected option
-#
-#   * **:datalist_input**
-#     * Locator:
-#     * Filters:
-#       * :disabled
-#       * :name
-#       * :placeholder
-#
-#   * **:datalist_option**
-#     * Locator:
-#
-#   * **:file_field** - Find file input elements
-#     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
-#       * :name (String) — Matches the name attribute
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :disabled (Boolean) — Match disabled field?
-#       * :multiple (Boolean) — Match field that accepts multiple values
-#       * :style (String, Regexp, Hash)
-#
-#   * **:label** - Find label elements
-#     * Locator: Match id or text contents
-#     * Filters:
-#       * :for (Element, String, Regexp) — The element or id of the element associated with the label
-#
-#   * **:table** - Find table elements
-#     * Locator: id or caption text of table
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Match id attribute of table
-#       * :caption (String) — Match text of associated caption
-#       * :class ((String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :style (String, Regexp, Hash)
-#       * :with_rows (Array<Array<String>>, Array<Hash<String, String>>) - Partial match <td> data - visibility of <td> elements is not considered
-#       * :rows (Array<Array<String>>) — Match all <td>s - visibility of <td> elements is not considered
-#       * :with_cols (Array<Array<String>>, Array<Hash<String, String>>) - Partial match <td> data - visibility of <td> elements is not considered
-#       * :cols (Array<Array<String>>) — Match all <td>s - visibility of <td> elements is not considered
-#
-#   * **:table_row** - Find table row
-#     * Locator: Array<String>, Hash<String,String> table row <td> contents - visibility of <td> elements is not considered
-#
-#   * **:frame** - Find frame/iframe elements
-#     * Locator: Match id or name
-#     * Filters:
-#       * :id (String, Regexp, XPath::Expression) — Match id attribute
-#       * :name (String) — Match name attribute
-#       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
-#       * :style (String, Regexp, Hash)
-#
-#   * **:element**
-#     * Locator: Type of element ('div', 'a', etc) - if not specified defaults to '*'
-#     * Filters: Matches on any element attribute
-class Capybara::Selector; end
+#       * :placeholder (String) - Matches the placeholder attribute
+#       * :type (String) - Matches the type attribute of the field or element type for 'textarea' and 'select'
+#       * :readonly (Boolean) - Match on the element being readonly
+#       * :with (String, Regexp) - Matches the current value of the field
+#       * :checked (Boolean) - Match checked fields?
+#       * :unchecked (Boolean) - Match unchecked fields?
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :multiple (Boolean) - Match fields that accept multiple values
+#
+# * **:fieldset** - Select fieldset elements
+#   * Locator: Matches id, {Capybara.configure test_id}, or contents of wrapped legend
+#   * Filters:
+#       * :legend (String) - Matches contents of wrapped legend
+#       * :disabled (Boolean) - Match disabled fieldset?
+#
+# * **:link** - Find links (`<a>` elements with an href attribute)
+#   * Locator: Matches the id, {Capybara.configure test_id}, or title attributes, or the string content of the link, or the alt attribute of a contained img element.
+#     By default this selector requires a link to have an href attribute.
+#   * Filters:
+#       * :title (String) - Matches the title attribute
+#       * :alt (String) - Matches the alt attribute of a contained img element
+#       * :href (String, Regexp, nil, false) - Matches the normalized href of the link, if nil will find `<a>` elements with no href attribute, if false ignores href presence
+#
+# * **:button** - Find buttons ( input [of type submit, reset, image, button] or button elements )
+#   * Locator: Matches the id, {Capybara.configure test_id} attribute, name, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :title (String) - Matches the title attribute
+#       * :value (String) - Matches the value of an input button
+#       * :type (String) - Matches the type attribute
+#       * :disabled (Boolean, :all) - Match disabled buttons (Default: false)
+#
+# * **:link_or_button** - Find links or buttons
+#   * Locator: See :link and :button selectors
+#   * Filters:
+#       * :disabled (Boolean, :all) - Match disabled buttons? (Default: false)
+#
+# * **:fillable_field** - Find text fillable fields ( textarea, input [not of type submit, image, radio, checkbox, hidden, file] )
+#   * Locator: Matches against the id, {Capybara.configure test_id} attribute, name, or placeholder
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :placeholder (String) - Matches the placeholder attribute
+#       * :with (String, Regexp) - Matches the current value of the field
+#       * :type (String) - Matches the type attribute of the field or element type for 'textarea'
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :multiple (Boolean) - Match fields that accept multiple values
+#
+# * **:radio_button** - Find radio buttons
+#   * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :checked (Boolean) - Match checked fields?
+#       * :unchecked (Boolean) - Match unchecked fields?
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :option (String, Regexp) - Match the current value
+#       * :with - Alias of :option
+#
+# * **:checkbox** - Find checkboxes
+#   * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :checked (Boolean) - Match checked fields?
+#       * :unchecked (Boolean) - Match unchecked fields?
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :option (String, Regexp) - Match the current value
+#       * :with - Alias of :option
+#
+# * **:select** - Find select elements
+#   * Locator: Match id, {Capybara.configure test_id} attribute, name, placeholder, or associated label text
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :placeholder (String) - Matches the placeholder attribute
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :multiple (Boolean) - Match fields that accept multiple values
+#       * :options (Array<String>) - Exact match options
+#       * :with_options (Array<String>) - Partial match options
+#       * :selected (String, Array<String>) - Match the selection(s)
+#       * :with_selected (String, Array<String>) - Partial match the selection(s)
+#
+# * **:option** - Find option elements
+#   * Locator: Match text of option
+#   * Filters:
+#       * :disabled (Boolean) - Match disabled option
+#       * :selected (Boolean) - Match selected option
+#
+# * **:datalist_input** - Find input field with datalist completion
+#   * Locator: Matches against the id, {Capybara.configure test_id} attribute, name, or placeholder
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :placeholder (String) - Matches the placeholder attribute
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :options (Array<String>) - Exact match options
+#       * :with_options (Array<String>) - Partial match options
+#
+# * **:datalist_option** - Find datalist option
+#   * Locator: Match text or value of option
+#   * Filters:
+#       * :disabled (Boolean) - Match disabled option
+#
+# * **:file_field** - Find file input elements
+#   * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text
+#   * Filters:
+#       * :name (String) - Matches the name attribute
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :multiple (Boolean) - Match field that accepts multiple values
+#
+# * **:label** - Find label elements
+#   * Locator: Match id, {Capybara.configure test_id}, or text contents
+#   * Filters:
+#       * :for (Element, String, Regexp) - The element or id of the element associated with the label
+#
+# * **:table** - Find table elements
+#   * Locator: id, {Capybara.configure test_id}, or caption text of table
+#   * Filters:
+#       * :caption (String) - Match text of associated caption
+#       * :with_rows (Array<Array<String>>, Array<Hash<String, String>>) - Partial match `<td>` data - visibility of `<td>` elements is not considered
+#       * :rows (Array<Array<String>>) - Match all `<td>`s - visibility of `<td>` elements is not considered
+#       * :with_cols (Array<Array<String>>, Array<Hash<String, String>>) - Partial match `<td>` data - visibility of `<td>` elements is not considered
+#       * :cols (Array<Array<String>>) - Match all `<td>`s - visibility of `<td>` elements is not considered
+#
+# * **:table_row** - Find table row
+#   * Locator: Array<String>, Hash<String,String> table row `<td>` contents - visibility of `<td>` elements is not considered
+#
+# * **:frame** - Find frame/iframe elements
+#   * Locator: Match id or name
+#   * Filters:
+#       * :name (String) - Match name attribute
+#
+# * **:element**
+#   * Locator: Type of element ('div', 'a', etc) - if not specified defaults to '*'
+#   * Filters:
+#       * :&lt;any> (String, Regexp) - Match on any specified element attribute
 #
-# rubocop:enable Style/AsciiComments
+class Capybara::Selector; end
 
 Capybara::Selector::FilterSet.add(:_field) do
   node_filter(:checked, :boolean) { |node, value| !(value ^ node.checked?) }