Add rubocop with a todo list

.github/workflows/ci.yml

@@ -20,4 +20,17 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - name: Run tests
-        run: bundle exec rspec spec/
+        run: bundle exec rake spec
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run RuboCop
+        run: bundle exec rake rubocop

.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  CountAsOne: [array, hash, heredoc, method_call]
+
+Metrics/ClassLength:
+  CountAsOne: [array, hash, heredoc, method_call]
+
+Metrics/MethodLength:
+  CountAsOne: [array, hash, heredoc, method_call]
+  Max: 20

.rubocop_todo.yml

@@ -0,0 +1,160 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-07-10 10:25:51 UTC using RuboCop version 1.77.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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - "grape_logging.gemspec"
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - "grape_logging.gemspec"
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - "grape_logging.gemspec"
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
+Lint/DuplicateBranch:
+  Exclude:
+    - "lib/grape_logging/util/parameter_filter.rb"
+
+# Offense count: 1
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - "lib/grape_logging/loggers/filter_parameters.rb"
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 38
+
+# Offense count: 8
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 90
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 18
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 19
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - "spec/lib/grape_logging/formatters/rails_spec.rb"
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: MinBranchesCount.
+Style/CaseLikeIf:
+  Exclude:
+    - "lib/grape_logging/formatters/default.rb"
+    - "lib/grape_logging/formatters/logstash.rb"
+    - "lib/grape_logging/formatters/rails.rb"
+
+# Offense count: 17
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 29
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/GlobalStdStream:
+  Exclude:
+    - "lib/grape_logging/reporters/logger_reporter.rb"
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - "lib/grape_logging/version.rb"
+
+# Offense count: 10
+Style/OpenStructUse:
+  Exclude:
+    - "spec/lib/grape_logging/loggers/client_env_spec.rb"
+    - "spec/lib/grape_logging/loggers/filter_parameters_spec.rb"
+    - "spec/lib/grape_logging/loggers/request_headers_spec.rb"
+    - "spec/lib/grape_logging/loggers/response_spec.rb"
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - "lib/grape_logging/formatters/rails.rb"
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/SlicingWithRange:
+  Exclude:
+    - "lib/grape_logging/loggers/request_headers.rb"
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireEnglish, EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - "lib/grape_logging/formatters/json.rb"
+    - "lib/grape_logging/formatters/lograge.rb"
+    - "lib/grape_logging/formatters/logstash.rb"
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments.
+# AllowedMethods: define_method
+Style/SymbolProc:
+  Exclude:
+    - "lib/grape_logging/util/parameter_filter.rb"
+
+# Offense count: 11
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 203

Rakefile

@@ -1,9 +1,17 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['-fd -c']
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'Rakefile', 'Gemfile', 'grape_logging.gemspec']
+end
 
-task default: :spec
+task default: %i[spec rubocop]
 
 desc 'Release gem and create GitHub release'
 task github_release: :release do
@@ -14,9 +22,9 @@ task github_release: :release do
   # Check if gh CLI is available
   unless system('which gh > /dev/null 2>&1')
     puts "\n⚠️  GitHub CLI (gh) not found"
-    puts "To create a GitHub release with auto-generated changelog, install gh:"
-    puts "  brew install gh  # macOS with Homebrew"
-    puts "  # or visit: https://github.com/cli/cli#installation"
+    puts 'To create a GitHub release with auto-generated changelog, install gh:'
+    puts '  brew install gh  # macOS with Homebrew'
+    puts '  # or visit: https://github.com/cli/cli#installation'
     puts "\nYou can manually create the release with:"
     puts "  gh release create v#{GrapeLogging::VERSION} --generate-notes"
     next
@@ -28,8 +36,8 @@ task github_release: :release do
   if system('gh', 'release', 'create', version, '--generate-notes', '--verify-tag')
     puts "✅ GitHub release #{version} created successfully"
   else
-    puts "❌ Failed to create GitHub release"
-    puts "You can manually create it with:"
+    puts '❌ Failed to create GitHub release'
+    puts 'You can manually create it with:'
     puts "  gh release create '#{version}' --generate-notes --verify-tag"
   end
 end

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'
 
@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   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']
 
@@ -25,4 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '~> 13.3'
   spec.add_development_dependency 'rspec', '~> 3.5'
+
+  # This is pinned to an exact version otherwise we can't know which rules
+  # are in play at any given time in different environments.
+  spec.add_development_dependency 'rubocop', '1.77.0'
 end

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