log_method 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaf9e766e7cd25359757ba13ccb52a0f21452c835025dde17e58a2ec1591c311
-  data.tar.gz: ec61724f38c1f35ce76747cd5f3b9f21c0f775b76e4bfd43bcf76d8cf01c9318
+  metadata.gz: dd51e1c0b040a4cc45e4d687d5d856f2e7bccec8b3abc9a7805d7e8eb3e5488e
+  data.tar.gz: 0bf8d484eb418695b4b3ce546bda78bb033124b0e9c950714cb14f90c6217815
 SHA512:
-  metadata.gz: b6d1a643280ce11e2502d364da9d15c1f9032eb0b7ed81f8c70cc2431fe1113a9a8c05447e1590e308271705ea3db5a5d847982281e4e9a6c99caae06a3abe73
-  data.tar.gz: cca740859bfed322dc5762b7190b743bdcff095f12d82a9541c9e27544243a4c90295b5d16f5f0116cf68d09dd17a3e393a25c530240329b54cc9c2c020d9769
+  metadata.gz: 3c3eb39b6bdce35dc03780555480f9e2e7ac33b0c1464b35ee0e1ba6f79ea7805cd19fee8e618b4a4b8ca044e4f82029ef943d2e13c61d10deaa77e2b04d94c4
+  data.tar.gz: 74ceee8774b9f583dc0df50b341f4aa1f363672c3ad605e318ff736319e84b6375a164ceeceedbcd27e2e8f8dbf4ace63b5c3d23a1c6273107f314a57466454b

data/README.md

@@ -100,7 +100,7 @@ LogMethod.config do |c|
   c.external_identifier_method = :external_id
   c.current_actor_proc = ->() { PaperTrail.request.whodunnit }
   c.current_actor_id_label = "user_id"
-  c.after_log_proc = ->(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id) {
+  c.after_log_proc = ->(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id, log_message) {
     Bugsnag.leave_breadcrumb method_name.to_s[0..29], {
       class: class_thats_logging_name,
       object_id: object_id,
@@ -115,13 +115,14 @@ end
 
 ### Options
 
-* `after_log_proc` This is a proc/lambda to be called after each log message has been sent to `Rails.logger.info`.  In the example above, we're using this to send a breadcrumb to Bugsnag so that if there is an error with this request, we can see what log messages were logged for that request.  It will be given these arguments:
+* `after_log_proc` This is a proc/lambda to be called after each log message has been sent to `Rails.logger.info`.  In the example above, we're using this to send a breadcrumb to Bugsnag so that if there is an error with this request, we can see what log messages were logged for that request.  It will be given these arguments and it must accept and require all 7 or none will be passed:
    - `class_thats_logging_name` - The class where `log` was called
    - `method_name` - The method name passed to `log`
    - `object_id` - The id of the object passed to `log`, if it had one
    - `object_class_name` - The class name of the object passed to log, if one was passed
    - `trace_id` - The trace id returned by `trace_id_proc`, or `nil` if that isn't configured.
    - `current_actor_id` - The value returned by; `current_actor_proc`, or `nil` if that isn't configured.
+   - `log_message` - the log message passed to `log`
 * `current_actor_id_label` - If a current actor is logged, this is the label that will precede it in the logs
 * `current_actor_proc` - Called to retrieve an identifier of the current actor executing the code, such as the current user.
 * `external_identifier_method` - If you are using external ids on your objects, this is the name of that method. If an object is passed in that responds to this method, it will be used instead of `id` when creating the log message.

data/lib/log_method/bugsnag_after_log.rb

@@ -1,5 +1,5 @@
 class LogMethod::BugsnagAfterLog
-  def self.call(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id)
+  def self.call(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id, _log_message)
     Bugsnag.leave_breadcrumb method_name.to_s[0..29], {
       class: class_thats_logging_name,
       object_id: object_id,

data/lib/log_method/log.rb

@@ -8,29 +8,44 @@ module LogMethod::Log
     trace_id         = LogMethod.config.trace_id_proc.()
     current_actor_id = LogMethod.config.current_actor_proc.()
 
-    message = if message.nil?
-                message_or_object
-              else
-                object_id,object_class = if !logging_external_identifier_method.nil? &&
-                                            message_or_object.respond_to?(logging_external_identifier_method)
+    object_identifier_phrase = ""
 
-                                           [message_or_object.send(logging_external_identifier_method), message_or_object.class]
+    if message.nil?
+      message = message_or_object
+    else
+      object_id,object_class = if !logging_external_identifier_method.nil? &&
+                                   message_or_object.respond_to?(logging_external_identifier_method)
 
-                                         elsif message_or_object.kind_of?(ActiveRecord::Base)
+                                 [message_or_object.send(logging_external_identifier_method), message_or_object.class]
 
-                                           [message_or_object.id, message_or_object.class]
+                               elsif message_or_object.kind_of?(ActiveRecord::Base)
 
-                                         else
+                                 [message_or_object.id, message_or_object.class]
 
-                                           [message_or_object.inspect, message_or_object.class]
+                               else
 
-                                         end
-                "[#{object_class}/#{object_id}]: #{message}"
-              end
+                                 [message_or_object.inspect, message_or_object.class]
 
-    Rails.logger.info("[#{self.class}##{method}](via LogMethod::Log)#{format_trace_id(trace_id)}#{format_current_actor_id(current_actor_id)}: #{message}")
+                               end
+      object_identifier_phrase = "[#{object_class}/#{object_id}]: "
+    end
 
-    LogMethod.config.after_log_proc.(self.class.name, method, object_id, object_class&.name, trace_id, current_actor_id)
+    Rails.logger.info("[#{self.class}##{method}](via LogMethod::Log)#{format_trace_id(trace_id)}#{format_current_actor_id(current_actor_id)}: #{object_identifier_phrase}#{message}")
+
+    all_args = [self.class.name, method, object_id, object_class&.name, trace_id, current_actor_id, message]
+
+    after_log_proc = LogMethod.config.after_log_proc
+    arity = if after_log_proc.kind_of?(Proc)
+              after_log_proc.arity
+            elsif after_log_proc.respond_to?(:call)
+              after_log_proc.method(:call).arity
+            end
+    args_for_arity = if arity <= 0
+                       []
+                     else
+                       all_args[0..(arity-1)]
+                     end
+    after_log_proc.(*args_for_arity)
   end
 
 private

data/lib/log_method/version.rb

@@ -1,3 +1,3 @@
 module LogMethod
-  VERSION="1.0.0"
+  VERSION="1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_method
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dave Copeland
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - davec@naildrivin5.com
 executables: []
@@ -73,7 +73,7 @@ metadata:
   homepage_uri: https://github.com/sustainable-rails/log_method
   source_code_uri: https://github.com/sustainable-rails/log_method
   changelog_uri: https://github.com/sustainable-rails/log_method/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.29
+signing_key:
 specification_version: 4
 summary: A nice log method for your Rails app that provides a ton of useful context
   in each message!