markdown_logging_proxy 1.1.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aff578739daa97caef0a7014bf062fe113a495cc124da496f6a08d8c31790e49
-  data.tar.gz: 560c9efb88be9083d5d91b46a174c8b5c26c5c0b30289776c80f937b9ee81b1b
+  metadata.gz: e893add5ca96b98f32be5370fb7bfc61e3f80f387392359b4c8e25f9d7e1ca45
+  data.tar.gz: 37dd7b894552ba38329279dcb2c8ef23961ca719c23ba1f7a5343e0e1c365c89
 SHA512:
-  metadata.gz: aa0ff0ff2637a3bd8eb9141cd6200e763478d071859958a07ca6585a2405fcce83160a9b03c49a88afa7f11428d3ed50bc4b3cde944bf96060c820b253406d20
-  data.tar.gz: 45f2d7f82f0e7d366857b8da7ab7a6397e582190969155013facd87a5ae66c7c441f006486fee4cfe9b388538d614eaa60c533f478ec4a7165f9038031e31dcb
+  metadata.gz: fd08c3cecf05ef6173ae54c8cd9885e2817c94c141fd3c168c1a04f79f9c267e9fbaebb164cf00ba6670125f4dafd0135a47d39b758b11b043feabf851bf9e8d
+  data.tar.gz: '096efff296da1406507b5f2a5531bbf267324a4b53c27ce7ced1b05f85e59b223480e5cb21838b658937a00093cad8e2d961f1c6727a48e85bf3ecf06a9797bb'

data/CHANGELOG.md

@@ -29,3 +29,16 @@
 
 - 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
+
+## [1.3.1]
+
+- Object inspection improvements and fixes
+- Implement `inspect_method: :limited` configuration option

data/Gemfile.lock

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

data/dist/markdown_logging_proxy.rb

@@ -4,20 +4,6 @@ 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)
@@ -86,19 +72,15 @@ module MarkdownLoggingProxy
 end
 module MarkdownLoggingProxy
   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
@@ -109,6 +91,7 @@ module MarkdownLoggingProxy
         target: @target,
         proxy: self,
         logger: @logger,
+        inspect_method: inspect_method,
         ignore: ignore,
         proxy_response: proxy_response,
         proxy_options: {
@@ -130,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
@@ -166,16 +151,64 @@ module MarkdownLoggingProxy
       @ignore.member?(meth)
     end
 
+    def inspect_object(obj, args: false)
+      obj_str =
+        case inspect_method
+        when :inspect then obj.inspect
+        when :limited then limited_inspect(obj)
+        when :id_object
+          if args
+            "[#{obj.map { |o| id_object(o) }.join(',')}]"
+          else
+            id_object(obj)
+          end
+        when :pretty_inpect
+          [obj.pretty_inspect.chomp].tap do |lines|
+            lines.prepend "# #{id_object(obj)}" unless args
+          end.join("\n")
+        else
+          obj.send(inspect_method)
+        end
+      ['```ruby', obj_str, '```'].join("\n")
+    end
+
+    # recursive
+    def limited_inspect(obj)
+      case obj
+      when Array
+        "[#{obj.map { |o| limited_inspect(o) }.join(',')}]"
+      when Hash
+        # assumes keys are safe to .inspect
+        insides = obj.each { |k, v| "#{k.inspect} => #{limited_inspect(v)}" }
+        "{#{insides.join(', ')}}"
+      when String, Symbol, Numeric, Class, true, false, nil
+        truncated_inspect(obj)
+      else
+        id_object(obj)
+      end
+    end
+
+    def id_object(object)
+      # #<Object:0xe140>
+      "#<#{object.class}:0x#{object.object_id.to_s(16)}>"
+    end
+
+    def truncated_inspect(obj, limit = 280)
+      obj_str = obj.inspect
+      obj_str = "#{obj_str.first(limit)}..." if obj_str.length > limit
+      obj_str
+    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, args: true)}
 
         Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
@@ -189,15 +222,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,
       ))
@@ -205,19 +239,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, args: true)}
         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
@@ -229,7 +264,7 @@ module MarkdownLoggingProxy
 
         Type: #{error.class}
 
-        #{MarkdownLogger.inspect_object(error)}
+        #{inspect_object(error)}
       MSG
       raise error
     end
@@ -239,7 +274,7 @@ module MarkdownLoggingProxy
       logger.log :info, 2, <<~MSG.chomp
         `#{meth}` response
 
-        #{MarkdownLogger.inspect_object(response)}
+        #{inspect_object(response)}
       MSG
     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,18 +1,14 @@
 module MarkdownLoggingProxy
   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
@@ -23,6 +19,7 @@ module MarkdownLoggingProxy
         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,64 @@ module MarkdownLoggingProxy
       @ignore.member?(meth)
     end
 
+    def inspect_object(obj, args: false)
+      obj_str =
+        case inspect_method
+        when :inspect then obj.inspect
+        when :limited then limited_inspect(obj)
+        when :id_object
+          if args
+            "[#{obj.map { |o| id_object(o) }.join(',')}]"
+          else
+            id_object(obj)
+          end
+        when :pretty_inpect
+          [obj.pretty_inspect.chomp].tap do |lines|
+            lines.prepend "# #{id_object(obj)}" unless args
+          end.join("\n")
+        else
+          obj.send(inspect_method)
+        end
+      ['```ruby', obj_str, '```'].join("\n")
+    end
+
+    # recursive
+    def limited_inspect(obj)
+      case obj
+      when Array
+        "[#{obj.map { |o| limited_inspect(o) }.join(',')}]"
+      when Hash
+        # assumes keys are safe to .inspect
+        insides = obj.each { |k, v| "#{k.inspect} => #{limited_inspect(v)}" }
+        "{#{insides.join(', ')}}"
+      when String, Symbol, Numeric, Class, true, false, nil
+        truncated_inspect(obj)
+      else
+        id_object(obj)
+      end
+    end
+
+    def id_object(object)
+      # #<Object:0xe140>
+      "#<#{object.class}:0x#{object.object_id.to_s(16)}>"
+    end
+
+    def truncated_inspect(obj, limit = 280)
+      obj_str = obj.inspect
+      obj_str = "#{obj_str.first(limit)}..." if obj_str.length > limit
+      obj_str
+    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, args: true)}
 
         Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
@@ -59,15 +109,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 +126,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, args: true)}
         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 +151,7 @@ module MarkdownLoggingProxy
 
         Type: #{error.class}
 
-        #{MarkdownLogger.inspect_object(error)}
+        #{inspect_object(error)}
       MSG
       raise error
     end
@@ -109,7 +161,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.1"
+  spec.version = "1.3.1"
   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.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Carl Zulauf