grape 1.7.1 → 1.8.0

data/spec/grape/validations/validators/values_spec.rb

@@ -30,6 +30,10 @@ describe Grape::Validations::Validators::ValuesValidator do
         def include?(value)
           values.include?(value)
         end
+
+        def even?(value)
+          value.to_i.even?
+        end
       end
     end
   end
@@ -241,6 +245,18 @@ describe Grape::Validations::Validators::ValuesValidator do
       end
       get '/proc/message'
 
+      params do
+        requires :number, values: { value: ->(v) { ValuesModel.even? v }, message: 'must be even' }
+      end
+      get '/proc/custom_message' do
+        { message: 'success' }
+      end
+
+      params do
+        requires :input_one, :input_two, values: { value: ->(v1, v2) { v1 + v2 > 10 } }
+      end
+      get '/proc/arity2'
+
       params do
         optional :name, type: String, values: %w[a b], allow_blank: true
       end
@@ -692,5 +708,26 @@ describe Grape::Validations::Validators::ValuesValidator do
       expect(last_response.status).to eq 400
       expect(last_response.body).to eq({ error: 'type failed check' }.to_json)
     end
+
+    context 'when proc has an arity of 1' do
+      it 'accepts a valid value' do
+        get '/proc/custom_message', number: 4
+        expect(last_response.status).to eq 200
+        expect(last_response.body).to eq({ message: 'success' }.to_json)
+      end
+
+      it 'rejects an invalid value' do
+        get '/proc/custom_message', number: 5
+        expect(last_response.status).to eq 400
+        expect(last_response.body).to eq({ error: 'number must be even' }.to_json)
+      end
+    end
+
+    context 'when arity is > 1' do
+      it 'returns an error status code' do
+        get '/proc/arity2', input_one: 2, input_two: 3
+        expect(last_response.status).to eq 400
+      end
+    end
   end
 end

data/spec/grape/validations_spec.rb

@@ -179,11 +179,12 @@ describe Grape::Validations do
     context 'requires :all using Grape::Entity documentation' do
       def define_requires_all
         documentation = {
-          required_field: { type: String },
-          optional_field: { type: String }
+          required_field: { type: String, required: true, param_type: 'query' },
+          optional_field: { type: String },
+          optional_array_field: { type: Array[String], is_array: true }
         }
         subject.params do
-          requires :all, except: :optional_field, using: documentation
+          requires :all, except: %i[optional_field optional_array_field], using: documentation
         end
       end
       before do
@@ -195,7 +196,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_requires_all
-        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq(%i[required_field optional_field])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq(%i[required_field optional_field optional_array_field])
       end
 
       it 'errors when required_field is not present' do
@@ -214,8 +215,8 @@ describe Grape::Validations do
     context 'requires :none using Grape::Entity documentation' do
       def define_requires_none
         documentation = {
-          required_field: { type: String },
-          optional_field: { type: String }
+          required_field: { type: String, example: 'Foo' },
+          optional_field: { type: Integer, format: 'int64' }
         }
         subject.params do
           requires :none, except: :required_field, using: documentation

data/spec/shared/deprecated_class_examples.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'deprecated class' do
+  subject { deprecated_class.new }
+
+  around do |example|
+    old_deprec_behavior = ActiveSupport::Deprecation.behavior
+    ActiveSupport::Deprecation.behavior = :raise
+    example.run
+    ActiveSupport::Deprecation.behavior = old_deprec_behavior
+  end
+
+  it 'raises an ActiveSupport::DeprecationException' do
+    expect { subject }.to raise_error(ActiveSupport::DeprecationException)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-14 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -73,9 +73,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,9 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack-accept
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +112,6 @@ files:
 - lib/grape/api.rb
 - lib/grape/api/helpers.rb
 - lib/grape/api/instance.rb
-- lib/grape/config.rb
 - lib/grape/content_types.rb
 - lib/grape/cookies.rb
 - lib/grape/dry_types.rb
@@ -167,8 +160,6 @@ files:
 - lib/grape/exceptions/validation_array_errors.rb
 - lib/grape/exceptions/validation_errors.rb
 - lib/grape/extensions/active_support/hash_with_indifferent_access.rb
-- lib/grape/extensions/deep_mergeable_hash.rb
-- lib/grape/extensions/deep_symbolize_hash.rb
 - lib/grape/extensions/hash.rb
 - lib/grape/extensions/hashie/mash.rb
 - lib/grape/formatter.rb
@@ -281,7 +272,6 @@ files:
 - spec/grape/api/shared_helpers_spec.rb
 - spec/grape/api_remount_spec.rb
 - spec/grape/api_spec.rb
-- spec/grape/config_spec.rb
 - spec/grape/dsl/callbacks_spec.rb
 - spec/grape/dsl/desc_spec.rb
 - spec/grape/dsl/headers_spec.rb
@@ -314,6 +304,7 @@ files:
 - spec/grape/extensions/param_builders/hash_spec.rb
 - spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
 - spec/grape/extensions/param_builders/hashie/mash_spec.rb
+- spec/grape/grape_spec.rb
 - spec/grape/integration/global_namespace_function_spec.rb
 - spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
@@ -354,6 +345,7 @@ files:
 - spec/grape/validations/validators/all_or_none_spec.rb
 - spec/grape/validations/validators/allow_blank_spec.rb
 - spec/grape/validations/validators/at_least_one_of_spec.rb
+- spec/grape/validations/validators/base_spec.rb
 - spec/grape/validations/validators/coerce_spec.rb
 - spec/grape/validations/validators/default_spec.rb
 - spec/grape/validations/validators/exactly_one_of_spec.rb
@@ -368,6 +360,7 @@ files:
 - spec/integration/eager_load/eager_load_spec.rb
 - spec/integration/multi_json/json_spec.rb
 - spec/integration/multi_xml/xml_spec.rb
+- spec/shared/deprecated_class_examples.rb
 - spec/shared/versioning_examples.rb
 - spec/spec_helper.rb
 - spec/support/basic_auth_encode_helpers.rb
@@ -382,10 +375,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.7.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/1.7.1
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.7.1
-post_install_message: 
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.8.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/1.8.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.8.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -400,8 +393,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files:
@@ -410,6 +403,7 @@ test_files:
 - spec/integration/multi_xml/xml_spec.rb
 - spec/integration/multi_json/json_spec.rb
 - spec/shared/versioning_examples.rb
+- spec/shared/deprecated_class_examples.rb
 - spec/support/basic_auth_encode_helpers.rb
 - spec/support/endpoint_faker.rb
 - spec/support/chunks.rb
@@ -431,7 +425,6 @@ test_files:
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/base_spec.rb
-- spec/grape/config_spec.rb
 - spec/grape/loading_spec.rb
 - spec/grape/endpoint_spec.rb
 - spec/grape/api_spec.rb
@@ -482,6 +475,7 @@ test_files:
 - spec/grape/validations/validators/at_least_one_of_spec.rb
 - spec/grape/validations/validators/coerce_spec.rb
 - spec/grape/validations/validators/zh-CN.yml
+- spec/grape/validations/validators/base_spec.rb
 - spec/grape/extensions/param_builders/hashie/mash_spec.rb
 - spec/grape/extensions/param_builders/hash_spec.rb
 - spec/grape/extensions/param_builders/hash_with_indifferent_access_spec.rb
@@ -506,6 +500,7 @@ test_files:
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/optional_parameters_in_route_spec.rb
 - spec/grape/api/documentation_spec.rb
+- spec/grape/grape_spec.rb
 - spec/grape/api_remount_spec.rb
 - spec/grape/named_api_spec.rb
 - spec/grape/dsl/request_response_spec.rb

data/lib/grape/config.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Config
-    class Configuration
-      ATTRIBUTES = %i[
-        param_builder
-      ].freeze
-
-      attr_accessor(*ATTRIBUTES)
-
-      def initialize
-        reset
-      end
-
-      def reset
-        self.param_builder = Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
-      end
-    end
-
-    def self.extended(base)
-      def base.configure
-        block_given? ? yield(config) : config
-      end
-
-      def base.config
-        @configuration ||= Grape::Config::Configuration.new
-      end
-    end
-  end
-end
-
-Grape.extend Grape::Config
-Grape.config.reset

data/lib/grape/extensions/deep_mergeable_hash.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    class DeepMergeableHash < ::Hash
-      def deep_merge!(other_hash)
-        other_hash.each_pair do |current_key, other_value|
-          this_value = self[current_key]
-
-          self[current_key] = if this_value.is_a?(::Hash) && other_value.is_a?(::Hash)
-                                this_value.deep_merge(other_value)
-                              else
-                                other_value
-                              end
-        end
-
-        self
-      end
-    end
-  end
-end

data/lib/grape/extensions/deep_symbolize_hash.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module DeepSymbolizeHash
-      def self.deep_symbolize_keys_in(object)
-        case object
-        when ::Hash
-          object.each_with_object({}) do |(key, value), new_hash|
-            new_hash[symbolize_key(key)] = deep_symbolize_keys_in(value)
-          end
-        when ::Array
-          object.map { |element| deep_symbolize_keys_in(element) }
-        else
-          object
-        end
-      end
-
-      def self.symbolize_key(key)
-        if key.is_a?(Symbol)
-          key
-        elsif key.is_a?(String)
-          key.to_sym
-        elsif key.respond_to?(:to_sym)
-          key.to_sym
-        else
-          key
-        end
-      end
-    end
-  end
-end

data/spec/grape/config_spec.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-describe '.configure' do
-  before do
-    Grape.configure do |config|
-      config.param_builder = 42
-    end
-  end
-
-  after do
-    Grape.config.reset
-  end
-
-  it 'is configured to the new value' do
-    expect(Grape.config.param_builder).to eq 42
-  end
-end