mm_uses_uuid 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.project

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>mm_uses_uuid</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>com.aptana.projects.webnature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in mm_uses_uuid.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+
+mm_uses_uuid plugin
+============
+
+Models that use this plugin use a `BSON::Binary::SUBTYPE_UUID` for the model's id field rather than the default `BSON::ObjectId`.
+
+Requirements
+============
+
+- Ruby 1.9
+- MongoMapper 0.10.1 or greater
+
+Installation
+=======
+
+Add this to your Gemfile if using Bundler: `gem 'mm_uses_uuid'`
+
+Or install the gem from the command line: `gem install mm_uses_uuid`
+
+Usage
+=======
+
+Use the MongoMapper `plugin` method to add MmUsesUuid to your model, for example:
+
+```
+class Group
+  include MongoMapper::Document
+  plugin  MmUsesUuid
+  
+  many :people, :class_name => 'Person'
+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
+you can generate a new one like this:
+
+```
+g = Group.new
+g.find_new_uuid(:ensure_unique_in => Group)
+```
+
+This will generate random UUIDs until it finds one that isn't in the passed collection (`Group` in the example).
+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.
+
+Copyright (c) 2011 PeepAll Ltd, released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/lib/mm_uses_uuid.rb

@@ -0,0 +1,98 @@
+require 'mongo_mapper'
+require_relative "mm_uses_uuid/version"
+require_relative "mm_uses_uuid/bson_binary_mixin"
+
+module MmUsesUuid
+  extend ActiveSupport::Concern
+
+  included do
+    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)
+      
+      args.flatten!
+      if args.size > 1
+        args.map! {|id| BsonUuid.to_mongo(id)}
+      else
+        args = BsonUuid.to_mongo(args.first)
+      end
+      
+      super(args)
+    end
+    
+    def new(*args)
+      new_object = super(*args)
+      new_object.find_new_uuid
+      new_object
+    end
+
+  end
+
+  module InstanceMethods
+    
+    def find_new_uuid(options = {})
+      
+      options = {force_safe: false}.merge(options)
+        
+      if not options[:ensure_unique_in]
+        @_id, variant = make_uuid
+        #puts "assuming #{variant} UUID #{@_id} is available"
+        return
+      else
+        find_new_uuid_safely(options[:ensure_unique_in])
+      end
+
+    end
+    
+    def find_new_uuid_safely(coll)
+
+      @_id = nil
+      begin
+        trial_id, variant = make_uuid
+        #puts "CHECKING #{coll} collection for availability of #{variant} UUID: #{trial_id}"
+        if coll.where(:_id => trial_id).fields(:_id).first.nil?
+          @_id = trial_id
+        end
+      end while @_id.nil?
+
+    end
+    
+    def make_uuid
+        uuid = SecureRandom.uuid.gsub!('-', '')
+        bson_encoded_uuid = BSON::Binary.new(uuid, BSON::Binary::SUBTYPE_UUID)
+        return bson_encoded_uuid, 'random'
+    end
+    
+    def id_to_s!
+      @_id = @_id.to_s
+      self
+    end
+    
+    def id_to_s
+      copy = self.clone
+      copy.instance_variable_set '@_id',  @_id.to_s
+      copy
+    end
+    
+  end
+end

data/lib/mm_uses_uuid/bson_binary_mixin.rb

@@ -0,0 +1,24 @@
+require 'bson/byte_buffer'
+
+module BSON
+
+  class Binary < ByteBuffer
+
+    def inspect
+      string_render = self.to_s
+      if string_render.empty?
+        "<BSON::Binary:#{object_id}>"
+      else
+        string_length = string_render.length
+        if string_render.length > 32
+          "<BSON::Binary:'#{string_render[0..8]}...'}'>"
+        else
+          "<BSON::Binary:'#{string_render}'>"
+        end
+        
+      end
+    end
+
+  end
+  
+end

data/lib/mm_uses_uuid/version.rb

@@ -0,0 +1,3 @@
+module MmUsesUuid
+  VERSION = "0.0.1"
+end

data/mm_uses_uuid.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mm_uses_uuid/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonathan Chambers"]
+  gem.email         = ["j.chambers@gmx.net"]
+  gem.description   = %q{MongoMapper plugin that uses a UUID instead of the default ObjectID}
+  gem.summary       = %q{UUIDs for MM}
+  gem.homepage      = 'https://github.com/jmchambers/mm_uses_uuid'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "mm_uses_uuid"
+  gem.require_paths = ['lib']
+  gem.version       = MmUsesUuid::VERSION
+  gem.license       = 'MIT'
+  
+  gem.add_development_dependency "rspec", "~> 2.7"
+  gem.add_development_dependency "bson_ext", "~> 1.5.0"
+  gem.add_dependency "mongo_mapper", "~> 0.10.1"
+  
+end

data/spec/mm_uses_uuid_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path('../../lib/mm_uses_uuid', __FILE__)
+
+describe MmUsesUuid do
+  
+  before(:all) do    
+    class Group
+      include MongoMapper::Document
+      plugin  MmUsesUuid
+      
+      many :people, :class_name => 'Person'
+      
+    end
+    
+    class Person
+      include MongoMapper::Document
+      plugin  MmUsesUuid
+      
+      key :name
+      key :age
+      
+      belongs_to :group
+    end
+    
+    MongoMapper.connection = Mongo::Connection.new('localhost', 27017)
+    MongoMapper.database = 'mm_uses_uuid_test'
+    
+  end
+  
+  before(:each) do
+    #we have to use a before(:each) to get the stubbing to work :(
+    SecureRandom.stub!(:uuid).and_return(
+      "11111111-1111-4111-y111-111111111111",
+      "22222222-2222-4222-y222-222222222222",
+      "11111111-1111-4111-y111-111111111111", #we repeat these so that our safe uuid creation tests will detect a collision and be forced to search
+      "11111111-1111-4111-y111-111111111111",
+      "11111111-1111-4111-y111-111111111111",
+      "33333333-3333-4333-y333-333333333333"
+    )
+    @group  = Group.create
+    @person = Person.create(name: 'Jon', age: 33)
+  end
+  
+  it "should cause newly initialized objects to have a BSON::Binary uuid" do
+    @group._id.should be_an_instance_of(BSON::Binary)
+    @group._id.subtype.should == BSON::Binary::SUBTYPE_UUID
+  end
+  
+  it "should have a useful inspect method that shows the uuid string" do
+    @group._id.inspect.should == "<BSON::Binary:'#{@group._id.to_s}'>"
+  end
+
+  it "should cause associated objects to reference the parent uuid" do
+    @group.people << @person
+    @person.group_id.should == @group._id
+  end
+  
+  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"
+  end
+  
+  context 'finding by uuid' do
+    
+    it "with a BSON::Binary uuid" do
+      found_group = Group.find(@group._id)
+      found_group._id.should == @group._id
+    end
+    
+    it "with a String uuid" do
+      found_group = Group.find(@group._id.to_s)
+      found_group._id.should == @group._id
+    end
+    
+  end
+  
+  after(:each) do
+    Group.delete_all; Person.delete_all
+  end
+  
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: mm_uses_uuid
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jonathan Chambers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-05 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 1
+        version: 0.10.1
+  type: :runtime
+  version_requirements: *id003
+description: MongoMapper plugin that uses a UUID instead of the default ObjectID
+email: 
+- j.chambers@gmx.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .project
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mm_uses_uuid.rb
+- lib/mm_uses_uuid/bson_binary_mixin.rb
+- lib/mm_uses_uuid/version.rb
+- mm_uses_uuid.gemspec
+- spec/mm_uses_uuid_spec.rb
+has_rdoc: true
+homepage: https://github.com/jmchambers/mm_uses_uuid
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: UUIDs for MM
+test_files: []
+