grape 1.7.1 → 1.8.0

data/lib/grape/validations/params_scope.rb

@@ -10,6 +10,11 @@ module Grape
 
       include Grape::DSL::Parameters
 
+      # 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
+
       class Attr
         attr_accessor :key, :scope
 
@@ -359,7 +364,8 @@ module Grape
         coerce_type validations, attrs, doc, opts
 
         validations.each do |type, options|
-          next if type == :as
+          # 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)
         end
@@ -414,7 +420,7 @@ module Grape
 
         # but not special JSON types, which
         # already imply coercion method
-        return unless [JSON, Array[JSON]].include? validations[:coerce]
+        return if [JSON, Array[JSON]].exclude? validations[:coerce]
 
         raise ArgumentError, 'coerce_with disallowed for type: JSON'
       end

data/lib/grape/validations/single_attribute_iterator.rb

@@ -6,8 +6,10 @@ module Grape
       private
 
       def yield_attributes(val, attrs)
+        return if skip?(val)
+
         attrs.each do |attr_name|
-          yield val, attr_name, empty?(val), skip?(val)
+          yield val, attr_name, empty?(val)
         end
       end
 

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

@@ -141,7 +141,7 @@ module Grape
             lambda do |val|
               method.call(val).tap do |new_val|
                 new_val.map do |item|
-                  item.is_a?(Hash) ? symbolize_keys(item) : item
+                  item.is_a?(Hash) ? item.deep_symbolize_keys : item
                 end
               end
             end
@@ -149,7 +149,7 @@ module Grape
           # Hash objects are processed directly
           elsif type == Hash
             lambda do |val|
-              symbolize_keys method.call(val)
+              method.call(val).deep_symbolize_keys
             end
 
           # Simple types are not processed.
@@ -158,20 +158,6 @@ module Grape
             method
           end
         end
-
-        def symbolize_keys!(hash)
-          hash.each_key do |key|
-            hash[key.to_sym] = hash.delete(key) if key.respond_to?(:to_sym)
-          end
-          hash
-        end
-
-        def symbolize_keys(hash)
-          hash.inject({}) do |new_hash, (key, value)|
-            new_key = key.respond_to?(:to_sym) ? key.to_sym : key
-            new_hash.merge!(new_key => value)
-          end
-        end
       end
     end
   end

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

@@ -46,34 +46,23 @@ module Grape
           # 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
+          attributes.each do |val, attr_name, empty_val|
             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
+            validate_param!(attr_name, val) if @required || (val.respond_to?(:key?) && val.key?(attr_name))
+          rescue Grape::Exceptions::Validation => e
+            array_errors << e
           end
 
           raise Grape::Exceptions::ValidationArrayErrors.new(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.inherited(klass)
-          return unless klass.name.present?
+          return if klass.name.blank?
 
-          Validations.register_validator(convert_to_short_name(klass), klass)
+          short_validator_name = klass.name.demodulize.underscore.delete_suffix('_validator')
+          Validations.register_validator(short_validator_name, klass)
         end
 
         def message(default_key = nil)
@@ -95,8 +84,8 @@ module Grape
 end
 
 Grape::Validations::Base = Class.new(Grape::Validations::Validators::Base) do
-  def initialize(*)
+  def self.inherited(*)
+    ActiveSupport::Deprecation.warn 'Grape::Validations::Base is deprecated! Use Grape::Validations::Validators::Base instead.'
     super
-    warn '[DEPRECATION] `Grape::Validations::Base` is deprecated. Use `Grape::Validations::Validators::Base` instead.'
   end
 end

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

@@ -12,10 +12,10 @@ module Grape
         def validate_param!(attr_name, params)
           params[attr_name] = if @default.is_a? Proc
                                 @default.call
-                              elsif @default.frozen? || !duplicatable?(@default)
+                              elsif @default.frozen? || !@default.duplicable?
                                 @default
                               else
-                                duplicate(@default)
+                                @default.dup
                               end
         end
 
@@ -27,24 +27,6 @@ module Grape
             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

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

@@ -8,14 +8,10 @@ module Grape
           attributes = MultipleAttributesIterator.new(self, @scope, params)
           array_errors = []
 
-          attributes.each do |resource_params, skip_value|
-            next if skip_value
-
-            begin
-              validate_params!(resource_params)
-            rescue Grape::Exceptions::Validation => e
-              array_errors << e
-            end
+          attributes.each do |resource_params|
+            validate_params!(resource_params)
+          rescue Grape::Exceptions::Validation => e
+            array_errors << e
           end
 
           raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?

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

@@ -10,13 +10,11 @@ module Grape
             @values = options[:value]
             @proc = options[:proc]
 
-            warn '[DEPRECATION] The values validator except option is deprecated. ' \
-                 'Use the except validator instead.' if @excepts
+            ActiveSupport::Deprecation.warn('The values validator except option is deprecated. Use the except validator instead.') if @excepts
 
             raise ArgumentError, 'proc must be a Proc' if @proc && !@proc.is_a?(Proc)
 
-            warn '[DEPRECATION] The values validator proc option is deprecated. ' \
-                 'The lambda expression can now be assigned directly to values.' if @proc
+            ActiveSupport::Deprecation.warn('The values validator proc option is deprecated. The lambda expression can now be assigned directly to values.') if @proc
           else
             @excepts = nil
             @values = nil
@@ -45,7 +43,7 @@ module Grape
           unless check_values(param_array, attr_name)
 
           raise validation_exception(attr_name, message(:values)) \
-          if @proc && !param_array.all? { |param| @proc.call(param) }
+            if @proc && !validate_proc(@proc, param_array)
         end
 
         private
@@ -70,6 +68,17 @@ module Grape
           param_array.none? { |param| excepts.include?(param) }
         end
 
+        def validate_proc(proc, param_array)
+          case proc.arity
+          when 0
+            param_array.all? { |_param| proc.call }
+          when 1
+            param_array.all? { |param| proc.call(param) }
+          else
+            raise ArgumentError, 'proc arity must be 0 or 1'
+          end
+        end
+
         def except_message
           options = instance_variable_get(:@option)
           options_key?(:except_message) ? options[:except_message] : message(:except_values)

data/lib/grape/version.rb

@@ -2,5 +2,5 @@
 
 module Grape
   # The current version of Grape.
-  VERSION = '1.7.1'
+  VERSION = '1.8.0'
 end

data/lib/grape.rb

@@ -11,6 +11,7 @@ require 'bigdecimal'
 require 'date'
 require 'active_support'
 require 'active_support/concern'
+require 'active_support/configurable'
 require 'active_support/version'
 require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
 require 'active_support/core_ext/array/conversions'
@@ -20,16 +21,21 @@ require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/duplicable'
 require 'active_support/dependencies/autoload'
+require 'active_support/deprecation'
+require 'active_support/inflector'
 require 'active_support/notifications'
 require 'i18n'
 
 I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
+  include ActiveSupport::Configurable
   extend ::ActiveSupport::Autoload
 
   eager_autoload do
@@ -92,8 +98,6 @@ module Grape
   module Extensions
     extend ::ActiveSupport::Autoload
     eager_autoload do
-      autoload :DeepMergeableHash
-      autoload :DeepSymbolizeHash
       autoload :Hash
     end
     module ActiveSupport
@@ -285,9 +289,13 @@ module Grape
       autoload :InvalidValue
     end
   end
+
+  configure do |config|
+    config.param_builder = Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+    config.compile_methods!
+  end
 end
 
-require 'grape/config'
 require 'grape/content_types'
 
 require 'grape/util/lazy_value'

data/spec/grape/api/custom_validations_spec.rb

@@ -1,48 +1,17 @@
 # frozen_string_literal: true
 
-describe Grape::Validations do
-  context 'deprecated Grape::Validations::Base' do
-    subject do
-      Class.new(Grape::API) do
-        params do
-          requires :text, validator_with_old_base: true
-        end
-        get do
-        end
-      end
-    end
-
-    let(:validator_with_old_base) do
-      Class.new(Grape::Validations::Base) do
-        def validate_param!(_attr_name, _params)
-          true
-        end
-      end
-    end
-
-    before do
-      described_class.register_validator('validator_with_old_base', validator_with_old_base)
-      allow(Warning).to receive(:warn)
-    end
+require 'shared/deprecated_class_examples'
 
-    after do
-      described_class.deregister_validator('validator_with_old_base')
-    end
-
-    def app
-      subject
+describe Grape::Validations do
+  describe 'Grape::Validations::Base' do
+    let(:deprecated_class) do
+      Class.new(Grape::Validations::Base)
     end
 
-    it 'puts a deprecation warning' do
-      expect(Warning).to receive(:warn) do |message|
-        expect(message).to include('`Grape::Validations::Base` is deprecated')
-      end
-
-      get '/'
-    end
+    it_behaves_like 'deprecated class'
   end
 
-  context 'using a custom length validator' do
+  describe 'using a custom length validator' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -64,6 +33,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('default_length', default_length_validator)
@@ -73,10 +43,6 @@ describe Grape::Validations do
       described_class.deregister_validator('default_length')
     end
 
-    def app
-      subject
-    end
-
     it 'under 140 characters' do
       get '/', text: 'abc'
       expect(last_response.status).to eq 200
@@ -96,7 +62,7 @@ describe Grape::Validations do
     end
   end
 
-  context 'using a custom body-only validator' do
+  describe 'using a custom body-only validator' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -115,6 +81,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('in_body', in_body_validator)
@@ -124,10 +91,6 @@ describe Grape::Validations do
       described_class.deregister_validator('in_body')
     end
 
-    def app
-      subject
-    end
-
     it 'allows field in body' do
       get '/', text: 'abc'
       expect(last_response.status).to eq 200
@@ -141,7 +104,7 @@ describe Grape::Validations do
     end
   end
 
-  context 'using a custom validator with message_key' do
+  describe 'using a custom validator with message_key' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -160,6 +123,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('with_message_key', message_key_validator)
@@ -169,10 +133,6 @@ describe Grape::Validations do
       described_class.deregister_validator('with_message_key')
     end
 
-    def app
-      subject
-    end
-
     it 'fails with message' do
       get '/', text: 'foobar'
       expect(last_response.status).to eq 400
@@ -180,7 +140,7 @@ describe Grape::Validations do
     end
   end
 
-  context 'using a custom request/param validator' do
+  describe 'using a custom request/param validator' do
     subject do
       Class.new(Grape::API) do
         params do
@@ -208,6 +168,7 @@ describe Grape::Validations do
         end
       end
     end
+    let(:app) { Rack::Builder.new(subject) }
 
     before do
       described_class.register_validator('admin', admin_validator)
@@ -217,10 +178,6 @@ describe Grape::Validations do
       described_class.deregister_validator('admin')
     end
 
-    def app
-      subject
-    end
-
     it 'fail when non-admin user sets an admin field' do
       get '/', admin_field: 'tester', non_admin_field: 'toaster'
       expect(last_response.status).to eq 400

data/spec/grape/api_remount_spec.rb

@@ -147,6 +147,42 @@ describe Grape::API do
         end
       end
 
+      context 'when the params are configured via a configuration' do
+        subject(:a_remounted_api) do
+          Class.new(described_class) do
+            params do
+              requires configuration[:required_attr_name], type: String
+            end
+
+            get(mounted { configuration[:endpoint] }) do
+              status 200
+            end
+          end
+        end
+
+        context 'when the configured param is my_attr' do
+          it 'requires the configured params' do
+            root_api.mount a_remounted_api, with: {
+              required_attr_name: 'my_attr',
+              endpoint: 'test'
+            }
+            get 'test?another_attr=1'
+            expect(last_response.status).to eq 400
+            get 'test?my_attr=1'
+            expect(last_response.status).to eq 200
+
+            root_api.mount a_remounted_api, with: {
+              required_attr_name: 'another_attr',
+              endpoint: 'test_b'
+            }
+            get 'test_b?another_attr=1'
+            expect(last_response.status).to eq 200
+            get 'test_b?my_attr=1'
+            expect(last_response.status).to eq 400
+          end
+        end
+      end
+
       context 'when executing a standard block within a `mounted` block with all dynamic params' do
         subject(:a_remounted_api) do
           Class.new(described_class) do

data/spec/grape/api_spec.rb

@@ -3311,7 +3311,7 @@ describe Grape::API do
       it 'is able to cascade' do
         subject.mount lambda { |env|
           headers = {}
-          headers['X-Cascade'] == 'pass' unless env['PATH_INFO'].include?('boo')
+          headers['X-Cascade'] == 'pass' if env['PATH_INFO'].exclude?('boo')
           [200, headers, ['Farfegnugen']]
         } => '/'
 
@@ -4226,6 +4226,15 @@ describe Grape::API do
       end
     end
 
+    it 'does not override methods inherited from Class' do
+      Class.define_method(:test_method) {}
+      subclass = Class.new(described_class)
+      expect(subclass).not_to receive(:add_setup)
+      subclass.test_method
+    ensure
+      Class.remove_method(:test_method)
+    end
+
     context 'overriding via composition' do
       module Inherited
         def inherited(api)