debug_logging 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95c155d2751e4ed8027d638174dd657f1205e009
-  data.tar.gz: 26c3390ea291a866f51c77b55961ae12c8439123
+  metadata.gz: 3175dd95278445508de7ab86b58993c7758777a9
+  data.tar.gz: 2f63b6b6728dbd590fe43f099c4ca0076ebc90de
 SHA512:
-  metadata.gz: b58918fd56b134e8e1285a4b4551e1b722c58a3138c178dcea67b0250156cb13d34588d8ed5858112024753192ba9f399c3131e50794f68ac47c814045ce1407
-  data.tar.gz: 8f6addac4962c57b13dfa9b9140775a548b845ead6df02b0c47393b3723bf26adf997807b38f84f6b6b6eb0536d8e5c0475e25ba2577a0b33344d5031e9585b7
+  metadata.gz: 7044a9f9f938a180fd8284c665f0d5dc3d4cbd0f61cc7f92e91803cc7bb9cdc024d759981866c15269d098f1065b217dd44c529dee52cb43a219d291cb0376d6
+  data.tar.gz: a842c4d45b4a5ab522776841a07ff29c0a8569733bbc7640871df496e5ba3ae38994fde4324d5f915ceabc0f02f5422d07c04f30c8ea96b459de974982f1f387

data/README.md

@@ -49,14 +49,17 @@ Recommend creating `config/initializers/debug_logging.rb` with:
 
 ```ruby
 # Showing the defaults
-DebugLogging.configuration.logger = Logger.new(STDOUT) # you probably want to override to be the Rails.logger
+DebugLogging.configuration.logger = Logger.new(STDOUT) # you probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
 DebugLogging.configuration.log_level = :debug # at what level do the messages created by this gem sent at?
+DebugLogging.configuration.multiple_last_hashes = false # pass every hash argument to last_hash_to_s_proc?
 DebugLogging.configuration.last_hash_to_s_proc = nil # e.g. ->(hash) { "keys: #{hash.keys}" }
 DebugLogging.configuration.last_hash_max_length = 1_000
 DebugLogging.configuration.args_max_length = 1_000
 DebugLogging.configuration.instance_benchmarks = false
 DebugLogging.configuration.class_benchmarks = false
-DebugLogging.configuration.add_invocation_id = true # invocation id allows you to identify a method call uniquely in a log
+DebugLogging.configuration.colorized_chain_for_method = false # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+DebugLogging.configuration.colorized_chain_for_class = false # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+DebugLogging.configuration.add_invocation_id = true # identify a method call uniquely in a log, pass a proc for colorization, e.g. ->(colorized_string) { colorized_string.light_black }
 DebugLogging.configuration.ellipsis = " ✂️ …".freeze
 ```
 
@@ -64,14 +67,17 @@ If you prefer to use the block style:
 
 ```ruby
 DebugLogging.configure do |config|
-  config.logger = Logger.new(STDOUT) # probably want to override to be the Rails.logger
+  config.logger = Logger.new(STDOUT) # probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
   config.log_level = :debug # at what level do the messages created by this gem sent at?
+  config.multiple_last_hashes = false # pass every hash argument to last_hash_to_s_proc?
   config.last_hash_to_s_proc = nil # e.g. ->(hash) { "keys: #{hash.keys}" }
   config.last_hash_max_length = 1_000
   config.args_max_length = 1_000
   config.instance_benchmarks = false
   config.class_benchmarks = false
-  config.add_invocation_id = true # invocation id allows you to identify a method call uniquely in a log
+  config.colorized_chain_for_method = false # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+  config.colorized_chain_for_class = false # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+  config.add_invocation_id = true # identify a method call uniquely in a log, pass a proc for colorization, e.g. ->(colorized_string) { colorized_string.light_black }
   config.ellipsis = " ✂️ …".freeze
 end
 ```
@@ -80,8 +86,13 @@ end
 Just prepend `debug_` to any config value you want to override in a class.
 
 **All** of the above **config** is **inheritable** and **configurable** at the **per-method** level as well!
-Just send along a hash of the config options when you call `logged` or `include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])`.  See the example class below:
+Just send along a hash of the config options when you call `logged` or `include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])`.  See the example class below, and the specs.
 
+**NOTE ON** `Rails.logger` - It will probably be nil in your initializer, so setting the `config.logger` to `Rails.logger` there will result in setting it to `nil`, which means the default will end up being used: `Logger.new(STDOUT)`. Instead just config the logger in your application.rb, or anytime later, but *before your classes get loaded* and start inheriting the config:
+
+```ruby
+DebugLogging.configuration.logger = Rails.logger
+```
 
 Every time a method is called, get logs, optionally with arguments, a benchmarck, and a unique invocation identifier:
 

data/debug_logging.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "colorize", "~> 0.8"
   spec.add_development_dependency "rspec-pending_for"
   spec.add_development_dependency "byebug", "~> 9.0"
   spec.add_development_dependency "bundler", "~> 1.14"

data/lib/debug_logging/argument_printer.rb

@@ -1,6 +1,35 @@
 module DebugLogging
   module ArgumentPrinter
-    def debug_arguments_to_s(args: nil, config_proxy: nil)
+    def debug_benchmark_to_s(tms: nil)
+      "completed in #{sprintf("%f", tms.real)}s (#{sprintf("%f", tms.total)}s CPU)"
+    end
+    def debug_invocation_id_to_s(args: nil, config_proxy: nil)
+      if config_proxy.debug_add_invocation_id
+        invocation = " ~#{args.object_id}@#{sprintf("%#-21a", Time.now.to_f)[4..(-4)]}~"
+        case config_proxy.debug_add_invocation_id
+        when true then
+          invocation
+        else
+          config_proxy.debug_add_invocation_id.call(ColorizedString[invocation])
+        end
+      else
+        ""
+      end
+    end
+    def debug_invocation_to_s(klass: nil, separator: nil, method_to_log: nil, config_proxy: nil)
+      klass_string = if config_proxy.debug_colorized_chain_for_class
+                       config_proxy.debug_colorized_chain_for_class.call(ColorizedString[klass.to_s])
+                     else
+                       klass.to_s
+                     end
+      method_string = if config_proxy.debug_colorized_chain_for_method
+                        config_proxy.debug_colorized_chain_for_method.call(ColorizedString[method_to_log.to_s])
+                      else
+                        method_to_log.to_s
+                      end
+      "#{klass_string}#{separator}#{method_string}"
+    end
+    def debug_signature_to_s(args: nil, config_proxy: nil)
       printed_args = ""
       add_args_ellipsis = false
       if config_proxy.debug_last_hash_to_s_proc && args[-1].is_a?(Hash)

data/lib/debug_logging/class_logger.rb

@@ -12,22 +12,24 @@ module DebugLogging
         method_to_log = method_to_log.to_sym
         original_method = method(method_to_log)
         (class << self; self; end).class_eval do
-          define_method(method_to_log) do |*args|
+          define_method(method_to_log) do |*args, &block|
             config_proxy = if opts
                              Configuration.new(**(debug_config.to_hash.merge(opts)))
                            else
                              self
                            end
             method_return_value = nil
-            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if config_proxy.debug_add_invocation_id
-            debug_log "#{self}.#{method_to_log}#{debug_arguments_to_s(args: args, config_proxy: config_proxy)}#{invocation_id}"
+            log_prefix = debug_invocation_to_s(klass: self.to_s, separator: ".", method_to_log: method_to_log, config_proxy: config_proxy)
+            signature = debug_signature_to_s(args: args, config_proxy: config_proxy)
+            invocation_id = debug_invocation_id_to_s(args: args, config_proxy: config_proxy)
+            debug_log "#{log_prefix}#{signature}#{invocation_id}"
             if config_proxy.debug_class_benchmarks
-              elapsed = Benchmark.realtime do
-                method_return_value = original_method.call(*args)
+              tms = Benchmark.measure do
+                method_return_value = original_method.call(*args, &block)
               end
-              debug_log "#{self}.#{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
+              debug_log "#{log_prefix} #{debug_benchmark_to_s(tms: tms)}#{invocation_id}"
             else
-              method_return_value = original_method.call(*args)
+              method_return_value = original_method.call(*args, &block)
             end
             method_return_value
           end

data/lib/debug_logging/configuration.rb

@@ -9,6 +9,8 @@ module DebugLogging
     attr_accessor :args_max_length
     attr_accessor :instance_benchmarks
     attr_accessor :class_benchmarks
+    attr_accessor :colorized_chain_for_method
+    attr_accessor :colorized_chain_for_class
     attr_accessor :add_invocation_id
     attr_accessor :ellipsis
     # alias the readers to the debug_* prefix so an instance of this class
@@ -37,6 +39,8 @@ module DebugLogging
     alias :debug_args_max_length :args_max_length
     alias :debug_instance_benchmarks :instance_benchmarks
     alias :debug_class_benchmarks :class_benchmarks
+    alias :debug_colorized_chain_for_method :colorized_chain_for_method
+    alias :debug_colorized_chain_for_class :colorized_chain_for_class
     alias :debug_add_invocation_id :add_invocation_id
     alias :debug_ellipsis :ellipsis
     def initialize(**options)
@@ -48,6 +52,8 @@ module DebugLogging
       @args_max_length = options.key?(:args_max_length) ? options[:args_max_length] : 1_000
       @instance_benchmarks = options.key?(:instance_benchmarks) ? options[:instance_benchmarks] : false
       @class_benchmarks = options.key?(:class_benchmarks) ? options[:class_benchmarks] : false
+      @colorized_chain_for_method = options.key?(:colorized_chain_for_method) ? options[:colorized_chain_for_method] : false
+      @colorized_chain_for_class = options.key?(:colorized_chain_for_class) ? options[:colorized_chain_for_class] : false
       @add_invocation_id = options.key?(:add_invocation_id) ? options[:add_invocation_id] : true
       @ellipsis = options.key?(:ellipsis) ? options[:ellipsis] : DEFAULT_ELLIPSIS
     end
@@ -69,6 +75,8 @@ module DebugLogging
           args_max_length: args_max_length,
           instance_benchmarks: instance_benchmarks,
           class_benchmarks: class_benchmarks,
+          colorized_chain_for_method: colorized_chain_for_method,
+          colorized_chain_for_class: colorized_chain_for_class,
           add_invocation_id: add_invocation_id,
           ellipsis: ellipsis
       }

data/lib/debug_logging/instance_logger_modulizer.rb

@@ -11,14 +11,15 @@ module DebugLogging
                              self.class
                            end
             method_return_value = nil
-            log_prefix = "#{self.class}##{method_to_log}"
-            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if config_proxy.debug_add_invocation_id && args
-            self.class.debug_log "#{log_prefix}#{self.class.debug_arguments_to_s(args: args, config_proxy: config_proxy)}#{invocation_id}"
+            log_prefix = self.class.debug_invocation_to_s(klass: self.class.to_s, separator: "#", method_to_log: method_to_log, config_proxy: config_proxy)
+            signature = self.class.debug_signature_to_s(args: args, config_proxy: config_proxy)
+            invocation_id = self.class.debug_invocation_id_to_s(args: args, config_proxy: config_proxy)
+            self.class.debug_log "#{log_prefix}#{signature}#{invocation_id}"
             if config_proxy.debug_instance_benchmarks
-              elapsed = Benchmark.realtime do
+              tms = Benchmark.measure do
                 method_return_value = super(*args, &block)
               end
-              self.class.debug_log "#{log_prefix} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
+              self.class.debug_log "#{log_prefix} #{self.class.debug_benchmark_to_s(tms: tms)}#{invocation_id}"
             else
               method_return_value = super(*args, &block)
             end

data/lib/debug_logging/version.rb

@@ -1,3 +1,3 @@
 module DebugLogging
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/debug_logging.rb

@@ -1,4 +1,5 @@
 require "logger"
+require "colorized_string"
 require "debug_logging/version"
 require "debug_logging/configuration"
 require "debug_logging/argument_printer"
@@ -140,6 +141,18 @@ module DebugLogging
   def debug_class_benchmarks=(class_benchmarks)
     @debug_logging_configuration.class_benchmarks = class_benchmarks
   end
+  def debug_colorized_chain_for_method
+    @debug_logging_configuration.colorized_chain_for_method
+  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_colorized_chain_for_class
+    @debug_logging_configuration.colorized_chain_for_class
+  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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec-pending_for
   requirement: !ruby/object:Gem::Requirement