grape 1.6.1 → 1.7.0

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

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
@@ -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,29 @@ 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
-          requires 'first_name', documentation: documentation
+          use :shared_params, type: 'value'
         end
-        subject.get '/' do
+        subject.get '/shared_params' do
+          {
+            param: params[:param]
+          }
         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)
+        expect(last_response.body).to eq({ param: 'value' }.to_json)
       end
     end
 
@@ -1975,4 +1985,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -152,6 +152,7 @@ files:
 - lib/grape/exceptions/missing_mime_type.rb
 - lib/grape/exceptions/missing_option.rb
 - lib/grape/exceptions/missing_vendor_option.rb
+- lib/grape/exceptions/too_many_multipart_files.rb
 - lib/grape/exceptions/unknown_options.rb
 - lib/grape/exceptions/unknown_parameter.rb
 - lib/grape/exceptions/unknown_validator.rb
@@ -218,12 +219,14 @@ files:
 - lib/grape/util/strict_hash_configuration.rb
 - lib/grape/util/xml.rb
 - lib/grape/validations.rb
+- lib/grape/validations/attributes_doc.rb
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/multiple_attributes_iterator.rb
 - lib/grape/validations/params_scope.rb
 - lib/grape/validations/single_attribute_iterator.rb
 - lib/grape/validations/types.rb
 - lib/grape/validations/types/array_coercer.rb
+- lib/grape/validations/types/build_coercer.rb
 - lib/grape/validations/types/custom_type_coercer.rb
 - lib/grape/validations/types/custom_type_collection_coercer.rb
 - lib/grape/validations/types/dry_type_coercer.rb
@@ -254,6 +257,7 @@ files:
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/defines_boolean_in_params_spec.rb
+- spec/grape/api/documentation_spec.rb
 - spec/grape/api/inherited_helpers_spec.rb
 - spec/grape/api/instance_spec.rb
 - spec/grape/api/invalid_format_spec.rb
@@ -293,10 +297,12 @@ files:
 - spec/grape/exceptions/invalid_formatter_spec.rb
 - spec/grape/exceptions/invalid_response_spec.rb
 - spec/grape/exceptions/invalid_versioner_option_spec.rb
+- spec/grape/exceptions/missing_group_type_spec.rb
 - spec/grape/exceptions/missing_mime_type_spec.rb
 - spec/grape/exceptions/missing_option_spec.rb
 - spec/grape/exceptions/unknown_options_spec.rb
 - spec/grape/exceptions/unknown_validator_spec.rb
+- spec/grape/exceptions/unsupported_group_type_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
 - spec/grape/extensions/param_builders/hash_spec.rb
@@ -330,6 +336,7 @@ files:
 - spec/grape/util/reverse_stackable_values_spec.rb
 - spec/grape/util/stackable_values_spec.rb
 - spec/grape/util/strict_hash_configuration_spec.rb
+- spec/grape/validations/attributes_doc_spec.rb
 - spec/grape/validations/attributes_iterator_spec.rb
 - spec/grape/validations/instance_behaivour_spec.rb
 - spec/grape/validations/multiple_attributes_iterator_spec.rb
@@ -361,7 +368,6 @@ files:
 - spec/support/basic_auth_encode_helpers.rb
 - spec/support/chunks.rb
 - spec/support/content_type_helpers.rb
-- spec/support/eager_load.rb
 - spec/support/endpoint_faker.rb
 - spec/support/file_streamer.rb
 - spec/support/integer_helpers.rb
@@ -371,9 +377,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.6.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/1.6.1
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.6.1
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v1.7.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/1.7.0
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v1.7.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -389,7 +395,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
@@ -397,6 +403,7 @@ test_files:
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/defines_boolean_in_params_spec.rb
+- spec/grape/api/documentation_spec.rb
 - spec/grape/api/inherited_helpers_spec.rb
 - spec/grape/api/instance_spec.rb
 - spec/grape/api/invalid_format_spec.rb
@@ -436,10 +443,12 @@ test_files:
 - spec/grape/exceptions/invalid_formatter_spec.rb
 - spec/grape/exceptions/invalid_response_spec.rb
 - spec/grape/exceptions/invalid_versioner_option_spec.rb
+- spec/grape/exceptions/missing_group_type_spec.rb
 - spec/grape/exceptions/missing_mime_type_spec.rb
 - spec/grape/exceptions/missing_option_spec.rb
 - spec/grape/exceptions/unknown_options_spec.rb
 - spec/grape/exceptions/unknown_validator_spec.rb
+- spec/grape/exceptions/unsupported_group_type_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/validation_spec.rb
 - spec/grape/extensions/param_builders/hash_spec.rb
@@ -473,6 +482,7 @@ test_files:
 - spec/grape/util/reverse_stackable_values_spec.rb
 - spec/grape/util/stackable_values_spec.rb
 - spec/grape/util/strict_hash_configuration_spec.rb
+- spec/grape/validations/attributes_doc_spec.rb
 - spec/grape/validations/attributes_iterator_spec.rb
 - spec/grape/validations/instance_behaivour_spec.rb
 - spec/grape/validations/multiple_attributes_iterator_spec.rb
@@ -504,7 +514,6 @@ test_files:
 - spec/support/basic_auth_encode_helpers.rb
 - spec/support/chunks.rb
 - spec/support/content_type_helpers.rb
-- spec/support/eager_load.rb
 - spec/support/endpoint_faker.rb
 - spec/support/file_streamer.rb
 - spec/support/integer_helpers.rb

data/spec/support/eager_load.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# Grape uses autoload https://api.rubyonrails.org/classes/ActiveSupport/Autoload.html.
-# When a class/module get added to the list, ActiveSupport doesn't check whether it really exists.
-# This method loads all classes/modules defined via autoload to be sure only existing
-# classes/modules were listed.
-def eager_load!(scope = Grape)
-  # get modules
-  scope.constants.each do |const_name|
-    const = scope.const_get(const_name)
-
-    next unless const.respond_to?(:eager_load!)
-
-    const.eager_load!
-
-    # check its modules, they might need to be loaded as well.
-    eager_load!(const)
-  end
-end