capybara 2.7.0 → 3.35.3

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Capybara
+  class Selector
+    module Filters
+      class Base
+        def initialize(name, matcher, block, **options)
+          @name = name
+          @matcher = matcher
+          @block = block
+          @options = options
+          @options[:valid_values] = [true, false] if options[:boolean]
+        end
+
+        def default?
+          @options.key?(:default)
+        end
+
+        def default
+          @options[:default]
+        end
+
+        def skip?(value)
+          @options.key?(:skip_if) && value == @options[:skip_if]
+        end
+
+        def format
+          @options[:format]
+        end
+
+        def matcher?
+          !@matcher.nil?
+        end
+
+        def boolean?
+          !!@options[:boolean]
+        end
+
+        def handles_option?(option_name)
+          if matcher?
+            @matcher.match? option_name
+          else
+            @name == option_name
+          end
+        end
+
+      private
+
+        def apply(subject, name, value, skip_value, ctx)
+          return skip_value if skip?(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)
+          else
+            filter_context(ctx).instance_exec(subject, name, value, &@block)
+          end
+        end
+
+        def filter_context(context)
+          context || @block.binding.receiver
+        end
+
+        def valid_value?(value)
+          return true unless @options.key?(:valid_values)
+
+          Array(@options[:valid_values]).any? { |valid| valid === value } # rubocop:disable Style/CaseEquality
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/filters/base'
+
+module Capybara
+  class Selector
+    module Filters
+      class ExpressionFilter < Base
+        def apply_filter(expr, name, value, selector)
+          apply(expr, name, value, expr, selector)
+        end
+      end
+
+      class IdentityExpressionFilter < ExpressionFilter
+        def initialize(name); super(name, nil, nil); end
+        def default?; false; end
+        def matcher?; false; end
+        def apply_filter(expr, _name, _value, _ctx); expr; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/filters/base'
+
+module Capybara
+  class Selector
+    module Filters
+      class LocatorFilter < NodeFilter
+        def initialize(block, **options)
+          super(nil, nil, block, **options)
+        end
+
+        def matches?(node, value, context = nil, exact:)
+          apply(node, value, true, context, exact: exact, format: context&.default_format)
+        rescue Capybara::ElementNotFound
+          false
+        end
+
+      private
+
+        def apply(subject, value, skip_value, ctx, **options)
+          return skip_value if skip?(value)
+
+          filter_context(ctx).instance_exec(subject, value, **options, &@block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/filters/base'
+
+module Capybara
+  class Selector
+    module Filters
+      class NodeFilter < Base
+        def initialize(name, matcher, block, **options)
+          super
+          @block = if boolean?
+            proc do |node, value|
+              error_cnt = errors.size
+              block.call(node, value).tap do |res|
+                add_error("Expected #{name} #{value} but it wasn't") if !res && error_cnt == errors.size
+              end
+            end
+          else
+            block
+          end
+        end
+
+        def matches?(node, name, value, context = nil)
+          apply(node, name, value, true, context)
+        rescue Capybara::ElementNotFound
+          false
+        end
+      end
+    end
+  end
+end

data/lib/capybara/selector/regexp_disassembler.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+require 'regexp_parser'
+
+module Capybara
+  class Selector
+    # @api private
+    class RegexpDisassembler
+      def initialize(regexp)
+        @regexp = regexp
+      end
+
+      def alternated_substrings
+        @alternated_substrings ||= begin
+          or_strings = process(alternation: true)
+          remove_or_covered(or_strings)
+          or_strings.any?(&:empty?) ? [] : or_strings
+        end
+      end
+
+      def substrings
+        @substrings ||= begin
+          strs = process(alternation: false).first
+          remove_and_covered(strs)
+        end
+      end
+
+    private
+
+      def remove_and_covered(strings)
+        # delete_if is documented to modify the array after every block iteration - this doesn't appear to be true
+        # uniq the strings to prevent identical strings from removing each other
+        strings.uniq!
+
+        # If we have "ab" and "abcd" required - only need to check for "abcd"
+        strings.delete_if do |sub_string|
+          strings.any? do |cover_string|
+            next if sub_string.equal? cover_string
+
+            cover_string.include?(sub_string)
+          end
+        end
+      end
+
+      def remove_or_covered(or_series)
+        # If we are going to match `("a" and "b") or ("ade" and "bce")` it only makes sense to match ("a" and "b")
+
+        # Ensure minimum sets of strings are being or'd
+        or_series.each { |strs| remove_and_covered(strs) }
+
+        # Remove any of the alternated string series that fully contain any other string series
+        or_series.delete_if do |and_strs|
+          or_series.any? do |and_strs2|
+            next if and_strs.equal? and_strs2
+
+            remove_and_covered(and_strs + and_strs2) == and_strs
+          end
+        end
+      end
+
+      def process(alternation:)
+        strs = extract_strings(Regexp::Parser.parse(@regexp), alternation: alternation)
+        strs = collapse(combine(strs).map(&:flatten))
+        strs.each { |str| str.map!(&:upcase) } if @regexp.casefold?
+        strs
+      end
+
+      def combine(strs)
+        suffixes = [[]]
+        strs.reverse_each do |str|
+          if str.is_a? Set
+            prefixes = str.each_with_object([]) { |s, memo| memo.concat combine(s) }
+
+            result = []
+            prefixes.product(suffixes) { |pair| result << pair.flatten(1) }
+            suffixes = result
+          else
+            suffixes.each { |arr| arr.unshift str }
+          end
+        end
+        suffixes
+      end
+
+      def collapse(strs)
+        strs.map do |substrings|
+          substrings.slice_before(&:nil?).map(&:join).reject(&:empty?).uniq
+        end
+      end
+
+      def extract_strings(expression, alternation: false)
+        Expression.new(expression).extract_strings(alternation)
+      end
+
+      # @api private
+      class Expression
+        def initialize(exp)
+          @exp = exp
+        end
+
+        def extract_strings(process_alternatives)
+          strings = []
+          each do |exp|
+            next if exp.ignore?
+
+            next strings.push(nil) if exp.optional? && !process_alternatives
+
+            next strings.push(exp.alternative_strings) if exp.alternation? && process_alternatives
+
+            strings.concat(exp.strings(process_alternatives))
+          end
+          strings
+        end
+
+      protected
+
+        def alternation?
+          (type == :meta) && !terminal?
+        end
+
+        def optional?
+          min_repeat.zero?
+        end
+
+        def terminal?
+          @exp.terminal?
+        end
+
+        def strings(process_alternatives)
+          if indeterminate?
+            [nil]
+          elsif terminal?
+            terminal_strings
+          elsif optional?
+            optional_strings
+          else
+            repeated_strings(process_alternatives)
+          end
+        end
+
+        def terminal_strings
+          text = case @exp.type
+          when :literal then @exp.text
+          when :escape then @exp.char
+          else
+            return [nil]
+          end
+
+          optional? ? options_set(text) : repeat_set(text)
+        end
+
+        def optional_strings
+          options_set(extract_strings(true))
+        end
+
+        def repeated_strings(process_alternatives)
+          repeat_set extract_strings(process_alternatives)
+        end
+
+        def alternative_strings
+          alts = alternatives.map { |sub_exp| sub_exp.extract_strings(alternation: true) }
+          alts.all?(&:any?) ? Set.new(alts) : nil
+        end
+
+        def ignore?
+          [Regexp::Expression::Assertion::NegativeLookahead,
+           Regexp::Expression::Assertion::NegativeLookbehind].any? { |klass| @exp.is_a? klass }
+        end
+
+      private
+
+        def indeterminate?
+          %i[meta set].include?(type)
+        end
+
+        def min_repeat
+          @exp.repetitions.begin
+        end
+
+        def max_repeat
+          @exp.repetitions.end
+        end
+
+        def fixed_repeat?
+          min_repeat == max_repeat
+        end
+
+        def type
+          @exp.type
+        end
+
+        def repeat_set(str)
+          strs = Array(str * min_repeat)
+          strs.push(nil) unless fixed_repeat?
+          strs
+        end
+
+        def options_set(strs)
+          strs = [Set.new([[''], Array(strs)])]
+          strs.push(nil) unless max_repeat == 1
+          strs
+        end
+
+        def alternatives
+          @exp.alternatives.map { |exp| Expression.new(exp) }
+        end
+
+        def each
+          @exp.each { |exp| yield Expression.new(exp) }
+        end
+      end
+      private_constant :Expression
+    end
+  end
+end

data/lib/capybara/selector/selector.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Capybara
+  class Selector < SimpleDelegator
+    class << self
+      def all
+        @definitions ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+
+      def [](name)
+        all.fetch(name.to_sym) { |sel_type| raise ArgumentError, "Unknown selector type (:#{sel_type})" }
+      end
+
+      def add(name, **options, &block)
+        all[name.to_sym] = Definition.new(name.to_sym, **options, &block)
+      end
+
+      def update(name, &block)
+        self[name].instance_eval(&block)
+      end
+
+      def remove(name)
+        all.delete(name.to_sym)
+      end
+
+      def for(locator)
+        all.values.find { |sel| sel.match?(locator) }
+      end
+    end
+
+    attr_reader :errors
+
+    def initialize(definition, config:, format:)
+      definition = self.class[definition] unless definition.is_a? Definition
+      super(definition)
+      @definition = definition
+      @config = config
+      @format = format
+      @errors = []
+    end
+
+    def format
+      @format || @definition.default_format
+    end
+    alias_method :current_format, :format
+
+    def enable_aria_label
+      @config[:enable_aria_label]
+    end
+
+    def enable_aria_role
+      @config[:enable_aria_role]
+    end
+
+    def test_id
+      @config[:test_id]
+    end
+
+    def call(locator, **options)
+      if format
+        raise ArgumentError, "Selector #{@name} does not support #{format}" unless expressions.key?(format)
+
+        instance_exec(locator, **options, &expressions[format])
+      else
+        warn 'Selector has no format'
+      end
+    ensure
+      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)
+      errors << error_msg
+    end
+
+    def expression_for(name, locator, config: @config, format: current_format, **options)
+      Selector.new(name, config: config, format: format).call(locator, **options)
+    end
+
+    # @api private
+    def with_filter_errors(errors)
+      old_errors = @errors
+      @errors = errors
+      yield
+    ensure
+      @errors = old_errors
+    end
+
+    # @api private
+    def builder(expr = nil)
+      case format
+      when :css
+        Capybara::Selector::CSSBuilder
+      when :xpath
+        Capybara::Selector::XPathBuilder
+      else
+        raise NotImplementedError, "No builder exists for selector of type #{default_format}"
+      end.new(expr)
+    end
+
+  private
+
+    def locator_description
+      locator_types.group_by { |lt| lt.is_a? Symbol }.map do |symbol, types_or_methods|
+        if symbol
+          "respond to #{types_or_methods.join(' or ')}"
+        else
+          "be an instance of #{types_or_methods.join(' or ')}"
+        end
+      end.join(' or ')
+    end
+
+    def locator_valid?(locator)
+      return true unless locator && locator_types
+
+      locator_types&.any? do |type_or_method|
+        type_or_method.is_a?(Symbol) ? locator.respond_to?(type_or_method) : type_or_method === locator # rubocop:disable Style/CaseEquality
+      end
+    end
+
+    def locate_field(xpath, locator, **_options)
+      return xpath if locator.nil?
+
+      locate_xpath = xpath # Need to save original xpath for the label wrap
+      locator = locator.to_s
+      attr_matchers = [XPath.attr(:id) == locator,
+                       XPath.attr(:name) == locator,
+                       XPath.attr(:placeholder) == locator,
+                       XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)].reduce(:|)
+      attr_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
+      attr_matchers |= XPath.attr(test_id) == locator if test_id
+
+      locate_xpath = locate_xpath[attr_matchers]
+      locate_xpath + locate_label(locator).descendant(xpath)
+    end
+
+    def locate_label(locator)
+      XPath.descendant(:label)[XPath.string.n.is(locator)]
+    end
+
+    def find_by_attr(attribute, value)
+      finder_name = "find_by_#{attribute}_attr"
+      if respond_to?(finder_name, true)
+        send(finder_name, value)
+      else
+        value ? XPath.attr(attribute) == value : nil
+      end
+    end
+
+    def find_by_class_attr(classes)
+      Array(classes).map { |klass| XPath.attr(:class).contains_word(klass) }.reduce(:&)
+    end
+  end
+end