object_inspector 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 050243c72935e87527820175e0eb7e5907ad45a25886aa36dd91ff72d5847578
-  data.tar.gz: e2c0975976e9e1c381412e04245486666bfa82c2d6aa547767957e0e9be3ba27
+  metadata.gz: 8f01a078cf1fd2426c6b8db14983ded1ef0be16abd1e0e58c9716945e5fb3f75
+  data.tar.gz: c2d17d5b4cec6f97798c943e600a64136d4bfdb231c6ae1c14b5bd3179a09142
 SHA512:
-  metadata.gz: c4670b2a2bcc06df1d1f37b6ded1c54da00e800a23a7326776af2785e1e4ae93967df61fc39685c1b62aa37c8872fd26c177f410123eed6c0d2240fb6d9ad177
-  data.tar.gz: 3b4f78ff90cc91e836356a1a76a6d21f0f63c69f40d66f9dfc07b554ba872e2357a67b8007486df5847fd28f593496358762a70bc0ce23f1749b651b4787d269
+  metadata.gz: b96dcc1132c1fe41b7794f25377f9809bf574c93db37a9f4b178f20bf7d563c515cda8400ea774324ac67446db1a8c374601bbef2c541ab2a3bde8dfb2b67993
+  data.tar.gz: bbefc6245702d58e25ea210a53530577f1943f0cf646012c8d27f9e068e5970748e52b1e41ce1878fe19b2caf3992ac0a8af5d7bb2cccb470ec6a354a4c5111d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.4.0 - 2018-05-25
+- Feature: Add ObjectInspector::Configuration#default_scope setting -- can be used to override the default Scope for object inspection.
+- Implement ObjectInspector::Scope#== for comparing scopes with scopes and/or scopes with (Arrays of) Strings, Symbols, etc.
+
+
 ### 0.3.1 - 2018-04-15
 - Add ObjectInspector::Configuration#formatter_class setting for overriding the default Formatter.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    object_inspector (0.3.1)
+    object_inspector (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,7 +7,7 @@
 
 ObjectInspector takes Object#inspect to the next level. Specify any combination of identification attributes, flags, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc.
 
-Because object inspection code should be easy to write and its output should be easy to read!
+Because object inspection code should be uniform, easy to build, and its output should be easy to read!
 
 If you'd like to just jump into an example: [Full Example](#full-example).
 
@@ -38,6 +38,8 @@ Tested MRI Ruby Versions:
 * 2.5.1
 * edge
 
+ObjectInspector has no other dependencies.
+
 
 ## Configuration
 
@@ -50,6 +52,7 @@ _Note: In a Rails app, the following would go in e.g. `config/initializers/objec
 ObjectInspector.configure do |config|
   config.formatter_class = ObjectInspector::TemplatingFormatter
   config.inspect_method_prefix = "inspect"
+  config.default_scope = ObjectInspector::Scope.new(:self)
   config.wild_card_scope = "all"
   config.out_of_scope_placeholder = "*"
   config.flags_separator = " / "
@@ -77,7 +80,7 @@ See also [Helper Usage](#helper-usage) for an even simpler usage option.
 
 ### Output Customization
 
-Use the `identification`, `flags`, `info`, and `name` options to customize inspect output.
+Use the `identification`, `flags`, `info`, and/or `name` options to customize inspect output.
 
 ```ruby
 class MyObject
@@ -296,9 +299,6 @@ end
 
 my_object = MyObject.new("Name")
 
-my_object.inspect
-# => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | * :: Name>"
-
 my_object.inspect(scope: :complex)
 # => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | Complex Info | * :: Name>"
 
@@ -310,6 +310,20 @@ my_object.inspect(scope: %i[self complex verbose])
 
 my_object.inspect(scope: :all)
 # => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) Default Info | Complex Info | Verbose Info :: Name>"
+
+my_object.inspect
+# => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | * :: Name>"
+
+ObjectInspector.configuration.default_scope = :complex
+my_object.inspect
+# => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | Complex Info | * :: Name>"
+
+ObjectInspector.configuration.default_scope = %i[self complex verbose]
+my_object.inspect
+
+ObjectInspector.configuration.default_scope = :all
+my_object.inspect
+# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) Default Info | Complex Info | Verbose Info :: Name>"
 ```
 
 
@@ -398,6 +412,38 @@ See examples:
 - [ObjectInspector::CombiningFormatter]
 
 
+## Supporting Gems
+
+ObjectInspector works great with the [ObjectIdentifier](https://github.com/pdobb/object_identifier) gem.
+
+```ruby
+class MyObject
+  include ObjectInspector::InspectorsHelper
+
+  def my_method1
+    1
+  end
+
+  def my_method2
+    2
+  end
+
+private
+
+  def inspect_identification
+    identify(:my_method1, :my_method2)
+  end
+
+  def inspect_flags; "FLAG1 / FLAG2" end
+  def inspect_info; "INFO" end
+  def inspect_name; "NAME" end
+end
+
+MyObject.new.inspect
+# => "<MyObject[my_method1:1, my_method2:2](FLAG1 / FLAG2) INFO :: NAME>"
+```
+
+
 ## Performance
 
 ### Benchmarking ObjectInspector
@@ -453,38 +499,6 @@ play scripts/benchmarking/formatters.rb
 ```
 
 
-## Supporting Gems
-
-ObjectInspector works great with the [ObjectIdentifier](https://github.com/pdobb/object_identifier) gem.
-
-```ruby
-class MyObject
-  include ObjectInspector::InspectorsHelper
-
-  def my_method1
-    1
-  end
-
-  def my_method2
-    2
-  end
-
-private
-
-  def inspect_identification
-    identify(:my_method1, :my_method2)
-  end
-
-  def inspect_flags; "FLAG1 / FLAG2" end
-  def inspect_info; "INFO" end
-  def inspect_name; "NAME" end
-end
-
-MyObject.new.inspect
-# => "<MyObject[my_method1:1, my_method2:2](FLAG1 / FLAG2) INFO :: NAME>"
-```
-
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/object_inspector.rb

@@ -20,6 +20,7 @@ module ObjectInspector
   class Configuration
     attr_reader :formatter_class,
                 :inspect_method_prefix,
+                :default_scope,
                 :wild_card_scope,
                 :out_of_scope_placeholder,
                 :flags_separator,
@@ -28,6 +29,7 @@ module ObjectInspector
     def initialize
       @formatter_class = TemplatingFormatter
       @inspect_method_prefix = "inspect".freeze
+      @default_scope = Scope.new(:self)
       @wild_card_scope = "all".freeze
       @out_of_scope_placeholder = "*".freeze
       @flags_separator = " / ".freeze
@@ -46,6 +48,10 @@ module ObjectInspector
       @inspect_method_prefix = value.to_s.freeze
     end
 
+    def default_scope=(value)
+      @default_scope = Conversions.Scope(value)
+    end
+
     def wild_card_scope=(value)
       @wild_card_scope = value.to_s.freeze
     end

data/lib/object_inspector/formatters/base_formatter.rb

@@ -21,12 +21,13 @@ module ObjectInspector
       raise NotImplementedError
     end
 
-    # Delegates to {Inspector#wrapped_object_inspection}.
+    # Delegates to {Inspector#wrapped_object_inspection_result}.
     #
     # @return [String] if given
     # @return [NilClass] if not given
-    def wrapped_object_inspection
-      @wrapped_object_inspection ||= inspector.wrapped_object_inspection
+    def wrapped_object_inspection_result
+      @wrapped_object_inspection_result ||=
+        inspector.wrapped_object_inspection_result
     end
 
     # Delegates to {Inspector#identification}.

data/lib/object_inspector/formatters/combining_formatter.rb

@@ -9,7 +9,7 @@ module ObjectInspector
     #
     # @return [String]
     def call
-      if wrapped_object_inspection
+      if wrapped_object_inspection_result
         build_wrapped_object_string
       else
         build_string
@@ -19,7 +19,7 @@ module ObjectInspector
   private
 
     def build_wrapped_object_string
-      "#{build_string} #{RIGHT_ARROW_ICON} #{wrapped_object_inspection}"
+      "#{build_string} #{RIGHT_ARROW_ICON} #{wrapped_object_inspection_result}"
     end
 
     def build_string

data/lib/object_inspector/formatters/templating_formatter.rb

@@ -41,7 +41,7 @@ module ObjectInspector
     #
     # @return [String]
     def call
-      if wrapped_object_inspection
+      if wrapped_object_inspection_result
         build_wrapped_object_string
       else
         build_string
@@ -51,7 +51,7 @@ module ObjectInspector
   private
 
     def build_wrapped_object_string
-      "#{build_string} #{RIGHT_ARROW_ICON} #{wrapped_object_inspection}"
+      "#{build_string} #{RIGHT_ARROW_ICON} #{wrapped_object_inspection_result}"
     end
 
     def build_string

data/lib/object_inspector/inspector.rb

@@ -28,7 +28,7 @@ module ObjectInspector
 
     def initialize(
           object,
-          scope: :self,
+          scope: ObjectInspector.configuration.default_scope,
           formatter: ObjectInspector.configuration.formatter_class,
           **kargs)
       @object = object
@@ -48,7 +48,7 @@ module ObjectInspector
     #
     # @return [String] if {#object_is_a_wrapper}
     # @return [NilClass] if not {#object_is_a_wrapper}
-    def wrapped_object_inspection
+    def wrapped_object_inspection_result
       if object_is_a_wrapper?
         self.class.inspect(
           extract_wrapped_object,

data/lib/object_inspector/scope.rb

@@ -3,6 +3,11 @@ module ObjectInspector
   # responds with `true`. This is a prettier way to test for a given type of
   # "scope" within objects.
   #
+  # It is possible to pass in multiple scope names to match on.
+  # `:all` is a "wild card" scope name, and will match on all scope names.
+  # Passing a block to a scope predicate falls back to the out-of-scope
+  # placeholder (`*` by default) if the scope does not match.
+  #
   # @see ActiveSupport::StringInquirer
   #   http://api.rubyonrails.org/classes/ActiveSupport/StringInquirer.html
   #
@@ -32,6 +37,25 @@ module ObjectInspector
       Array(items).join(separator)
     end
 
+    # Compare self with the passed in object.
+    #
+    # @return [TrueClass] if self and `other` resolve to the same set of objects
+    # @return [FalseClass] if self and `other` resolve to a different set of
+    #   objects
+    def ==(other)
+      names.sort ==
+        Array(other).map(&:to_s).sort
+    end
+    alias_method :eql?, :==
+
+    def to_s(separator: ", ".freeze)
+      to_a.join(separator)
+    end
+
+    def to_a
+      names
+    end
+
   private
 
     def method_missing(method_name, *args, &block)
@@ -55,7 +79,7 @@ module ObjectInspector
 
     def evaluate_block_if(condition, &block)
       if condition
-        block.call
+        block.call(self)
       else
         ObjectInspector.configuration.out_of_scope_placeholder
       end

data/lib/object_inspector/version.rb

@@ -1,3 +1,3 @@
 module ObjectInspector
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/object_inspector.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Paul Dobbins"]
   spec.email         = ["paul.dobbins@icloud.com"]
 
-  spec.summary       = %q{ObjectInspector generates uniformly formatted inspect output with customizable amounts of detail.}
+  spec.summary       = %q{ObjectInspector builds uniformly formatted inspect output with customizable amounts of detail.}
   spec.description   = %q{ObjectInspector takes Object#inspect to the next level. Specify any combination of identification attributes, flags, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc.}
   spec.homepage      = "https://github.com/pdobb/object_inspector"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Dobbins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-15 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,6 +206,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: ObjectInspector generates uniformly formatted inspect output with customizable
+summary: ObjectInspector builds uniformly formatted inspect output with customizable
   amounts of detail.
 test_files: []