capybara 3.29.0 → 3.33.0

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,6 +10,7 @@ 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)
@@ -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
 
@@ -181,7 +182,7 @@ module Capybara
           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
@@ -251,9 +252,9 @@ 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
 

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

@@ -4,6 +4,7 @@ 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)
+    btn_xpath += XPath.descendant[XPath.attr(:role).equals('button')] if enable_aria_role
     image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type) == 'image']
 
     unless locator.nil?
@@ -26,7 +27,7 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
       image_btn_xpath = image_btn_xpath[alt_matches]
     end
 
-    %i[value title type name].inject(input_btn_xpath.union(btn_xpath).union(image_btn_xpath)) do |memo, ef|
+    %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])]
     end
   end
@@ -34,10 +35,15 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
   node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
   expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
 
+  node_filter(:name) { |node, value| !value.is_a?(Regexp) || value.match?(node[:name]) }
+  expression_filter(:name) do |xpath, val|
+    builder(xpath).add_attribute_conditions(name: val)
+  end
+
   describe_expression_filters do |disabled: nil, **options|
     desc = +''
     desc << ' that is not disabled' if disabled == false
-    desc << describe_all_expression_filters(options)
+    desc << describe_all_expression_filters(**options)
   end
 
   describe_node_filters do |disabled: nil, **|

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

@@ -5,7 +5,7 @@ Capybara.add_selector(:checkbox, locator_type: [String, Symbol]) do
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
       XPath.attr(:type) == 'checkbox'
     ]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[checked unchecked disabled name])
@@ -20,7 +20,7 @@ Capybara.add_selector(:checkbox, locator_type: [String, Symbol]) do
   describe_node_filters do |option: nil, with: nil, **|
     desc = +''
     desc << " with value #{option.inspect}" if option
-    desc << " with value #{with.inspec}" if with
+    desc << " with value #{with.inspect}" if with
     desc
   end
 end

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

@@ -2,7 +2,9 @@
 
 Capybara.add_selector(:css, locator_type: [String, Symbol], raw_locator: true) do
   css do |css|
-    warn "DEPRECATED: Passing a symbol (#{css.inspect}) as the CSS locator is deprecated - please pass a string instead." if css.is_a? Symbol
+    if css.is_a? Symbol
+      warn "DEPRECATED: Passing a symbol (#{css.inspect}) as the CSS locator is deprecated - please pass a string instead."
+    end
     css
   end
 end

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

@@ -5,7 +5,7 @@ Capybara.add_selector(:datalist_input, locator_type: [String, Symbol]) do
 
   xpath do |locator, **options|
     xpath = XPath.descendant(:input)[XPath.attr(:list)]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[disabled name placeholder])

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

@@ -16,7 +16,7 @@ Capybara.add_selector(:datalist_option, locator_type: [String, Symbol]) do
   describe_expression_filters do |disabled: nil, **options|
     desc = +''
     desc << ' that is not disabled' if disabled == false
-    desc << describe_all_expression_filters(options)
+    desc << describe_all_expression_filters(**options)
   end
 
   describe_node_filters do |**options|

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

@@ -19,7 +19,7 @@ Capybara.add_selector(:element, locator_type: [String, Symbol]) do
 
   describe_expression_filters do |**options|
     booleans, values = options.partition { |_k, v| [true, false].include? v }.map(&:to_h)
-    desc = describe_all_expression_filters(values)
+    desc = describe_all_expression_filters(**values)
     desc + booleans.map do |k, v|
       v ? " with #{k} attribute" : "without #{k} attribute"
     end.join

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

@@ -7,7 +7,7 @@ Capybara.add_selector(:field, locator_type: [String, Symbol]) do
     invalid_types = %w[submit image]
     invalid_types << 'hidden' unless options[:type].to_s == 'hidden'
     xpath = XPath.descendant(:input, :textarea, :select)[!XPath.attr(:type).one_of(*invalid_types)]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   expression_filter(:type) do |expr, type|

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

@@ -6,7 +6,7 @@ Capybara.add_selector(:file_field, locator_type: [String, Symbol]) do
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
       XPath.attr(:type) == 'file'
     ]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[disabled multiple name])

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

@@ -6,7 +6,7 @@ Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input, :textarea)[
       !XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')
     ]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   expression_filter(:type) do |expr, type|
@@ -18,7 +18,7 @@ Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
     end
   end
 
-  filter_set(:_field, %i[disabled multiple name placeholder valid])
+  filter_set(:_field, %i[disabled multiple name placeholder valid validation_message])
 
   node_filter(:with) do |node, with|
     val = node.value

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

@@ -2,7 +2,7 @@
 
 Capybara.add_selector(:label, locator_type: [String, Symbol]) do
   label 'label'
-  xpath(:for) do |locator, options|
+  xpath(:for) do |locator, **options|
     xpath = XPath.descendant(:label)
     unless locator.nil?
       locator_matchers = XPath.string.n.is(locator.to_s) | (XPath.attr(:id) == locator.to_s)
@@ -10,7 +10,9 @@ Capybara.add_selector(:label, locator_type: [String, Symbol]) do
       xpath = xpath[locator_matchers]
     end
     if options.key?(:for)
-      if (for_option = options[:for].is_a?(Capybara::Node::Element) ? options[:for][:id] : options[:for])
+      for_option = options[:for]
+      for_option = for_option[:id] if for_option.is_a?(Capybara::Node::Element)
+      if for_option && (for_option != '')
         with_attr = builder(XPath.self).add_attribute_conditions(for: for_option)
         wrapped = !XPath.attr(:for) &
                   builder(XPath.self.descendant(*labelable_elements)).add_attribute_conditions(id: for_option)

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

@@ -5,6 +5,13 @@ Capybara.add_selector(:link, locator_type: [String, Symbol]) do
     xpath = XPath.descendant(:a)
     xpath = builder(xpath).add_attribute_conditions(href: href) unless href == false
 
+    if enable_aria_role
+      role_path = XPath.descendant[XPath.attr(:role).equals('link')]
+      role_path = builder(role_path).add_attribute_conditions(href: href) unless [true, false].include? href
+
+      xpath += role_path
+    end
+
     unless locator.nil?
       locator = locator.to_s
       matchers = [XPath.attr(:id) == locator,
@@ -18,6 +25,7 @@ Capybara.add_selector(:link, locator_type: [String, Symbol]) do
 
     xpath = xpath[find_by_attr(:title, title)]
     xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt) == alt]] if alt
+
     xpath
   end
 

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

@@ -6,7 +6,7 @@ Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
       XPath.attr(:type) == 'radio'
     ]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[checked unchecked disabled name])
@@ -21,7 +21,7 @@ Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
   describe_node_filters do |option: nil, with: nil, **|
     desc = +''
     desc << " with value #{option.inspect}" if option
-    desc << " with value #{with.inspec}" if with
+    desc << " with value #{with.inspect}" if with
     desc
   end
 end

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

@@ -5,22 +5,32 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
 
   xpath do |locator, **options|
     xpath = XPath.descendant(:select)
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[disabled multiple name placeholder])
 
   node_filter(:options) do |node, options|
-    actual = if node.visible?
-      node.all(:xpath, './/option', wait: false).map(&:text)
-    else
-      node.all(:xpath, './/option', visible: false, wait: false).map { |option| option.text(:all) }
-    end
+    actual = options_text(node)
     (options.sort == actual.sort).tap do |res|
       add_error("Expected options #{options.inspect} found #{actual.inspect}") unless res
     end
   end
 
+  node_filter(:enabled_options) do |node, options|
+    actual = options_text(node) { |o| !o.disabled? }
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected enabled options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
+  node_filter(:disabled_options) do |node, options|
+    actual = options_text(node, &:disabled?)
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected disabled options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
   expression_filter(:with_options) do |expr, options|
     options.inject(expr) do |xpath, option|
       xpath[expression_for(:option, option)]
@@ -28,18 +38,14 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
   end
 
   node_filter(:selected) do |node, selected|
-    actual = node.all(:xpath, './/option', visible: false, wait: false)
-                 .select(&:selected?)
-                 .map { |option| option.text(:all) }
+    actual = options_text(node, visible: false, &:selected?)
     (Array(selected).sort == actual.sort).tap do |res|
       add_error("Expected #{selected.inspect} to be selected found #{actual.inspect}") unless res
     end
   end
 
   node_filter(:with_selected) do |node, selected|
-    actual = node.all(:xpath, './/option', visible: false, wait: false)
-                 .select(&:selected?)
-                 .map { |option| option.text(:all) }
+    actual = options_text(node, visible: false, &:selected?)
     (Array(selected) - actual).empty?.tap do |res|
       add_error("Expected at least #{selected.inspect} to be selected found #{actual.inspect}") unless res
     end
@@ -51,12 +57,25 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
     desc
   end
 
-  describe_node_filters do |options: nil, selected: nil, with_selected: nil, disabled: nil, **|
+  describe_node_filters do |
+    options: nil, disabled_options: nil, enabled_options: nil,
+    selected: nil, with_selected: nil,
+    disabled: nil, **|
     desc = +''
     desc << " with options #{options.inspect}" if options
+    desc << " with disabled options #{disabled_options.inspect}}" if disabled_options
+    desc << " with enabled options #{enabled_options.inspect}" if enabled_options
     desc << " with #{selected.inspect} selected" if selected
     desc << " with at least #{with_selected.inspect} selected" if with_selected
     desc << ' which is disabled' if disabled
     desc
   end
+
+  def options_text(node, **opts, &filter_block)
+    opts[:wait] = false
+    opts[:visible] = false unless node.visible?
+    node.all(:xpath, './/option', **opts, &filter_block).map do |o|
+      o.text((:all if opts[:visible] == false))
+    end
+  end
 end

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

@@ -19,7 +19,10 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
           header = XPath.descendant(:th)[XPath.string.n.is(header)]
           td = XPath.descendant(:tr)[header].descendant(:td)
           cell_condition = XPath.string.n.is(cell_str)
-          cell_condition &= prev_col_position?(XPath.ancestor(:table)[1].join(xp)) if xp
+          if xp
+            prev_cell = XPath.ancestor(:table)[1].join(xp)
+            cell_condition &= (prev_cell & prev_col_position?(prev_cell))
+          end
           td[cell_condition]
         end
       else
@@ -28,7 +31,7 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
 
           if prev_cell
             prev_cell = XPath.ancestor(:tr)[1].preceding_sibling(:tr).join(prev_cell)
-            cell_condition &= prev_col_position?(prev_cell)
+            cell_condition &= (prev_cell & prev_col_position?(prev_cell))
           end
 
           XPath.descendant(:td)[cell_condition]
@@ -40,7 +43,7 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
   end
 
   expression_filter(:cols, valid_values: [Array]) do |xpath, cols|
-    raise ArgumentError, ':cols must be an Array of Arrays' unless cols.all? { |col| col.is_a? Array }
+    raise ArgumentError, ':cols must be an Array of Arrays' unless cols.all?(Array)
 
     rows = cols.transpose
     col_conditions = rows.map { |row| match_row(row, match_size: true) }.reduce(:&)

data/lib/capybara/selector/filter_set.rb

@@ -15,15 +15,15 @@ module Capybara
         instance_eval(&block)
       end
 
-      def node_filter(names, *types_and_options, &block)
+      def node_filter(names, *types, **options, &block)
         Array(names).each do |name|
-          add_filter(name, Filters::NodeFilter, *types_and_options, &block)
+          add_filter(name, Filters::NodeFilter, *types, **options, &block)
         end
       end
       alias_method :filter, :node_filter
 
-      def expression_filter(name, *types_and_options, &block)
-        add_filter(name, Filters::ExpressionFilter, *types_and_options, &block)
+      def expression_filter(name, *types, **options, &block)
+        add_filter(name, Filters::ExpressionFilter, *types, **options, &block)
       end
 
       def describe(what = nil, &block)
@@ -42,9 +42,9 @@ module Capybara
       def description(node_filters: true, expression_filters: true, **options)
         opts = options_with_defaults(options)
         description = +''
-        description << undeclared_descriptions.map { |desc| desc.call(opts).to_s }.join
-        description << expression_filter_descriptions.map { |desc| desc.call(opts).to_s }.join if expression_filters
-        description << node_filter_descriptions.map { |desc| desc.call(opts).to_s }.join if node_filters
+        description << undeclared_descriptions.map { |desc| desc.call(**opts).to_s }.join
+        description << expression_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if expression_filters
+        description << node_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if node_filters
         description
       end
 
@@ -112,9 +112,11 @@ module Capybara
 
       def add_filter(name, filter_class, *types, matcher: nil, **options, &block)
         types.each { |type| options[type] = true }
-        raise 'ArgumentError', ':default option is not supported for filters with a :matcher option' if matcher && options[:default]
+        if matcher && options[:default]
+          raise 'ArgumentError', ':default option is not supported for filters with a :matcher option'
+        end
 
-        filter = filter_class.new(name, matcher, block, options)
+        filter = filter_class.new(name, matcher, block, **options)
         (filter_class <= Filters::ExpressionFilter ? @expression_filters : @node_filters)[name] = filter
       end
     end

data/lib/capybara/selector/filters/base.rb

@@ -48,7 +48,12 @@ module Capybara
 
         def apply(subject, name, value, skip_value, ctx)
           return skip_value if skip?(value)
-          raise ArgumentError, "Invalid value #{value.inspect} passed to #{self.class.name.split('::').last} #{name}#{" : #{@name}" if @name.is_a?(Regexp)}" unless valid_value?(value)
+
+          unless valid_value?(value)
+            raise ArgumentError,
+                  "Invalid value #{value.inspect} passed to #{self.class.name.split('::').last} #{name}" \
+                  "#{" : #{name}" if @name.is_a?(Regexp)}"
+          end
 
           if @block.arity == 2
             filter_context(ctx).instance_exec(subject, value, &@block)

data/lib/capybara/selector/filters/locator_filter.rb

@@ -7,7 +7,7 @@ module Capybara
     module Filters
       class LocatorFilter < NodeFilter
         def initialize(block, **options)
-          super(nil, nil, block, options)
+          super(nil, nil, block, **options)
         end
 
         def matches?(node, value, context = nil, exact:)

data/lib/capybara/selector/selector.rb

@@ -48,6 +48,10 @@ module Capybara
       @config[:enable_aria_label]
     end
 
+    def enable_aria_role
+      @config[:enable_aria_role]
+    end
+
     def test_id
       @config[:test_id]
     end
@@ -56,12 +60,14 @@ module Capybara
       if format
         raise ArgumentError, "Selector #{@name} does not support #{format}" unless expressions.key?(format)
 
-        instance_exec(locator, options, &expressions[format])
+        instance_exec(locator, **options, &expressions[format])
       else
         warn 'Selector has no format'
       end
     ensure
-      warn "Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. This will raise an error in a future version of Capybara." unless locator_valid?(locator)
+      unless locator_valid?(locator)
+        warn "Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. This will raise an error in a future version of Capybara."
+      end
     end
 
     def add_error(error_msg)