grape 1.2.5 → 1.3.0

data/lib/grape/middleware/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Middleware
     # This is a simple middleware for adding before and after filters

data/lib/grape/middleware/formatter.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 
 module Grape
   module Middleware
     class Formatter < Base
-      CHUNKED = 'chunked'.freeze
+      CHUNKED = 'chunked'
 
       def default_options
         {
@@ -52,7 +54,7 @@ module Grape
 
       def fetch_formatter(headers, options)
         api_format = mime_types[headers[Grape::Http::Headers::CONTENT_TYPE]] || env[Grape::Env::API_FORMAT]
-        Grape::Formatter.formatter_for(api_format, options)
+        Grape::Formatter.formatter_for(api_format, **options)
       end
 
       # Set the content type header for the API format if it is not already present.
@@ -97,7 +99,7 @@ module Grape
         unless content_type_for(fmt)
           throw :error, status: 415, message: "The provided content-type '#{request.media_type}' is not supported."
         end
-        parser = Grape::Parser.parser_for fmt, options
+        parser = Grape::Parser.parser_for fmt, **options
         if parser
           begin
             body = (env[Grape::Env::API_REQUEST_BODY] = parser.call(body, env))

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

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'
 

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

data/lib/grape/namespace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   # A container for endpoints or other namespaces, which allows for both
   # logical grouping of endpoints as well as sharing common configuration.

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,5 @@
+# frozen_string_literal: true
+
 module Grape
   # Represents a path to an endpoint.
   class Path

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,8 @@
+# frozen_string_literal: true
+
 module Grape
   class Request < Rack::Request
-    HTTP_PREFIX = 'HTTP_'.freeze
+    HTTP_PREFIX = 'HTTP_'
 
     alias rack_params params
 

data/lib/grape/router.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/router/route'
 
 module Grape
@@ -5,14 +7,17 @@ module Grape
     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
 
     def self.normalize_path(path)
-      path = "/#{path}"
+      path = +"/#{path}"
       path.squeeze!('/')
       path.sub!(%r{/+\Z}, '')
       path = '/' if path == ''
@@ -36,7 +41,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 +49,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)

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'mustermann/grape'
 
@@ -17,8 +19,8 @@ module Grape
       def initialize(pattern, **options)
         @origin  = pattern
         @path    = build_path(pattern, **options)
-        @capture = extract_capture(options)
-        @pattern = Mustermann.new(@path, pattern_options)
+        @capture = extract_capture(**options)
+        @pattern = Mustermann.new(@path, **pattern_options)
         @regexp  = to_regexp
       end
 
@@ -36,6 +38,7 @@ 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
@@ -44,7 +47,7 @@ module Grape
           parts[parts.length - 1] = '?' + parts.last
         end.join('/') if pattern.end_with?('*path')
 
-        pattern + suffix.to_s
+        "#{pattern}#{suffix}"
       end
 
       def extract_capture(requirements: {}, **options)

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'
@@ -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/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

data/lib/grape/util/content_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ContentTypes
     # Content types are listed in order of preference.

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

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

data/lib/grape/util/registrable.rb

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