grape 1.5.0 → 1.6.0

data/lib/grape/middleware/formatter.rb

@@ -22,6 +22,7 @@ module Grape
 
       def after
         return unless @app_response
+
         status, headers, bodies = *@app_response
 
         if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.include?(status)
@@ -79,7 +80,7 @@ module Grape
           (request.post? || request.put? || request.patch? || request.delete?) &&
           (!request.form_data? || !request.media_type) &&
           !request.parseable_data? &&
-          (request.content_length.to_i > 0 || request.env[Grape::Http::Headers::HTTP_TRANSFER_ENCODING] == CHUNKED)
+          (request.content_length.to_i.positive? || request.env[Grape::Http::Headers::HTTP_TRANSFER_ENCODING] == CHUNKED)
 
         return unless (input = env[Grape::Env::RACK_INPUT])
 
@@ -96,9 +97,7 @@ module Grape
       def read_rack_input(body)
         fmt = request.media_type ? mime_types[request.media_type] : options[:default_format]
 
-        unless content_type_for(fmt)
-          throw :error, status: 415, message: "The provided content-type '#{request.media_type}' is not supported."
-        end
+        throw :error, status: 415, message: "The provided content-type '#{request.media_type}' is not supported." unless content_type_for(fmt)
         parser = Grape::Parser.parser_for fmt, **options
         if parser
           begin
@@ -145,6 +144,7 @@ module Grape
         fmt = Rack::Utils.parse_nested_query(env[Grape::Http::Headers::QUERY_STRING])[Grape::Http::Headers::FORMAT]
         # avoid symbol memory leak on an unknown format
         return fmt.to_sym if content_type_for(fmt)
+
         fmt
       end
 

data/lib/grape/middleware/stack.rb

@@ -6,12 +6,11 @@ module Grape
     # It allows to insert and insert after
     class Stack
       class Middleware
-        attr_reader :args, :opts, :block, :klass
+        attr_reader :args, :block, :klass
 
-        def initialize(klass, *args, **opts, &block)
+        def initialize(klass, *args, &block)
           @klass = klass
-          @args  = args
-          @opts  = opts
+          @args = args
           @block = block
         end
 
@@ -32,16 +31,8 @@ module Grape
           klass.to_s
         end
 
-        if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
-          def use_in(builder)
-            block ? builder.use(klass, *args, **opts, &block) : builder.use(klass, *args, **opts)
-          end
-        else
-          def use_in(builder)
-            args  = self.args
-            args += [opts] unless opts.empty?
-            block ? builder.use(klass, *args, &block) : builder.use(klass, *args)
-          end
+        def use_in(builder)
+          builder.use(@klass, *@args, &@block)
         end
       end
 
@@ -54,8 +45,8 @@ module Grape
         @others = []
       end
 
-      def each
-        @middlewares.each { |x| yield x }
+      def each(&block)
+        @middlewares.each(&block)
       end
 
       def size
@@ -75,6 +66,7 @@ module Grape
         middleware = self.class::Middleware.new(*args, &block)
         middlewares.insert(index, middleware)
       end
+      ruby2_keywords :insert if respond_to?(:ruby2_keywords, true)
 
       alias insert_before insert
 
@@ -82,11 +74,13 @@ module Grape
         index = assert_index(index, :after)
         insert(index + 1, *args, &block)
       end
+      ruby2_keywords :insert_after if respond_to?(:ruby2_keywords, true)
 
       def use(*args, &block)
         middleware = self.class::Middleware.new(*args, &block)
         middlewares.push(middleware)
       end
+      ruby2_keywords :use if respond_to?(:ruby2_keywords, true)
 
       def merge_with(middleware_specs)
         middleware_specs.each do |operation, *args|

data/lib/grape/middleware/versioner/accept_version_header.rb

@@ -22,11 +22,9 @@ module Grape
         def before
           potential_version = (env[Grape::Http::Headers::HTTP_ACCEPT_VERSION] || '').strip
 
-          if strict?
+          if strict? && potential_version.empty?
             # If no Accept-Version header:
-            if potential_version.empty?
-              throw :error, status: 406, headers: error_headers, message: 'Accept-Version header must be set.'
-            end
+            throw :error, status: 406, headers: error_headers, message: 'Accept-Version header must be set.'
           end
 
           return if potential_version.empty?
@@ -51,7 +49,7 @@ module Grape
         # of routes (see Grape::Router) for more information). To prevent
         # this behavior, and not add the `X-Cascade` header, one can set the `:cascade` option to `false`.
         def cascade?
-          if options[:version_options] && options[:version_options].key?(:cascade)
+          if options[:version_options]&.key?(:cascade)
             options[:version_options][:cascade]
           else
             true

data/lib/grape/middleware/versioner/header.rb

@@ -26,10 +26,10 @@ module Grape
       # route.
       class Header < Base
         VENDOR_VERSION_HEADER_REGEX =
-          /\Avnd\.([a-z0-9.\-_!#\$&\^]+?)(?:-([a-z0-9*.]+))?(?:\+([a-z0-9*\-.]+))?\z/.freeze
+          /\Avnd\.([a-z0-9.\-_!#{Regexp.last_match(0)}\^]+?)(?:-([a-z0-9*.]+))?(?:\+([a-z0-9*\-.]+))?\z/.freeze
 
-        HAS_VENDOR_REGEX = /\Avnd\.[a-z0-9.\-_!#\$&\^]+/.freeze
-        HAS_VERSION_REGEX = /\Avnd\.([a-z0-9.\-_!#\$&\^]+?)(?:-([a-z0-9*.]+))+/.freeze
+        HAS_VENDOR_REGEX = /\Avnd\.[a-z0-9.\-_!#{Regexp.last_match(0)}\^]+/.freeze
+        HAS_VERSION_REGEX = /\Avnd\.([a-z0-9.\-_!#{Regexp.last_match(0)}\^]+?)(?:-([a-z0-9*.]+))+/.freeze
 
         def before
           strict_header_checks if strict?
@@ -52,12 +52,14 @@ module Grape
 
         def strict_accept_header_presence_check
           return unless header.qvalues.empty?
+
           fail_with_invalid_accept_header!('Accept header must be set.')
         end
 
         def strict_version_vendor_accept_header_presence_check
           return unless versions.present?
           return if an_accept_header_with_version_and_vendor_is_present?
+
           fail_with_invalid_accept_header!('API vendor or version not found.')
         end
 
@@ -160,7 +162,7 @@ module Grape
         # information). To prevent # this behavior, and not add the `X-Cascade`
         # header, one can set the `:cascade` option to `false`.
         def cascade?
-          if version_options && version_options.key?(:cascade)
+          if version_options&.key?(:cascade)
             version_options[:cascade]
           else
             true

data/lib/grape/middleware/versioner/param.rb

@@ -32,6 +32,7 @@ module Grape
         def before
           potential_version = Rack::Utils.parse_nested_query(env[Grape::Http::Headers::QUERY_STRING])[paramkey]
           return if potential_version.nil?
+
           throw :error, status: 404, message: '404 API Version Not Found', headers: { Grape::Http::Headers::X_CASCADE => 'pass' } if options[:versions] && !options[:versions].find { |v| v.to_s == potential_version }
           env[Grape::Env::API_VERSION] = potential_version
           env[Grape::Env::RACK_REQUEST_QUERY_HASH].delete(paramkey) if env.key? Grape::Env::RACK_REQUEST_QUERY_HASH

data/lib/grape/middleware/versioner/parse_media_type_patch.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+require 'English'
 module Rack
   module Accept
     module Header
-      ALLOWED_CHARACTERS = %r{^([a-z*]+)\/([a-z0-9*\&\^\-_#\$!.+]+)(?:;([a-z0-9=;]+))?$}.freeze
+      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)

data/lib/grape/middleware/versioner/path.rb

@@ -37,6 +37,7 @@ module Grape
           pieces = path.split('/')
           potential_version = pieces[1]
           return unless potential_version&.match?(options[:pattern])
+
           throw :error, status: 404, message: '404 API Version Not Found' if options[:versions] && !options[:versions].find { |v| v.to_s == potential_version }
           env[Grape::Env::API_VERSION] = potential_version
         end
@@ -45,6 +46,7 @@ module Grape
 
         def mounted_path?(path)
           return false unless mount_path && path.start_with?(mount_path)
+
           rest = path.slice(mount_path.length..-1)
           rest.start_with?('/') || rest.empty?
         end

data/lib/grape/parser/json.rb

@@ -8,7 +8,7 @@ module Grape
           ::Grape::Json.load(object)
         rescue ::Grape::Json::ParseError
           # handle JSON parsing errors via the rescue handlers or provide error message
-          raise Grape::Exceptions::InvalidMessageBody, 'application/json'
+          raise Grape::Exceptions::InvalidMessageBody.new('application/json')
         end
       end
     end

data/lib/grape/parser/xml.rb

@@ -8,7 +8,7 @@ module Grape
           ::Grape::Xml.parse(object)
         rescue ::Grape::Xml::ParseError
           # handle XML parsing errors via the rescue handlers or provide error message
-          raise Grape::Exceptions::InvalidMessageBody, 'application/xml'
+          raise Grape::Exceptions::InvalidMessageBody.new('application/xml')
         end
       end
     end

data/lib/grape/path.rb

@@ -91,6 +91,7 @@ module Grape
 
     def split_setting(key)
       return if settings[key].nil?
+
       settings[key].to_s.split('/')
     end
   end

data/lib/grape/request.rb

@@ -15,6 +15,8 @@ module Grape
 
     def params
       @params ||= build_params
+    rescue EOFError
+      raise Grape::Exceptions::EmptyMessageBody.new(content_type)
     end
 
     def headers
@@ -35,6 +37,7 @@ module Grape
       Grape::Util::LazyObject.new do
         env.each_pair.with_object({}) do |(k, v), headers|
           next unless k.to_s.start_with? HTTP_PREFIX
+
           transformed_header = Grape::Http::Headers::HTTP_HEADERS[k] || transform_header(k)
           headers[transformed_header] = v
         end

data/lib/grape/router/attribute_translator.rb

@@ -4,7 +4,7 @@ module Grape
   class Router
     # this could be an OpenStruct, but doesn't work in Ruby 2.3.0, see https://bugs.ruby-lang.org/issues/12251
     class AttributeTranslator
-      attr_reader :attributes, :request_method, :requirements
+      attr_reader :attributes
 
       ROUTE_ATTRIBUTES = %i[
         prefix

data/lib/grape/router/pattern.rb

@@ -41,7 +41,7 @@ module Grape
         end
 
         pattern = -pattern.split('/').tap do |parts|
-          parts[parts.length - 1] = '?' + parts.last
+          parts[parts.length - 1] = "?#{parts.last}"
         end.join('/') if pattern.end_with?('*path')
 
         PatternCache[[pattern, suffix]]

data/lib/grape/router/route.rb

@@ -84,8 +84,8 @@ module Grape
         path, line = *location.scan(SOURCE_LOCATION_REGEXP).first
         path = File.realpath(path) if Pathname.new(path).relative?
         expected ||= name
-        warn <<-WARNING
-#{path}:#{line}: The route_xxx methods such as route_#{name} have been deprecated, please use #{expected}.
+        warn <<~WARNING
+          #{path}:#{line}: The route_xxx methods such as route_#{name} have been deprecated, please use #{expected}.
         WARNING
       end
     end

data/lib/grape/router.rb

@@ -28,6 +28,7 @@ module Grape
 
     def compile!
       return if compiled
+
       @union = Regexp.union(@neutral_regexes)
       @neutral_regexes = nil
       self.class.supported_methods.each do |method|
@@ -60,6 +61,7 @@ module Grape
     def recognize_path(input)
       any = with_optimization { greedy_match?(input) }
       return if any == default_response
+
       any.endpoint
     end
 
@@ -80,6 +82,7 @@ module Grape
       map[method].each do |route|
         next if exact_route == route
         next unless route.match?(input)
+
         response = process_route(route, env)
         break unless cascade?(response)
       end
@@ -91,6 +94,7 @@ module Grape
       response = yield(input, method)
 
       return response if response && !(cascade = cascade?(response))
+
       last_neighbor_route = greedy_match?(input)
 
       # If last_neighbor_route exists and request method is OPTIONS,
@@ -139,12 +143,14 @@ module Grape
     def match?(input, method)
       current_regexp = @optimized_map[method]
       return unless current_regexp.match(input)
+
       last_match = Regexp.last_match
       @map[method].detect { |route| last_match["_#{route.index}"] }
     end
 
     def greedy_match?(input)
       return unless @union.match(input)
+
       last_match = Regexp.last_match
       @neutral_map.detect { |route| last_match["_#{route.index}"] }
     end

data/lib/grape/util/inheritable_setting.rb

@@ -5,9 +5,7 @@ module Grape
     # A branchable, inheritable settings object which can store both stackable
     # and inheritable values (see InheritableValues and StackableValues).
     class InheritableSetting
-      attr_accessor :route, :api_class, :namespace
-      attr_accessor :namespace_inheritable, :namespace_stackable, :namespace_reverse_stackable
-      attr_accessor :parent, :point_in_time_copies
+      attr_accessor :route, :api_class, :namespace, :namespace_inheritable, :namespace_stackable, :namespace_reverse_stackable, :parent, :point_in_time_copies
 
       # Retrieve global settings.
       def self.global

data/lib/grape/util/lazy_value.rb

@@ -49,9 +49,10 @@ module Grape
       end
 
       def []=(key, value)
-        @value_hash[key] = if value.is_a?(Hash)
+        @value_hash[key] = case value
+                           when Hash
                              LazyValueHash.new(value)
-                           elsif value.is_a?(Array)
+                           when Array
                              LazyValueArray.new(value)
                            else
                              LazyValue.new(value)

data/lib/grape/validations/attributes_iterator.rb

@@ -48,6 +48,14 @@ module Grape
       def yield_attributes(_resource_params, _attrs)
         raise NotImplementedError
       end
+
+      # This is a special case so that we can ignore tree's where option
+      # values are missing lower down. Unfortunately we can remove this
+      # are the parameter parsing stage as they are required to ensure
+      # the correct indexing is maintained
+      def skip?(val)
+        val == Grape::DSL::Parameters::EmptyOptionalValue
+      end
     end
   end
 end

data/lib/grape/validations/multiple_attributes_iterator.rb

@@ -6,7 +6,7 @@ module Grape
       private
 
       def yield_attributes(resource_params, _attrs)
-        yield resource_params
+        yield resource_params, skip?(resource_params)
       end
     end
   end