markdown_logging_proxy 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a597efa8e2dab27f1fe61005c367d1cfbabd2e1ea5a03e03ec1b29d2baab02
-  data.tar.gz: f76c90d59eb9c1a911c6eeb2c3e1e2bb8ec881847d9bf8d9cadb0a53ae3378fc
+  metadata.gz: 215b4bc73f85cdb7ec9bfa2e3ef3b1efefa55a9d99c34f36007788c798dcbcc0
+  data.tar.gz: 391123e09db062038d9e4e4ef3aa2a98f15dc07a7727ede676d6a51d7c5cf532
 SHA512:
-  metadata.gz: 108a3acc43c38e7a9fad4773a5d2f2b7b9c55e33b1f6280869316affe6d8b48d342ada65cb170865f672a6f1a77f184a171ccdc6720ebe9c41d5bae8af5ed590
-  data.tar.gz: 9a696b09265a340d4934c4874cbe0e0977cd6739768d282f145255b128126cdac879e921de452addffa1b94b980dce0d7039d397babd978a179e70b70c09d5aa
+  metadata.gz: 3119ffa9798cf92d8010df9d20738eaf1c7e782de72b40709aba08066270811b31b119ada4ba977e4af67fc5f37da6d455a01afd81ab0a8a62fe944587323c58
+  data.tar.gz: 6171e82b3677b73c9fa83753a9a21927625427a344b77e07f6285f5090bc1eff156c51504f74310a33bf7fef1bd36bfab4c191423369715b0427d7018b0a475e

data/CHANGELOG.md

@@ -33,3 +33,7 @@
 ## [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.2.0)
+    markdown_logging_proxy (1.3.0)
 
 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)
@@ -94,6 +80,7 @@ module MarkdownLoggingProxy
         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
@@ -104,6 +91,7 @@ module MarkdownLoggingProxy
         target: @target,
         proxy: self,
         logger: @logger,
+        inspect_method: inspect_method,
         ignore: ignore,
         proxy_response: proxy_response,
         proxy_options: {
@@ -125,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
@@ -161,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}
@@ -184,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,
       ))
@@ -200,21 +211,20 @@ module MarkdownLoggingProxy
 
     def log_and_proxy_block(meth, blk)
       return if blk.nil?
-      logger_ref = self.logger
-      target_ref = self.target
+      tracer = self
       proc do |*args|
-        logger_ref.log :info, 2, <<~MSG.chomp
-          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target_ref)}
+        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
         instance_exec(*args, &blk).tap do |response|
-          logger_ref.log :info, 3, <<~MSG.chomp
+          tracer.logger.log :info, 3, <<~MSG.chomp
             Response from block in `#{meth}`
 
-            #{MarkdownLogger.inspect_object(response)}
+            #{tracer.inspect_object(response)}
           MSG
         end
       end
@@ -226,7 +236,7 @@ module MarkdownLoggingProxy
 
         Type: #{error.class}
 
-        #{MarkdownLogger.inspect_object(error)}
+        #{inspect_object(error)}
       MSG
       raise error
     end
@@ -236,7 +246,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

@@ -8,6 +8,7 @@ module MarkdownLoggingProxy
         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
@@ -18,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,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,21 +98,20 @@ module MarkdownLoggingProxy
 
     def log_and_proxy_block(meth, blk)
       return if blk.nil?
-      logger_ref = self.logger
-      target_ref = self.target
+      tracer = self
       proc do |*args|
-        logger_ref.log :info, 2, <<~MSG.chomp
-          Yield to block in `#{meth}` on #{MarkdownLogger.id_object(target_ref)}
+        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
         instance_exec(*args, &blk).tap do |response|
-          logger_ref.log :info, 3, <<~MSG.chomp
+          tracer.logger.log :info, 3, <<~MSG.chomp
             Response from block in `#{meth}`
 
-            #{MarkdownLogger.inspect_object(response)}
+            #{tracer.inspect_object(response)}
           MSG
         end
       end
@@ -101,7 +123,7 @@ module MarkdownLoggingProxy
 
         Type: #{error.class}
 
-        #{MarkdownLogger.inspect_object(error)}
+        #{inspect_object(error)}
       MSG
       raise error
     end
@@ -111,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.2.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.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Carl Zulauf