grape 1.5.2 → 1.7.0

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

@@ -11,15 +11,21 @@ module Grape
       class PrimitiveCoercer < DryTypeCoercer
         MAPPING = {
           Grape::API::Boolean => DryTypes::Params::Bool,
-          BigDecimal          => DryTypes::Params::Decimal,
+          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
+          String => DryTypes::Coercible::String
         }.freeze
 
         STRICT_MAPPING = {
           Grape::API::Boolean => DryTypes::Strict::Bool,
-          BigDecimal          => DryTypes::Strict::Decimal
+          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)
@@ -27,11 +33,13 @@ module Grape
 
           @type = type
 
-          @coercer = if strict
-                       STRICT_MAPPING.fetch(type) { scope.const_get(type.name) }
-                     else
-                       MAPPING.fetch(type) { scope.const_get(type.name) }
-                     end
+          @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
         end
 
         def call(val)

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

@@ -9,8 +9,6 @@ module Grape
       # Takes the given array and converts it to a set. Every element of the set
       # is also coerced.
       class SetCoercer < ArrayCoercer
-        register_collection Set
-
         def initialize(type, strict = false)
           super
 

data/lib/grape/validations/types.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'types/build_coercer'
-require_relative 'types/custom_type_coercer'
-require_relative 'types/custom_type_collection_coercer'
-require_relative 'types/multiple_type_coercer'
-require_relative 'types/variant_collection_coercer'
-require_relative 'types/json'
-require_relative 'types/file'
-require_relative 'types/invalid_value'
+require 'grape/validations/types/json'
+require 'grape/validations/types/file'
 
 module Grape
   module Validations
@@ -22,7 +16,8 @@ module Grape
     # and {Grape::Dsl::Parameters#optional}. The main
     # entry point for this process is {Types.build_coercer}.
     module Types
-      # Types representing a single value, which are coerced.
+      module_function
+
       PRIMITIVES = [
         # Numerical
         Integer,
@@ -44,33 +39,23 @@ module Grape
       ].freeze
 
       # Types representing data structures.
-      STRUCTURES = [
-        Hash,
-        Array,
-        Set
-      ].freeze
+      STRUCTURES = [Hash, Array, Set].freeze
 
-      # Special custom types provided by Grape.
       SPECIAL = {
-        JSON => Json,
+        ::JSON => Json,
         Array[JSON] => JsonArray,
         ::File => File,
         Rack::Multipart::UploadedFile => File
       }.freeze
 
-      GROUPS = [
-        Array,
-        Hash,
-        JSON,
-        Array[JSON]
-      ].freeze
+      GROUPS = [Array, Hash, JSON, Array[JSON]].freeze
 
       # Is the given class a primitive type as recognized by Grape?
       #
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type is known by Grape as a valid
       #   type for a single value
-      def self.primitive?(type)
+      def primitive?(type)
         PRIMITIVES.include?(type)
       end
 
@@ -80,7 +65,7 @@ module Grape
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type is known by Grape as a valid
       #   data structure type
-      def self.structure?(type)
+      def structure?(type)
         STRUCTURES.include?(type)
       end
 
@@ -92,7 +77,7 @@ module Grape
       # @param type [Array<Class>,Set<Class>] type (or type list!) to check
       # @return [Boolean] +true+ if the given value will be treated as
       #   a list of types.
-      def self.multiple?(type)
+      def multiple?(type)
         (type.is_a?(Array) || type.is_a?(Set)) && type.size > 1
       end
 
@@ -103,7 +88,7 @@ module Grape
       #
       # @param type [Class] type to check
       # @return [Boolean] +true+ if special routines are available
-      def self.special?(type)
+      def special?(type)
         SPECIAL.key? type
       end
 
@@ -112,7 +97,7 @@ module Grape
       #
       # @param type [Array<Class>,Class] type to check
       # @return [Boolean] +true+ if the type is a supported group type
-      def self.group?(type)
+      def group?(type)
         GROUPS.include? type
       end
 
@@ -121,7 +106,7 @@ module Grape
       #
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type can be used as a custom type
-      def self.custom?(type)
+      def custom?(type)
         !primitive?(type) &&
           !structure?(type) &&
           !multiple?(type) &&
@@ -134,15 +119,98 @@ module Grape
       # @param type [Array<Class>,Class] type to check
       # @return [Boolean] true if +type+ is a collection of a type that implements
       #   its own +#parse+ method.
-      def self.collection_of_custom?(type)
+      def collection_of_custom?(type)
         (type.is_a?(Array) || type.is_a?(Set)) &&
           type.length == 1 &&
           (custom?(type.first) || special?(type.first))
       end
 
-      def self.map_special(type)
+      def map_special(type)
         SPECIAL.fetch(type, type)
       end
+
+      # Chooses the best coercer for the given type. For example, if the type
+      # is Integer, it will return a coercer which will be able to coerce a value
+      # to the integer.
+      #
+      # There are a few very special coercers which might be returned.
+      #
+      # +Grape::Types::MultipleTypeCoercer+ is a coercer which is returned when
+      # the given type implies values in an array with different types.
+      # For example, +[Integer, String]+ allows integer and string values in
+      # an array.
+      #
+      # +Grape::Types::CustomTypeCoercer+ is a coercer which is returned when
+      # a method is specified by a user with +coerce_with+ option or the user
+      # specifies a custom type which implements requirments of
+      # +Grape::Types::CustomTypeCoercer+.
+      #
+      # +Grape::Types::CustomTypeCollectionCoercer+ is a very similar to the
+      # previous one, but it expects an array or set of values having a custom
+      # type implemented by the user.
+      #
+      # There is also a group of custom types implemented by Grape, check
+      # +Grape::Validations::Types::SPECIAL+ to get the full list.
+      #
+      # @param type [Class] the type to which input strings
+      #   should be coerced
+      # @param method [Class,#call] the coercion method to use
+      # @return [Object] object to be used
+      #   for coercion and type validation
+      def build_coercer(type, method: nil, strict: false)
+        cache_instance(type, method, strict) do
+          create_coercer_instance(type, method, strict)
+        end
+      end
+
+      def create_coercer_instance(type, method, strict)
+        # Maps a custom type provided by Grape, it doesn't map types wrapped by collections!!!
+        type = Types.map_special(type)
+
+        # Use a special coercer for multiply-typed parameters.
+        if Types.multiple?(type)
+          MultipleTypeCoercer.new(type, method)
+
+          # Use a special coercer for custom types and coercion methods.
+        elsif method || Types.custom?(type)
+          CustomTypeCoercer.new(type, method)
+
+          # Special coercer for collections of types that implement a parse method.
+          # CustomTypeCoercer (above) already handles such types when an explicit coercion
+          # method is supplied.
+        elsif Types.collection_of_custom?(type)
+          Types::CustomTypeCollectionCoercer.new(
+            Types.map_special(type.first), type.is_a?(Set)
+          )
+        else
+          DryTypeCoercer.coercer_instance_for(type, strict)
+        end
+      end
+
+      def cache_instance(type, method, strict, &_block)
+        key = cache_key(type, method, strict)
+
+        return @__cache[key] if @__cache.key?(key)
+
+        instance = yield
+
+        @__cache_write_lock.synchronize do
+          @__cache[key] = instance
+        end
+
+        instance
+      end
+
+      def cache_key(type, method, strict)
+        [type, method, strict].each_with_object(+'_') do |val, memo|
+          next if val.nil?
+
+          memo << '_' << val.to_s
+        end
+      end
+
+      instance_variable_set(:@__cache,            {})
+      instance_variable_set(:@__cache_write_lock, Mutex.new)
     end
   end
 end

data/lib/grape/validations/validators/all_or_none_of_validator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class AllOrNoneOfValidator < MultipleParamsBase
+        def validate_params!(params)
+          keys = keys_in_common(params)
+          return if keys.empty? || keys.length == all_keys.length
+
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:all_or_none))
+        end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/allow_blank_validator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class AllowBlankValidator < Base
+        def validate_param!(attr_name, params)
+          return if (options_key?(:value) ? @option[:value] : @option) || !params.is_a?(Hash)
+
+          value = params[attr_name]
+          value = value.strip if value.respond_to?(:strip)
+
+          return if value == false || value.present?
+
+          raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:blank))
+        end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/as_validator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class AsValidator < Base
+        # We use a validator for renaming parameters. This is just a marker for
+        # the parameter scope to handle the renaming. No actual validation
+        # happens here.
+        def validate_param!(*); end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/at_least_one_of_validator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class AtLeastOneOfValidator < MultipleParamsBase
+        def validate_params!(params)
+          return unless keys_in_common(params).empty?
+
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:at_least_one))
+        end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/base.rb

@@ -2,89 +2,101 @@
 
 module Grape
   module Validations
-    class Base
-      attr_reader :attrs
+    module Validators
+      class Base
+        attr_reader :attrs
 
-      # Creates a new Validator from options specified
-      # by a +requires+ or +optional+ directive during
-      # parameter definition.
-      # @param attrs [Array] names of attributes to which the Validator applies
-      # @param options [Object] implementation-dependent Validator options
-      # @param required [Boolean] attribute(s) are required or optional
-      # @param scope [ParamsScope] parent scope for this Validator
-      # @param opts [Array] additional validation options
-      def initialize(attrs, options, required, scope, *opts)
-        @attrs = Array(attrs)
-        @option = options
-        @required = required
-        @scope = scope
-        opts = opts.any? ? opts.shift : {}
-        @fail_fast = opts.fetch(:fail_fast, false)
-        @allow_blank = opts.fetch(:allow_blank, false)
-      end
+        # Creates a new Validator from options specified
+        # by a +requires+ or +optional+ directive during
+        # parameter definition.
+        # @param attrs [Array] names of attributes to which the Validator applies
+        # @param options [Object] implementation-dependent Validator options
+        # @param required [Boolean] attribute(s) are required or optional
+        # @param scope [ParamsScope] parent scope for this Validator
+        # @param opts [Array] additional validation options
+        def initialize(attrs, options, required, scope, *opts)
+          @attrs = Array(attrs)
+          @option = options
+          @required = required
+          @scope = scope
+          opts = opts.any? ? opts.shift : {}
+          @fail_fast = opts.fetch(:fail_fast, false)
+          @allow_blank = opts.fetch(:allow_blank, false)
+        end
 
-      # Validates a given request.
-      # @note Override #validate! unless you need to access the entire request.
-      # @param request [Grape::Request] the request currently being handled
-      # @raise [Grape::Exceptions::Validation] if validation failed
-      # @return [void]
-      def validate(request)
-        return unless @scope.should_validate?(request.params)
-        validate!(request.params)
-      end
+        # Validates a given request.
+        # @note Override #validate! unless you need to access the entire request.
+        # @param request [Grape::Request] the request currently being handled
+        # @raise [Grape::Exceptions::Validation] if validation failed
+        # @return [void]
+        def validate(request)
+          return unless @scope.should_validate?(request.params)
+
+          validate!(request.params)
+        end
 
-      # Validates a given parameter hash.
-      # @note Override #validate if you need to access the entire request.
-      # @param params [Hash] parameters to validate
-      # @raise [Grape::Exceptions::Validation] if validation failed
-      # @return [void]
-      def validate!(params)
-        attributes = SingleAttributeIterator.new(self, @scope, params)
-        # we collect errors inside array because
-        # there may be more than one error per field
-        array_errors = []
+        # Validates a given parameter hash.
+        # @note Override #validate if you need to access the entire request.
+        # @param params [Hash] parameters to validate
+        # @raise [Grape::Exceptions::Validation] if validation failed
+        # @return [void]
+        def validate!(params)
+          attributes = SingleAttributeIterator.new(self, @scope, params)
+          # we collect errors inside array because
+          # there may be more than one error per field
+          array_errors = []
 
-        attributes.each do |val, attr_name, empty_val, skip_value|
-          next if skip_value
-          next if !@scope.required? && empty_val
-          next unless @scope.meets_dependency?(val, params)
-          begin
-            validate_param!(attr_name, val) if @required || val.respond_to?(:key?) && val.key?(attr_name)
-          rescue Grape::Exceptions::Validation => e
-            array_errors << e
+          attributes.each do |val, attr_name, empty_val, skip_value|
+            next if skip_value
+            next if !@scope.required? && empty_val
+            next unless @scope.meets_dependency?(val, params)
+
+            begin
+              validate_param!(attr_name, val) if @required || (val.respond_to?(:key?) && val.key?(attr_name))
+            rescue Grape::Exceptions::Validation => e
+              array_errors << e
+            end
           end
+
+          raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?
         end
 
-        raise Grape::Exceptions::ValidationArrayErrors, array_errors if array_errors.any?
-      end
+        def self.convert_to_short_name(klass)
+          ret = klass.name.gsub(/::/, '/')
+          ret.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          ret.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          ret.tr!('-', '_')
+          ret.downcase!
+          File.basename(ret, '_validator')
+        end
 
-      def self.convert_to_short_name(klass)
-        ret = klass.name.gsub(/::/, '/')
-        ret.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-        ret.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-        ret.tr!('-', '_')
-        ret.downcase!
-        File.basename(ret, '_validator')
-      end
+        def self.inherited(klass)
+          return unless klass.name.present?
 
-      def self.inherited(klass)
-        return unless klass.name.present?
-        Validations.register_validator(convert_to_short_name(klass), klass)
-      end
+          Validations.register_validator(convert_to_short_name(klass), klass)
+        end
 
-      def message(default_key = nil)
-        options = instance_variable_get(:@option)
-        options_key?(:message) ? options[:message] : default_key
-      end
+        def message(default_key = nil)
+          options = instance_variable_get(:@option)
+          options_key?(:message) ? options[:message] : default_key
+        end
 
-      def options_key?(key, options = nil)
-        options = instance_variable_get(:@option) if options.nil?
-        options.respond_to?(:key?) && options.key?(key) && !options[key].nil?
-      end
+        def options_key?(key, options = nil)
+          options = instance_variable_get(:@option) if options.nil?
+          options.respond_to?(:key?) && options.key?(key) && !options[key].nil?
+        end
 
-      def fail_fast?
-        @fail_fast
+        def fail_fast?
+          @fail_fast
+        end
       end
     end
   end
 end
+
+Grape::Validations::Base = Class.new(Grape::Validations::Validators::Base) do
+  def initialize(*)
+    super
+    warn '[DEPRECATION] `Grape::Validations::Base` is deprecated. Use `Grape::Validations::Validators::Base` instead.'
+  end
+end

data/lib/grape/validations/validators/coerce_validator.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class CoerceValidator < Base
+        def initialize(attrs, options, required, scope, **opts)
+          super
+
+          @converter = if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)
+                         type
+                       else
+                         Types.build_coercer(type, method: @option[:method])
+                       end
+        end
+
+        def validate_param!(attr_name, params)
+          raise validation_exception(attr_name) unless params.is_a? Hash
+
+          new_value = coerce_value(params[attr_name])
+
+          raise validation_exception(attr_name, new_value.message) unless valid_type?(new_value)
+
+          # Don't assign a value if it is identical. It fixes a problem with Hashie::Mash
+          # which looses wrappers for hashes and arrays after reassigning values
+          #
+          #     h = Hashie::Mash.new(list: [1, 2, 3, 4])
+          #     => #<Hashie::Mash list=#<Hashie::Array [1, 2, 3, 4]>>
+          #     list = h.list
+          #     h[:list] = list
+          #     h
+          #     => #<Hashie::Mash list=[1, 2, 3, 4]>
+          return if params[attr_name].instance_of?(new_value.class) && params[attr_name] == new_value
+
+          params[attr_name] = new_value
+        end
+
+        private
+
+        # @!attribute [r] converter
+        # Object that will be used for parameter coercion and type checking.
+        #
+        # See {Types.build_coercer}
+        #
+        # @return [Object]
+        attr_reader :converter
+
+        def valid_type?(val)
+          !val.is_a?(Types::InvalidValue)
+        end
+
+        def coerce_value(val)
+          converter.call(val)
+          # Some custom types might fail, so it should be treated as an invalid value
+        rescue StandardError
+          Types::InvalidValue.new
+        end
+
+        # Type to which the parameter will be coerced.
+        #
+        # @return [Class]
+        def type
+          @option[:type].is_a?(Hash) ? @option[:type][:value] : @option[:type]
+        end
+
+        def validation_exception(attr_name, custom_msg = nil)
+          Grape::Exceptions::Validation.new(
+            params: [@scope.full_name(attr_name)],
+            message: custom_msg || message(:coerce)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/default_validator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class DefaultValidator < Base
+        def initialize(attrs, options, required, scope, **opts)
+          @default = options
+          super
+        end
+
+        def validate_param!(attr_name, params)
+          params[attr_name] = if @default.is_a? Proc
+                                @default.call
+                              elsif @default.frozen? || !duplicatable?(@default)
+                                @default
+                              else
+                                duplicate(@default)
+                              end
+        end
+
+        def validate!(params)
+          attrs = SingleAttributeIterator.new(self, @scope, params)
+          attrs.each do |resource_params, attr_name|
+            next unless @scope.meets_dependency?(resource_params, params)
+
+            validate_param!(attr_name, resource_params) if resource_params.is_a?(Hash) && resource_params[attr_name].nil?
+          end
+        end
+
+        private
+
+        # return true if we might be able to dup this object
+        def duplicatable?(obj)
+          !obj.nil? &&
+            obj != true &&
+            obj != false &&
+            !obj.is_a?(Symbol) &&
+            !obj.is_a?(Numeric)
+        end
+
+        # make a best effort to dup the object
+        def duplicate(obj)
+          obj.dup
+        rescue TypeError
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/exactly_one_of_validator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class ExactlyOneOfValidator < MultipleParamsBase
+        def validate_params!(params)
+          keys = keys_in_common(params)
+          return if keys.length == 1
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one)) if keys.length.zero?
+
+          raise Grape::Exceptions::Validation.new(params: keys, message: message(:mutual_exclusion))
+        end
+      end
+    end
+  end
+end

data/lib/grape/validations/validators/except_values_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Grape
+  module Validations
+    module Validators
+      class ExceptValuesValidator < Base
+        def initialize(attrs, options, required, scope, **opts)
+          @except = options.is_a?(Hash) ? options[:value] : options
+          super
+        end
+
+        def validate_param!(attr_name, params)
+          return unless params.respond_to?(:key?) && params.key?(attr_name)
+
+          excepts = @except.is_a?(Proc) ? @except.call : @except
+          return if excepts.nil?
+
+          param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
+          raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:except_values)) if param_array.any? { |param| excepts.include?(param) }
+        end
+      end
+    end
+  end
+end