grape 1.2.5 → 1.3.1

data/lib/grape/middleware/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Middleware
     # Common methods for all types of Grape middleware

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
@@ -76,7 +78,8 @@ module Grape
       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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 
 module Grape

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.\-_!#\$&\^]+?)(?:-([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.\-_!#\$&\^]+/.freeze
+        HAS_VERSION_REGEX = /\Avnd\.([a-z0-9.\-_!#\$&\^]+?)(?:-([a-z0-9*.]+))+/.freeze
 
         def before
           strict_header_checks if strict?

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   module Accept
     module Header

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

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

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

data/lib/grape/parser/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Parser
     module Xml

data/lib/grape/parser.rb

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

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
@@ -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?

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,6 +1,10 @@
+# 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
 
@@ -28,14 +32,17 @@ module Grape
     end
 
     def build_headers
-      headers = {}
-      env.each_pair do |k, v|
-        next unless k.to_s.start_with? HTTP_PREFIX
-
-        k = k[5..-1].split('_').each(&:capitalize!).join('-')
-        headers[k] = v
+      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
       end
-      headers
+    end
+
+    def transform_header(header)
+      -header[5..-1].split('_').each(&:capitalize!).join('-')
     end
   end
 end

data/lib/grape/router/attribute_translator.rb

@@ -1,32 +1,42 @@
+# 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
+      attr_reader :attributes, :request_method, :requirements
+
       def initialize(attributes = {})
         @attributes = attributes
+        @request_method = attributes[:request_method]
+        @requirements = attributes[:requirements]
       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) # rubocop:disable Style/MethodMissing
+        if setter?(method_name[-1])
+          attributes[method_name[0..-1]] = *args
         else
-          super
+          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|
+        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

data/lib/grape/router/route.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/router/pattern'
 require 'grape/router/attribute_translator'
 require 'forwardable'
@@ -6,8 +8,8 @@ require 'pathname'
 module Grape
   class Router
     class Route
-      ROUTE_ATTRIBUTE_REGEXP = /route_([_a-zA-Z]\w*)/
-      SOURCE_LOCATION_REGEXP = /^(.*?):(\d+?)(?::in `.+?')?$/
+      ROUTE_ATTRIBUTE_REGEXP = /route_([_a-zA-Z]\w*)/.freeze
+      SOURCE_LOCATION_REGEXP = /^(.*?):(\d+?)(?::in `.+?')?$/.freeze
       FIXED_NAMED_CAPTURES = %w[format version].freeze
 
       attr_accessor :pattern, :translator, :app, :index, :regexp, :options
@@ -62,10 +64,13 @@ module Grape
       end
 
       def initialize(method, pattern, **options)
+        method_s = method.to_s
+        method_upcase = Grape::Http::Headers.find_supported_method(method_s) || method_s.upcase
+
         @suffix     = options[:suffix]
-        @options    = options.merge(method: method.to_s.upcase)
+        @options    = options.merge(method: method_upcase)
         @pattern    = Pattern.new(pattern, **options)
-        @translator = AttributeTranslator.new(**options, request_method: method.to_s.upcase)
+        @translator = AttributeTranslator.new(**options, request_method: method_upcase)
       end
 
       def exec(env)

data/lib/grape/router.rb

@@ -1,22 +1,36 @@
+# frozen_string_literal: true
+
 require 'grape/router/route'
+require 'grape/util/cache'
 
 module Grape
   class Router
     attr_reader :map, :compiled
 
     class Any < AttributeTranslator
-      def initialize(pattern, **attributes)
+      attr_reader :pattern, :regexp, :index
+      def initialize(pattern, regexp, index, **attributes)
         @pattern = pattern
+        @regexp = regexp
+        @index = index
         super(attributes)
       end
     end
 
+    class NormalizePathCache < Grape::Util::Cache
+      def initialize
+        @cache = Hash.new do |h, path|
+          normalized_path = +"/#{path}"
+          normalized_path.squeeze!('/')
+          normalized_path.sub!(%r{/+\Z}, '')
+          normalized_path = '/' if normalized_path.empty?
+          h[path] = -normalized_path
+        end
+      end
+    end
+
     def self.normalize_path(path)
-      path = "/#{path}"
-      path.squeeze!('/')
-      path.sub!(%r{/+\Z}, '')
-      path = '/' if path == ''
-      path
+      NormalizePathCache[path]
     end
 
     def self.supported_methods
@@ -36,7 +50,7 @@ module Grape
         routes = map[method]
         @optimized_map[method] = routes.map.with_index do |route, index|
           route.index = index
-          route.regexp = /(?<_#{index}>#{route.pattern.to_regexp})/
+          route.regexp = Regexp.new("(?<_#{index}>#{route.pattern.to_regexp})")
         end
         @optimized_map[method] = Regexp.union(@optimized_map[method])
       end
@@ -44,12 +58,12 @@ module Grape
     end
 
     def append(route)
-      map[route.request_method.to_s.upcase] << route
+      map[route.request_method] << route
     end
 
     def associate_routes(pattern, **options)
-      regexp = /(?<_#{@neutral_map.length}>)#{pattern.to_regexp}/
-      @neutral_map << Any.new(pattern, regexp: regexp, index: @neutral_map.length, **options)
+      regexp = Regexp.new("(?<_#{@neutral_map.length}>)#{pattern.to_regexp}")
+      @neutral_map << Any.new(pattern, regexp, @neutral_map.length, **options)
     end
 
     def call(env)
@@ -101,7 +115,7 @@ module Grape
         env,
         neighbor.allow_header,
         neighbor.endpoint
-      ) if neighbor && method == 'OPTIONS' && !cascade
+      ) if neighbor && method == Grape::Http::Headers::OPTIONS && !cascade
 
       route = match?(input, '*')
       return neighbor.endpoint.call(env) if neighbor && cascade && route
@@ -155,7 +169,7 @@ module Grape
     end
 
     def call_with_allow_headers(env, methods, endpoint)
-      env[Grape::Env::GRAPE_ALLOWED_METHODS] = methods
+      env[Grape::Env::GRAPE_ALLOWED_METHODS] = methods.join(', ').freeze
       endpoint.call(env)
     end
 

data/lib/grape/serve_file/file_body.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ServeFile
     CHUNK_SIZE = 16_384

data/lib/grape/serve_file/file_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ServeFile
     # A simple class used to identify responses which represent files and do not

data/lib/grape/serve_file/sendfile_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ServeFile
     # Response should respond to to_path method

data/lib/grape/util/base_inheritable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Util
     # Base for classes which need to operate with own values kept
@@ -29,6 +31,10 @@ module Grape
         combined.uniq!
         combined
       end
+
+      def key?(name)
+        inherited_values.key?(name) || new_values.key?(name)
+      end
     end
   end
 end

data/lib/grape/util/cache.rb

@@ -0,0 +1,20 @@
+# frozen_String_literal: true
+
+require 'singleton'
+require 'forwardable'
+
+module Grape
+  module Util
+    class Cache
+      include Singleton
+
+      attr_reader :cache
+
+      class << self
+        extend Forwardable
+        def_delegators :cache, :[]
+        def_delegators :instance, :cache
+      end
+    end
+  end
+end

data/lib/grape/util/endpoint_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Util
     class EndpointConfiguration < LazyValueHash

data/lib/grape/util/env.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 module Grape
   module Env
-    API_VERSION = 'api.version'.freeze
-    API_ENDPOINT = 'api.endpoint'.freeze
-    API_REQUEST_INPUT = 'api.request.input'.freeze
-    API_REQUEST_BODY = 'api.request.body'.freeze
-    API_TYPE = 'api.type'.freeze
-    API_SUBTYPE = 'api.subtype'.freeze
-    API_VENDOR = 'api.vendor'.freeze
-    API_FORMAT = 'api.format'.freeze
+    API_VERSION = 'api.version'
+    API_ENDPOINT = 'api.endpoint'
+    API_REQUEST_INPUT = 'api.request.input'
+    API_REQUEST_BODY = 'api.request.body'
+    API_TYPE = 'api.type'
+    API_SUBTYPE = 'api.subtype'
+    API_VENDOR = 'api.vendor'
+    API_FORMAT = 'api.format'
 
-    RACK_INPUT = 'rack.input'.freeze
-    RACK_REQUEST_QUERY_HASH = 'rack.request.query_hash'.freeze
-    RACK_REQUEST_FORM_HASH = 'rack.request.form_hash'.freeze
-    RACK_REQUEST_FORM_INPUT = 'rack.request.form_input'.freeze
+    RACK_INPUT = 'rack.input'
+    RACK_REQUEST_QUERY_HASH = 'rack.request.query_hash'
+    RACK_REQUEST_FORM_HASH = 'rack.request.form_hash'
+    RACK_REQUEST_FORM_INPUT = 'rack.request.form_input'
 
-    GRAPE_REQUEST = 'grape.request'.freeze
-    GRAPE_REQUEST_HEADERS = 'grape.request.headers'.freeze
-    GRAPE_REQUEST_PARAMS = 'grape.request.params'.freeze
-    GRAPE_ROUTING_ARGS = 'grape.routing_args'.freeze
-    GRAPE_ALLOWED_METHODS = 'grape.allowed_methods'.freeze
+    GRAPE_REQUEST = 'grape.request'
+    GRAPE_REQUEST_HEADERS = 'grape.request.headers'
+    GRAPE_REQUEST_PARAMS = 'grape.request.params'
+    GRAPE_ROUTING_ARGS = 'grape.routing_args'
+    GRAPE_ALLOWED_METHODS = 'grape.allowed_methods'
   end
 end

data/lib/grape/util/inheritable_setting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Util
     # A branchable, inheritable settings object which can store both stackable

data/lib/grape/util/inheritable_values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_inheritable'
 
 module Grape

data/lib/grape/util/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   if Object.const_defined? :MultiJson
     Json = ::MultiJson

data/lib/grape/util/lazy_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Util
     class LazyBlock

data/lib/grape/util/lazy_object.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Based on https://github.com/HornsAndHooves/lazy_object
+
+module Grape
+  module Util
+    class LazyObject < BasicObject
+      attr_reader :callable
+
+      def initialize(&callable)
+        @callable = callable
+      end
+
+      def __target_object__
+        @__target_object__ ||= callable.call
+      end
+
+      def ==(other)
+        __target_object__ == other
+      end
+
+      def !=(other)
+        __target_object__ != other
+      end
+
+      def !
+        !__target_object__
+      end
+
+      def method_missing(method_name, *args, &block)
+        if __target_object__.respond_to?(method_name)
+          __target_object__.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_priv = false)
+        __target_object__.respond_to?(method_name, include_priv)
+      end
+    end
+  end
+end