RuboCop Automated Reformatting

Author: reidmorrison

.rubocop.yml

@@ -1,9 +1,10 @@
 AllCops:
-  TargetRubyVersion: 2.4
   Exclude:
-    - '.git/**/*'
-    - '.github/**/*'
-    - 'gemfiles/**/*'
+    - ".git/**/*"
+    - "docs/**/*"
+    - "gemfiles/*"
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
 #
 # RuboCop built-in settings.
@@ -31,7 +32,7 @@ Layout/HashAlignment:
 Layout/LineLength:
   Max: 128
   Exclude:
-    - '**/test/**/*'
+    - "**/test/**/*"
 
 # Match existing layout
 Layout/SpaceInsideHashLiteralBraces:
@@ -44,17 +45,17 @@ Metrics/AbcSize:
 # Support long block lengths for tests
 Metrics/BlockLength:
   Exclude:
-    - 'test/**/*'
-    - '**/*/cli.rb'
-  ExcludedMethods:
-    - 'aasm'
-    - 'included'
+    - "test/**/*"
+    - "**/*/cli.rb"
+  AllowedMethods:
+    - "aasm"
+    - "included"
 
 # Soften limits
 Metrics/ClassLength:
   Max: 250
   Exclude:
-    - 'test/**/*'
+    - "test/**/*"
 
 # TODO: Soften Limits for phase 1 only
 Metrics/CyclomaticComplexity:
@@ -77,15 +78,15 @@ Metrics/PerceivedComplexity:
 
 # Initialization Vector abbreviation
 Naming/MethodParameterName:
-  AllowedNames: ['iv', '_', 'io', 'ap']
+  AllowedNames: [ "iv", "_", "io", "ap", "id", "_id" ]
 
 # Does not allow Symbols to load
 Security/YAMLLoad:
   AutoCorrect: false
 
 # Needed for testing DateTime
 Style/DateTime:
-  Exclude: ['test/**/*']
+  Exclude: [ "test/**/*" ]
 
 # TODO: Soften Limits for phase 1 only
 Style/Documentation:

lib/rails_semantic_logger.rb

@@ -6,21 +6,27 @@ module RailsSemanticLogger
   module ActionController
     autoload :LogSubscriber, "rails_semantic_logger/action_controller/log_subscriber"
   end
+
   module ActionMailer
     autoload :LogSubscriber, "rails_semantic_logger/action_mailer/log_subscriber"
   end
+
   module ActionView
     autoload :LogSubscriber, "rails_semantic_logger/action_view/log_subscriber"
   end
+
   module ActiveJob
     autoload :LogSubscriber, "rails_semantic_logger/active_job/log_subscriber"
   end
+
   module ActiveRecord
     autoload :LogSubscriber, "rails_semantic_logger/active_record/log_subscriber"
   end
+
   module Rack
     autoload :Logger, "rails_semantic_logger/rack/logger"
   end
+
   module DelayedJob
     autoload :Plugin, "rails_semantic_logger/delayed_job/plugin"
   end
@@ -48,9 +54,11 @@ def self.unattach(subscriber)
   end
 
   def self.subscriber_patterns(subscriber)
-    subscriber.patterns.respond_to?(:keys) ?
-      subscriber.patterns.keys :
+    if subscriber.patterns.respond_to?(:keys)
+      subscriber.patterns.keys
+    else
       subscriber.patterns
+    end
   end
 
   private_class_method :subscriber_patterns, :unattach

lib/rails_semantic_logger/action_controller/log_subscriber.rb

@@ -14,10 +14,10 @@ def process_action(event)
 
           # Unused, but needed for Devise 401 status code monkey patch to still work.
           ::ActionController::Base.log_process_action(payload)
-          
+
           params = payload[:params]
 
-          if params.kind_of?(Hash) || params.kind_of?(::ActionController::Parameters)
+          if params.is_a?(Hash) || params.is_a?(::ActionController::Parameters)
             # According to PR https://github.com/reidmorrison/rails_semantic_logger/pull/37/files
             # params is not always a Hash.
             payload[:params] = params.to_unsafe_h unless params.is_a?(Hash)
@@ -79,7 +79,9 @@ def redirect_to(event)
       end
 
       def send_data(event)
-        controller_logger(event).info(message: "Sent data", payload: {file_name: event.payload[:filename]}, duration: event.duration)
+        controller_logger(event).info(message:  "Sent data",
+                                      payload:  {file_name: event.payload[:filename]},
+                                      duration: event.duration)
       end
 
       def unpermitted_parameters(event)

lib/rails_semantic_logger/action_mailer/log_subscriber.rb

@@ -9,22 +9,22 @@ def deliver(event)
         message_id = event.payload[:message_id]
         duration = event.duration.round(1)
         if ex
-          log_with_formatter event: event, log_duration: true, level: :error do |fmt|
+          log_with_formatter event: event, log_duration: true, level: :error do |_fmt|
             {
-              message: "Error delivering mail #{message_id} (#{duration}ms)",
+              message:   "Error delivering mail #{message_id} (#{duration}ms)",
               exception: ex
             }
           end
         else
-          message = begin
+          message =
             if event.payload[:perform_deliveries]
               "Delivered mail #{message_id} (#{duration}ms)"
             else
               "Skipped delivery of mail #{message_id} as `perform_deliveries` is false"
             end
-          end
-          log_with_formatter event: event, log_duration: true do |fmt|
-            { message: message }
+
+          log_with_formatter event: event, log_duration: true do |_fmt|
+            {message: message}
           end
         end
       end
@@ -34,8 +34,8 @@ def process(event)
         mailer   = event.payload[:mailer]
         action   = event.payload[:action]
         duration = event.duration.round(1)
-        log_with_formatter event: event do |fmt|
-          { message: "#{mailer}##{action}: processed outbound mail in #{duration}ms" }
+        log_with_formatter event: event do |_fmt|
+          {message: "#{mailer}##{action}: processed outbound mail in #{duration}ms"}
         end
       end
 
@@ -74,8 +74,6 @@ def date
             event.payload[:date].to_time.utc
           elsif event.payload[:date].is_a?(String)
             Time.parse(date).utc
-          else
-            nil
           end
         end
 
@@ -94,8 +92,8 @@ def action
         def formatted_args
           if defined?(mailer.constantize.log_arguments?) && !mailer.constantize.log_arguments?
             ""
-          else
-            JSON.pretty_generate(event.payload[:args].map { |arg| format(arg) }) if event.payload[:args].present?
+          elsif event.payload[:args].present?
+            JSON.pretty_generate(event.payload[:args].map { |arg| format(arg) })
           end
         end
 

lib/rails_semantic_logger/action_view/log_subscriber.rb

@@ -19,7 +19,7 @@ def initialize
       def render_template(event)
         return unless should_log?
 
-        payload               = {
+        payload = {
           template: from_rails_root(event.payload[:identifier])
         }
         payload[:within]      = from_rails_root(event.payload[:layout]) if event.payload[:layout]
@@ -36,7 +36,7 @@ def render_template(event)
       def render_partial(event)
         return unless should_log?
 
-        payload               = {
+        payload = {
           partial: from_rails_root(event.payload[:identifier])
         }
         payload[:within]      = from_rails_root(event.payload[:layout]) if event.payload[:layout]
@@ -56,7 +56,7 @@ def render_collection(event)
 
         identifier = event.payload[:identifier] || "templates"
 
-        payload               = {
+        payload = {
           template: from_rails_root(identifier),
           count:    event.payload[:count]
         }
@@ -72,9 +72,9 @@ def render_collection(event)
       end
 
       def start(name, id, payload)
-        if (name == "render_template.action_view" || name == "render_layout.action_view") && should_log?
+        if ["render_template.action_view", "render_layout.action_view"].include?(name) && should_log?
           qualifier        = " layout" if name == "render_layout.action_view"
-          payload          = { template: from_rails_root(payload[:identifier]) }
+          payload          = {template: from_rails_root(payload[:identifier])}
           payload[:within] = from_rails_root(payload[:layout]) if payload[:layout]
 
           logger.send(self.class.rendered_log_level, message: "Rendering#{qualifier}", payload: payload)
@@ -84,18 +84,19 @@ def start(name, id, payload)
       end
 
       if (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1) || Rails::VERSION::MAJOR > 7
-        class Start # :nodoc:
-          def start(name, id, payload)
+        class Start
+          def start(name, _id, payload)
             return unless %w[render_template.action_view render_layout.action_view].include?(name)
 
             qualifier        = " layout" if name == "render_layout.action_view"
-            payload          = { template: from_rails_root(payload[:identifier]) }
+            payload          = {template: from_rails_root(payload[:identifier])}
             payload[:within] = from_rails_root(payload[:layout]) if payload[:layout]
 
             logger.debug(message: "Rendering#{qualifier}", payload: payload)
           end
 
-          def finish(name, id, payload) end
+          def finish(name, id, payload)
+          end
 
           private
 
@@ -105,7 +106,7 @@ def from_rails_root(string)
             string
           end
 
-          def rails_root # :doc:
+          def rails_root
             @root ||= "#{Rails.root}/"
           end
 
@@ -117,8 +118,10 @@ def logger
         def self.attach_to(*)
           ActiveSupport::Notifications.unsubscribe("render_template.action_view")
           ActiveSupport::Notifications.unsubscribe("render_layout.action_view")
-          ActiveSupport::Notifications.subscribe("render_template.action_view", RailsSemanticLogger::ActionView::LogSubscriber::Start.new)
-          ActiveSupport::Notifications.subscribe("render_layout.action_view", RailsSemanticLogger::ActionView::LogSubscriber::Start.new)
+          ActiveSupport::Notifications.subscribe("render_template.action_view",
+                                                 RailsSemanticLogger::ActionView::LogSubscriber::Start.new)
+          ActiveSupport::Notifications.subscribe("render_layout.action_view",
+                                                 RailsSemanticLogger::ActionView::LogSubscriber::Start.new)
 
           super
         end

lib/rails_semantic_logger/active_job/log_subscriber.rb

@@ -9,17 +9,17 @@ def enqueue(event)
         if ex
           log_with_formatter level: :error, event: event do |fmt|
             {
-              message: "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
+              message:   "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
               exception: ex
             }
           end
         elsif event.payload[:aborted]
           log_with_formatter level: :info, event: event do |fmt|
-            { message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution." }
+            {message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution."}
           end
         else
           log_with_formatter event: event do |fmt|
-            { message: "Enqueued #{fmt.job_info}" }
+            {message: "Enqueued #{fmt.job_info}"}
           end
         end
       end
@@ -30,13 +30,13 @@ def enqueue_at(event)
         if ex
           log_with_formatter level: :error, event: event do |fmt|
             {
-              message: "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
+              message:   "Failed enqueuing #{fmt.job_info} (#{ex.class} (#{ex.message})",
               exception: ex
             }
           end
         elsif event.payload[:aborted]
           log_with_formatter level: :info, event: event do |fmt|
-            { message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution." }
+            {message: "Failed enqueuing #{fmt.job_info}, a before_enqueue callback halted the enqueuing execution."}
           end
         else
           log_with_formatter event: event do |fmt|
@@ -56,7 +56,7 @@ def perform(event)
         if ex
           log_with_formatter event: event, log_duration: true, level: :error do |fmt|
             {
-              message: "Error performing #{fmt.job_info} in #{event.duration.round(2)}ms",
+              message:   "Error performing #{fmt.job_info} in #{event.duration.round(2)}ms",
               exception: ex
             }
           end

lib/rails_semantic_logger/active_record/log_subscriber.rb

@@ -169,9 +169,7 @@ def render_bind_v5_0_3(attr, value)
       def render_bind_v6_1(attr, value)
         case attr
         when ActiveModel::Attribute
-          if attr.type.binary? && attr.value
-            value = "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>"
-          end
+          value = "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>" if attr.type.binary? && attr.value
         when Array
           attr = attr.first
         else

lib/rails_semantic_logger/engine.rb

@@ -77,7 +77,7 @@ class Engine < ::Rails::Engine
           logger = SemanticLogger[Rails]
           logger.warn(
             "Rails Error: Unable to access log file. Please ensure that #{path} exists and is chmod 0666. " \
-              "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed.",
+            "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed.",
             e
           )
           logger
@@ -111,14 +111,14 @@ class Engine < ::Rails::Engine
       if defined?(Sidekiq)
         if Sidekiq.respond_to?(:logger=)
           Sidekiq.logger = SemanticLogger[Sidekiq]
-        elsif Sidekiq::VERSION[0..1] == '7.'
+        elsif Sidekiq::VERSION[0..1] == "7."
           method = Sidekiq.server? ? :configure_server : :configure_client
           Sidekiq.public_send(method) { |cfg| cfg.logger = SemanticLogger[Sidekiq] }
         end
       end
 
       # Replace the Sidetiq logger
-      Sidetiq.logger       = SemanticLogger[Sidetiq] if defined?(Sidetiq) && Sidetiq.respond_to?(:logger=)
+      Sidetiq.logger = SemanticLogger[Sidetiq] if defined?(Sidetiq) && Sidetiq.respond_to?(:logger=)
 
       # Replace the DelayedJob logger
       if defined?(Delayed::Worker)
@@ -143,7 +143,9 @@ class Engine < ::Rails::Engine
       # Rails Patches
       require("rails_semantic_logger/extensions/action_cable/tagged_logger_proxy") if defined?(::ActionCable)
       require("rails_semantic_logger/extensions/action_controller/live") if defined?(::ActionController::Live)
-      require("rails_semantic_logger/extensions/action_dispatch/debug_exceptions") if defined?(::ActionDispatch::DebugExceptions)
+      if defined?(::ActionDispatch::DebugExceptions)
+        require("rails_semantic_logger/extensions/action_dispatch/debug_exceptions")
+      end
       if defined?(::ActionView::StreamingTemplateRenderer::Body)
         require("rails_semantic_logger/extensions/action_view/streaming_template_renderer")
       end

lib/rails_semantic_logger/extensions/active_support/log_subscriber.rb

@@ -1,4 +1,4 @@
-if ActiveSupport::VERSION::STRING == '7.1.1'
+if ActiveSupport::VERSION::STRING == "7.1.1"
   require "active_support/log_subscriber"
 
   module ActiveSupport

lib/rails_semantic_logger/extensions/active_support/logger.rb

@@ -9,18 +9,18 @@ class << self
       # Prevent broadcasting since SemanticLogger already supports multiple loggers
       if method_defined?(:broadcast)
         undef :broadcast
-        def broadcast(logger)
+        def broadcast(_logger)
           Module.new
         end
       end
     end
 
     # Prevent Console from trying to merge loggers
-    def self.logger_outputs_to?(*args)
+    def self.logger_outputs_to?(*_args)
       true
     end
 
-    def self.new(*args, **kwargs)
+    def self.new(*_args, **_kwargs)
       SemanticLogger[self]
     end
   end