mega-max-rb 0.0.1

data/capybara-3.40.0/lib/capybara/selector/definition.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/filter_set'
+require 'capybara/selector/css'
+require 'capybara/selector/regexp_disassembler'
+require 'capybara/selector/builders/xpath_builder'
+require 'capybara/selector/builders/css_builder'
+
+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)
+        @match = nil
+        @label = nil
+        @failure_message = nil
+        @expressions = {}
+        @expression_filters = {}
+        @locator_filter = nil
+        @default_visibility = nil
+        @locator_type = locator_type
+        @raw_locator = raw_locator
+        @supports_exact = supports_exact
+        instance_eval(&block)
+      end
+
+      def custom_filters
+        warn "Deprecated: Selector#custom_filters is not valid when same named expression and node filter exist - don't use"
+        node_filters.merge(expression_filters).freeze
+      end
+
+      def node_filters
+        @filter_set.node_filters
+      end
+
+      def expression_filters
+        @filter_set.expression_filters
+      end
+
+      ##
+      #
+      # Define a selector by an xpath expression
+      #
+      # @overload xpath(*expression_filters, &block)
+      #   @param [Array<Symbol>] expression_filters ([])  Names of filters that are implemented via this expression, if not specified the names of any keyword parameters in the block will be used
+      #   @yield [locator, options]                       The block to use to generate the XPath expression
+      #   @yieldparam [String] locator                    The locator string passed to the query
+      #   @yieldparam [Hash] options                      The options hash passed to the query
+      #   @yieldreturn [#to_xpath, #to_s]                 An object that can produce an xpath expression
+      #
+      # @overload xpath()
+      # @return [#call]                             The block that will be called to generate the XPath expression
+      #
+      def xpath(*allowed_filters, &block)
+        expression(:xpath, allowed_filters, &block)
+      end
+
+      ##
+      #
+      # Define a selector by a CSS selector
+      #
+      # @overload css(*expression_filters, &block)
+      #   @param [Array<Symbol>] expression_filters ([])  Names of filters that can be implemented via this CSS selector
+      #   @yield [locator, options]                   The block to use to generate the CSS selector
+      #   @yieldparam [String] locator               The locator string passed to the query
+      #   @yieldparam [Hash] options                 The options hash passed to the query
+      #   @yieldreturn [#to_s]                        An object that can produce a CSS selector
+      #
+      # @overload css()
+      # @return [#call]                             The block that will be called to generate the CSS selector
+      #
+      def css(*allowed_filters, &block)
+        expression(:css, allowed_filters, &block)
+      end
+
+      ##
+      #
+      # 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 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
+      #
+      def match(&block)
+        @match = block if block
+        @match
+      end
+
+      ##
+      #
+      # Set/get a descriptive label for the selector
+      #
+      # @overload label(label)
+      #   @param [String] label            A descriptive label for this selector - used in error messages
+      # @overload label()
+      # @return [String]                 The currently set label
+      #
+      def label(label = nil)
+        @label = label if label
+        @label
+      end
+
+      ##
+      #
+      # Description of the selector
+      #
+      # @!method description(options)
+      #   @param [Hash] options            The options of the query used to generate the description
+      #   @return [String]                 Description of the selector when used with the options passed
+      def_delegator :@filter_set, :description
+
+      ##
+      #
+      #  Should this selector be used for the passed in locator
+      #
+      #  This is used by the automatic selector selection mechanism when no selector type is passed to a selector query
+      #
+      # @param [String] locator     The locator passed to the query
+      # @return [Boolean]           Whether or not to use this selector
+      #
+      def match?(locator)
+        @match&.call(locator)
+      end
+
+      ##
+      #
+      # Define a node filter for use with this selector
+      #
+      # @!method node_filter(name, *types, options={}, &block)
+      #   @param [Symbol, Regexp] name            The filter name
+      #   @param [Array<Symbol>] types    The types of the filter - currently valid types are [:boolean]
+      #   @param [Hash] options ({})      Options of the filter
+      #   @option options [Array<>] :valid_values Valid values for this filter
+      #   @option options :default        The default value of the filter (if any)
+      #   @option options :skip_if        Value of the filter that will cause it to be skipped
+      #   @option options [Regexp] :matcher (nil) A Regexp used to check whether a specific option is handled by this filter.  If not provided the filter will be used for options matching the filter name.
+      #
+      # If a Symbol is passed for the name the block should accept | node, option_value |, while if a Regexp
+      # is passed for the name the block should accept | node, option_name, option_value |. In either case
+      # the block should return `true` if the node passes the filer or `false` if it doesn't
+
+      ##
+      #
+      # Define an expression filter for use with this selector
+      #
+      # @!method expression_filter(name, *types, matcher: nil, **options, &block)
+      #   @param [Symbol, Regexp] name            The filter name
+      #   @param [Regexp] matcher (nil)   A Regexp used to check whether a specific option is handled by this filter
+      #   @param [Array<Symbol>] types    The types of the filter - currently valid types are [:boolean]
+      #   @param [Hash] options ({})      Options of the filter
+      #   @option options [Array<>] :valid_values Valid values for this filter
+      #   @option options :default        The default value of the filter (if any)
+      #   @option options :skip_if        Value of the filter that will cause it to be skipped
+      #   @option options [Regexp] :matcher (nil) A Regexp used to check whether a specific option is handled by this filter.  If not provided the filter will be used for options matching the filter name.
+      #
+      # If a Symbol is passed for the name the block should accept | current_expression, option_value |, while if a Regexp
+      # is passed for the name the block should accept | current_expression, option_name, option_value |. In either case
+      # the block should return the modified expression
+
+      def_delegators :@filter_set, :node_filter, :expression_filter, :filter
+
+      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
+      end
+
+      def filter_set(name, filters_to_use = nil)
+        @filter_set.import(name, filters_to_use)
+      end
+
+      def_delegator :@filter_set, :describe
+
+      def describe_expression_filters(&block)
+        if block
+          describe(:expression_filters, &block)
+        else
+          describe(:expression_filters) do |**options|
+            describe_all_expression_filters(**options)
+          end
+        end
+      end
+
+      def describe_all_expression_filters(**opts)
+        expression_filters.map do |ef_name, ef|
+          if ef.matcher?
+            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
+        end.join
+      end
+
+      def describe_node_filters(&block)
+        describe(:node_filters, &block)
+      end
+
+      ##
+      #
+      # Set the default visibility mode that should be used if no visible option is passed when using the selector.
+      # If not specified will default to the behavior indicated by Capybara.ignore_hidden_elements
+      #
+      # @param [Symbol] default_visibility  Only find elements with the specified visibility:
+      #                                              * :all - finds visible and invisible elements.
+      #                                              * :hidden - only finds invisible elements.
+      #                                              * :visible - only finds visible elements.
+      def visible(default_visibility = nil, &block)
+        @default_visibility = block || default_visibility
+      end
+
+      def default_visibility(fallback = Capybara.ignore_hidden_elements, options = {})
+        vis = if @default_visibility.respond_to?(:call)
+          @default_visibility.call(options)
+        else
+          @default_visibility
+        end
+        vis.nil? ? fallback : vis
+      end
+
+      # @api private
+      def raw_locator?
+        !!@raw_locator
+      end
+
+      # @api private
+      def supports_exact?
+        @supports_exact
+      end
+
+      def default_format
+        return nil if @expressions.keys.empty?
+
+        if @expressions.size == 1
+          @expressions.keys.first
+        else
+          :xpath
+        end
+      end
+
+      # @api private
+      def locator_types
+        return nil unless @locator_type
+
+        Array(@locator_type)
+      end
+
+    private
+
+      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)
+        key_types = %i[key keyreq]
+        # user filter_map when we drop dupport for 2.6
+        # block.parameters.select { |(type, _name)| key_types.include? type }.map { |(_, name)| name }
+        block.parameters.filter_map { |(type, name)| name if key_types.include? type }
+      end
+
+      def expression(type, allowed_filters, &block)
+        if block
+          @expressions[type] = block
+          allowed_filters = parameter_names(block) if allowed_filters.empty?
+          allowed_filters.flatten.each do |ef|
+            expression_filters[ef] = Capybara::Selector::Filters::IdentityExpressionFilter.new(ef)
+          end
+        end
+        @expressions[type]
+      end
+    end
+  end
+end

data/capybara-3.40.0/lib/capybara/selector/filter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/filters/node_filter'
+require 'capybara/selector/filters/expression_filter'
+require 'capybara/selector/filters/locator_filter'

data/capybara-3.40.0/lib/capybara/selector/filter_set.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'capybara/selector/filter'
+
+module Capybara
+  class Selector
+    class FilterSet
+      attr_reader :node_filters, :expression_filters
+
+      def initialize(name, &block)
+        @name = name
+        @node_filters = {}
+        @expression_filters = {}
+        @descriptions = Hash.new { |hsh, key| hsh[key] = [] }
+        instance_eval(&block) if block
+      end
+
+      def node_filter(names, *types, **options, &block)
+        Array(names).each do |name|
+          add_filter(name, Filters::NodeFilter, *types, **options, &block)
+        end
+      end
+      alias_method :filter, :node_filter
+
+      def expression_filter(name, *types, **options, &block)
+        add_filter(name, Filters::ExpressionFilter, *types, **options, &block)
+      end
+
+      def describe(what = nil, &block)
+        case what
+        when nil
+          undeclared_descriptions.push block
+        when :node_filters
+          node_filter_descriptions.push block
+        when :expression_filters
+          expression_filter_descriptions.push block
+        else
+          raise ArgumentError, 'Unknown description type'
+        end
+      end
+
+      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
+      end
+
+      def descriptions
+        Capybara::Helpers.warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'
+        [undeclared_descriptions, node_filter_descriptions, expression_filter_descriptions].flatten
+      end
+
+      def import(name, filters = nil)
+        filter_selector = filters.nil? ? ->(*) { true } : ->(filter_name, _) { filters.include? filter_name }
+
+        self.class[name].tap do |f_set|
+          expression_filters.merge!(f_set.expression_filters.select(&filter_selector))
+          node_filters.merge!(f_set.node_filters.select(&filter_selector))
+          f_set.undeclared_descriptions.each { |desc| describe(&desc) }
+          f_set.expression_filter_descriptions.each { |desc| describe(:expression_filters, &desc) }
+          f_set.node_filter_descriptions.each { |desc| describe(:node_filters, &desc) }
+        end
+        self
+      end
+
+      class << self
+        def all
+          @filter_sets ||= {} # rubocop:disable Naming/MemoizedInstanceVariableName
+        end
+
+        def [](name)
+          all.fetch(name.to_sym) { |set_name| raise ArgumentError, "Unknown filter set (:#{set_name})" }
+        end
+
+        def add(name, &block)
+          all[name.to_sym] = FilterSet.new(name.to_sym, &block)
+        end
+
+        def remove(name)
+          all.delete(name.to_sym)
+        end
+      end
+
+    protected
+
+      def undeclared_descriptions
+        @descriptions[:undeclared]
+      end
+
+      def node_filter_descriptions
+        @descriptions[:node_filters]
+      end
+
+      def expression_filter_descriptions
+        @descriptions[:expression_filters]
+      end
+
+    private
+
+      def options_with_defaults(options)
+        expression_filters
+          .chain(node_filters)
+          .filter_map { |name, filter| [name, filter.default] if filter.default? }
+          .to_h.merge!(options)
+      end
+
+      def add_filter(name, filter_class, *types, matcher: nil, **options, &block)
+        types.each { |type| options[type] = true }
+        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_class <= Filters::ExpressionFilter ? @expression_filters : @node_filters)[name] = filter
+      end
+    end
+  end
+end

data/capybara-3.40.0/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/capybara-3.40.0/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/capybara-3.40.0/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/capybara-3.40.0/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