object_identifier 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c5a1784fbf5892f1a289cdf6e97a73c17da21d6
-  data.tar.gz: f0a9c0f931faad3e31dd5230d72195c93664f926
+  metadata.gz: 157f8efe2cfccf189c024f9dbf79bd406bcd8161
+  data.tar.gz: bf91af5bbe21d2ca45cc4020fe6db71d62f83bce
 SHA512:
-  metadata.gz: 4c036b06b434be033f7b1ecbe2c4acfcb8723115e49342af696b0e878aca7a2b5a0e369f259129e73b52306e7a84a7ada8329fef79832b11a5ef2fcb3f573e35
-  data.tar.gz: 193da902de57dad4ae7e3339c9c24118be8597640ff14a21dfe7aeeaca1e916481684b61a43330c2ca0ffc953e75ab41ab13fc89f20568240528c7047b8b2b1a
+  metadata.gz: 6e770c731b11d1789c09682845177510a6dbc0feb8f841f13955147dba10686f1ba0ecaecd31b11f4db05e320d72adb2c804c0e4333fcf211126c08dbfc6fe0f
+  data.tar.gz: 15cae1fb559f72d069f45a95072859b056290c278768ab318fbad9d9ad20a5712144961763f8ceb8eff9b80e9d8c243680e5d4631f0ef22391b5d6200510293b

data/README.md

@@ -0,0 +1,96 @@
+# Object Identifier
+
+[![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.
+
+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)}"`.
+
+
+## Compatibility
+
+Tested with:
+
+* Ruby: MRI 2.0.0
+* Rails: 4.0.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "object_identifier"
+```
+
+And then execute:
+
+```ruby
+bundle
+```
+
+## Usage
+
+<b>Defaults</b>
+
+Outputs the `id` attribute by default, if possible and if no other attributes
+are given:
+
+```ruby
+some_object.identify  # => Movie[id:1]
+```
+
+Also works with methods:
+
+```ruby
+some_object.identify(:get_rating)  # => Movie[get_rating:"7/10"]
+```
+
+<b>Unknown Attributes/Methods</b>
+
+If the object doesn't respond to a specified attribute/method it is simply
+ignored:
+
+```ruby
+some_object.identify(:gobble_gobble, :id)  # => Movie[id:1]
+```
+
+<b>Collections</b>
+
+Works great with collections:
+
+```ruby
+[some_object, some_other_object].identify(:id, :name)
+  # => Movie[id:1, name:"Pi"], Contact[id:23, name:"Bob"]
+```
+
+Also allows limiting of results:
+
+```ruby
+[some_object, some_other_object].identify(:id, :name, limit: 1)
+  # => Movie[id:1, name:"Pi"], ... (1 more)
+```
+
+<b>Overriding the Class Name</b>
+
+```ruby
+some_object.identify(klass: "MyMovie")       # => MyMovie[id:1]
+some_object.identify(klass: nil)             # => [id:1]
+delayed_job.identify(klass: "Delayed::Job")  # => Delayed::Job[id:1]
+```
+
+<b>Nils and Empty Collections</b>
+
+```ruby
+nil.identify(:id, :name)  # => [no objects]
+[].identify               # => [no objects]
+```
+
+## Authors
+
+- Paul Dobbins
+- Evan Sherwood

data/lib/object_identifier/identifier.rb

@@ -25,12 +25,7 @@ module ObjectIdentifier
     #   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)
-      obj = if obj.respond_to?(:to_ary)
-              obj.to_ary
-            else
-              [obj]
-            end
-      new(obj, *args).to_s
+      new(Array.wrap(obj), *args).to_s
     end
 
     def initialize(objects, *args)

data/lib/object_identifier/version.rb

@@ -1,3 +1,3 @@
 module ObjectIdentifier
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paul Dobbins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: naught
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +110,7 @@ files:
 - lib/object_identifier.rb
 - MIT-LICENSE
 - Rakefile
+- README.md
 - test/core_ext/object_test.rb
 - test/core_ext/string_test.rb
 - test/core_ext/symbol_test.rb