object_inspector 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce8aec7e092dd069c72397d26c799c103b45af8c784e92355dc8f3f267f8f2b
-  data.tar.gz: a81699623cc8cb8bc532df00b7b9cf6b1d60d6f3620d9a2887bedf217be19ee7
+  metadata.gz: c5bfaac0270b232c17c91495180cf29e5a4538c1010e636cf681832d6668ba8c
+  data.tar.gz: fd5e4add5c7a5c7d971ec22a4d5ba80e78642d4df9e060c6382b6b7a93e67551
 SHA512:
-  metadata.gz: 7b1b091814bb2188953da2d9dbc9ee513c5092f84e7c21339daac97ee1accb0afa5dd1259424fdf9d0ac9770b63a3219bbc196976e670167e679a827dd61e8e5
-  data.tar.gz: f7a2eac925594a69a2e4ab7faec46ccd0f719a5773a8870c60868e9556b077fa7ae0c00f1943b1ba82e4bb4b7f4d59c0bf9093e2da4c895434f8c3e276749251
+  metadata.gz: 0b31e59f84e625d766309ba1dd760a87bba5b70007214aeec3dd3f47c44e64446db34c640a5a9c35923881178eb61c98080138d542ba1fe1b632a93d1269b4ee
+  data.tar.gz: 777ee932d2e9fa0c0d4c013dd9f0c8713956afafd883ce866fccb93f23b25fa8eaddb729b6035fd74c514bf9865f40bca09cb06fc2153a4f927458b7dbdbad45

data/.rubocop.yml

@@ -98,6 +98,11 @@ Style/Alias:
 Style/BlockDelimiters:
   Enabled: false # Reconsider later.
 
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+  Exclude:
+    - "test/**/*"
+
 Style/CollectionMethods:
   Enabled: true
   PreferredMethods:

data/.travis.yml

@@ -4,11 +4,10 @@ env:
 sudo: false
 language: ruby
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.3
-  - 2.6.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.6.0 - 2019-03-13
+- Fix inspection of delegating wrapper objects
+
+
 ### 0.5.2 - 2019-02-24
 - Automatically compact nils in join_* methods
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    object_inspector (0.5.2)
+    object_inspector (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -35,8 +35,8 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    object_identifier (0.1.1)
-    parallel (1.13.0)
+    object_identifier (0.2.1)
+    parallel (1.14.0)
     parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)

data/README.md

@@ -24,7 +24,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install object_inspector
 
@@ -32,11 +32,10 @@ Or install it yourself as:
 ## Compatibility
 
 Tested MRI Ruby Versions:
-* 2.2.10
-* 2.3.7
-* 2.4.4
-* 2.5.3
-* 2.6.1
+* 2.3
+* 2.4
+* 2.5
+* 2.6
 * edge
 
 ObjectInspector has no other dependencies.
@@ -381,6 +380,62 @@ MyWrapperObject.new.inspect
 This feature is recursive.
 
 
+### Wrapped Delegators
+
+If the Object being inspected is wrapped by an object that delegates all unknown methods to the wrapped object, then inspect flags will be doubled up. To get around this, redefine the `inspect` method in the Wrapper object e.g. like:
+
+```ruby
+class MyDelegatingWrapperObject
+  include ObjectInspector::InspectorsHelper
+
+  def initialize(my_object)
+    @my_object = my_object
+  end
+
+  def inspect(**kargs)
+    super(identification: self.class.name,
+          name: nil,
+          flags: nil,
+          info: nil,
+          issues: nil,
+          **kargs)
+  end
+
+  def to_model
+    @my_object
+  end
+
+  private
+
+  def method_missing(method_symbol, *args)
+    @my_object.__send__(method_symbol, *args)
+  end
+
+  def respond_to_missing?(*args)
+    @my_object.respond_to?(*args) || super
+  end
+end
+
+class MyWrappedObject
+  include ObjectInspector::InspectorsHelper
+
+  def display_name
+    "WRAPPED_OBJECT_NAME"
+  end
+
+  private
+
+  def inspect_flags; "FLAG1" end
+  def inspect_info; "INFO" end
+  def inspect_issues; "ISSUE1" end
+  def inspect_name; "NAME" end
+end
+
+MyDelegatingWrapperObject.new(MyWrappedObject.new).inspect
+# => "<MyDelegatingWrapperObject>  ⇨  <MyWrappedObject(FLAG1) !!ISSUE1!! INFO :: NAME>"
+```
+
+
 ## On-the-fly Inspect Methods
 
 When passed as an option (as opposed to being called via an Object-defined method) symbols will be called/evaluated on Object on the fly.

data/bin/console

@@ -9,7 +9,6 @@ require "ostruct"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"
 Pry.start
 

data/lib/object_inspector/formatters/base_formatter.rb

@@ -5,11 +5,10 @@ module ObjectInspector
   # with {ObjectInspector::Inspector} objects to combine the supplied
   # {#identification}, {#flags}, {#info}, and {#name} strings into a friendly
   # "inspect" String.
-  #
-  # @attr inspector [ObjectInspector::Inspector]
   class BaseFormatter
     attr_reader :inspector
 
+    # @param inspector [ObjectInspector::Inspector]
     def initialize(inspector)
       @inspector = inspector
     end
@@ -27,14 +26,14 @@ module ObjectInspector
     # @return [NilClass] if not given
     def wrapped_object_inspection_result
       @wrapped_object_inspection_result ||=
-        inspector.wrapped_object_inspection_result
+        @inspector.wrapped_object_inspection_result
     end
 
     # Delegates to {Inspector#identification}.
     #
     # @return [String] if given
     def identification
-      @identification ||= inspector.identification
+      @identification ||= @inspector.identification
     end
 
     # Delegates to {Inspector#flags}.
@@ -42,7 +41,7 @@ module ObjectInspector
     # @return [String] if given
     # @return [NilClass] if not given
     def flags
-      @flags ||= inspector.flags
+      @flags ||= @inspector.flags
     end
 
     # Delegates to {Inspector#issues}.
@@ -50,7 +49,7 @@ module ObjectInspector
     # @return [String] if given
     # @return [NilClass] if not given
     def issues
-      @issues ||= inspector.issues
+      @issues ||= @inspector.issues
     end
 
     # Delegates to {Inspector#info}.
@@ -58,7 +57,7 @@ module ObjectInspector
     # @return [String] if given
     # @return [NilClass] if not given
     def info
-      @info ||= inspector.info
+      @info ||= @inspector.info
     end
 
     # Delegates to {Inspector#name}.
@@ -66,7 +65,7 @@ module ObjectInspector
     # @return [String] if given
     # @return [NilClass] if not given
     def name
-      @name ||= inspector.name
+      @name ||= @inspector.name
     end
   end
 end

data/lib/object_inspector/inspector.rb

@@ -1,24 +1,11 @@
 # frozen_string_literal: true
 
 module ObjectInspector
-  # ObjectInspector::Inspector organizes inspection of the associated {#object}
+  # ObjectInspector::Inspector organizes inspection of the associated {@object}
   # via the passed in options and via a {ObjectInspector::BaseFormatter}
   # instance.
-  #
-  # @attr object [Object] the object being inspected
-  # @attr scope [Symbol] Object inspection type. For example:
-  #   :self (default) -- Means: Only interrogate self. Don't visit neighbors.
-  #   <custom>        -- Anything else that makes sense for {#object} to key on
-  # @attr formatter [ObjectInspector::BaseFormatter]
-  #   (ObjectInspector.configuration.formatter) the formatter object type
-  #   to use for formatting the inspect String
-  # @attr kargs [Hash] options to be sent to {#object} via the
-  #   {ObjectInspector::ObjectInterrogator} when calling the `inspect_*` methods
   class Inspector
-    attr_reader :object,
-                :scope,
-                :formatter_klass,
-                :kargs
+    attr_reader :object
 
     # Shortcuts the instantiation -> {#to_s} flow that would normally be
     # required to use ObjectInspector::Inspector.
@@ -28,6 +15,17 @@ module ObjectInspector
       new(object, **kargs).to_s
     end
 
+    # @param object [Object] the object being inspected
+    # @param scope [Symbol] Object inspection type. For example:
+    #   :self (default) -- Means: Only interrogate self. Don't visit neighbors.
+    #   <custom>        -- Anything else that makes sense for {@object} to key
+    #                      on
+    # @param formatter [ObjectInspector::BaseFormatter]
+    #   (ObjectInspector.configuration.formatter) the formatter object type
+    #   to use for formatting the inspect String
+    # @param kargs [Hash] options to be sent to {@object} via the
+    #   {ObjectInspector::ObjectInterrogator} when calling the `inspect_*`
+    #   methods
     def initialize(
           object,
           scope: ObjectInspector.configuration.default_scope,
@@ -55,19 +53,20 @@ module ObjectInspector
 
       self.class.inspect(
         extract_wrapped_object,
-        scope: scope,
-        formatter: formatter_klass)
+        scope: @scope,
+        formatter: @formatter_klass,
+        kargs: @kargs)
     end
 
-    # Core object identification details, such as the {#object} class name and
+    # Core object identification details, such as the {@object} class name and
     # any core-level attributes.
     #
     # @return [String]
     def identification
-      (value(key: :identification) || object.class).to_s
+      (value(key: :identification) || @object.class).to_s
     end
 
-    # Boolean flags/states applicable to {#object}.
+    # Boolean flags/states applicable to {@object}.
     #
     # @return [String] if given
     # @return [NilClass] if not given
@@ -75,7 +74,7 @@ module ObjectInspector
       value(key: :flags)
     end
 
-    # Issues/Warnings applicable to {#object}.
+    # Issues/Warnings applicable to {@object}.
     #
     # @return [String] if given
     # @return [NilClass] if not given
@@ -83,7 +82,7 @@ module ObjectInspector
       value(key: :issues)
     end
 
-    # Informational details applicable to {#object}.
+    # Informational details applicable to {@object}.
     #
     # @return [String] if given
     # @return [NilClass] if not given
@@ -91,29 +90,35 @@ module ObjectInspector
       value(key: :info)
     end
 
-    # The generally human-friendly unique identifier for {#object}.
+    # A human-friendly identifier for {@object}.
     #
     # @return [String] if given
     # @return [NilClass] if not given
     def name
-      value(key: :name) ||
-        interrogate_object(method_name: :display_name,
-                           kargs: object_method_keyword_arguments)
+      key = :name
+
+      if @kargs.key?(key)
+        value(key: key)
+      else
+        interrogate_object_inspect_method(key) ||
+          interrogate_object(method_name: :display_name,
+                             kargs: object_method_keyword_arguments)
+      end
     end
 
     private
 
     def formatter
-      formatter_klass.new(self)
+      @formatter_klass.new(self)
     end
 
-    # @return [String] if `key` is found in {#kargs} or if {#object} responds to
+    # @return [String] if `key` is found in {#kargs} or if {@object} responds to
     #   `#{object_inspet_method_name}` (e.g. `inspect_flags`)
-    # @return [NilClass] if not found in {#kargs} or {#object}
+    # @return [NilClass] if not found in {#kargs} or {@object}
     def value(key:)
       return_value =
-        if (passed_in_value = kargs[key])
-          evaluate_passed_in_value(passed_in_value)
+        if @kargs.key?(key)
+          evaluate_passed_in_value(@kargs[key])
         else
           interrogate_object_inspect_method(key)
         end
@@ -121,12 +126,12 @@ module ObjectInspector
       return_value&.to_s
     end
 
-    # Call `value` on {#object} if it responds to it and the result is not nil,
+    # Call `value` on {@object} if it responds to it and the result is not nil,
     # else just return `value`.
     #
-    # @return [#to_s] if {#object} responds to `value` and if the call result
+    # @return [#to_s] if {@object} responds to `value` and if the call result
     #   isn't nil
-    # @return [#nil] if {#object} doesn't respond to `value` or if the call
+    # @return [#nil] if {@object} doesn't respond to `value` or if the call
     #   result is nil
     def evaluate_passed_in_value(value)
       if value.is_a?(Symbol)
@@ -136,11 +141,11 @@ module ObjectInspector
       end
     end
 
-    # Attempt to call `inspect_*` on {#object} based on the passed in `name`.
+    # Attempt to call `inspect_*` on {@object} based on the passed in `name`.
     #
-    # @return [String] if {#object} responds to
+    # @return [String] if {@object} responds to
     #   `#{object_inspet_method_name}` (e.g. `inspect_flags`)
-    # @return [NilClass] if not found on {#object}
+    # @return [NilClass] if not found on {@object}
     def interrogate_object_inspect_method(
           name,
           prefix: ObjectInspector.configuration.inspect_method_prefix)
@@ -152,7 +157,7 @@ module ObjectInspector
     def interrogate_object(method_name:, kargs: {})
       interrogator =
         ObjectInterrogator.new(
-          object: object,
+          object: @object,
           method_name: method_name,
           kargs: kargs)
 
@@ -167,17 +172,17 @@ module ObjectInspector
 
     def object_method_keyword_arguments
       {
-        scope: scope
+        scope: @scope
       }
     end
 
     def extract_wrapped_object
-      object.to_model
+      @object.to_model
     end
 
     def object_is_a_wrapper?
-      object.respond_to?(:to_model) &&
-        object.to_model != object
+      @object.respond_to?(:to_model) &&
+        @object.to_model != @object
     end
   end
 end

data/lib/object_inspector/object_interrogator.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
 module ObjectInspector
-  # ObjectInspector::ObjectInterrogator collaborates with {#object} to return
-  # Object#{#method_name} if {#object} responds to the method.
+  # ObjectInspector::ObjectInterrogator collaborates with {@object} to return
+  # Object#{@method_name} if {@object} responds to the method.
   #
-  # If Object#{#method_name} accepts the supplied {#kargs} then they are passed
-  # in as well. If not, then any supplied {#kargs} will be ignored.
+  # If Object#{@method_name} accepts the supplied {@kargs} then they are passed
+  # in as well. If not, then any supplied {@kargs} will be ignored.
   class ObjectInterrogator
-    attr_reader :object,
-                :method_name,
-                :kargs
+    attr_reader :object
 
     def initialize(object:, method_name:, kargs: {})
       @object = object
@@ -24,23 +22,23 @@ module ObjectInspector
     def call
       return unless object_responds_to_method_name?
 
-      if object.method(method_name).arity != 0
+      if @object.method(@method_name).arity != 0
         call_with_kargs
       else
-        object.send(method_name)
+        @object.__send__(@method_name)
       end
     end
 
     private
 
     def call_with_kargs
-      object.send(method_name, **kargs)
+      @object.__send__(@method_name, **@kargs)
     rescue ArgumentError
-      object.send(method_name)
+      @object.__send__(@method_name)
     end
 
     def object_responds_to_method_name?(include_private: true)
-      object.respond_to?(method_name, include_private)
+      @object.respond_to?(@method_name, include_private)
     end
   end
 end

data/lib/object_inspector/scope.rb

@@ -67,8 +67,7 @@ module ObjectInspector
     # @return [FalseClass] if self and `other` resolve to a different set of
     #   objects
     def ==(other)
-      names.sort ==
-        Array(other).map(&:to_s).sort
+      @names.sort == Array(other).map(&:to_s).sort
     end
     alias_method :eql?, :==
 
@@ -77,7 +76,7 @@ module ObjectInspector
     end
 
     def to_a
-      names
+      @names
     end
 
     private

data/lib/object_inspector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ObjectInspector
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Paul Dobbins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-24 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ObjectInspector builds uniformly formatted inspect output with customizable