object_identifier 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4553678db77484aa04ce8bf00e3238310bb253632fb8867cae4e948a35bfda6c
-  data.tar.gz: afae645239815d3a9a011b56892127eccbf0dbc9558fc59ed6d7c15349fdbbe7
+  metadata.gz: f93a767a479c1b5fccb0203eb79707479970876206c1325e567afe0792032d58
+  data.tar.gz: 3c6508fa051abfce2c19001783e98658b9e183f8725e871044a67b5185042bf8
 SHA512:
-  metadata.gz: 639af898d48d62cfdf69c325986fab12147ddad81219b0e60557a9e52288597d5dddd3f4473ac94df3bbfd5ade304bb55c3f1a49b9918f4c959941ba4899f773
-  data.tar.gz: 9f715f65e2afa4ac783db81cd8cab09b137b206dae15d4b05e757dc2d0c82e04848dbd2551e02b8a7c6127aed3b5cb5257c920e8d79f027cf42d1b61ae238679
+  metadata.gz: 3861571fbe466a526f9c10fe4c840ee51c7124998cf1009c81a9667c070cf1999362fa501b7030da795612b16ec81ff2f436a41613fd1256db614ecbecb46b34
+  data.tar.gz: 9c8505f55368a9cb64e0d8bcee68f2b5de7f0a4346a227d75d8d93465072da0d027b888789a6da90aef86867399546ac27c1a63eb945d6778050a6df46bd8bb8

data/LICENSE.txt

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

@@ -38,15 +38,16 @@ Or install it yourself as:
 ## Compatibility
 
 Tested MRI Ruby Versions:
-* 3.2.0
-* 2.4.9
-* 2.5.8
-* 2.6.6
+* 2.7
+* 3.0
+* 3.1
+* 3.2
 
+Object Identifier has no other dependencies.
 
 ## Configuration
 
-Global/default values for ObjectIdentifier can be configured via the ObjectIdentifier::Configuration object.
+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`_
 
@@ -163,19 +164,19 @@ OpenStruct.new(my_value: my_value_object).identify(:my_value)
 
 ## Supporting Gems
 
-ObjectIdentifier works great with the [ObjectInspector](https://github.com/pdobb/object_inspector) gem.
+Object Identifier works great with the [Object Inspector](https://github.com/pdobb/object_inspector) gem.
 
 
 ### Benchmarking Formatters
 
-Performance of Formatters can be tested by playing the [Formatters Benchmarking Scripts](https://github.com/pdobb/object_identifier/tree/master/scripts/benchmarking) in the pry console for this gem.
+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 pry console for this gem.
 
 Custom Formatters may be similarly gauged for comparison by adding them to the `custom_formatter_klasses` array before playing the script.
 
 ```ruby
 custom_formatter_klasses = [MyCustomFormatter]
 
-play scripts/benchmarking/formatters.rb
+play script/benchmarking/formatters.rb
 # ObjectIdentifier::StringFormatter
 #     58.478k (± 0.8%) i/s -    295.776k in   5.058178s
 # MyCustomFormatter
@@ -185,11 +186,21 @@ play scripts/benchmarking/formatters.rb
 
 ## Development
 
-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.
+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`, 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 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).
+
+
+### 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`
+
+While the YARD server is running, documentation in the live site will be auto-updated on source code save (and site reload).
 
 
 ## Contributing

data/lib/core_ext/object.rb

@@ -39,7 +39,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, **kargs)
-    ObjectIdentifier::Identifier.(self, *args, **kargs)
+  def identify(*args, **kwargs)
+    ObjectIdentifier.(self, *args, **kwargs)
   end
 end

data/lib/object_identifier/array_wrap.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# ObjectIdentifier::ArrayWrap mirrors the implementation of Rails'
+# Array.wrap method. This allows us to get around objects that respond to
+# `to_a` (such as Struct) and, instead, either utilize `to_ary` or just
+# actually wrap the object in an Array ourselves.
+class ObjectIdentifier::ArrayWrap
+  # :reek:NilCheck
+  # :reek:ManualDispatch
+
+  # Dispatch "Array Wrapping" logic on the given `object`.
+  #
+  # @param object The object(s) to attempt to Array wrap.
+  def self.call(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary || [object]
+    else
+      [object]
+    end
+  end
+end

data/lib/object_identifier/configuration.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# ObjectIdentifier is the top-level namespace/module for this gem.
+module ObjectIdentifier
+  # Default Configuration Accessors
+
+  # The default formatter class to use ({ObjectIdentifier::StringFormatter}).
+  def self.default_formatter_class
+    configuration.formatter_class
+  end
+
+  # The default attributes to include on object inspections.
+  def self.default_attributes
+    configuration.default_attributes
+  end
+
+  # Custom Configuration Getters/Setters
+
+  # Accessor for the {ObjectIdentifier::Configuration} object.
+  def self.configuration
+    @configuration ||= ObjectIdentifier::Configuration.new
+  end
+
+  # @yieldparam configuration [ObjectIdentifier::Configuration]
+  def self.configure
+    yield(configuration)
+  end
+
+  # Reset the current configuration settings memoized by
+  # {ObjectIdentifier.configuration}.
+  def self.reset_configuration
+    @configuration = ObjectIdentifier::Configuration.new
+  end
+
+  # ObjectIdentifier::Configuration stores the default configuration options for
+  # the ObjectIdentifier 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,
+                :default_attributes
+
+    def initialize
+      @formatter_class = ObjectIdentifier::StringFormatter
+      @default_attributes = %i[id]
+    end
+
+    def formatter_class=(value)
+      unless value.is_a?(Class)
+        raise TypeError, "Formatter must be a Class constant"
+      end
+
+      @formatter_class = value
+    end
+
+    def default_attributes=(value)
+      @default_attributes = value.to_a.map!(&:to_sym)
+    end
+  end
+end

data/lib/object_identifier/formatters/base_formatter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# ObjectIdentifier::BaseFormatter is an abstract base class for formatters.
+class ObjectIdentifier::BaseFormatter
+  attr_reader :objects,
+              :parameters
+
+  # A shortcut for calling `new(...).call`.
+  def self.call(...)
+    new(...).call
+  end
+
+  # @param objects [Object, [Object, ...]] The object(s) to be interrogated for
+  #   String values to be added to the output String.
+  # @param parameters [ObjectIdentifier::Parameters]
+  def initialize(objects, parameters: ObjectIdentifier::Parameters.build)
+    @objects = ObjectIdentifier::ArrayWrap.(objects)
+    @parameters = parameters
+  end
+
+  def call
+    raise NotImplementedError
+  end
+end

data/lib/object_identifier/formatters/string_formatter.rb

@@ -2,102 +2,148 @@
 
 # ObjectIdentifier::StringFormatter builds a String to identify the
 # given object(s).
-class ObjectIdentifier::StringFormatter
+class ObjectIdentifier::StringFormatter < ObjectIdentifier::BaseFormatter
+  # The String to output when {#objects} is empty.
   NO_OBJECTS_INDICATOR = "[no objects]"
-  KLASS_NOT_GIVEN = "NOT_GIVEN"
-
-  def self.call(objects, *attributes, **kargs)
-    new(objects, *attributes, **kargs).call
-  end
-
-  # @param objects [Object, [Object, ...]] the object(s) to be interrogated for
-  #   String values to be added to the output String
-  # @param attributes [Array, *args] a list of method calls to interrogate the
-  #   given object(s) with
-  # @param limit [Integer, nil] a given limit on the number of objects to
-  #   interrogate
-  # @param klass [String, Symbol] a preferred type name for identifying the
-  #   given object(s) as
-  def initialize(
-        objects,
-        attributes = ObjectIdentifier::Identifier.default_attributes,
-        limit: nil,
-        klass: KLASS_NOT_GIVEN)
-    @objects = ObjectIdentifier::ArrayWrap.(objects)
-    @attributes = ObjectIdentifier::ArrayWrap.(attributes)
-    @limit = (limit || @objects.size).to_i
-    @klass = klass.to_s
-  end
 
   # Output the self-identifying string for the given object(s). Will either
   # return a single object representation or a list of object
   # representations, based on the number of objects we're identifying.
   #
-  # @return [String] a string that identifies the object(s)
+  # @return [String] A string that identifies the object(s).
   def call
-    return NO_OBJECTS_INDICATOR if @objects.empty?
-
-    output_strings = @objects.first(@limit).map { |obj| format(obj) }
-    output_strings << "... (#{truncated_objects_count} more)" if truncated?
-    output_strings.join(", ")
+    if objects.none?
+      NO_OBJECTS_INDICATOR
+    elsif objects.one?
+      format_item
+    else # objects.size > 1
+      format_collection
+    end
   end
 
   private
 
-  def format(object)
-    return NO_OBJECTS_INDICATOR if blank?(object)
-
-    "#{class_name(object)}[#{format_attributes(evaluate_attributes(object))}]"
+  def format_collection
+    Collection.new(objects, parameters).call
   end
 
-  # Simple version of Rails' Object#blank? method.
-  def blank?(object)
-    object.nil? || object == [] || object == {}
+  def format_item(object = objects.first)
+    Item.new(object, parameters).call
   end
 
-  def class_name(object)
-    klass_given? ? @klass : object.class.name
-  end
+  # ObjectIdentifier::StringFormatter::Collection formats a collection-specific
+  # identification String, which will also necessarily be composed of
+  # {ObjectIdentifier::StringFormatter::Item} identification Strings.
+  class Collection
+    attr_reader :objects,
+                :parameters
+
+    # @param objects [Object, [Object, ...]] the object(s) to be interrogated
+    #   for String values to be added to the output String
+    # @param parameters [ObjectIdentifier::Parameters]
+    def initialize(objects, parameters)
+      @objects = objects
+      @parameters = parameters
+    end
 
-  def klass_given?
-    @klass != KLASS_NOT_GIVEN
-  end
+    # Build a comma-separated list of formatted item Strings representing the
+    # given objects.
+    #
+    # @return [String]
+    def call
+      parts = objects.first(limit).map { |obj| format_item(obj) }
+      parts << "... (#{truncated_objects_count} more)" if truncated?
+      parts.join(", ")
+    end
 
-  def format_attributes(attributes_hash)
-    return if attributes_hash.empty?
+    private
 
-    attributes_formatter = determine_attributes_formatter(attributes_hash)
-    attributes_hash.map(&attributes_formatter).join(", ")
-  end
+    def format_item(object)
+      Item.new(object, parameters).call
+    end
 
-  def determine_attributes_formatter(attributes_hash)
-    if attributes_hash.one?
-      ->(_key, value) { value.inspect_lit }
-    else
-      ->(key, value) { "#{key}:#{value.inspect_lit}" }
+    def limit
+      parameters.limit { objects_count }
     end
-  end
 
-  # @return [Hash]
-  def evaluate_attributes(object)
-    @attributes.each_with_object({}) { |key, acc|
-      if object.respond_to?(key, :include_private)
-        acc[key] = object.send(key)
-      elsif key.to_s.start_with?("@")
-        acc[key] = object.instance_variable_get(key)
-      end
-    }
-  end
+    def truncated?
+      truncated_objects_count.positive?
+    end
 
-  def truncated_objects_count
-    @truncated_objects_count ||= objects_count - @limit
-  end
+    def truncated_objects_count
+      @truncated_objects_count ||= objects_count - limit
+    end
 
-  def objects_count
-    @objects_count ||= @objects.size
+    def objects_count
+      @objects_count ||= objects.size
+    end
   end
 
-  def truncated?
-    truncated_objects_count.positive?
+  # ObjectIdentifier::StringFormatter::Item formats a single-object-specific
+  # identification String.
+  class Item
+    attr_reader :object,
+                :parameters
+
+    # @param object [Object] The object to be interrogated for String values to
+    #   be added to the output String.
+    # @param parameters [ObjectIdentifier::Parameters]
+    def initialize(object, parameters)
+      @object = object
+      @parameters = parameters
+    end
+
+    # @return [String] The self-identifying String for {#object}.
+    def call
+      return NO_OBJECTS_INDICATOR if blank?
+
+      "#{class_name}[#{formatted_attributes}]"
+    end
+
+    private
+
+    # :reek:NilCheck
+
+    # Simple version of Rails' Object#blank? method.
+    def blank?
+      object.nil? || object == [] || object == {}
+    end
+
+    def class_name
+      parameters.klass { object.class.name }
+    end
+
+    def formatted_attributes
+      attributes_hash.map(&attributes_formatter).join(", ")
+    end
+
+    # :reek:DuplicateMethodCall
+
+    def attributes_formatter
+      @attributes_formatter ||=
+        if attributes_hash.one?
+          ->(_key, value) { value.inspect_lit }
+        else # attributes_hash.size > 1
+          ->(key, value) { "#{key}:#{value.inspect_lit}" }
+        end
+    end
+
+    # :reek:ManualDispatch
+
+    # @return [Hash]
+    def attributes_hash
+      @attributes_hash ||=
+        attributes.each_with_object({}) { |key, acc|
+          if object.respond_to?(key, :include_private)
+            acc[key] = object.__send__(key)
+          elsif key.to_s.start_with?("@")
+            acc[key] = object.instance_variable_get(key)
+          end
+        }
+    end
+
+    def attributes
+      parameters.attributes
+    end
   end
 end

data/lib/object_identifier/object_identifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# ObjectIdentifier is the top-level namespace/module for this gem.
+module ObjectIdentifier
+  # :reek:LongParameterList
+
+  # ObjectIdentifier.call is the main entry point for use of this gem. In
+  # typical usage, however, this method will almost exclusively just be called
+  # by {Object#identify}, as defined in lib/core_ext/object.rb.
+  def self.call(
+        objects,
+        *attributes,
+        formatter_class: default_formatter_class,
+        **formatter_options)
+
+    parameters =
+      ObjectIdentifier::Parameters.build(
+        attributes: attributes,
+        formatter_options: formatter_options)
+
+    formatter_class.(objects, parameters: parameters)
+  end
+end

data/lib/object_identifier/parameters.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# ObjectIdentifier::Parameters encapsulates the attributes list and
+# 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"
+
+  attr_reader :attributes
+
+  # Factory method for building an {ObjectIdentifier::Parameters} object. Uses
+  # ObjectIdentifier.default_attributes if the given `attributes` array is
+  # empty.
+  def self.build(attributes: [], formatter_options: {})
+    attrs = ObjectIdentifier::ArrayWrap.(attributes)
+    attrs = ObjectIdentifier.default_attributes if attrs.empty?
+    attrs.flatten!
+
+    new(
+      attributes: attrs,
+      formatter_options: formatter_options.to_h)
+  end
+
+  # @param attributes [Array, *args] A list of method calls to interrogate the
+  #   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
+  #   identifying the given object(s) as.
+  def initialize(
+        attributes: [],
+        formatter_options: {})
+    @attributes = attributes
+    @limit = formatter_options.fetch(:limit, nil)
+    @klass = formatter_options.fetch(:klass, KLASS_NOT_GIVEN)
+  end
+
+  # NOTE: Expects a block if a value wasn't supplied on initialization.
+  def limit
+    @limit || (yield if block_given?)
+  end
+
+  # NOTE: Expects a block if a value wasn't supplied on initialization.
+  def klass
+    if klass_given?
+      @klass.to_s
+    elsif block_given?
+      yield.to_s
+    else
+      nil
+    end
+  end
+
+  private
+
+  def klass_given?
+    @klass != KLASS_NOT_GIVEN
+  end
+end

data/lib/object_identifier/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module ObjectIdentifier
-  VERSION = "0.5.0"
+  # The current ObjectIdentifier gem version.
+  VERSION = "0.7.0"
 end

data/lib/object_identifier.rb

@@ -1,65 +1,22 @@
 # frozen_string_literal: true
 
-# ObjectIdentifier is the base namespace for all modules/classes related to the
-# object_identifier gem.
+# ObjectIdentifier is the top-level namespace/module for this gem.
 module ObjectIdentifier
-  # ObjectIdentifier::ArrayWrap mirrors the implementation of Rails'
-  # {Array.wrap} method. This allows us to get around objects that respond to
-  # `to_a` (such as Struct) and, instead, either utilize `to_ary` or just
-  # actually wrap the object in an Array ourselves.
-  class ArrayWrap
-    def self.call(object)
-      if object.nil?
-        []
-      elsif object.respond_to?(:to_ary)
-        object.to_ary || [object]
-      else
-        [object]
-      end
-    end
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-  def self.reset_configuration
-    @configuration = Configuration.new
-  end
-
-  # ObjectIdentifier::Configuration stores the default configuration options for
-  # the ObjectIdentifier 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,
-                :default_attributes
+end
 
-    def initialize
-      @formatter_class = ObjectIdentifier::StringFormatter
-      @default_attributes = %i[id]
-    end
+require "object_identifier/version"
+require "object_identifier/configuration"
+require "object_identifier/object_identifier"
+require "object_identifier/array_wrap"
+require "object_identifier/parameters"
 
-    def formatter_class=(value)
-      unless value.is_a?(Class)
-        raise TypeError, "Formatter must be a Class constant"
-      end
+# FORMATTERS
 
-      @formatter_class = value
-    end
+require "object_identifier/formatters/base_formatter"
+require "object_identifier/formatters/string_formatter"
 
-    def default_attributes=(value)
-      @default_attributes = value.to_a.map!(&:to_sym)
-    end
-  end
-end
+# CORE EXTENSIONS
 
-require "object_identifier/version"
-require "object_identifier/identifier"
-require "object_identifier/formatters/string_formatter"
 require "core_ext/object"
 require "core_ext/string"
 require "core_ext/symbol"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
-- Evan Sherwood
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -95,6 +94,20 @@ 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
@@ -152,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: solargraph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -188,32 +201,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rubocop"
-- ".rubocop.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - 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
+- lib/object_identifier/formatters/base_formatter.rb
 - lib/object_identifier/formatters/string_formatter.rb
-- lib/object_identifier/identifier.rb
+- lib/object_identifier/object_identifier.rb
+- lib/object_identifier/parameters.rb
 - lib/object_identifier/version.rb
-- object_identifier.gemspec
-- scripts/benchmarking/formatters.rb
 homepage: https://github.com/pdobb/object_identifier
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/pdobb/object_identifier/issues
+  changelog_uri: https://github.com/pdobb/object_identifier/releases
+  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: []
@@ -223,15 +232,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: ObjectIdentifier identifies an object by its class name and attributes.
+summary: Object Identifier identifies an object by its class name and attributes.
 test_files: []

data/.github/workflows/ci.yml

@@ -1,38 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-      # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.byebug_history
-*.gem
-.DS_Store

data/.rubocop

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

data/.rubocop.yml

@@ -1,127 +0,0 @@
-AllCops:
-  UseCache: true
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: false
-  TargetRubyVersion: 2.4.0
-  NewCops: enable
-
-Layout/DotPosition:
-  EnforcedStyle: trailing
-
-Layout/EndOfLine:
-  EnforcedStyle: lf
-
-Layout/FirstArgumentIndentation:
-  EnforcedStyle: consistent_relative_to_receiver
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/FirstParameterIndentation:
-  Enabled: false # Revisit if more settings become available.
-
-Layout/LineContinuationSpacing:
-  EnforcedStyle: no_space
-
-Layout/LineEndStringConcatenationIndentation:
-  EnforcedStyle: aligned
-
-Layout/LineLength:
-  Max: 80
-  Exclude:
-    - "object_identifier.gemspec"
-    - "scripts/benchmarking/**/*"
-
-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/OrAssignmentToConstant:
-  Exclude:
-    - "scripts/**/*"
-
-Lint/Void:
-  CheckForMethodsWithNoSideEffects: true
-
-Metrics/BlockLength:
-  AllowedMethods:
-    - describe
-    - context
-    - ips # Benchmarking
-
-Metrics/ClassLength:
-  Exclude:
-    - "test/**/*"
-
-Naming/MethodParameterName:
-  AllowedNames:
-    - a
-    - b
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/BlockDelimiters:
-  Enabled: false # Reconsider later.
-
-Style/ClassAndModuleChildren:
-  AutoCorrect: true
-  EnforcedStyle: compact
-
-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/LambdaCall:
-  Enabled: false # Allow ServiceObject.(*). Only use on classes, not instances.
-
-Style/OpenStructUse:
-  Exclude:
-    - "test/**/*"
-
-Style/RegexpLiteral:
-  EnforcedStyle: mixed
-
-Style/RescueStandardError:
-  EnforcedStyle: implicit
-
-Style/SingleLineMethods:
-  Exclude:
-    - "test/**/*_test.rb"
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,30 +0,0 @@
-### 0.5.0 - 2023-01-04
-- Add support for defining customer Formatters.
-- Add ObjectInspector::Configuration#formatter_class setting for overriding the default Formatter. See the README for more.
-- Add a benchmarking script for comparing performance of formatters. See the README for more.
-
-### 0.4.1 - 2022-12-30
-- Make compatible with Ruby 3.2 (and likely Ruby 3.0 and 3.1 as well).
-- Update development dependencies.
-
-### 0.4.0 - 2020-09-01
-- [#4](https://github.com/pdobb/object_identifier/pull/4) Only show attribute names if identifying more than one attribute.
-- Update development dependencies.
-
-#### BREAKING
-- Drop support for Ruby 2.3.
-
-### 0.3.0 - 2019-06-27
-- Fix identification of objects that implement `to_a`, such as Struct.
-
-### 0.2.1 - 2019-02-24
-- Add ability to identify instance vars.
-
-### 0.1.0 - 2018-04-14
-- Revamp gem.
-- Update gem dependencies.
-- Now returns "[no objects]" even if given a :klass option.
-
-
-### 0.0.6 - 2016-02-06
-- Fix: identify method now supports private & protected methods.

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in object_identifier.gemspec
-gemspec

data/Gemfile.lock

@@ -1,83 +0,0 @@
-PATH
-  remote: .
-  specs:
-    object_identifier (0.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.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 (1.0.0)
-    minitest (5.17.0)
-    minitest-reporters (1.5.0)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    much-stub (0.1.10)
-    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.13, < 0.15)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    reek (6.1.3)
-      kwalify (~> 0.7.0)
-      parser (~> 3.1.0)
-      rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rubocop (1.42.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      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.24.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      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)
-      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
-
-DEPENDENCIES
-  benchmark-ips
-  bundler
-  byebug
-  minitest
-  minitest-reporters
-  much-stub
-  object_identifier!
-  pry
-  pry-byebug
-  rake
-  reek
-  rubocop
-  simplecov
-
-BUNDLED WITH
-   2.4.1

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: :test

data/bin/console

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "object_identifier"
-require "ostruct"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
-Pry.start
-
-# require "irb"
-# IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/object_identifier/identifier.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# ObjectIdentifier::Identifier manages construction of identification outputs
-# using the passed in formatter_class.
-class ObjectIdentifier::Identifier
-  # NOTE: `kargs` may be specific to the Formatter being called.
-  def self.call(
-        objects,
-        *attributes,
-        formatter_class: default_formatter_class,
-        **formatter_options)
-    formatter_class.(objects, *attributes, **formatter_options)
-  end
-
-  def self.default_formatter_class
-    ObjectIdentifier.configuration.formatter_class
-  end
-
-  def self.default_attributes
-    ObjectIdentifier.configuration.default_attributes
-  end
-end

data/object_identifier.gemspec

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "object_identifier/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "object_identifier"
-  spec.version       = ObjectIdentifier::VERSION
-  spec.authors       = ["Paul DobbinSchmaltz", "Evan Sherwood"]
-  spec.email         = ["p.dobbinschmaltz@icloud.com"]
-  spec.required_ruby_version = ">= 2.4.0"
-  spec.metadata      = { "rubygems_mfa_required" => "true" }
-
-  spec.summary       = "ObjectIdentifier identifies an object by its class name and attributes."
-  spec.description   = "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."
-  spec.homepage      = "https://github.com/pdobb/object_identifier"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # 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"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "much-stub"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "reek"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
-end

data/scripts/benchmarking/formatters.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-# Play from the pry console with:
-#   play scripts/benchmarking/formatters.rb
-
-require "benchmark/ips"
-
-custom_formatter_klasses ||= []
-
-formatter_klasses = [
-  ObjectIdentifier::StringFormatter,
-  *Array(custom_formatter_klasses)
-].freeze
-
-MyObject ||= Struct.new(:id, :name)
-
-objects = [
-  MyObject.new(id: 1, name: "NAME1"),
-  MyObject.new(id: 2, name: "NAME2"),
-  MyObject.new(id: 3, name: "NAME3")
-].freeze
-
-puts "== Averaged ============================================================="
-Benchmark.ips { |x|
-  formatter_klasses.each do |formatter_klass|
-    x.report(formatter_klass) {
-      formatter_klass.new(objects[0]).call
-      formatter_klass.new(objects[0], %i[id name]).call
-      formatter_klass.new(objects[0], klass: "CustomClass").call
-      formatter_klass.new(objects[0], %i[id name], klass: "CustomClass").call
-      formatter_klass.new(objects, limit: 2).call
-      formatter_klass.new(objects, %i[id name], klass: "CustomClass", limit: 2).call
-    }
-  end
-
-  x.compare!
-}
-puts "== Done"
-
-puts "== Individualized ======================================================="
-Benchmark.ips { |x|
-  # rubocop:disable Style/CombinableLoops
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Default Attributes") {
-      formatter_klass.new(objects[0]).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Custom Attributes") {
-      formatter_klass.new(objects[0], %i[id name]).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Custom Class") {
-      formatter_klass.new(objects[0], klass: "CustomClass").call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Custom Attributes & Custom Class") {
-      formatter_klass.new(objects[0], %i[id name], klass: "CustomClass").call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Limit 2") {
-      formatter_klass.new(objects, limit: 2).call
-    }
-  end
-  formatter_klasses.each do |formatter_klass|
-    x.report("#{formatter_klass} - Custom Attributes & Custom Class & Limit 2") {
-      formatter_klass.new(objects, %i[id name], klass: "CustomClass", limit: 2).call
-    }
-  end
-  # rubocop:enable Style/CombinableLoops
-
-  x.compare!
-}
-puts "== Done"