capybara 3.23.0 → 3.35.3

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

@@ -1,20 +1,17 @@
 # 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
-
+      class HaveSibling < CountableWrappedElementMatcher
         def element_matches?(el)
-          el.assert_sibling(*@args, &@filter_block)
+          el.assert_sibling(*@args, **session_query_options, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_sibling(*@args, &@filter_block)
+          el.assert_no_sibling(*@args, **session_query_options, &@filter_block)
         end
 
         def description
@@ -22,7 +19,7 @@ module Capybara
         end
 
         def query
-          @query ||= Capybara::Queries::SiblingQuery.new(*session_query_args, &@filter_block)
+          @query ||= Capybara::Queries::SiblingQuery.new(*session_query_args, **session_query_options, &@filter_block)
         end
       end
     end

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

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
 require 'capybara/rspec/matchers/base'
-require 'capybara/rspec/matchers/count_sugar'
 
 module Capybara
   module RSpecMatchers
     module Matchers
-      class HaveText < WrappedElementMatcher
-        include CountSugar
-
+      class HaveText < CountableWrappedElementMatcher
         def element_matches?(el)
-          el.assert_text(*@args)
+          el.assert_text(*@args, **@kw_args)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_text(*@args)
+          el.assert_no_text(*@args, **@kw_args)
         end
 
         def description
-          "text #{format(text)}"
+          "have text #{format(text)}"
         end
 
         def format(content)

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

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class HaveTitle < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_title(*@args)
+          el.assert_title(*@args, **@kw_args)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_title(*@args)
+          el.assert_no_title(*@args, **@kw_args)
         end
 
         def description

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

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class MatchSelector < HaveSelector
         def element_matches?(el)
-          el.assert_matches_selector(*@args, &@filter_block)
+          el.assert_matches_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_not_matches_selector(*@args, &@filter_block)
+          el.assert_not_matches_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def description
@@ -19,7 +19,7 @@ module Capybara
         end
 
         def query
-          @query ||= Capybara::Queries::MatchQuery.new(*session_query_args, &@filter_block)
+          @query ||= Capybara::Queries::MatchQuery.new(*session_query_args, **session_query_options, &@filter_block)
         end
       end
     end

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

@@ -6,8 +6,13 @@ module Capybara
   module RSpecMatchers
     module Matchers
       class MatchStyle < WrappedElementMatcher
+        def initialize(styles = nil, **kw_args, &filter_block)
+          styles, kw_args = kw_args, {} if styles.nil?
+          super(styles, **kw_args, &filter_block)
+        end
+
         def element_matches?(el)
-          el.assert_matches_style(*@args)
+          el.assert_matches_style(*@args, **@kw_args)
         end
 
         def does_not_match?(_actual)
@@ -28,7 +33,7 @@ module Capybara
       ##
       # @deprecated
       class HaveStyle < MatchStyle
-        def initialize(*args, &filter_block)
+        def initialize(*args, **kw_args, &filter_block)
           warn 'HaveStyle matcher is deprecated, please use the MatchStyle matcher instead'
           super
         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

@@ -7,8 +7,13 @@ 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
+#   * :class (String, Array<String | Regexp>, 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
 #
@@ -25,8 +30,8 @@ require 'capybara/selector/definition'
 #   * Locator: Matches against the 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
+#       * :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
@@ -34,6 +39,8 @@ require 'capybara/selector/definition'
 #       * :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
+#       * :validation_message (String, Regexp) - Matches the elements current validationMessage
 #
 # * **:fieldset** - Select fieldset elements
 #   * Locator: Matches id, {Capybara.configure test_id}, or contents of wrapped legend
@@ -52,7 +59,7 @@ require 'capybara/selector/definition'
 # * **: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
+#       * :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
@@ -66,17 +73,19 @@ require 'capybara/selector/definition'
 # * **: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) - Matches the name attribute
-#       * :placeholder (String) - Matches the placeholder attribute
+#       * :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
+#       * :validation_message (String, Regexp) - Matches the elements current validationMessage
 #
 # * **: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
+#       * :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)
@@ -86,21 +95,23 @@ require 'capybara/selector/definition'
 # * **:checkbox** - Find checkboxes
 #   * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text
 #   * Filters:
-#       * :name (String) - Matches the name attribute
+#       * :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
+#       * :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) - Matches the name attribute
-#       * :placeholder (String) - Matches the placeholder attribute
+#       * :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)
@@ -115,8 +126,8 @@ require 'capybara/selector/definition'
 #   * Locator: Matches against the 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
+#       * :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
@@ -129,7 +140,7 @@ require 'capybara/selector/definition'
 # * **: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
+#       * :name (String, Regexp) - Matches the name attribute
 #       * :disabled (Boolean, :all) - Match disabled field? (Default: false)
 #       * :multiple (Boolean) - Match field that accepts multiple values
 #
@@ -160,15 +171,28 @@ require 'capybara/selector/definition'
 #   * Filters:
 #       * :\<any> (String, Regexp) - Match on any specified element attribute
 #
-class Capybara::Selector; end
+class Capybara::Selector; end # rubocop:disable Lint/EmptyClass
 
 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]) }
+  node_filter(:validation_message) do |node, msg|
+    vm = node[:validationMessage]
+    (msg.is_a?(Regexp) ? msg.match?(vm) : vm == msg.to_s).tap do |res|
+      add_error("Expected validation message to be #{msg.inspect} but was #{vm}") unless res
+    end
+  end
 
-  expression_filter(:name) { |xpath, val| xpath[XPath.attr(:name) == val] }
-  expression_filter(:placeholder) { |xpath, val| xpath[XPath.attr(:placeholder) == val] }
+  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)] }
 
@@ -182,12 +206,15 @@ Capybara::Selector::FilterSet.add(:_field) do
     desc
   end
 
-  describe(:node_filters) do |checked: nil, unchecked: nil, disabled: nil, **|
+  describe(:node_filters) do |checked: nil, unchecked: nil, disabled: nil, valid: nil, validation_message: 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 << " with validation message #{validation_message.to_s.inspect}" if validation_message
     desc
   end
 end

data/lib/capybara/selector/builders/css_builder.rb

@@ -17,11 +17,7 @@ module Capybara
           conditions = if name == :class
             class_conditions(value)
           elsif value.is_a? Regexp
-            Selector::RegexpDisassembler.new(value).alternated_substrings.map do |strs|
-              strs.map do |str|
-                "[#{name}*='#{str}'#{' i' if value.casefold?}]"
-              end.join
-            end
+            regexp_conditions(name, value)
           else
             [attribute_conditions(name => value)]
           end
@@ -36,6 +32,14 @@ module Capybara
 
     private
 
+      def regexp_conditions(name, value)
+        Selector::RegexpDisassembler.new(value).alternated_substrings.map do |strs|
+          strs.map do |str|
+            "[#{name}*='#{str}'#{' i' if value.casefold?}]"
+          end.join
+        end
+      end
+
       def attribute_conditions(attributes)
         attributes.map do |attribute, value|
           case value
@@ -70,7 +74,7 @@ module Capybara
             end.join
           end
         else
-          cls = Array(classes).group_by { |cl| cl.start_with?('!') && !cl.start_with?('!!!') }
+          cls = Array(classes).reject { |c| c.is_a? Regexp }.group_by { |cl| cl.match?(/^!(?!!!)/) }
           [(cls[false].to_a.map { |cl| ".#{Capybara::Selector::CSS.escape(cl.sub(/^!!/, ''))}" } +
           cls[true].to_a.map { |cl| ":not(.#{Capybara::Selector::CSS.escape(cl.slice(1..-1))})" }).join]
         end

data/lib/capybara/selector/builders/xpath_builder.rb

@@ -15,6 +15,8 @@ module Capybara
       def add_attribute_conditions(**conditions)
         @expression = conditions.inject(expression) do |xp, (name, value)|
           conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)
+          return xp if conditions.nil?
+
           if xp.is_a? XPath::Expression
             xp[conditions]
           else
@@ -47,8 +49,8 @@ module Capybara
         when XPath::Expression, Regexp
           attribute_conditions(class: classes)
         else
-          Array(classes).map do |klass|
-            if klass.start_with?('!') && !klass.start_with?('!!!')
+          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|
+            if klass.match?(/^!(?!!!)/)
               !XPath.attr(:class).contains_word(klass.slice(1..-1))
             else
               XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))

data/lib/capybara/selector/css.rb

@@ -15,7 +15,7 @@ module Capybara
       end
 
       def self.escape_char(char)
-        char.match?(%r{[ -/:-~]}) ? "\\#{char}" : format('\\%06x', char.ord)
+        char.match?(%r{[ -/:-~]}) ? "\\#{char}" : format('\\%06<hex>x', hex: char.ord)
       end
 
       def self.split(css)

data/lib/capybara/selector/definition.rb

@@ -10,11 +10,12 @@ module Capybara
   class Selector
     class Definition
       attr_reader :name, :expressions
+
       extend Forwardable
 
       def initialize(name, locator_type: nil, raw_locator: false, supports_exact: nil, &block)
         @name = name
-        @filter_set = Capybara::Selector::FilterSet.add(name) {}
+        @filter_set = Capybara::Selector::FilterSet.add(name)
         @match = nil
         @label = nil
         @failure_message = nil
@@ -82,7 +83,7 @@ module Capybara
       # Automatic selector detection
       #
       # @yield [locator]                   This block takes the passed in locator string and returns whether or not it matches the selector
-      # @yieldparam [String], locator      The locator string used to determin if it matches the selector
+      # @yieldparam [String], locator      The locator string used to determine if it matches the selector
       # @yieldreturn [Boolean]             Whether this selector matches the locator string
       # @return [#call]                    The block that will be used to detect selector match
       #
@@ -166,7 +167,7 @@ module Capybara
 
       def locator_filter(*types, **options, &block)
         types.each { |type| options[type] = true }
-        @locator_filter = Capybara::Selector::Filters::LocatorFilter.new(block, options) if block
+        @locator_filter = Capybara::Selector::Filters::LocatorFilter.new(block, **options) if block
         @locator_filter
       end
 
@@ -177,11 +178,11 @@ module Capybara
       def_delegator :@filter_set, :describe
 
       def describe_expression_filters(&block)
-        if block_given?
+        if block
           describe(:expression_filters, &block)
         else
           describe(:expression_filters) do |**options|
-            describe_all_expression_filters(options)
+            describe_all_expression_filters(**options)
           end
         end
       end
@@ -189,7 +190,7 @@ module Capybara
       def describe_all_expression_filters(**opts)
         expression_filters.map do |ef_name, ef|
           if ef.matcher?
-            handled_custom_keys(ef, opts.keys).map { |key| " with #{ef_name}[#{key} => #{opts[key]}]" }.join
+            handled_custom_options(ef, opts).map { |option, value| " with #{ef_name}[#{option} => #{value}]" }.join
           elsif opts.key?(ef_name)
             " with #{ef_name} #{opts[ef_name]}"
           end
@@ -214,7 +215,7 @@ module Capybara
       end
 
       def default_visibility(fallback = Capybara.ignore_hidden_elements, options = {})
-        vis = if @default_visibility&.respond_to?(:call)
+        vis = if @default_visibility.respond_to?(:call)
           @default_visibility.call(options)
         else
           @default_visibility
@@ -251,14 +252,15 @@ module Capybara
 
     private
 
-      def handled_custom_keys(filter, keys)
-        keys.select do |key|
-          filter.handles_option?(key) && !::Capybara::Queries::SelectorQuery::VALID_KEYS.include?(key)
+      def handled_custom_options(filter, options)
+        options.select do |option, _|
+          filter.handles_option?(option) && !::Capybara::Queries::SelectorQuery::VALID_KEYS.include?(option)
         end
       end
 
       def parameter_names(block)
-        block.parameters.select { |(type, _name)| %i[key keyreq].include? type }.map { |(_type, name)| name }
+        key_types = %i[key keyreq]
+        block.parameters.select { |(type, _name)| key_types.include? type }.map { |(_type, name)| name }
       end
 
       def expression(type, allowed_filters, &block)