capybara 3.29.0 → 3.37.1

data/lib/capybara/queries/selector_query.rb

@@ -6,29 +6,43 @@ module Capybara
   module Queries
     class SelectorQuery < Queries::BaseQuery
       attr_reader :expression, :selector, :locator, :options
+
       SPATIAL_KEYS = %i[above below left_of right_of near].freeze
       VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +
-                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set]
+                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]
       VALID_MATCH = %i[first smart prefer_exact one].freeze
 
       def initialize(*args,
                      session_options:,
                      enable_aria_label: session_options.enable_aria_label,
+                     enable_aria_role: session_options.enable_aria_role,
                      test_id: session_options.test_id,
                      selector_format: nil,
+                     order: nil,
                      **options,
                      &filter_block)
         @resolved_node = nil
         @resolved_count = 0
         @options = options.dup
+        @order = order
         @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }
 
+        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])
+          Capybara::Helpers.warn(
+            "Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring"
+          )
+        end
+
         super(@options)
         self.session_options = session_options
 
         @selector = Selector.new(
           find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),
-          config: { enable_aria_label: enable_aria_label, test_id: test_id },
+          config: {
+            enable_aria_label: enable_aria_label,
+            enable_aria_role: enable_aria_role,
+            test_id: test_id
+          },
           format: selector_format
         )
 
@@ -37,7 +51,7 @@ module Capybara
 
         raise ArgumentError, "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty?
 
-        @expression = selector.call(@locator, @options)
+        @expression = selector.call(@locator, **@options)
 
         warn_exact_usage
 
@@ -47,7 +61,7 @@ module Capybara
       def name; selector.name; end
       def label; selector.label || selector.name; end
 
-      def description(only_applied = false)
+      def description(only_applied = false) # rubocop:disable Style/OptionalBooleanParameter
         desc = +''
         show_for = show_for_stage(only_applied)
 
@@ -65,6 +79,8 @@ module Capybara
 
         desc << " with id #{options[:id]}" if options[:id]
         desc << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
+        desc << ' that is focused' if options[:focused]
+        desc << ' that is not focused' if options[:focused] == false
 
         desc << case options[:style]
         when String
@@ -77,7 +93,9 @@ module Capybara
         end
 
         %i[above below left_of right_of near].each do |spatial_filter|
-          desc << " #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}" if options[spatial_filter] && show_for[:spatial] # rubocop:disable Style/RescueModifier
+          if options[spatial_filter] && show_for[:spatial]
+            desc << " #{spatial_filter} #{options[spatial_filter] rescue '<ERROR>'}" # rubocop:disable Style/RescueModifier
+          end
         end
 
         desc << selector.description(node_filters: show_for[:node], **options)
@@ -85,11 +103,9 @@ module Capybara
         desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]
 
         desc << " within #{@resolved_node.inspect}" if describe_within?
-        if locator.is_a?(String) && locator.start_with?('#', './/', '//')
-          unless selector.raw_locator?
-            desc << "\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. " \
-                    "Please see the documentation for acceptable locator values.\n\n"
-          end
+        if locator.is_a?(String) && locator.start_with?('#', './/', '//') && !selector.raw_locator?
+          desc << "\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. " \
+                  "Please see the documentation for acceptable locator values.\n\n"
         end
         desc
       end
@@ -148,7 +164,7 @@ module Capybara
 
         node.synchronize do
           children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))
-          Capybara::Result.new(children, self)
+          Capybara::Result.new(ordered_results(children), self)
         end
       end
 
@@ -229,17 +245,18 @@ module Capybara
         hints[:styles] = options[:style] if use_default_style_filter?
         hints[:position] = true if use_spatial_filter?
 
-        if selector_format == :css
-          if node.method(:find_css).arity != 1
-            node.find_css(css, **hints)
-          else
+        case selector_format
+        when :css
+          if node.method(:find_css).arity == 1
             node.find_css(css)
-          end
-        elsif selector_format == :xpath
-          if node.method(:find_xpath).arity != 1
-            node.find_xpath(xpath(exact), **hints)
           else
+            node.find_css(css, **hints)
+          end
+        when :xpath
+          if node.method(:find_xpath).arity == 1
             node.find_xpath(xpath(exact))
+          else
+            node.find_xpath(xpath(exact), **hints)
           end
         else
           raise ArgumentError, "Unknown format: #{selector_format}"
@@ -311,6 +328,15 @@ module Capybara
         filters
       end
 
+      def ordered_results(results)
+        case @order
+        when :reverse
+          results.reverse
+        else
+          results
+        end
+      end
+
       def custom_keys
         @custom_keys ||= node_filters.keys + expression_filters.keys
       end
@@ -338,7 +364,7 @@ module Capybara
         conditions[:id] = options[:id] if use_default_id_filter?
         conditions[:class] = options[:class] if use_default_class_filter?
         conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)
-        builder(expr).add_attribute_conditions(conditions)
+        builder(expr).add_attribute_conditions(**conditions)
       end
 
       def use_default_id_filter?
@@ -353,6 +379,10 @@ module Capybara
         options.key?(:style) && !custom_keys.include?(:style)
       end
 
+      def use_default_focused_filter?
+        options.key?(:focused) && !custom_keys.include?(:focused)
+      end
+
       def use_spatial_filter?
         options.values_at(*SPATIAL_KEYS).compact.any?
       end
@@ -417,6 +447,7 @@ module Capybara
           matches_id_filter?(node) &&
           matches_class_filter?(node) &&
           matches_style_filter?(node) &&
+          matches_focused_filter?(node) &&
           matches_text_filter?(node) &&
           matches_exact_text_filter?(node)
       end
@@ -464,9 +495,31 @@ module Capybara
       end
 
       def matches_class_filter?(node)
-        return true unless use_default_class_filter? && options[:class].is_a?(Regexp)
+        return true unless use_default_class_filter? && need_to_process_classes?
 
-        options[:class].match? node[:class]
+        if options[:class].is_a? Regexp
+          options[:class].match? node[:class]
+        else
+          classes = (node[:class] || '').split
+          options[:class].select { |c| c.is_a? Regexp }.all? do |r|
+            classes.any? { |cls| r.match? cls }
+          end
+        end
+      end
+
+      def matches_focused_filter?(node)
+        return true unless use_default_focused_filter?
+
+        (node == node.session.active_element) == options[:focused]
+      end
+
+      def need_to_process_classes?
+        case options[:class]
+        when Regexp then true
+        when Array then options[:class].any?(Regexp)
+        else
+          false
+        end
       end
 
       def matches_style_filter?(node)
@@ -494,16 +547,19 @@ module Capybara
       def matches_text_filter?(node)
         value = options[:text]
         return true unless value
-        return matches_text_exactly?(node, value) if exact_text == true
+        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)
 
         regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)
         matches_text_regexp?(node, regexp)
       end
 
       def matches_exact_text_filter?(node)
-        return true unless exact_text.is_a?(String)
-
-        matches_text_exactly?(node, exact_text)
+        case exact_text
+        when String, Regexp
+          matches_text_exactly?(node, exact_text)
+        else
+          true
+        end
       end
 
       def matches_visibility_filters?(node)
@@ -531,17 +587,21 @@ module Capybara
 
       def matches_text_exactly?(node, value)
         regexp = value.is_a?(Regexp) ? value : /\A#{Regexp.escape(value.to_s)}\z/
-        matches_text_regexp?(node, regexp)
+        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }
       end
 
       def normalize_ws
         options.fetch(:normalize_ws, session_options.default_normalize_ws)
       end
 
-      def matches_text_regexp?(node, regexp)
+      def matches_text_regexp(node, regexp)
         text_visible = visible
         text_visible = :all if text_visible == :hidden
-        node.text(text_visible, normalize_ws: normalize_ws).match?(regexp)
+        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)
+      end
+
+      def matches_text_regexp?(node, regexp)
+        !matches_text_regexp(node, regexp).nil?
       end
 
       def default_visibility
@@ -562,6 +622,7 @@ module Capybara
 
       class Rectangle
         attr_reader :top, :bottom, :left, :right
+
         def initialize(position)
           # rubocop:disable Style/RescueModifier
           @top = position['top'] rescue position['y']
@@ -632,7 +693,7 @@ module Capybara
 
           d = u.dot w
           e = v.dot w
-          cap_d = (a * c) - (b * b)
+          cap_d = (a * c) - (b**2)
           sD = tD = cap_d
 
           # compute the line parameters of the two closest points

data/lib/capybara/queries/sibling_query.rb

@@ -7,15 +7,16 @@ module Capybara
       def resolve_for(node, exact = nil)
         @sibling_node = node
         node.synchronize do
-          match_results = super(node.session.current_scope, exact)
+          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')
+          match_results = super(scope, exact)
           siblings = node.find_xpath((XPath.preceding_sibling + XPath.following_sibling).to_s)
                          .map(&method(:to_element))
                          .select { |el| match_results.include?(el) }
-          Capybara::Result.new(siblings, self)
+          Capybara::Result.new(ordered_results(siblings), self)
         end
       end
 
-      def description(applied = false)
+      def description(applied = false) # rubocop:disable Style/OptionalBooleanParameter
         desc = super
         sibling_query = @sibling_node&.instance_variable_get(:@query)
         desc += " that is a sibling of #{sibling_query.description}" if sibling_query

data/lib/capybara/queries/style_query.rb

@@ -34,7 +34,7 @@ module Capybara
     private
 
       def stringify_keys(hsh)
-        hsh.each_with_object({}) { |(k, v), str_keys| str_keys[k.to_s] = v }
+        hsh.transform_keys(&:to_s)
       end
 
       def valid_keys

data/lib/capybara/queries/text_query.rb

@@ -6,13 +6,15 @@ module Capybara
     class TextQuery < BaseQuery
       def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments
         @type = type.nil? ? default_type : type
+        raise ArgumentError, "#{@type} is not a valid type for a text query" unless valid_types.include?(@type)
+
         @options = options
         super(@options)
         self.session_options = session_options
 
         if expected_text.nil? && !exact?
           warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. '\
-               'Please specify a string or regexp instead.'
+               "Please specify a string or regexp instead. #{Capybara::Helpers.filter_backtrace(caller)}"
         end
 
         @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s
@@ -89,6 +91,10 @@ module Capybara
         COUNT_KEYS + %i[wait exact normalize_ws]
       end
 
+      def valid_types
+        %i[all visible]
+      end
+
       def check_visible_text?
         @type == :visible
       end

data/lib/capybara/rack_test/browser.rb

@@ -8,6 +8,7 @@ class Capybara::RackTest::Browser
 
   def initialize(driver)
     @driver = driver
+    @current_fragment = nil
   end
 
   def app
@@ -19,6 +20,8 @@ class Capybara::RackTest::Browser
   end
 
   def visit(path, **attributes)
+    @new_visit_request = true
+    reset_cache!
     reset_host!
     process_and_follow_redirects(:get, path, attributes)
   end
@@ -30,18 +33,20 @@ class Capybara::RackTest::Browser
 
   def submit(method, path, attributes)
     path = request_path if path.nil? || path.empty?
-    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => current_url)
+    uri = build_uri(path)
+    uri.query = '' if method.to_s.casecmp('get').zero?
+    process_and_follow_redirects(method, uri.to_s, attributes, 'HTTP_REFERER' => referer_url)
   end
 
   def follow(method, path, **attributes)
     return if fragment_or_script?(path)
 
-    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => current_url)
+    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => referer_url)
   end
 
   def process_and_follow_redirects(method, path, attributes = {}, env = {})
+    @current_fragment = build_uri(path).fragment
     process(method, path, attributes, env)
-
     return unless driver.follow_redirects?
 
     driver.redirect_limit.times do
@@ -53,32 +58,42 @@ class Capybara::RackTest::Browser
         end
       end
     end
-    raise Capybara::InfiniteRedirectError, "redirected more than #{driver.redirect_limit} times, check for infinite redirects." if last_response.redirect?
+
+    if last_response.redirect? # rubocop:disable Style/GuardClause
+      raise Capybara::InfiniteRedirectError, "redirected more than #{driver.redirect_limit} times, check for infinite redirects."
+    end
   end
 
   def process(method, path, attributes = {}, env = {})
     method = method.downcase
     new_uri = build_uri(path)
     @current_scheme, @current_host, @current_port = new_uri.select(:scheme, :host, :port)
-
+    @current_fragment = new_uri.fragment || @current_fragment
     reset_cache!
+    @new_visit_request = false
     send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))
   end
 
   def build_uri(path)
-    URI.parse(path).tap do |uri|
-      uri.path = request_path if path.empty? || path.start_with?('?')
-      uri.path = '/' if uri.path.empty?
-      uri.path = request_path.sub(%r{/[^/]*$}, '/') + uri.path unless uri.path.start_with?('/')
+    uri = URI.parse(path)
+    base_uri = base_relative_uri_for(uri)
+
+    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')
 
+    if base_uri.absolute?
+      base_uri.merge(uri)
+    else
       uri.scheme ||= @current_scheme
       uri.host ||= @current_host
       uri.port ||= @current_port unless uri.default_port == @current_port
+      uri
     end
   end
 
   def current_url
-    last_request.url
+    uri = build_uri(last_request.url)
+    uri.fragment = @current_fragment if @current_fragment
+    uri.to_s
   rescue Rack::Test::Error
     ''
   end
@@ -114,8 +129,39 @@ class Capybara::RackTest::Browser
     dom.title
   end
 
+  def last_request
+    raise Rack::Test::Error if @new_visit_request
+
+    super
+  end
+
+  def last_response
+    raise Rack::Test::Error if @new_visit_request
+
+    super
+  end
+
 protected
 
+  def base_href
+    find(:css, 'head > base').first&.[](:href).to_s
+  end
+
+  def base_relative_uri_for(uri)
+    base_uri = URI.parse(base_href)
+    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|
+      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?
+      c.path = '/' if c.path.empty?
+    end
+
+    if [current_uri, base_uri].any?(&:absolute?)
+      current_uri.merge(base_uri)
+    else
+      base_uri.path = current_uri.path if base_uri.path.empty?
+      base_uri
+    end
+  end
+
   def build_rack_mock_session
     reset_host! unless current_host
     Rack::MockSession.new(app, current_host)
@@ -127,9 +173,21 @@ protected
     '/'
   end
 
+  def safe_last_request
+    last_request
+  rescue Rack::Test::Error
+    nil
+  end
+
 private
 
   def fragment_or_script?(path)
     path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')
   end
+
+  def referer_url
+    build_uri(last_request.url).to_s
+  rescue Rack::Test::Error
+    ''
+  end
 end

data/lib/capybara/rack_test/driver.rb

@@ -17,6 +17,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   def initialize(app, **options)
     raise ArgumentError, 'rack-test requires a rack application, but none was given' unless app
 
+    super()
     @app = app
     @options = DEFAULT_OPTIONS.merge(options)
   end
@@ -42,7 +43,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   end
 
   def visit(path, **attributes)
-    browser.visit(path, attributes)
+    browser.visit(path, **attributes)
   end
 
   def refresh
@@ -97,10 +98,10 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
     @browser = nil
   end
 
-  def get(*args, &block); browser.get(*args, &block); end
-  def post(*args, &block); browser.post(*args, &block); end
-  def put(*args, &block); browser.put(*args, &block); end
-  def delete(*args, &block); browser.delete(*args, &block); end
+  def get(...); browser.get(...); end
+  def post(...); browser.post(...); end
+  def put(...); browser.put(...); end
+  def delete(...); browser.delete(...); end
   def header(key, value); browser.header(key, value); end
 
   def invalid_element_errors

data/lib/capybara/rack_test/form.rb

@@ -6,7 +6,7 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
   # That check should be based solely on the form element's 'enctype' attribute value,
   # which should probably be provided to Rack::Test in its non-GET request methods.
   class NilUploadedFile < Rack::Test::UploadedFile
-    def initialize
+    def initialize # rubocop:disable Lint/MissingSuper
       @empty_file = Tempfile.new('nil_uploaded_file')
       @empty_file.close
     end
@@ -56,7 +56,7 @@ private
   end
 
   def request_method
-    /post/i.match?(self[:method]) ? :post : :get
+    /post/i.match?(self[:method] || '') ? :post : :get
   end
 
   def merge_param!(params, key, value)

data/lib/capybara/rack_test/node.rb

@@ -15,7 +15,7 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
   end
 
   def visible_text
-    displayed_text.gsub(/\ +/, ' ')
+    displayed_text.squeeze(' ')
                   .gsub(/[\ \n]*\n[\ \n]*/, "\n")
                   .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
                   .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
@@ -45,6 +45,7 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
 
     if radio? then set_radio(value)
     elsif checkbox? then set_checkbox(value)
+    elsif range? then set_range(value)
     elsif input_field? then set_input(value)
     elsif textarea? then native['_capybara_raw_value'] = value.to_s
     end
@@ -76,8 +77,8 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
       set(!checked?)
     elsif tag_name == 'label'
       click_label
-    elsif tag_name == 'details'
-      toggle_details
+    elsif (details = native.xpath('.//ancestor-or-self::details').last)
+      toggle_details(details)
     end
   end
 
@@ -107,6 +108,13 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     end
   end
 
+  def readonly?
+    # readonly attribute not valid on these input types
+    return false if input_field? && %w[hidden range color checkbox radio file submit image reset button].include?(type)
+
+    super
+  end
+
   def path
     native.path
   end
@@ -123,16 +131,21 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     alias_method "unchecked_#{meth_name}", meth_name
     private "unchecked_#{meth_name}" # rubocop:disable Style/AccessModifierDeclarations
 
-    define_method meth_name do |*args|
-      stale_check
-      send("unchecked_#{meth_name}", *args)
+    if RUBY_VERSION >= '2.7'
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{meth_name}(...)
+          stale_check
+          method(:"unchecked_#{meth_name}").call(...)
+        end
+      METHOD
+    else
+      define_method meth_name do |*args|
+        stale_check
+        send("unchecked_#{meth_name}", *args)
+      end
     end
   end
 
-  def ==(other)
-    native == other.native
-  end
-
 protected
 
   # @api private
@@ -149,7 +162,7 @@ protected
       end.join || ''
       text = "\n#{text}\n" if BLOCK_ELEMENTS.include?(tag_name)
       text
-    else
+    else # rubocop:disable Lint/DuplicateBranch
       ''
     end
   end
@@ -199,6 +212,14 @@ private
     end
   end
 
+  def set_range(value) # rubocop:disable Naming/AccessorMethodName
+    min, max, step = (native['min'] || 0).to_f, (native['max'] || 100).to_f, (native['step'] || 1).to_f
+    value = value.to_f
+    value = value.clamp(min, max)
+    value = (((value - min) / step).round * step) + min
+    native['value'] = value.clamp(min, max)
+  end
+
   def set_input(value) # rubocop:disable Naming/AccessorMethodName
     if text_or_password? && attribute_is_not_blank?(:maxlength)
       # Browser behavior for maxlength="0" is inconsistent, so we stick with
@@ -223,7 +244,7 @@ private
   end
 
   def follow_link
-    method = self['data-method'] if driver.options[:respect_data_method]
+    method = self['data-method'] || self['data-turbo-method'] if driver.options[:respect_data_method]
     method ||= :get
     driver.follow(method, self[:href].to_s)
   end
@@ -238,11 +259,14 @@ private
     labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)
   end
 
-  def toggle_details
-    if native.has_attribute?('open')
-      native.remove_attribute('open')
+  def toggle_details(details = nil)
+    details ||= native.xpath('.//ancestor-or-self::details').last
+    return unless details
+
+    if details.has_attribute?('open')
+      details.remove_attribute('open')
     else
-      native.set_attribute('open', 'open')
+      details.set_attribute('open', 'open')
     end
   end
 
@@ -284,6 +308,10 @@ protected
     tag_name == 'textarea'
   end
 
+  def range?
+    input_field? && type == 'range'
+  end
+
   OPTION_OWNER_XPATH = XPath.parent(:optgroup, :select, :datalist).to_s.freeze
   DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|
     x.parent(:fieldset)[