debug_logging 3.1.9 → 4.0.1

data/lib/debug_logging/log_subscriber.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "active_support"
 require "active_support/log_subscriber"
 
@@ -34,8 +32,8 @@ module DebugLogging
       {
         name: event.name,
         duration: Rational(event.duration, 1000).to_f,
-        time: debug_time_to_s(event.time),
-        end: debug_time_to_s(event.end),
+        time: debug_event_time_to_s(event.time),
+        end: debug_event_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),
       }

data/lib/debug_logging/util.rb

@@ -2,6 +2,20 @@ module DebugLogging
   module Util
     module_function
 
+    def debug_time(time_or_monotonic)
+      case time_or_monotonic
+      when Time, DateTime
+        time_or_monotonic
+      when Numeric
+        Time.at(time_or_monotonic)
+      when String
+        Time.parse(time_or_monotonic)
+      else
+        # Garbage in, Sweet Nourishing Gruel Out
+        Time.now
+      end
+    end
+
     # methods_to_log may be an array of a single method name, followed by config options and payload,
     #   or it could be an array of method names followed by config options and payload to be shared by the whole set.
     def extract_payload_and_config(method_names:, payload: nil, config: nil)
@@ -14,6 +28,7 @@ module DebugLogging
         scoped_payload
       end
       config_opts = config&.clone(freeze: false) || {}
+      # puts "[EPAC] config: #{config}, scoped_payload: #{scoped_payload}, payload: #{payload}, config_opts: #{config_opts}"
       unless payload.empty?
         DebugLogging::Configuration::CONFIG_KEYS.each { |k| config_opts[k] = payload.delete(k) if payload.key?(k) }
       end
@@ -35,6 +50,8 @@ module DebugLogging
             # logged :meth1, :meth2, :meth3 without options is valid
             method_names
           end
+        else
+          raise ArgumentError, "unknown type for method_names: #{method_names.class}"
         end
       [method_names, payload, config_opts]
     end

data/lib/debug_logging/version.rb

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

data/lib/debug_logging.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Std Lib
 require "logger"
 require "digest"
@@ -44,7 +42,8 @@ require "debug_logging/class_logger"
 #
 #       # For instance methods:
 #       # Option 1: specify the exact method(s) to add logging to
-#       include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
+#       extend DebugLogging::InstanceLogger
+#       i_logged [:drive, :stop]
 #
 #       # Provides the `logged` method decorator
 #       extend DebugLogging::ClassLogger
@@ -59,7 +58,8 @@ 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))
+#       extend DebugLogging::InstanceLogger
+#       i_logged instance_methods(false)
 #
 #       def will_not_be_logged; false; end
 #
@@ -68,29 +68,36 @@ 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))
+  # We can't compare with nil to check for no arguments passed as a configuration value,
+  #   because nil can be an argument passed, hence:
+  ACTUAL_NOTHING = Object.new
+
+  class << self
+    def extended(base)
+      base.send(:extend, ArgumentPrinter)
+      base.send(:include, 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
-  end
 
-  #### API ####
+    #### API ####
 
-  # For single statement global config in an initializer
-  # e.g. DebugLogging.configuration.ellipsis = "..."
-  def self.configuration
-    self.debug_logging_configuration ||= Configuration.new
-  end
+    # For single statement global config in an initializer
+    # e.g. DebugLogging.configuration.ellipsis = "..."
+    def configuration
+      self.debug_logging_configuration ||= Configuration.new
+    end
 
-  # For global config in an initializer with a block
-  def self.configure
-    yield(configuration)
+    # For global config in an initializer with a block
+    def configure
+      yield(configuration)
+    end
   end
 
   module ApiClassMethods
@@ -226,6 +233,22 @@ module DebugLogging
       @debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
     end
 
+    def debug_add_timestamp
+      @debug_logging_configuration.add_timestamp
+    end
+
+    def debug_add_timestamp=(add_timestamp)
+      @debug_logging_configuration.add_timestamp = add_timestamp
+    end
+
+    def debug_time_formatter_proc
+      @debug_logging_configuration.time_formatter_proc
+    end
+
+    def debug_time_formatter_proc=(time_formatter_proc)
+      @debug_logging_configuration.time_formatter_proc = time_formatter_proc
+    end
+
     def debug_add_invocation_id
       @debug_logging_configuration.add_invocation_id
     end

data/lib/simple_debug_logging.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Simpler version of what the sibling DebugLogging library does.  Included as a bauble.
 #
 ############# THIS IS A BAUBLE
@@ -57,11 +55,11 @@ 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
-            puts "#{self}.#{method_to_log} ~#{args.hash}~ complete in #{elapsed}s#{invocation_id}"
+            puts "#{self}::#{method_to_log} ~#{args.hash}~ complete in #{elapsed}s#{invocation_id}"
             method_return_value
           end
         end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 3.1.9
+  version: 4.0.1
 platform: ruby
 authors:
 - Peter Boling
-- 'John '
+- John Gillson
 - guckin
 autorequire:
 bindir: exe
@@ -38,7 +38,7 @@ cert_chain:
   KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
   pF8dMA==
   -----END CERTIFICATE-----
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -68,20 +68,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.4.4
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,20 +156,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '22.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.1.1
+        version: 22.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '22.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.1.1
+        version: 22.1.3
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +290,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENSE.txt
 - README.md
@@ -331,10 +319,10 @@ licenses:
 - MIT
 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
+  source_code_uri: https://github.com/pboling/debug_logging/tree/v4.0.1
+  changelog_uri: https://github.com/pboling/debug_logging/blob/v4.0.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/debug_logging/issues
-  documentation_uri: https://www.rubydoc.info/gems/debug_logging/3.1.9
+  documentation_uri: https://www.rubydoc.info/gems/debug_logging/4.0.1
   wiki_uri: https://github.com/pboling/debug_logging/wiki
   funding_uri: https://liberapay.com/pboling
   rubygems_mfa_required: 'true'
@@ -346,17 +334,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Drop-in debug logging useful when a call stack gets unruly