markdown_logging_proxy 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b7fa845a8bab9f3a70e7362c0910ff5b24c6bc95d5267e82e8d4f87f90fa2e3
-  data.tar.gz: 0c26ee702af858bc046077ebf4209f473c50e66ee14e03f45da161f1990b510a
+  metadata.gz: 215b4bc73f85cdb7ec9bfa2e3ef3b1efefa55a9d99c34f36007788c798dcbcc0
+  data.tar.gz: 391123e09db062038d9e4e4ef3aa2a98f15dc07a7727ede676d6a51d7c5cf532
 SHA512:
-  metadata.gz: 6ac27cf32075e6046405f21bec1d4bae709c9a3e91b40b461a53b8a5794ff25165efe4295183a9a0f58a1f8686a15d08b0424e79f87355887967338c85e00526
-  data.tar.gz: 927d9792258911a98117c6915288b13bb05a6596257a38504adf24d1439aa972e71868c8895ab1cd0d5afbb8e4910e463948bb0bd11cbf0e29544fc66b04685d
+  metadata.gz: 3119ffa9798cf92d8010df9d20738eaf1c7e782de72b40709aba08066270811b31b119ada4ba977e4af67fc5f37da6d455a01afd81ab0a8a62fe944587323c58
+  data.tar.gz: 6171e82b3677b73c9fa83753a9a21927625427a344b77e07f6285f5090bc1eff156c51504f74310a33bf7fef1bd36bfab4c191423369715b0427d7018b0a475e

data/CHANGELOG.md

@@ -24,3 +24,16 @@
 
 - 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
+
+## [1.3.0]
+
+- Add `inspect_method` configuration option

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_logging_proxy (1.1.0)
+    markdown_logging_proxy (1.3.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,19 +1,9 @@
+require 'logger'
+require 'securerandom'
+require 'pp'
+require 'time'
 module MarkdownLoggingProxy
   class MarkdownLogger
-    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)}>`"
-    end
-
     def self.build(location, **options)
       return location if location.is_a?(MarkdownLogger)
       new(location, **options)
@@ -81,38 +71,27 @@ module MarkdownLoggingProxy
   end
 end
 module MarkdownLoggingProxy
-  # frozen_string_literal: true
-
-  require 'logger'
-  require 'securerandom'
-  require 'pp'
-  require 'time'
-
   class Proxy
-    # Object methods that should be proxied but won't hit method_missing
-    DEFAULT_OVERWRITES = %i[
-      ! != !~ <=> == === =~
-      clone display dup enum_for eql? equal? freeze frozen? hash inspect
-      is_a? itself kind_of? nil? taint tainted? tap then to_enum to_s
-      trust untaint unstrust untrusted? yield_self
-    ]
+    DO_NOT_OVERWRITE = %i[__binding__ __id__ __send__ class extend]
+    DEFAULT_OVERWRITES = Object.new.methods - DO_NOT_OVERWRITE
 
     def initialize(
         to_proxy = nil,
         target: nil,
         location: STDOUT,
         backtrace: true, # regex/true/false backtrace control
+        inspect_method: :pretty_inspect,
         ignore: [], # methods we shouldn't log/proxy
         proxy_response: [], # methods we should return a proxy for
         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,
         proxy: self,
         logger: @logger,
+        inspect_method: inspect_method,
         ignore: ignore,
         proxy_response: proxy_response,
         proxy_options: {
@@ -134,18 +113,20 @@ module MarkdownLoggingProxy
 end
 module MarkdownLoggingProxy
   class Tracer
-    attr_reader :target, :logger, :ignore, :proxy
+    attr_reader :target, :logger, :ignore, :proxy, :inspect_method
 
     def initialize(
         target:,
         proxy:,
         logger: nil,
+        inspect_method: :pretty_inspect,
         ignore: [],
         proxy_response: [],
         proxy_options: {}
       )
       @target = target
       @logger = logger
+      @inspect_method = inspect_method
       @ignore = ignore
       @proxy_response = proxy_response
       @proxy_options = proxy_options
@@ -170,16 +151,36 @@ module MarkdownLoggingProxy
       @ignore.member?(meth)
     end
 
+    def inspect_object(obj, show_id: true)
+      obj_str =
+        case inspect_method
+        when :inspect then obj.inspect
+        when :object_id then object_id(obj)
+        when :pretty_inpect
+          [obj.pretty_inspect.chomp].tap do |lines|
+            lines.prepend "# #{object_id(obj)}" if show_id
+          end.join("\n")
+        else
+          obj.send(inspect_method)
+        end
+      ['```ruby', obj_str, '```'].join("\n")
+    end
+
+    def id_object(object)
+      # #<Object:0xe140>
+      "`#<#{object.class}:0x#{object.object_id.to_s(16)}>`"
+    end
+
     private
 
     def log_call_signature(meth, args, &blk)
       return if ignore.member?(meth)
       logger.log :info, 1, <<~MSG.chomp
-        Calling `#{meth}` on #{MarkdownLogger.id_object(target)}
+        Calling `#{meth}` on #{id_object(target)}
 
         Arguments:
 
-        #{MarkdownLogger.inspect_object(args, false)}
+        #{inspect_object(args, show_id: false)}
 
         Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
@@ -193,15 +194,16 @@ module MarkdownLoggingProxy
       logger.log :info, 3, <<~MSG.chomp
         Returning proxied response to `#{meth}`
 
-        Proxy from `#{meth}` on #{MarkdownLogger.id_object(target)}
+        Proxy from `#{meth}` on #{id_object(target)}
 
         Proxy for:
 
-        #{MarkdownLogger.inspect_object(response)}
+        #{inspect_object(response)}
       MSG
       Proxy.new(**@proxy_options.merge(
         target: response,
         location: logger,
+        inspect_method: inspect_method,
         proxy_response: @proxy_response,
         ignore: @ignore,
       ))
@@ -209,19 +211,20 @@ module MarkdownLoggingProxy
 
     def log_and_proxy_block(meth, blk)
       return if blk.nil?
+      tracer = self
       proc do |*args|
-        logger.log :info, 2, <<~MSG.chomp
-          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target)}
+        tracer.logger.log :info, 2, <<~MSG.chomp
+          Yield to block in `#{meth}` on #{tracer.id_object(tracer.target)}
 
           Arguments:
 
-          #{MarkdownLogger.inspect_object(args, false)}
+          #{tracer.inspect_object(args, show_id: false)}
         MSG
-        blk.call(*args).tap do |response|
-          logger.log :info, 3, <<~MSG.chomp
+        instance_exec(*args, &blk).tap do |response|
+          tracer.logger.log :info, 3, <<~MSG.chomp
             Response from block in `#{meth}`
 
-            #{MarkdownLogger.inspect_object(response)}
+            #{tracer.inspect_object(response)}
           MSG
         end
       end
@@ -233,7 +236,7 @@ module MarkdownLoggingProxy
 
         Type: #{error.class}
 
-        #{MarkdownLogger.inspect_object(error)}
+        #{inspect_object(error)}
       MSG
       raise error
     end
@@ -243,8 +246,9 @@ module MarkdownLoggingProxy
       logger.log :info, 2, <<~MSG.chomp
         `#{meth}` response
 
-        #{MarkdownLogger.inspect_object(response)}
+        #{inspect_object(response)}
       MSG
     end
   end
 end
+

data/lib/markdown_logging_proxy/markdown_logger.rb

@@ -1,19 +1,5 @@
 module MarkdownLoggingProxy
   class MarkdownLogger
-    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)}>`"
-    end
-
     def self.build(location, **options)
       return location if location.is_a?(MarkdownLogger)
       new(location, **options)

data/lib/markdown_logging_proxy/proxy.rb

@@ -1,36 +1,25 @@
 module MarkdownLoggingProxy
-  # frozen_string_literal: true
-
-  require 'logger'
-  require 'securerandom'
-  require 'pp'
-  require 'time'
-
   class Proxy
-    # Object methods that should be proxied but won't hit method_missing
-    DEFAULT_OVERWRITES = %i[
-      ! != !~ <=> == === =~
-      clone display dup enum_for eql? equal? freeze frozen? hash inspect
-      is_a? itself kind_of? nil? taint tainted? tap then to_enum to_s
-      trust untaint unstrust untrusted? yield_self
-    ]
+    DO_NOT_OVERWRITE = %i[__binding__ __id__ __send__ class extend]
+    DEFAULT_OVERWRITES = Object.new.methods - DO_NOT_OVERWRITE
 
     def initialize(
         to_proxy = nil,
         target: nil,
         location: STDOUT,
         backtrace: true, # regex/true/false backtrace control
+        inspect_method: :pretty_inspect,
         ignore: [], # methods we shouldn't log/proxy
         proxy_response: [], # methods we should return a proxy for
         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,
         proxy: self,
         logger: @logger,
+        inspect_method: inspect_method,
         ignore: ignore,
         proxy_response: proxy_response,
         proxy_options: {

data/lib/markdown_logging_proxy/tracer.rb

@@ -1,17 +1,19 @@
 module MarkdownLoggingProxy
   class Tracer
-    attr_reader :target, :logger, :ignore, :proxy
+    attr_reader :target, :logger, :ignore, :proxy, :inspect_method
 
     def initialize(
         target:,
         proxy:,
         logger: nil,
+        inspect_method: :pretty_inspect,
         ignore: [],
         proxy_response: [],
         proxy_options: {}
       )
       @target = target
       @logger = logger
+      @inspect_method = inspect_method
       @ignore = ignore
       @proxy_response = proxy_response
       @proxy_options = proxy_options
@@ -36,16 +38,36 @@ module MarkdownLoggingProxy
       @ignore.member?(meth)
     end
 
+    def inspect_object(obj, show_id: true)
+      obj_str =
+        case inspect_method
+        when :inspect then obj.inspect
+        when :object_id then object_id(obj)
+        when :pretty_inpect
+          [obj.pretty_inspect.chomp].tap do |lines|
+            lines.prepend "# #{object_id(obj)}" if show_id
+          end.join("\n")
+        else
+          obj.send(inspect_method)
+        end
+      ['```ruby', obj_str, '```'].join("\n")
+    end
+
+    def id_object(object)
+      # #<Object:0xe140>
+      "`#<#{object.class}:0x#{object.object_id.to_s(16)}>`"
+    end
+
     private
 
     def log_call_signature(meth, args, &blk)
       return if ignore.member?(meth)
       logger.log :info, 1, <<~MSG.chomp
-        Calling `#{meth}` on #{MarkdownLogger.id_object(target)}
+        Calling `#{meth}` on #{id_object(target)}
 
         Arguments:
 
-        #{MarkdownLogger.inspect_object(args, false)}
+        #{inspect_object(args, show_id: false)}
 
         Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
@@ -59,15 +81,16 @@ module MarkdownLoggingProxy
       logger.log :info, 3, <<~MSG.chomp
         Returning proxied response to `#{meth}`
 
-        Proxy from `#{meth}` on #{MarkdownLogger.id_object(target)}
+        Proxy from `#{meth}` on #{id_object(target)}
 
         Proxy for:
 
-        #{MarkdownLogger.inspect_object(response)}
+        #{inspect_object(response)}
       MSG
       Proxy.new(**@proxy_options.merge(
         target: response,
         location: logger,
+        inspect_method: inspect_method,
         proxy_response: @proxy_response,
         ignore: @ignore,
       ))
@@ -75,19 +98,20 @@ module MarkdownLoggingProxy
 
     def log_and_proxy_block(meth, blk)
       return if blk.nil?
+      tracer = self
       proc do |*args|
-        logger.log :info, 2, <<~MSG.chomp
-          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target)}
+        tracer.logger.log :info, 2, <<~MSG.chomp
+          Yield to block in `#{meth}` on #{tracer.id_object(tracer.target)}
 
           Arguments:
 
-          #{MarkdownLogger.inspect_object(args, false)}
+          #{tracer.inspect_object(args, show_id: false)}
         MSG
-        blk.call(*args).tap do |response|
-          logger.log :info, 3, <<~MSG.chomp
+        instance_exec(*args, &blk).tap do |response|
+          tracer.logger.log :info, 3, <<~MSG.chomp
             Response from block in `#{meth}`
 
-            #{MarkdownLogger.inspect_object(response)}
+            #{tracer.inspect_object(response)}
           MSG
         end
       end
@@ -99,7 +123,7 @@ module MarkdownLoggingProxy
 
         Type: #{error.class}
 
-        #{MarkdownLogger.inspect_object(error)}
+        #{inspect_object(error)}
       MSG
       raise error
     end
@@ -109,7 +133,7 @@ module MarkdownLoggingProxy
       logger.log :info, 2, <<~MSG.chomp
         `#{meth}` response
 
-        #{MarkdownLogger.inspect_object(response)}
+        #{inspect_object(response)}
       MSG
     end
   end

data/markdown_logging_proxy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "markdown_logging_proxy"
-  spec.version = "1.1.0"
+  spec.version = "1.3.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.1.0
+  version: 1.3.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