markdown_logging_proxy 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215b4bc73f85cdb7ec9bfa2e3ef3b1efefa55a9d99c34f36007788c798dcbcc0
-  data.tar.gz: 391123e09db062038d9e4e4ef3aa2a98f15dc07a7727ede676d6a51d7c5cf532
+  metadata.gz: e893add5ca96b98f32be5370fb7bfc61e3f80f387392359b4c8e25f9d7e1ca45
+  data.tar.gz: 37dd7b894552ba38329279dcb2c8ef23961ca719c23ba1f7a5343e0e1c365c89
 SHA512:
-  metadata.gz: 3119ffa9798cf92d8010df9d20738eaf1c7e782de72b40709aba08066270811b31b119ada4ba977e4af67fc5f37da6d455a01afd81ab0a8a62fe944587323c58
-  data.tar.gz: 6171e82b3677b73c9fa83753a9a21927625427a344b77e07f6285f5090bc1eff156c51504f74310a33bf7fef1bd36bfab4c191423369715b0427d7018b0a475e
+  metadata.gz: fd08c3cecf05ef6173ae54c8cd9885e2817c94c141fd3c168c1a04f79f9c267e9fbaebb164cf00ba6670125f4dafd0135a47d39b758b11b043feabf851bf9e8d
+  data.tar.gz: '096efff296da1406507b5f2a5531bbf267324a4b53c27ce7ced1b05f85e59b223480e5cb21838b658937a00093cad8e2d961f1c6727a48e85bf3ecf06a9797bb'

data/CHANGELOG.md

@@ -37,3 +37,8 @@
 ## [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.3.0)
+    markdown_logging_proxy (1.3.1)
 
 GEM
   remote: https://rubygems.org/

data/dist/markdown_logging_proxy.rb

@@ -151,14 +151,20 @@ module MarkdownLoggingProxy
       @ignore.member?(meth)
     end
 
-    def inspect_object(obj, show_id: true)
+    def inspect_object(obj, args: false)
       obj_str =
         case inspect_method
         when :inspect then obj.inspect
-        when :object_id then object_id(obj)
+        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 "# #{object_id(obj)}" if show_id
+            lines.prepend "# #{id_object(obj)}" unless args
           end.join("\n")
         else
           obj.send(inspect_method)
@@ -166,9 +172,31 @@ module MarkdownLoggingProxy
       ['```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)}>`"
+      "#<#{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
@@ -176,11 +204,11 @@ module MarkdownLoggingProxy
     def log_call_signature(meth, args, &blk)
       return if ignore.member?(meth)
       logger.log :info, 1, <<~MSG.chomp
-        Calling `#{meth}` on #{id_object(target)}
+        Calling `#{meth}` on `#{id_object(target)}`
 
         Arguments:
 
-        #{inspect_object(args, show_id: false)}
+        #{inspect_object(args, args: true)}
 
         Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
@@ -194,7 +222,7 @@ module MarkdownLoggingProxy
       logger.log :info, 3, <<~MSG.chomp
         Returning proxied response to `#{meth}`
 
-        Proxy from `#{meth}` on #{id_object(target)}
+        Proxy from `#{meth}` on `#{id_object(target)}`
 
         Proxy for:
 
@@ -214,11 +242,11 @@ module MarkdownLoggingProxy
       tracer = self
       proc do |*args|
         tracer.logger.log :info, 2, <<~MSG.chomp
-          Yield to block in `#{meth}` on #{tracer.id_object(tracer.target)}
+          Yield to block in `#{meth}` on `#{tracer.id_object(tracer.target)}`
 
           Arguments:
 
-          #{tracer.inspect_object(args, show_id: false)}
+          #{tracer.inspect_object(args, args: true)}
         MSG
         instance_exec(*args, &blk).tap do |response|
           tracer.logger.log :info, 3, <<~MSG.chomp

data/lib/markdown_logging_proxy/tracer.rb

@@ -38,14 +38,20 @@ module MarkdownLoggingProxy
       @ignore.member?(meth)
     end
 
-    def inspect_object(obj, show_id: true)
+    def inspect_object(obj, args: false)
       obj_str =
         case inspect_method
         when :inspect then obj.inspect
-        when :object_id then object_id(obj)
+        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 "# #{object_id(obj)}" if show_id
+            lines.prepend "# #{id_object(obj)}" unless args
           end.join("\n")
         else
           obj.send(inspect_method)
@@ -53,9 +59,31 @@ module MarkdownLoggingProxy
       ['```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)}>`"
+      "#<#{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
@@ -63,11 +91,11 @@ module MarkdownLoggingProxy
     def log_call_signature(meth, args, &blk)
       return if ignore.member?(meth)
       logger.log :info, 1, <<~MSG.chomp
-        Calling `#{meth}` on #{id_object(target)}
+        Calling `#{meth}` on `#{id_object(target)}`
 
         Arguments:
 
-        #{inspect_object(args, show_id: false)}
+        #{inspect_object(args, args: true)}
 
         Block given? #{block_given? ? 'Yes' : 'No'}
         #{logger.inspect_backtrace}
@@ -81,7 +109,7 @@ module MarkdownLoggingProxy
       logger.log :info, 3, <<~MSG.chomp
         Returning proxied response to `#{meth}`
 
-        Proxy from `#{meth}` on #{id_object(target)}
+        Proxy from `#{meth}` on `#{id_object(target)}`
 
         Proxy for:
 
@@ -101,11 +129,11 @@ module MarkdownLoggingProxy
       tracer = self
       proc do |*args|
         tracer.logger.log :info, 2, <<~MSG.chomp
-          Yield to block in `#{meth}` on #{tracer.id_object(tracer.target)}
+          Yield to block in `#{meth}` on `#{tracer.id_object(tracer.target)}`
 
           Arguments:
 
-          #{tracer.inspect_object(args, show_id: false)}
+          #{tracer.inspect_object(args, args: true)}
         MSG
         instance_exec(*args, &blk).tap do |response|
           tracer.logger.log :info, 3, <<~MSG.chomp

data/markdown_logging_proxy.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "markdown_logging_proxy"
-  spec.version = "1.3.0"
+  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.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Carl Zulauf