grape 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ff753adfdf2428ba49d22317b87ff7a526845e582496dd6f653c8ff04261166
-  data.tar.gz: b62d8ab4c9ac3ca28d62bb2e9afaae54255ed820be17029da35498111ff98cb7
+  metadata.gz: 172d51f08cb655e030afc83ecc06cb13ad5c72c9ad1d6f63d6f87d8b45a52772
+  data.tar.gz: 2d946a6526a7cc848e441fac2d4e0169a0762025d34445307f3945abeeef2b72
 SHA512:
-  metadata.gz: 4501a8f8141b54f83a6e289d0dc9e1128273b92a23a4116f892ef2b47feb03fb852f6787d151a02f553665a5cdb3ac34e440f468ab4901a02c436340bde27f32
-  data.tar.gz: 861d46d98bb44caf203c5e6f919ecf568174a5d915259df983f66310c4c9b118213c62b489c8e498569ea2eebf0a8bf65a0b0888fb4d14e97e408e1f3a12c5fe
+  metadata.gz: eb1ec3cd146f8e4a3f12314159e68177b92548fb7ea3eeac47a425addc3fa04a38c61c566ed3a0655d325bd5d24044b020449aa5702f997d746eef2c5d493928
+  data.tar.gz: 8c44c721a9e0acbb00997ac40ea4b491c4a3c0315e6f4cc1432a2ea5cff102887e028e10df883eba0b50645219918a3fc5a3a66f36068a9d6abc81b29b75c61f

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 2.1.3 (2024-07-13)
+
+#### Fixes
+
+* [#2467](https://github.com/ruby-grape/grape/pull/2467): Fix repo coverage - [@ericproulx](https://github.com/ericproulx).
+* [#2468](https://github.com/ruby-grape/grape/pull/2468): Align `error!` method signatures across different places - [@numbata](https://github.com/numbata).
+* [#2469](https://github.com/ruby-grape/grape/pull/2469): Fix full path building for lateral scopes - [@numbata](https://github.com/numbata).
+
+### 2.1.2 (2024-06-28)
+
+#### Fixes
+
+* [#2459](https://github.com/ruby-grape/grape/pull/2459): Autocorrect cops - [@ericproulx](https://github.com/ericproulx).
+* [#3458](https://github.com/ruby-grape/grape/pull/2458): Remove unused Grape::Util::Accept::Header - [@ericproulx](https://github.com/ericproulx).
+* [#2463](https://github.com/ruby-grape/grape/pull/2463): Fix error message indices - [@ericproulx](https://github.com/ericproulx).
+
 ### 2.1.1 (2024-06-22)
 
 #### Features

data/README.md

@@ -157,7 +157,7 @@ Grape is a REST-like API framework for Ruby. It's designed to run on Rack or com
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, **2.1.1**.
+You're reading the documentation for the stable release of Grape, **2.1.3**.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources

data/lib/grape/api/instance.rb

@@ -46,7 +46,7 @@ module Grape
         # Parses the API's definition and compiles it into an instance of
         # Grape::API.
         def compile
-          @instance ||= new
+          @instance ||= new # rubocop:disable Naming/MemoizedInstanceVariableName
         end
 
         # Wipe the compiled API so we can recompile after changes were made.

data/lib/grape/api.rb

@@ -32,7 +32,7 @@ module Grape
       def inherited(api)
         super
 
-        api.initial_setup(Grape::API == self ? Grape::API::Instance : @base_instance)
+        api.initial_setup(self == Grape::API ? Grape::API::Instance : @base_instance)
         api.override_all_methods!
       end
 
@@ -108,7 +108,7 @@ module Grape
       end
 
       def respond_to?(method, include_private = false)
-        super(method, include_private) || base_instance.respond_to?(method, include_private)
+        super || base_instance.respond_to?(method, include_private)
       end
 
       def respond_to_missing?(method, include_private = false)

data/lib/grape/dsl/inside_route.rb

@@ -163,12 +163,14 @@ module Grape
       # end user with the specified message.
       #
       # @param message [String] The message to display.
-      # @param status [Integer] the HTTP Status Code. Defaults to default_error_status, 500 if not set.
+      # @param status [Integer] The HTTP Status Code. Defaults to default_error_status, 500 if not set.
       # @param additional_headers [Hash] Addtional headers for the response.
-      def error!(message, status = nil, additional_headers = nil)
+      # @param backtrace [Array<String>] The backtrace of the exception that caused the error.
+      # @param original_exception [Exception] The original exception that caused the error.
+      def error!(message, status = nil, additional_headers = nil, backtrace = nil, original_exception = nil)
         status = self.status(status || namespace_inheritable(:default_error_status))
         headers = additional_headers.present? ? header.merge(additional_headers) : header
-        throw :error, message: message, status: status, headers: headers
+        throw :error, message: message, status: status, headers: headers, backtrace: backtrace, original_exception: original_exception
       end
 
       # Creates a Rack response based on the provided message, status, and headers.

data/lib/grape/dsl/parameters.rb

@@ -231,7 +231,7 @@ module Grape
 
       alias group requires
 
-      class EmptyOptionalValue; end
+      class EmptyOptionalValue; end # rubocop:disable Lint/EmptyClass
 
       def map_params(params, element, is_array = false)
         if params.is_a?(Array)

data/lib/grape/endpoint.rb

@@ -231,8 +231,8 @@ module Grape
       options[:app].endpoints if options[:app].respond_to?(:endpoints)
     end
 
-    def equals?(e)
-      (options == e.options) && (inheritable_setting.to_hash == e.inheritable_setting.to_hash)
+    def equals?(endpoint)
+      (options == endpoint.options) && (inheritable_setting.to_hash == endpoint.inheritable_setting.to_hash)
     end
 
     protected

data/lib/grape/exceptions/validation_errors.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class ValidationErrors < Grape::Exceptions::Base
       ERRORS_FORMAT_KEY = 'grape.errors.format'
-      DEFAULT_ERRORS_FORMAT = '%{attributes} %{message}'
+      DEFAULT_ERRORS_FORMAT = '%<attributes>s %<message>s'
 
       include Enumerable
 

data/lib/grape/middleware/base.rb

@@ -74,7 +74,7 @@ module Grape
       end
 
       def mime_types
-        @mime_type ||= content_types.each_pair.with_object({}) do |(k, v), types_without_params|
+        @mime_types ||= content_types.each_pair.with_object({}) do |(k, v), types_without_params|
           types_without_params[v.split(';').first] = k
         end
       end

data/lib/grape/middleware/error.rb

@@ -74,8 +74,8 @@ module Grape
         rack_response(status, headers, format_message(message, backtrace, original_exception))
       end
 
-      def default_rescue_handler(e)
-        error_response(message: e.message, backtrace: e.backtrace, original_exception: e)
+      def default_rescue_handler(exception)
+        error_response(message: exception.message, backtrace: exception.backtrace, original_exception: exception)
       end
 
       def rescue_handler_for_base_only_class(klass)

data/lib/grape/middleware/stack.rb

@@ -57,8 +57,8 @@ module Grape
         middlewares.last
       end
 
-      def [](i)
-        middlewares[i]
+      def [](index)
+        middlewares[index]
       end
 
       def insert(index, *args, &block)

data/lib/grape/validations/attributes_iterator.rb

@@ -21,6 +21,7 @@ module Grape
       private
 
       def do_each(params_to_process, parent_indicies = [], &block)
+        @scope.reset_index # gets updated depending on the size of params_to_process
         params_to_process.each_with_index do |resource_params, index|
           # when we get arrays of arrays it means that target element located inside array
           # we need this because we want to know parent arrays indicies

data/lib/grape/validations/params_scope.rb

@@ -93,9 +93,7 @@ module Grape
 
       def meets_dependency?(params, request_params)
         return true unless @dependent_on
-
         return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)
-
         return params.any? { |param| meets_dependency?(param, request_params) } if params.is_a?(Array)
 
         meets_hash_dependency?(params)
@@ -103,7 +101,6 @@ module Grape
 
       def attr_meets_dependency?(params)
         return true unless @dependent_on
-
         return false if @parent.present? && !@parent.attr_meets_dependency?(params)
 
         meets_hash_dependency?(params)
@@ -169,6 +166,10 @@ module Grape
         !@optional
       end
 
+      def reset_index
+        @index = nil
+      end
+
       protected
 
       # Adds a parameter declaration to our list of validations.
@@ -189,7 +190,13 @@ module Grape
       #
       # @return [Array<Symbol>] the nesting/path of the current parameter scope
       def full_path
-        nested? ? @parent.full_path + [@element] : []
+        if nested?
+          (@parent.full_path + [@element])
+        elsif lateral?
+          @parent.full_path
+        else
+          []
+        end
       end
 
       private
@@ -297,12 +304,7 @@ module Grape
       #   `optional` invocation that opened this scope.
       # @yield parameter scope
       def new_group_scope(attrs, &block)
-        self.class.new(
-          api: @api,
-          parent: self,
-          group: attrs.first,
-          &block
-        )
+        self.class.new(api: @api, parent: self, group: attrs.first, &block)
       end
 
       # Pushes declared params to parent or settings

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

@@ -7,7 +7,7 @@ module Grape
         def validate_params!(params)
           keys = keys_in_common(params)
           return if keys.length == 1
-          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one)) if keys.length.zero?
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:exactly_one)) if keys.empty?
 
           raise Grape::Exceptions::Validation.new(params: keys, message: message(:mutual_exclusion))
         end

data/lib/grape/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-22 00:00:00.000000000 Z
+date: 2024-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -189,7 +189,6 @@ files:
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
 - lib/grape/types/invalid_value.rb
-- lib/grape/util/accept/header.rb
 - lib/grape/util/accept_header_handler.rb
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
@@ -252,9 +251,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.1.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.1.1
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.1.1
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.1.3/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/2.1.3
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.1.3
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/grape/util/accept/header.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Util
-    module Accept
-      module Header
-        ALLOWED_CHARACTERS = %r{^([a-z*]+)/([a-z0-9*&\^\-_#{$ERROR_INFO}.+]+)(?:;([a-z0-9=;]+))?$}.freeze
-        class << self
-          # Corrected version of https://github.com/mjackson/rack-accept/blob/master/lib/rack/accept/header.rb#L40-L44
-          def parse_media_type(media_type)
-            # see http://tools.ietf.org/html/rfc6838#section-4.2 for allowed characters in media type names
-            m = media_type&.match(ALLOWED_CHARACTERS)
-            m ? [m[1], m[2], m[3] || ''] : []
-          end
-        end
-      end
-    end
-  end
-end