Merge feaf8dc into 090326e

.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.3
   Include:
     - Dangerfile
     - gemfiles/*.gemfile

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-12-20 21:38:24 +0000 using RuboCop version 0.51.0.
+# on 2019-10-27 10:47:06 -0400 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -26,16 +26,22 @@ Lint/RescueWithoutErrorClass:
   Exclude:
     - 'lib/grape/validations/validators/coerce.rb'
 
-# Offense count: 47
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/UnneededRequireStatement:
+  Exclude:
+    - 'lib/grape.rb'
+
+# Offense count: 48
 Metrics/AbcSize:
   Max: 44
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Max: 182
 
-# Offense count: 9
+# Offense count: 10
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 302
@@ -44,23 +50,23 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 1234
+# Offense count: 1287
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 215
 
-# Offense count: 57
+# Offense count: 59
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 34
+  Max: 33
 
 # Offense count: 12
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
   Max: 220
 
-# Offense count: 21
+# Offense count: 22
 Metrics/PerceivedComplexity:
   Max: 14
 
@@ -79,3 +85,29 @@ Naming/FileName:
 # SupportedStyles: annotated, template
 Style/FormatStringToken:
   EnforcedStyle: template
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/grape/middleware/formatter.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil.
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/grape/api/instance.rb'
+    - 'lib/grape/dsl/desc.rb'
+    - 'lib/grape/dsl/helpers.rb'
+    - 'lib/grape/dsl/inside_route.rb'
+    - 'lib/grape/dsl/routing.rb'
+    - 'lib/grape/endpoint.rb'
+    - 'lib/grape/middleware/error.rb'
+    - 'lib/grape/middleware/versioner/accept_version_header.rb'
+    - 'lib/grape/middleware/versioner/header.rb'
+    - 'lib/grape/middleware/versioner/param.rb'
+    - 'lib/grape/middleware/versioner/path.rb'

Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails-5' do
   gem 'rails', '5.2.1'
 end

CHANGELOG.md

@@ -8,6 +8,7 @@
 * [#1904](https://github.com/ruby-grape/grape/pull/1904): Allows Grape to load files on startup rather than on the first call - [@myxoh](https://github.com/myxoh).
 * [#1907](https://github.com/ruby-grape/grape/pull/1907): Adds outside configuration to Grape with `configure` - [@unleashy](https://github.com/unleashy).
 * [#1914](https://github.com/ruby-grape/grape/pull/1914): Run specs in random order - [@splattael](https://github.com/splattael).
+* [#1790](https://github.com/ruby-grape/grape/pull/1790): Added frozen_string_literal - [@ericproulx](https://github.com/ericproulx).
 
 #### Fixes
 

Dangerfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')
 toc.check

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # when changing this file, run appraisal install ; rubocop -a gemfiles/*.gemfile
 
 source 'https://rubygems.org'

Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 guard :rspec, all_on_start: true, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 Bundler.setup :default, :test, :development

benchmark/nested_params.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape'
 require 'benchmark/ips'
 

benchmark/simple.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'grape'
 require 'benchmark/ips'

benchmark/simple_with_type_coercer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'grape'
 require 'benchmark/ips'

gemfiles/multi_json.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'

gemfiles/multi_xml.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'

gemfiles/rack_edge.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'

gemfiles/rails_5.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'

gemfiles/rails_edge.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source 'https://rubygems.org'

grape.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'grape/version'
 

lib/grape.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'rack'
 require 'rack/builder'

lib/grape/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/router'
 require 'grape/api/instance'
 

lib/grape/api/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class API
     module Helpers

lib/grape/api/instance.rb

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

lib/grape/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Config
     class Configuration

lib/grape/cookies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Cookies
     def initialize

lib/grape/dsl/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/desc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module DSL
     module Desc

lib/grape/dsl/headers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module DSL
     module Headers

lib/grape/dsl/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/inside_route.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 require 'grape/dsl/headers'
 

lib/grape/dsl/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module DSL
     module Logger

lib/grape/dsl/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/request_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/routing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/dsl/validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

lib/grape/eager_load.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Grape.eager_load!
 Grape::Http.eager_load!
 Grape::Exceptions.eager_load!

lib/grape/endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   # An Endpoint is the proxy scope in which all routing
   # blocks are executed. In other words, any methods

lib/grape/error_formatter.rb

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

lib/grape/error_formatter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Base

lib/grape/error_formatter/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Json

lib/grape/error_formatter/txt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Txt

lib/grape/error_formatter/xml.rb

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

lib/grape/exceptions/base.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class Base < StandardError
-      BASE_MESSAGES_KEY = 'grape.errors.messages'.freeze
-      BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'.freeze
+      BASE_MESSAGES_KEY = 'grape.errors.messages'
+      BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'
       FALLBACK_LOCALE = :en
 
       attr_reader :status, :message, :headers
@@ -28,9 +30,8 @@ def compose_message(key, **attributes)
           @problem = problem(key, **attributes)
           @summary = summary(key, **attributes)
           @resolution = resolution(key, **attributes)
-          [['Problem', @problem], ['Summary', @summary], ['Resolution', @resolution]].reduce('') do |message, detail_array|
-            message << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
-            message
+          [['Problem', @problem], ['Summary', @summary], ['Resolution', @resolution]].each_with_object(+'') do |detail_array, final_message|
+            final_message << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
           end
         else
           short_message

lib/grape/exceptions/incompatible_option_values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class IncompatibleOptionValues < Base

lib/grape/exceptions/invalid_accept_header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidAcceptHeader < Base

lib/grape/exceptions/invalid_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidFormatter < Base