object_inspector 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a5678d0a60ea94fd380f64bac99e4c0f8e5f1a6752597ce934b2687a87d5f57
-  data.tar.gz: ca234feb9aa4dadd78fe1672f1bcbd897f6717597ab246d4b275140fd31de760
+  metadata.gz: b814c9a90935be0339c6bf2ce1e2e0547b5ccb4b59a26feb40d91082cd9c7b2a
+  data.tar.gz: 6f024e9206a497fa173a3e7aff23ae9334b1eacd8cacb4559675ae5db5c3aa1f
 SHA512:
-  metadata.gz: 3585d51c146f4013022e2c2cad959580643f92efd843461f06432f42f406f0a71d6f45e47671c288036d46a94ce4b9f754b37ef446d5fa1590922afbcab23ad4
-  data.tar.gz: f1d439874733a0596d63efe69da6eb95df1b8562b3321f14c468448d26a00fd22ee8e90febaf234cd11f9ebd1a9181bc68ba3c29156264ecdd770f4ebd663c08
+  metadata.gz: 41a2fc9fa580c3ce169bfb5dd8b110d5c9d66635d85cde16c689e42ff91354dbbdd042a7bd45f57381c46e04de6938d91310b79f79a64a56dbd53f6d7f81e37b
+  data.tar.gz: 9ab9384c13706f95f8a1ced4fdf2d0e2162dbad989a709f226026ff6d0be89844392eaf182044fb62d314eac9a2f645a3bacf1ba351a95821b555960fb8d38fa

data/README.md

@@ -71,6 +71,7 @@ ObjectInspector.configure do |config|
   config.flags_separator = " / "
   config.issues_separator = " | "
   config.info_separator = " | "
+  config.error_handler = ->(exception, object:) {}
 end
 ```
 
@@ -522,6 +523,24 @@ See examples:
 - [ObjectInspector::TemplatingFormatter]
 - [ObjectInspector::CombiningFormatter]
 
+## Handling Errors
+
+When `#inspect` raises any `StandardError`, Object Inspector falls back to the original `#inspect` method and records the error in `ObjectInspector.last_error`:
+
+```ruby
+user = User.select(:id).first
+user.inspect
+# => #<User id: 1>
+
+ObjectInspector.last_error
+# => #<ActiveModel::MissingAttributeError: missing attribute: ...>
+puts ObjectInspector.last_error.full_message
+# ...: undefined local variable or method 'asdf' for an instance of Game (NameError)
+# ...
+
+ObjectInspector.clear_error
+```
+
 ## Help
 
 ### How can I see the original inspect output on ActiveRecord objects?
@@ -630,33 +649,15 @@ alias oiset set_object_inspector_scope
 > [!IMPORTANT]
 > ObjectInspector defaults to `enabled`. However, this implies an increased chance of causing additional queries/processing based on your usage.
 
-If your inspect methods reference other ActiveRecord models, you will be introducing Database queries into basic object inspection. While you can control this through careful use of `complex` scopes (see below), you may wish to default ObjectInspector to be `disabled` across the board for active web / background processes. Then, since ObjectInspector's utility really shines on the the Rails console, you can default it to `enabled` there.
-
-To set Object inspector to be `disabled` by default, but `enabled` on the Rails console:
-
-1. In an initializer, set [ObjectInspector::Configuration] to default to `disabled`:
+If your inspect methods reference other ActiveRecord models, you will be introducing Database queries into basic object inspection. While you can control this through careful use of `complex` scopes, you may wish to default ObjectInspector to be `disabled` by default e.g. in production:
 
 ```ruby
 # config/initializers/object_inspector.rb
 ObjectInspector.configure do |config|
-  config.enabled = false
-end
-```
-
-2. Enable ObjectInspector via `.irbrc` (or `.pryrc`, or the like):
-
-```ruby
-# .irbrc:
-
-# ...
-
-ObjectInspector.configuration.enable
-# Note: ^ produces output: ` -> ObjectInspector enabled`
-
-# OR (silent version):
+  config.enabled = !Rails.env.production?
 
-ObjectInspector.configure do |config|
-  config.enabled = true
+  # OR:
+  config.enabled = Rails.configuration.x.object_inspector.enabled
 end
 ```
 

data/lib/object_inspector/inspect_behaviors.rb

@@ -4,14 +4,25 @@
 # the default `#inspect` method for that object to instead call
 # {ObjectInspector::Inspector.inspect}.
 module ObjectInspector::InspectBehaviors
+  # :reek:TooManyStatements
+
   # Calls {ObjectInspector::Inspector.inspect} on `self`, passing through any
   # keyword arguments.
   #
+  # If building the gem inspect String raises a {StandardError}, records the
+  # error via {ObjectInspector.record_error} and falls back to the ancestor
+  # `#inspect` via `super` (Object / ActiveRecord / etc.).
+  #
   # @return [String]
   def inspect(**)
     return super() if ObjectInspector.configuration.disabled?
 
-    ObjectInspector::Inspector.inspect(self, **)
+    ObjectInspector::Inspector.inspect(self, **).tap {
+      ObjectInspector.clear_error
+    }
+  rescue => ex
+    ObjectInspector.record_error(ex, object: self)
+    super()
   end
 
   # Like {#inspect} but:
@@ -22,9 +33,18 @@ module ObjectInspector::InspectBehaviors
   # {#inspect} since the `:all` scope may result in additional queries or extra
   # processing--depending on how the inspect hooks are setup.
   #
+  # On {StandardError}, records the error and falls back to {#inspect} (which
+  # then falls back to the original ancestor `#inspect` if needed).
+  #
   # @return [String]
   def inspect!(**)
-    ObjectInspector::Inspector.inspect(self, **, scope: :all)
+    ObjectInspector::Inspector.inspect(self, **, scope: :all).tap {
+      ObjectInspector.clear_error
+    }
+  rescue => ex
+    ObjectInspector.record_error(ex, object: self)
+
+    inspect
   end
 
   private

data/lib/object_inspector/version.rb

@@ -4,6 +4,6 @@
 
 module ObjectInspector
   # The current ObjectInspector gem version.
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
   public_constant :VERSION
 end

data/lib/object_inspector.rb

@@ -3,6 +3,9 @@
 # Defines the base namespace for all modules/classes used by the
 # object_inspector gem.
 module ObjectInspector
+  LAST_ERROR_THREAD_KEY = :object_inspector_last_error
+  private_constant :LAST_ERROR_THREAD_KEY
+
   # Accessor for the {ObjectInspector::Configuration} object.
   def self.configuration
     @configuration ||= Configuration.new
@@ -21,6 +24,40 @@ module ObjectInspector
     @configuration = Configuration.new
   end
 
+  # Remember the given exception--which will have caused inspect to fall back to
+  # the original `#inspect`. Stored per-thread/fiber so concurrent use does not
+  # clobber it.
+  #
+  # Calls {Configuration#error_handler} with `exception, object:` after
+  # recording.
+  #
+  # @param exception [Exception]
+  # @param object [Object, nil] The object being inspected, when known.
+  #
+  # @return [Exception]
+  def self.record_error(exception, object: nil)
+    Thread.current[LAST_ERROR_THREAD_KEY] = exception
+
+    configuration.error_handler.(exception, object:)
+
+    exception
+  end
+
+  # The most recent exception passed to {record_error} on this thread/fiber.
+  # Cleared by {clear_error} (including after a successful gem inspect).
+  #
+  # @return [Exception, nil]
+  def self.last_error
+    Thread.current[LAST_ERROR_THREAD_KEY]
+  end
+
+  # Clear {#last_error} for the current thread/fiber.
+  #
+  # @return [nil]
+  def self.clear_error
+    Thread.current[LAST_ERROR_THREAD_KEY] = nil
+  end
+
   # :reek:TooManyInstanceVariables, :reek:TooManyMethods
 
   # ObjectInspector::Configuration stores the default configuration options for
@@ -36,7 +73,8 @@ module ObjectInspector
                 :name_separator,
                 :flags_separator,
                 :issues_separator,
-                :info_separator
+                :info_separator,
+                :error_handler
 
     # :reek:LongParameterList, :reek:BooleanParameter
     def initialize( # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
@@ -50,7 +88,8 @@ module ObjectInspector
       name_separator: " - ",
       flags_separator: " / ",
       issues_separator: " | ",
-      info_separator: " | "
+      info_separator: " | ",
+      error_handler: ->(exception, object:) {}
     )
       @enabled = enabled
       @formatter_class = formatter_class
@@ -63,6 +102,7 @@ module ObjectInspector
       @flags_separator = flags_separator
       @issues_separator = issues_separator
       @info_separator = info_separator
+      self.error_handler = error_handler
     end
 
     # @param value [Object] Coerced to a Boolean with `!!value`.
@@ -136,6 +176,21 @@ module ObjectInspector
     def info_separator=(value)
       @info_separator = value.to_s.freeze
     end
+
+    # :reek:ManualDispatch
+
+    # A callable, invoked by {ObjectInspector.record_error}.
+    #
+    # Expected signature: `->(exception, object:) { ... }`.
+    #
+    # @param value [#call]
+    def error_handler=(value)
+      unless value.respond_to?(:call)
+        raise(TypeError, "error_handler must be callable")
+      end
+
+      @error_handler = value
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz