object_identifier 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 145c33d70d8d3e4122c427a6c2a5ae956cfe7ed0
-  data.tar.gz: c550160bd82b0417256face662342f33c567a1a6
+  metadata.gz: e8ddc2ad9b41c164acd506d459485a07fec316df
+  data.tar.gz: 1db0b95efe25e89e27dbce11275f7662fccc3b5a
 SHA512:
-  metadata.gz: 28deb5124d478be4452168bc59cb371704d60481a8adae647e6edf9672c52272058a5c48bf63e9b2ba3a28e710cdbf75bf92f4c2400104478277ea13b0e4e8d3
-  data.tar.gz: 5772ec327a63e2f0a528398c73c7738a66af8d436b1a48b5189d0bfd85c7d3d53e841d69bcd75a76efac04f70933a92bda312e835a79b2393e6e2d8421c12357
+  metadata.gz: ab5c8a2a62cba5aebfca5ac676b9b3dc3e4221e7112ecaea1027ae7df57dcb42daf09654927ac6fe80ffe6069052f878c1bef8747336fd467943f92576563add
+  data.tar.gz: 21d76f36afa3abe23f84caf8d9c70e5f52b3e640500675b0aa6ad14030e03978ad05a9c99dab7e3351631ac8b37c9303dd71b1e2873d847d7a091824fec3a697

data/README.md

@@ -2,32 +2,34 @@
 
 [![Gem Version](https://badge.fury.io/rb/object_identifier.png)](http://badge.fury.io/rb/object_identifier)
 
-Object Identifier allows quick, easy, and uniform identification of an object
-by inspecting its class name and any desirable attributes/methods. This is great
-for logging, notifications or any other purpose.
+Object Identifier allows quick, easy, and uniform identification of an object by inspecting its class name and outputting any desirable attributes/methods. This is great for quickly logging, sending more descriptive notifications, or any other purpose.
 
-For example, instead of typing out string interpolations such as
-`"#{some_object.class.name}[id:#{some_object.id}, name:'#{some_object.name}']"`
-all over the place in controllers or in rescue blocks in models, etc., you can
-now just use `"#{some_object.identify(:id, :name)}"`.
+For example:
+
+```ruby
+some_object.identify(:id, :name)
+```
+
+Which is the same as:
+
+```ruby
+"#{some_object.class.name}[id:#{some_object.id}, name:'#{some_object.name}']"
+```
 
 
 ## Compatibility
 
-Tested with:
+* Ruby: MRI 1.9.3+
+* Ruby: MRI 2+
+* Rails: 3+
 
-* Ruby: MRI 1.9.3
-* Ruby: MRI 2.0.0
-* Ruby: MRI 2.1.0
-* Rails: 3.2
-* Rails: 4.0.1
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "object_identifier"
+gem 'object_identifier'
 ```
 
 And then execute:
@@ -36,9 +38,10 @@ And then execute:
 bundle
 ```
 
+
 ## Usage
 
-<b>Defaults</b>
+### Defaults
 
 Outputs the `id` attribute by default, if possible and if no other attributes
 are given:
@@ -53,7 +56,7 @@ Also works with methods:
 some_object.identify(:get_rating)  # => Movie[get_rating:"7/10"]
 ```
 
-<b>Unknown Attributes/Methods</b>
+### Unknown Attributes/Methods
 
 If the object doesn't respond to a specified attribute/method it is simply
 ignored:
@@ -62,7 +65,7 @@ ignored:
 some_object.identify(:gobble_gobble, :id)  # => Movie[id:1]
 ```
 
-<b>Collections</b>
+### Collections
 
 Works great with collections:
 
@@ -78,7 +81,7 @@ Also allows limiting of results:
   # => Movie[id:1, name:"Pi"], ... (1 more)
 ```
 
-<b>Overriding the Class Name</b>
+### Overriding the Class Name
 
 ```ruby
 some_object.identify(klass: "MyMovie")       # => MyMovie[id:1]
@@ -86,13 +89,44 @@ some_object.identify(klass: nil)             # => [id:1]
 delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[id:1]
 ```
 
-<b>Nils and Empty Collections</b>
+### Nils and Empty Collections
 
 ```ruby
 nil.identify(:id, :name)  # => [no objects]
 [].identify               # => [no objects]
 ```
 
+
+## Custom Object Identifiers
+
+Internally, Object Identifier relies on a method named `inspect_lit` to return a "literally-inspected" string representation of all objects being identified. For example:
+
+```ruby
+:a_symbol.respond_to?(:inspect_lit) # => true
+:a_symbol.inspect_lit               # => ":\"a_symbol\""
+"a_string".inspect_lit              # => "\"a_string\""
+BigDecimal(1.99, 3).inspect_lit     # => "<BD:1.99>"
+```
+
+Therefore, if you'd like to represent a custom object in a special way for object identification, just define the to-string conversion within the `inspect_lit` method.
+
+
+```ruby
+class MyVal
+  def initialize(val)
+    @val = val
+  end
+
+  def inspect_lit
+    "<MOO:#{@val}>"
+  end
+end
+
+OpenStruct.new(my_val: MyVal.new(42)).identify(:my_val)
+# => "OpenStruct[my_val:<MOO:42>]"
+```
+
+
 ## Authors
 
 - Paul Dobbins

data/lib/object_identifier/core_ext/big_decimal.rb

@@ -1,9 +1,12 @@
 class BigDecimal
-  # Formats this BigDecimal to look like a float, which is at least readable.
-  # @return [String] a String representation of this BigDecimal object (via float)
+  # Formats this BigDecimal as an object-type-revealing String.
+  #
+  # @return [String] a String representation of this BigDecimal object
+  #
   # @example
-  #   BigDecimal.new(1).inspect_lit # => "1.0"
+  #   BigDecimal.new(1).inspect_lit         # => "<BD:1.0>"
+  #   BigDecimal.new(99.999, 5).inspect_lit # => "<BD:99.999>"
   def inspect_lit
-    to_s
+    "<BD:#{self}>"
   end
 end

data/lib/object_identifier/core_ext/object.rb

@@ -2,6 +2,7 @@ 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 when used in
   # logging methods, etc.
+  #
   # @return [String] a string representation of this object
   def inspect_lit
     inspect
@@ -9,21 +10,33 @@ class Object
 
   # Instance method for constructing a self-identifying string for any given
   # object or list of objects.
+  #
   # @overload identify(*args)
   #   @param args [*] (optional) a list of arguments to identify for this object
   #     or for each object in this collection
   # @overload identify(*args, options)
-  #   @param args [*] (optional) (default: :id) a list of arguments to identify for this object
-  #   @param [Hash] options the options for building a customized self-identifier
+  #   @param args [*] (optional) (default: :id) a list of arguments to identify
+  #     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 [Fixnum] :limit maximum number of objects to display from a collection
+  #   @option options [Fixnum] :limit maximum number of objects to display from
+  #     a collection
+  #
   # @return [String] a self-identifying string like `Class[id:1, name:'temp']`
+  #
   # @example
-  #   OpenStruct.new(a: 1, b: '2', c: :"3").identify(:a, :b, :c) # => "OpenStruct[a:1, b:\"2\", c::\"3\"]"
+  #   OpenStruct.new(a: 1, b: '2', c: :"3").identify(:a, :b, :c)
+  #   # => "OpenStruct[a:1, b:\"2\", c::\"3\"]"
+  #
   #   1.identify(:to_s) # => "Fixnum[to_s:\"1\"]"
-  #   nil.identify # => "[no objects]"
-  #   %w(1 2 3).identify(: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]"
-  #   (1..10).to_a.identify(:to_f, limit: 2) # => "Fixnum[to_f:1.0], Fixnum[to_f:2.0], ... (8 more)"
+  #   nil.identify      # => "[no objects]"
+  #
+  #   %w(1 2 3).identify(: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]"
+  #
+  #   (1..10).to_a.identify(:to_f, limit: 2)
+  #   # => "Fixnum[to_f:1.0], Fixnum[to_f:2.0], ... (8 more)"
   def identify(*args)
     ObjectIdentifier::Identifier.identify(self, *args)
   end

data/lib/object_identifier/core_ext/string.rb

@@ -1,10 +1,12 @@
 class String
   # Formats this string to look like a string literal so that object type will
   # be inherently obvious when used in logging methods, etc.
+  #
   # @return [String] a string literal representation of this object
+  #
   # @example
   #   "test".inspect_lit # => "\"test\"" (or '"test"')
-  #   "1".inspect_lit # => "\"1\"" (or '"1"')
+  #   "1".inspect_lit    # => "\"1\"" (or '"1"')
   #   "12.3".inspect_lit # => "\"12.3\"" (or '"12.3"')
   def inspect_lit
     %("#{to_s}")

data/lib/object_identifier/core_ext/symbol.rb

@@ -1,9 +1,11 @@
 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"')
+  #   :test.inspect_lit     # => ":\"test\"" (or ':"test"')
   #   :"ta-da!".inspect_lit # => ":\"ta-da!\"" (or ':"ta-da!"')
   def inspect_lit
     %(:"#{to_s}")

data/lib/object_identifier/identifier.rb

@@ -1,43 +1,51 @@
-require "naught"
-
 module ObjectIdentifier
   class Identifier
-    NullObject = Naught.build
-    include NullObject::Conversions
+    def initialize(objects, *args)
+      @objects    = Array.wrap(objects)
+      @options    = args.extract_options!
+      @attributes = args.empty? ? [:id] : args
+    end
 
     # Class method for constructing a self-identifying string for any given
     # object or collection of objects.
+    #
     # @overload self.identify(obj, *args)
     #   @param obj [Object] the object to identify
-    #   @param args [*] (optional) a list of arguments to identify for this object
-    #     or for each object in this collection
+    #   @param args [*] (optional) a list of arguments to identify for this
+    #     object or for each object in this collection
     # @overload self.identify(obj, *args, options)
     #   @param obj [Object] the object to identify
-    #   @param args [*] (optional) (default :id) a list of arguments to identify for this object
-    #   @param [Hash] options the options for building a customized self-identifier
+    #   @param args [*] (optional) (default :id) a list of arguments to identify
+    #     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 [Fixnum] :limit maximum number of objects to display from a collection
+    #   @option options [Fixnum] :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) # => "OpenStruct[a:1, b:\"2\", c::\"3\"]"
+    #   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(%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((1..10).to_a, :to_f, limit: 2) # => "Fixnum[to_f:1.0], Fixnum[to_f:2.0], ... (8 more)"
+    #   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((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(Array.wrap(obj), *args).to_s
-    end
-
-    def initialize(objects, *args)
-      @objects    = objects
-      @options    = args.extract_options!
-      @attributes = args.empty? ? [:id] : args
+      new(obj, *args).to_s
     end
 
     # Output the self-identifying string for an instance of
-    # ObjectIdentifier::Identifier. Will either return a single object representation
-    # or a list of object representations, based on the number of objects we're
-    # identifying.
+    # ObjectIdentifier::Identifier. 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 representing the object or list of objects
     def to_s
       if multiple_objects_to_identify?
@@ -51,8 +59,8 @@ module ObjectIdentifier
 
     def format_multiple_objects
       objects = @objects.first(limit).map do |obj|
-        format_with_attributes(obj)
-      end.join(", ")
+                  format_with_attributes(obj)
+                end.join(", ")
 
       if any_objects_abbreviated?
         objects << ", ... (#{number_of_abbreviated_objects} more)"
@@ -71,15 +79,15 @@ module ObjectIdentifier
     end
 
     def multiple_objects_to_identify?
-      @objects.try(:many?)
+      @objects.many?
     end
 
     def limit
-      @options[:limit] || @objects.size
+      @options.fetch(:limit) { @objects.size }.to_i
     end
 
     def limit_given?
-      @options.has_key?(:limit)
+      @options.key?(:limit)
     end
 
     def any_objects_abbreviated?
@@ -87,7 +95,7 @@ module ObjectIdentifier
     end
 
     def number_of_abbreviated_objects
-      @objects.size - Maybe(@options[:limit]).to_i
+      @objects.size - @options[:limit].to_i
     end
 
     def format_with_attributes(object)
@@ -102,7 +110,7 @@ module ObjectIdentifier
     end
 
     def format_empty(object)
-      @options.has_key?(:klass) ? "#{@options[:klass]}[]" : "[no objects]"
+      @options.key?(:klass) ? "#{@options[:klass]}[]" : "[no objects]"
     end
 
     def attribute_formatter(hash)
@@ -118,7 +126,7 @@ module ObjectIdentifier
     end
 
     def class_name_of(object)
-      @options.has_key?(:klass) ? @options[:klass] : object.class.name
+      @options.key?(:klass) ? @options[:klass] : object.class.name
     end
   end
 end

data/lib/object_identifier/version.rb

@@ -1,3 +1,3 @@
 module ObjectIdentifier
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/core_ext/big_decimal_test.rb

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

data/test/core_ext/string_test.rb

@@ -3,7 +3,7 @@ require "test_helper"
 describe String do
   describe "#inspect_lit" do
     it "quotes string values" do
-      assert "string".inspect_lit == %("string")
+      "string".inspect_lit.must_equal %("string")
     end
   end
 end

data/test/core_ext/symbol_test.rb

@@ -3,7 +3,7 @@ require "test_helper"
 describe Symbol do
   describe "#inspect_lit" do
     it "quotes symbol values after colon" do
-      assert :symbol.inspect_lit == %(:"symbol")
+      :symbol.inspect_lit.must_equal %(:"symbol")
     end
   end
 end

data/test/object_identifier_test.rb

@@ -2,68 +2,68 @@ require "test_helper"
 
 describe ObjectIdentifier::Identifier do
   describe "#identify" do
-    it "yields 'Class[id:1]' when id and no attributes" do
-      assert OpenStruct.new(id: 1).identify == "OpenStruct[id:1]"
+    it "yields 'Class[id:1]', GIVEN id and no attributes" do
+      OpenStruct.new(id: 1).identify.must_equal "OpenStruct[id:1]"
     end
 
     it "lists each entry in collection" do
       collection = [OpenStruct.new(id: 1), OpenStruct.new(id: 2)]
-      assert collection.identify == "OpenStruct[id:1], OpenStruct[id:2]"
+      collection.identify.must_equal "OpenStruct[id:1], OpenStruct[id:2]"
     end
 
     describe "no attributes, no id, empty array, nil" do
-      it "yields 'Class[]' when no id or attributes" do
-        assert Object.new.identify == "Object[]"
+      it "yields 'Class[]', GIVEN no id or attributes" do
+        Object.new.identify.must_equal "Object[]"
       end
 
-      it "yields '[no objects]' when an empty array" do
-        assert [].identify == "[no objects]"
+      it "yields '[no objects]', GIVEN an empty array" do
+        [].identify.must_equal "[no objects]"
       end
 
-      it "yields '[no objects]' when nil" do
-        assert nil.identify == "[no objects]"
+      it "yields '[no objects]', GIVEN nil" do
+        nil.identify.must_equal "[no objects]"
       end
     end
 
     describe "with attributes" do
       it "yields attribute values" do
         obj = OpenStruct.new(name: "Pepper", beak_size: 4)
-        assert obj.identify(:beak_size) == "OpenStruct[beak_size:4]"
+        obj.identify(:beak_size).must_equal "OpenStruct[beak_size:4]"
       end
 
       it "quotes strings" do
         obj = OpenStruct.new(name: "Pepper")
-        assert obj.identify(:name) == %(OpenStruct[name:"Pepper"])
+        obj.identify(:name).must_equal %(OpenStruct[name:"Pepper"])
       end
 
       it "quotes symbols" do
         obj = OpenStruct.new(name: "Pepper", color: :grey)
-        assert obj.identify(:color) == %(OpenStruct[color::"grey"])
+        obj.identify(:color).must_equal %(OpenStruct[color::"grey"])
       end
 
       it "ignores attributes that don't exist" do
         obj = OpenStruct.new(name: "Pepper", color: :grey, beak_size: 4)
-        assert obj.identify(:volume, :beak_size) == "OpenStruct[beak_size:4]"
+        obj.identify(:volume, :beak_size).must_equal "OpenStruct[beak_size:4]"
       end
     end
 
     describe "options" do
       it "overrides object class name with :klass" do
-        assert OpenStruct.new(id: 1).identify(klass: "Monkey") == "Monkey[id:1]"
+        OpenStruct.new(id: 1).identify(klass: "Monkey").must_equal "Monkey[id:1]"
       end
 
-      it "yields no class if given class is empty string" do
-        assert OpenStruct.new(id: 1).identify(klass: "") == "[id:1]"
-        assert OpenStruct.new(id: 1).identify(klass: nil) == "[id:1]"
+      it "yields no class, GIVEN class is empty string" do
+        OpenStruct.new(id: 1).identify(klass: "").must_equal "[id:1]"
+        OpenStruct.new(id: 1).identify(klass: nil).must_equal "[id:1]"
       end
 
       it "overrides object class name with :klass with no attributes" do
-        assert [].identify(klass: "Monkey") == "Monkey[]"
+        [].identify(klass: "Monkey").must_equal "Monkey[]"
       end
 
       it "yields first n (:limit) objects in collection" do
-        assert [1,2,3,4,5,6,7].identify(:to_i, limit: 3) ==
-          "Fixnum[to_i:1], Fixnum[to_i:2], Fixnum[to_i:3], ... (4 more)"
+        (1..7).to_a.identify(:to_i, limit: 3).must_equal(
+          "Fixnum[to_i:1], Fixnum[to_i:2], Fixnum[to_i:3], ... (4 more)")
       end
     end
   end

data/test/test_helper.rb

@@ -1,4 +1,3 @@
-# Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
@@ -8,7 +7,7 @@ require "minitest/rails"
 Rails.backtrace_cleaner.remove_silencers!
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir[Rails.root.join("test/support/**/*.rb")].each { |f| require f }
 
 # Load fixtures from the engine
 if ActiveSupport::TestCase.method_defined?(:fixture_path=)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Paul Dobbins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,20 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: naught
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Identify an object by inspecting its class name and attributes.