debug_logging 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2354763d5bcb6438947c4e268683c956477b812
-  data.tar.gz: 2c0c20aff357b165857f6c7794bb54e87e2b7ac3
+  metadata.gz: 74f20737ddaf59151ab3118f196f2d811cfe4687
+  data.tar.gz: 21a1c19d58110b20436788e74f94c2c5fdc62c10
 SHA512:
-  metadata.gz: b6312e56ce69f08fa23d1e57c24b7e10354e4f971304b6dbed74d3232cb2593d1ccff250f0e5eebc51e24edf80c60c646c8f636cdf135a7d8d1967289903334d
-  data.tar.gz: 987ea132ee891882e14a1bee41bbe47084700468767588e21eaa2a487098178613b36592d0f69e17c55fdfcad9bd1a175a0613bea9b5064bf028212fd53ab6a2
+  metadata.gz: 7ebb58f828a34bfa2be6c31228c977dd08e796070c2af386781efaf434d5453b7d333552908f47f8e3df5fe6a2a56148499f14d364c203cf1210309f54fa7378
+  data.tar.gz: ee69b5dab10dbb4a5a076bd62ee0d3540747201d41e7bbf22b5b71d11321c2db5dce2bbb44cbc2afb08bd2bb93a5928a24cfce9e4872d49942c327f1907b77a3

data/.byebug_history

@@ -0,0 +1,4 @@
+exit
+@debug_logging_configuration
+debug_logging_configuration
+debug_class_benchmarks

data/README.md

@@ -41,45 +41,75 @@ Crack open the specs for usage examples.
 ### Without Rails
 
 It just works. ;)
-Configuration can go anywhere you want.
+Configuration can go anywhere you want.  It will look like the Rails config though; see below.
 
 ### With Rails
 
 Recommend creating `config/initializers/debug_logging.rb` with:
+
 ```ruby
 # Showing the defaults
-DebugLogging.logger = Logger.new(STDOUT) # you probably want to override to be the Rails.logger
-DebugLogging.log_level = :debug # at what level do the messages created by this gem sent at?
-DebugLogging.last_hash_to_s_proc = nil # e.g. ->(hash) { "#{hash.keys}" }
-DebugLogging.last_hash_max_length = 1_000
-DebugLogging.args_max_length = 1_000
-DebugLogging.instance_benchmarks = false
-DebugLogging.class_benchmarks = false
-DebugLogging.add_invocation_id = true # invocation id allows you to identify a method call uniquely in a log
-DebugLogging.ellipsis = " ✂️ …".freeze
+DebugLogging.configuration.logger = Logger.new(STDOUT) # you probably want to override to be the Rails.logger
+DebugLogging.configuration.log_level = :debug # at what level do the messages created by this gem sent at?
+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.ellipsis = " ✂️ …".freeze
+```
+
+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.log_level = :debug # at what level do the messages created by this gem sent at?
+  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.ellipsis = " ✂️ …".freeze
+end
 ```
 
+**All** of the above **config** is **inheritable** and **configurable** at the **per-class** level as well!
+Just prepend `debug_` to any config value you want to override in a class.
+
+Every time a method is called, get logs, optionally with arguments, a benchmarck, and a unique invocation identifier:
+
 ```ruby
 class Car
 
+  # adds the helper methods to the class, all are prefixed with debug_*,
+  #   except for the logged class method, which comes from extending DebugLogging::ClassLogger
+  extend DebugLogging
+
+  # per class configuration overrides!
+  self.debug_class_benchmarks = true
+  self.debug_instance_benchmarks = true
+
   # For instance methods:
   # Option 1: specify the exact method(s) to add logging to
   include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
-  
+
   extend DebugLogging::ClassLogger
-  
-  logged def self.make; new; end
-  def self.design(*args); new; end
-  def self.safety(*args); new; end
+
+  logged def debug_make; new; end
+  def design(*args); new; end
+  def safety(*args); new; end
   logged :design, :safety
-  
+
   def drive(speed); speed; end
   def stop; 0; end
-  
+
   # For instance methods:
   # Option 2: add logging to all instance methods defined above (but *not* defined below)
-  include DebugLogging::InstanceLogger.new(i_methods: self.instance_methods(false))
-  
+  include DebugLogging::InstanceLogger.new(i_methods: debug_instance_methods(false))
+
   def will_not_be_logged; false; end
 
 end

data/debug_logging.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rspec-pending_for"
+  spec.add_development_dependency "byebug", "~> 9.0"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/debug_logging/argument_printer.rb

@@ -1,28 +1,27 @@
 module DebugLogging
   module ArgumentPrinter
-    def self.to_s(args)
-      length = 0
-      if DebugLogging.last_hash_to_s_proc && args[-1].is_a?(Hash)
+    def debug_arguments_to_s(args)
+      if debug_last_hash_to_s_proc && args[-1].is_a?(Hash)
         if args.length > 1
           add_args_ellipsis = false
           add_last_hash_ellipsis = false
-          printed_args = args[0..(-2)].map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > DebugLogging.args_max_length}[0..(DebugLogging.args_max_length)]
-          printed_args << DebugLogging.ellipsis if add_args_ellipsis
-          printed_args << ", " << DebugLogging.last_hash_to_s_proc.call(args[-1]).tap {|x| add_last_hash_ellipsis = x.length > DebugLogging.last_hash_max_length}[0..(DebugLogging.last_hash_max_length)]
-          printed_args << DebugLogging.ellipsis if add_last_hash_ellipsis
+          printed_args = args[0..(-2)].map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > debug_args_max_length}[0..(debug_args_max_length)]
+          printed_args << debug_ellipsis if add_args_ellipsis
+          printed_args << ", " << debug_last_hash_to_s_proc.call(args[-1]).tap {|x| add_last_hash_ellipsis = x.length > debug_last_hash_max_length}[0..(debug_last_hash_max_length)]
+          printed_args << debug_ellipsis if add_last_hash_ellipsis
         else
-          printed_args = DebugLogging.last_hash_to_s_proc.call(args[0]).tap {|x| add_last_hash_ellipsis = x.length > DebugLogging.last_hash_max_length}[0..(DebugLogging.last_hash_max_length)]
-          printed_args << DebugLogging.ellipsis if add_last_hash_ellipsis
+          printed_args = debug_last_hash_to_s_proc.call(args[0]).tap {|x| add_last_hash_ellipsis = x.length > debug_last_hash_max_length}[0..(debug_last_hash_max_length)]
+          printed_args << debug_ellipsis if add_last_hash_ellipsis
         end
       else
         add_args_ellipsis = false
         if args.length == 1 && args[0].is_a?(Hash)
           # handle double splat
-          printed_args = ("**" << args.map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > DebugLogging.args_max_length})[0..(DebugLogging.args_max_length)]
+          printed_args = ("**" << args.map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > debug_args_max_length})[0..(debug_args_max_length)]
         else
-          printed_args = args.map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > DebugLogging.args_max_length}[0..(DebugLogging.args_max_length)]
+          printed_args = args.map {|x| x.inspect}.join(", ").tap {|x| add_args_ellipsis = x.length > debug_args_max_length}[0..(debug_args_max_length)]
         end
-        printed_args << DebugLogging.ellipsis if add_args_ellipsis
+        printed_args << debug_ellipsis if add_args_ellipsis
       end
       "(#{printed_args})"
     end

data/lib/debug_logging/class_logger.rb

@@ -2,18 +2,19 @@ module DebugLogging
   module ClassLogger
     def logged(*methods_to_log)
       methods_to_log.each do |method_to_log|
-        # method name will always be a symbol
+        # method name must be a symbol
+        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|
             method_return_value = nil
-            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if DebugLogging.add_invocation_id && args
-            DebugLogging.log "#{self}.#{method_to_log}#{ArgumentPrinter.to_s(args)}#{invocation_id}"
-            if DebugLogging.class_benchmarks
+            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if debug_add_invocation_id
+            debug_log "#{self}.#{method_to_log}#{debug_arguments_to_s(args)}#{invocation_id}"
+            if debug_class_benchmarks
               elapsed = Benchmark.realtime do
                 method_return_value = original_method.call(*args)
               end
-              DebugLogging.log "#{self}.#{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
+              debug_log "#{self}.#{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
             else
               method_return_value = original_method.call(*args)
             end

data/lib/debug_logging/configuration.rb

@@ -0,0 +1,32 @@
+module DebugLogging
+  class Configuration
+    attr_accessor :logger
+    attr_accessor :log_level
+    attr_accessor :last_hash_to_s_proc
+    attr_accessor :last_hash_max_length
+    attr_accessor :args_max_length
+    attr_accessor :instance_benchmarks
+    attr_accessor :class_benchmarks
+    attr_accessor :add_invocation_id
+    attr_accessor :ellipsis
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @log_level = :debug
+      @last_hash_to_s_proc = nil
+      @last_hash_max_length = 1_000
+      @args_max_length = 1_000
+      @instance_benchmarks = false
+      @class_benchmarks = false
+      @add_invocation_id = true
+      @ellipsis = " ✂️ …".freeze
+    end
+    def instance_benchmarks=(instance_benchmarks)
+      require "benchmark" if instance_benchmarks
+      @instance_benchmarks = instance_benchmarks
+    end
+    def class_benchmarks=(class_benchmarks)
+      require "benchmark" if class_benchmarks
+      @class_benchmarks = class_benchmarks
+    end
+  end
+end

data/lib/debug_logging/instance_logger.rb

@@ -5,6 +5,7 @@ module DebugLogging
     end
     def included(base)
       if @instance_methods_to_log
+        base.send(:include, ArgumentPrinter)
         instance_method_logger = DebugLogging::InstanceLoggerModulizer.to_mod(@instance_methods_to_log)
         base.send(:prepend, instance_method_logger)
       end

data/lib/debug_logging/instance_logger_modulizer.rb

@@ -3,15 +3,16 @@ module DebugLogging
     def self.to_mod(methods_to_log = [])
       Module.new do
         Array(methods_to_log).each do |method_to_log|
+          # method name must be a symbol
           define_method(method_to_log.to_sym) do |*args, &block|
             method_return_value = nil
-            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if DebugLogging.add_invocation_id && args
-            DebugLogging.log "#{self.class}##{method_to_log}#{DebugLogging::ArgumentPrinter.to_s(args)}#{invocation_id}"
-            if DebugLogging.instance_benchmarks
+            invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if self.class.debug_add_invocation_id && args
+            self.class.debug_log "#{self.class}##{method_to_log}#{self.class.debug_arguments_to_s(args)}#{invocation_id}"
+            if self.class.debug_instance_benchmarks
               elapsed = Benchmark.realtime do
                 method_return_value = super(*args, &block)
               end
-              DebugLogging.log "#{self.class}##{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
+              self.class.debug_log "#{self.class}##{method_to_log} completed in #{sprintf("%f", elapsed)}s#{invocation_id}"
             else
               method_return_value = super(*args, &block)
             end

data/lib/debug_logging/version.rb

@@ -1,3 +1,3 @@
 module DebugLogging
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/debug_logging.rb

@@ -1,16 +1,11 @@
 require "logger"
 require "debug_logging/version"
+require "debug_logging/configuration"
 require "debug_logging/argument_printer"
 require "debug_logging/instance_logger_modulizer"
 require "debug_logging/instance_logger"
 require "debug_logging/class_logger"
 
-####################
-#                  #
-# Next Level Magic #
-# Classes inheriting from Module.
-# Cats and dogs sleeping together.
-#                  #
 ####################
 #                  #
 # NOTE: The manner this is made to work for class methods is totally different
@@ -24,15 +19,23 @@ require "debug_logging/class_logger"
 #                  #
 #     class Car
 #
+#       # adds the helper methods to the class, all are prefixed with debug_*,
+#       #   except for the logged class method, which comes from extending DebugLogging::ClassLogger
+#       extend DebugLogging
+#
+#       # per class configuration overrides!
+#       self.debug_class_benchmarks = true
+#       self.debug_instance_benchmarks = true
+#
 #       # For instance methods:
 #       # Option 1: specify the exact method(s) to add logging to
 #       include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
 #
 #       extend DebugLogging::ClassLogger
 #
-#       logged def self.make; new; end
-#       def self.design(*args); new; end
-#       def self.safety(*args); new; end
+#       logged def debug_make; new; end
+#       def design(*args); new; end
+#       def safety(*args); new; end
 #       logged :design, :safety
 #
 #       def drive(speed); speed; end
@@ -40,7 +43,7 @@ require "debug_logging/class_logger"
 #
 #       # For instance methods:
 #       # Option 2: add logging to all instance methods defined above (but *not* defined below)
-#       include DebugLogging::InstanceLogger.new(i_methods: self.instance_methods(false))
+#       include DebugLogging::InstanceLogger.new(i_methods: debug_instance_methods(false))
 #
 #       def will_not_be_logged; false; end
 #
@@ -49,75 +52,93 @@ require "debug_logging/class_logger"
 ####################
 
 module DebugLogging
-  def self.config_reset
-    @@logger = nil
-    @@log_level = :debug
-    @@last_hash_to_s_proc = nil
-    @@last_hash_max_length = 1_000
-    @@args_max_length = 1_000
-    @@instance_benchmarks = false
-    @@class_benchmarks = false
-    @@add_invocation_id = true
-    @@ellipsis = " ✂️ …".freeze
+  def self.extended(base)
+    base.send(:extend, ArgumentPrinter)
+    base.debug_config_reset(debug_logging_configuration.dup)
+  end
+
+  #### API ####
+  def debug_log(message)
+    debug_logger.send(debug_log_level, message)
+  end
+
+  # For single statement global config in an initializer
+  # e.g. DebugLogging.configuration.ellipsis = "..."
+  def self.configuration
+    self.debug_logging_configuration ||= Configuration.new
+  end
+
+  # For global config in an initializer with a block
+  def self.configure
+    yield(configuration)
+  end
+
+  # For per-class config with a block
+  def debug_logging_configure
+    @debug_logging_configuration ||= Configuration.new
+    yield(@debug_logging_configuration)
+  end
+
+  #### CONFIG ####
+  class << self
+    attr_accessor :debug_logging_configuration
   end
-  def self.logger
-    @@logger ||= Logger.new(STDOUT)
+  def debug_config_reset(config = Configuration.new)
+    @debug_logging_configuration = config
   end
-  def self.logger=(logger)
-    @@logger = logger
+  def debug_logger
+    @debug_logging_configuration.logger
   end
-  def self.log_level
-    @@log_level || :debug
+  def debug_logger=(logger)
+    @debug_logging_configuration.logger = logger
   end
-  def self.log_level=(log_level)
-    @@log_level = log_level
+  def debug_log_level
+    @debug_logging_configuration.log_level
   end
-  def self.last_hash_to_s_proc
-    @@last_hash_to_s_proc
+  def debug_log_level=(log_level)
+    @debug_logging_configuration.log_level = log_level
   end
-  def self.last_hash_to_s_proc=(last_hash_to_s_proc)
-    @@last_hash_to_s_proc = last_hash_to_s_proc
+  def debug_last_hash_to_s_proc
+    @debug_logging_configuration.last_hash_to_s_proc
   end
-  def self.last_hash_max_length
-    @@last_hash_max_length || 1_000
+  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 self.last_hash_max_length=(last_hash_max_length)
-    @@last_hash_max_length = last_hash_max_length
+  def debug_last_hash_max_length
+    @debug_logging_configuration.last_hash_max_length
   end
-  def self.args_max_length
-    @@args_max_length || 1_000
+  def debug_last_hash_max_length=(last_hash_max_length)
+    @debug_logging_configuration.last_hash_max_length = last_hash_max_length
   end
-  def self.args_max_length=(args_max_length)
-    @@args_max_length = args_max_length
+  def debug_args_max_length
+    @debug_logging_configuration.args_max_length
   end
-  def self.instance_benchmarks
-    @@instance_benchmarks
+  def debug_args_max_length=(args_max_length)
+    @debug_logging_configuration.args_max_length = args_max_length
   end
-  def self.instance_benchmarks=(instance_benchmarks)
-    require "benchmark" if instance_benchmarks
-    @@instance_benchmarks = instance_benchmarks
+  def debug_instance_benchmarks
+    @debug_logging_configuration.instance_benchmarks
   end
-  def self.class_benchmarks
-    @@class_benchmarks
+  def debug_instance_benchmarks=(instance_benchmarks)
+    @debug_logging_configuration.instance_benchmarks = instance_benchmarks
   end
-  def self.class_benchmarks=(class_benchmarks)
-    require "benchmark" if class_benchmarks
-    @@class_benchmarks = class_benchmarks
+  def debug_class_benchmarks
+    @debug_logging_configuration.class_benchmarks
   end
-  def self.add_invocation_id
-    @@add_invocation_id
+  def debug_class_benchmarks=(class_benchmarks)
+    @debug_logging_configuration.class_benchmarks = class_benchmarks
   end
-  def self.add_invocation_id=(add_invocation_id)
-    @@add_invocation_id = add_invocation_id
+  def debug_add_invocation_id
+    @debug_logging_configuration.add_invocation_id
   end
-  def self.ellipsis
-    @@ellipsis
+  def debug_add_invocation_id=(add_invocation_id)
+    @debug_logging_configuration.add_invocation_id = add_invocation_id
   end
-  def self.ellipsis=(ellipsis)
-    @@ellipsis = ellipsis
+  def debug_ellipsis
+    @debug_logging_configuration.ellipsis
   end
-  def self.log(message)
-    logger.send(log_level, message)
+  def debug_ellipsis=(ellipsis)
+    @debug_logging_configuration.ellipsis = ellipsis
   end
-  config_reset # setup defaults
+  self.debug_logging_configuration = Configuration.new # setup defaults
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-pending_for
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -85,6 +100,7 @@ files:
 - lib/debug_logging.rb
 - lib/debug_logging/argument_printer.rb
 - lib/debug_logging/class_logger.rb
+- lib/debug_logging/configuration.rb
 - lib/debug_logging/instance_logger.rb
 - lib/debug_logging/instance_logger_modulizer.rb
 - lib/debug_logging/version.rb