grape 2.4.0 → 3.2.1

data/lib/grape/validations/params_scope.rb

@@ -3,18 +3,24 @@
 module Grape
   module Validations
     class ParamsScope
-      attr_accessor :element, :parent, :index
-      attr_reader :type, :params_meeting_dependency
+      attr_reader :parent, :type, :nearest_array_ancestor, :full_path
+
+      def qualifying_params
+        ParamScopeTracker.current&.qualifying_params(self)
+      end
 
       include Grape::DSL::Parameters
+      include Grape::Validations::ParamsDocumentation
 
       # There are a number of documentation options on entities that don't have
       # corresponding validators. Since there is nowhere that enumerates them all,
       # we maintain a list of them here and skip looking up validators for them.
       RESERVED_DOCUMENTATION_KEYWORDS = %i[as required param_type is_array format example].freeze
 
+      SPECIAL_JSON = [JSON, Array[JSON]].freeze
+
       class Attr
-        attr_accessor :key, :scope
+        attr_reader :key, :scope
 
         # Open up a new ParamsScope::Attr
         # @param key [Hash, Symbol] key of attr
@@ -44,40 +50,43 @@ module Grape
 
       # Open up a new ParamsScope, allowing parameter definitions per
       #   Grape::DSL::Params.
-      # @param opts [Hash] options for this scope
-      # @option opts :element [Symbol] the element that contains this scope; for
-      #   this to be relevant, @parent must be set
-      # @option opts :element_renamed [Symbol, nil] whenever this scope should
+      # @param api [API] the API endpoint to modify
+      # @param element [Symbol] the element that contains this scope; for
+      #   this to be relevant, parent must be set
+      # @param element_renamed [Symbol, nil] whenever this scope should
       #   be renamed and to what, given +nil+ no renaming is done
-      # @option opts :parent [ParamsScope] the scope containing this scope
-      # @option opts :api [API] the API endpoint to modify
-      # @option opts :optional [Boolean] whether or not this scope needs to have
+      # @param parent [ParamsScope] the scope containing this scope
+      # @param optional [Boolean] whether or not this scope needs to have
       #   any parameters set or not
-      # @option opts :type [Class] a type meant to govern this scope (deprecated)
-      # @option opts :type [Hash] group options for this scope
-      # @option opts :dependent_on [Symbol] if present, this scope should only
+      # @param type [Class] a type meant to govern this scope (deprecated)
+      # @param type [Hash] group options for this scope
+      # @param dependent_on [Symbol] if present, this scope should only
       #   validate if this param is present in the parent scope
       # @yield the instance context, open for parameter definitions
-      def initialize(opts, &block)
-        @element          = opts[:element]
-        @element_renamed  = opts[:element_renamed]
-        @parent           = opts[:parent]
-        @api              = opts[:api]
-        @optional         = opts[:optional] || false
-        @type             = opts[:type]
-        @group            = opts[:group]
-        @dependent_on     = opts[:dependent_on]
-        @params_meeting_dependency = []
+      def initialize(api:, element: nil, element_renamed: nil, parent: nil, optional: false, type: nil, group: nil, dependent_on: nil, &block)
+        @element          = element
+        @element_renamed  = element_renamed
+        @parent           = parent
+        @api              = api
+        @optional         = optional
+        @type             = type
+        @group            = group
+        @dependent_on     = dependent_on
+        # Must be an ivar: push_declared_params is dispatched on self during
+        # instance_eval, so local variables from initialize are unreachable.
+        # configure_declared_params consumes it and clears @declared_params to nil.
         @declared_params = []
-        @index = nil
+        @full_path = build_full_path
 
         instance_eval(&block) if block
 
         configure_declared_params
+        @nearest_array_ancestor = find_nearest_array_ancestor
+        freeze
       end
 
       def configuration
-        @api.configuration.respond_to?(:evaluate) ? @api.configuration.evaluate : @api.configuration
+        (@api.configuration.respond_to?(:evaluate) && @api.configuration.evaluate) || @api.configuration
       end
 
       # @return [Boolean] whether or not this entire scope needs to be
@@ -87,9 +96,9 @@ module Grape
 
         return false if @optional && (scoped_params.blank? || all_element_blank?(scoped_params))
         return false unless meets_dependency?(scoped_params, parameters)
-        return true if parent.nil?
+        return true if @parent.nil?
 
-        parent.should_validate?(parameters)
+        @parent.should_validate?(parameters)
       end
 
       def meets_dependency?(params, request_params)
@@ -97,8 +106,9 @@ module Grape
         return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)
 
         if params.is_a?(Array)
-          @params_meeting_dependency = params.flatten.filter { |param| meets_dependency?(param, request_params) }
-          return @params_meeting_dependency.present?
+          filtered = params.flatten.filter { |param| meets_dependency?(param, request_params) }
+          ParamScopeTracker.current&.store_qualifying_params(self, filtered)
+          return filtered.present?
         end
 
         meets_hash_dependency?(params)
@@ -115,28 +125,27 @@ module Grape
         # params might be anything what looks like a hash, so it must implement a `key?` method
         return false unless params.respond_to?(:key?)
 
-        @dependent_on.each do |dependency|
+        @dependent_on.all? do |dependency|
           if dependency.is_a?(Hash)
-            dependency_key = dependency.keys[0]
-            proc = dependency.values[0]
-            return false unless proc.call(params.try(:[], dependency_key))
-          elsif params.respond_to?(:key?) && params.try(:[], dependency).blank?
-            return false
+            key, callable = dependency.first
+            callable.call(params[key])
+          else
+            params[dependency].present?
           end
         end
-
-        true
       end
 
       # @return [String] the proper attribute name, with nesting considered.
       def full_name(name, index: nil)
+        tracker = ParamScopeTracker.current
         if nested?
           # Find our containing element's name, and append ours.
-          "#{@parent.full_name(@element)}#{brackets(index || @index)}#{brackets(name)}"
+          resolved_index = index || tracker&.index_for(self)
+          "#{@parent.full_name(@element)}#{brackets(resolved_index)}#{brackets(name)}"
         elsif lateral?
           # Find the name of the element as if it was at the same nesting level
           # as our parent. We need to forward our index upward to achieve this.
-          @parent.full_name(name, index: @index)
+          @parent.full_name(name, index: tracker&.index_for(self))
         else
           # We must be the root scope, so no prefix needed.
           name.to_s
@@ -171,28 +180,23 @@ module Grape
         !@optional
       end
 
-      def reset_index
-        @index = nil
-      end
-
       protected
 
       # Adds a parameter declaration to our list of validations.
       # @param attrs [Array] (see Grape::DSL::Parameters#requires)
-      def push_declared_params(attrs, opts = {})
+      def push_declared_params(attrs, **opts)
         opts[:declared_params_scope] = self unless opts.key?(:declared_params_scope)
-        return @parent.push_declared_params(attrs, opts) if lateral?
+        return @parent.push_declared_params(attrs, **opts) if lateral?
 
         push_renamed_param(full_path + [attrs.first], opts[:as]) if opts[:as]
         @declared_params.concat(attrs.map { |attr| ::Grape::Validations::ParamsScope::Attr.new(attr, opts[:declared_params_scope]) })
       end
 
-      # Get the full path of the parameter scope in the hierarchy.
-      #
-      # @return [Array<Symbol>] the nesting/path of the current parameter scope
-      def full_path
+      private
+
+      def build_full_path
         if nested?
-          (@parent.full_path + [@element])
+          @parent.full_path + [@element]
         elsif lateral?
           @parent.full_path
         else
@@ -200,8 +204,6 @@ module Grape
         end
       end
 
-      private
-
       # Add a new parameter which should be renamed when using the +#declared+
       # method.
       #
@@ -210,169 +212,160 @@ module Grape
       # @param new_name [String, Symbol] the new name of the parameter (the
       #   renamed name, with the +as: ...+ semantic)
       def push_renamed_param(path, new_name)
-        base = @api.route_setting(:renamed_params) || {}
+        api_route_setting = @api.inheritable_setting.route
+        base = api_route_setting[:renamed_params] || {}
         base[Array(path).map(&:to_s)] = new_name.to_s
-        @api.route_setting(:renamed_params, base)
+        api_route_setting[:renamed_params] = base
       end
 
-      def require_required_and_optional_fields(context, opts)
+      def require_required_and_optional_fields(context, using:, except: nil)
+        except_fields = Array.wrap(except)
+        using_fields = using.keys.delete_if { |f| except_fields.include?(f) }
+
         if context == :all
-          optional_fields = Array.wrap(opts[:except])
-          required_fields = opts[:using].keys.delete_if { |f| optional_fields.include?(f) }
+          optional_fields = except_fields
+          required_fields = using_fields
         else # context == :none
-          required_fields = Array.wrap(opts[:except])
-          optional_fields = opts[:using].keys.delete_if { |f| required_fields.include?(f) }
+          required_fields = except_fields
+          optional_fields = using_fields
         end
         required_fields.each do |field|
-          field_opts = opts[:using][field]
+          field_opts = using[field]
           raise ArgumentError, "required field not exist: #{field}" unless field_opts
 
-          requires(field, field_opts)
+          requires(field, **field_opts)
         end
         optional_fields.each do |field|
-          field_opts = opts[:using][field]
-          optional(field, field_opts) if field_opts
+          field_opts = using[field]
+          optional(field, **field_opts) if field_opts
         end
       end
 
-      def require_optional_fields(context, opts)
-        optional_fields = opts[:using].keys
+      def require_optional_fields(context, using:, except: nil)
+        optional_fields = using.keys
         unless context == :all
-          except_fields = Array.wrap(opts[:except])
+          except_fields = Array.wrap(except)
           optional_fields.delete_if { |f| except_fields.include?(f) }
         end
         optional_fields.each do |field|
-          field_opts = opts[:using][field]
-          optional(field, field_opts) if field_opts
+          field_opts = using[field]
+          optional(field, **field_opts) if field_opts
         end
       end
 
-      def validate_attributes(attrs, opts, &block)
-        validations = opts.clone
-        validations[:type] ||= Array if block
-        validates(attrs, validations)
+      def validate_attributes(attrs, **opts, &block)
+        opts[:type] ||= Array if block
+        validates(attrs, opts)
       end
 
       # Returns a new parameter scope, subordinate to the current one and nested
-      # under the parameter corresponding to `attrs.first`.
-      # @param attrs [Array] the attributes passed to the `requires` or
-      #   `optional` invocation that opened this scope.
-      # @param optional [Boolean] whether the parameter this are nested under
+      # under the given element.
+      # @param element [Symbol] the parameter name under which this scope is nested
+      # @param type [Class] the type governing this scope
+      # @param as [Symbol, nil] optional renamed name for the element
+      # @param optional [Boolean] whether the parameter this scope is nested under
       #   is optional or not (and hence, whether this block's params will be).
       # @yield parameter scope
-      def new_scope(attrs, optional = false, &block)
+      def new_scope(element, type:, as:, optional: false, &)
         # if required params are grouped and no type or unsupported type is provided, raise an error
-        type = attrs[1] ? attrs[1][:type] : nil
-        if attrs.first && !optional
+        if element && !optional
           raise Grape::Exceptions::MissingGroupType if type.nil?
           raise Grape::Exceptions::UnsupportedGroupType unless Grape::Validations::Types.group?(type)
         end
 
         self.class.new(
           api: @api,
-          element: attrs.first,
-          element_renamed: attrs[1][:as],
+          element:,
+          element_renamed: as,
           parent: self,
-          optional: optional,
+          optional:,
           type: type || Array,
           group: @group,
-          &block
+          &
         )
       end
 
       # Returns a new parameter scope, not nested under any current-level param
       # but instead at the same level as the current scope.
-      # @param options [Hash] options to control how this new scope behaves
-      # @option options :dependent_on [Symbol] if given, specifies that this
-      #   scope should only validate if this parameter from the above scope is
-      #   present
+      # @param dependent_on [Symbol] if given, specifies that this scope should
+      #   only validate if this parameter from the above scope is present
       # @yield parameter scope
-      def new_lateral_scope(options, &block)
+      def new_lateral_scope(dependent_on:, &)
         self.class.new(
           api: @api,
-          element: nil,
           parent: self,
-          options: @optional,
+          optional: @optional,
           type: type == Array ? Array : Hash,
-          dependent_on: options[:dependent_on],
-          &block
+          dependent_on:,
+          &
         )
       end
 
-      # Returns a new parameter scope, subordinate to the current one and nested
-      # under the parameter corresponding to `attrs.first`.
-      # @param attrs [Array] the attributes passed to the `requires` or
-      #   `optional` invocation that opened this scope.
+      # Returns a new parameter scope, subordinate to the current one, sharing
+      # the given group options with all parameters defined within.
+      # @param group [Hash] common options to merge into each parameter in the scope
       # @yield parameter scope
-      def new_group_scope(attrs, &block)
-        self.class.new(api: @api, parent: self, group: attrs.first, &block)
+      def new_group_scope(group, &)
+        self.class.new(api: @api, parent: self, group:, &)
       end
 
-      # Pushes declared params to parent or settings
+      # Pushes declared params to parent or settings, then clears @declared_params.
+      # Clearing here (rather than in initialize) keeps the lifecycle ownership in
+      # one place: this method both consumes and invalidates the ivar so that
+      # push_declared_params cannot be called on the frozen scope later.
       def configure_declared_params
         push_renamed_param(full_path, @element_renamed) if @element_renamed
 
         if nested?
-          @parent.push_declared_params [element => @declared_params]
+          @parent.push_declared_params [@element => @declared_params]
         else
-          @api.namespace_stackable(:declared_params, @declared_params)
+          @api.inheritable_setting.namespace_stackable[:declared_params] = @declared_params
         end
-
-        # params were stored in settings, it can be cleaned from the params scope
+      ensure
         @declared_params = nil
       end
 
-      def validates(attrs, validations)
-        doc = AttributesDoc.new @api, self
-        doc.extract_details validations
+      def find_nearest_array_ancestor
+        scope = @parent
+        scope = scope.parent while scope && scope.type != Array
+        scope
+      end
 
+      def validates(attrs, validations)
         coerce_type = infer_coercion(validations)
-
-        doc.type = coerce_type
-
+        required = validations.key?(:presence)
         default = validations[:default]
-
-        if (values_hash = validations[:values]).is_a? Hash
-          values = values_hash[:value]
-          # NB: excepts is deprecated
-          excepts = values_hash[:except]
-        else
-          values = validations[:values]
-        end
-
-        doc.values = values
-
-        except_values = options_key?(:except_values, :value, validations) ? validations[:except_values][:value] : validations[:except_values]
+        values = validations[:values].is_a?(Hash) ? validations.dig(:values, :value) : validations[:values]
+        except_values = validations[:except_values].is_a?(Hash) ? validations.dig(:except_values, :value) : validations[:except_values]
 
         # NB. values and excepts should be nil, Proc, Array, or Range.
         # Specifically, values should NOT be a Hash
-
         # use values or excepts to guess coerce type when stated type is Array
-        coerce_type = guess_coerce_type(coerce_type, values, except_values, excepts)
+        coerce_type = guess_coerce_type(coerce_type, values, except_values)
 
         # default value should be present in values array, if both exist and are not procs
-        check_incompatible_option_values(default, values, except_values, excepts)
+        check_incompatible_option_values(default, values, except_values)
 
         # type should be compatible with values array, if both exist
-        validate_value_coercion(coerce_type, values, except_values, excepts)
+        validate_value_coercion(coerce_type, values, except_values)
 
-        doc.document attrs
+        document_params attrs, validations, coerce_type, values, except_values
 
-        opts = derive_validator_options(validations)
+        opts = derive_validator_options(validations).freeze
 
         # Validate for presence before any other validators
-        validates_presence(validations, attrs, doc, opts)
+        validates_presence(validations, attrs, opts)
 
         # Before we run the rest of the validators, let's handle
         # whatever coercion so that we are working with correctly
         # type casted values
-        coerce_type validations, attrs, doc, opts
+        coerce_type validations.extract!(:coerce, :coerce_with, :coerce_message), attrs, required, opts
 
         validations.each do |type, options|
           # Don't try to look up validators for documentation params that don't have one.
           next if RESERVED_DOCUMENTATION_KEYWORDS.include?(type)
 
-          validate(type, options, attrs, doc, opts)
+          validate(type, options, attrs, required, opts)
         end
       end
 
@@ -425,7 +418,7 @@ module Grape
 
         # but not special JSON types, which
         # already imply coercion method
-        return if [JSON, Array[JSON]].exclude? validations[:coerce]
+        return unless SPECIAL_JSON.include?(validations[:coerce])
 
         raise ArgumentError, 'coerce_with disallowed for type: JSON'
       end
@@ -436,20 +429,22 @@ module Grape
       # composited from more than one +requires+/+optional+
       # parameter, and needs to be run before most other
       # validations.
-      def coerce_type(validations, attrs, doc, opts)
+      def coerce_type(validations, attrs, required, opts)
         check_coerce_with(validations)
 
-        return unless validations.key?(:coerce)
+        # Falsy check (not key?) is intentional: when a remountable API is first
+        # evaluated on its base instance (no configuration supplied yet),
+        # configuration[:some_type] evaluates to nil. Skipping instantiation
+        # here is correct — the real mounted instance will replay this step with
+        # the actual type value.
+        return unless validations[:coerce]
 
         coerce_options = {
           type: validations[:coerce],
           method: validations[:coerce_with],
           message: validations[:coerce_message]
         }
-        validate('coerce', coerce_options, attrs, doc, opts)
-        validations.delete(:coerce_with)
-        validations.delete(:coerce)
-        validations.delete(:coerce_message)
+        validate('coerce', coerce_options, attrs, required, opts)
       end
 
       def guess_coerce_type(coerce_type, *values_list)
@@ -462,30 +457,26 @@ module Grape
         coerce_type
       end
 
-      def check_incompatible_option_values(default, values, except_values, excepts)
+      def check_incompatible_option_values(default, values, except_values)
         return unless default && !default.is_a?(Proc)
 
         raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values) if values && !values.is_a?(Proc) && !Array(default).all? { |def_val| values.include?(def_val) }
 
-        if except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }
-          raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)
-        end
+        return unless except_values && !except_values.is_a?(Proc) && Array(default).any? { |def_val| except_values.include?(def_val) }
 
-        return unless excepts && !excepts.is_a?(Proc)
-        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, excepts) \
-          unless Array(default).none? { |def_val| excepts.include?(def_val) }
+        raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :except, except_values)
       end
 
-      def validate(type, options, attrs, doc, opts)
-        validator_options = {
-          attributes: attrs,
-          options: options,
-          required: doc.required,
-          params_scope: self,
-          opts: opts,
-          validator_class: Validations.require_validator(type)
-        }
-        @api.namespace_stackable(:validations, validator_options)
+      def validate(type, options, attrs, required, opts)
+        validator_class = Validations.require_validator(type)
+        validator_instance = validator_class.new(
+          attrs,
+          options,
+          required,
+          self,
+          opts
+        )
+        @api.inheritable_setting.namespace_stackable[:validations] = validator_instance
       end
 
       def validate_value_coercion(coerce_type, *values_list)
@@ -527,10 +518,10 @@ module Grape
         }
       end
 
-      def validates_presence(validations, attrs, doc, opts)
+      def validates_presence(validations, attrs, opts)
         return unless validations.key?(:presence) && validations[:presence]
 
-        validate('presence', validations.delete(:presence), attrs, doc, opts)
+        validate('presence', validations.delete(:presence), attrs, true, opts)
         validations.delete(:message) if validations.key?(:message)
       end
     end

data/lib/grape/validations/single_attribute_iterator.rb

@@ -5,10 +5,10 @@ module Grape
     class SingleAttributeIterator < AttributesIterator
       private
 
-      def yield_attributes(val, attrs)
+      def yield_attributes(val)
         return if skip?(val)
 
-        attrs.each do |attr_name|
+        @attrs.each do |attr_name|
           yield val, attr_name, empty?(val)
         end
       end

data/lib/grape/validations/types/array_coercer.rb

@@ -7,15 +7,14 @@ module Grape
       # an array of arrays of integers.
       #
       # It could've been possible to use an +of+
-      # method (https://dry-rb.org/gems/dry-types/1.2/array-with-member/)
+      # method (https://dry-rb.org/gems/dry-types/main/array-with-member/)
       # provided by dry-types. Unfortunately, it doesn't work for Grape because of
       # behavior of Virtus which was used earlier, a `Grape::Validations::Types::PrimitiveCoercer`
       # maintains Virtus behavior in coercing.
       class ArrayCoercer < DryTypeCoercer
         def initialize(type, strict = false)
           super
-
-          @coercer = scope::Array
+          @coercer = strict ? DryTypes::Strict::Array : DryTypes::Params::Array
           @subtype = type.first
         end
 

data/lib/grape/validations/types/dry_type_coercer.rb

@@ -1,19 +1,12 @@
 # frozen_string_literal: true
 
-module DryTypes
-  # Call +Dry.Types()+ to add all registered types to +DryTypes+ which is
-  # a container in this case. Check documentation for more information
-  # https://dry-rb.org/gems/dry-types/1.2/getting-started/
-  include Dry.Types()
-end
-
 module Grape
   module Validations
     module Types
       # A base class for classes which must identify a coercer to be used.
       # If the +strict+ argument is true, it won't coerce the given value
       # but check its type. More information there
-      # https://dry-rb.org/gems/dry-types/1.2/built-in-types/
+      # https://dry-rb.org/gems/dry-types/main/built-in-types/
       class DryTypeCoercer
         class << self
           # Returns a collection coercer which corresponds to a given type.
@@ -42,7 +35,7 @@ module Grape
         def initialize(type, strict = false)
           @type = type
           @strict = strict
-          @scope = strict ? DryTypes::Strict : DryTypes::Params
+          @cache_coercer = strict ? DryTypes::StrictCache : DryTypes::ParamsCache
         end
 
         # Coerces the given value to a type which was specified during
@@ -53,13 +46,13 @@ module Grape
           return if val.nil?
 
           @coercer[val]
-        rescue Dry::Types::CoercionError => _e
+        rescue Dry::Types::CoercionError
           InvalidValue.new
         end
 
         protected
 
-        attr_reader :scope, :type, :strict
+        attr_reader :type, :strict, :cache_coercer
       end
     end
   end

data/lib/grape/validations/types/primitive_coercer.rb

@@ -7,37 +7,10 @@ module Grape
       # initialization. When +strict+ is true, it doesn't coerce a value but check
       # that it has the proper type.
       class PrimitiveCoercer < DryTypeCoercer
-        MAPPING = {
-          Grape::API::Boolean => DryTypes::Params::Bool,
-          BigDecimal => DryTypes::Params::Decimal,
-          Numeric => DryTypes::Params::Integer | DryTypes::Params::Float | DryTypes::Params::Decimal,
-          TrueClass => DryTypes::Params::Bool.constrained(eql: true),
-          FalseClass => DryTypes::Params::Bool.constrained(eql: false),
-
-          # unfortunately, a +Params+ scope doesn't contain String
-          String => DryTypes::Coercible::String
-        }.freeze
-
-        STRICT_MAPPING = {
-          Grape::API::Boolean => DryTypes::Strict::Bool,
-          BigDecimal => DryTypes::Strict::Decimal,
-          Numeric => DryTypes::Strict::Integer | DryTypes::Strict::Float | DryTypes::Strict::Decimal,
-          TrueClass => DryTypes::Strict::Bool.constrained(eql: true),
-          FalseClass => DryTypes::Strict::Bool.constrained(eql: false)
-        }.freeze
-
         def initialize(type, strict = false)
           super
 
-          @type = type
-
-          @coercer = (strict ? STRICT_MAPPING : MAPPING).fetch(type) do
-            scope.const_get(type.name, false)
-          rescue NameError
-            raise ArgumentError, "type #{type} should support coercion via `[]`" unless type.respond_to?(:[])
-
-            type
-          end
+          @coercer = cache_coercer[type]
         end
 
         def call(val)