grape 1.6.2 → 1.7.1

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Types::PrimitiveCoercer do
   subject { described_class.new(type, strict) }
 
@@ -25,13 +23,13 @@ describe Grape::Validations::Types::PrimitiveCoercer do
 
       [true, 'true', 1].each do |val|
         it "coerces '#{val}' to true" do
-          expect(subject.call(val)).to eq(true)
+          expect(subject.call(val)).to be(true)
         end
       end
 
       [false, 'false', 0].each do |val|
         it "coerces '#{val}' to false" do
-          expect(subject.call(val)).to eq(false)
+          expect(subject.call(val)).to be(false)
         end
       end
 
@@ -66,6 +64,10 @@ describe Grape::Validations::Types::PrimitiveCoercer do
       it 'coerces an empty string to nil' do
         expect(subject.call('')).to be_nil
       end
+
+      it 'accepts non-nil value' do
+        expect(subject.call(42)).to be_a(Integer)
+      end
     end
 
     context 'Numeric' do
@@ -74,6 +76,10 @@ describe Grape::Validations::Types::PrimitiveCoercer do
       it 'coerces an empty string to nil' do
         expect(subject.call('')).to be_nil
       end
+
+      it 'accepts a non-nil value' do
+        expect(subject.call(42)).to be_a(Numeric) # in fact Integer
+      end
     end
 
     context 'Time' do
@@ -104,6 +110,15 @@ describe Grape::Validations::Types::PrimitiveCoercer do
       end
     end
 
+    context 'a type unknown in Dry-types' do
+      let(:type) { Complex }
+
+      it 'raises error on init' do
+        expect(DryTypes::Params.constants).not_to include(type.name.to_sym)
+        expect { subject }.to raise_error(/type Complex should support coercion/)
+      end
+    end
+
     context 'the strict mode' do
       let(:strict) { true }
 
@@ -115,7 +130,7 @@ describe Grape::Validations::Types::PrimitiveCoercer do
         end
 
         it 'returns a value as it is when the given value is Boolean' do
-          expect(subject.call(true)).to eq(true)
+          expect(subject.call(true)).to be(true)
         end
       end
 

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Types::SetCoercer do
   subject { described_class.new(type) }
 

data/spec/grape/validations/types_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Types do
   module TypesSpec
     class FooType
@@ -50,6 +48,34 @@ describe Grape::Validations::Types do
     end
   end
 
+  describe 'special types' do
+    subject { described_class::SPECIAL[type] }
+
+    context 'when JSON' do
+      let(:type) { JSON }
+
+      it { is_expected.to eq(Grape::Validations::Types::Json) }
+    end
+
+    context 'when Array[JSON]' do
+      let(:type) { Array[JSON] }
+
+      it { is_expected.to eq(Grape::Validations::Types::JsonArray) }
+    end
+
+    context 'when File' do
+      let(:type) { File }
+
+      it { is_expected.to eq(Grape::Validations::Types::File) }
+    end
+
+    context 'when Rack::Multipart::UploadedFile' do
+      let(:type) { Rack::Multipart::UploadedFile }
+
+      it { is_expected.to eq(Grape::Validations::Types::File) }
+    end
+  end
+
   describe '::custom?' do
     it 'returns false if the type does not respond to :parse' do
       expect(described_class).not_to be_custom(Object)

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::AllOrNoneOfValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::AllowBlankValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::AtLeastOneOfValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::CoerceValidator do
   subject do
     Class.new(Grape::API)

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::DefaultValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::ExactlyOneOfValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::ExceptValuesValidator do
   module ValidationsSpec
     class ExceptValuesModel

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::MutualExclusionValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::PresenceValidator do
   subject do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::RegexpValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::SameAsValidator do
   let_it_be(:app) do
     Class.new(Grape::API) do

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::Validators::ValuesValidator do
   let_it_be(:values_model) do
     Class.new do
@@ -116,6 +114,13 @@ describe Grape::Validations::Validators::ValuesValidator do
         { type: params[:type] }
       end
 
+      params do
+        optional :type, type: Integer, values: 1..
+      end
+      get '/endless' do
+        { type: params[:type] }
+      end
+
       params do
         requires :type, values: ->(v) { ValuesModel.include? v }
       end
@@ -376,6 +381,18 @@ describe Grape::Validations::Validators::ValuesValidator do
     expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
   end
 
+  it 'validates against values in an endless range', if: ActiveSupport::VERSION::MAJOR >= 6 do
+    get('/endless', type: 10)
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to eq({ type: 10 }.to_json)
+  end
+
+  it 'does not allow an invalid value for a parameter using an endless range', if: ActiveSupport::VERSION::MAJOR >= 6 do
+    get('/endless', type: 0)
+    expect(last_response.status).to eq 400
+    expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
+  end
+
   it 'does not allow non-numeric string value for int value using lambda' do
     get('/lambda_int_val', number: 'foo')
     expect(last_response.status).to eq 400

data/spec/grape/validations_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations do
   subject { Class.new(Grape::API) }
 
@@ -45,7 +43,7 @@ describe Grape::Validations do
         subject.params do
           optional :some_param
         end
-        expect(declared_params).to eq([:some_param])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([:some_param])
       end
     end
 
@@ -65,7 +63,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_optional_using
-        expect(declared_params).to eq(%i[field_a field_b])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq(%i[field_a field_b])
       end
 
       it 'works when field_a and field_b are not present' do
@@ -112,7 +110,7 @@ describe Grape::Validations do
         subject.params do
           requires :some_param
         end
-        expect(declared_params).to eq([:some_param])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([:some_param])
       end
 
       it 'works when required field is present but nil' do
@@ -197,7 +195,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_requires_all
-        expect(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])
       end
 
       it 'errors when required_field is not present' do
@@ -232,7 +230,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_requires_none
-        expect(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])
       end
 
       it 'errors when required_field is not present' do
@@ -262,7 +260,7 @@ describe Grape::Validations do
 
         it 'adds only the entity documentation to declared params, nothing more' do
           define_requires_all
-          expect(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])
         end
       end
 
@@ -328,7 +326,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(declared_params).to eq([items: [:key]])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([items: [:key]])
       end
     end
 
@@ -400,7 +398,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(declared_params).to eq([items: [:key]])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([items: [:key]])
       end
     end
 
@@ -463,7 +461,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(declared_params).to eq([items: [:key]])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([items: [:key]])
       end
     end
 
@@ -824,7 +822,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(declared_params).to eq([items: [:key]])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([items: [:key]])
       end
     end
 
@@ -888,7 +886,7 @@ describe Grape::Validations do
             requires(:required_subitems, type: Array) { requires :value }
           end
         end
-        expect(declared_params).to eq([items: [:key, { optional_subitems: [:value] }, { required_subitems: [:value] }]])
+        expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq([items: [:key, { optional_subitems: [:value] }, { required_subitems: [:value] }]])
       end
 
       context <<~DESC do
@@ -1073,12 +1071,12 @@ describe Grape::Validations do
             }
             # 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 contain_exactly(
+              '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
@@ -1428,14 +1426,14 @@ describe Grape::Validations do
           subject.params do
             use :pagination
           end
-          expect(declared_params).to eq %i[page per_page]
+          expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq %i[page per_page]
         end
 
         it 'by #use with multiple params' do
           subject.params do
             use :pagination, :period
           end
-          expect(declared_params).to eq %i[page per_page start_date end_date]
+          expect(Grape::Validations::ParamsScope::Attr.attrs_keys(declared_params)).to eq %i[page per_page start_date end_date]
         end
       end
 
@@ -1485,17 +1483,52 @@ describe Grape::Validations do
       end
     end
 
-    context 'documentation' do
-      it 'can be included with a hash' do
-        documentation = { example: 'Joe' }
+    context 'with block and keyword argument' do
+      before do
+        subject.helpers do
+          params :shared_params do |type:|
+            optional :param, default: type
+          end
+        end
+        subject.format :json
+        subject.params do
+          use :shared_params, type: 'value'
+        end
+        subject.get '/shared_params' do
+          {
+            param: params[:param]
+          }
+        end
+      end
+
+      it 'works' do
+        get '/shared_params'
+
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq({ param: 'value' }.to_json)
+      end
+    end
 
+    context 'with block and empty args' do
+      before do
+        subject.helpers do
+          params :shared_params do |empty_args|
+            optional :param, default: empty_args[:some]
+          end
+        end
+        subject.format :json
         subject.params do
-          requires 'first_name', documentation: documentation
+          use :shared_params
         end
-        subject.get '/' do
+        subject.get '/shared_params' do
+          :ok
         end
+      end
 
-        expect(subject.routes.first.params['first_name'][:documentation]).to eq(documentation)
+      it 'works' do
+        get '/shared_params'
+
+        expect(last_response.status).to eq(200)
       end
     end
 
@@ -1975,4 +2008,22 @@ describe Grape::Validations do
       end
     end
   end
+
+  describe 'require_validator' do
+    subject { described_class.require_validator(short_name) }
+
+    context 'when found' do
+      let(:short_name) { :presence }
+
+      it { is_expected.to be(Grape::Validations::Validators::PresenceValidator) }
+    end
+
+    context 'when not found' do
+      let(:short_name) { :test }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Grape::Exceptions::UnknownValidator)
+      end
+    end
+  end
 end

data/spec/integration/multi_json/json_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Json do
   it 'uses multi_json' do
     expect(described_class).to eq(::MultiJson)

data/spec/integration/multi_xml/xml_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Xml do
   it 'uses multi_xml' do
     expect(described_class).to eq(::MultiXml)

data/spec/spec_helper.rb

@@ -23,8 +23,6 @@ Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each do |file|
   require file
 end
 
-eager_load!
-
 # The default value for this setting is true in a standard Rails app,
 # so it should be set to true here as well to reflect that.
 I18n.enforce_available_locales = true
@@ -43,5 +41,12 @@ RSpec.configure do |config|
   config.example_status_persistence_file_path = '.rspec_status'
 end
 
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+require 'simplecov-lcov'
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.report_with_single_file = true
+  c.single_report_path = 'coverage/lcov.info'
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+SimpleCov.start