grape 1.1.0 → 1.7.1

data/lib/grape/middleware/stack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Middleware
     # Class to handle the stack of middlewares based on ActionDispatch::MiddlewareStack
@@ -28,6 +30,10 @@ module Grape
         def inspect
           klass.to_s
         end
+
+        def use_in(builder)
+          builder.use(@klass, *@args, &@block)
+        end
       end
 
       include Enumerable
@@ -39,8 +45,8 @@ module Grape
         @others = []
       end
 
-      def each
-        @middlewares.each { |x| yield x }
+      def each(&block)
+        @middlewares.each(&block)
       end
 
       def size
@@ -60,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
 
@@ -67,16 +74,19 @@ 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|
           if args.last.is_a?(Proc)
-            public_send(operation, *args, &args.pop)
+            last_proc = args.pop
+            public_send(operation, *args, &last_proc)
           else
             public_send(operation, *args)
           end
@@ -85,9 +95,9 @@ module Grape
 
       # @return [Rack::Builder] the builder object with our middlewares applied
       def build(builder = Rack::Builder.new)
-        others.shift(others.size).each(&method(:merge_with))
+        others.shift(others.size).each { |m| merge_with(m) }
         middlewares.each do |m|
-          m.block ? builder.use(m.klass, *m.args, &m.block) : builder.use(m.klass, *m.args)
+          m.use_in(builder)
         end
         builder
       end
@@ -96,7 +106,7 @@ module Grape
       # @param [Array] other_specs An array of middleware specifications (e.g. [[:use, klass], [:insert_before, *args]])
       def concat(other_specs)
         @others << Array(other_specs).reject { |o| o.first == :use }
-        merge_with Array(other_specs).select { |o| o.first == :use }
+        merge_with(Array(other_specs).select { |o| o.first == :use })
       end
 
       protected

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 
 module Grape
@@ -20,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?
@@ -49,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 require 'grape/middleware/versioner/parse_media_type_patch'
 
@@ -24,10 +26,10 @@ module Grape
       # route.
       class Header < Base
         VENDOR_VERSION_HEADER_REGEX =
-          /\Avnd\.([a-z0-9.\-_!#\$&\^]+?)(?:-([a-z0-9*.]+))?(?:\+([a-z0-9*\-.]+))?\z/
+          /\Avnd\.([a-z0-9.\-_!#{Regexp.last_match(0)}\^]+?)(?:-([a-z0-9*.]+))?(?:\+([a-z0-9*\-.]+))?\z/.freeze
 
-        HAS_VENDOR_REGEX = /\Avnd\.[a-z0-9.\-_!#\$&\^]+/
-        HAS_VERSION_REGEX = /\Avnd\.([a-z0-9.\-_!#\$&\^]+?)(?:-([a-z0-9*.]+))+/
+        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?
@@ -50,18 +52,20 @@ 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
 
         def an_accept_header_with_version_and_vendor_is_present?
           header.qvalues.keys.any? do |h|
-            VENDOR_VERSION_HEADER_REGEX =~ h.sub('application/', '')
+            VENDOR_VERSION_HEADER_REGEX.match?(h.sub('application/', ''))
           end
         end
 
@@ -99,7 +103,7 @@ module Grape
         def available_media_types
           available_media_types = []
 
-          content_types.each do |extension, _media_type|
+          content_types.each_key do |extension|
             versions.reverse_each do |version|
               available_media_types += [
                 "application/vnd.#{vendor}-#{version}+#{extension}",
@@ -111,7 +115,7 @@ module Grape
 
           available_media_types << "application/vnd.#{vendor}"
 
-          content_types.each do |_, media_type|
+          content_types.each_value do |media_type|
             available_media_types << media_type
           end
 
@@ -158,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
@@ -173,7 +177,7 @@ module Grape
         # @return [Boolean] whether the content type sets a vendor
         def vendor?(media_type)
           _, subtype = Rack::Accept::Header.parse_media_type(media_type)
-          subtype[HAS_VENDOR_REGEX]
+          subtype.present? && subtype[HAS_VENDOR_REGEX]
         end
 
         def request_vendor(media_type)
@@ -190,7 +194,7 @@ module Grape
         # @return [Boolean] whether the content type sets an API version
         def version?(media_type)
           _, subtype = Rack::Accept::Header.parse_media_type(media_type)
-          subtype[HAS_VERSION_REGEX]
+          subtype.present? && subtype[HAS_VERSION_REGEX]
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 
 module Grape
@@ -22,7 +24,7 @@ module Grape
         def default_options
           {
             version_options: {
-              parameter: 'apiver'.freeze
+              parameter: 'apiver'
             }
           }
         end
@@ -30,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,11 +1,15 @@
+# frozen_string_literal: true
+
+require 'English'
 module Rack
   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.to_s.match(%r{^([a-z*]+)\/([a-z0-9*\&\^\-_#\$!.+]+)(?:;([a-z0-9=;]+))?$})
+          m = media_type&.match(ALLOWED_CHARACTERS)
           m ? [m[1], m[2], m[3] || ''] : []
         end
       end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 
 module Grape
@@ -34,7 +36,8 @@ module Grape
 
           pieces = path.split('/')
           potential_version = pieces[1]
-          return unless potential_version =~ options[:pattern]
+          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
@@ -43,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/middleware/versioner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Versioners set env['api.version'] when a version is defined on an API and
 # on the requests. The current methods for determining version are:
 #

data/lib/grape/namespace.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'grape/util/cache'
+
 module Grape
   # A container for endpoints or other namespaces, which allows for both
   # logical grouping of endpoints as well as sharing common configuration.
@@ -23,13 +27,21 @@ module Grape
 
     # (see ::joined_space_path)
     def self.joined_space(settings)
-      (settings || []).map(&:space).join('/')
+      settings&.map(&:space)
     end
 
     # Join the namespaces from a list of settings to create a path prefix.
     # @param settings [Array] list of Grape::Util::InheritableSettings.
     def self.joined_space_path(settings)
-      Grape::Router.normalize_path(joined_space(settings))
+      Grape::Router.normalize_path(JoinedSpaceCache[joined_space(settings)])
+    end
+
+    class JoinedSpaceCache < Grape::Util::Cache
+      def initialize
+        @cache = Hash.new do |h, joined_space|
+          h[joined_space] = -joined_space.join('/')
+        end
+      end
     end
   end
 end

data/lib/grape/parser/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Parser
     module Json
@@ -6,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Parser
     module Xml
@@ -6,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/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Parser
     extend Util::Registrable
@@ -11,8 +13,8 @@ module Grape
         }
       end
 
-      def parsers(options)
-        builtin_parsers.merge(default_elements).merge(options[:parsers] || {})
+      def parsers(**options)
+        builtin_parsers.merge(default_elements).merge!(options[:parsers] || {})
       end
 
       def parser_for(api_format, **options)

data/lib/grape/path.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'grape/util/cache'
+
 module Grape
   # Represents a path to an endpoint.
   class Path
@@ -38,11 +42,11 @@ module Grape
     end
 
     def namespace?
-      namespace && namespace.to_s =~ /^\S/ && namespace != '/'
+      namespace&.match?(/^\S/) && namespace != '/'
     end
 
     def path?
-      raw_path && raw_path.to_s =~ /^\S/ && raw_path != '/'
+      raw_path&.match?(/^\S/) && raw_path != '/'
     end
 
     def suffix
@@ -56,7 +60,7 @@ module Grape
     end
 
     def path
-      Grape::Router.normalize_path(parts.join('/'))
+      Grape::Router.normalize_path(PartsCache[parts])
     end
 
     def path_with_suffix
@@ -69,6 +73,14 @@ module Grape
 
     private
 
+    class PartsCache < Grape::Util::Cache
+      def initialize
+        @cache = Hash.new do |h, parts|
+          h[parts] = -parts.join('/')
+        end
+      end
+    end
+
     def parts
       parts = [mount_path, root_prefix].compact
       parts << ':version' if uses_path_versioning?
@@ -79,6 +91,7 @@ module Grape
 
     def split_setting(key)
       return if settings[key].nil?
+
       settings[key].to_s.split('/')
     end
   end

data/lib/grape/presenters/presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Presenters
     class Presenter

data/lib/grape/request.rb

@@ -1,16 +1,24 @@
+# frozen_string_literal: true
+
+require 'grape/util/lazy_object'
+
 module Grape
   class Request < Rack::Request
-    HTTP_PREFIX = 'HTTP_'.freeze
+    HTTP_PREFIX = 'HTTP_'
 
     alias rack_params params
 
-    def initialize(env, options = {})
-      extend options[:build_params_with] || Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+    def initialize(env, **options)
+      extend options[:build_params_with] || Grape.config.param_builder
       super(env)
     end
 
     def params
       @params ||= build_params
+    rescue EOFError
+      raise Grape::Exceptions::EmptyMessageBody.new(content_type)
+    rescue Rack::Multipart::MultipartPartLimitError
+      raise Grape::Exceptions::TooManyMultipartFiles.new(Rack::Utils.multipart_part_limit)
     end
 
     def headers
@@ -28,14 +36,18 @@ module Grape
     end
 
     def build_headers
-      headers = {}
-      env.each_pair do |k, v|
-        next unless k.to_s.start_with? HTTP_PREFIX
+      Grape::Util::LazyObject.new do
+        env.each_pair.with_object({}) do |(k, v), headers|
+          next unless k.to_s.start_with? HTTP_PREFIX
 
-        k = k[5..-1].split('_').each(&:capitalize!).join('-')
-        headers[k] = v
+          transformed_header = Grape::Http::Headers::HTTP_HEADERS[k] || transform_header(k)
+          headers[transformed_header] = v
+        end
       end
-      headers
+    end
+
+    def transform_header(header)
+      -header[5..].split('_').each(&:capitalize!).join('-')
     end
   end
 end

data/lib/grape/router/attribute_translator.rb

@@ -1,30 +1,63 @@
+# frozen_string_literal: true
+
 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
-      def initialize(attributes = {})
+      attr_reader :attributes
+
+      ROUTE_ATTRIBUTES = %i[
+        prefix
+        version
+        settings
+        format
+        description
+        http_codes
+        headers
+        entity
+        details
+        requirements
+        request_method
+        namespace
+      ].freeze
+
+      ROUTER_ATTRIBUTES = %i[pattern index].freeze
+
+      def initialize(**attributes)
         @attributes = attributes
       end
 
+      (ROUTER_ATTRIBUTES + ROUTE_ATTRIBUTES).each do |attr|
+        define_method attr do
+          attributes[attr]
+        end
+      end
+
       def to_h
-        @attributes
+        attributes
       end
 
-      def method_missing(m, *args)
-        if m[-1] == '='
-          @attributes[m[0..-1]] = *args
-        elsif m[-1] != '='
-          @attributes[m]
+      def method_missing(method_name, *args)
+        if setter?(method_name[-1])
+          attributes[method_name[0..]] = *args
+        else
+          attributes[method_name]
         end
       end
 
       def respond_to_missing?(method_name, _include_private = false)
-        if method_name[-1] == '='
+        if setter?(method_name[-1])
           true
         else
           @attributes.key?(method_name)
         end
       end
+
+      private
+
+      def setter?(method_name)
+        method_name[-1] == '='
+      end
     end
   end
 end

data/lib/grape/router/pattern.rb

@@ -1,34 +1,33 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'mustermann/grape'
+require 'grape/util/cache'
 
 module Grape
   class Router
     class Pattern
-      DEFAULT_PATTERN_OPTIONS   = { uri_decode: true, type: :grape }.freeze
+      DEFAULT_PATTERN_OPTIONS   = { uri_decode: true }.freeze
       DEFAULT_SUPPORTED_CAPTURE = %i[format version].freeze
 
-      attr_reader :origin, :path, :capture, :pattern
+      attr_reader :origin, :path, :pattern, :to_regexp
 
       extend Forwardable
       def_delegators :pattern, :named_captures, :params
-      def_delegators :@regexp, :===
+      def_delegators :to_regexp, :===
       alias match? ===
 
       def initialize(pattern, **options)
         @origin  = pattern
         @path    = build_path(pattern, **options)
-        @capture = extract_capture(options)
-        @pattern = Mustermann.new(@path, pattern_options)
-        @regexp  = to_regexp
-      end
-
-      def to_regexp
-        @to_regexp ||= @pattern.to_regexp
+        @pattern = Mustermann::Grape.new(@path, **pattern_options(options))
+        @to_regexp = @pattern.to_regexp
       end
 
       private
 
-      def pattern_options
+      def pattern_options(options)
+        capture = extract_capture(**options)
         options = DEFAULT_PATTERN_OPTIONS.dup
         options[:capture] = capture if capture.present?
         options
@@ -36,27 +35,32 @@ module Grape
 
       def build_path(pattern, anchor: false, suffix: nil, **_options)
         unless anchor || pattern.end_with?('*path')
+          pattern = +pattern
           pattern << '/' unless pattern.end_with?('/')
           pattern << '*path'
         end
 
-        pattern = pattern.split('/').tap do |parts|
-          parts[parts.length - 1] = '?' + parts.last
+        pattern = -pattern.split('/').tap do |parts|
+          parts[parts.length - 1] = "?#{parts.last}"
         end.join('/') if pattern.end_with?('*path')
 
-        pattern + suffix.to_s
+        PatternCache[[pattern, suffix]]
       end
 
       def extract_capture(requirements: {}, **options)
         requirements = {}.merge(requirements)
-        supported_capture.each_with_object(requirements) do |field, capture|
+        DEFAULT_SUPPORTED_CAPTURE.each_with_object(requirements) do |field, capture|
           option = Array(options[field])
           capture[field] = option.map(&:to_s) if option.present?
         end
       end
 
-      def supported_capture
-        DEFAULT_SUPPORTED_CAPTURE
+      class PatternCache < Grape::Util::Cache
+        def initialize
+          @cache = Hash.new do |h, (pattern, suffix)|
+            h[[pattern, suffix]] = -"#{pattern}#{suffix}"
+          end
+        end
       end
     end
   end