Adds most of the safe todos from RuboCop

grape_logging.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape_logging/version'
 
@@ -8,13 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['aserafin']
   spec.email         = ['adrian@softmad.pl']
 
-  spec.summary       = %q{Out of the box request logging for Grape!}
-  spec.description   = %q{This gem provides simple request logging for Grape with just few lines of code you have to put in your project! In return you will get response codes, paths, parameters and more!}
+  spec.summary       = 'Out of the box request logging for Grape!'
+  spec.description   = 'This gem provides simple request logging for Grape with just few lines of code you have to put in your project! In return you will get response codes, paths, parameters and more!'
   spec.homepage      = 'http://github.com/aserafin/grape_logging'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 

lib/grape_logging/formatters/default.rb

@@ -18,6 +18,7 @@ def format(data)
       end
 
       private
+
       def format_hash(hash)
         hash.keys.sort.map { |key| "#{key}=#{hash[key]}" }.join(' ')
       end

lib/grape_logging/formatters/logstash.rb

@@ -3,9 +3,9 @@ module Formatters
     class Logstash
       def call(severity, datetime, _, data)
         {
-          :'@timestamp' => datetime.iso8601,
-          :'@version' => '1',
-          :severity => severity
+          '@timestamp': datetime.iso8601,
+          '@version': '1',
+          severity: severity
         }.merge!(format(data)).to_json + "\n"
       end
 

lib/grape_logging/formatters/rails.rb

@@ -3,7 +3,6 @@
 module GrapeLogging
   module Formatters
     class Rails
-
       def call(severity, datetime, _, data)
         if data.is_a?(String)
           "#{severity[0..0]} [#{datetime}] #{severity} -- : #{data}\n"
@@ -24,15 +23,15 @@ def format_exception(exception)
         [
           "#{exception.message} (#{exception.class})",
           backtrace_array.join("\n")
-        ].reject{|line| line == ""}.join("\n")
+        ].reject { |line| line == '' }.join("\n")
       end
 
       def format_hash(hash)
         # Create Rails' single summary line at the end of every request, formatted like:
         # Completed 200 OK in 958ms (Views: 951.1ms | ActiveRecord: 3.8ms)
         # See: actionpack/lib/action_controller/log_subscriber.rb
 
-        message = ""
+        message = ''
         additions = []
         status = hash.delete(:status)
         params = hash.delete(:params)
@@ -47,13 +46,12 @@ def format_hash(hash)
         message << "  Parameters: #{params.inspect}\n" if params
 
         message << "Completed #{status} #{::Rack::Utils::HTTP_STATUS_CODES[status]} in #{total_time}ms"
-        message << " (#{additions.join(" | ".freeze)})" if additions.size > 0
+        message << " (#{additions.join(' | '.freeze)})" unless additions.empty?
         message << "\n"
         message << "\n" if defined?(::Rails.env) && ::Rails.env.development?
 
         message
       end
-
     end
   end
 end

lib/grape_logging/loggers/base.rb

@@ -1,7 +1,7 @@
 module GrapeLogging
   module Loggers
     class Base
-      def parameters(request, response)
+      def parameters(_request, _response)
         {}
       end
     end

lib/grape_logging/loggers/client_env.rb

@@ -2,7 +2,7 @@ module GrapeLogging
   module Loggers
     class ClientEnv < GrapeLogging::Loggers::Base
       def parameters(request, _)
-        { ip: request.env["HTTP_X_FORWARDED_FOR"] || request.env["REMOTE_ADDR"], ua: request.env["HTTP_USER_AGENT"] }
+        { ip: request.env['HTTP_X_FORWARDED_FOR'] || request.env['REMOTE_ADDR'], ua: request.env['HTTP_USER_AGENT'] }
       end
     end
   end

lib/grape_logging/loggers/filter_parameters.rb

@@ -3,7 +3,7 @@ module Loggers
     class FilterParameters < GrapeLogging::Loggers::Base
       AD_PARAMS = 'action_dispatch.request.parameters'.freeze
 
-      def initialize(filter_parameters = nil, replacement = nil, exceptions = %w(controller action format))
+      def initialize(filter_parameters = nil, replacement = nil, exceptions = %w[controller action format])
         @filter_parameters = filter_parameters || (defined?(::Rails.application) ? ::Rails.application.config.filter_parameters : [])
         @replacement = replacement || '[FILTERED]'
         @exceptions = exceptions
@@ -30,8 +30,8 @@ def safe_parameters(request)
 
       def clean_parameters(parameters)
         original_encoding_map = build_encoding_map(parameters)
-        params = transform_key_encoding(parameters, Hash.new{ |h, _| [Encoding::ASCII_8BIT, h] })
-        cleaned_params = parameter_filter.filter(params).reject{ |key, _value| @exceptions.include?(key) }
+        params = transform_key_encoding(parameters, Hash.new { |h, _| [Encoding::ASCII_8BIT, h] })
+        cleaned_params = parameter_filter.filter(params).reject { |key, _value| @exceptions.include?(key) }
         transform_key_encoding(cleaned_params, original_encoding_map)
       end
 

lib/grape_logging/loggers/request_headers.rb

@@ -1,7 +1,6 @@
 module GrapeLogging
   module Loggers
     class RequestHeaders < GrapeLogging::Loggers::Base
-
       HTTP_PREFIX = 'HTTP_'.freeze
 
       def parameters(request, _)
@@ -16,7 +15,6 @@ def parameters(request, _)
 
         { headers: headers }
       end
-
     end
   end
 end

lib/grape_logging/loggers/response.rb

@@ -11,12 +11,11 @@ def parameters(_, response)
       # For example, if you POST on a PUT endpoint, response.body is egal to """".
       # It's strange, but it's the Grape behavior...
       def serialized_response_body(response)
-
         if response.respond_to?(:body)
           # Rack responses
           begin
-            response.body.map{ |body| JSON.parse(body.to_s) }
-          rescue # No reason to have "=> e" here when we don't use it..
+            response.body.map { |body| JSON.parse(body.to_s) }
+          rescue StandardError # No reason to have "=> e" here when we don't use it..
             response.body
           end
         else

lib/grape_logging/middleware/request_logger.rb

@@ -3,11 +3,12 @@
 module GrapeLogging
   module Middleware
     class RequestLogger < Grape::Middleware::Base
-
-      ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
-        event = ActiveSupport::Notifications::Event.new(*args)
-        GrapeLogging::Timings.append_db_runtime(event)
-      end if defined?(ActiveRecord)
+      if defined?(ActiveRecord)
+        ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          GrapeLogging::Timings.append_db_runtime(event)
+        end
+      end
 
       # Persist response status & response (body)
       # to use int in parameters
@@ -18,10 +19,10 @@ def initialize(app, options = {})
 
         @included_loggers = @options[:include] || []
         @reporter = if options[:instrumentation_key]
-          Reporters::ActiveSupportReporter.new(@options[:instrumentation_key])
-        else
-          Reporters::LoggerReporter.new(@options[:logger], @options[:formatter], @options[:log_level])
-        end
+                      Reporters::ActiveSupportReporter.new(@options[:instrumentation_key])
+                    else
+                      Reporters::LoggerReporter.new(@options[:logger], @options[:formatter], @options[:log_level])
+                    end
       end
 
       def before

lib/grape_logging/multi_io.rb

@@ -5,11 +5,11 @@ def initialize(*targets)
     end
 
     def write(*args)
-      @targets.each {|t| t.write(*args)}
+      @targets.each { |t| t.write(*args) }
     end
 
     def close
       @targets.each(&:close)
     end
   end
-end
+end

lib/grape_logging/reporters/active_support_reporter.rb

@@ -8,4 +8,4 @@ def perform(params)
       ActiveSupport::Notifications.instrument @instrumentation_key, params
     end
   end
-end
+end

lib/grape_logging/reporters/logger_reporter.rb

@@ -3,9 +3,7 @@ class LoggerReporter
     def initialize(logger, formatter, log_level)
       @logger = logger.clone || Logger.new(STDOUT)
       @log_level = log_level || :info
-      if @logger.respond_to?(:formatter=)
-        @logger.formatter = formatter || @logger.formatter || GrapeLogging::Formatters::Default.new
-      end
+      @logger.formatter = formatter || @logger.formatter || GrapeLogging::Formatters::Default.new if @logger.respond_to?(:formatter=)
     end
 
     def perform(params)

lib/grape_logging/timings.rb

@@ -1,6 +1,6 @@
 module GrapeLogging
   module Timings
-    extend self
+    module_function
 
     def db_runtime=(value)
       Thread.current[:grape_db_runtime] = value
@@ -18,4 +18,4 @@ def append_db_runtime(event)
       self.db_runtime += event.duration
     end
   end
-end
+end

lib/grape_logging/util/parameter_filter.rb

@@ -1,12 +1,12 @@
-if defined?(::Rails.application)
+if defined?(Rails.application)
   if Gem::Version.new(Rails.version) < Gem::Version.new('6.0.0')
     class ParameterFilter < ActionDispatch::Http::ParameterFilter
       def initialize(_replacement, filter_parameters)
         super(filter_parameters)
       end
     end
   else
-    require "active_support/parameter_filter"
+    require 'active_support/parameter_filter'
 
     class ParameterFilter < ActiveSupport::ParameterFilter
       def initialize(_replacement, filter_parameters)
@@ -37,9 +37,11 @@ def compiled_filter
 
     class CompiledFilter # :nodoc:
       def self.compile(replacement, filters)
-        return lambda { |params| params.dup } if filters.empty?
+        return ->(params) { params.dup } if filters.empty?
 
-        strings, regexps, blocks = [], [], []
+        strings = []
+        regexps = []
+        blocks = []
 
         filters.each do |item|
           case item
@@ -52,8 +54,8 @@ def self.compile(replacement, filters)
           end
         end
 
-        deep_regexps, regexps = regexps.partition { |r| r.to_s.include?("\\.".freeze) }
-        deep_strings, strings = strings.partition { |s| s.include?("\\.".freeze) }
+        deep_regexps, regexps = regexps.partition { |r| r.to_s.include?('\\.'.freeze) }
+        deep_strings, strings = strings.partition { |s| s.include?('\\.'.freeze) }
 
         regexps << Regexp.new(strings.join('|'.freeze), true) unless strings.empty?
         deep_regexps << Regexp.new(deep_strings.join('|'.freeze), true) unless deep_strings.empty?
@@ -67,7 +69,7 @@ def initialize(replacement, regexps, deep_regexps, blocks)
         @replacement = replacement
         @regexps = regexps
         @deep_regexps = deep_regexps.any? ? deep_regexps : nil
-        @blocks  = blocks
+        @blocks = blocks
       end
 
       def call(original_params, parents = [])

spec/lib/grape_logging/formatters/rails_spec.rb

@@ -2,23 +2,23 @@
 
 describe GrapeLogging::Formatters::Rails do
   let(:formatter) { described_class.new }
-  let(:severity) { "INFO" }
+  let(:severity) { 'INFO' }
   let(:datetime) { Time.new('2018', '03', '02', '10', '35', '04', '+13:00') }
 
   let(:exception_data) { ArgumentError.new('Message') }
-  let(:hash_data) {
+  let(:hash_data) do
     {
       status: 200,
       time: {
         total: 272.4,
         db: 40.63,
         view: 231.76999999999998
       },
-      method: "GET",
-      path: "/api/endpoint",
-      host: "localhost"
+      method: 'GET',
+      path: '/api/endpoint',
+      host: 'localhost'
     }
-  }
+  end
 
   describe '#call' do
     context 'string data' do
@@ -36,7 +36,7 @@
         message = formatter.call(severity, datetime, nil, exception_data)
         lines = message.split("\n")
 
-        expect(lines[0]).to eq "I [2018-03-02 10:35:04 +1300] INFO -- : Message (ArgumentError)"
+        expect(lines[0]).to eq 'I [2018-03-02 10:35:04 +1300] INFO -- : Message (ArgumentError)'
         expect(lines[1]).to include '.rb'
         expect(lines.size).to be > 1
       end
@@ -52,9 +52,9 @@
       it 'includes params if included (from GrapeLogging::Loggers::FilterParameters)' do
         hash_data.merge!(
           params: {
-            "some_param" => {
-              value_1: "123",
-              value_2: "456"
+            'some_param' => {
+              value_1: '123',
+              value_2: '456'
             }
           }
         )
@@ -63,22 +63,21 @@
         lines = message.split("\n")
 
         expected_output = if RUBY_VERSION >= '3.4'
-          '  Parameters: {"some_param" => {value_1: "123", value_2: "456"}}'
-        else
-          '  Parameters: {"some_param"=>{:value_1=>"123", :value_2=>"456"}}'
-        end
+                            '  Parameters: {"some_param" => {value_1: "123", value_2: "456"}}'
+                          else
+                            '  Parameters: {"some_param"=>{:value_1=>"123", :value_2=>"456"}}'
+                          end
         expect(lines.first).to eq expected_output
-        expect(lines.last).to eq "Completed 200 OK in 272.4ms (Views: 231.77ms | DB: 40.63ms)"
+        expect(lines.last).to eq 'Completed 200 OK in 272.4ms (Views: 231.77ms | DB: 40.63ms)'
       end
     end
 
-    context "unhandled data" do
+    context 'unhandled data' do
       it 'returns the #inspect string representation' do
         message = formatter.call(severity, datetime, nil, [1, 2, 3])
 
         expect(message).to eq "[1, 2, 3]\n"
       end
     end
   end
-
 end