mm_uses_uuid 0.0.5 → 0.0.6

data/README.md

@@ -31,7 +31,12 @@ class Group
 end
 ```
 
-The newly instantiated model will have a randomly generated UUID. If you want to make sure that the UUID hasn't already been used
+The newly instantiated model will have a randomly generated UUID.
+
+Ensuring truly unique UUIDs
+---------------------------
+
+If you want to make sure that the UUID hasn't already been used
 you can generate a new one like this:
 
 ```
@@ -43,4 +48,28 @@ This will generate random UUIDs until it finds one that isn't in the passed coll
 Obviously, the whole idea of random (type 4) UUIDs is that there is a tiny probability of generating duplicates.
 For this reason, you should only consider using `:ensure_unique_in` if a duplicate UUID would be a disaster for you.
 
+Encoding class in the LSN
+-------------------------
+
+It is possible to encode the class of an object in its UUID by forcing the least significant nibble (the rightmost hex character) of its UUIDs to be a particular value.
+To do this, add the `uuid_lsn` method to you model and pass it a single hex character like this:
+
+```
+class Group
+  include MongoMapper::Document
+  plugin  MmUsesUuid
+  
+  many :people, :class_name => 'Person'
+  
+  uuid_lsn 0xf
+end
+```
+
+Once this value is set you can use `MongoMapper.find_by_uuid(...)` to find by id (or a list of ids) and it will automatically detect the class by inspecting
+the last character of the UUIDs you pass. So for the example above, all UUIDs generated for new Group objects will end in 'f'
+and, if you pass a UUID ending in 'f' to `MongoMapper.find`, it will pass that request on to `Group.find()`.
+
+This method can be useful if you need to store long lists of ids, but don't want to incur any additional complexity and storage by storing
+the collection name as well. However, because we only use one nibble, this method can only be used for 16 distinct collections.
+
 Copyright (c) 2011 PeepAll Ltd, released under the MIT license

data/lib/mm_uses_uuid/version.rb

@@ -1,3 +1,3 @@
 module MmUsesUuid
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/mm_uses_uuid.rb

@@ -2,6 +2,42 @@ require 'mongo_mapper'
 require_relative "mm_uses_uuid/version"
 require_relative "mm_uses_uuid/bson_binary_mixin"
 
+class BsonUuid
+  def self.to_mongo(value)
+    case value
+    when String
+      BSON::Binary.new(value, BSON::Binary::SUBTYPE_UUID)
+    when BSON::Binary, NilClass
+      value
+    else
+      raise "BsonUuid cannot be of type #{value.class}. String, BSON::Binary and NilClass are the only permitted types"
+    end 
+  end
+  
+  def self.from_mongo(value)
+    value
+  end
+end
+
+module MongoMapper
+  
+  @@lsn_class ||= []
+  
+  def self.find_by_uuid(*args)
+    args.flatten!
+    ids_by_class = {}
+    args.each do |id|
+      lsn = id.to_s[-1].hex
+      klass = @@lsn_class[lsn]
+      raise "expected to find a class in @@lsn_class[#{lsn}] of the MongoMapper module but there was no entry. You need to set uuid_lsn in you class." if klass.nil?
+      ids_by_class[klass] ||= []
+      ids_by_class[klass] << id
+    end
+    ids_by_class.map {|klass, ids| klass.find(ids)} .flatten
+  end
+  
+end
+
 module MmUsesUuid
   extend ActiveSupport::Concern
 
@@ -9,23 +45,6 @@ module MmUsesUuid
     key :_id, BsonUuid
   end
 
-  class BsonUuid
-    def self.to_mongo(value)
-      case value
-      when String
-        BSON::Binary.new(value, BSON::Binary::SUBTYPE_UUID)
-      when BSON::Binary, NilClass
-        value
-      else
-        raise "BsonUuid cannot be of type #{value.class}. String, BSON::Binary and NilClass are the only permitted types"
-      end 
-    end
-    
-    def self.from_mongo(value)
-      value
-    end
-  end
-  
   module ClassMethods
     
     def find(*args)
@@ -36,8 +55,8 @@ module MmUsesUuid
       else
         args = BsonUuid.to_mongo(args.first)
       end
-      
       super(args)
+      
     end
     
     def new(params = {})
@@ -51,6 +70,14 @@ module MmUsesUuid
       new_object
     end
 
+    def uuid_lsn(lsn_integer)
+      add_class_lsn(self, lsn_integer)
+    end
+    
+    def add_class_lsn(klass, lsn_integer)
+      MongoMapper.class_eval "@@lsn_class[#{lsn_integer}] = #{klass}"
+    end
+
   end
 
   module InstanceMethods
@@ -83,9 +110,13 @@ module MmUsesUuid
     end
     
     def make_uuid
-        uuid = SecureRandom.uuid.gsub!('-', '')
-        bson_encoded_uuid = BSON::Binary.new(uuid, BSON::Binary::SUBTYPE_UUID)
-        return bson_encoded_uuid, 'random'
+      uuid = SecureRandom.uuid.gsub!('-', '')
+      lsn_class = MongoMapper.class_variable_get('@@lsn_class')
+      if replacement_lsn = lsn_class.index(self.class)
+        uuid[-1] = replacement_lsn.to_s(16)
+      end
+      bson_encoded_uuid = BSON::Binary.new(uuid, BSON::Binary::SUBTYPE_UUID)
+      return bson_encoded_uuid, 'random'
     end
     
     def id_to_s!

data/spec/mm_uses_uuid_spec.rb

@@ -7,8 +7,11 @@ describe MmUsesUuid do
       include MongoMapper::Document
       plugin  MmUsesUuid
       
+      key  :name, String
       many :people, :class_name => 'Person'
       
+      uuid_lsn 0
+      
     end
     
     class Person
@@ -19,6 +22,9 @@ describe MmUsesUuid do
       key :age
       
       belongs_to :group
+      
+      uuid_lsn 0xf
+      
     end
     
     MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
@@ -36,7 +42,7 @@ describe MmUsesUuid do
       "11111111-1111-4111-y111-111111111111",
       "33333333-3333-4333-y333-333333333333"
     )
-    @group  = Group.create
+    @group  = Group.create(name: 'mongo_mapper fanclub')
     @person = Person.create(name: 'Jon', age: 33)
   end
   
@@ -45,12 +51,21 @@ describe MmUsesUuid do
     @group._id.subtype.should == BSON::Binary::SUBTYPE_UUID
   end
   
+  it "should replace the least significant bits with the integer specified using uuid_lsn" do
+    @group._id.to_s.slice(-1).should == '0'
+    @person._id.to_s.slice(-1).should == 'f'
+  end
+
+  it "should perform a find on the right collection if MongoMapper.find is used" do
+    MongoMapper.find_by_uuid(@person.id, @group.id).map(&:name).should include(@person.name, @group.name)
+  end
+
   it "should not set a new uuid if one as passed as a param" do
-    group_with_passed_id = Group.new(:id => BSON::Binary.new("3333333333334333y333333333333333", BSON::Binary::SUBTYPE_UUID))
-    group_with_passed_id.id.to_s.should == "3333333333334333y333333333333333"
+    group_with_passed_id = Group.new(:id => BSON::Binary.new("3333333333334333y333333333333330", BSON::Binary::SUBTYPE_UUID))
+    group_with_passed_id.id.to_s.should == "3333333333334333y333333333333330"
     
-    group_with_passed_id = Group.new('_id' => BSON::Binary.new("3333333333334333y333333333333333", BSON::Binary::SUBTYPE_UUID))
-    group_with_passed_id.id.to_s.should == "3333333333334333y333333333333333"
+    group_with_passed_id = Group.new('_id' => BSON::Binary.new("3333333333334333y333333333333330", BSON::Binary::SUBTYPE_UUID))
+    group_with_passed_id.id.to_s.should == "3333333333334333y333333333333330"
   end
   
   it "should have a useful inspect method that shows the uuid string" do
@@ -58,8 +73,8 @@ describe MmUsesUuid do
   end
   
   it "should report that uuid BSON::Binary objects are eql? if they encode the same string" do
-    a = BSON::Binary.new("3333333333334333y333333333333333", BSON::Binary::SUBTYPE_UUID)
-    b = BSON::Binary.new("3333333333334333y333333333333333", BSON::Binary::SUBTYPE_UUID)
+    a = BSON::Binary.new("3333333333334333y333333333333330", BSON::Binary::SUBTYPE_UUID)
+    b = BSON::Binary.new("3333333333334333y333333333333330", BSON::Binary::SUBTYPE_UUID)
     a.should eql b
   end
 
@@ -71,7 +86,7 @@ describe MmUsesUuid do
   it "should ensure that the uuid is unique if :ensure_unique_in is set" do
     safe_new_group = Group.new
     safe_new_group.find_new_uuid(:ensure_unique_in => Group)
-    safe_new_group._id.to_s.should == "3333333333334333y333333333333333"
+    safe_new_group._id.to_s.should == "3333333333334333y333333333333330"
   end
   
   context 'finding by uuid' do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Jonathan Chambers
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-23 00:00:00 +00:00
+date: 2012-01-01 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency