object_inspector 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f01a078cf1fd2426c6b8db14983ded1ef0be16abd1e0e58c9716945e5fb3f75
-  data.tar.gz: c2d17d5b4cec6f97798c943e600a64136d4bfdb231c6ae1c14b5bd3179a09142
+  metadata.gz: 9f4c63d6d3fafd3a58a9d2b5044b4d815e4778b762aa5ed38702e4ec79fcd4ec
+  data.tar.gz: 7aebf8ecc7b5ec9de2cb0b95d11b70cfdc1f91e69d306aa930843c90f7803571
 SHA512:
-  metadata.gz: b96dcc1132c1fe41b7794f25377f9809bf574c93db37a9f4b178f20bf7d563c515cda8400ea774324ac67446db1a8c374601bbef2c541ab2a3bde8dfb2b67993
-  data.tar.gz: bbefc6245702d58e25ea210a53530577f1943f0cf646012c8d27f9e068e5970748e52b1e41ce1878fe19b2caf3992ac0a8af5d7bb2cccb470ec6a354a4c5111d
+  metadata.gz: d2552d039748335690f1d3e95382232e644d875c43823d7bbb81cc5acaff3437549027e6119ee8dc1236e270bdea96e26ebd0130329d6e149bb01feac67d6c95
+  data.tar.gz: 3414d335667867d81c96701fd07bad0b71025f750c127db218915cb5e8f23116619fcfb347494aa9bc1b07b9fa5bf9056af0db82871eb029013c0417cb1bb387

data/.rubocop

@@ -0,0 +1,4 @@
+--display-cop-names
+--display-style-guide
+--extra-details
+--format=fuubar

data/.rubocop.yml

@@ -0,0 +1,145 @@
+# AllCops:
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - extend
+      - include
+      - prepend
+    attributes:
+      - attr_accessor
+      - attr_reader
+      - attr_writer
+  ExpectedOrder:
+    - constants
+    - module_inclusion
+    - attributes
+    - public_class_methods
+    - initializer
+    - public_methods
+    - predicates
+    - protected_methods
+    - private_methods
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent_relative_to_receiver
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineOperationIndentation:
+  Enabled: false # Waiting for e.g. `indented_relative_to_receiver`.
+
+Lint/AmbiguousOperator:
+  Enabled: false # Conflicts with other rules.
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false # Conflicts with other rules.
+
+Lint/Void:
+  CheckForMethodsWithNoSideEffects: true
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - new
+    - describe # Tests
+    - context # Tests
+    - ips # Benchmarking
+
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+    - "lib/object_inspector/formatters/templating_formatter.rb"
+
+Metrics/LineLength:
+  Max: 80
+  Exclude:
+    - "test/**/*"
+    - "object_inspector.gemspec"
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - a
+    - b
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/BlockDelimiters:
+  Enabled: false # Reconsider later.
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find_all: select
+    detect: detect
+    inject: inject
+
+Style/EmptyElse:
+  # It"s helpful to show intent by including a comment in an else block.
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/ExpandPathArguments:
+  Exclude:
+    - "object_inspector.gemspec"
+
+Style/FormatString:
+  Enabled: false # % notation with an Array just reads better sometimes.
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NumericPredicate:
+  AutoCorrect: true
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/StringMethods:
+  Enabled: true
+
+Style/SingleLineMethods:
+  Exclude:
+    - "test/**/*_test.rb"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.5.0 - 2018-06-11
+- Add `inspect_issues` to ObjectInspector::TemplatingFormatter.
+- Add ObjectInspector::Scope#join_name.
+- Add configurable ObjectInspector.configuration.presented_object_separator.
+
+
 ### 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.

data/Gemfile.lock

@@ -1,17 +1,31 @@
 PATH
   remote: .
   specs:
-    object_inspector (0.4.0)
+    object_inspector (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
     benchmark-ips (2.7.2)
     builder (3.2.3)
     byebug (10.0.2)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
     coderay (1.1.2)
-    docile (1.3.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.3.1)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.1)
     json (2.1.0)
     method_source (0.9.0)
     minitest (5.11.3)
@@ -20,20 +34,44 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    object_identifier (0.1.0)
+    object_identifier (0.1.1)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    rake (10.4.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    reek (4.8.1)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (>= 2.0, < 4.0)
+    rubocop (0.57.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    unicode-display_width (1.4.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
@@ -48,8 +86,10 @@ DEPENDENCIES
   object_inspector!
   pry (~> 0.11)
   pry-byebug (~> 3.6)
-  rake (~> 10.0)
+  rake (~> 12.3)
+  reek (~> 4.8)
+  rubocop (~> 0.57)
   simplecov (~> 0.16)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -55,6 +55,8 @@ ObjectInspector.configure do |config|
   config.default_scope = ObjectInspector::Scope.new(:self)
   config.wild_card_scope = "all"
   config.out_of_scope_placeholder = "*"
+  config.presenter_inspect_flags = " ⇨ "
+  config.name_separator = " - "
   config.flags_separator = " / "
   config.info_separator = " | "
 end
@@ -104,15 +106,17 @@ class MyObject
     ObjectInspector::Inspector.inspect(self)
   end
 
-private
+  private
 
   def inspect_identification; "My Object" end
   def inspect_flags; "FLAG1 / FLAG2" end
+  def inspect_issues; "ISSUE1 | ISSUE2" end
   def inspect_info; "INFO" end
   def inspect_name; "NAME" end  # Or: def display_name; "NAME" end
 end
 
-MyObject.new.inspect  # => "<My Object(FLAG1 / FLAG2) INFO :: NAME>"
+MyObject.new.inspect
+# => "<My Object(FLAG1 / FLAG2) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
 
@@ -137,12 +141,14 @@ class MyObject
   def inspect
     super(identification: "My Object",
           flags: "FLAG1",
+          issues: "ISSUE1 | ISSUE2",
           info: "INFO",
           name: "NAME")
   end
 end
 
-MyObject.new.inspect  # => "<My Object(FLAG1) INFO :: NAME>"
+MyObject.new.inspect
+# => "<My Object(FLAG1) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
 Or, define `inspect_identification`, `inspect_flags`, `inspect_info`, and/or `inspect_name` (or `display_name`) in Object.
@@ -151,15 +157,17 @@ Or, define `inspect_identification`, `inspect_flags`, `inspect_info`, and/or `in
 class MyObject
   include ObjectInspector::InspectorsHelper
 
-private
+  private
 
   def inspect_identification; "My Object" end
   def inspect_flags; "FLAG1 / FLAG2" end
+  def inspect_issues; "ISSUE1 | ISSUE2" end
   def inspect_info; "INFO" end
   def inspect_name; "NAME" end  # Or: def display_name; "NAME" end
 end
 
-MyObject.new.inspect  # => "<My Object(FLAG1 / FLAG2) INFO :: NAME>"
+MyObject.new.inspect
+# => "<My Object(FLAG1) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
 
@@ -231,11 +239,13 @@ scope.complex? { "MATCH" }  # => "*"
 ### Scope Joiners
 
 ObjectInspector::Scope also offers helper methods for uniformly joining inspect elements:
+- `join_name` -- Joins name parts with ` - ` by default
 - `join_flags` -- Joins flags with ` / ` by default
 - `join_info` -- Joins info items with ` | ` by default
 
 ```ruby
 scope = ObjectInspector::Scope.new(:verbose)
+scope.join_name([1, 2, 3])  # => "1 - 2 - 3"
 scope.join_flags([1, 2, 3])  # => "1 / 2 / 3"
 scope.join_info([1, 2, 3])   # => "1 | 2 | 3"
 ```
@@ -263,7 +273,12 @@ class MyObject
     OpenStruct.new(flags: "AO2_FLAG1")
   end
 
-private
+  # Or `def inspect_name`
+  def display_name(scope:)
+    name
+  end
+
+  private
 
   def inspect_identification
     identify(:a2)
@@ -283,6 +298,10 @@ private
     scope.join_flags(flags)
   end
 
+  def inspect_issues
+    "!!WARNING!!"
+  end
+
   def inspect_info(scope:)
     info = ["Default Info"]
     info << "Complex Info" if scope.complex?
@@ -290,40 +309,36 @@ private
 
     scope.join_info(info)
   end
-
-  # Or `def inspect_name`
-  def display_name
-    name
-  end
 end
 
 my_object = MyObject.new("Name")
 
 my_object.inspect(scope: :complex)
-# => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | Complex Info | * :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / *) !!!!WARNING!!!! Default Info | Complex Info | * :: Name>"
 
 my_object.inspect(scope: :verbose)
-# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) Default Info | Verbose Info :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!!!WARNING!!!! Default Info | Verbose Info :: Name>"
 
 my_object.inspect(scope: %i[self complex verbose])
-# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) Default Info | Complex Info | Verbose Info :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!!!WARNING!!!! Default Info | Complex Info | Verbose Info :: Name>"
 
 my_object.inspect(scope: :all)
-# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) Default Info | Complex Info | Verbose Info :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!!!WARNING!!!! Default Info | Complex Info | Verbose Info :: Name>"
 
 my_object.inspect
-# => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | * :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / *) !!!!WARNING!!!! Default Info | * :: Name>"
 
 ObjectInspector.configuration.default_scope = :complex
 my_object.inspect
-# => "<MyObject[a2:2](DEFAULT_FLAG / *) Default Info | Complex Info | * :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / *) !!!!WARNING!!!! Default Info | Complex Info | * :: Name>"
 
 ObjectInspector.configuration.default_scope = %i[self complex verbose]
 my_object.inspect
+# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!!!WARNING!!!! Default Info | Complex Info | Verbose Info :: Name>"
 
 ObjectInspector.configuration.default_scope = :all
 my_object.inspect
-# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) Default Info | Complex Info | Verbose Info :: Name>"
+# => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!!!WARNING!!!! Default Info | Complex Info | Verbose Info :: Name>"
 ```
 
 
@@ -339,7 +354,7 @@ class MyWrapperObject
     @to_model ||= MyWrappedObject.new
   end
 
-private
+  private
 
   def inspect_flags; "WRAPPER_FLAG1" end
 end
@@ -347,7 +362,7 @@ end
 class MyWrappedObject
   include ObjectInspector::InspectorsHelper
 
-private
+  private
 
   def inspect_flags; "FLAG1 / FLAG2" end
   def inspect_info; "INFO" end
@@ -428,19 +443,20 @@ class MyObject
     2
   end
 
-private
+  private
 
   def inspect_identification
     identify(:my_method1, :my_method2)
   end
 
   def inspect_flags; "FLAG1 / FLAG2" end
+  def inspect_issues; "ISSUE1 | ISSUE2" 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>"
+# => "<MyObject[my_method1:1, my_method2:2](FLAG1 / FLAG2) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
 

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/lib/object_inspector/conversions.rb

@@ -2,15 +2,14 @@ module ObjectInspector
   # ObjectInspector::Conversions defines conversion functions used by
   # ObjectInspector.
   module Conversions
-
-  module_function
+    module_function
 
     # Convert the passed in value to an {ObjectInspector::Scope} object.
     # Just returns the pass in value if it already is an
     # {ObjectInspector::Scope} object.
     #
     # @return [ObjectInspector::Scope]
-    def Scope(value)
+    def Scope(value) # rubocop:disable Naming/MethodName
       case value
       when ObjectInspector::Scope
         value

data/lib/object_inspector/formatters/base_formatter.rb

@@ -6,8 +6,6 @@ module ObjectInspector
   #
   # @attr inspector [ObjectInspector::Inspector]
   class BaseFormatter
-    RIGHT_ARROW_ICON = [0x21E8].pack("U").freeze
-
     attr_reader :inspector
 
     def initialize(inspector)
@@ -45,6 +43,14 @@ module ObjectInspector
       @flags ||= inspector.flags
     end
 
+    # Delegates to {Inspector#issues}.
+    #
+    # @return [String] if given
+    # @return [NilClass] if not given
+    def issues
+      @issues ||= inspector.issues
+    end
+
     # Delegates to {Inspector#info}.
     #
     # @return [String] if given

data/lib/object_inspector/formatters/combining_formatter.rb

@@ -16,10 +16,12 @@ module ObjectInspector
       end
     end
 
-  private
+    private
 
     def build_wrapped_object_string
-      "#{build_string} #{RIGHT_ARROW_ICON} #{wrapped_object_inspection_result}"
+      "#{build_string} "\
+      "#{ObjectInspector.configuration.presented_object_separator} "\
+      "#{wrapped_object_inspection_result}"
     end
 
     def build_string
@@ -36,7 +38,7 @@ module ObjectInspector
         build_identification_string,
         build_flags_string,
         build_info_string,
-        build_name_string,
+        build_name_string
       ].compact
     end
 

data/lib/object_inspector/formatters/templating_formatter.rb

@@ -13,6 +13,10 @@ module ObjectInspector
       @name_template ||= "<%s :: %s>".freeze
     end
 
+    def self.issues_and_name_template
+      @issues_and_name_template ||= "<%s !!%s!! :: %s>".freeze
+    end
+
     def self.flags_and_name_template
       @flags_and_name_template ||= "<%s(%s) :: %s>".freeze
     end
@@ -21,18 +25,43 @@ module ObjectInspector
       @info_and_name_template ||= "<%s %s :: %s>".freeze
     end
 
+    def self.issues_and_info_and_name_template
+      @issues_and_info_and_name_template ||= "<%s !!%s!! %s :: %s>".freeze
+    end
+
     def self.flags_and_info_template
       @flags_and_info_template ||= "<%s(%s) %s>".freeze
     end
 
+    def self.issues_and_info_template
+      @issues_and_info_template ||= "<%s !!%s!! %s>".freeze
+    end
+
+    def self.flags_and_issues_and_info_template
+      @flags_and_issues_and_info_template ||= "<%s(%s) !!%s!! %s>".freeze
+    end
+
+    def self.flags_and_issues_and_name_template
+      @flags_and_issues_and_name_template ||= "<%s(%s) !!%s!! :: %s>".freeze
+    end
+
     def self.flags_and_info_and_name_template
       @flags_and_info_and_name_template ||= "<%s(%s) %s :: %s>".freeze
     end
 
+    def self.flags_and_issues_and_info_and_name_template
+      @flags_and_issues_and_info_and_name_template ||=
+        "<%s(%s) !!%s!! %s :: %s>".freeze
+    end
+
     def self.flags_template
       @flags_template ||= "<%s(%s)>".freeze
     end
 
+    def self.issues_template
+      @issues_template ||= "<%s !!%s!!>".freeze
+    end
+
     def self.info_template
       @info_template ||= "<%s %s>".freeze
     end
@@ -48,96 +77,167 @@ module ObjectInspector
       end
     end
 
-  private
+    private
 
     def build_wrapped_object_string
-      "#{build_string} #{RIGHT_ARROW_ICON} #{wrapped_object_inspection_result}"
+      "#{build_string} "\
+      "#{ObjectInspector.configuration.presented_object_separator} "\
+      "#{wrapped_object_inspection_result}"
     end
 
+    # rubocop:disable Metrics/MethodLength
     def build_string
       if flags
-        if info
-          if name
-            build_flags_and_info_and_name_string
-          else
-            build_flags_and_info_string
-          end
-        elsif name
-          build_flags_and_name_string
-        else
-          build_flags_string
-        end
+        build_string_with_flags_and_maybe_issues_and_info_and_name
+      elsif issues
+        build_string_with_issues_and_maybe_info_and_name
       elsif info
-        if name
-          build_info_and_name_string
-        else
-          build_info_string
-        end
+        build_string_with_info_and_maybe_name
       elsif name
-        build_name_string
+        build_string_with_name
       else
         build_base_string
       end
     end
+    # rubocop:enable Metrics/MethodLength
+
+    def build_string_with_flags_and_maybe_issues_and_info_and_name
+      if issues
+        build_string_with_flags_and_issues_and_maybe_info_and_name
+      elsif info
+        build_string_with_flags_and_info_and_maybe_name
+      elsif name
+        build_string_with_flags_and_name
+      else
+        build_string_with_flags
+      end
+    end
+
+    def build_string_with_flags_and_issues_and_maybe_info_and_name
+      if info
+        build_string_with_flags_and_issues_and_info_and_maybe_name
+      elsif name
+        build_string_with_flags_and_issues_and_name
+      else
+        build_string_with_flags_and_issues
+      end
+    end
+
+    def build_string_with_flags_and_issues_and_info_and_maybe_name
+      if name
+        build_string_with_flags_and_issues_and_info_and_name
+      else
+        build_string_with_flags_and_issues_and_info
+      end
+    end
+
+    def build_string_with_issues_and_maybe_info_and_name
+      if info
+        build_string_with_issues_and_info_and_maybe_name
+      elsif name
+        build_string_with_issues_and_name
+      else
+        build_string_with_issues
+      end
+    end
+
+    def build_string_with_issues_and_info_and_maybe_name
+      if name
+        build_string_with_issues_and_info_and_name
+      else
+        build_string_with_issues_and_info
+      end
+    end
+
+    def build_string_with_flags_and_maybe_info_and_name
+      if info
+        build_string_with_flags_and_info_and_maybe_name
+      elsif name
+        build_string_with_flags_and_name
+      else
+        build_string_with_flags
+      end
+    end
+
+    def build_string_with_flags_and_info_and_maybe_name
+      if name
+        build_string_with_flags_and_info_and_name
+      else
+        build_string_with_flags_and_info
+      end
+    end
+
+    def build_string_with_info_and_maybe_name
+      if name
+        build_string_with_info_and_name
+      else
+        build_string_with_info
+      end
+    end
+
+    def build_string_with_flags_and_issues_and_info_and_name
+      self.class.flags_and_issues_and_info_and_name_template %
+        [identification, flags, issues, info, name]
+    end
+
+    def build_string_with_flags_and_issues_and_name
+      self.class.flags_and_issues_and_name_template %
+        [identification, flags, issues, name]
+    end
+
+    def build_string_with_flags_and_info_and_name
+      self.class.flags_and_info_and_name_template %
+        [identification, flags, info, name]
+    end
+
+    def build_string_with_issues_and_info_and_name
+      self.class.issues_and_info_and_name_template %
+        [identification, issues, info, name]
+    end
+
+    def build_string_with_flags_and_issues_and_info
+      self.class.flags_and_issues_and_info_template %
+        [identification, flags, issues, info]
+    end
+
+    def build_string_with_flags_and_info
+      self.class.flags_and_info_template % [identification, flags, info]
+    end
+
+    def build_string_with_flags_and_name
+      self.class.flags_and_name_template % [identification, flags, name]
+    end
 
-    def build_flags_and_info_and_name_string
-      self.class.flags_and_info_and_name_template % [
-        identification,
-        flags,
-        info,
-        name
-      ]
+    def build_string_with_issues_and_info
+      self.class.issues_and_info_template % [identification, issues, info]
     end
 
-    def build_flags_and_info_string
-      self.class.flags_and_info_template % [
-        identification,
-        flags,
-        info
-      ]
+    def build_string_with_issues_and_name
+      self.class.issues_and_name_template % [identification, issues, name]
     end
 
-    def build_flags_and_name_string
-      self.class.flags_and_name_template % [
-        identification,
-        flags,
-        name
-      ]
+    def build_string_with_info_and_name
+      self.class.info_and_name_template % [identification, info, name]
     end
 
-    def build_info_and_name_string
-      self.class.info_and_name_template % [
-        identification,
-        info,
-        name
-      ]
+    def build_string_with_flags
+      self.class.flags_template % [identification, flags]
     end
 
-    def build_name_string
-      self.class.name_template % [
-        identification,
-        name
-      ]
+    def build_string_with_issues
+      self.class.issues_template % [identification, issues]
     end
 
-    def build_flags_string
-      self.class.flags_template % [
-        identification,
-        flags
-      ]
+    def build_string_with_info
+      self.class.info_template % [identification, info]
     end
 
-    def build_info_string
-      self.class.info_template % [
-        identification,
-        info
-      ]
+    def build_string_with_name
+      self.class.name_template % [identification, name]
     end
 
     def build_base_string
-      self.class.base_template % [
-        identification
-      ]
+      self.class.base_template % [identification]
     end
   end
 end

data/lib/object_inspector/inspector.rb

@@ -49,12 +49,12 @@ module ObjectInspector
     # @return [String] if {#object_is_a_wrapper}
     # @return [NilClass] if not {#object_is_a_wrapper}
     def wrapped_object_inspection_result
-      if object_is_a_wrapper?
-        self.class.inspect(
-          extract_wrapped_object,
-          scope: scope,
-          formatter: formatter_klass)
-      end
+      return unless object_is_a_wrapper?
+
+      self.class.inspect(
+        extract_wrapped_object,
+        scope: scope,
+        formatter: formatter_klass)
     end
 
     # Core object identification details, such as the {#object} class name and
@@ -73,6 +73,14 @@ module ObjectInspector
       value(key: :flags)
     end
 
+    # Issues/Warnings applicable to {#object}.
+    #
+    # @return [String] if given
+    # @return [NilClass] if not given
+    def issues
+      value(key: :issues)
+    end
+
     # Informational details applicable to {#object}.
     #
     # @return [String] if given
@@ -91,7 +99,7 @@ module ObjectInspector
                            kargs: object_method_keyword_arguments)
     end
 
-  private
+    private
 
     def formatter
       formatter_klass.new(self)
@@ -157,7 +165,7 @@ module ObjectInspector
 
     def object_method_keyword_arguments
       {
-        scope: scope,
+        scope: scope
       }
     end
 

data/lib/object_inspector/object_interrogator.rb

@@ -29,7 +29,7 @@ module ObjectInspector
       end
     end
 
-  private
+    private
 
     def call_with_kargs
       object.send(method_name, **kargs)

data/lib/object_inspector/scope.rb

@@ -19,6 +19,15 @@ module ObjectInspector
       @names = Array(names).map { |name| String(name) }
     end
 
+    # Join the passed-in name parts with the passed in separator.
+    #
+    # @param items [Array<#to_s>]
+    # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
+    def join_name(parts,
+                  separator: ObjectInspector.configuration.name_separator)
+      Array(parts).join(separator)
+    end
+
     # Join the passed-in flags with the passed in separator.
     #
     # @param items [Array<#to_s>]
@@ -28,12 +37,21 @@ module ObjectInspector
       Array(flags).join(separator)
     end
 
+    # Join the passed-in issues with the passed in separator.
+    #
+    # @param items [Array<#to_s>]
+    # @param separator [#to_s] (ObjectInspector.configuration.issues_separator)
+    def join_issues(issues,
+                    separator: ObjectInspector.configuration.issues_separator)
+      Array(issues).join(separator)
+    end
+
     # Join the passed-in items with the passed in separator.
     #
     # @param items [Array<#to_s>]
     # @param separator [#to_s] (ObjectInspector.configuration.info_separator)
     def join_info(items,
-                   separator: ObjectInspector.configuration.info_separator)
+                  separator: ObjectInspector.configuration.info_separator)
       Array(items).join(separator)
     end
 
@@ -56,7 +74,7 @@ module ObjectInspector
       names
     end
 
-  private
+    private
 
     def method_missing(method_name, *args, &block)
       if method_name[-1] == "?"
@@ -77,9 +95,9 @@ module ObjectInspector
       end
     end
 
-    def evaluate_block_if(condition, &block)
+    def evaluate_block_if(condition)
       if condition
-        block.call(self)
+        yield(self)
       else
         ObjectInspector.configuration.out_of_scope_placeholder
       end
@@ -91,7 +109,7 @@ module ObjectInspector
     end
 
     def wild_card_scope?
-      @is_wild_card_scope ||=
+      @wild_card_scope ||=
         any_names_match?(ObjectInspector.configuration.wild_card_scope)
     end
 

data/lib/object_inspector/version.rb

@@ -1,3 +1,3 @@
 module ObjectInspector
-  VERSION = "0.4.0"
+  VERSION = "0.5.0".freeze
 end

data/lib/object_inspector.rb

@@ -1,10 +1,6 @@
 # ObjectInspector is the base namespace for all modules/classes related to the
 # object_inspector gem.
 module ObjectInspector
-  class << self
-    attr_writer :configuration
-  end
-
   def self.configuration
     @configuration ||= Configuration.new
   end
@@ -17,13 +13,19 @@ module ObjectInspector
     @configuration = Configuration.new
   end
 
+  # ObjectInspector::Configuration stores the default configuration options for
+  # the ObjectInspector gem. Modification of attributes is possible at any time,
+  # and values will persist for the duration of the running process.
   class Configuration
     attr_reader :formatter_class,
                 :inspect_method_prefix,
                 :default_scope,
                 :wild_card_scope,
                 :out_of_scope_placeholder,
+                :presented_object_separator,
+                :name_separator,
                 :flags_separator,
+                :issues_separator,
                 :info_separator
 
     def initialize
@@ -32,7 +34,10 @@ module ObjectInspector
       @default_scope = Scope.new(:self)
       @wild_card_scope = "all".freeze
       @out_of_scope_placeholder = "*".freeze
+      @presented_object_separator = " #{[0x21E8].pack("U")} ".freeze
+      @name_separator = " - ".freeze
       @flags_separator = " / ".freeze
+      @issues_separator = " | ".freeze
       @info_separator = " | ".freeze
     end
 
@@ -60,10 +65,22 @@ module ObjectInspector
       @out_of_scope_placeholder = value.to_s.freeze
     end
 
+    def presented_object_separator=(value)
+      @presented_object_separator = value.to_s.freeze
+    end
+
+    def name_separator=(value)
+      @name_separator = value.to_s.freeze
+    end
+
     def flags_separator=(value)
       @flags_separator = value.to_s.freeze
     end
 
+    def issues_separator=(value)
+      @issues_separator = value.to_s.freeze
+    end
+
     def info_separator=(value)
       @info_separator = value.to_s.freeze
     end

data/object_inspector.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "object_inspector/version"
@@ -9,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Paul Dobbins"]
   spec.email         = ["paul.dobbins@icloud.com"]
 
-  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.summary       = "ObjectInspector builds uniformly formatted inspect output with customizable amounts of detail."
+  spec.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 represents objects. Great for the console, logging, etc."
   spec.homepage      = "https://github.com/pdobb/object_inspector"
   spec.license       = "MIT"
 
@@ -23,21 +22,24 @@ Gem::Specification.new do |spec|
   #     "public gem pushes."
   # end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files =
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "benchmark-ips", "~> 2.7"
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", "~> 1.2"
-  spec.add_development_dependency "simplecov", "~> 0.16"
-  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "object_identifier", "~> 0.1"
   spec.add_development_dependency "pry", "~> 0.11"
   spec.add_development_dependency "pry-byebug", "~> 3.6"
-  spec.add_development_dependency "benchmark-ips", "~> 2.7"
-  spec.add_development_dependency "object_identifier", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "reek", "~> 4.8"
+  spec.add_development_dependency "rubocop", "~> 0.57"
+  spec.add_development_dependency "simplecov", "~> 0.16"
 end

data/scripts/benchmarking/formatters.rb

@@ -9,7 +9,7 @@ custom_formatter_klasses ||= []
 formatter_klasses = [
   ObjectInspector::TemplatingFormatter,
   ObjectInspector::CombiningFormatter,
-  *Array(custom_formatter_klasses),
+  *Array(custom_formatter_klasses)
 ]
 
 INSPECTOR_WITH_FLAGS_AND_INFO_AND_NAME ||=
@@ -49,7 +49,6 @@ INSPECTOR_WITH_BASE ||=
   OpenStruct.new(
     identification: "IDENTIFICATION")
 
-
 puts "== Averaged ============================================================="
 Benchmark.ips { |x|
   formatter_klasses.each do |formatter_klass|
@@ -66,10 +65,9 @@ Benchmark.ips { |x|
   end
 
   x.compare!
-};
+}
 puts "== Done"
 
-
 puts "== Individualized ======================================================="
 Benchmark.ips { |x|
   formatter_klasses.each do |formatter_klass|
@@ -114,5 +112,5 @@ Benchmark.ips { |x|
   end
 
   x.compare!
-};
+}
 puts "== Done"

data/scripts/benchmarking/object_inspector.rb

@@ -43,7 +43,6 @@ OBJECT_WITH_BASE ||=
   OpenStruct.new(
     identification: "IDENTIFICATION")
 
-
 puts "== Averaged ============================================================="
 Benchmark.ips { |x|
   x.report(inspector_klass) {
@@ -69,5 +68,5 @@ Benchmark.ips { |x|
   }
 
   x.compare!
-};
+}
 puts "== Done"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Paul Dobbins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -67,89 +81,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: object_identifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '4.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
-  name: object_identifier
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.57'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.57'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 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 represents objects. Great for the console, logging,
@@ -161,6 +189,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -203,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: ObjectInspector builds uniformly formatted inspect output with customizable