debug_logging 1.0.15 → 3.1.0

data/lib/debug_logging/instance_logger.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
+
 module DebugLogging
   class InstanceLogger < Module
     def initialize(i_methods: nil, config: nil)
+      super()
       @config = config
       @instance_methods_to_log = Array(i_methods) if i_methods
     end
+
     def included(base)
       return unless @instance_methods_to_log
+
       base.send(:include, ArgumentPrinter)
       instance_method_logger = DebugLogging::InstanceLoggerModulizer.to_mod(methods_to_log: @instance_methods_to_log, config: @config)
       base.send(:prepend, instance_method_logger)

data/lib/debug_logging/instance_logger_modulizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DebugLogging
   module InstanceLoggerModulizer
     def self.to_mod(methods_to_log: nil, config: nil)
@@ -10,7 +12,7 @@ module DebugLogging
                              proxy
                            else
                              proxy = if config
-                                       Configuration.new(**(self.class.debug_config.to_hash.merge(config))) 
+                                       Configuration.new(**self.class.debug_config.to_hash.merge(config))
                                      else
                                        self.class.debug_config
                                      end
@@ -18,7 +20,7 @@ module DebugLogging
                              instance_variable_set(DebugLogging::Configuration.config_pointer('i', method_to_log), proxy)
                              proxy
                            end
-            log_prefix = self.class.debug_invocation_to_s(klass: self.class.to_s, separator: "#", method_to_log: method_to_log, config_proxy: config_proxy)
+            log_prefix = self.class.debug_invocation_to_s(klass: self.class.to_s, separator: '#', method_to_log: method_to_log, config_proxy: config_proxy)
             invocation_id = self.class.debug_invocation_id_to_s(args: args, config_proxy: config_proxy)
             config_proxy.log do
               signature = self.class.debug_signature_to_s(args: args, config_proxy: config_proxy)

data/lib/debug_logging/instance_notifier.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DebugLogging
+  class InstanceNotifier < Module
+    def initialize(i_methods: nil)
+      super()
+      @instance_methods_to_notify = Array(i_methods) if i_methods
+    end
+
+    def included(base)
+      return unless @instance_methods_to_notify
+
+      base.send(:include, ArgumentPrinter)
+      instance_method_notifier = DebugLogging::InstanceNotifierModulizer.to_mod(methods_to_notify: @instance_methods_to_notify)
+      base.send(:prepend, instance_method_notifier)
+    end
+  end
+end

data/lib/debug_logging/instance_notifier_modulizer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DebugLogging
+  module InstanceNotifierModulizer
+    def self.to_mod(methods_to_notify: nil)
+      Module.new do
+        Array(methods_to_notify).each do |method_to_notify|
+          # method name must be a symbol
+          payload = method_to_notify.is_a?(Array) && method_to_notify.last.is_a?(Hash) && method_to_notify.pop || {}
+          if method_to_notify.is_a?(Array)
+            method_to_notify = method_to_notify.first&.to_sym
+          else
+            method_to_notify.to_sym
+          end
+          config_proxy = nil
+          define_method(method_to_notify) do |*args, &block|
+            config_proxy = if (proxy = instance_variable_get(DebugLogging::Configuration.config_pointer('i', method_to_notify)))
+                             proxy
+                           else
+                             proxy = if !payload.empty?
+                                       Configuration.new(**self.class.debug_config.to_hash.merge(payload))
+                                     else
+                                       self.class.debug_config
+                                     end
+                             proxy.register(method_to_notify)
+                             instance_variable_set(DebugLogging::Configuration.config_pointer('i', method_to_notify), proxy)
+                             proxy
+                           end
+            if payload.key?(:instance_variables)
+              payload[:instance_variables].each do |k|
+                payload[k] = instance_variable_get("@#{k}") if instance_variable_get("@#{k}")
+              end
+              payload.delete(:instance_variables)
+            end
+            ActiveSupport::Notifications.instrument(
+              self.class.debug_event_name_to_s(method_to_notify: method_to_notify), { args: args }.merge(payload)
+            ) do
+              super(*args, &block)
+            end
+          end
+
+          ActiveSupport::Notifications.subscribe(/log/) do |*args|
+            config_proxy&.log do
+              DebugLogging::LogSubscriber.log_event(ActiveSupport::Notifications::Event.new(*args))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/debug_logging/log_subscriber.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/log_subscriber'
+
+module DebugLogging
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    class << self
+      attr_accessor :event
+    end
+    attach_to :log
+
+    EVENT_FORMAT_STRING = '%<name>s (%<duration>.3f secs) start=%<time>s end=%<end>s payload=%<payload>s'
+
+    def self.log_event(event)
+      @event = event
+      if event.payload && event.payload[:exception_object]
+        exception = event.payload[:exception_object]
+        "#{event.name} [ERROR] : \n#{exception.class} : #{exception.message}\n" + exception.backtrace.join("\n")
+      end
+      format(EVENT_FORMAT_STRING, event_to_format_options(event))
+    end
+
+    # @param [ActiveSupport::Notifications::Event]
+    # @return [Hash]
+    def self.event_to_format_options(event)
+      {
+        name: event.name,
+        duration: Rational(event.duration, 1000).to_f,
+        time: event.time,
+        end: event.end,
+        payload: event.payload
+      }
+    end
+  end
+end

data/lib/debug_logging/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DebugLogging
-  VERSION = "1.0.15"
+  VERSION = '3.1.0'
 end

data/lib/simple_debug_logging.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # Simpler version of what the sibling DebugLogging library does.  Included as a bauble.
 #
 ############# THIS IS A BAUBLE
 ############# FOR EXAMINING SEVERAL OF THE WONDERS OF RUBY
 ############# TO ACCOMPLISH SOMETHING PRACTICAL
-############# For a more robust implementation use the gem debug_logging itself, 
+############# For a more robust implementation use the gem debug_logging itself,
 #############   which makes use of these same principles.
 #
 # Automatically log Class.method(arguments) as they are called at runtime (instance or singleton)!
@@ -19,8 +21,6 @@
 #       logged :a_class_method
 #     end
 #
-#   Make sure you have the latest debug_logging gem (>= 1.0.10) installed for this to work
-#
 #   In an irb session:
 #     >> require_relative 'unobtrusively_logged'
 #     => true
@@ -39,8 +39,10 @@ require 'benchmark'
 
 class SimpleDebugLogging < Module
   def initialize(i_methods: nil)
+    super()
     @instance_methods_to_log = Array(i_methods) if i_methods
   end
+
   def included(base)
     instance_method_logger = InstanceMethodLoggerModulizer.to_mod(@instance_methods_to_log)
     base.send(:prepend, instance_method_logger)
@@ -54,7 +56,7 @@ class SimpleDebugLogging < Module
           define_method(method_to_log.to_sym) do |*args|
             method_return_value = nil
             invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if args
-            puts "#{self}.#{method_to_log}(#{args.map {|x| x.inspect}.join(", ")})#{invocation_id}"
+            puts "#{self}.#{method_to_log}(#{args.map(&:inspect).join(', ')})#{invocation_id}"
             elapsed = Benchmark.realtime do
               method_return_value = original_method.call(*args)
             end
@@ -72,7 +74,7 @@ class SimpleDebugLogging < Module
           define_method(method_to_log.to_sym) do |*args, &block|
             method_return_value = nil
             invocation_id = " ~#{args.object_id}@#{Time.now.to_i}~" if args
-            puts "#{self.class}##{method_to_log}(#{args.map {|x| x.inspect}.join(", ")})#{invocation_id}"
+            puts "#{self.class}##{method_to_log}(#{args.map(&:inspect).join(', ')})#{invocation_id}"
             elapsed = Benchmark.realtime do
               method_return_value = super(*args, &block)
             end

metadata

@@ -1,113 +1,161 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 3.1.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2020-10-24 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'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-pending_for
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.4.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rspec-pending_for
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.92'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.92'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: silent_stream
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '1'
 description: |2
 
   Unobtrusive debug logging for Ruby.  NO LITTERING.
@@ -121,6 +169,8 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -129,11 +179,16 @@ files:
 - bin/setup
 - debug_logging.gemspec
 - lib/debug_logging.rb
+- lib/debug_logging/active_support_notifications.rb
 - lib/debug_logging/argument_printer.rb
 - lib/debug_logging/class_logger.rb
+- lib/debug_logging/class_notifier.rb
 - lib/debug_logging/configuration.rb
 - lib/debug_logging/instance_logger.rb
 - lib/debug_logging/instance_logger_modulizer.rb
+- lib/debug_logging/instance_notifier.rb
+- lib/debug_logging/instance_notifier_modulizer.rb
+- lib/debug_logging/log_subscriber.rb
 - lib/debug_logging/version.rb
 - lib/simple_debug_logging.rb
 homepage: https://github.com/pboling/debug_logging
@@ -148,15 +203,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Drop-in debug logging useful when a call stack gets unruly