capybara 3.32.2

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

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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveCurrentPath < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_current_path(current_path, **@kw_args)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_current_path(current_path, **@kw_args)
+        end
+
+        def description
+          "have current path #{current_path.inspect}"
+        end
+
+      private
+
+        def current_path
+          @args.first
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveSelector < CountableWrappedElementMatcher
+        def initialize(*args, **kw_args, &filter_block)
+          super
+          if (RUBY_VERSION >= '2.7') && (@args.size < 2) && @kw_args.keys.any?(String) # rubocop:disable Style/GuardClause
+            @args.push(@kw_args)
+            @kw_args = {}
+          end
+        end
+
+        def element_matches?(el)
+          el.assert_selector(*@args, **session_query_options, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_selector(*@args, **session_query_options, &@filter_block)
+        end
+
+        def description
+          "have #{query.description}"
+        end
+
+        def query
+          @query ||= Capybara::Queries::SelectorQuery.new(*session_query_args, **session_query_options, &@filter_block)
+        end
+      end
+
+      class HaveAllSelectors < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_all_of_selectors(*@args, **session_query_options, &@filter_block)
+        end
+
+        def does_not_match?(_actual)
+          raise ArgumentError, 'The have_all_selectors matcher does not support use with not_to/should_not'
+        end
+
+        def description
+          'have all selectors'
+        end
+      end
+
+      class HaveNoSelectors < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_none_of_selectors(*@args, **session_query_options, &@filter_block)
+        end
+
+        def does_not_match?(_actual)
+          raise ArgumentError, 'The have_none_of_selectors matcher does not support use with not_to/should_not'
+        end
+
+        def description
+          'have no selectors'
+        end
+      end
+
+      class HaveAnySelectors < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_any_of_selectors(*@args, **session_query_options, &@filter_block)
+        end
+
+        def does_not_match?(_actual)
+          el.assert_none_of_selectors(*@args, **session_query_options, &@filter_block)
+        end
+
+        def description
+          'have any selectors'
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveText < CountableWrappedElementMatcher
+        def element_matches?(el)
+          el.assert_text(*@args, **@kw_args)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_text(*@args, **@kw_args)
+        end
+
+        def description
+          "have text #{format(text)}"
+        end
+
+        def format(content)
+          content.inspect
+        end
+
+      private
+
+        def text
+          @args[0].is_a?(Symbol) ? @args[1] : @args[0]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveTitle < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_title(*@args, **@kw_args)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_title(*@args, **@kw_args)
+        end
+
+        def description
+          "have title #{title.inspect}"
+        end
+
+      private
+
+        def title
+          @args.first
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/have_selector'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class MatchSelector < HaveSelector
+        def element_matches?(el)
+          el.assert_matches_selector(*@args, **session_query_options, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_not_matches_selector(*@args, **session_query_options, &@filter_block)
+        end
+
+        def description
+          "match #{query.description}"
+        end
+
+        def query
+          @query ||= Capybara::Queries::MatchQuery.new(*session_query_args, **session_query_options, &@filter_block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class MatchStyle < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_matches_style(*@args, **@kw_args)
+        end
+
+        def does_not_match?(_actual)
+          raise ArgumentError, 'The match_style matcher does not support use with not_to/should_not'
+        end
+
+        def description
+          'match style'
+        end
+      end
+    end
+  end
+end
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      ##
+      # @deprecated
+      class HaveStyle < MatchStyle
+        def initialize(*args, **kw_args, &filter_block)
+          warn 'HaveStyle matcher is deprecated, please use the MatchStyle matcher instead'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Capybara
+  module RSpecMatchers
+    module SpatialSugar
+      def above(el)
+        options[:above] = el
+        self
+      end
+
+      def below(el)
+        options[:below] = el
+        self
+      end
+
+      def left_of(el)
+        options[:left_of] = el
+        self
+      end
+
+      def right_of(el)
+        options[:right_of] = el
+        self
+      end
+
+      def near(el)
+        options[:near] = el
+        self
+      end
+
+    private
+
+      def options
+        # (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        @kw_args
+      end
+    end
+  end
+end

data/lib/capybara/selector.rb

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/xpath_extensions'
+require 'capybara/selector/selector'
+require 'capybara/selector/definition'
+
+#
+# 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
+#   * :above (Element) - Match elements above the passed element on the page
+#   * :below (Element) - Match elements below the passed element on the page
+#   * :left_of (Element) - Match elements left of the passed element on the page
+#   * :right_of (Element) - Match elements right of the passed element on the page
+#   * :near (Element) - Match elements near (within 50px) the passed element on the page
+#
+# ### 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, placeholder, or
+#     associated label text
+#   * Filters:
+#       * :name (String, Regexp) - Matches the name attribute
+#       * :placeholder (String, Regexp) - 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
+#       * :valid (Boolean) - Match fields that are valid/invalid according to HTML5 form validation
+#
+# * **: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, Regexp) - 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, placeholder, or associated label text
+#   * Filters:
+#       * :name (String, Regexp) - Matches the name attribute
+#       * :placeholder (String, Regexp) - 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
+#       * :valid (Boolean) - Match fields that are valid/invalid according to HTML5 form validation
+#
+# * **:radio_button** - Find radio buttons
+#   * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text
+#   * Filters:
+#       * :name (String, Regexp) - 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, Regexp) - Matches the name attribute
+#       * :checked (Boolean) - Match checked fields?
+#       * :unchecked (Boolean) - Match unchecked fields?
+#       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
+#       * :with (String, Regexp) - Match the current value
+#       * :option - Alias of :with
+#
+# * **:select** - Find select elements
+#   * Locator: Match id, {Capybara.configure test_id} attribute, name, placeholder, or associated label text
+#   * Filters:
+#       * :name (String, Regexp) - Matches the name attribute
+#       * :placeholder (String, Placeholder) - 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
+#       * :enabled_options (Array<String>) - Exact match enabled options
+#       * :disabled_options (Array<String>) - Exact match disabled 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,
+#     placeholder, or associated label text
+#   * Filters:
+#       * :name (String, Regexp) - Matches the name attribute
+#       * :placeholder (String, Regexp) - 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, Regexp) - 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, {Capybara.configure test_id} attribute, or name
+#   * Filters:
+#       * :name (String) - Match name attribute
+#
+# * **:element**
+#   * Locator: Type of element ('div', 'a', etc) - if not specified defaults to '*'
+#   * Filters:
+#       * :\<any> (String, Regexp) - Match on any specified element attribute
+#
+class Capybara::Selector; end
+
+Capybara::Selector::FilterSet.add(:_field) do
+  node_filter(:checked, :boolean) { |node, value| !(value ^ node.checked?) }
+  node_filter(:unchecked, :boolean) { |node, value| (value ^ node.checked?) }
+  node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
+  node_filter(:valid, :boolean) { |node, value| node.evaluate_script('this.validity.valid') == value }
+  node_filter(:name) { |node, value| !value.is_a?(Regexp) || value.match?(node[:name]) }
+  node_filter(:placeholder) { |node, value| !value.is_a?(Regexp) || value.match?(node[:placeholder]) }
+
+  expression_filter(:name) do |xpath, val|
+    builder(xpath).add_attribute_conditions(name: val)
+  end
+  expression_filter(:placeholder) do |xpath, val|
+    builder(xpath).add_attribute_conditions(placeholder: val)
+  end
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+  expression_filter(:multiple) { |xpath, val| xpath[val ? XPath.attr(:multiple) : ~XPath.attr(:multiple)] }
+
+  describe(:expression_filters) do |name: nil, placeholder: nil, disabled: nil, multiple: nil, **|
+    desc = +''
+    desc << ' that is not disabled' if disabled == false
+    desc << " with name #{name}" if name
+    desc << " with placeholder #{placeholder}" if placeholder
+    desc << ' with the multiple attribute' if multiple == true
+    desc << ' without the multiple attribute' if multiple == false
+    desc
+  end
+
+  describe(:node_filters) do |checked: nil, unchecked: nil, disabled: nil, valid: nil, **|
+    desc, states = +'', []
+    states << 'checked' if checked || (unchecked == false)
+    states << 'not checked' if unchecked || (checked == false)
+    states << 'disabled' if disabled == true
+    desc << " that is #{states.join(' and ')}" unless states.empty?
+    desc << ' that is valid' if valid == true
+    desc << ' that is invalid' if valid == false
+    desc
+  end
+end
+
+require 'capybara/selector/definition/xpath'
+require 'capybara/selector/definition/css'
+require 'capybara/selector/definition/id'
+require 'capybara/selector/definition/field'
+require 'capybara/selector/definition/fieldset'
+require 'capybara/selector/definition/link'
+require 'capybara/selector/definition/button'
+require 'capybara/selector/definition/link_or_button'
+require 'capybara/selector/definition/fillable_field'
+require 'capybara/selector/definition/radio_button'
+require 'capybara/selector/definition/checkbox'
+require 'capybara/selector/definition/select'
+require 'capybara/selector/definition/datalist_input'
+require 'capybara/selector/definition/option'
+require 'capybara/selector/definition/datalist_option'
+require 'capybara/selector/definition/file_field'
+require 'capybara/selector/definition/label'
+require 'capybara/selector/definition/table'
+require 'capybara/selector/definition/table_row'
+require 'capybara/selector/definition/frame'
+require 'capybara/selector/definition/element'