dm-aspects 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76edcbc7c99910f52334bb2a686fca0346c68156
-  data.tar.gz: 79f3f4292a74babff405e208ce23a4dfb76de132
+  metadata.gz: 19d6a6eef086183c567938fcb7d963be0990ea05
+  data.tar.gz: b83bd9acf7e9e998638a39049f682be85c81fa56
 SHA512:
-  metadata.gz: 3b7f4abd012ffe1d8fd88118e0bf9d1aeeac4ea74c614c41a4c4ce3451e2fecd3f34082360831bc940be77b4f45592018661ef5a3fabf8fcc7f87b348765c723
-  data.tar.gz: f4ecb216fcb3df27be1675e3b2a7281a4e84f8b3ceeca65259ec671a692bbb3b39d486c4b0f8afffa49346b9caf3b5b7e731d8f8657ba627fc25dcf258385497
+  metadata.gz: fe5f27486d39cf40804f6c678b59f241009be964b09b0138795256014feafab666a51c585767f4e64448b9cc5b2660dd707b489f5bf03f4f04515307a8bd9644
+  data.tar.gz: 39609270d6e706a806e49fc04a0e1bf98b64eb5e3a0e7f03a510c3af3c7de31badd19f7ac0d5632b0076ec3699a4cdcb3d9bcd8bbae7b8ce5e461b3d8c03070b

data/Rakefile

@@ -13,4 +13,5 @@ Rake::TestTask.new do |t|
   t.libs << "spec"
   t.pattern = "spec/**/*_spec.rb"
 end
+
 task :default => [:test]

data/lib/datamapper/aspects/bson_id.rb

@@ -2,17 +2,46 @@
 
 module DataMapper
   module Aspects
+    # Public: Provides a valid BSON Object ID key property.
+    # Also validates that BSON IDs are valid object ids.
+    #
+    # Examples
+    #
+    #   my_obj.id.id_is_valid?
+    #   # => true
+    #
+    #   my_obj.id.id_generation_time
+    #   # => 2014-05-09 06:07:00 UTC
     module BSONID
       def self.included(base)
+        # Public: Provides the default aspect's attributes.
         base.property :id, String, length: 24, key: true, default: Moped::BSON::ObjectId.new.to_s
+
+        # Internal: Validates that the BSON ID is a valid object id.
         base.validates_with_method :id, method: :id_is_valid?
 
+        # Public: Retrieves the generation time of the BSON Object ID.
+        #
+        # Examples
+        #
+        #   id_generation_time()
+        #   # => 2014-05-09 06:07:00 UTC
+        #
+        # Returns the generation time of the BSON Object ID as a String.
         def id_generation_time
           Moped::BSON::ObjectId.from_string(@id).generation_time
         end
 
+        # Public: Checks if the ID is a valid BSON Object ID.
+        #
+        # Examples
+        #
+        #   id_is_valid?()
+        #   # => true
+        #
+        # Returns true if ID is valid, false if not.
         def id_is_valid?
-          Moped::BSON::Objectid.legal?(@id)
+          Moped::BSON::ObjectId.legal?(@id)
         end
       end
     end

data/lib/dm-aspects/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   module Aspects
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dm-aspects
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - StyleSeek Engineering Team