object_inspector 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50466d066a40b772c3d98ff85d1be9934a3011e9699261de12da2b620bec1785
-  data.tar.gz: 6deb6b097b7ee1c6d553754242ecbcc0683b3768c5906c139c279a6e07e21da4
+  metadata.gz: 1468942ef1aa4a276a2138a904f34329d8b1e9846b58e013c208fbfe4a9113da
+  data.tar.gz: a552ef57ab52b60f208bbe2fceac50f96be25a340cd3854864a5d6a54e3d886f
 SHA512:
-  metadata.gz: fccec790066ab69fad5c25d737c04b3c5698860d6acca5bc828e0be0a1186260060ad328c183dffc58012c9461405259de1ffb27b763e370df1cc48aa08459d4
-  data.tar.gz: a20c43a5d28088cd5ca7c0da08e1c456f8d4e0433faf7a552401855b66267c8b596e1beb7885ec9a80e829ac9b2523287ef2e3139122ca4b961d3cc54a0072ab
+  metadata.gz: 2d02eab73350615584726ada8923bcdea3d428cf61d8e95abf17778b4b76836f828b2c12389dadf1aebe85e369106b4396da1e8501f81fe4e74b44a3031171b8
+  data.tar.gz: 1d044028f4889d0b6bd5615d5f035e19e5bf6ce7e5a30a30ce54a686edb403dd89a826bf8cfd0c4a89781c862af798d4e50ce9a1ed0080012f33a99ec4e477e1

data/README.md

@@ -5,7 +5,7 @@
 
 Object Inspector takes Object#inspect to the next level. Specify any combination of identification attributes, flags, issues, info, and/or a name along with an optional, self-definable scope option to represent objects. Great for the console, logging, etc.
 
-Why? Because object inspection code should be uniform and easy to build, and its output should be easy to read! Consistency improves readability.
+Why? Because object inspection output should be uniform and easy to build, and its output should be easy to read! Consistency improves readability.
 
 If you'd like to just jump into an example: [Full Example](#full-example).
 
@@ -181,6 +181,30 @@ MyObject.new.inspect
 # => "<My Object(FLAG1) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
+### Helper Inclusion
+
+It may be useful to conditionally include ObjectInspector::InspectorsHelper, as well as other similar methods, via a mix-in.
+
+```ruby
+module ObjectInspectionBehaviors
+  extend ActiveSupport::Concern
+
+  included do
+    # If you'd like to preserve the original inspect method, here is your
+    # chance to.
+    alias_method :__inspect__, :inspect
+
+    include ObjectInspector::InspectorsHelper
+  end
+
+  # An example of another, similar style of method you may wish to utilize in
+  # this mix-in.
+  def introspect
+    self
+  end
+end
+```
+
 ## Scopes
 
 Use the `scope` option to define the scope of the `inspect_*` methods. The supplied value will be wrapped by the ObjectInspector::Scope helper object.
@@ -233,6 +257,8 @@ scope.complex?  # => true
 scope.all?      # => true
 ```
 
+_**NOTE**_: Calling `#inspect!` on an object that mixes in `ObjectInspector::InspectorsHelper` is equivalent to passing in the "wild card" scope.
+
 ### Scope blocks
 
 Passing a block to a scope predicate falls back to the out-of-scope placeholder (`*` by default) if the scope does not match.
@@ -347,6 +373,9 @@ my_object.inspect(scope: %i[self complex verbose])
 my_object.inspect(scope: :all)
 # => "<MyObject[2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!I1 | VI2!! Default Info | Complex Info | Verbose Info :: Name>"
 
+my_object.inspect! # 👀 Same as passing in `scope: :all`
+# => "<MyObject[2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!I1 | VI2!! Default Info | Complex Info | Verbose Info :: Name>"
+
 ObjectInspector.configuration.default_scope = :complex
 my_object.inspect
 # => "<MyObject[2](DEFAULT_FLAG / *) !!I1 | *!! Default Info | Complex Info | * :: Name>"
@@ -375,6 +404,7 @@ class MyWrapperObject
   private
 
   def inspect_flags = "WRAPPER_FLAG1"
+  def inspect_issues(scope:) = scope.complex? { "CI1" }
 end
 
 class MyWrappedObject
@@ -384,10 +414,14 @@ class MyWrappedObject
 
   def inspect_flags = "FLAG1 / FLAG2"
   def inspect_info = "INFO"
+  def inspect_issues(scope:) = scope.complex? { "CI1" }
 end
 
 MyWrapperObject.new.inspect
-# => "<MyWrapperObject(WRAPPER_FLAG1)> ⇨ <MyWrappedObject(FLAG1 / FLAG2) INFO>"
+# => "<MyWrapperObject(WRAPPER_FLAG1) !!*!!>  ⇨  <MyWrappedObject(FLAG1 / FLAG2) !!*!! INFO>"
+
+MyWrapperObject.new.inspect!
+# => "<MyWrapperObject(WRAPPER_FLAG1) !!CI1!!>  ⇨  <MyWrappedObject(FLAG1 / FLAG2) !!CI1!! INFO>"
 ```
 
 This feature is recursive.
@@ -590,13 +624,13 @@ load "script/benchmarking/formatters.rb"
 #
 # Comparison:
 # ObjectInspector::TemplatingFormatter:    65856.3 i/s
-# ObjectInspector::CombiningFormatter:    60920.0 i/s - 1.08x  slower
+# ObjectInspector::CombiningFormatter:    60920.0 i/s - 1.13x  slower
 # == Done
 ```
 
 #### Benchmarking Custom Formatters
 
-Custom Formatters may be similarly gauged for comparison by putting them into a constant `CUSTOM_FORMATTER_CLASSES` before playing the script in the IRB console for this gem.
+Custom Formatters may be similarly gauged for comparison by putting them into a constant `CUSTOM_FORMATTER_CLASSES` before loading the script in the IRB console for this gem.
 
 ```ruby
 CUSTOM_FORMATTER_CLASSES = [MyCustomFormatter]

data/lib/object_inspector/inspector.rb

@@ -47,7 +47,8 @@ class ObjectInspector::Inspector
     formatter.call
   end
 
-  # Generate the inspect String for the wrapped object, if present.
+  # Generate the inspect String for the wrapped object, if `self` is a wrapper
+  # object.
   #
   # @return [String] if {#object_is_a_wrapper?}
   # @return [NilClass] if not {#object_is_a_wrapper?}

data/lib/object_inspector/inspectors_helper.rb

@@ -5,10 +5,20 @@
 # generating the inspection output.
 module ObjectInspector::InspectorsHelper
   # Calls {ObjectInspector::Inspector.inspect} on the passed in `object`,
-  # passing it the passed in `kwargs` (keyword arguments).
+  # passing through any keyword arguments.
   #
   # @return [String]
   def inspect(object = self, **)
     ObjectInspector::Inspector.inspect(object, **)
   end
+
+  # Like {#inspect} but forces scope to `:all`. This (the bang (!) version) is
+  # considered the "more dangerous" version of {#inspect} in the sense that the
+  # `:all` scope may result in additional queries or extra processing--depending
+  # on how the inspect hooks are setup.
+  #
+  # @return [String]
+  def inspect!(object = self, **)
+    ObjectInspector::Inspector.inspect(object, **, scope: :all)
+  end
 end

data/lib/object_inspector/version.rb

@@ -2,5 +2,5 @@
 
 module ObjectInspector
   # The current ObjectInspector gem version.
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 bindir: exe
 cert_chain: []
-date: 2025-03-23 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips