markdown_logging_proxy 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 338dd4aa3a43c7cda534f2b694a44b1347e1ad7434f417aa479dc8bb4daf7f95
-  data.tar.gz: 0bcd6c0fd97df22c18495e5f68a9181a45cd4dc2997c3d2754ba99e4b9678104
+  metadata.gz: 38a597efa8e2dab27f1fe61005c367d1cfbabd2e1ea5a03e03ec1b29d2baab02
+  data.tar.gz: f76c90d59eb9c1a911c6eeb2c3e1e2bb8ec881847d9bf8d9cadb0a53ae3378fc
 SHA512:
-  metadata.gz: 689b425d69ab942947a53913d1ea6b2405d334d76e31bdb25050ed89fe3eb1bc5250f95801a6da1dd7b290b700c6ae62914f3d01d17d7f21ea782135920b6f8e
-  data.tar.gz: 3c67856e0afc5c95b08a1606e0d6d1338e96ee41542e6608deca25c77fe1ea1e758f8ce479c075de5f1de769277716285c56cb0f527c4d1fc2139c2fc8115611
+  metadata.gz: 108a3acc43c38e7a9fad4773a5d2f2b7b9c55e33b1f6280869316affe6d8b48d342ada65cb170865f672a6f1a77f184a171ccdc6720ebe9c41d5bae8af5ed590
+  data.tar.gz: 9a696b09265a340d4934c4874cbe0e0977cd6739768d282f145255b128126cdac879e921de452addffa1b94b980dce0d7039d397babd978a179e70b70c09d5aa

data/CHANGELOG.md

@@ -14,3 +14,22 @@
 
 - Add missing CHANGELOG updates
 - Commit updates to compiled `dist/` version of library
+
+## [1.0.2]
+
+- Improved log formatting
+- Fix to proxy method overwrite behavior
+
+## [1.1.0]
+
+- Don't show object IDs for args arrays. It's confusing.
+- BREAKING: Proxies most `Object` methods by default now
+
+## [1.1.1]
+
+- Allow proxying of `nil`
+- Add require statements to copy+paste version
+
+## [1.2.0]
+
+- Overwrite as many `Object` methods as we can by default

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_logging_proxy (1.0.1)
+    markdown_logging_proxy (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -18,7 +18,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ### Copy+Paste
 
-Look at `dist/` for compiled versions of the gem which can safely (relatively) be copied into irb/pry sessions.
+You can copy the contents of [`dist/markdown_logging_proxy.rb`](dist/markdown_logging_proxy.rb) into a live irb/pry session.
 
 ## Usage
 

data/dist/markdown_logging_proxy.rb

@@ -1,12 +1,21 @@
+require 'logger'
+require 'securerandom'
+require 'pp'
+require 'time'
 module MarkdownLoggingProxy
   class MarkdownLogger
-    def self.inspect_object(object)
-      ['```ruby', object.pretty_inspect.chomp, '```'].join("\n")
+    def self.inspect_object(object, show_id = true)
+      [
+        '```ruby',
+        ("# #{id_object(object)}" if show_id),
+        object.pretty_inspect.chomp,
+        '```'
+      ].compact.join("\n")
     end
 
     def self.id_object(object)
       # #<Object:0x00007f5a0919e140>
-      "##{object.class}:0x#{object.object_id.to_s(16)}>"
+      "`#<#{object.class}:0x#{object.object_id.to_s(16)}>`"
     end
 
     def self.build(location, **options)
@@ -14,9 +23,10 @@ module MarkdownLoggingProxy
       new(location, **options)
     end
 
-    attr_reader :std_logger, :backtrace, :heading_level
+    attr_reader :std_logger, :backtrace, :heading_level, :created_at
 
     def initialize(location, backtrace: true)
+      @created_at = Time.now
       @std_logger = create_logger(location)
       @heading_level = 1
       @backtrace = backtrace
@@ -62,7 +72,8 @@ module MarkdownLoggingProxy
 
     def markdown_formatter
       proc do |severity, time, __exec, msg|
-        "#{'#' * heading_level} #{severity} in #{Process.pid} at #{time.iso8601} -- #{msg}\n\n"
+        elapsed = Time.now - created_at
+        "#{'#' * heading_level} #{severity} at +#{elapsed.round(5)} -- #{msg}\n\n"
       end
     end
   end
@@ -74,14 +85,9 @@ module MarkdownLoggingProxy
   end
 end
 module MarkdownLoggingProxy
-  # frozen_string_literal: true
-
-  require 'logger'
-  require 'securerandom'
-  require 'pp'
-  require 'time'
-
   class Proxy
+    DO_NOT_OVERWRITE = %i[__binding__ __id__ __send__ class extend]
+    DEFAULT_OVERWRITES = Object.new.methods - DO_NOT_OVERWRITE
 
     def initialize(
         to_proxy = nil,
@@ -90,10 +96,9 @@ module MarkdownLoggingProxy
         backtrace: true, # regex/true/false backtrace control
         ignore: [], # methods we shouldn't log/proxy
         proxy_response: [], # methods we should return a proxy for
-        overwrite: [] # methods defined on Object we should overwrite
+        overwrite: DEFAULT_OVERWRITES
       )
       @target = to_proxy || target
-      raise ArgumentError, "Missing required proxy target" unless @target
       @logger = MarkdownLogger.build(location, backtrace: backtrace)
       @tracer = Tracer.new(
         target: @target,
@@ -107,8 +112,8 @@ module MarkdownLoggingProxy
         }
       )
       overwrite.each do |meth|
-        define_method(meth) do |*args, &blk|
-          @traceer.trace(meth, args, &blk)
+        self.class.define_method(meth) do |*args, &blk|
+          @tracer.trace(meth, args, &blk)
         end
       end
     end
@@ -121,7 +126,7 @@ end
 module MarkdownLoggingProxy
   class Tracer
     attr_reader :target, :logger, :ignore, :proxy
-    
+
     def initialize(
         target:,
         proxy:,
@@ -132,7 +137,7 @@ module MarkdownLoggingProxy
       )
       @target = target
       @logger = logger
-      @ignore = (ignore + proxy_response)
+      @ignore = ignore
       @proxy_response = proxy_response
       @proxy_options = proxy_options
     end
@@ -165,9 +170,9 @@ module MarkdownLoggingProxy
 
         Arguments:
 
-        #{MarkdownLogger.inspect_object(args)}
+        #{MarkdownLogger.inspect_object(args, false)}
 
-        Block? #{block_given? ? 'Yes' : 'No'}
+        Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
       MSG
     end
@@ -176,12 +181,14 @@ module MarkdownLoggingProxy
       response = target.public_send(meth, *args, &log_and_proxy_block(meth, blk))
       log_response(meth, response) unless ignore?(meth)
       return response unless proxy_response?(meth)
-      logger.log :info, 3, <<~MSG
+      logger.log :info, 3, <<~MSG.chomp
         Returning proxied response to `#{meth}`
-        
+
         Proxy from `#{meth}` on #{MarkdownLogger.id_object(target)}
-        
-        Proxy for: #{MarkdownLogger.id_object(response)}
+
+        Proxy for:
+
+        #{MarkdownLogger.inspect_object(response)}
       MSG
       Proxy.new(**@proxy_options.merge(
         target: response,
@@ -193,16 +200,18 @@ module MarkdownLoggingProxy
 
     def log_and_proxy_block(meth, blk)
       return if blk.nil?
+      logger_ref = self.logger
+      target_ref = self.target
       proc do |*args|
-        logger.log :info, 3, <<~MSG
-          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target)}
+        logger_ref.log :info, 2, <<~MSG.chomp
+          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target_ref)}
 
           Arguments:
 
-          #{MarkdownLogger.inspect_object(args)}
+          #{MarkdownLogger.inspect_object(args, false)}
         MSG
-        blk.call(*args).tap do |response|
-          logger.log :info, 4, <<~MSG
+        instance_exec(*args, &blk).tap do |response|
+          logger_ref.log :info, 3, <<~MSG.chomp
             Response from block in `#{meth}`
 
             #{MarkdownLogger.inspect_object(response)}
@@ -212,7 +221,7 @@ module MarkdownLoggingProxy
     end
 
     def log_and_reraise_error(meth, error)
-      logger.log :error, 2, <<~MSG
+      logger.log :error, 2, <<~MSG.chomp
         Error in `#{meth}`
 
         Type: #{error.class}
@@ -232,3 +241,4 @@ module MarkdownLoggingProxy
     end
   end
 end
+

data/lib/markdown_logging_proxy/markdown_logger.rb

@@ -1,12 +1,17 @@
 module MarkdownLoggingProxy
   class MarkdownLogger
-    def self.inspect_object(object)
-      ['```ruby', object.pretty_inspect.chomp, '```'].join("\n")
+    def self.inspect_object(object, show_id = true)
+      [
+        '```ruby',
+        ("# #{id_object(object)}" if show_id),
+        object.pretty_inspect.chomp,
+        '```'
+      ].compact.join("\n")
     end
 
     def self.id_object(object)
       # #<Object:0x00007f5a0919e140>
-      "##{object.class}:0x#{object.object_id.to_s(16)}>"
+      "`#<#{object.class}:0x#{object.object_id.to_s(16)}>`"
     end
 
     def self.build(location, **options)
@@ -14,9 +19,10 @@ module MarkdownLoggingProxy
       new(location, **options)
     end
 
-    attr_reader :std_logger, :backtrace, :heading_level
+    attr_reader :std_logger, :backtrace, :heading_level, :created_at
 
     def initialize(location, backtrace: true)
+      @created_at = Time.now
       @std_logger = create_logger(location)
       @heading_level = 1
       @backtrace = backtrace
@@ -62,7 +68,8 @@ module MarkdownLoggingProxy
 
     def markdown_formatter
       proc do |severity, time, __exec, msg|
-        "#{'#' * heading_level} #{severity} in #{Process.pid} at #{time.iso8601} -- #{msg}\n\n"
+        elapsed = Time.now - created_at
+        "#{'#' * heading_level} #{severity} at +#{elapsed.round(5)} -- #{msg}\n\n"
       end
     end
   end

data/lib/markdown_logging_proxy/proxy.rb

@@ -1,12 +1,7 @@
 module MarkdownLoggingProxy
-  # frozen_string_literal: true
-
-  require 'logger'
-  require 'securerandom'
-  require 'pp'
-  require 'time'
-
   class Proxy
+    DO_NOT_OVERWRITE = %i[__binding__ __id__ __send__ class extend]
+    DEFAULT_OVERWRITES = Object.new.methods - DO_NOT_OVERWRITE
 
     def initialize(
         to_proxy = nil,
@@ -15,10 +10,9 @@ module MarkdownLoggingProxy
         backtrace: true, # regex/true/false backtrace control
         ignore: [], # methods we shouldn't log/proxy
         proxy_response: [], # methods we should return a proxy for
-        overwrite: [] # methods defined on Object we should overwrite
+        overwrite: DEFAULT_OVERWRITES
       )
       @target = to_proxy || target
-      raise ArgumentError, "Missing required proxy target" unless @target
       @logger = MarkdownLogger.build(location, backtrace: backtrace)
       @tracer = Tracer.new(
         target: @target,
@@ -32,8 +26,8 @@ module MarkdownLoggingProxy
         }
       )
       overwrite.each do |meth|
-        define_method(meth) do |*args, &blk|
-          @traceer.trace(meth, args, &blk)
+        self.class.define_method(meth) do |*args, &blk|
+          @tracer.trace(meth, args, &blk)
         end
       end
     end

data/lib/markdown_logging_proxy/tracer.rb

@@ -1,7 +1,7 @@
 module MarkdownLoggingProxy
   class Tracer
     attr_reader :target, :logger, :ignore, :proxy
-    
+
     def initialize(
         target:,
         proxy:,
@@ -12,7 +12,7 @@ module MarkdownLoggingProxy
       )
       @target = target
       @logger = logger
-      @ignore = (ignore + proxy_response)
+      @ignore = ignore
       @proxy_response = proxy_response
       @proxy_options = proxy_options
     end
@@ -45,9 +45,9 @@ module MarkdownLoggingProxy
 
         Arguments:
 
-        #{MarkdownLogger.inspect_object(args)}
+        #{MarkdownLogger.inspect_object(args, false)}
 
-        Block? #{block_given? ? 'Yes' : 'No'}
+        Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
       MSG
     end
@@ -56,12 +56,14 @@ module MarkdownLoggingProxy
       response = target.public_send(meth, *args, &log_and_proxy_block(meth, blk))
       log_response(meth, response) unless ignore?(meth)
       return response unless proxy_response?(meth)
-      logger.log :info, 3, <<~MSG
+      logger.log :info, 3, <<~MSG.chomp
         Returning proxied response to `#{meth}`
-        
+
         Proxy from `#{meth}` on #{MarkdownLogger.id_object(target)}
-        
-        Proxy for: #{MarkdownLogger.id_object(response)}
+
+        Proxy for:
+
+        #{MarkdownLogger.inspect_object(response)}
       MSG
       Proxy.new(**@proxy_options.merge(
         target: response,
@@ -73,16 +75,18 @@ module MarkdownLoggingProxy
 
     def log_and_proxy_block(meth, blk)
       return if blk.nil?
+      logger_ref = self.logger
+      target_ref = self.target
       proc do |*args|
-        logger.log :info, 3, <<~MSG
-          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target)}
+        logger_ref.log :info, 2, <<~MSG.chomp
+          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target_ref)}
 
           Arguments:
 
-          #{MarkdownLogger.inspect_object(args)}
+          #{MarkdownLogger.inspect_object(args, false)}
         MSG
-        blk.call(*args).tap do |response|
-          logger.log :info, 4, <<~MSG
+        instance_exec(*args, &blk).tap do |response|
+          logger_ref.log :info, 3, <<~MSG.chomp
             Response from block in `#{meth}`
 
             #{MarkdownLogger.inspect_object(response)}
@@ -92,7 +96,7 @@ module MarkdownLoggingProxy
     end
 
     def log_and_reraise_error(meth, error)
-      logger.log :error, 2, <<~MSG
+      logger.log :error, 2, <<~MSG.chomp
         Error in `#{meth}`
 
         Type: #{error.class}

data/markdown_logging_proxy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "markdown_logging_proxy"
-  spec.version = "1.0.1"
+  spec.version = "1.2.0"
   spec.authors = ["Carl Zulauf"]
   spec.email = ["carl@linkleaf.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown_logging_proxy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Carl Zulauf
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Proxy object for debugging