object_identifier 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b85174f7e95e1acad9f62da0d27dd867435668009aaf20d37a77de955835837
-  data.tar.gz: bbf1820134da13adc7bf0cc1ed41653afa63a0b0023b205d5b5179156227f202
+  metadata.gz: 38798b7f089d030451f58184525dead78487ef58d077950f5431902f6fa81ba9
+  data.tar.gz: 6fd7204e666fc5340dfeb303c86829b8595c5c7fc9fd4047c1abf9635444f8ae
 SHA512:
-  metadata.gz: 0beefb1a00fe450580879bcd8b1095f30a412eaa2b6a32033c614753b828eb6a4bb96e5d891935666d82cde9233bf73c010162d9bccb345a4946ab4f4e7f2833
-  data.tar.gz: 48b59efffdb83a460f471d6ba957b6ba3166b3aaf6cc1b19d7d17afd4a274b607de02a4f853f51806489f56de77bfaa4c2cc2461665f8dd5bee61f8dd4b27145
+  metadata.gz: 33eefb5c23a4f22cb0aaa9a05506068b4d6940e2f04054868dc5e7971f045893828c6372f2cd5b4dd4ff4d1fcc73200cc6cf9129d9adf9f3482ec9605a30e58a
+  data.tar.gz: 571cfbcef11143e7b052a2aa4a2e0497f3526481a068715cc3a427875751b1e9b90a0bde5cf989ca9ab2e2df026805d21a1237fbf893db63e86cae975d4ebf96

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Paul DobbinSchmaltz
+Copyright (c) 2025 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

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://img.shields.io/github/v/release/pdobb/object_identifier)](https://img.shields.io/github/v/release/pdobb/object_identifier)
 [![CI Actions](https://github.com/pdobb/object_identifier/actions/workflows/ci.yml/badge.svg)](https://github.com/pdobb/object_identifier/actions)
-[![Maintainability](https://api.codeclimate.com/v1/badges/0b737a72d16ec755c1ff/maintainability)](https://codeclimate.com/github/pdobb/object_identifier/maintainability)
 
 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.
 
@@ -38,11 +37,17 @@ Or install it yourself as:
 
 Tested MRI Ruby Versions:
 
-- 3.1
 - 3.2
 - 3.3
+- 3.4
 
-Note: For Ruby 2.7 or 3.1 support, install object_identifier gem version 0.7.0.
+For Ruby 2.7 support, install object_identifier gem version 0.7.0.
+
+```ruby
+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"
@@ -133,36 +138,6 @@ The number of results that will be identified from a collection can be truncated
 {}.identify  # => [no objects]
 ```
 
-## Custom Object Identifiers
-
-Internally, Object Identifier calls `inspect_lit` to return a "literally-inspected" string representation of an object. This works because Object, itself, is monkey-patched to define `inspect_lit` which just returns `inspect`. This is sufficient for most objects, but some objects will benefit from defining special output from `inspect_lit`.
-
-Object Identifier defines `inspect_lit` on three other core objects: String, Symbol, and BigDecimal.
-
-```ruby
-"a_string".inspect_lit           # => "\"a_string\""
-:a_symbol.inspect_lit            # => ":\"a_symbol\""
-BigDecimal(1.99, 3).inspect_lit  # => "<BD:1.99>"
-```
-
-To identify an object in a special way, just define `inspect_lit` to return a custom String.
-
-```ruby
-class MyValueObject
-  def initialize(val)
-    @val = val
-  end
-
-  def inspect_lit
-    "#{@val} Meters"
-  end
-end
-
-my_value_object = MyValueObject.new(42)
-OpenStruct.new(my_value: my_value_object).identify(:my_value)
-# => "OpenStruct[my_value:42 Meters]"
-```
-
 ## Supporting Gems
 
 Object Identifier works great with the [Object Inspector](https://github.com/pdobb/object_inspector) gem.
@@ -191,7 +166,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ### Testing
 
-To test this gem (gemwork):
+To test this gem:
 
 ```bash
 rake
@@ -210,7 +185,7 @@ npx prettier . --write
 
 ### Releases
 
-To release a new version of Gemwork to RubyGems:
+To release a new version of this gem to RubyGems:
 
 1. Update the version number in `version.rb`
 2. Update `CHANGELOG.md`

data/lib/core_ext/object.rb

@@ -2,14 +2,6 @@
 
 # Reopen the core Object class to add {#identify} to all objects.
 class Object
-  # Standard #inspect for any object that doesn't override this method. This
-  # method is meant to make an object's type inherently obvious inspected.
-  #
-  # @return [String] a String-literal representation of this object
-  def inspect_lit
-    inspect
-  end
-
   # Instance method for constructing a self-identifying string for any given
   # object or list of objects.
   #
@@ -39,7 +31,7 @@ class Object
   #
   #   (1..10).to_a.identify(:to_f, limit: 2)
   #   # => "Integer[to_f:1.0], Integer[to_f:2.0], ... (8 more)"
-  def identify(*args, **kwargs)
-    ObjectIdentifier.(self, *args, **kwargs)
+  def identify(...)
+    ObjectIdentifier.(self, ...)
   end
 end

data/lib/object_identifier/formatters/string_formatter.rb

@@ -23,14 +23,14 @@ class ObjectIdentifier::StringFormatter < ObjectIdentifier::BaseFormatter
 
   private
 
-  def format_collection
-    Collection.new(objects, parameters).call
-  end
-
   def format_item(object = objects.first)
     Item.new(object, parameters).call
   end
 
+  def format_collection
+    Collection.new(objects, parameters).call
+  end
+
   # ObjectIdentifier::StringFormatter::Collection formats a collection-specific
   # identification String, which will also necessarily be composed of
   # {ObjectIdentifier::StringFormatter::Item} identification Strings.
@@ -122,9 +122,9 @@ class ObjectIdentifier::StringFormatter < ObjectIdentifier::BaseFormatter
     def attributes_formatter
       @attributes_formatter ||=
         if attributes_hash.one?
-          ->(_key, value) { value.inspect_lit }
+          ->(_key, value) { value.inspect }
         else # attributes_hash.size > 1
-          ->(key, value) { "#{key}:#{value.inspect_lit}" }
+          ->(key, value) { "#{key}:#{value.inspect}" }
         end
     end
 

data/lib/object_identifier/object_identifier.rb

@@ -12,7 +12,6 @@ module ObjectIdentifier
         *attributes,
         formatter_class: default_formatter_class,
         **formatter_options)
-
     parameters =
       ObjectIdentifier::Parameters.build(
         attributes: attributes,

data/lib/object_identifier/version.rb

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

data/lib/object_identifier.rb

@@ -18,6 +18,3 @@ require "object_identifier/formatters/string_formatter"
 # CORE EXTENSIONS
 
 require "core_ext/object"
-require "core_ext/string"
-require "core_ext/symbol"
-require "core_ext/big_decimal"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2025-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -63,10 +62,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- lib/core_ext/big_decimal.rb
 - lib/core_ext/object.rb
-- lib/core_ext/string.rb
-- lib/core_ext/symbol.rb
 - lib/object_identifier.rb
 - lib/object_identifier/array_wrap.rb
 - lib/object_identifier/configuration.rb
@@ -84,7 +80,6 @@ metadata:
   source_code_uri: https://github.com/pdobb/object_identifier
   homepage_uri: https://github.com/pdobb/object_identifier
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,15 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Object Identifier identifies an object by its class name and attributes.
 test_files: []

data/lib/core_ext/big_decimal.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "bigdecimal"
-
-# Reopen the core BigDecimal class to represent {#inspect_lit}.
-class BigDecimal
-  # Formats this BigDecimal as an object-type-revealing String.
-  #
-  # @return [String] a String representation of this BigDecimal object
-  #
-  # @example
-  #   BigDecimal.new(1).inspect_lit          # => "<BD:1.0>"
-  #   BigDecimal.new(99.999, 5).inspect_lit  # => "<BD:99.999>"
-  def inspect_lit
-    "<BD:#{self}>"
-  end
-end

data/lib/core_ext/string.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-# Reopen the core String class to represent {#inspect_lit}.
-class String
-  # Formats self to look like a String literal so that object type will be
-  # inherently obvious when inspected.
-  #
-  # @return [String] a String-literal representation of this object
-  #
-  # @example
-  #   "test".inspect_lit  # => "\"test\"" (i.e. '"test"')
-  #   "1".inspect_lit     # => "\"1\""    (i.e. '"1"')
-  #   "12.3".inspect_lit  # => "\"12.3\"" (i.e. '"12.3"')
-  def inspect_lit
-    %("#{self}")
-  end
-end

data/lib/core_ext/symbol.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# Reopen the core Symbol class to represent {#inspect_lit}.
-class Symbol
-  # Formats this symbol to look like a symbol literal so that object type will
-  # be inherently obvious when used in logging methods, etc.
-  #
-  # @return [String] a symbol literal representation of this object
-  #
-  # @example
-  #   :test.inspect_lit      # => ":\"test\"" (or ':"test"')
-  #   :"ta-da!".inspect_lit  # => ":\"ta-da!\"" (or ':"ta-da!"')
-  def inspect_lit
-    %(:"#{self}")
-  end
-end