object_inspector 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20f26835756f0ebb2f4ecb6371662cc35a4cb9d62e72682a5b76d8e96ca8290
-  data.tar.gz: c41e95352adedc432259b57f8ed0be5e16a9a0b7860ba23e5bbd8f8fa1cecf9f
+  metadata.gz: 391dabb8dbbee7bad63ca6a701193227c2829affa135db1b58035153ced6d079
+  data.tar.gz: 9ce283422270b1dee3a517dfb39cb52438504867924061277732e16ac58347ca
 SHA512:
-  metadata.gz: 141e7e013e692ff025d7f6c2bc11f395ed6ff8499c30e5d161d7e5fc0219f2981b688ea1db6c01a80e87363553bf07a5b8319d04db744f688a3839bcf9ff1982
-  data.tar.gz: 4a811cba205e011f8d8ce390c89da2aa93dd01e21692ce28516739b35c7907c7f7e416f606c39fdfb92edba237f76ac439175dd90c1fefc498b7e8ad25bbcfae
+  metadata.gz: 662abef818a3761fafcddbac8dfb7c1219afb3d4b49d9eff61fe9b843c5e45b9af9b3714ce75f62164157dbd9d01a6ff9ffa35a774fa88f1f029929bf8e27e0f
+  data.tar.gz: 8d8048b05386af2d81bea333827e9efadfba6b4de9bf62375e164ca46455773c962b798162e11671594048848c4904deb4ec0304cbcec2dba0ee1705aeec77b2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Paul DobbinSchmaltz
+Copyright (c) 2024 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,6 +1,7 @@
 # Object Inspector
 
-[![Gem Version](https://badge.fury.io/rb/object_inspector.svg)](https://badge.fury.io/rb/object_inspector)
+[![Gem Version](https://img.shields.io/github/v/release/pdobb/object_inspector)](https://img.shields.io/github/v/release/pdobb/object_inspector)
+[![CI Actions](https://github.com/pdobb/object_inspector/actions/workflows/ci.yml/badge.svg)](https://github.com/pdobb/object_inspector/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/34e821263d9e0c33d536/maintainability)](https://codeclimate.com/github/pdobb/object_inspector/maintainability)
 
 Object Inspector 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.
@@ -9,7 +10,6 @@ Why? Because object inspection code should be uniform, easy to build, and its ou
 
 If you'd like to just jump into an example: [Full Example](#full-example).
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,17 +26,15 @@ Or install it yourself:
 
     $ gem install object_inspector
 
-
 ## Compatibility
 
 Tested MRI Ruby Versions:
-* 2.7
-* 3.0
-* 3.1
-* 3.2
 
-Object Inspector has no other dependencies.
+- 3.1
+- 3.2
+- 3.3
 
+Object Inspector has no other dependencies.
 
 ## Configuration
 
@@ -60,7 +58,6 @@ ObjectInspector.configure do |config|
 end
 ```
 
-
 ## Usage
 
 Given, an object of any type, call ObjectInspector::Inspector.inspect.
@@ -77,7 +74,6 @@ MyObject.new.inspect  # => "<MyObject>"
 
 See also [Helper Usage](#helper-usage) for an even simpler usage option.
 
-
 ### Output Customization
 
 Use the `identification`, `flags`, `info`, and/or `name` options to customize inspect output.
@@ -118,7 +114,6 @@ MyObject.new.inspect
 # => "<My Object(FLAG1 / FLAG2) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
-
 ## Helper Usage
 
 To save some typing, include ObjectInspector::InspectHelper into an object and ObjectInspector::Inspector.inspect will be called on `self` automatically.
@@ -169,13 +164,11 @@ MyObject.new.inspect
 # => "<My Object(FLAG1) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
-
 ## Scopes
 
 Use the `scope` option to define the scope of the `inspect_*` methods. The supplied value will be wrapped by the ObjectInspector::Scope helper object.
 The default value is `ObjectInspector::Scope.new(:self)`.
 
-
 ### Scope Names
 
 ObjectInspector::Scope acts like [ActiveSupport::StringInquirer](http://api.rubyonrails.org/classes/ActiveSupport/StringInquirer.html). This is a prettier way to test for a given type of "scope" within objects.
@@ -186,8 +179,8 @@ The ObjectInspector::Scope objects in these examples are the same as specifying
 my_object.inspect(scope: <scope_name>)
 ```
 
-
 Options:
+
 - `:self` (Default) -- Is meant to confine object interrogation to self (don't interrogate neighboring objects).
 - `:all` -- Is meant to match on all scopes, regardless of their name.
 - `<custom>` -- Anything else that makes sense for the object to key on.
@@ -199,7 +192,6 @@ scope.verbose?  # => false
 scope.complex?  # => false
 ```
 
-
 #### Multiple Scope Names
 
 It is also possible to pass in multiple scope names to match on.
@@ -211,7 +203,6 @@ scope.verbose?  # => true
 scope.complex?  # => true
 ```
 
-
 #### The "Wild Card" Scope
 
 Finally, `:all` is a "wild card" scope name, and will match on all scope names.
@@ -223,7 +214,6 @@ scope.verbose?  # => true
 scope.complex?  # => true
 ```
 
-
 ### Scope blocks
 
 Passing a block to a scope predicate falls back to the out-of-scope placeholder (`*` by default) if the scope does not match.
@@ -234,7 +224,6 @@ scope.verbose? { "MATCH" }  # => "MATCH"
 scope.complex? { "MATCH" }  # => "*"
 ```
 
-
 ### Scope Joiners
 
 ObjectInspector::Scope also offers helper methods for uniformly joining inspect elements:
@@ -252,7 +241,6 @@ scope.join_info([1, 2, 3])   # => "1 | 2 | 3"
 scope.join_info([1, 2, 3, nil])   # => "1 | 2 | 3"
 ```
 
-
 ## Full Example
 
 ```ruby
@@ -343,7 +331,6 @@ my_object.inspect
 # => "<MyObject[a2:2](DEFAULT_FLAG / AO1_FLAG1 / AO2_FLAG1) !!!!WARNING!!!! Default Info | Complex Info | Verbose Info :: Name>"
 ```
 
-
 ## Wrapped Objects
 
 If the Object being inspected wraps another object -- i.e. defines #to_model and #to_model returns an object other than self -- the inspect output will re-inspect the wrapped object. The wrapper points to the wrapped object with an arrow (⇨).
@@ -376,7 +363,6 @@ 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:
@@ -432,7 +418,6 @@ 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.
@@ -474,7 +459,6 @@ MyObject.new.inspect(identification: nil, info: nil, flags: nil, issues: nil)
 # => "<MyObject>"
 ```
 
-
 ## 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). Then, either override the ObjectInspector::Configuration#formatter_class value (see [Configuration](#configuration)) or just pass your custom class name into ObjectInspector::Inspector.new.
@@ -503,10 +487,10 @@ MyObject.new.inspect
 ```
 
 See examples:
+
 - [ObjectInspector::TemplatingFormatter]
 - [ObjectInspector::CombiningFormatter]
 
-
 ## Supporting Gems
 
 Object Inspector works great with the [Object Identifier](https://github.com/pdobb/object_identifier) gem.
@@ -539,31 +523,29 @@ MyObject.new.inspect
 # => "<MyObject[my_method1:1, my_method2:2](FLAG1 / FLAG2) !!ISSUE1 | ISSUE2!! INFO :: NAME>"
 ```
 
-
 ## Performance
 
 ### Benchmarking Object Inspector
 
 ObjectInspetor is ~4x slower than Ruby's default inspect.
 
-Performance of Object Inspector can be tested by playing the [Object Inspector Benchmarking Script](https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/object_inspector.rb) in the pry console for this gem.
+Performance of Object Inspector can be tested by playing the [Object Inspector Benchmarking Script](https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/object_inspector.rb) in the IRB console for this gem.
 
 ```ruby
-play script/benchmarking/object_inspector.rb
+load "script/benchmarking/object_inspector.rb"
 # Comparison:
 #                 Ruby:    30382.2 i/s
 # ObjectInspector::Inspector:     7712.2 i/s - 3.94x  slower
 ```
 
-
 ### Benchmarking Formatters
 
 [ObjectInspector::TemplatingFormatter] -- which is the default Formatter -- outperforms [ObjectInspector::CombiningFormatter] by about 30% on average.
 
-Performance of Formatters can be tested by playing the [Formatters Benchmarking Scripts](https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/formatters.rb) in the pry console for this gem.
+Performance of Formatters can be tested by playing the [Formatters Benchmarking Scripts](https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/formatters.rb) in the IRB console for this gem.
 
 ```ruby
-play script/benchmarking/formatters.rb
+load "script/benchmarking/formatters.rb"
 # == Averaged =============================================================
 # ...
 #
@@ -574,7 +556,6 @@ play script/benchmarking/formatters.rb
 # == Done
 ```
 
-
 #### Benchmarking Custom Formatters
 
 Custom Formatters may be similarly gauged for comparison by adding them to the `custom_formatter_klasses` array before playing the script.
@@ -594,18 +575,45 @@ play script/benchmarking/formatters.rb
 # == Done
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Or, run `rake` to run the tests plus linters as well as `yard` (to confirm proper YARD documentation practices). 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`, bump the latest ruby target versions etc. with `rake bump`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Testing
+
+To test this gem (gemwork):
+
+```bash
+rake
+```
+
+#### Linters
+
+```bash
+rubocop
+
+reek
+
+npx prettier . --check
+npx prettier . --write
+```
+
+### Releases
+
+To release a new version of object_inspector to RubyGems:
+
+1. Update the version number in `version.rb`
+2. Update `CHANGELOG.md`
+3. Run `bundle` to update Gemfile.lock with the latest version info
+4. Commit the changes. e.g. `Bump to vX.Y.Z`
+5. Run `rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ### Documentation
 
 [YARD documentation](https://yardoc.org/index.html) can be generated and viewed live:
+
 1. Install YARD: `gem install yard`
 2. Run the YARD server: `yard server --reload`
 3. Open the live documentation site: `open http://localhost:8808`
@@ -616,12 +624,10 @@ While the YARD server is running, documentation in the live site will be auto-up
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pdobb/object_inspector.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-
 [ObjectInspector::TemplatingFormatter]: https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/formatters/templating_formatter.rb
 [ObjectInspector::CombiningFormatter]: https://github.com/pdobb/object_inspector/blob/master/lib/object_inspector/formatters/combining_formatter.rb
 [Object Inspector Benchmarking Scripts]: https://github.com/pdobb/object_inspector/blob/master/script/benchmarking/object_inspector.rb

data/lib/object_inspector/inspector.rb

@@ -104,8 +104,8 @@ class ObjectInspector::Inspector
       value(key: key)
     else
       interrogate_object_inspect_method(key) ||
-        interrogate_object(method_name: :display_name,
-                           kwargs: object_method_keyword_arguments)
+        interrogate_object(
+          method_name: :display_name, kwargs: object_method_keyword_arguments)
     end
   end
 

data/lib/object_inspector/scope.rb

@@ -28,8 +28,8 @@ class ObjectInspector::Scope
   #
   # @param parts [Array<#to_s>]
   # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
-  def join_name(parts,
-                separator: ObjectInspector.configuration.name_separator)
+  def join_name(
+        parts, separator: ObjectInspector.configuration.name_separator)
     _join(parts, separator)
   end
 
@@ -37,8 +37,8 @@ class ObjectInspector::Scope
   #
   # @param flags [Array<#to_s>]
   # @param separator [#to_s] (ObjectInspector.configuration.flags_separator)
-  def join_flags(flags,
-                 separator: ObjectInspector.configuration.flags_separator)
+  def join_flags(
+        flags, separator: ObjectInspector.configuration.flags_separator)
     _join(flags, separator)
   end
 
@@ -46,8 +46,8 @@ class ObjectInspector::Scope
   #
   # @param issues [Array<#to_s>]
   # @param separator [#to_s] (ObjectInspector.configuration.issues_separator)
-  def join_issues(issues,
-                  separator: ObjectInspector.configuration.issues_separator)
+  def join_issues(
+        issues, separator: ObjectInspector.configuration.issues_separator)
     _join(issues, separator)
   end
 
@@ -55,8 +55,8 @@ class ObjectInspector::Scope
   #
   # @param items [Array<#to_s>]
   # @param separator [#to_s] (ObjectInspector.configuration.info_separator)
-  def join_info(items,
-                separator: ObjectInspector.configuration.info_separator)
+  def join_info(
+        items, separator: ObjectInspector.configuration.info_separator)
     _join(items, separator)
   end
 
@@ -66,7 +66,7 @@ class ObjectInspector::Scope
   # @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?, :==
 
@@ -82,10 +82,10 @@ class ObjectInspector::Scope
 
   private
 
-  def method_missing(method_name, *args, &block)
+  def method_missing(method_name, *args, &)
     if method_name[-1] == "?"
       scope_name = method_name[0..-2]
-      evaluate_match(scope_name, &block)
+      evaluate_match(scope_name, &)
     else
       super
     end

data/lib/object_inspector/version.rb

@@ -2,5 +2,5 @@
 
 module ObjectInspector
   # The current ObjectInspector gem version.
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_inspector
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -25,49 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: gemwork
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,48 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pdobb-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,48 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Object Inspector 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
@@ -231,14 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Object Inspector builds uniformly formatted inspect output with customizable