grape 0.12.0 → 0.14.0

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

@@ -1,13 +1,13 @@
 module Grape
   class API
-    Boolean = Virtus::Attribute::Boolean # rubocop:disable ConstantName
+    Boolean = Virtus::Attribute::Boolean
   end
 
   module Validations
     class CoerceValidator < Base
       def validate_param!(attr_name, params)
         fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :coerce unless params.is_a? Hash
-        new_value = coerce_value(@option, params[attr_name])
+        new_value = coerce_value(params[attr_name])
         if valid_type?(new_value)
           params[attr_name] = new_value
         else
@@ -15,52 +15,50 @@ module Grape
         end
       end
 
-      class InvalidValue; end
-
       private
 
-      def _valid_array_type?(type, values)
-        values.all? do |val|
-          _valid_single_type?(type, val)
-        end
-      end
+      def valid_type?(val)
+        # Special value to denote coercion failure
+        return false if val.instance_of?(Types::InvalidValue)
 
-      def _valid_single_type?(klass, val)
-        # allow nil, to ignore when a parameter is absent
+        # Allow nil, to ignore when a parameter is absent
         return true if val.nil?
-        if klass == Virtus::Attribute::Boolean
-          val.is_a?(TrueClass) || val.is_a?(FalseClass) || (val.is_a?(String) && val.empty?)
-        elsif klass == Rack::Multipart::UploadedFile
-          val.is_a?(Hashie::Mash) && val.key?(:tempfile)
-        elsif [DateTime, Date, Numeric].any? { |vclass| vclass >= klass }
-          return true if val.is_a?(String) && val.empty?
-          val.is_a?(klass)
-        else
-          val.is_a?(klass)
-        end
-      end
 
-      def valid_type?(val)
-        if @option.is_a?(Array) || @option.is_a?(Set)
-          _valid_array_type?(@option.first, val)
-        else
-          _valid_single_type?(@option, val)
-        end
+        converter.value_coerced? val
       end
 
-      def coerce_value(type, val)
+      def coerce_value(val)
         # Don't coerce things other than nil to Arrays or Hashes
-        return val || []      if type == Array
-        return val || Set.new if type == Set
-        return val || {}      if type == Hash
+        unless (@option[:method] && !val.nil?) || type.is_a?(Virtus::Attribute)
+          return val || []      if type == Array
+          return val || Set.new if type == Set
+          return val || {}      if type == Hash
+        end
 
-        converter = Virtus::Attribute.build(type)
         converter.coerce(val)
 
       # not the prettiest but some invalid coercion can currently trigger
       # errors in Virtus (see coerce_spec.rb:75)
       rescue
-        InvalidValue.new
+        Types::InvalidValue.new
+      end
+
+      # Type to which the parameter will be coerced.
+      #
+      # @return [Class]
+      def type
+        @option[:type]
+      end
+
+      # Create and cache the attribute object
+      # that will be used for parameter coercion
+      # and type checking.
+      #
+      # See {Types.build_coercer}
+      #
+      # @return [Virtus::Attribute]
+      def converter
+        @converter ||= Types.build_coercer(type, @option[:method])
       end
     end
   end

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

@@ -7,9 +7,8 @@ module Grape
       end
 
       def validate_param!(attr_name, params)
-        unless params.respond_to?(:key?) && params.key?(attr_name)
-          fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :presence
-        end
+        return if params.respond_to?(:key?) && params.key?(attr_name)
+        fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :presence
       end
     end
   end

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

@@ -2,10 +2,8 @@ module Grape
   module Validations
     class RegexpValidator < Base
       def validate_param!(attr_name, params)
-        if params.key?(attr_name) &&
-           !params[attr_name].nil? && !(params[attr_name].to_s =~ @option)
-          fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :regexp
-        end
+        return unless params.key?(attr_name) && !params[attr_name].nil? && !(params[attr_name].to_s =~ @option)
+        fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :regexp
       end
     end
   end

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

@@ -7,13 +7,13 @@ module Grape
       end
 
       def validate_param!(attr_name, params)
+        return unless params.is_a?(Hash)
         return unless params[attr_name] || required_for_root_scope?
 
         values = @values.is_a?(Proc) ? @values.call : @values
         param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
-        unless param_array.all? { |param| values.include?(param) }
-          fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :values
-        end
+        return if param_array.all? { |param| values.include?(param) }
+        fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :values
       end
 
       private

data/lib/grape/validations.rb

@@ -1,4 +1,5 @@
 module Grape
+  # Registry to store and locate known Validators.
   module Validations
     class << self
       attr_accessor :validators
@@ -6,6 +7,10 @@ module Grape
 
     self.validators = {}
 
+    # Register a new validator, so it can be used to validate parameters.
+    # @param short_name [String] all lower-case, no spaces
+    # @param klass [Class] the validator class. Should inherit from
+    #   Validations::Base.
     def self.register_validator(short_name, klass)
       validators[short_name] = klass
     end

data/lib/grape/version.rb

@@ -1,3 +1,4 @@
 module Grape
-  VERSION = '0.12.0'
+  # The current version of Grape.
+  VERSION = '0.14.0'
 end

data/lib/grape.rb

@@ -9,25 +9,21 @@ require 'hashie'
 require 'set'
 require 'active_support/version'
 require 'active_support/core_ext/hash/indifferent_access'
-
-if ActiveSupport::VERSION::MAJOR >= 4
-  require 'active_support/core_ext/object/deep_dup'
-else
-  require_relative 'backports/active_support/deep_dup'
-end
-
-require 'active_support/ordered_hash'
-require 'active_support/core_ext/object/conversions'
+require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/hash/except'
 require 'active_support/dependencies/autoload'
-require 'grape/util/content_types'
+require 'active_support/notifications'
 require 'multi_json'
 require 'multi_xml'
-require 'virtus'
 require 'i18n'
 require 'thread'
 
+require 'virtus'
+
 I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
 
 module Grape
@@ -44,7 +40,8 @@ module Grape
 
     autoload :Cookies
     autoload :Validations
-    autoload :Request, 'grape/http/request'
+    autoload :Request
+    autoload :Env, 'grape/util/env'
   end
 
   module Http
@@ -66,12 +63,14 @@ module Grape
     autoload :InvalidVersionerOption
     autoload :UnknownValidator
     autoload :UnknownOptions
+    autoload :UnknownParameter
     autoload :InvalidWithOptionForRepresent
     autoload :IncompatibleOptionValues
     autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
     autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
     autoload :InvalidMessageBody
     autoload :InvalidAcceptHeader
+    autoload :InvalidVersionHeader
   end
 
   module ErrorFormatter
@@ -129,6 +128,7 @@ module Grape
     autoload :StackableValues
     autoload :InheritableSetting
     autoload :StrictHashConfiguration
+    autoload :FileResponse
   end
 
   module DSL
@@ -159,6 +159,8 @@ module Grape
   end
 end
 
+require 'grape/util/content_types'
+
 require 'grape/validations/validators/base'
 require 'grape/validations/attributes_iterator'
 require 'grape/validations/validators/allow_blank'
@@ -172,5 +174,6 @@ require 'grape/validations/validators/regexp'
 require 'grape/validations/validators/values'
 require 'grape/validations/params_scope'
 require 'grape/validations/validators/all_or_none'
+require 'grape/validations/types'
 
 require 'grape/version'

data/spec/grape/api/custom_validations_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe Grape::Validations do
   before do
-    class DefaultLength < Grape::Validations::Base
-      def validate_param!(attr_name, params)
-        @option = params[:max].to_i if params.key?(:max)
-        unless params[attr_name].length <= @option
+    module CustomValidationsSpec
+      class DefaultLength < Grape::Validations::Base
+        def validate_param!(attr_name, params)
+          @option = params[:max].to_i if params.key?(:max)
+          return if params[attr_name].length <= @option
           fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
         end
       end

data/spec/grape/api/deeply_included_options_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-module API
+module DeeplyIncludedOptionsSpec
   module Defaults
     extend ActiveSupport::Concern
     included do
@@ -11,11 +11,11 @@ module API
   module Admin
     module Defaults
       extend ActiveSupport::Concern
-      include API::Defaults
+      include DeeplyIncludedOptionsSpec::Defaults
     end
 
     class Users < Grape::API
-      include API::Admin::Defaults
+      include DeeplyIncludedOptionsSpec::Admin::Defaults
 
       resource :users do
         get do
@@ -24,14 +24,14 @@ module API
       end
     end
   end
-end
 
-class Main < Grape::API
-  mount API::Admin::Users
+  class Main < Grape::API
+    mount DeeplyIncludedOptionsSpec::Admin::Users
+  end
 end
 
 describe Grape::API do
-  subject { Main }
+  subject { DeeplyIncludedOptionsSpec::Main }
 
   def app
     subject

data/spec/grape/api/nested_helpers_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Grape::API::Helpers do
-  subject do
+  module NestedHelpersSpec
     module HelperMethods
       extend Grape::API::Helpers
       def current_user
@@ -28,8 +28,10 @@ describe Grape::API::Helpers do
     class Main < Grape::API
       mount Nested
     end
+  end
 
-    Main
+  subject do
+    NestedHelpersSpec::Main
   end
 
   def app

data/spec/grape/api/shared_helpers_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 
 describe Grape::API::Helpers do
-  module SharedParams
-    extend Grape::API::Helpers
+  subject do
+    shared_params = Module.new do
+      extend Grape::API::Helpers
 
-    params :pagination do
-      optional :page, type: Integer
-      optional :size, type: Integer
+      params :pagination do
+        optional :page, type: Integer
+        optional :size, type: Integer
+      end
     end
-  end
 
-  subject do
     Class.new(Grape::API) do
-      helpers SharedParams
+      helpers shared_params
       format :json
 
       params do