capybara 3.29.0 → 3.33.0

data/lib/capybara/rspec/matchers.rb

@@ -15,45 +15,45 @@ module Capybara
     # RSpec matcher for whether the element(s) matching a given selector exist.
     #
     # @see Capybara::Node::Matchers#assert_selector
-    def have_selector(*args, &optional_filter_block)
-      Matchers::HaveSelector.new(*args, &optional_filter_block)
+    def have_selector(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveSelector.new(*args, **kw_args, &optional_filter_block)
     end
 
     # RSpec matcher for whether the element(s) matching a group of selectors exist.
     #
     # @see Capybara::Node::Matchers#assert_all_of_selectors
-    def have_all_of_selectors(*args, &optional_filter_block)
-      Matchers::HaveAllSelectors.new(*args, &optional_filter_block)
+    def have_all_of_selectors(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveAllSelectors.new(*args, **kw_args, &optional_filter_block)
     end
 
     # RSpec matcher for whether no element(s) matching a group of selectors exist.
     #
     # @see Capybara::Node::Matchers#assert_none_of_selectors
-    def have_none_of_selectors(*args, &optional_filter_block)
-      Matchers::HaveNoSelectors.new(*args, &optional_filter_block)
+    def have_none_of_selectors(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveNoSelectors.new(*args, **kw_args, &optional_filter_block)
     end
 
     # RSpec matcher for whether the element(s) matching any of a group of selectors exist.
     #
     # @see Capybara::Node::Matchers#assert_any_of_selectors
-    def have_any_of_selectors(*args, &optional_filter_block)
-      Matchers::HaveAnySelectors.new(*args, &optional_filter_block)
+    def have_any_of_selectors(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveAnySelectors.new(*args, **kw_args, &optional_filter_block)
     end
 
     # RSpec matcher for whether the current element matches a given selector.
     #
     # @see Capybara::Node::Matchers#assert_matches_selector
-    def match_selector(*args, &optional_filter_block)
-      Matchers::MatchSelector.new(*args, &optional_filter_block)
+    def match_selector(*args, **kw_args, &optional_filter_block)
+      Matchers::MatchSelector.new(*args, **kw_args, &optional_filter_block)
     end
 
     %i[css xpath].each do |selector|
       define_method "have_#{selector}" do |expr, **options, &optional_filter_block|
-        Matchers::HaveSelector.new(selector, expr, options, &optional_filter_block)
+        Matchers::HaveSelector.new(selector, expr, **options, &optional_filter_block)
       end
 
       define_method "match_#{selector}" do |expr, **options, &optional_filter_block|
-        Matchers::MatchSelector.new(selector, expr, options, &optional_filter_block)
+        Matchers::MatchSelector.new(selector, expr, **options, &optional_filter_block)
       end
     end
 
@@ -79,7 +79,7 @@ module Capybara
 
     %i[link button field select table].each do |selector|
       define_method "have_#{selector}" do |locator = nil, **options, &optional_filter_block|
-        Matchers::HaveSelector.new(selector, locator, options, &optional_filter_block)
+        Matchers::HaveSelector.new(selector, locator, **options, &optional_filter_block)
       end
     end
 
@@ -110,7 +110,7 @@ module Capybara
 
     %i[checked unchecked].each do |state|
       define_method "have_#{state}_field" do |locator = nil, **options, &optional_filter_block|
-        Matchers::HaveSelector.new(:field, locator, options.merge(state => true), &optional_filter_block)
+        Matchers::HaveSelector.new(:field, locator, **options.merge(state => true), &optional_filter_block)
       end
     end
 
@@ -127,27 +127,27 @@ module Capybara
     # RSpec matcher for text content.
     #
     # @see Capybara::Node::Matchers#assert_text
-    def have_text(*args)
-      Matchers::HaveText.new(*args)
+    def have_text(text_or_type, *args, **options)
+      Matchers::HaveText.new(text_or_type, *args, **options)
     end
     alias_method :have_content, :have_text
 
     def have_title(title, **options)
-      Matchers::HaveTitle.new(title, options)
+      Matchers::HaveTitle.new(title, **options)
     end
 
     # RSpec matcher for the current path.
     #
     # @see Capybara::SessionMatchers#assert_current_path
     def have_current_path(path, **options)
-      Matchers::HaveCurrentPath.new(path, options)
+      Matchers::HaveCurrentPath.new(path, **options)
     end
 
     # RSpec matcher for element style.
     #
     # @see Capybara::Node::Matchers#matches_style?
     def match_style(styles, **options)
-      Matchers::MatchStyle.new(styles, options)
+      Matchers::MatchStyle.new(styles, **options)
     end
 
     ##
@@ -161,30 +161,30 @@ module Capybara
     %w[selector css xpath text title current_path link button
        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))
+      define_method "have_no_#{matcher_type}" do |*args, **kw_args, &optional_filter_block|
+        Matchers::NegatedMatcher.new(send("have_#{matcher_type}", *args, **kw_args, &optional_filter_block))
       end
     end
     alias_method :have_no_content, :have_no_text
 
     %w[selector css xpath].each do |matcher_type|
-      define_method "not_match_#{matcher_type}" do |*args, &optional_filter_block|
-        Matchers::NegatedMatcher.new(send("match_#{matcher_type}", *args, &optional_filter_block))
+      define_method "not_match_#{matcher_type}" do |*args, **kw_args, &optional_filter_block|
+        Matchers::NegatedMatcher.new(send("match_#{matcher_type}", *args, **kw_args, &optional_filter_block))
       end
     end
 
     # RSpec matcher for whether sibling element(s) matching a given selector exist.
     #
     # @see Capybara::Node::Matchers#assert_sibling
-    def have_sibling(*args, &optional_filter_block)
-      Matchers::HaveSibling.new(*args, &optional_filter_block)
+    def have_sibling(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveSibling.new(*args, **kw_args, &optional_filter_block)
     end
 
     # RSpec matcher for whether ancestor element(s) matching a given selector exist.
     #
     # @see Capybara::Node::Matchers#assert_ancestor
-    def have_ancestor(*args, &optional_filter_block)
-      Matchers::HaveAncestor.new(*args, &optional_filter_block)
+    def have_ancestor(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveAncestor.new(*args, **kw_args, &optional_filter_block)
     end
 
     ##

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

@@ -12,22 +12,28 @@ module Capybara
 
         attr_reader :failure_message, :failure_message_when_negated
 
-        def initialize(*args, &filter_block)
+        def initialize(*args, **kw_args, &filter_block)
           @args = args.dup
+          @kw_args = kw_args || {}
           @filter_block = filter_block
         end
 
       private
 
         def session_query_args
-          if @args.last.is_a? Hash
-            @args.last[:session_options] = session_options
-          else
-            @args.push(session_options: session_options)
-          end
+          # if @args.last.is_a? Hash
+          #   @args.last[:session_options] = session_options
+          # else
+          #   @args.push(session_options: session_options)
+          # end
           @args
         end
 
+        def session_query_options
+          @kw_args[:session_options] = session_options
+          @kw_args
+        end
+
         def session_options
           @context_el ||= nil
           if @context_el.respond_to? :session_options

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

@@ -29,7 +29,8 @@ module Capybara
     private
 
       def options
-        (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        # (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        @kw_args
       end
     end
   end

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

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class HaveAncestor < CountableWrappedElementMatcher
         def element_matches?(el)
-          el.assert_ancestor(*@args, &@filter_block)
+          el.assert_ancestor(*@args, **session_query_options, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_ancestor(*@args, &@filter_block)
+          el.assert_no_ancestor(*@args, **session_query_options, &@filter_block)
         end
 
         def description
@@ -19,7 +19,8 @@ module Capybara
         end
 
         def query
-          @query ||= Capybara::Queries::AncestorQuery.new(*session_query_args, &@filter_block)
+          # @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

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

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class HaveCurrentPath < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_current_path(*@args)
+          el.assert_current_path(current_path, **@kw_args)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_current_path(*@args)
+          el.assert_no_current_path(current_path, **@kw_args)
         end
 
         def description

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

@@ -6,12 +6,20 @@ 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, &@filter_block)
+          el.assert_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_selector(*@args, &@filter_block)
+          el.assert_no_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def description
@@ -19,13 +27,13 @@ module Capybara
         end
 
         def query
-          @query ||= Capybara::Queries::SelectorQuery.new(*session_query_args, &@filter_block)
+          @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, &@filter_block)
+          el.assert_all_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
         def does_not_match?(_actual)
@@ -39,7 +47,7 @@ module Capybara
 
       class HaveNoSelectors < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_none_of_selectors(*@args, &@filter_block)
+          el.assert_none_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
         def does_not_match?(_actual)
@@ -53,11 +61,11 @@ module Capybara
 
       class HaveAnySelectors < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_any_of_selectors(*@args, &@filter_block)
+          el.assert_any_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
         def does_not_match?(_actual)
-          el.assert_none_of_selectors(*@args, &@filter_block)
+          el.assert_none_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
         def description

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

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       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
@@ -19,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

@@ -7,15 +7,15 @@ module Capybara
     module Matchers
       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

@@ -7,7 +7,7 @@ module Capybara
     module Matchers
       class MatchStyle < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_matches_style(*@args)
+          el.assert_matches_style(*@args, **@kw_args)
         end
 
         def does_not_match?(_actual)
@@ -28,7 +28,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

@@ -31,7 +31,8 @@ module Capybara
     private
 
       def options
-        (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        # (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        @kw_args
       end
     end
   end

data/lib/capybara/selector.rb

@@ -30,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
@@ -40,6 +40,7 @@ require 'capybara/selector/definition'
 #       * :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
@@ -58,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
@@ -72,18 +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)
@@ -93,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)
@@ -122,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
@@ -136,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
 #
@@ -174,9 +178,21 @@ Capybara::Selector::FilterSet.add(:_field) do
   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)] }
 
@@ -190,7 +206,7 @@ Capybara::Selector::FilterSet.add(:_field) do
     desc
   end
 
-  describe(:node_filters) do |checked: nil, unchecked: nil, disabled: nil, valid: 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)
@@ -198,6 +214,7 @@ Capybara::Selector::FilterSet.add(:_field) do
     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