object_identifier 0.0.6 → 0.1.0

data/lib/object_identifier/identifier.rb

@@ -1,10 +1,6 @@
 module ObjectIdentifier
   class Identifier
-    def initialize(objects, *args)
-      @objects    = Array.wrap(objects)
-      @options    = args.extract_options!
-      @attributes = args.empty? ? [:id] : args
-    end
+    NO_OBJECTS_INDICATOR = "[no objects]".freeze
 
     # Class method for constructing a self-identifying string for any given
     # object or collection of objects.
@@ -20,25 +16,33 @@ module ObjectIdentifier
     #   @param [Hash] options the options for building a customized
     #     self-identifier
     #   @option options [String, nil] :klass object class name override
-    #   @option options [Fixnum] :limit maximum number of objects to display
+    #   @option options [Integer] :limit maximum number of objects to display
     #     from a collection
     #
     # @return [String] a self-identifying string like `Class[id:1, name:'temp']`
     #
     # @example
-    #   ObjectIdentifier::Identifier.identify(OpenStruct.new(a: 1, b: '2', c: :"3"), :a, :b, :c)
+    #   ObjectIdentifier::Identifier.identify(
+    #     OpenStruct.new(a: 1, b: '2', c: :"3"), :a, :b, :c)
     #   # => "OpenStruct[a:1, b:\"2\", c::\"3\"]"
     #
-    #   ObjectIdentifier::Identifier.identify(1, :to_s) # => "Fixnum[to_s:\"1\"]"
-    #   ObjectIdentifier::Identifier.identify(nil)      # => "[no objects]"
+    #   ObjectIdentifier::Identifier.identify(1, :to_s)  # => "Integer[to_s:\"1\"]"
+    #   ObjectIdentifier::Identifier.identify(nil)       # => "[no objects]"
     #
-    #   ObjectIdentifier::Identifier.identify(%w(1 2 3), :to_i, :to_f)
-    #   # => "String[to_i:1, to_f:1.0], String[to_i:2, to_f:2.0], String[to_i:3, to_f:3.0]"
+    #   ObjectIdentifier::Identifier.identify(%w(1 2), :to_i, :to_f)
+    #   # => "String[to_i:1, to_f:1.0], String[to_i:2, to_f:2.0]"
     #
     #   ObjectIdentifier::Identifier.identify((1..10).to_a, :to_f, limit: 2)
-    #   # => "Fixnum[to_f:1.0], Fixnum[to_f:2.0], ... (8 more)"
-    def self.identify(obj, *args)
-      new(obj, *args).to_s
+    #   # => "Integer[to_f:1.0], Integer[to_f:2.0], ... (8 more)"
+    def self.identify(object, *args)
+      new(object, *args).to_s
+    end
+
+    def initialize(objects, *args, limit: nil, klass: :not_given)
+      @objects = Array(objects)
+      @attributes = args.empty? ? [:id] : args
+      @limit = (limit || @objects.size).to_i
+      @klass = klass
     end
 
     # Output the self-identifying string for an instance of
@@ -48,85 +52,81 @@ module ObjectIdentifier
     #
     # @return [String] a string representing the object or list of objects
     def to_s
-      if multiple_objects_to_identify?
+      if many?
         format_multiple_objects
       else
         format_single_object
       end
     end
 
-    private
+  private
 
     def format_multiple_objects
-      objects = @objects.first(limit).map do |obj|
-                  format_with_attributes(obj)
-                end.join(", ")
+      objects =
+        @objects.first(@limit).map { |obj| format(obj) }
 
-      if any_objects_abbreviated?
-        objects << ", ... (#{number_of_abbreviated_objects} more)"
+      if truncated?
+        objects << "... (#{truncated_objects_count} more)"
       end
 
-      objects
+      objects.join(", ")
     end
 
     def format_single_object
-      obj = if nil_or_empty_array?(@objects)
-              @objects
-            else
-              @objects.first
-            end
-      format_with_attributes(obj)
-    end
+      object = @objects.first if @objects.respond_to?(:first)
 
-    def multiple_objects_to_identify?
-      @objects.many?
+      format(object)
     end
 
-    def limit
-      @options.fetch(:limit) { @objects.size }.to_i
+    def format(object)
+      return NO_OBJECTS_INDICATOR if blank?(object)
+
+      "#{class_name(object)}[#{format_attributes(evaluate_attributes(object))}]"
     end
 
-    def limit_given?
-      @options.key?(:limit)
+    def format_attributes(attributes_hash)
+      return if attributes_hash.empty?
+
+      attributes_hash.map { |(key, value)|
+        "#{key}:#{value.inspect_lit}"
+      }.join(", ")
     end
 
-    def any_objects_abbreviated?
-      limit_given? && number_of_abbreviated_objects > 0
+    # @return [Hash]
+    def evaluate_attributes(object)
+      @attributes.each_with_object({}) { |key, acc|
+        if object.respond_to?(key, :include_private)
+          acc[key] = object.send(key)
+        end
+      }
     end
 
-    def number_of_abbreviated_objects
-      @objects.size - @options[:limit].to_i
+    def class_name(object)
+      klass_given? ? @klass : object.class.name
     end
 
-    def format_with_attributes(object)
-      if nil_or_empty_array?(object)
-        format_empty(object)
-      else
-        attrs = @attributes.each_with_object({}) do |key, memo|
-          memo[key] = object.send(key) if object.respond_to?(key, :include_all)
-        end
-        "#{class_name_of(object)}[#{attribute_formatter(attrs)}]"
-      end
+    def truncated_objects_count
+      objects_count - @limit
     end
 
-    def format_empty(object)
-      @options.key?(:klass) ? "#{@options[:klass]}[]" : "[no objects]"
+    def objects_count
+      @objects_count ||= @objects.size
     end
 
-    def attribute_formatter(hash)
-      return if hash.empty?
+    def klass_given?
+      @klass != :not_given
+    end
 
-      hash.inject([]) do |memo, (key, value)|
-        memo << "#{key}:#{value.inspect_lit}"
-      end.join(", ")
+    def blank?(object)
+      object.nil? || object == [] || object == {}
     end
 
-    def nil_or_empty_array?(object)
-      object.nil? || object == []
+    def many?
+      objects_count > 1
     end
 
-    def class_name_of(object)
-      @options.fetch(:klass) { object.class.name }
+    def truncated?
+      truncated_objects_count > 0
     end
   end
 end

data/lib/object_identifier/version.rb

@@ -1,3 +1,3 @@
 module ObjectIdentifier
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/object_identifier.rb

@@ -1,9 +1,8 @@
+module ObjectIdentifier
+end
+
+require "object_identifier/identifier"
 require "object_identifier/core_ext/object"
 require "object_identifier/core_ext/string"
 require "object_identifier/core_ext/symbol"
 require "object_identifier/core_ext/big_decimal"
-
-module ObjectIdentifier
-  autoload :Identifier, "object_identifier/identifier"
-  autoload :Deidentifier, "object_identifier/deidentifier"
-end

data/object_identifier.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$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 Dobbins", "Evan Sherwood"]
+  spec.email         = ["paul.dobbins@icloud.com"]
+
+  spec.summary       = %q{ObjectIdentifier identifies an object by its class name and attributes.}
+  spec.description   = %q{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 quickly 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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.2"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+end

metadata

@@ -1,117 +1,155 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul Dobbins
 - Evan Sherwood
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: minitest-rails
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '3.6'
+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 quickly logging, sending descriptive notification messages, etc.
 email:
-- pdobbins@gmail.com
+- paul.dobbins@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/object_identifier.rb
 - lib/object_identifier/core_ext/big_decimal.rb
 - lib/object_identifier/core_ext/object.rb
 - lib/object_identifier/core_ext/string.rb
 - lib/object_identifier/core_ext/symbol.rb
-- lib/object_identifier/deidentifier.rb
 - lib/object_identifier/identifier.rb
 - lib/object_identifier/version.rb
-- test/core_ext/big_decimal_test.rb
-- test/core_ext/object_test.rb
-- test/core_ext/string_test.rb
-- test/core_ext/symbol_test.rb
-- test/deidentifier_test.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/object_identifier_test.rb
-- test/test_helper.rb
+- object_identifier.gemspec
 homepage: https://github.com/pdobb/object_identifier
 licenses:
 - MIT
@@ -132,50 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Identify an object by inspecting its class name and attributes.
-test_files:
-- test/core_ext/big_decimal_test.rb
-- test/core_ext/object_test.rb
-- test/core_ext/string_test.rb
-- test/core_ext/symbol_test.rb
-- test/deidentifier_test.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/object_identifier_test.rb
-- test/test_helper.rb
-has_rdoc: 
+summary: ObjectIdentifier identifies an object by its class name and attributes.
+test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2013 Paul Dobbins
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/object_identifier/deidentifier.rb

@@ -1,78 +0,0 @@
-module ObjectIdentifier
-  class Deidentifier
-    attr_accessor :str, :options
-
-    def initialize(str, options = {})
-      @str     = str.to_s
-      @options = options
-    end
-
-    # Class method for reconstructing an object or set of objects from its/their
-    # self-identifying string(s).
-    #
-    # @overload self.identify(str)
-    #   @param str [String] the String to deidentify
-    # @overload self.identify(str, options)
-    #   @param str [String] the object to identify
-    #   @param [Hash] options the options for building a customized
-    #     self-identifier
-    #   @option options [String, nil] :klass object class name override
-    #   @option options [Fixnum] :limit maximum number of objects to display
-    #     from a collection
-    #
-    # @return [Object] the object represented by the identifier String
-    def self.deidentify(obj, options = {})
-      new(obj, options).deidentify
-    end
-
-    # @return [Object] the object represented by the identifier String
-    def deidentify
-      if multiple_objects_to_deidentify?
-        # deidentify_multiple_objects
-      else
-        deidentify_single_object(str)
-      end
-    end
-
-    private
-
-    def deidentify_multiple_objects
-    end
-
-    def deidentify_single_object(object_str)
-      klass = determine_class(object_str)
-      attributes = extract_attributes(object_str)
-
-      case (model = klass.constantize)
-      when ActiveRecord::Base
-        model.where(select_core_attributes(attributes)).first
-      else
-        model.new(attributes)
-      end
-    end
-
-    def multiple_objects_to_deidentify?
-      str.starts_with?("[") && str.ends_with?("]")
-    end
-
-    def determine_class(object_str)
-      options.fetch(:klass) {
-        object_str[/\A(\w+)/, 1]
-      }
-    end
-
-    def extract_attributes(object_str)
-      result = object_str[/\[(.+)\]/, 1]
-      return if result == "no objects"
-      JSON.parse(jsonify_attributes_str(result))
-    end
-
-    def jsonify_attributes_str(attributes_str)
-      "{ #{attributes_str} }".gsub(/ (\w+):/, ' "\1":')
-    end
-
-    def select_core_attributes(attributes)
-      attributes.select { |key, _| key.in?(klass.column_names) }
-    end
-  end
-end

data/test/core_ext/big_decimal_test.rb

@@ -1,12 +0,0 @@
-require "test_helper"
-
-describe BigDecimal do
-  describe "#inspect_lit" do
-    it "returns the same as #to_s" do
-      [1, 1.0, 0, 99.9999].each do |val|
-        bd_val = BigDecimal.new(val, 10)
-        bd_val.inspect_lit.must_equal "<BD:#{bd_val}>"
-      end
-    end
-  end
-end

data/test/core_ext/object_test.rb

@@ -1,11 +0,0 @@
-require "test_helper"
-
-describe Object do
-  it "responds to #inspect_lit" do
-    assert Object.new.respond_to?(:inspect_lit)
-  end
-
-  it "responds to #identify" do
-    assert Object.new.respond_to?(:identify)
-  end
-end

data/test/core_ext/string_test.rb

@@ -1,9 +0,0 @@
-require "test_helper"
-
-describe String do
-  describe "#inspect_lit" do
-    it "quotes string values" do
-      "string".inspect_lit.must_equal %("string")
-    end
-  end
-end

data/test/core_ext/symbol_test.rb

@@ -1,9 +0,0 @@
-require "test_helper"
-
-describe Symbol do
-  describe "#inspect_lit" do
-    it "quotes symbol values after colon" do
-      :symbol.inspect_lit.must_equal %(:"symbol")
-    end
-  end
-end