object_inspector 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93cdfccb3e1e30286035a4c152053794eb78ba6b99e3bf7b6d5679ca60c8f8fb
-  data.tar.gz: e551588d9bc978dd5676a14188787a55eed91b0e81c31c44479ac88559f350bc
+  metadata.gz: 050243c72935e87527820175e0eb7e5907ad45a25886aa36dd91ff72d5847578
+  data.tar.gz: e2c0975976e9e1c381412e04245486666bfa82c2d6aa547767957e0e9be3ba27
 SHA512:
-  metadata.gz: 2ed62b8237dff20c6de7157c1c6475b08643396cc0fc1b71f2c334a562ca9253ee8da911949fc63c0549bad881e8f2704817c6c28bc265b6fd596ca5c5e47ad8
-  data.tar.gz: 6ff191c8ed79769432a2792b3c0c88d7ff6aae372d5ce323e455b6e890caecdb131dcf25ccdfd704fb9ec26bf416413330535d169dbe2d0f38d48c40485a3310
+  metadata.gz: c4670b2a2bcc06df1d1f37b6ded1c54da00e800a23a7326776af2785e1e4ae93967df61fc39685c1b62aa37c8872fd26c177f410123eed6c0d2240fb6d9ad177
+  data.tar.gz: 3b4f78ff90cc91e836356a1a76a6d21f0f63c69f40d66f9dfc07b554ba872e2357a67b8007486df5847fd28f593496358762a70bc0ce23f1749b651b4787d269

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.3.1 - 2018-04-15
+- Add ObjectInspector::Configuration#formatter_class setting for overriding the default Formatter.
+
+
 ### 0.3.0 - 2018-04-14
 
 - Remove optional dependency on ActiveSupport::StringInquirer. [Scopes are now objects](https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/scope.rb) that act like ActiveSupport::StringInquirer objects.

data/Gemfile.lock

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

data/README.md

@@ -5,7 +5,11 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/34e821263d9e0c33d536/test_coverage)](https://codeclimate.com/github/pdobb/object_inspector/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/34e821263d9e0c33d536/maintainability)](https://codeclimate.com/github/pdobb/object_inspector/maintainability)
 
-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 represent an object in the console, in logging, etc.
+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!
+
+If you'd like to just jump into an example: [Full Example](#full-example).
 
 
 ## Installation
@@ -44,6 +48,8 @@ _Note: In a Rails app, the following would go in e.g. `config/initializers/objec
 ```ruby
 # Default values are shown.
 ObjectInspector.configure do |config|
+  config.formatter_class = ObjectInspector::TemplatingFormatter
+  config.inspect_method_prefix = "inspect"
   config.wild_card_scope = "all"
   config.out_of_scope_placeholder = "*"
   config.flags_separator = " / "
@@ -87,7 +93,7 @@ end
 MyObject.new.inspect  # => "<My Object(FLAG1 / FLAG2) INFO :: NAME>"
 ```
 
-Or, define `inspect_identification`, `inspect_flags`, `inspect_info`, and `inspect_name` as either public or private methods on Object.
+Or, define `inspect_identification`, `inspect_flags`, `inspect_info`, and/or `inspect_name` (or `display_name`) as either public or private methods on Object.
 
 ```ruby
 class MyObject
@@ -100,7 +106,7 @@ private
   def inspect_identification; "My Object" end
   def inspect_flags; "FLAG1 / FLAG2" end
   def inspect_info; "INFO" end
-  def inspect_name; "NAME" end
+  def inspect_name; "NAME" end  # Or: def display_name; "NAME" end
 end
 
 MyObject.new.inspect  # => "<My Object(FLAG1 / FLAG2) INFO :: NAME>"
@@ -136,7 +142,7 @@ end
 MyObject.new.inspect  # => "<My Object(FLAG1) INFO :: NAME>"
 ```
 
-Or, define `inspect_identification`, `inspect_flags`, `inspect_info`, and `inspect_name` (or `display_name`) in Object.
+Or, define `inspect_identification`, `inspect_flags`, `inspect_info`, and/or `inspect_name` (or `display_name`) in Object.
 
 ```ruby
 class MyObject
@@ -232,22 +238,6 @@ scope.join_info([1, 2, 3])   # => "1 | 2 | 3"
 ```
 
 
-### Conversion to ObjectInspector::Scope
-
-ObjectInspector::Conversions.Scope() is available for proper conversion to ObjectInspector::Scope objects. Though this should rarely be necessary as conversion is performed automatically when calling `<my_object>.inspect(scope: <scope_name>)`.
-
-```ruby
-ObjectInspector::Conversions.Scope(:self)
-# => #<ObjectInspector::Scope:0x007ff78ab8e7f8 @name="self">
-
-scope = ObjectInspector::Scope.new(:verbose)
-result = ObjectInspector::Conversions.Scope(scope)
-# => #<ObjectInspector::Scope:0x007ff78ac9c140 @name="verbose">
-
-scope.object_id == result.object_id  # => true
-```
-
-
 ## Full Example
 
 ```ruby
@@ -378,7 +368,7 @@ MyObject.new.inspect                      # => "<MyObject my_method2>"
 
 ## Custom Formatters
 
-A custom inspect formatter can be defined by implementing the interface defined by [ObjectInspector::BaseFormatter](https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/formatters/base_formatter.rb) and then passing that into ObjectInspector::Inspector.new.
+A custom inspect formatter can be defined by implementing the interface defined by [ObjectInspector::BaseFormatter](https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/formatters/base_formatter.rb). Then, either override the ObjectInspector::Configuration#formatter_class value (see [Configuration](#configuration)) or just pass your custom class name into ObjectInspector::Inspector.new.
 
 ```ruby
 class MyCustomFormatter < ObjectInspector::BaseFormatter

data/lib/object_inspector/inspector.rb

@@ -7,7 +7,8 @@ module ObjectInspector
   # @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] the formatter object type
+  # @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
@@ -28,11 +29,11 @@ module ObjectInspector
     def initialize(
           object,
           scope: :self,
-          formatter: TemplatingFormatter,
+          formatter: ObjectInspector.configuration.formatter_class,
           **kargs)
       @object = object
-      @formatter_klass = formatter
       @scope = Conversions.Scope(scope)
+      @formatter_klass = formatter
       @kargs = kargs
     end
 

data/lib/object_inspector/version.rb

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

data/lib/object_inspector.rb

@@ -18,18 +18,32 @@ module ObjectInspector
   end
 
   class Configuration
-    attr_reader :wild_card_scope,
+    attr_reader :formatter_class,
+                :inspect_method_prefix,
+                :wild_card_scope,
                 :out_of_scope_placeholder,
                 :flags_separator,
-                :info_separator,
-                :inspect_method_prefix
+                :info_separator
 
     def initialize
+      @formatter_class = TemplatingFormatter
+      @inspect_method_prefix = "inspect".freeze
       @wild_card_scope = "all".freeze
       @out_of_scope_placeholder = "*".freeze
       @flags_separator = " / ".freeze
       @info_separator = " | ".freeze
-      @inspect_method_prefix = "inspect".freeze
+    end
+
+    def formatter_class=(value)
+      unless value.is_a?(Class)
+        raise TypeError, "Formatter must be a Class constant"
+      end
+
+      @formatter_class = value
+    end
+
+    def inspect_method_prefix=(value)
+      @inspect_method_prefix = value.to_s.freeze
     end
 
     def wild_card_scope=(value)
@@ -47,10 +61,6 @@ module ObjectInspector
     def info_separator=(value)
       @info_separator = value.to_s.freeze
     end
-
-    def inspect_method_prefix=(value)
-      @inspect_method_prefix = value.to_s.freeze
-    end
   end
 end
 

data/object_inspector.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["paul.dobbins@icloud.com"]
 
   spec.summary       = %q{ObjectInspector generates 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 represent an object in the console, in logging, etc.}
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Paul Dobbins
@@ -151,8 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 description: 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 represent an object in the console, in logging, etc.
+  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.
 email:
 - paul.dobbins@icloud.com
 executables: []