object_identifier 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38798b7f089d030451f58184525dead78487ef58d077950f5431902f6fa81ba9
-  data.tar.gz: 6fd7204e666fc5340dfeb303c86829b8595c5c7fc9fd4047c1abf9635444f8ae
+  metadata.gz: 29e798cf195e524f05ad84c6b2d68573055a68a2ab35aa26f3cde652fd34569e
+  data.tar.gz: 552e5b2a70321be36ad0e32429346bc0c69c11526a64256116849739c5e3f894
 SHA512:
-  metadata.gz: 33eefb5c23a4f22cb0aaa9a05506068b4d6940e2f04054868dc5e7971f045893828c6372f2cd5b4dd4ff4d1fcc73200cc6cf9129d9adf9f3482ec9605a30e58a
-  data.tar.gz: 571cfbcef11143e7b052a2aa4a2e0497f3526481a068715cc3a427875751b1e9b90a0bde5cf989ca9ab2e2df026805d21a1237fbf893db63e86cae975d4ebf96
+  metadata.gz: 1adb6f5553906c1c990214c2b237f994e222c1a260f271ddd88c6a3e95c5fe60f114d7d7f34449fe17b9f19053cc8816e8b2f196ae1cdb2e9a1605982bd9e00e
+  data.tar.gz: 5704c4b611b882b4ab5180bc1f0abb0691102411cb54f80afddcd5e37112e76600c1116b09a968d56a39ea978cc9c8ed98c960500d5eda1a29e0973fb32540c5

data/README.md

@@ -5,6 +5,8 @@
 
 Object Identifier allows quick, easy, and uniform identification of an object by inspecting its class name and outputting any desirable attributes/methods. It is great for logging, sending descriptive notification messages, etc.
 
+Why? Because object identification output should be uniform and easy to build, and its output should be easy to read! Consistency improves readability.
+
 For example:
 
 ```ruby
@@ -27,11 +29,15 @@ gem "object_identifier"
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install object_identifier
+```sh
+$ gem install object_identifier
+```
 
 ## Compatibility
 
@@ -50,7 +56,7 @@ gem "object_identifier", "0.7.0"
 For Ruby 3.1 support, install object_identifier gem version 0.9.0.
 
 ```ruby
-gem "object_identifier", "0.7.0"
+gem "object_identifier", "0.9.0"
 ```
 
 Object Identifier has no other dependencies.
@@ -59,10 +65,10 @@ Object Identifier has no other dependencies.
 
 Global/default values for Object Identifier can be configured via the ObjectIdentifier::Configuration object.
 
-_Note: In a Rails app, the following would go in e.g. `config/initializers/object_identifier.rb`_
-
 ```ruby
-# Default values are shown.
+# config/initializers/object_identifier.rb
+
+# Default values are shown. Customize to your liking.
 ObjectIdentifier.configure do |config|
   config.formatter_class = ObjectIdentifier::StringFormatter
   config.default_attributes = %i[id]
@@ -76,21 +82,35 @@ end
 `identify` outputs the `id` of the receiving object by default, if it exists and no other attributes/methods are specified.
 
 ```ruby
-my_movie.identify                # => Movie[1]
+Movie = Data.define(:id, :name, :rating)
+
+my_movie = Movie[1, "Identifier Gadget", "7/10"]
+
+my_movie.identify          # => "Movie[1]"
 ```
 
 `identify` doesn't output labels if only identifying a single attribute/method. It includes labels when two or more attributes/methods are being identified.
 
 ```ruby
-my_movie.identify(:id)           # => Movie[1]
-my_movie.identify(:rating)       # => Movie["7/10"]
-my_movie.identify(:id, :rating)  # => Movie[id:1, rating:"7/10"]
+my_movie.identify(:id)     # => "Movie[1]"
+my_movie.identify(:name)   # => 'Movie["Identifier Gadget"]'
+my_movie.identify(:rating) # => 'Movie["7/10"]'
+
+my_movie.identify(:id, :name, :rating)
+# => 'Movie[id:1, name: "Identifier Gadget", rating:"7/10"]'
 ```
 
 Private methods can be identified just the same as public methods.
 
 ```ruby
-my_movie.identify(:my_private_method)  # => Movie["Shh"]
+Movie =
+  Data.define(:id, :name, :rating) do
+    private def my_private_method = "Shh"
+  end
+
+my_movie = Movie[1, "Private Identifier", "7/10"]
+
+my_movie.identify(:my_private_method) # => 'Movie["Shh"]'
 ```
 
 ### Unknown Attributes/Methods
@@ -98,21 +118,21 @@ my_movie.identify(:my_private_method)  # => Movie["Shh"]
 If the object doesn't respond to a specified attribute/method it is simply ignored:
 
 ```ruby
-my_movie.identify(:id, :rating, :other)  # => Movie[id:1, rating:"7/10"]
+my_movie.identify(:id, :rating, :unknown)   # => 'Movie[id:1, rating:"7/10"]'
 ```
 
 ### Overriding Class Names
 
 ```ruby
-my_delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[1]
-my_movie.identify(klass: nil)                   # => [1]
+my_movie.identify(class: "MyBlockbuster")  # => "MyBlockbuster[1]"
+my_movie.identify(class: nil)              # => "[1]"
 ```
 
 ### Identifying Nil
 
 ```ruby
-nil.identify(:id, :name)                 # => [no objects]
-nil.identify(:id, :name, klass: "Nope")  # => [no objects]
+nil.identify(:id, :name)                   # => "[no objects]"
+nil.identify(:id, :name, class: "Nope")    # => "[no objects]"
 ```
 
 ### Collections
@@ -120,22 +140,25 @@ nil.identify(:id, :name, klass: "Nope")  # => [no objects]
 Collections of objects are each identified in turn.
 
 ```ruby
+User = Data.define(:id, :name)
+my_user = User[2, "Bob"]
+
 [my_movie, my_user].identify(:id, :name)
-# => Movie[id:1, name:"Pi"], User[id:1, name:"Bob"]
+# => 'Movie[id:1, name:"Identifier Gadget"], User[id:2, name:"Bob"]'
 ```
 
 The number of results that will be identified from a collection can be truncated by specifying the `limit` option.
 
 ```ruby
 [my_movie, my_user].identify(:id, :name, limit: 1)
-# => Movie[id:1, name:"Pi"], ... (1 more)
+# => 'Movie[id:1, name:"Identifier Gadget"], ... (1 more)'
 ```
 
 ### Empty Collections
 
 ```ruby
-[].identify  # => [no objects]
-{}.identify  # => [no objects]
+[].identify  # => "[no objects]"
+{}.identify  # => "[no objects]"
 ```
 
 ## Supporting Gems
@@ -146,16 +169,21 @@ Object Identifier works great with the [Object Inspector](https://github.com/pdo
 
 Performance of Formatters can be tested by playing the [Formatters Benchmarking Scripts](https://github.com/pdobb/object_identifier/blob/master/script/benchmarking/formatters.rb) in the IRB console for this gem.
 
-Custom Formatters may be similarly gauged for comparison by adding them to the `custom_formatter_klasses` array before playing (loading) the script.
+Custom Formatters may be similarly gauged for comparison by putting them into constant array `CUSTOM_FORMATTER_CLASSES` before loading the script in the IRB console for this gem.
 
 ```ruby
-custom_formatter_klasses = [MyCustomFormatter]
+CUSTOM_FORMATTER_CLASSES = [MyCustomFormatter]
 
 load "script/benchmarking/formatters.rb"
+# Reporting for: Ruby v3.4.2
+
+# == Averaged ============================================================
+# ...
+#
 # ObjectIdentifier::StringFormatter
-#     58.478k (± 0.8%) i/s -    295.776k in   5.058178s
+#     38.646k (± 1.3%) i/s   (25.88 μs/i) -    196.758k in   5.092094s
 # MyCustomFormatter
-#                          ...
+#     ...
 ```
 
 ## Development

data/lib/core_ext/object.rb

@@ -13,15 +13,18 @@ class Object
   #     for this object
   #   @param [Hash] options the options for building a customized
   #     self-identifier
-  #   @option options [String, nil] :klass object class name override
+  #   @option options [String, nil] :class object class name override
   #   @option options [Integer] :limit maximum number of objects to display from
   #     a collection
   #
   # @return [String] a self-identifying string
   #
   # @example
-  #   OpenStruct.new(a: 1, b: '2', c: :"3").identify(:a, :b, :c)
-  #   # => "OpenStruct[a:1, b:\"2\", c::\"3\"]"
+  #   Struct.new(:a, :b, :c)[1, "2", :"3"].identify(:a, :b, :c, class: "Struct")
+  #   => "Struct[a:1, b:\"2\", c::\"3\"]"
+
+  #   Data.define(:a, :b, :c)[1, "2", :"3"].identify(:a, :b, :c, class: "Data")
+  #   # => "Data[a:1, b:\"2\", c::\"3\"]"
   #
   #   1.identify(:to_s) # => "Integer[to_s:\"1\"]"
   #   nil.identify      # => "[no objects]"

data/lib/object_identifier/configuration.rb

@@ -46,7 +46,7 @@ module ObjectIdentifier
 
     def formatter_class=(value)
       unless value.is_a?(Class)
-        raise TypeError, "Formatter must be a Class constant"
+        raise(TypeError, "Formatter must be a Class constant")
       end
 
       @formatter_class = value

data/lib/object_identifier/formatters/base_formatter.rb

@@ -19,6 +19,6 @@ class ObjectIdentifier::BaseFormatter
   end
 
   def call
-    raise NotImplementedError
+    raise(NotImplementedError)
   end
 end

data/lib/object_identifier/formatters/string_formatter.rb

@@ -110,7 +110,7 @@ class ObjectIdentifier::StringFormatter < ObjectIdentifier::BaseFormatter
     end
 
     def class_name
-      parameters.klass { object.class.name }
+      parameters.class { object.class.name }
     end
 
     def formatted_attributes

data/lib/object_identifier/parameters.rb

@@ -4,8 +4,8 @@
 # formatter options that may be needed for custom formatting during object
 # identification.
 class ObjectIdentifier::Parameters
-  # This String to display if `formatter_options[:klass]` isn't present.
-  KLASS_NOT_GIVEN = "NOT_GIVEN"
+  # This String to display if `formatter_options[:class]` isn't present.
+  CLASS_NOT_GIVEN = "NOT_GIVEN"
 
   attr_reader :attributes
 
@@ -26,14 +26,26 @@ class ObjectIdentifier::Parameters
   #   given object(s) with.
   # @option formatter_options[:limit] [Integer, nil] A given limit on the number
   #   of objects to interrogate.
-  # @option formatter_options[:klass] [#to_s] A preferred type name for
+  # @option formatter_options[:class] [#to_s] A preferred type name for
   #   identifying the given object(s) as.
-  def initialize(
+  def initialize( # rubocop:disable Metrics/MethodLength
         attributes: [],
         formatter_options: {})
     @attributes = attributes
     @limit = formatter_options.fetch(:limit, nil)
-    @klass = formatter_options.fetch(:klass, KLASS_NOT_GIVEN)
+    @class =
+      formatter_options.fetch(:class) {
+        # For backwards compatibility with earlier versions of this gem.
+        if formatter_options.key?(:klass)
+          warn(
+            "DEPRECATION WARNING: "\
+            "The `klass` option is deprecated and will be removed in v1.0. "\
+            "Use `class` instead.")
+          formatter_options[:klass]
+        else
+          CLASS_NOT_GIVEN
+        end
+      }
   end
 
   # NOTE: Expects a block if a value wasn't supplied on initialization.
@@ -42,9 +54,9 @@ class ObjectIdentifier::Parameters
   end
 
   # NOTE: Expects a block if a value wasn't supplied on initialization.
-  def klass
-    if klass_given?
-      @klass.to_s
+  def class
+    if class_given?
+      @class.to_s
     elsif block_given?
       yield.to_s
     else
@@ -54,7 +66,7 @@ class ObjectIdentifier::Parameters
 
   private
 
-  def klass_given?
-    @klass != KLASS_NOT_GIVEN
+  def class_given?
+    @class != CLASS_NOT_GIVEN
   end
 end

data/lib/object_identifier/version.rb

@@ -2,5 +2,5 @@
 
 module ObjectIdentifier
   # The current ObjectIdentifier gem version.
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 bindir: exe
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2025-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Object Identifier identifies an object by its class name and attributes.
 test_files: []