capybara 3.16.1 → 3.33.0

data/lib/capybara/node/simple.rb

@@ -102,12 +102,15 @@ module Capybara
       #
       def visible?(check_ancestors = true)
         return false if (tag_name == 'input') && (native[:type] == 'hidden')
+        return false if tag_name == 'template'
 
         if check_ancestors
           !find_xpath(VISIBILITY_XPATH)
         else
           # No need for an xpath if only checking the current element
-          !(native.key?('hidden') || (native[:style] =~ /display:\s?none/) || %w[script head].include?(tag_name))
+          !(native.key?('hidden') ||
+            /display:\s?none/.match?(native[:style] || '') ||
+            %w[script head].include?(tag_name))
         end
       end
 
@@ -127,7 +130,8 @@ module Capybara
       #
       # @return [Boolean]     Whether the element is disabled
       def disabled?
-        native.has_attribute?('disabled')
+        native.has_attribute?('disabled') &&
+          %w[button input select textarea optgroup option menuitem fieldset].include?(tag_name)
       end
 
       ##
@@ -148,7 +152,7 @@ module Capybara
         yield # simple nodes don't need to wait
       end
 
-      def allow_reload!
+      def allow_reload!(*)
         # no op
       end
 
@@ -195,7 +199,8 @@ module Capybara
         x.ancestor_or_self[
           x.attr(:style)[x.contains('display:none') | x.contains('display: none')] |
           x.attr(:hidden) |
-          x.qname.one_of('script', 'head')
+          x.qname.one_of('script', 'head') |
+          (~x.self(:summary) & XPath.parent(:details)[!XPath.attr(:open)])
         ].boolean
       end.to_s.freeze
     end

data/lib/capybara/queries/ancestor_query.rb

@@ -6,9 +6,13 @@ module Capybara
       # @api private
       def resolve_for(node, exact = nil)
         @child_node = node
+
         node.synchronize do
           match_results = super(node.session.current_scope, exact)
-          node.all(:xpath, XPath.ancestor) { |el| match_results.include?(el) }
+          ancestors = node.find_xpath(XPath.ancestor.to_s)
+                          .map(&method(:to_element))
+                          .select { |el| match_results.include?(el) }
+          Capybara::Result.new(ordered_results(ancestors), self)
         end
       end
 
@@ -18,12 +22,6 @@ module Capybara
         desc += " that is an ancestor of #{child_query.description}" if child_query
         desc
       end
-
-    private
-
-      def valid_keys
-        super - COUNT_KEYS
-      end
     end
   end
 end

data/lib/capybara/queries/base_query.rb

@@ -79,7 +79,8 @@ module Capybara
         if count
           message << " #{occurrences count}"
         elsif between
-          message << " between #{between.first} and #{between.end ? between.last : 'infinite'} times"
+          message << " between #{between.begin ? between.first : 1} and" \
+                     " #{between.end ? between.last : 'infinite'} times"
         elsif maximum
           message << " at most #{occurrences maximum}"
         elsif minimum

data/lib/capybara/queries/current_path_query.rb

@@ -22,7 +22,7 @@ module Capybara
         @actual_path = options[:url] ? uri&.to_s : uri&.request_uri
 
         if @expected_path.is_a? Regexp
-          @actual_path.to_s.match(@expected_path)
+          @actual_path.to_s.match?(@expected_path)
         else
           ::Addressable::URI.parse(@expected_path) == ::Addressable::URI.parse(@actual_path)
         end

data/lib/capybara/queries/selector_query.rb

@@ -1,32 +1,51 @@
 # frozen_string_literal: true
 
+require 'matrix'
+
 module Capybara
   module Queries
     class SelectorQuery < Queries::BaseQuery
       attr_reader :expression, :selector, :locator, :options
-      VALID_KEYS = COUNT_KEYS + %i[text id class style visible exact exact_text normalize_ws match wait filter_set]
+
+      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]
       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] = {} }
+
         super(@options)
         self.session_options = session_options
 
-        @selector = find_selector(args[0].is_a?(Symbol) ? args.shift : args[0])
+        @selector = Selector.new(
+          find_selector(args[0].is_a?(Symbol) ? args.shift : args[0]),
+          config: {
+            enable_aria_label: enable_aria_label,
+            enable_aria_role: enable_aria_role,
+            test_id: test_id
+          },
+          format: selector_format
+        )
+
         @locator = args.shift
         @filter_block = filter_block
 
         raise ArgumentError, "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty?
 
-        selector_config = { enable_aria_label: enable_aria_label, test_id: test_id }
-        @expression = selector.call(@locator, @options.merge(selector_config: selector_config))
+        @expression = selector.call(@locator, **@options)
 
         warn_exact_usage
 
@@ -44,13 +63,17 @@ module Capybara
           desc << 'visible ' if visible == :visible
           desc << 'non-visible ' if visible == :hidden
         end
+
         desc << "#{label} #{locator.inspect}"
+
         if show_for[:any]
           desc << " with#{' exact' if exact_text == true} text #{options[:text].inspect}" if options[:text]
           desc << " with exact text #{exact_text}" if exact_text.is_a?(String)
         end
+
         desc << " with id #{options[:id]}" if options[:id]
         desc << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
+
         desc << case options[:style]
         when String
           " with style attribute #{options[:style].inspect}"
@@ -60,8 +83,17 @@ module Capybara
           " with styles #{options[:style].inspect}"
         else ''
         end
+
+        %i[above below left_of right_of near].each do |spatial_filter|
+          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)
+
         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?
@@ -81,6 +113,7 @@ module Capybara
 
         matches_locator_filter?(node) &&
           matches_system_filters?(node) &&
+          matches_spatial_filters?(node) &&
           matches_node_filters?(node, node_filter_errors) &&
           matches_filter_block?(node)
       rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])
@@ -119,17 +152,21 @@ module Capybara
       # @api private
       def resolve_for(node, exact = nil)
         applied_filters.clear
+        @filter_cache.clear
         @resolved_node = node
         @resolved_count += 1
+
         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
 
       # @api private
       def supports_exact?
-        @expression.respond_to? :to_xpath
+        return @expression.respond_to? :to_xpath if @selector.supports_exact?.nil?
+
+        @selector.supports_exact?
       end
 
       def failure_message
@@ -142,20 +179,36 @@ module Capybara
 
     private
 
+      def selector_format
+        @selector.format
+      end
+
+      def matching_text
+        options[:text] || options[:exact_text]
+      end
+
       def text_fragments
-        text = (options[:text] || options[:exact_text])
-        text.is_a?(String) ? text.split : []
+        (text = matching_text).is_a?(String) ? text.split : []
       end
 
       def xpath_text_conditions
-        (options[:text] || options[:exact_text]).split.map { |txt| XPath.contains(txt) }.reduce(&:&)
+        case (text = matching_text)
+        when String
+          text.split.map { |txt| XPath.contains(txt) }.reduce(&:&)
+        when Regexp
+          condition = XPath.current
+          condition = condition.uppercase if text.casefold?
+          Selector::RegexpDisassembler.new(text).alternated_substrings.map do |strs|
+            strs.flat_map(&:split).map { |str| condition.contains(str) }.reduce(:&)
+          end.reduce(:|)
+        end
       end
 
       def try_text_match_in_expression?
         first_try? &&
-          (options[:text] || options[:exact_text]).is_a?(String) &&
-          @resolved_node&.respond_to?(:session) &&
-          @resolved_node.session.driver.wait?
+          matching_text &&
+          @resolved_node.is_a?(Capybara::Node::Base) &&
+          @resolved_node.session&.driver&.wait?
       end
 
       def first_try?
@@ -182,23 +235,24 @@ module Capybara
       def find_nodes_by_selector_format(node, exact)
         hints = {}
         hints[:uses_visibility] = true unless visible == :all
-        hints[:texts] = text_fragments unless selector.format == :xpath
+        hints[:texts] = text_fragments unless selector_format == :xpath
         hints[:styles] = options[:style] if use_default_style_filter?
+        hints[:position] = true if use_spatial_filter?
 
-        if selector.format == :css
+        if selector_format == :css
           if node.method(:find_css).arity != 1
             node.find_css(css, **hints)
           else
             node.find_css(css)
           end
-        elsif selector.format == :xpath
+        elsif selector_format == :xpath
           if node.method(:find_xpath).arity != 1
             node.find_xpath(xpath(exact), **hints)
           else
             node.find_xpath(xpath(exact))
           end
         else
-          raise ArgumentError, "Unknown format: #{selector.format}"
+          raise ArgumentError, "Unknown format: #{selector_format}"
         end
       end
 
@@ -220,6 +274,8 @@ module Capybara
         unapplied_options = options.keys - valid_keys
         @selector.with_filter_errors(errors) do
           node_filters.all? do |filter_name, filter|
+            next true unless apply_filter?(filter)
+
             if filter.matcher?
               unapplied_options.select { |option_name| filter.handles_option?(option_name) }.all? do |option_name|
                 unapplied_options.delete(option_name)
@@ -265,6 +321,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
@@ -292,7 +357,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?
@@ -307,9 +372,15 @@ module Capybara
         options.key?(:style) && !custom_keys.include?(:style)
       end
 
+      def use_spatial_filter?
+        options.values_at(*SPATIAL_KEYS).compact.any?
+      end
+
       def apply_expression_filters(expression)
         unapplied_options = options.keys - valid_keys
         expression_filters.inject(expression) do |expr, (name, ef)|
+          next expr unless apply_filter?(ef)
+
           if ef.matcher?
             unapplied_options.select(&ef.method(:handles_option?)).inject(expr) do |memo, option_name|
               unapplied_options.delete(option_name)
@@ -348,16 +419,20 @@ module Capybara
         node.is_a?(::Capybara::Node::Simple) && node.path == '/'
       end
 
+      def apply_filter?(filter)
+        filter.format.nil? || (filter.format == selector_format)
+      end
+
       def matches_locator_filter?(node)
-        return true unless @selector.locator_filter
+        return true unless @selector.locator_filter && apply_filter?(@selector.locator_filter)
 
-        @selector.locator_filter.matches?(node, @locator, @selector)
+        @selector.locator_filter.matches?(node, @locator, @selector, exact: exact?)
       end
 
       def matches_system_filters?(node)
         applied_filters << :system
 
-        matches_visible_filter?(node) &&
+        matches_visibility_filters?(node) &&
           matches_id_filter?(node) &&
           matches_class_filter?(node) &&
           matches_style_filter?(node) &&
@@ -365,16 +440,52 @@ module Capybara
           matches_exact_text_filter?(node)
       end
 
+      def matches_spatial_filters?(node)
+        applied_filters << :spatial
+        return true unless use_spatial_filter?
+
+        node_rect = Rectangle.new(node.initial_cache[:position] || node.rect)
+
+        if options[:above]
+          el_rect = rect_cache(options[:above])
+          return false unless node_rect.above? el_rect
+        end
+
+        if options[:below]
+          el_rect = rect_cache(options[:below])
+          return false unless node_rect.below? el_rect
+        end
+
+        if options[:left_of]
+          el_rect = rect_cache(options[:left_of])
+          return false unless node_rect.left_of? el_rect
+        end
+
+        if options[:right_of]
+          el_rect = rect_cache(options[:right_of])
+          return false unless node_rect.right_of? el_rect
+        end
+
+        if options[:near]
+          return false if node == options[:near]
+
+          el_rect = rect_cache(options[:near])
+          return false unless node_rect.near? el_rect
+        end
+
+        true
+      end
+
       def matches_id_filter?(node)
         return true unless use_default_id_filter? && options[:id].is_a?(Regexp)
 
-        node[:id] =~ options[:id]
+        options[:id].match? node[:id]
       end
 
       def matches_class_filter?(node)
         return true unless use_default_class_filter? && options[:class].is_a?(Regexp)
 
-        node[:class] =~ options[:class]
+        options[:class].match? node[:class]
       end
 
       def matches_style_filter?(node)
@@ -382,7 +493,7 @@ module Capybara
         when String, nil
           true
         when Regexp
-          node[:style] =~ options[:style]
+          options[:style].match? node[:style]
         when Hash
           matches_style?(node, options[:style])
         end
@@ -392,7 +503,7 @@ module Capybara
         @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)
         styles.all? do |style, value|
           if value.is_a? Regexp
-            @actual_styles[style.to_s] =~ value
+            value.match? @actual_styles[style.to_s]
           else
             @actual_styles[style.to_s] == value
           end
@@ -414,14 +525,27 @@ module Capybara
         matches_text_exactly?(node, exact_text)
       end
 
-      def matches_visible_filter?(node)
-        case visible
-        when :visible then
+      def matches_visibility_filters?(node)
+        obscured = options[:obscured]
+        return (visible != :hidden) && (node.initial_cache[:visible] != false) && !node.obscured? if obscured == false
+
+        vis = case visible
+        when :visible
           node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)
-        when :hidden then
+        when :hidden
           (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)
-        else true
+        else
+          true
         end
+
+        vis && case obscured
+               when true
+                 node.obscured?
+               when false
+                 !node.obscured?
+               else
+                 true
+               end
       end
 
       def matches_text_exactly?(node, value)
@@ -436,7 +560,7 @@ module Capybara
       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 default_visibility
@@ -446,6 +570,148 @@ module Capybara
       def builder(expr)
         selector.builder(expr)
       end
+
+      def position_cache(key)
+        @filter_cache[key][:position] ||= key.rect
+      end
+
+      def rect_cache(key)
+        @filter_cache[key][:rect] ||= Rectangle.new(position_cache(key))
+      end
+
+      class Rectangle
+        attr_reader :top, :bottom, :left, :right
+
+        def initialize(position)
+          # rubocop:disable Style/RescueModifier
+          @top = position['top'] rescue position['y']
+          @bottom = position['bottom'] rescue (@top + position['height'])
+          @left = position['left'] rescue position['x']
+          @right = position['right'] rescue (@left + position['width'])
+          # rubocop:enable Style/RescueModifier
+        end
+
+        def distance(other)
+          distance = Float::INFINITY
+
+          line_segments.each do |ls1|
+            other.line_segments.each do |ls2|
+              distance = [
+                distance,
+                distance_segment_segment(*ls1, *ls2)
+              ].min
+            end
+          end
+
+          distance
+        end
+
+        def above?(other)
+          bottom <= other.top
+        end
+
+        def below?(other)
+          top >= other.bottom
+        end
+
+        def left_of?(other)
+          right <= other.left
+        end
+
+        def right_of?(other)
+          left >= other.right
+        end
+
+        def near?(other)
+          distance(other) <= 50
+        end
+
+      protected
+
+        def line_segments
+          [
+            [Vector[top, left], Vector[top, right]],
+            [Vector[top, right], Vector[bottom, left]],
+            [Vector[bottom, left], Vector[bottom, right]],
+            [Vector[bottom, right], Vector[top, left]]
+          ]
+        end
+
+      private
+
+        def distance_segment_segment(l1p1, l1p2, l2p1, l2p2)
+          # See http://geomalgorithms.com/a07-_distance.html
+          # rubocop:disable Naming/VariableName
+          u = l1p2 - l1p1
+          v = l2p2 - l2p1
+          w = l1p1 - l2p1
+
+          a = u.dot u
+          b = u.dot v
+          c = v.dot v
+
+          d = u.dot w
+          e = v.dot w
+          cap_d = (a * c) - (b * b)
+          sD = tD = cap_d
+
+          # compute the line parameters of the two closest points
+          if cap_d < Float::EPSILON # the lines are almost parallel
+            sN = 0.0 # force using point P0 on segment S1
+            sD = 1.0 # to prevent possible division by 0.0 later
+            tN = e
+            tD = c
+          else # get the closest points on the infinite lines
+            sN = (b * e) - (c * d)
+            tN = (a * e) - (b * d)
+            if sN.negative? # sc < 0 => the s=0 edge is visible
+              sN = 0
+              tN = e
+              tD = c
+            elsif sN > sD # sc > 1 => the s=1 edge is visible
+              sN = sD
+              tN = e + b
+              tD = c
+            end
+          end
+
+          if tN.negative? # tc < 0 => the t=0 edge is visible
+            tN = 0
+            # recompute sc for this edge
+            if (-d).negative?
+              sN = 0.0
+            elsif -d > a
+              sN = sD
+            else
+              sN = -d
+              sD = a
+            end
+          elsif tN > tD # tc > 1 => the t=1 edge is visible
+            tN = tD
+            # recompute sc for this edge
+            if (-d + b).negative?
+              sN = 0.0
+            elsif (-d + b) > a
+              sN = sD
+            else
+              sN = (-d + b)
+              sD = a
+            end
+          end
+
+          # finally do the division to get sc and tc
+          sc = sN.abs < Float::EPSILON ? 0.0 : sN / sD
+          tc = tN.abs < Float::EPSILON ? 0.0 : tN / tD
+
+          # difference of the two closest points
+          dP = w + (u * sc) - (v * tc)
+
+          Math.sqrt(dP.dot(dP))
+          # rubocop:enable Naming/VariableName
+        end
+      end
+
+      private_constant :Rectangle
     end
   end
 end