debug_logging 3.1.1 → 3.1.7

data/debug_logging.gemspec

@@ -7,7 +7,7 @@ require 'debug_logging/version'
 Gem::Specification.new do |spec|
   spec.name          = 'debug_logging'
   spec.version       = DebugLogging::VERSION
-  spec.authors       = ['Peter Boling']
+  spec.authors       = ['Peter Boling', 'guckin']
   spec.email         = ['peter.boling@gmail.com']
 
   spec.summary       = 'Drop-in debug logging useful when a call stack gets unruly'
@@ -33,7 +33,10 @@ Automatically log selected methods and their arguments as they are called at run
   spec.add_development_dependency 'rake', '>= 13'
   spec.add_development_dependency 'rspec', '>= 3'
   spec.add_development_dependency 'rspec-pending_for', '>= 0'
-  spec.add_development_dependency 'rubocop', '>= 0.92'
-  spec.add_development_dependency 'rubocop-rspec', '>= 1'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-md'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0'
   spec.add_development_dependency 'silent_stream', '>= 1'
 end

data/lib/debug_logging.rb

@@ -4,9 +4,14 @@ require 'logger'
 require 'colorized_string'
 require 'digest'
 
+require 'debug_logging/constants'
 require 'debug_logging/version'
+require 'debug_logging/errors'
 require 'debug_logging/configuration'
+require 'debug_logging/util'
+require 'debug_logging/finalize'
 require 'debug_logging/argument_printer'
+require 'debug_logging/hooks'
 require 'debug_logging/instance_logger_modulizer'
 require 'debug_logging/instance_logger'
 require 'debug_logging/class_logger'
@@ -60,26 +65,17 @@ require 'debug_logging/class_logger'
 module DebugLogging
   def self.extended(base)
     base.send(:extend, ArgumentPrinter)
+    base.send(:extend, ApiClassMethods)
+    base.send(:extend, ConfigClassMethods)
     base.debug_config_reset(Configuration.new(**debug_logging_configuration.to_hash))
+    base.class_eval do
+      def base.inherited(subclass)
+        subclass.debug_config_reset(Configuration.new(**debug_config.to_hash))
+      end
+    end
   end
 
   #### API ####
-  # Not used by this gem internally, but provides an external interface for
-  #   classes to also use this logging tool directly,
-  #   with configured options like benchmarking, colors, or leg level.
-  def debug_log(message = nil, config_proxy = nil, &block)
-    # If a, instance-method-level, or class-method-level custom config is not
-    #   passed in, then fall back to the class' default config, which is a
-    #   potentially customized copy of the default config for the whole app.
-    config_proxy ||= debug_config
-    config_proxy.log(message, &block)
-  end
-
-  # There are times when the class will need access to the configuration object,
-  #   such as to override it per instance method
-  def debug_config
-    @debug_logging_configuration
-  end
 
   # For single statement global config in an initializer
   # e.g. DebugLogging.configuration.ellipsis = "..."
@@ -92,130 +88,187 @@ module DebugLogging
     yield(configuration)
   end
 
-  # For per-class config with a block
-  def debug_logging_configure
-    @debug_logging_configuration ||= Configuration.new
-    yield(@debug_logging_configuration)
+  module ApiClassMethods
+    # Not used by this gem internally, but provides an external interface for
+    #   classes to also use this logging tool directly,
+    #   with configured options like benchmarking, colors, or leg level.
+    def debug_log(message = nil, config_proxy = nil, &block)
+      # If a, instance-method-level, or class-method-level custom config is not
+      #   passed in, then fall back to the class' default config, which is a
+      #   potentially customized copy of the default config for the whole app.
+      config_proxy ||= debug_config
+      config_proxy.log(message, &block)
+    end
+
+    # There are times when the class will need access to the configuration object,
+    #   such as to override it per instance method
+    def debug_config
+      @debug_logging_configuration
+    end
   end
 
   #### CONFIG ####
   class << self
     attr_accessor :debug_logging_configuration
   end
-  def debug_config_reset(config = Configuration.new)
-    @debug_logging_configuration = config
-  end
 
-  def debug_enabled
-    @debug_logging_configuration.enabled
-  end
+  module ConfigClassMethods
+    include Constants
 
-  def debug_enabled=(value)
-    @debug_logging_configuration.enabled = value
-  end
+    # For per-class config with a block
+    def debug_logging_configure
+      @debug_logging_configuration ||= Configuration.new
+      yield(@debug_logging_configuration)
+    end
 
-  def debug_logger
-    @debug_logging_configuration.logger
-  end
+    def debug_config_reset(config = Configuration.new)
+      @debug_logging_configuration = config
+    end
 
-  def debug_logger=(logger)
-    @debug_logging_configuration.logger = logger
-  end
+    def debug_enabled
+      @debug_logging_configuration.enabled
+    end
 
-  def debug_log_level
-    @debug_logging_configuration.log_level
-  end
+    def debug_enabled=(value)
+      @debug_logging_configuration.enabled = value
+    end
 
-  def debug_log_level=(log_level)
-    @debug_logging_configuration.log_level = log_level
-  end
+    def debug_logger
+      @debug_logging_configuration.logger
+    end
 
-  def debug_multiple_last_hashes
-    @debug_logging_configuration.multiple_last_hashes
-  end
+    def debug_logger=(logger)
+      @debug_logging_configuration.logger = logger
+    end
 
-  def debug_multiple_last_hashes=(multiple_last_hashes)
-    @debug_logging_configuration.multiple_last_hashes = multiple_last_hashes
-  end
+    def debug_log_level
+      @debug_logging_configuration.log_level
+    end
 
-  def debug_last_hash_to_s_proc
-    @debug_logging_configuration.last_hash_to_s_proc
-  end
+    def debug_log_level=(log_level)
+      @debug_logging_configuration.log_level = log_level
+    end
 
-  def debug_last_hash_to_s_proc=(last_hash_to_s_proc)
-    @debug_logging_configuration.last_hash_to_s_proc = last_hash_to_s_proc
-  end
+    def debug_multiple_last_hashes
+      @debug_logging_configuration.multiple_last_hashes
+    end
 
-  def debug_last_hash_max_length
-    @debug_logging_configuration.last_hash_max_length
-  end
+    def debug_multiple_last_hashes=(multiple_last_hashes)
+      @debug_logging_configuration.multiple_last_hashes = multiple_last_hashes
+    end
 
-  def debug_last_hash_max_length=(last_hash_max_length)
-    @debug_logging_configuration.last_hash_max_length = last_hash_max_length
-  end
+    def debug_last_hash_to_s_proc
+      @debug_logging_configuration.last_hash_to_s_proc
+    end
 
-  def debug_args_max_length
-    @debug_logging_configuration.args_max_length
-  end
+    def debug_last_hash_to_s_proc=(last_hash_to_s_proc)
+      @debug_logging_configuration.last_hash_to_s_proc = last_hash_to_s_proc
+    end
 
-  def debug_args_max_length=(args_max_length)
-    @debug_logging_configuration.args_max_length = args_max_length
-  end
+    def debug_last_hash_max_length
+      @debug_logging_configuration.last_hash_max_length
+    end
 
-  def debug_instance_benchmarks
-    @debug_logging_configuration.instance_benchmarks
-  end
+    def debug_last_hash_max_length=(last_hash_max_length)
+      @debug_logging_configuration.last_hash_max_length = last_hash_max_length
+    end
 
-  def debug_instance_benchmarks=(instance_benchmarks)
-    @debug_logging_configuration.instance_benchmarks = instance_benchmarks
-  end
+    def debug_args_to_s_proc
+      @debug_logging_configuration.args_to_s_proc
+    end
 
-  def debug_class_benchmarks
-    @debug_logging_configuration.class_benchmarks
-  end
+    def debug_args_to_s_proc=(args_to_s_proc)
+      @debug_logging_configuration.args_to_s_proc = args_to_s_proc
+    end
 
-  def debug_class_benchmarks=(class_benchmarks)
-    @debug_logging_configuration.class_benchmarks = class_benchmarks
-  end
+    def debug_args_max_length
+      @debug_logging_configuration.args_max_length
+    end
 
-  def debug_colorized_chain_for_method
-    @debug_logging_configuration.colorized_chain_for_method
-  end
+    def debug_args_max_length=(args_max_length)
+      @debug_logging_configuration.args_max_length = args_max_length
+    end
 
-  def debug_colorized_chain_for_method=(colorized_chain_for_method)
-    @debug_logging_configuration.colorized_chain_for_method = colorized_chain_for_method
-  end
+    def debug_instance_benchmarks
+      @debug_logging_configuration.instance_benchmarks
+    end
 
-  def debug_colorized_chain_for_class
-    @debug_logging_configuration.colorized_chain_for_class
-  end
+    def debug_instance_benchmarks=(instance_benchmarks)
+      @debug_logging_configuration.instance_benchmarks = instance_benchmarks
+    end
 
-  def debug_colorized_chain_for_class=(colorized_chain_for_class)
-    @debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
-  end
+    def debug_class_benchmarks
+      @debug_logging_configuration.class_benchmarks
+    end
 
-  def debug_add_invocation_id
-    @debug_logging_configuration.add_invocation_id
-  end
+    def debug_class_benchmarks=(class_benchmarks)
+      @debug_logging_configuration.class_benchmarks = class_benchmarks
+    end
 
-  def debug_add_invocation_id=(add_invocation_id)
-    @debug_logging_configuration.add_invocation_id = add_invocation_id
-  end
+    def debug_colorized_chain_for_method
+      @debug_logging_configuration.colorized_chain_for_method
+    end
 
-  def debug_mark_scope_exit
-    @debug_logging_configuration.mark_scope_exit
-  end
+    def debug_colorized_chain_for_method=(colorized_chain_for_method)
+      @debug_logging_configuration.colorized_chain_for_method = colorized_chain_for_method
+    end
 
-  def debug_mark_scope_exit=(mark_scope_exit)
-    @debug_logging_configuration.mark_scope_exit = mark_scope_exit
-  end
+    def debug_colorized_chain_for_class
+      @debug_logging_configuration.colorized_chain_for_class
+    end
 
-  def debug_ellipsis
-    @debug_logging_configuration.ellipsis
-  end
+    def debug_colorized_chain_for_class=(colorized_chain_for_class)
+      @debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
+    end
+
+    def debug_add_invocation_id
+      @debug_logging_configuration.add_invocation_id
+    end
 
-  def debug_ellipsis=(ellipsis)
-    @debug_logging_configuration.ellipsis = ellipsis
+    def debug_add_invocation_id=(add_invocation_id)
+      @debug_logging_configuration.add_invocation_id = add_invocation_id
+    end
+
+    def debug_ellipsis
+      @debug_logging_configuration.ellipsis
+    end
+
+    def debug_ellipsis=(ellipsis)
+      @debug_logging_configuration.ellipsis = ellipsis
+    end
+
+    def debug_mark_scope_exit
+      @debug_logging_configuration.mark_scope_exit
+    end
+
+    def debug_mark_scope_exit=(mark_scope_exit)
+      @debug_logging_configuration.mark_scope_exit = mark_scope_exit
+    end
+
+    def debug_add_payload
+      @debug_logging_configuration.add_payload
+    end
+
+    def debug_add_payload=(add_payload)
+      @debug_logging_configuration.add_payload = add_payload
+    end
+
+    def debug_payload_max_length
+      @debug_logging_configuration.payload_max_length
+    end
+
+    def debug_payload_max_length=(payload_max_length)
+      @debug_logging_configuration.payload_max_length = payload_max_length
+    end
+
+    def debug_error_handler_proc
+      @debug_logging_configuration.error_handler_proc
+    end
+
+    def debug_error_handler_proc=(error_handler_proc)
+      @debug_logging_configuration.error_handler_proc = error_handler_proc
+    end
   end
+
   self.debug_logging_configuration = Configuration.new # setup defaults
 end

data/lib/debug_logging/argument_printer.rb

@@ -2,7 +2,7 @@
 
 module DebugLogging
   module ArgumentPrinter
-    def debug_benchmark_to_s(tms: nil)
+    def debug_benchmark_to_s(tms:)
       "completed in #{format('%f', tms.real)}s (#{format('%f', tms.total)}s CPU)"
     end
 
@@ -38,56 +38,97 @@ module DebugLogging
       "#{klass_string}#{separator}#{method_string}"
     end
 
-    def debug_signature_to_s(args: nil, config_proxy: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def debug_signature_to_s(args: nil, config_proxy: nil) # rubocop:disable Metrics/CyclomaticComplexity
       return '' unless args && config_proxy
 
       printed_args = ''
 
       add_args_ellipsis = false
       if config_proxy.debug_last_hash_to_s_proc && args[-1].is_a?(Hash)
-        add_last_hash_ellipsis = false
+        add_other_args_ellipsis = false
         if args.length > 1
           if config_proxy.debug_multiple_last_hashes
             last_hash_args, other_args = args.partition do |arg|
               arg.is_a?(Hash)
             end
-            other_args_string = other_args.map(&:inspect).join(', ')[0..(config_proxy.debug_args_max_length)]
+            other_args_string = if config_proxy.debug_args_to_s_proc
+                                  printed, add_other_args_ellipsis = debug_safe_proc(
+                                    proc_name:'args_to_s_proc',
+                                    proc: config_proxy.debug_args_to_s_proc,
+                                    args: other_args,
+                                    max_length: config_proxy.debug_args_max_length
+                                  )
+                                  printed
+                                else
+                                  other_args.map(&:inspect).join(', ').tap do |x|
+                                    add_other_args_ellipsis = x.length > config_proxy.debug_args_max_length
+                                  end[0..(config_proxy.debug_args_max_length)]
+                                end
+            other_args_string += config_proxy.debug_ellipsis if add_other_args_ellipsis
             # On the debug_multiple_last_hashes truthy branch we don't print the ellipsis after regular args
-            #   because it will go instead after the last hash (if needed)
+            #   because it will go instead after each of the last hashes (if needed)
             #   ...join(", ").tap {|x| _add_args_ellipsis = x.length > config_proxy.debug_args_max_length}
             last_hash_args_string = last_hash_args.map do |arg|
               arr = []
-              arr << config_proxy.debug_last_hash_to_s_proc.call(arg).to_s
-                                 .tap do |x|
-                add_last_hash_ellipsis = x.length > config_proxy.debug_last_hash_max_length
-              end
-              if add_last_hash_ellipsis
-                arr[-1] = arr[-1][0..(config_proxy.debug_last_hash_max_length)]
-                arr << config_proxy.debug_ellipsis
-              end
+              printed, add_last_hash_ellipsis = debug_safe_proc(
+                proc_name:'last_hash_to_s_proc',
+                proc: config_proxy.debug_last_hash_to_s_proc,
+                args: arg,
+                max_length: config_proxy.debug_last_hash_max_length
+              )
+              printed += config_proxy.debug_ellipsis if add_last_hash_ellipsis
+              arr << printed
               arr
             end.flatten.join(', ')
             printed_args += other_args_string if other_args_string
             printed_args += ', ' if !other_args_string.empty? && !last_hash_args_string.empty?
             printed_args += last_hash_args_string if last_hash_args_string && !last_hash_args_string.empty?
           else
-            printed_args += args[0..-2].map(&:inspect).join(', ').tap do |x|
-                              add_args_ellipsis = x.length > config_proxy.debug_args_max_length
-                            end [0..(config_proxy.debug_args_max_length)]
-            printed_args += config_proxy.debug_ellipsis if add_args_ellipsis
-            printed_args += ", #{config_proxy.debug_last_hash_to_s_proc.call(args[-1]).tap do |x|
-                                   add_last_hash_ellipsis = x.length > config_proxy.debug_last_hash_max_length
-                                 end [0..(config_proxy.debug_last_hash_max_length)]}"
+            other_args = args[0..-2]
+            other_args_string = if config_proxy.debug_args_to_s_proc
+                                  printed, add_other_args_ellipsis = debug_safe_proc(
+                                    proc_name:'args_to_s_proc',
+                                    proc: config_proxy.debug_args_to_s_proc,
+                                    args: other_args,
+                                    max_length: config_proxy.debug_args_max_length
+                                  )
+                                  printed
+                                else
+                                  other_args.map(&:inspect).join(', ').tap do |x|
+                                    add_other_args_ellipsis = x.length > config_proxy.debug_args_max_length
+                                  end[0..(config_proxy.debug_args_max_length)]
+                                end
+            other_args_string += config_proxy.debug_ellipsis if add_other_args_ellipsis
+            printed_args += other_args_string
+            printed, add_last_hash_ellipsis = debug_safe_proc(
+              proc_name:'last_hash_to_s_proc',
+              proc: config_proxy.debug_last_hash_to_s_proc,
+              args: args[-1],
+              max_length: config_proxy.debug_last_hash_max_length
+            )
+            printed_args += ", #{printed}"
             printed_args += config_proxy.debug_ellipsis if add_last_hash_ellipsis
           end
         else
-          printed_args += String(config_proxy.debug_last_hash_to_s_proc.call(args[0])).tap do |x|
-                            add_last_hash_ellipsis = x.length > config_proxy.debug_last_hash_max_length
-                          end [0..(config_proxy.debug_last_hash_max_length)]
+          printed, add_last_hash_ellipsis = debug_safe_proc(
+            proc_name:'last_hash_to_s_proc',
+            proc: config_proxy.debug_last_hash_to_s_proc,
+            args: args[0],
+            max_length: config_proxy.debug_last_hash_max_length
+          )
+          printed_args += printed
           printed_args += config_proxy.debug_ellipsis if add_last_hash_ellipsis
         end
       else
-        printed_args += if args.length == 1 && args[0].is_a?(Hash)
+        printed_args += if config_proxy.debug_args_to_s_proc
+                          printed, add_args_ellipsis = debug_safe_proc(
+                            proc_name:'args_to_s_proc',
+                            proc: config_proxy.debug_args_to_s_proc,
+                            args: args,
+                            max_length: config_proxy.debug_args_max_length
+                          )
+                          printed
+                        elsif args.length == 1 && args[0].is_a?(Hash)
                           # handle double splat
                           ("**#{args.map(&:inspect).join(', ').tap do |x|
                                   add_args_ellipsis = x.length > config_proxy.debug_args_max_length
@@ -95,13 +136,26 @@ module DebugLogging
                         else
                           args.map(&:inspect).join(', ').tap do |x|
                             add_args_ellipsis = x.length > config_proxy.debug_args_max_length
-                          end [0..(config_proxy.debug_args_max_length)]
+                          end[0..(config_proxy.debug_args_max_length)]
                         end
         printed_args += config_proxy.debug_ellipsis if add_args_ellipsis
       end
       "(#{printed_args})"
     end
 
+    def debug_safe_proc(proc_name:, proc:, args:, max_length:)
+      max_length ||= 1000 # can't be nil
+      begin
+        add_ellipsis = false
+        printed = String(proc.call(args)).tap do |x|
+          add_ellipsis = x.length > max_length
+        end[0..(max_length)]
+        return printed, add_ellipsis
+      rescue => e
+        return "#{e.class}: #{e.message}\nPlease check that your #{proc_name} is able to handle #{args}", false
+      end
+    end
+
     def debug_payload_to_s(payload: nil, config_proxy: nil)
       return '' unless payload && config_proxy
 
@@ -110,7 +164,16 @@ module DebugLogging
         when true
           payload.inspect
         else
-          config_proxy.debug_add_payload.call(**payload)
+          printed_payload = ""
+          printed, add_payload_ellipsis = debug_safe_proc(
+            proc_name: "add_payload",
+            proc: config_proxy.debug_add_payload,
+            args: payload,
+            max_length: config_proxy.payload_max_length
+          )
+          printed_payload += printed
+          printed_payload += config_proxy.debug_ellipsis if add_payload_ellipsis
+          printed_payload
         end
       else
         ''