object_inspector 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5bfaac0270b232c17c91495180cf29e5a4538c1010e636cf681832d6668ba8c
-  data.tar.gz: fd5e4add5c7a5c7d971ec22a4d5ba80e78642d4df9e060c6382b6b7a93e67551
+  metadata.gz: b3f1b53680d632fb88f63e951032b3be151ac352501620742cc091aaaf15a244
+  data.tar.gz: 4a059bdf8a0f6033d52bd05c1bb24ad83d33f7dde4d0b8ccd7ae010630566506
 SHA512:
-  metadata.gz: 0b31e59f84e625d766309ba1dd760a87bba5b70007214aeec3dd3f47c44e64446db34c640a5a9c35923881178eb61c98080138d542ba1fe1b632a93d1269b4ee
-  data.tar.gz: 777ee932d2e9fa0c0d4c013dd9f0c8713956afafd883ce866fccb93f23b25fa8eaddb729b6035fd74c514bf9865f40bca09cb06fc2153a4f927458b7dbdbad45
+  metadata.gz: 31eb8c71b23c092697db6b8f35b787581a472c13f6aded499602731546b2121fd07952650319e836af6368cf745f29f156ac2a31722a09a6d83cadb4c238e2d4
+  data.tar.gz: 6e605745d774bcca73bf93ccd6b818044bb10365832c2f3b2f182bb1884b4de145f0328d81d82ae78fdf65a4609053f51b242ba2790e6071ca083111f5becc7b

data/.rubocop.yml

@@ -36,15 +36,18 @@ Layout/EmptyLineAfterGuardClause:
 Layout/EndOfLine:
   EnforcedStyle: lf
 
-Layout/FirstParameterIndentation:
+Layout/IndentFirstArgument:
   EnforcedStyle: consistent_relative_to_receiver
 
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
+Layout/IndentFirstParameter:
+  Enabled: false # Revisit if more settings become available.
+
 Layout/MultilineAssignmentLayout:
   Enabled: true
 

data/CHANGELOG.md

@@ -1,9 +1,16 @@
-### 0.6.0 - 2019-03-13
-- Fix inspection of delegating wrapper objects
+### 0.6.2 - 2022-12-30
+- Internal spruce-up for Ruby 3.2. No outward-facing changes.
+- Remove travis-ci config since travis-ci is no longer in use.
+
+### 0.6.1 - 2019-06-27
+- Flatten and compact arrays of `nil`s as well as nested arrays of `nil`s in join_* methods.
 
+### 0.6.0 - 2019-03-13
+- Fix inspection of delegating wrapper objects.
+- Allow clearing output of inspect methods.
 
 ### 0.5.2 - 2019-02-24
-- Automatically compact nils in join_* methods
+- Automatically compact nils in join_* methods.
 
 ### 0.5.1 - 2018-06-12
 - Don't include empty strings from Scope#join_* methods when applicable.
@@ -13,29 +20,23 @@
 - 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.
 
-
 ### 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.
 - Add ObjectInspector::Scope.join_flags helper method.
 - Add ObjectInspector::Scope.join_info helper method.
 - Scope: Show an out-of-scope-placeholder symbol (*) when predicate is not matched and a block is given.
 - Scope: Add wild-card "all" scope that is always evaluated as true / a match.
-- Add ability to specify multiple scopes. e.g. my_object.inspect(scope: %i[verbose complex])
+- Add ability to specify multiple scopes. e.g. my_object.inspect(scope: %i[verbose complex]).
 - Add gem defaults configuration.
 
-
 ### 0.2.0 - 2018-04-12
-
 - Automatically inspect wrapped Objects, if applicable.
 - Use `display_name` if defined on object, in place of `inspect_name`.
 - Add on-the-fly inspect methods when Symbols are passed in to #inspect.
@@ -45,5 +46,4 @@
 
 
 ### 0.1.0 - 2018-04-09
-
 - Initial release!

data/Gemfile.lock

@@ -1,82 +1,65 @@
 PATH
   remote: .
   specs:
-    object_inspector (0.6.0)
+    object_inspector (0.6.2)
 
 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 (11.0.0)
-    codeclimate-engine-rb (0.4.1)
-      virtus (~> 1.0)
-    coderay (1.1.2)
-    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.2)
-    json (2.2.0)
+    ast (2.4.2)
+    benchmark-ips (2.10.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    docile (1.4.0)
+    json (2.6.3)
     kwalify (0.7.2)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    minitest-reporters (1.3.6)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    object_identifier (0.2.1)
-    parallel (1.14.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
+    object_identifier (0.4.1)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.10)
-    psych (3.1.0)
-    rainbow (3.0.0)
-    rake (12.3.2)
-    reek (5.3.1)
-      codeclimate-engine-rb (~> 0.4.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    reek (6.1.3)
       kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
-      psych (~> 3.1.0)
+      parser (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    rubocop (0.65.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.41.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      psych (>= 3.1.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.22.0)
       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.1)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby
@@ -97,4 +80,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.0.1
+   2.4.1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Paul Dobbins
+Copyright (c) 2023 Paul DobbinSchmaltz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,13 +1,12 @@
 # ObjectInspector
 
 [![Gem Version](https://badge.fury.io/rb/object_inspector.svg)](https://badge.fury.io/rb/object_inspector)
-[![Build Status](https://travis-ci.org/pdobb/object_inspector.svg?branch=master)](https://travis-ci.org/pdobb/object_inspector)
 [![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, issues, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc.
+ObjectInspector 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.
 
-Because object inspection code should be uniform, easy to build, and its output should be easy to read!
+Why? 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).
 
@@ -36,7 +35,9 @@ Tested MRI Ruby Versions:
 * 2.4
 * 2.5
 * 2.6
-* edge
+* 2.7
+* 3.1
+* 3.2
 
 ObjectInspector has no other dependencies.
 
@@ -455,6 +456,28 @@ MyObject.new.inspect(info: :my_method2)   # => "<MyObject Result2>"
 MyObject.new.inspect                      # => "<MyObject my_method2>"
 ```
 
+## Clearing Output for Specified Inspect Method
+
+Pass `nil` to any inspect method type to not display it:
+
+```ruby
+class MyObject
+  include ObjectInspector::InspectorsHelper
+
+  def inspect_identification; "My Object" end
+  def inspect_info; "INFO" end
+  def inspect_flags; "FLAG1" end
+  def inspect_issues; "ISSUE1" end
+end
+
+MyObject.new.inspect
+# => "<My Object(FLAG1) !!ISSUE1!! INFO>"
+MyObject.new.inspect(info: nil, flags: nil, issues: nil)
+# => "<My Object>"
+MyObject.new.inspect(identification: nil, info: nil, flags: nil, issues: nil)
+# => "<MyObject>"
+```
+
 
 ## Custom Formatters
 
@@ -580,7 +603,9 @@ play scripts/benchmarking/formatters.rb
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
 ## Contributing

data/lib/object_inspector/scope.rb

@@ -27,8 +27,7 @@ module ObjectInspector
     # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
     def join_name(parts,
                   separator: ObjectInspector.configuration.name_separator)
-      the_parts = Array(parts).tap(&:compact!)
-      the_parts.join(separator) if the_parts.any?
+      _join(parts, separator)
     end
 
     # Join the passed-in flags with the passed in separator.
@@ -37,8 +36,7 @@ module ObjectInspector
     # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
     def join_flags(flags,
                    separator: ObjectInspector.configuration.flags_separator)
-      the_flags = Array(flags).tap(&:compact!)
-      the_flags.join(separator) if the_flags.any?
+      _join(flags, separator)
     end
 
     # Join the passed-in issues with the passed in separator.
@@ -47,8 +45,7 @@ module ObjectInspector
     # @param separator [#to_s] (ObjectInspector.configuration.issues_separator)
     def join_issues(issues,
                     separator: ObjectInspector.configuration.issues_separator)
-      the_issues = Array(issues).tap(&:compact!)
-      the_issues.join(separator) if the_issues.any?
+      _join(issues, separator)
     end
 
     # Join the passed-in items with the passed in separator.
@@ -57,8 +54,7 @@ module ObjectInspector
     # @param separator [#to_s] (ObjectInspector.configuration.info_separator)
     def join_info(items,
                   separator: ObjectInspector.configuration.info_separator)
-      the_items = Array(items).tap(&:compact!)
-      the_items.join(separator) if the_items.any?
+      _join(items, separator)
     end
 
     # Compare self with the passed in object.
@@ -108,6 +104,13 @@ module ObjectInspector
       end
     end
 
+    def _join(items, separator)
+      items = Array(items)
+      items.flatten!
+      items.compact!
+      items.join(separator) unless items.empty?
+    end
+
     def match?(scope_name)
       any_names_match?(scope_name) ||
         wild_card_scope?

data/lib/object_inspector/version.rb

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

data/object_inspector.gemspec

@@ -7,8 +7,8 @@ require "object_inspector/version"
 Gem::Specification.new do |spec|
   spec.name          = "object_inspector"
   spec.version       = ObjectInspector::VERSION
-  spec.authors       = ["Paul Dobbins"]
-  spec.email         = ["paul.dobbins@icloud.com"]
+  spec.authors       = ["Paul DobbinSchmaltz"]
+  spec.email         = ["p.dobbinschmaltz@icloud.com"]
 
   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, issues, info, and/or a name along with an optional, self-definable scope option to represents objects. Great for the console, logging, etc."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
-- Paul Dobbins
-autorequire: 
+- Paul DobbinSchmaltz
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -183,7 +183,7 @@ description: ObjectInspector takes Object#inspect to the next level. Specify any
   self-definable scope option to represents objects. Great for the console, logging,
   etc.
 email:
-- paul.dobbins@icloud.com
+- p.dobbinschmaltz@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -191,7 +191,6 @@ files:
 - ".gitignore"
 - ".rubocop"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -217,7 +216,7 @@ homepage: https://github.com/pdobb/object_inspector
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,8 +231,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: ObjectInspector builds uniformly formatted inspect output with customizable
   amounts of detail.

data/.travis.yml

@@ -1,21 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=7711465d4611bd7f1211f3262ac4ba750ffcda0574c3c6e4a6ba55446871dd17
-sudo: false
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head
-notifications:
-  email: false
-before_install: gem install bundler -v 1.16.1
-cache: bundler
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT