grape 1.2.5 → 1.3.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class Base
@@ -17,6 +19,7 @@ module Grape
         @required = required
         @scope = scope
         @fail_fast = opts[:fail_fast] || false
+        @allow_blank = opts[:allow_blank] || false
       end
 
       # Validates a given request.
@@ -40,12 +43,12 @@ module Grape
         # there may be more than one error per field
         array_errors = []
 
-        attributes.each do |resource_params, attr_name|
-          next if !@scope.required? && resource_params.empty?
-          next unless @scope.meets_dependency?(resource_params, params)
+        attributes.each do |val, attr_name, empty_val|
+          next if !@scope.required? && empty_val
+          next unless @scope.meets_dependency?(val, params)
           begin
-            if @required || resource_params.respond_to?(:key?) && resource_params.key?(attr_name)
-              validate_param!(attr_name, resource_params)
+            if @required || val.respond_to?(:key?) && val.key?(attr_name)
+              validate_param!(attr_name, val)
             end
           rescue Grape::Exceptions::Validation => e
             array_errors << e

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

@@ -1,9 +1,17 @@
+# frozen_string_literal: true
+
 module Grape
   class API
-    Boolean = Virtus::Attribute::Boolean
+    class Boolean
+      def self.build(val)
+        return nil if val != true && val != false
+
+        new
+      end
+    end
 
     class Instance
-      Boolean = Virtus::Attribute::Boolean
+      Boolean = Grape::API::Boolean
     end
   end
 
@@ -11,7 +19,12 @@ module Grape
     class CoerceValidator < Base
       def initialize(*_args)
         super
-        @converter = Types.build_coercer(type, @option[:method])
+
+        @converter = if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)
+                       type
+                     else
+                       Types.build_coercer(type, method: @option[:method])
+                     end
       end
 
       def validate(request)
@@ -19,11 +32,22 @@ module Grape
       end
 
       def validate_param!(attr_name, params)
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:coerce) unless params.is_a? Hash
-        return unless requires_coercion?(params[attr_name])
+        raise validation_exception(attr_name) unless params.is_a? Hash
+
         new_value = coerce_value(params[attr_name])
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:coerce) unless valid_type?(new_value)
-        params[attr_name] = new_value
+
+        raise validation_exception(attr_name) 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]>
+        params[attr_name] = new_value unless params[attr_name] == new_value
       end
 
       private
@@ -33,31 +57,25 @@ module Grape
       #
       # See {Types.build_coercer}
       #
-      # @return [Virtus::Attribute]
+      # @return [Object]
       attr_reader :converter
 
       def valid_type?(val)
-        # Special value to denote coercion failure
-        return false if val.instance_of?(Types::InvalidValue)
-
-        # Allow nil, to ignore when a parameter is absent
-        return true if val.nil?
-
-        converter.value_coerced? val
+        !val.is_a?(Types::InvalidValue)
       end
 
       def coerce_value(val)
-        # Don't coerce things other than nil to Arrays or Hashes
-        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
+        # define default values for structures, the dry-types lib which is used
+        # for coercion doesn't accept nil as a value, so it would fail
+        if val.nil?
+          return []      if type == Array || type.is_a?(Array)
+          return Set.new if type == Set
+          return {}      if type == Hash
         end
 
-        converter.coerce(val)
+        converter.call(val)
 
-      # not the prettiest but some invalid coercion can currently trigger
-      # errors in Virtus (see coerce_spec.rb:75)
+      # Some custom types might fail, so it should be treated as an invalid value
       rescue
         Types::InvalidValue.new
       end
@@ -69,9 +87,8 @@ module Grape
         @option[:type].is_a?(Hash) ? @option[:type][:value] : @option[:type]
       end
 
-      def requires_coercion?(value)
-        # JSON types do not require coercion if value is valid
-        !valid_type?(value) || converter.coercer.respond_to?(:method) && !converter.is_a?(Grape::Validations::Types::Json)
+      def validation_exception(attr_name)
+        Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:coerce))
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class DefaultValidator < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/validations/validators/multiple_params_base'
 
 module Grape
@@ -5,7 +7,7 @@ module Grape
     class ExactlyOneOfValidator < MultipleParamsBase
       def validate_params!(params)
         return if keys_in_common(params).length == 1
-        raise Grape::Exceptions::Validation, params: all_keys, message: message(:exactly_one)
+        raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one))
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class ExceptValuesValidator < Base
@@ -13,7 +15,7 @@ module Grape
         return if excepts.nil?
 
         param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:except_values) if param_array.any? { |param| excepts.include?(param) }
+        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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class MultipleParamsBase < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/validations/validators/multiple_params_base'
 
 module Grape
@@ -6,7 +8,7 @@ module Grape
       def validate_params!(params)
         keys = keys_in_common(params)
         return if keys.length <= 1
-        raise Grape::Exceptions::Validation, params: keys, message: message(:mutual_exclusion)
+        raise Grape::Exceptions::Validation.new(params: keys, message: message(:mutual_exclusion))
       end
     end
   end

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class PresenceValidator < Base
       def validate_param!(attr_name, params)
         return if params.respond_to?(:key?) && params.key?(attr_name)
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:presence)
+        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:presence))
       end
     end
   end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class RegexpValidator < Base
       def validate_param!(attr_name, params)
         return unless params.respond_to?(:key?) && params.key?(attr_name)
         return if Array.wrap(params[attr_name]).all? { |param| param.nil? || (param.to_s =~ (options_key?(:value) ? @option[:value] : @option)) }
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:regexp)
+        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:regexp))
       end
     end
   end

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

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class SameAsValidator < Base
       def validate_param!(attr_name, params)
         confirmation = options_key?(:value) ? @option[:value] : @option
         return if params[attr_name] == params[confirmation]
-        raise Grape::Exceptions::Validation,
-              params: [@scope.full_name(attr_name)],
-              message: build_message
+        raise Grape::Exceptions::Validation.new(
+          params: [@scope.full_name(attr_name)],
+          message: build_message
+        )
       end
 
       private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Validations
     class ValuesValidator < Base
@@ -24,17 +26,23 @@ module Grape
 
       def validate_param!(attr_name, params)
         return unless params.is_a?(Hash)
-        return unless params[attr_name] || required_for_root_scope?
 
-        param_array = params[attr_name].nil? ? [nil] : Array.wrap(params[attr_name])
+        val = params[attr_name]
+
+        return if val.nil? && !required_for_root_scope?
+
+        # don't forget that +false.blank?+ is true
+        return if val != false && val.blank? && @allow_blank
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: except_message \
+        param_array = val.nil? ? [nil] : Array.wrap(val)
+
+        raise validation_exception(attr_name, except_message) \
           unless check_excepts(param_array)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
+        raise validation_exception(attr_name, message(:values)) \
           unless check_values(param_array, attr_name)
 
-        raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message(:values) \
+        raise validation_exception(attr_name, message(:values)) \
           if @proc && !param_array.all? { |param| @proc.call(param) }
       end
 
@@ -66,6 +74,10 @@ module Grape
       def required_for_root_scope?
         @required && @scope.root?
       end
+
+      def validation_exception(attr_name, message)
+        Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message)
+      end
     end
   end
 end

data/lib/grape/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Grape
   # The current version of Grape.
-  VERSION = '1.2.5'.freeze
+  VERSION = '1.3.0'
 end

data/spec/grape/api/custom_validations_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations do
@@ -8,7 +10,7 @@ describe Grape::Validations do
           def validate_param!(attr_name, params)
             @option = params[:max].to_i if params.key?(:max)
             return if params[attr_name].length <= @option
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
+            raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long")
           end
         end
       end
@@ -87,7 +89,7 @@ describe Grape::Validations do
       module CustomValidationsSpec
         class WithMessageKey < Grape::Validations::PresenceValidator
           def validate_param!(attr_name, _params)
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: :presence
+            raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: :presence)
           end
         end
       end
@@ -126,7 +128,7 @@ describe Grape::Validations do
             return unless @option
             # check if user is admin or not
             # as an example get a token from request and check if it's admin or not
-            raise Grape::Exceptions::Validation, params: @attrs, message: 'Can not set Admin only field.' unless request.headers['X-Access-Token'] == 'admin'
+            raise Grape::Exceptions::Validation.new(params: @attrs, message: 'Can not set Admin only field.') unless request.headers['X-Access-Token'] == 'admin'
           end
         end
       end

data/spec/grape/api/deeply_included_options_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module DeeplyIncludedOptionsSpec

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Instance do
@@ -21,7 +23,7 @@ describe Grape::API::Instance do
       { class: 'TrueClass', value: true }.to_s
     end
 
-    it 'sets Boolean as a Virtus::Attribute::Boolean' do
+    it 'sets Boolean as a type' do
       post '/echo?message=true'
       expect(last_response.status).to eq(201)
       expect(last_response.body).to eq expected_body
@@ -29,8 +31,8 @@ describe Grape::API::Instance do
 
     context 'Params endpoint type' do
       subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
-      it 'params type is a Virtus::Attribute::Boolean' do
-        is_expected.to eq 'Virtus::Attribute::Boolean'
+      it 'params type is a boolean' do
+        is_expected.to eq 'Grape::API::Boolean'
       end
     end
   end

data/spec/grape/api/inherited_helpers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::API::Helpers do

data/spec/grape/api/instance_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'shared/versioning_examples'
+
+describe Grape::API::Instance do
+  subject(:an_instance) do
+    Class.new(Grape::API::Instance) do
+      namespace :some_namespace do
+        get 'some_endpoint' do
+          'success'
+        end
+      end
+    end
+  end
+
+  let(:root_api) do
+    to_mount = an_instance
+    Class.new(Grape::API) do
+      mount to_mount
+    end
+  end
+
+  def app
+    root_api
+  end
+
+  context 'when an instance is mounted on the root' do
+    it 'can call the instance endpoint' do
+      get '/some_namespace/some_endpoint'
+      expect(last_response.body).to eq 'success'
+    end
+  end
+
+  context 'when an instance is the root' do
+    let(:root_api) do
+      to_mount = an_instance
+      Class.new(Grape::API::Instance) do
+        mount to_mount
+      end
+    end
+
+    it 'can call the instance endpoint' do
+      get '/some_namespace/some_endpoint'
+      expect(last_response.body).to eq 'success'
+    end
+  end
+
+  context 'top level setting' do
+    it 'does not inherit settings from the superclass (Grape::API::Instance)' do
+      expect(an_instance.top_level_setting.parent).to be_nil
+    end
+  end
+end

data/spec/grape/api/invalid_format_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do

data/spec/grape/api/namespace_parameters_in_route_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Endpoint do