grape 1.2.5 → 1.4.0

data/lib/grape/middleware/globals.rb

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

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.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/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?
@@ -61,7 +63,7 @@ module Grape
 
         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
 

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

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.rb

@@ -1,18 +1,14 @@
+# 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)
-        @pattern = pattern
-        super(attributes)
-      end
-    end
-
     def self.normalize_path(path)
-      path = "/#{path}"
+      path = +"/#{path}"
       path.squeeze!('/')
       path.sub!(%r{/+\Z}, '')
       path = '/' if path == ''
@@ -25,18 +21,20 @@ module Grape
 
     def initialize
       @neutral_map = []
+      @neutral_regexes = []
       @map = Hash.new { |hash, key| hash[key] = [] }
       @optimized_map = Hash.new { |hash, key| hash[key] = // }
     end
 
     def compile!
       return if compiled
-      @union = Regexp.union(@neutral_map.map(&:regexp))
+      @union = Regexp.union(@neutral_regexes)
+      @neutral_regexes = nil
       self.class.supported_methods.each do |method|
         routes = map[method]
         @optimized_map[method] = routes.map.with_index do |route, index|
           route.index = index
-          route.regexp = /(?<_#{index}>#{route.pattern.to_regexp})/
+          Regexp.new("(?<_#{index}>#{route.pattern.to_regexp})")
         end
         @optimized_map[method] = Regexp.union(@optimized_map[method])
       end
@@ -44,12 +42,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)
+      @neutral_regexes << Regexp.new("(?<_#{@neutral_map.length}>)#{pattern.to_regexp}")
+      @neutral_map << Grape::Router::AttributeTranslator.new(options.merge(pattern: pattern, index: @neutral_map.length))
     end
 
     def call(env)
@@ -93,37 +91,34 @@ module Grape
       response = yield(input, method)
 
       return response if response && !(cascade = cascade?(response))
-      neighbor = greedy_match?(input)
+      last_neighbor_route = greedy_match?(input)
 
-      # If neighbor exists and request method is OPTIONS,
+      # If last_neighbor_route exists and request method is OPTIONS,
       # return response by using #call_with_allow_headers.
-      return call_with_allow_headers(
-        env,
-        neighbor.allow_header,
-        neighbor.endpoint
-      ) if neighbor && method == 'OPTIONS' && !cascade
+      return call_with_allow_headers(env, last_neighbor_route) if last_neighbor_route && method == Grape::Http::Headers::OPTIONS && !cascade
 
       route = match?(input, '*')
-      return neighbor.endpoint.call(env) if neighbor && cascade && route
+
+      return last_neighbor_route.endpoint.call(env) if last_neighbor_route && cascade && route
 
       if route
         response = process_route(route, env)
         return response if response && !(cascade = cascade?(response))
       end
 
-      !cascade && neighbor ? call_with_allow_headers(env, neighbor.allow_header, neighbor.endpoint) : nil
+      return call_with_allow_headers(env, last_neighbor_route) if !cascade && last_neighbor_route
+
+      nil
     end
 
     def process_route(route, env)
-      input, = *extract_input_and_method(env)
-      routing_args = env[Grape::Env::GRAPE_ROUTING_ARGS]
-      env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(routing_args, route, input)
+      prepare_env_from_route(env, route)
       route.exec(env)
     end
 
     def make_routing_args(default_args, route, input)
       args = default_args || { route_info: route }
-      args.merge(route.params(input))
+      args.merge(route.params(input) || {})
     end
 
     def extract_input_and_method(env)
@@ -154,9 +149,15 @@ module Grape
       @neutral_map.detect { |route| last_match["_#{route.index}"] }
     end
 
-    def call_with_allow_headers(env, methods, endpoint)
-      env[Grape::Env::GRAPE_ALLOWED_METHODS] = methods
-      endpoint.call(env)
+    def call_with_allow_headers(env, route)
+      prepare_env_from_route(env, route)
+      env[Grape::Env::GRAPE_ALLOWED_METHODS] = route.allow_header.join(', ').freeze
+      route.endpoint.call(env)
+    end
+
+    def prepare_env_from_route(env, route)
+      input, = *extract_input_and_method(env)
+      env[Grape::Env::GRAPE_ROUTING_ARGS] = make_routing_args(env[Grape::Env::GRAPE_ROUTING_ARGS], route, input)
     end
 
     def cascade?(response)

data/lib/grape/router/attribute_translator.rb

@@ -1,32 +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
+      attr_reader :attributes, :request_method, :requirements
+
+      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) # 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