From 5eea5ab2183619b156476d2e97e6356d5dc2c82b Mon Sep 17 00:00:00 2001 From: Pieter Oliver Date: Tue, 8 Jul 2025 17:17:15 +0100 Subject: [PATCH] AutoFix RuboCop Style/StringLiterals --- .rubocop_todo.yml | 16 --------------- grape_logging.gemspec | 2 +- lib/grape_logging/formatters/rails.rb | 4 ++-- lib/grape_logging/loggers/client_env.rb | 2 +- lib/grape_logging/util/parameter_filter.rb | 6 +++--- .../grape_logging/formatters/rails_spec.rb | 20 +++++++++---------- .../grape_logging/loggers/client_env_spec.rb | 10 +++++----- .../loggers/request_headers_spec.rb | 4 ++-- .../grape_logging/loggers/response_spec.rb | 4 ++-- .../middleware/request_logger_spec.rb | 8 ++++---- 10 files changed, 30 insertions(+), 46 deletions(-) diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index f0c05ae..40fbfbc 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -275,22 +275,6 @@ Style/StringConcatenation: - 'lib/grape_logging/formatters/lograge.rb' - 'lib/grape_logging/formatters/logstash.rb' -# Offense count: 33 -# This cop supports safe autocorrection (--autocorrect). -# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline. -# SupportedStyles: single_quotes, double_quotes -Style/StringLiterals: - Exclude: - - 'grape_logging.gemspec' - - 'lib/grape_logging/formatters/rails.rb' - - 'lib/grape_logging/loggers/client_env.rb' - - 'lib/grape_logging/util/parameter_filter.rb' - - 'spec/lib/grape_logging/formatters/rails_spec.rb' - - 'spec/lib/grape_logging/loggers/client_env_spec.rb' - - 'spec/lib/grape_logging/loggers/request_headers_spec.rb' - - 'spec/lib/grape_logging/loggers/response_spec.rb' - - 'spec/lib/grape_logging/middleware/request_logger_spec.rb' - # Offense count: 1 # This cop supports unsafe autocorrection (--autocorrect-all). # Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments. diff --git a/grape_logging.gemspec b/grape_logging.gemspec index 18b9da0..3090481 100644 --- a/grape_logging.gemspec +++ b/grape_logging.gemspec @@ -14,7 +14,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'] diff --git a/lib/grape_logging/formatters/rails.rb b/lib/grape_logging/formatters/rails.rb index 6d82abc..fdcaab8 100644 --- a/lib/grape_logging/formatters/rails.rb +++ b/lib/grape_logging/formatters/rails.rb @@ -23,7 +23,7 @@ module GrapeLogging [ "#{exception.message} (#{exception.class})", backtrace_array.join("\n") - ].reject { |line| line == "" }.join("\n") + ].reject { |line| line == '' }.join("\n") end def format_hash(hash) @@ -31,7 +31,7 @@ module GrapeLogging # 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) diff --git a/lib/grape_logging/loggers/client_env.rb b/lib/grape_logging/loggers/client_env.rb index b8cd027..9d84dd8 100644 --- a/lib/grape_logging/loggers/client_env.rb +++ b/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 diff --git a/lib/grape_logging/util/parameter_filter.rb b/lib/grape_logging/util/parameter_filter.rb index c840a96..8475c65 100644 --- a/lib/grape_logging/util/parameter_filter.rb +++ b/lib/grape_logging/util/parameter_filter.rb @@ -6,7 +6,7 @@ if defined?(::Rails.application) end end else - require "active_support/parameter_filter" + require 'active_support/parameter_filter' class ParameterFilter < ActiveSupport::ParameterFilter def initialize(_replacement, filter_parameters) @@ -52,8 +52,8 @@ else 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? diff --git a/spec/lib/grape_logging/formatters/rails_spec.rb b/spec/lib/grape_logging/formatters/rails_spec.rb index 3607502..9686881 100644 --- a/spec/lib/grape_logging/formatters/rails_spec.rb +++ b/spec/lib/grape_logging/formatters/rails_spec.rb @@ -2,7 +2,7 @@ require 'spec_helper' 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') } @@ -14,9 +14,9 @@ describe GrapeLogging::Formatters::Rails do db: 40.63, view: 231.76999999999998 }, - method: "GET", - path: "/api/endpoint", - host: "localhost" + method: 'GET', + path: '/api/endpoint', + host: 'localhost' } } @@ -36,7 +36,7 @@ describe GrapeLogging::Formatters::Rails do 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 @@ describe GrapeLogging::Formatters::Rails do 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' } } ) @@ -68,11 +68,11 @@ describe GrapeLogging::Formatters::Rails do ' 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]) diff --git a/spec/lib/grape_logging/loggers/client_env_spec.rb b/spec/lib/grape_logging/loggers/client_env_spec.rb index 2676319..3d490fa 100644 --- a/spec/lib/grape_logging/loggers/client_env_spec.rb +++ b/spec/lib/grape_logging/loggers/client_env_spec.rb @@ -4,13 +4,13 @@ require 'ostruct' describe GrapeLogging::Loggers::ClientEnv do let(:ip) { '10.0.0.1' } let(:user_agent) { 'user agent' } - let(:forwarded_for) { "forwarded for" } - let(:remote_addr) { "remote address" } + let(:forwarded_for) { 'forwarded for' } + let(:remote_addr) { 'remote address' } context 'forwarded for' do let(:mock_request) do OpenStruct.new(env: { - "HTTP_X_FORWARDED_FOR" => forwarded_for + 'HTTP_X_FORWARDED_FOR' => forwarded_for }) end @@ -27,7 +27,7 @@ describe GrapeLogging::Loggers::ClientEnv do context 'remote address' do let(:mock_request) do OpenStruct.new(env: { - "REMOTE_ADDR" => remote_addr + 'REMOTE_ADDR' => remote_addr }) end @@ -39,7 +39,7 @@ describe GrapeLogging::Loggers::ClientEnv do context 'user agent' do let(:mock_request) do OpenStruct.new(env: { - "HTTP_USER_AGENT" => user_agent + 'HTTP_USER_AGENT' => user_agent }) end diff --git a/spec/lib/grape_logging/loggers/request_headers_spec.rb b/spec/lib/grape_logging/loggers/request_headers_spec.rb index 2d00843..b9c02d6 100644 --- a/spec/lib/grape_logging/loggers/request_headers_spec.rb +++ b/spec/lib/grape_logging/loggers/request_headers_spec.rb @@ -9,14 +9,14 @@ describe GrapeLogging::Loggers::RequestHeaders do let(:mock_request_with_unhandled_headers) do OpenStruct.new(env: { HTTP_REFERER: 'http://example.com', - "PATH_INFO" => "/api/v1/users" + 'PATH_INFO' => '/api/v1/users' }) end let(:mock_request_with_long_headers) do OpenStruct.new(env: { HTTP_REFERER: 'http://example.com', - HTTP_USER_AGENT: "Mozilla/5.0" + HTTP_USER_AGENT: 'Mozilla/5.0' }) end diff --git a/spec/lib/grape_logging/loggers/response_spec.rb b/spec/lib/grape_logging/loggers/response_spec.rb index c610b61..d04d91d 100644 --- a/spec/lib/grape_logging/loggers/response_spec.rb +++ b/spec/lib/grape_logging/loggers/response_spec.rb @@ -4,7 +4,7 @@ require 'ostruct' describe GrapeLogging::Loggers::Response do context 'with a parseable JSON body' do let(:response) do - OpenStruct.new(body: [{ "one": "two", "three": { "four": 5 } }]) + OpenStruct.new(body: [{ "one": 'two', "three": { "four": 5 } }]) end it 'returns an array of parsed JSON objects' do @@ -16,7 +16,7 @@ describe GrapeLogging::Loggers::Response do context 'with a body that is not parseable JSON' do let(:response) do - OpenStruct.new(body: "this is a body") + OpenStruct.new(body: 'this is a body') end it 'just returns the body' do diff --git a/spec/lib/grape_logging/middleware/request_logger_spec.rb b/spec/lib/grape_logging/middleware/request_logger_spec.rb index b3876fc..19f767b 100644 --- a/spec/lib/grape_logging/middleware/request_logger_spec.rb +++ b/spec/lib/grape_logging/middleware/request_logger_spec.rb @@ -64,7 +64,7 @@ describe GrapeLogging::Middleware::RequestLogger do options[:include] << GrapeLogging::Loggers::RequestHeaders.new options[:include] << GrapeLogging::Loggers::ClientEnv.new options[:include] << GrapeLogging::Loggers::Response.new - options[:include] << GrapeLogging::Loggers::FilterParameters.new(["replace_me"]) + options[:include] << GrapeLogging::Loggers::FilterParameters.new(['replace_me']) end %w[get put post delete options head patch].each do |the_method| @@ -84,9 +84,9 @@ describe GrapeLogging::Middleware::RequestLogger do it 'should filter parameters in the log' do expect(logger).to receive('info') do |arguments| expect(arguments[:params]).to eq( - "replace_me" => '[FILTERED]', - "replace_me_too" => '[FILTERED]', - "cant_touch_this" => 'should see' + 'replace_me' => '[FILTERED]', + 'replace_me_too' => '[FILTERED]', + 'cant_touch_this' => 'should see' ) end parameters = {