debug_logging 3.1.8 → 3.1.9

data/lib/debug_logging/instance_notifier_modulizer.rb

@@ -7,43 +7,47 @@ module DebugLogging
         methods_to_notify, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
           method_names: Array(methods_to_notify),
           payload: payload,
-          config: config
+          config: config,
         )
         Array(methods_to_notify).each do |method_to_notify|
           method_to_notify, method_payload, method_config_opts = DebugLogging::Util.extract_payload_and_config(
             method_names: method_to_notify,
             payload: payload,
-            config: config_opts
+            config: config_opts,
           )
           define_method(method_to_notify) do |*args, &block|
             config_proxy = DebugLogging::Util.config_proxy_finder(
               scope: self.class,
               config_opts: method_config_opts,
               method_name: method_to_notify,
-              proxy_ref: 'inm'
+              proxy_ref: "inm",
             ) do |config_proxy|
               ActiveSupport::Notifications.subscribe(
-                DebugLogging::ArgumentPrinter.debug_event_name_to_s(method_to_notify: method_to_notify)
+                DebugLogging::ArgumentPrinter.debug_event_name_to_s(method_to_notify: method_to_notify),
               ) do |*args|
                 config_proxy&.log do
                   DebugLogging::LogSubscriber.log_event(ActiveSupport::Notifications::Event.new(*args))
                 end
               end
             end
-            paydirt = DebugLogging::Util.payload_instance_vaiable_hydration(scope: self, payload: method_payload)
+            paydirt = DebugLogging::Util.payload_instance_variable_hydration(scope: self, payload: method_payload)
             ActiveSupport::Notifications.instrument(
               DebugLogging::ArgumentPrinter.debug_event_name_to_s(method_to_notify: method_to_notify),
               debug_args: args,
               config_proxy: config_proxy,
-              **paydirt
+              **paydirt,
             ) do
               begin
+                # TODO: I need to split logic based on Ruby version.
+                # TODO: Use VersionGem's minimum Ruby version check
+                # TODO: Switch between positional, and kwargs argument handling
+                # See: https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
                 super(*args, &block)
-              rescue => error
+              rescue StandardError => e
                 if config_proxy.error_handler_proc
-                  config_proxy.error_handler_proc.call(config_proxy, error, self, method_to_notify, args)
+                  config_proxy.error_handler_proc.call(config_proxy, e, self, method_to_notify, args)
                 else
-                  raise error
+                  raise e
                 end
               end
             end

data/lib/debug_logging/log_subscriber.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'active_support/log_subscriber'
+require "active_support"
+require "active_support/log_subscriber"
 
 module DebugLogging
   class LogSubscriber < ActiveSupport::LogSubscriber
@@ -12,7 +13,7 @@ module DebugLogging
     end
     attach_to :log
 
-    EVENT_FORMAT_STRING = '%<name>s (%<duration>.3f secs) start=%<time>s end=%<end>s args=%<args>s payload=%<payload>s'
+    EVENT_FORMAT_STRING = "%<name>s (%<duration>.3f secs) start=%<time>s end=%<end>s args=%<args>s payload=%<payload>s"
 
     def self.log_event(event)
       @event = event
@@ -33,10 +34,10 @@ module DebugLogging
       {
         name: event.name,
         duration: Rational(event.duration, 1000).to_f,
-        time: event.time,
-        end: event.end,
+        time: debug_time_to_s(event.time),
+        end: debug_time_to_s(event.end),
         args: debug_signature_to_s(args: args, config_proxy: config_proxy),
-        payload: debug_payload_to_s(payload: payload, config_proxy: config_proxy)
+        payload: debug_payload_to_s(payload: payload, config_proxy: config_proxy),
       }
     end
   end

data/lib/debug_logging/util.rb

@@ -9,10 +9,10 @@ module DebugLogging
       # When scoped config is not present it will reuse the class' configuration object
       scoped_payload = (method_names.is_a?(Array) && method_names.last.is_a?(Hash) && method_names.pop.clone(freeze: false)) || {}
       payload = if payload
-                  payload.merge(scoped_payload)
-                else
-                  scoped_payload
-                end
+        payload.merge(scoped_payload)
+      else
+        scoped_payload
+      end
       config_opts = config&.clone(freeze: false) || {}
       unless payload.empty?
         DebugLogging::Configuration::CONFIG_KEYS.each { |k| config_opts[k] = payload.delete(k) if payload.key?(k) }
@@ -39,7 +39,7 @@ module DebugLogging
       [method_names, payload, config_opts]
     end
 
-    def payload_instance_vaiable_hydration(scope:, payload:)
+    def payload_instance_variable_hydration(scope:, payload:)
       paydirt = {}
       # TODO: Could make instance variable introspection configurable before or after method execution
       if payload.key?(:instance_variables)
@@ -54,19 +54,24 @@ module DebugLogging
     end
 
     def config_proxy_finder(scope:, method_name:, proxy_ref:, config_opts: {}, &block)
-      if (proxy = scope.send(:instance_variable_get, DebugLogging::Configuration.config_pointer(proxy_ref,
-                                                                                                method_name)))
+      if (proxy = scope.send(:instance_variable_get, DebugLogging::Configuration.config_pointer(
+        proxy_ref,
+        method_name,
+      )))
         proxy
       else
         base = scope.respond_to?(:debug_config) ? scope.debug_config : DebugLogging.debug_logging_configuration
         proxy = if config_opts.empty?
-                  base
-                else
-                  DebugLogging::Configuration.new(**base.to_hash.merge(config_opts))
-                end
+          base
+        else
+          DebugLogging::Configuration.new(**base.to_hash.merge(config_opts))
+        end
         proxy.register(method_name)
-        scope.send(:instance_variable_set, DebugLogging::Configuration.config_pointer(proxy_ref, method_name),
-                   proxy)
+        scope.send(
+          :instance_variable_set,
+          DebugLogging::Configuration.config_pointer(proxy_ref, method_name),
+          proxy,
+        )
         yield proxy if block
         proxy
       end

data/lib/debug_logging/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module DebugLogging
-  VERSION = '3.1.8'
+  module Version
+    VERSION = "3.1.9"
+  end
 end

data/lib/debug_logging.rb

@@ -1,20 +1,25 @@
 # frozen_string_literal: true
 
-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'
+# Std Lib
+require "logger"
+require "digest"
+
+# External gems
+require "version_gem"
+require "colorized_string"
+
+# This gem
+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"
 
 ####################
 #                  #
@@ -272,3 +277,7 @@ module DebugLogging
 
   self.debug_logging_configuration = Configuration.new # setup defaults
 end
+
+DebugLogging::Version.class_eval do
+  extend VersionGem::Basic
+end

data/lib/simple_debug_logging.rb

@@ -35,7 +35,7 @@
 # NOTE: The instance method manner of logging works on Ruby 2.0+
 # NOTE: The class method manner of logging works on Ruby 2.1+
 
-require 'benchmark'
+require "benchmark"
 
 class SimpleDebugLogging < Module
   def initialize(i_methods: nil)
@@ -57,7 +57,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(&: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
@@ -76,7 +76,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(&: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,15 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.1.9
 platform: ruby
 authors:
 - Peter Boling
+- 'John '
 - guckin
 autorequire:
 bindir: exe
-cert_chain: []
-date: 2020-12-19 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
+  ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0yMzA5MjAxNzMwMjhaFw0yNDA5MTkxNzMwMjhaMEMxFTATBgNVBAMM
+  DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA+a9UvHo3
+  84k96WgU5Kk5HB+cLZs/modjorsTfqY67MJF5nNvAoqcKTUBW4uG+Zpfnm3jaDO5
+  GxhJEIZWfndYzycHT2KMVQ1uTP82ba8ZaKrPlPIafkbui3mdds47qsmqHiblKERg
+  U532lkwfqHDlJwE7OBZQ59EwWWLynlT/yAUHpOBbqIuHKUxdpmBI+sIjrZcD1e05
+  WmjkO6fwIdC5oM757aoPxIgXD587VOViH11Vkm2doskj4T8yONtwVHlcrrhJ9Bzd
+  /zdp6vEn7GZQrABvpOlqwWxQ72ZnFhJe/RJZf6CXOPOh69Ai0QKYl2a1sYuCJKS3
+  nsBnxXJINEEznjR7rZjNUmYD+CZqfjzgPqedRxTlASe7iA4w7xZOqMDzcuhNwcUQ
+  tMEH6BTktxKP3jXZPXRfHCf6s+HRVb6vezAonTBVyydf5Xp5VwWkd6cwm+2BzHl5
+  7kc/3lLxKMcsyEUprAsk8LdHohwZdC267l+RS++AP6Cz6x+nB3oGob19AgMBAAGj
+  fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQCSSas60GqqMjt
+  xR7LoY1gucEvtzAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
+  A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
+  ggGBAMl9ifcw5p+PdvB7dCPoNKoVdp/2LbC9ztETHuYL2gUMJB6UoS3o9c/piSuR
+  V3ZMQaijmNu6ms1bWAtJ66LjmYrVflJtf9yp31Kierr9LpisMSUx2qbMOHGa8d2Z
+  vCUWPF8E9Cg0mP3GAyZ6qql8jDh/anUKeksPXqJvNxNPDu2DVYsa/IWdl96whzS4
+  Bl7SwB1E7agps40UcshCSKaVDOU0M+XN6SrnJMElnBic+KSAkBkVFbzS0BE4ODZM
+  BgE6nYzQ05qhuvbE+oGdACTlemNtDDWCh0uw+7x0q2PocGIDU5zsPn/WNTkCXPmB
+  CHGvqDNWq4M7ncTKAaS2XExgyb7uPdq9fKiOW8nmH+zCiGzJXzBWwZlKf7L4Ht9E
+  a3f0e5C+zvee9Z5Ng9ciyfav9/fcXgYt5MjoBv27THr5XfBhgOCIHSYW2tqJmWKi
+  KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
+  pF8dMA==
+  -----END CERTIFICATE-----
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -29,9 +58,6 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.4
@@ -39,152 +65,221 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.4
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '11'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: kettle-soup-cover
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: 1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13'
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rspec-pending_for
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.34
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard-junk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-md
+  name: rubocop-lts
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.1.1
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rspec-block_is_expected
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-pending_for
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: silent_stream
   requirement: !ruby/object:Gem::Requirement
@@ -209,18 +304,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
-- Gemfile
+- CONTRIBUTING.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- debug_logging.gemspec
+- SECURITY.md
 - lib/debug_logging.rb
 - lib/debug_logging/active_support_notifications.rb
 - lib/debug_logging/argument_printer.rb
@@ -242,7 +329,15 @@ files:
 homepage: https://github.com/pboling/debug_logging
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/pboling/debug_logging
+  source_code_uri: https://github.com/pboling/debug_logging/tree/v3.1.9
+  changelog_uri: https://github.com/pboling/debug_logging/blob/v3.1.9/CHANGELOG.md
+  bug_tracker_uri: https://github.com/pboling/debug_logging/issues
+  documentation_uri: https://www.rubydoc.info/gems/debug_logging/3.1.9
+  wiki_uri: https://github.com/pboling/debug_logging/wiki
+  funding_uri: https://liberapay.com/pboling
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -251,14 +346,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.1
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Drop-in debug logging useful when a call stack gets unruly

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.byebug_history

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color