grape 1.5.3 → 1.6.0

data/spec/grape/validations/params_scope_spec.rb

@@ -98,6 +98,7 @@ describe Grape::Validations::ParamsScope do
 
         def self.parse(value)
           raise if value == 'invalid'
+
           new(value)
         end
 
@@ -144,7 +145,7 @@ describe Grape::Validations::ParamsScope do
       get '/renaming-coerced', foo: ' there we go '
 
       expect(last_response.status).to eq(200)
-      expect(last_response.body).to eq('there we go-')
+      expect(last_response.body).to eq('-there we go')
     end
 
     it do
@@ -180,6 +181,28 @@ describe Grape::Validations::ParamsScope do
       expect(last_response.status).to eq(200)
       expect(last_response.body).to eq('{"baz":{"qux":"any"}}')
     end
+
+    it 'renaming can be defined before default' do
+      subject.params do
+        optional :foo, as: :bar, default: 'before'
+      end
+      subject.get('/rename-before-default') { declared(params)[:bar] }
+      get '/rename-before-default'
+
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('before')
+    end
+
+    it 'renaming can be defined after default' do
+      subject.params do
+        optional :foo, default: 'after', as: :bar
+      end
+      subject.get('/rename-after-default') { declared(params)[:bar] }
+      get '/rename-after-default'
+
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('after')
+    end
   end
 
   context 'array without coerce type explicitly given' do
@@ -568,7 +591,7 @@ describe Grape::Validations::ParamsScope do
     it 'allows renaming of dependent on parameter' do
       subject.params do
         optional :a, as: :b
-        given b: ->(val) { val == 'x' } do
+        given a: ->(val) { val == 'x' } do
           requires :c
         end
       end
@@ -582,7 +605,7 @@ describe Grape::Validations::ParamsScope do
       expect(last_response.status).to eq 200
     end
 
-    it 'raises an error if the dependent parameter is not the renamed one' do
+    it 'does not raise if the dependent parameter is not the renamed one' do
       expect do
         subject.params do
           optional :a, as: :b
@@ -590,6 +613,17 @@ describe Grape::Validations::ParamsScope do
             requires :c
           end
         end
+      end.not_to raise_error
+    end
+
+    it 'raises an error if the dependent parameter is the renamed one' do
+      expect do
+        subject.params do
+          optional :a, as: :b
+          given :b do
+            requires :c
+          end
+        end
       end.to raise_error(Grape::Exceptions::UnknownParameter)
     end
 

data/spec/grape/validations/single_attribute_iterator_spec.rb

@@ -49,7 +49,7 @@ describe Grape::Validations::SingleAttributeIterator do
         it 'marks params with skipped values' do
           expect { |b| iterator.each(&b) }.to yield_successive_args(
             [params[0], :first, false, true], [params[0], :second, false, true],
-            [params[1], :first, false, false], [params[1], :second, false, false],
+            [params[1], :first, false, false], [params[1], :second, false, false]
           )
         end
       end

data/spec/grape/validations/types/primitive_coercer_spec.rb

@@ -12,7 +12,7 @@ describe Grape::Validations::Types::PrimitiveCoercer do
       let(:type) { BigDecimal }
 
       it 'coerces to BigDecimal' do
-        expect(subject.call(5)).to eq(BigDecimal(5))
+        expect(subject.call(5)).to eq(BigDecimal('5'))
       end
 
       it 'coerces an empty string to nil' do
@@ -127,7 +127,7 @@ describe Grape::Validations::Types::PrimitiveCoercer do
         end
 
         it 'returns a value as it is when the given value is BigDecimal' do
-          expect(subject.call(BigDecimal(0))).to eq(BigDecimal(0))
+          expect(subject.call(BigDecimal('0'))).to eq(BigDecimal('0'))
         end
       end
     end

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

@@ -31,9 +31,9 @@ describe Grape::Validations::CoerceValidator do
 
       it 'i18n error on malformed input' do
         I18n.available_locales = %i[en zh-CN]
-        I18n.load_path << File.expand_path('../zh-CN.yml', __FILE__)
+        I18n.load_path << File.expand_path('zh-CN.yml', __dir__)
         I18n.reload!
-        I18n.locale = 'zh-CN'.to_sym
+        I18n.locale = :'zh-CN'
         subject.params do
           requires :age, type: Integer
         end
@@ -48,7 +48,7 @@ describe Grape::Validations::CoerceValidator do
 
       it 'gives an english fallback error when default locale message is blank' do
         I18n.available_locales = %i[en pt-BR]
-        I18n.locale = 'pt-BR'.to_sym
+        I18n.locale = :'pt-BR'
         subject.params do
           requires :age, type: Integer
         end
@@ -84,9 +84,10 @@ describe Grape::Validations::CoerceValidator do
         before do
           subject.params do
             requires :a, types: { value: [Boolean, String], message: 'type cast is invalid' }, coerce_with: (lambda do |val|
-              if val == 'yup'
+              case val
+              when 'yup'
                 true
-              elsif val == 'false'
+              when 'false'
                 0
               else
                 val
@@ -650,7 +651,7 @@ describe Grape::Validations::CoerceValidator do
 
       it 'parses parameters with Array[Array[String]] type and coerce_with' do
         subject.params do
-          requires :values, type: Array[Array[String]], coerce_with: ->(val) { val.is_a?(String) ? [val.split(/,/).map(&:strip)] : val }
+          requires :values, type: Array[Array[String]], coerce_with: ->(val) { val.is_a?(String) ? [val.split(',').map(&:strip)] : val }
         end
         subject.post '/coerce_nested_strings' do
           params[:values]
@@ -834,9 +835,10 @@ describe Grape::Validations::CoerceValidator do
         before do
           subject.params do
             requires :int, type: Integer, coerce_with: (lambda do |val|
-              if val == '0'
+              case val
+              when '0'
                 nil
-              elsif val.match?(/^-?\d+$/)
+              when /^-?\d+$/
                 val.to_i
               else
                 val
@@ -1201,9 +1203,10 @@ describe Grape::Validations::CoerceValidator do
         before do
           subject.params do
             requires :a, types: [Boolean, String], coerce_with: (lambda do |val|
-              if val == 'yup'
+              case val
+              when 'yup'
                 true
-              elsif val == 'false'
+              when 'false'
                 0
               else
                 val

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

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Grape::Validations::ExceptValuesValidator do
   module ValidationsSpec
     class ExceptValuesModel
-      DEFAULT_EXCEPTS = ['invalid-type1', 'invalid-type2', 'invalid-type3'].freeze
+      DEFAULT_EXCEPTS = %w[invalid-type1 invalid-type2 invalid-type3].freeze
       class << self
         attr_accessor :excepts
 
@@ -170,7 +170,7 @@ describe Grape::Validations::ExceptValuesValidator do
   it 'raises IncompatibleOptionValues when type is incompatible with values array' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, except_values: ['valid-type1', 'valid-type2', 'valid-type3'], type: Symbol }
+      subject.params { optional :type, except_values: %w[valid-type1 valid-type2 valid-type3], type: Symbol }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 

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

@@ -5,8 +5,8 @@ require 'spec_helper'
 describe Grape::Validations::ValuesValidator do
   module ValidationsSpec
     class ValuesModel
-      DEFAULT_VALUES = ['valid-type1', 'valid-type2', 'valid-type3'].freeze
-      DEFAULT_EXCEPTS = ['invalid-type1', 'invalid-type2', 'invalid-type3'].freeze
+      DEFAULT_VALUES = %w[valid-type1 valid-type2 valid-type3].freeze
+      DEFAULT_EXCEPTS = %w[invalid-type1 invalid-type2 invalid-type3].freeze
       class << self
         def values
           @values ||= []
@@ -27,6 +27,10 @@ describe Grape::Validations::ValuesValidator do
           @excepts ||= []
           @excepts << except
         end
+
+        def include?(value)
+          values.include?(value)
+        end
       end
     end
 
@@ -106,7 +110,7 @@ describe Grape::Validations::ValuesValidator do
         end
 
         params do
-          requires :type, values: ->(v) { ValuesModel.values.include? v }
+          requires :type, values: ->(v) { ValuesModel.include? v }
         end
         get '/lambda_val' do
           { type: params[:type] }
@@ -214,14 +218,14 @@ describe Grape::Validations::ValuesValidator do
         put '/optional_with_array_of_string_values'
 
         params do
-          requires :type, values: { proc: ->(v) { ValuesModel.values.include? v } }
+          requires :type, values: { proc: ->(v) { ValuesModel.include? v } }
         end
         get '/proc' do
           { type: params[:type] }
         end
 
         params do
-          requires :type, values: { proc: ->(v) { ValuesModel.values.include? v }, message: 'failed check' }
+          requires :type, values: { proc: ->(v) { ValuesModel.include? v }, message: 'failed check' }
         end
         get '/proc/message'
 
@@ -420,21 +424,21 @@ describe Grape::Validations::ValuesValidator do
   it 'raises IncompatibleOptionValues on an invalid default value from proc' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], default: ValidationsSpec::ValuesModel.values.sample + '_invalid' }
+      subject.params { optional :type, values: %w[valid-type1 valid-type2 valid-type3], default: "#{ValidationsSpec::ValuesModel.values.sample}_invalid" }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
   it 'raises IncompatibleOptionValues on an invalid default value' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], default: 'invalid-type' }
+      subject.params { optional :type, values: %w[valid-type1 valid-type2 valid-type3], default: 'invalid-type' }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
   it 'raises IncompatibleOptionValues when type is incompatible with values array' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], type: Symbol }
+      subject.params { optional :type, values: %w[valid-type1 valid-type2 valid-type3], type: Symbol }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
@@ -648,9 +652,9 @@ describe Grape::Validations::ValuesValidator do
     end
 
     it 'accepts multiple valid values' do
-      get '/proc', type: ['valid-type1', 'valid-type3']
+      get '/proc', type: %w[valid-type1 valid-type3]
       expect(last_response.status).to eq 200
-      expect(last_response.body).to eq({ type: ['valid-type1', 'valid-type3'] }.to_json)
+      expect(last_response.body).to eq({ type: %w[valid-type1 valid-type3] }.to_json)
     end
 
     it 'rejects a single invalid value' do
@@ -660,7 +664,7 @@ describe Grape::Validations::ValuesValidator do
     end
 
     it 'rejects an invalid value among valid ones' do
-      get '/proc', type: ['valid-type1', 'invalid-type1', 'valid-type3']
+      get '/proc', type: %w[valid-type1 invalid-type1 valid-type3]
       expect(last_response.status).to eq 400
       expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
     end

data/spec/grape/validations_spec.rb

@@ -494,6 +494,7 @@ describe Grape::Validations do
           class DateRangeValidator < Grape::Validations::Base
             def validate_param!(attr_name, params)
               return if params[attr_name][:from] <= params[attr_name][:to]
+
               raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: "'from' must be lower or equal to 'to'")
             end
           end
@@ -887,13 +888,13 @@ describe Grape::Validations do
       context <<~DESC do
         Issue occurs whenever:
         * param structure with at least three levels
-        * 1st level item is a required Array that has >1 entry with an optional item present and >1 entry with an optional item missing  
-        * 2nd level is an optional Array or Hash 
+        * 1st level item is a required Array that has >1 entry with an optional item present and >1 entry with an optional item missing#{'  '}
+        * 2nd level is an optional Array or Hash#{' '}
         * 3rd level is a required item (can be any type)
         * additional levels do not effect the issue from occuring
       DESC
 
-        it "example based off actual real world use case" do
+        it 'example based off actual real world use case' do
           subject.params do
             requires :orders, type: Array do
               requires :id, type: Integer
@@ -911,17 +912,17 @@ describe Grape::Validations do
 
           data = {
             orders: [
-              { id: 77, drugs: [{batches: [{batch_no: "A1234567"}]}]},
+              { id: 77, drugs: [{ batches: [{ batch_no: 'A1234567' }] }] },
               { id: 70 }
             ]
           }
 
           get '/validate_required_arrays_under_optional_arrays', data
-          expect(last_response.body).to eq("validate_required_arrays_under_optional_arrays works!")
+          expect(last_response.body).to eq('validate_required_arrays_under_optional_arrays works!')
           expect(last_response.status).to eq(200)
         end
 
-        it "simplest example using Array -> Array -> Hash -> String" do
+        it 'simplest example using Array -> Array -> Hash -> String' do
           subject.params do
             requires :orders, type: Array do
               requires :id, type: Integer
@@ -937,17 +938,17 @@ describe Grape::Validations do
 
           data = {
             orders: [
-              { id: 77, drugs: [{batch_no: "A1234567"}]},
+              { id: 77, drugs: [{ batch_no: 'A1234567' }] },
               { id: 70 }
             ]
           }
 
           get '/validate_required_arrays_under_optional_arrays', data
-          expect(last_response.body).to eq("validate_required_arrays_under_optional_arrays works!")
+          expect(last_response.body).to eq('validate_required_arrays_under_optional_arrays works!')
           expect(last_response.status).to eq(200)
         end
 
-        it "simplest example using Array -> Hash -> String" do
+        it 'simplest example using Array -> Hash -> String' do
           subject.params do
             requires :orders, type: Array do
               requires :id, type: Integer
@@ -963,17 +964,17 @@ describe Grape::Validations do
 
           data = {
             orders: [
-              { id: 77, drugs: {batch_no: "A1234567"}},
+              { id: 77, drugs: { batch_no: 'A1234567' } },
               { id: 70 }
             ]
           }
 
           get '/validate_required_arrays_under_optional_arrays', data
-          expect(last_response.body).to eq("validate_required_arrays_under_optional_arrays works!")
+          expect(last_response.body).to eq('validate_required_arrays_under_optional_arrays works!')
           expect(last_response.status).to eq(200)
         end
 
-        it "correctly indexes invalida data" do
+        it 'correctly indexes invalida data' do
           subject.params do
             requires :orders, type: Array do
               requires :id, type: Integer
@@ -991,16 +992,16 @@ describe Grape::Validations do
           data = {
             orders: [
               { id: 70 },
-              { id: 77, drugs: [{batch_no: "A1234567", quantity: 12}, {batch_no: "B222222"}]}
+              { id: 77, drugs: [{ batch_no: 'A1234567', quantity: 12 }, { batch_no: 'B222222' }] }
             ]
           }
 
           get '/correctly_indexes', data
-          expect(last_response.body).to eq("orders[1][drugs][1][quantity] is missing")
+          expect(last_response.body).to eq('orders[1][drugs][1][quantity] is missing')
           expect(last_response.status).to eq(400)
         end
 
-        context "multiple levels of optional and requires settings" do
+        context 'multiple levels of optional and requires settings' do
           before do
             subject.params do
               requires :top, type: Array do
@@ -1022,53 +1023,62 @@ describe Grape::Validations do
             end
           end
 
-          it "with valid data" do
+          it 'with valid data' do
             data = {
               top: [
                 { top_id: 1, middle_1: [
-                  {middle_1_id: 11}, {middle_1_id: 12, middle_2: [
-                    {middle_2_id: 121}, {middle_2_id: 122, bottom: [{bottom_id: 1221}]}]}]},
+                  { middle_1_id: 11 }, { middle_1_id: 12, middle_2: [
+                    { middle_2_id: 121 }, { middle_2_id: 122, bottom: [{ bottom_id: 1221 }] }
+                  ] }
+                ] },
                 { top_id: 2, middle_1: [
-                  {middle_1_id: 21}, {middle_1_id: 22, middle_2: [
-                  {middle_2_id: 221}]}]},
+                  { middle_1_id: 21 }, { middle_1_id: 22, middle_2: [
+                    { middle_2_id: 221 }
+                  ] }
+                ] },
                 { top_id: 3, middle_1: [
-                  {middle_1_id: 31}, {middle_1_id: 32}]},
+                  { middle_1_id: 31 }, { middle_1_id: 32 }
+                ] },
                 { top_id: 4 }
               ]
             }
 
             get '/multi_level', data
-            expect(last_response.body).to eq("multi_level works!")
+            expect(last_response.body).to eq('multi_level works!')
             expect(last_response.status).to eq(200)
           end
 
-          it "with invalid data" do
+          it 'with invalid data' do
             data = {
               top: [
                 { top_id: 1, middle_1: [
-                  {middle_1_id: 11}, {middle_1_id: 12, middle_2: [
-                  {middle_2_id: 121}, {middle_2_id: 122, bottom: [{bottom_id: nil}]}]}]},
+                  { middle_1_id: 11 }, { middle_1_id: 12, middle_2: [
+                    { middle_2_id: 121 }, { middle_2_id: 122, bottom: [{ bottom_id: nil }] }
+                  ] }
+                ] },
                 { top_id: 2, middle_1: [
-                  {middle_1_id: 21}, {middle_1_id: 22, middle_2: [{middle_2_id: nil}]}]},
+                  { middle_1_id: 21 }, { middle_1_id: 22, middle_2: [{ middle_2_id: nil }] }
+                ] },
                 { top_id: 3, middle_1: [
-                  {middle_1_id: nil}, {middle_1_id: 32}]},
+                  { middle_1_id: nil }, { middle_1_id: 32 }
+                ] },
                 { top_id: nil, missing_top_id: 4 }
               ]
             }
             # debugger
             get '/multi_level', data
-            expect(last_response.body.split(", ")).to match_array([
-              "top[3][top_id] is empty",
-              "top[2][middle_1][0][middle_1_id] is empty",
-              "top[1][middle_1][1][middle_2][0][middle_2_id] is empty",
-              "top[0][middle_1][1][middle_2][1][bottom][0][bottom_id] is empty"
-            ])
+            expect(last_response.body.split(', ')).to match_array([
+                                                                    'top[3][top_id] is empty',
+                                                                    'top[2][middle_1][0][middle_1_id] is empty',
+                                                                    'top[1][middle_1][1][middle_2][0][middle_2_id] is empty',
+                                                                    'top[0][middle_1][1][middle_2][1][bottom][0][bottom_id] is empty'
+                                                                  ])
             expect(last_response.status).to eq(400)
           end
         end
       end
 
-      it "exactly_one_of" do
+      it 'exactly_one_of' do
         subject.params do
           requires :orders, type: Array do
             requires :id, type: Integer
@@ -1086,17 +1096,17 @@ describe Grape::Validations do
 
         data = {
           orders: [
-            { id: 77, drugs: {batch_no: "A1234567"}},
+            { id: 77, drugs: { batch_no: 'A1234567' } },
             { id: 70 }
           ]
         }
 
         get '/exactly_one_of', data
-        expect(last_response.body).to eq("exactly_one_of works!")
+        expect(last_response.body).to eq('exactly_one_of works!')
         expect(last_response.status).to eq(200)
       end
 
-      it "at_least_one_of" do
+      it 'at_least_one_of' do
         subject.params do
           requires :orders, type: Array do
             requires :id, type: Integer
@@ -1114,17 +1124,17 @@ describe Grape::Validations do
 
         data = {
           orders: [
-            { id: 77, drugs: {batch_no: "A1234567"}},
+            { id: 77, drugs: { batch_no: 'A1234567' } },
             { id: 70 }
           ]
         }
 
         get '/at_least_one_of', data
-        expect(last_response.body).to eq("at_least_one_of works!")
+        expect(last_response.body).to eq('at_least_one_of works!')
         expect(last_response.status).to eq(200)
       end
 
-      it "all_or_none_of" do
+      it 'all_or_none_of' do
         subject.params do
           requires :orders, type: Array do
             requires :id, type: Integer
@@ -1142,13 +1152,13 @@ describe Grape::Validations do
 
         data = {
           orders: [
-            { id: 77, drugs: {batch_no: "A1234567", batch_id: "12"}},
+            { id: 77, drugs: { batch_no: 'A1234567', batch_id: '12' } },
             { id: 70 }
           ]
         }
 
         get '/all_or_none_of', data
-        expect(last_response.body).to eq("all_or_none_of works!")
+        expect(last_response.body).to eq('all_or_none_of works!')
         expect(last_response.status).to eq(200)
       end
     end
@@ -1177,6 +1187,7 @@ describe Grape::Validations do
         class Customvalidator < Grape::Validations::Base
           def validate_param!(attr_name, params)
             return if params[attr_name] == 'im custom'
+
             raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: 'is not custom!')
           end
         end
@@ -1325,6 +1336,7 @@ describe Grape::Validations do
           class CustomvalidatorWithOptions < Grape::Validations::Base
             def validate_param!(attr_name, params)
               return if params[attr_name] == @option[:text]
+
               raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message)
             end
           end

data/spec/shared/versioning_examples.rb

@@ -70,7 +70,7 @@ shared_examples_for 'versioning' do
 
         subject.version 'v1', macro_options do
           get 'version' do
-            'version ' + request.env['api.version']
+            "version #{request.env['api.version']}"
           end
         end
 
@@ -94,7 +94,7 @@ shared_examples_for 'versioning' do
 
         subject.version 'v1', macro_options do
           get 'version' do
-            'version ' + request.env['api.version']
+            "version #{request.env['api.version']}"
           end
         end
 

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ require 'rubygems'
 require 'bundler'
 Bundler.require :default, :test
 
-Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each do |file|
   require file
 end
 

data/spec/support/basic_auth_encode_helpers.rb

@@ -4,7 +4,7 @@ module Spec
   module Support
     module Helpers
       def encode_basic_auth(username, password)
-        'Basic ' + Base64.encode64("#{username}:#{password}")
+        "Basic #{Base64.encode64("#{username}:#{password}")}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-07 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -371,9 +371,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.5.3/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/1.5.3
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.5.3
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.6.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/1.6.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.6.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -382,7 +382,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="