mongoid_upk 0.0.2 → 0.1.0

data/.travis.yml

@@ -0,0 +1,17 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - ruby-head
+  - rbx-18mode
+  - rbx-19mode
+
+branches:
+  only:
+    - develop
+    - master
+
+notifications:
+  email:
+    - chris@dinarrr.com

data/README.md

@@ -4,6 +4,8 @@ Mongoid::UPK generates more unique `_id` by using UUID.
 
 UPK stands for "unique primary key" or "uuid primary key".
 
+
+
 ## Install
 
 ```bash
@@ -16,8 +18,12 @@ gem install mongoid_upk
 gem "mongoid_upk"
 ```
 
+
+
 ## Usage
 
+**Basic**
+
 ```ruby
 class MyModel
   include Mongoid::Document
@@ -25,19 +31,18 @@ class MyModel
 end
 ```
 
-Will automatically use `UUID` ([uuid gem](https://github.com/assaf/uuid) by assaf), `:compact` mode per default.
-
-**Explicit definition**
+or:
 
 ```ruby
 class MyModel
   include Mongoid::Document
   include Mongoid::UPK
-  uuid_pk
+  uuid_pk # you can leave this out, because it's the default generator
 end
 ```
 
-Same as above.
+
+Will use `UUID` ([uuid gem](https://github.com/assaf/uuid) by assaf), `:compact` mode per default.
 
 **Pretty UUID**
 
@@ -65,9 +70,28 @@ end
 Very long `_id` with both BSON::ObjectId **and** UUID.
 (Example: `4f2e55a2ee911332c4000001-95faf560320f012f315510e6baa29f2c`)
 
+**Own pk generator**
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include Mongoid::UPK
+  unique_pk do
+    # code goes here
+    # result must be a string
+    # example:
+    Digest::MD5.hexdigest(Time.now.to_f.to_s)
+  end
+end
+```
+
+Example is self-describing.
+
+
+
 ## Motivation
 
-While writing very fast to MongoDB it is possible to take an BSON::ObjectId twice.
+While writing very fast to MongoDB it is possible to take a BSON::ObjectId twice.
 This will lead to big troubles because you never know which document will be returned.
 
 This gem utilizes the `key` method and overwrites the automatically given default id with the choosen generator on save.
@@ -77,6 +101,8 @@ UUID is in most cases more reliable, especially if the app instances are set up
 
 Read more about the [UUID gem and how to set up your project (e.g. using unicorn or other threaded webservers)](https://github.com/assaf/uuid).
 
+
+
 ## License
 
 MIT/X11

data/lib/mongoid_upk.rb

@@ -42,6 +42,16 @@ module Mongoid
         end
       end
 
+      def unique_pk
+        if block_given?
+          key :_id do |origin_bson_id|
+            yield
+          end
+        else
+          raise ArgumentError, "No block provided!"
+        end
+      end
+
     end
 
   end

data/lib/mongoid_upk/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mongoid
   module UPK
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/mongoid_upk.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_upk"
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Grabo"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".rvmrc",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",

data/spec/mongoid_upk_spec.rb

@@ -1,9 +1,12 @@
 # encoding: utf-8
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "digest/sha1"
+require "digest/md5"
 
 class TestDoc
   include Mongoid::Document
   include Mongoid::UPK
+  uuid_pk
 
   field :name
 end
@@ -18,6 +21,8 @@ describe Mongoid::UPK do
 
   it "bson id + uuid" do
     class TestDoc2 < TestDoc
+      include Mongoid::Document
+      include Mongoid::UPK
       bson_uuid_pk
     end
 
@@ -34,6 +39,21 @@ describe Mongoid::UPK do
         include Mongoid::UPK
       end
     }.to raise_error(Mongoid::UPK::MissingDependency)
+  end
+
+  it "#unique_pk with block" do
+    class TestDoc3
+      include Mongoid::Document
+      include Mongoid::UPK
+      unique_pk do
+        "md5-" + Digest::MD5.hexdigest(Time.now.to_f.to_s)
+      end
+    end
 
+    td = TestDoc3.new
+    old_id = td._id
+    td.save and td.reload
+    td._id.should_not == old_id
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_upk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &7357340 !ruby/object:Gem::Requirement
+  requirement: &10032780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7357340
+  version_requirements: *10032780
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &7356860 !ruby/object:Gem::Requirement
+  requirement: &10032300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7356860
+  version_requirements: *10032300
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &7356380 !ruby/object:Gem::Requirement
+  requirement: &10031820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7356380
+  version_requirements: *10031820
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &7355900 !ruby/object:Gem::Requirement
+  requirement: &10031340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *7355900
+  version_requirements: *10031340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &7355420 !ruby/object:Gem::Requirement
+  requirement: &10030860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7355420
+  version_requirements: *10030860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7354940 !ruby/object:Gem::Requirement
+  requirement: &10030380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7354940
+  version_requirements: *10030380
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &7354460 !ruby/object:Gem::Requirement
+  requirement: &10046300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7354460
+  version_requirements: *10046300
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &7353980 !ruby/object:Gem::Requirement
+  requirement: &10045820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7353980
+  version_requirements: *10045820
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &7353500 !ruby/object:Gem::Requirement
+  requirement: &10045340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7353500
+  version_requirements: *10045340
 - !ruby/object:Gem::Dependency
   name: pry-doc
-  requirement: &7369420 !ruby/object:Gem::Requirement
+  requirement: &10044860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7369420
+  version_requirements: *10044860
 description: Mongoid::UPK generates more unique `_id` by using UUID.
 email: chris@dinarrr.com
 executables: []
@@ -130,6 +130,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -155,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 762031412242489430
+      hash: 2358298730515367779
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: