dm-aspects 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77a91169bc5a83e7318913fdea269fcf5b3ff186
-  data.tar.gz: e7e48625182f7285b3a9d5dcfdaa2e18db4f711c
+  metadata.gz: 76edcbc7c99910f52334bb2a686fca0346c68156
+  data.tar.gz: 79f3f4292a74babff405e208ce23a4dfb76de132
 SHA512:
-  metadata.gz: d20d1431f8c1255ebe418706b40c36e6675d7b4dec2d46886f835f0ee0bd8f5791fbd0288326ee202edf21d9f4e66d47009fd8d7b830cdae7b062ae2eee1481a
-  data.tar.gz: 8457cb7a73f440c810e981456b1fca67c2c271a535c6fb7e15455cf6757c1ec83e224c9ee98c584801a3dbcfb522dd10b1d58f973ce61e17f256568bf4ccf2be
+  metadata.gz: 3b7f4abd012ffe1d8fd88118e0bf9d1aeeac4ea74c614c41a4c4ce3451e2fecd3f34082360831bc940be77b4f45592018661ef5a3fabf8fcc7f87b348765c723
+  data.tar.gz: f4ecb216fcb3df27be1675e3b2a7281a4e84f8b3ceeca65259ec671a692bbb3b39d486c4b0f8afffa49346b9caf3b5b7e731d8f8657ba627fc25dcf258385497

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in dm-aspects.gemspec
 gemspec
+
+gem 'moped', require: 'moped/bson'

data/README.md

@@ -14,6 +14,42 @@ And then execute:
 
 ## Usage
 
+### DataMapper::Aspects::BSONID
+
+Adds a primary key property called `:id` to your model that uses BSONID:
+
+    property :id, String, length: 24, key: true, default: Moped::BSON::ObjectId.new
+
+Moped::BSON has been found to be the fastest BSON ObjectId library for ruby, so it
+was chosen for ObjectID generation and validation. However, `dm-aspects` has not declared
+this as a dependency, since all `dm-aspects` are optional (and declaring `moped` as a
+dependency would drag a bunch of unwanted code in and slow down your boot up time).
+
+As such, you to add this to you Gemfile before using this module:
+
+````ruby
+gem 'moped', require: 'moped/bson'
+````
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+  include DataMapper::Aspects::BSONID
+
+  # :id is added automatically
+  property :name
+  
+end
+
+MyModel.create(name: 'Example')
+# => #<MyModel @id="53673b2c89d50f5c7400001f" @name="Example">
+````
+
+---
+
+
 ### DataMapper::Aspects::Slug
 
 Adds a `:slug` property to your model:
@@ -36,7 +72,7 @@ end
 
 MyModel.create(slug: 'my-slug')
 MyModel.find_by_slug('')
-# => #<Game @id=1 @slug="my-slug">
+# => #<MyModel @id=1 @slug="my-slug">
 ````
 
 ---

data/lib/datamapper/aspects/bson_id.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module DataMapper
+  module Aspects
+    module BSONID
+      def self.included(base)
+        base.property :id, String, length: 24, key: true, default: Moped::BSON::ObjectId.new.to_s
+        base.validates_with_method :id, method: :id_is_valid?
+
+        def id_generation_time
+          Moped::BSON::ObjectId.from_string(@id).generation_time
+        end
+
+        def id_is_valid?
+          Moped::BSON::Objectid.legal?(@id)
+        end
+      end
+    end
+  end
+end

data/lib/dm-aspects/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dm-aspects
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - StyleSeek Engineering Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dm-core
@@ -81,6 +81,7 @@ files:
 - Rakefile
 - dm-aspects.gemspec
 - lib/datamapper/aspects.rb
+- lib/datamapper/aspects/bson_id.rb
 - lib/datamapper/aspects/slug.rb
 - lib/datamapper/aspects/status.rb
 - lib/datamapper/aspects/utils.rb
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Aspect-Oriented modules to add enhance your DataMapper models.