capybara 3.30.0 → 3.35.3

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, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_current_path(*@args)
+          el.assert_no_current_path(current_path, **@kw_args, &@filter_block)
         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

@@ -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

@@ -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

@@ -7,7 +7,7 @@ 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
@@ -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
@@ -79,6 +80,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
 #
 # * **:radio_button** - Find radio buttons
 #   * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text
@@ -108,6 +110,8 @@ require 'capybara/selector/definition'
 #       * :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)
@@ -167,7 +171,7 @@ 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?) }
@@ -176,6 +180,12 @@ Capybara::Selector::FilterSet.add(:_field) do
   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) do |xpath, val|
     builder(xpath).add_attribute_conditions(name: val)
@@ -196,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)
@@ -204,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

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

@@ -74,7 +74,7 @@ module Capybara
             end.join
           end
         else
-          cls = Array(classes).group_by { |cl| cl.match?(/^!(?!!!)/) }
+          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,7 +49,7 @@ module Capybara
         when XPath::Expression, Regexp
           attribute_conditions(class: classes)
         else
-          Array(classes).map do |klass|
+          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|
             if klass.match?(/^!(?!!!)/)
               !XPath.attr(:class).contains_word(klass.slice(1..-1))
             else

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
       #
@@ -177,7 +178,7 @@ 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|
@@ -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)

data/lib/capybara/selector/definition/button.rb

@@ -4,30 +4,30 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
   xpath(:value, :title, :type, :name) do |locator, **options|
     input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
     btn_xpath = XPath.descendant(:button)
+    aria_btn_xpath = XPath.descendant[XPath.attr(:role).equals('button')]
     image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type) == 'image']
 
     unless locator.nil?
       locator = locator.to_s
-      locator_matchers = XPath.attr(:id).equals(locator) |
-                         XPath.attr(:name).equals(locator) |
-                         XPath.attr(:value).is(locator) |
-                         XPath.attr(:title).is(locator)
-      locator_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
-      locator_matchers |= XPath.attr(test_id) == locator if test_id
+      locator_matchers = combine_locators(locator, config: self)
+      btn_matchers = locator_matchers |
+                     XPath.string.n.is(locator) |
+                     XPath.descendant(:img)[XPath.attr(:alt).is(locator)]
 
-      input_btn_xpath = input_btn_xpath[locator_matchers]
-
-      btn_xpath = btn_xpath[locator_matchers |
-                            XPath.string.n.is(locator) |
-                            XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
+      input_btn_xpath = input_btn_xpath[locator_matchers] + locate_label(locator).descendant(input_btn_xpath)
+      btn_xpath = btn_xpath[btn_matchers] + locate_label(locator).descendant(btn_xpath)
+      aria_btn_xpath = aria_btn_xpath[btn_matchers]
 
       alt_matches = XPath.attr(:alt).is(locator)
       alt_matches |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
-      image_btn_xpath = image_btn_xpath[alt_matches]
+      image_btn_xpath = image_btn_xpath[alt_matches] + locate_label(locator).descendant(image_btn_xpath)
     end
 
-    %i[value title type].inject(input_btn_xpath.union(btn_xpath).union(image_btn_xpath)) do |memo, ef|
-      memo[find_by_attr(ef, options[ef])]
+    btn_xpaths = [input_btn_xpath, btn_xpath, image_btn_xpath]
+    btn_xpaths << aria_btn_xpath if enable_aria_role
+
+    %i[value title type].inject(btn_xpaths.inject(&:union)) do |memo, ef|
+      memo.where(find_by_attr(ef, options[ef]))
     end
   end
 
@@ -48,4 +48,16 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
   describe_node_filters do |disabled: nil, **|
     ' that is disabled' if disabled == true
   end
+
+  def combine_locators(locator, config:)
+    [
+      XPath.attr(:id).equals(locator),
+      XPath.attr(:name).equals(locator),
+      XPath.attr(:value).is(locator),
+      XPath.attr(:title).is(locator),
+      (XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)),
+      (XPath.attr(:'aria-label').is(locator) if config.enable_aria_label),
+      (XPath.attr(config.test_id) == locator if config.test_id)
+    ].compact.inject(&:|)
+  end
 end