mongomatic 0.1.1 → 0.1.2

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Mongomatic allows you to map your Ruby objects to Mongo documents. It is designed to be fast and simple.
 
-== Usage
+== Basic Usage
 
   require 'mongomatic'
   
@@ -10,7 +10,7 @@ Mongomatic allows you to map your Ruby objects to Mongo documents. It is designe
     validates_presence_of :name, :email
   end
   
-  # set the db settings for all models:
+  # set the db for all models:
   Mongomatic.db = Mongo::Connection.new.db("mongomatic_test")
   # or you can set it for a specific model:
   User.db = Mongo::Connection.new.db("mongomatic_test_user")
@@ -46,7 +46,30 @@ Mongomatic allows you to map your Ruby objects to Mongo documents. It is designe
   cursor.count
   => 0 
   cursor.next
-  => nil 
+  => nil
+  
+  found = User.find_one({"name" => "Ben Myles"})
+  => #<User:0x00000100ccd408 @doc={"_id"=>BSON::ObjectID('4c32c3720218236526000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false>
+  found = User.find_one(BSON::ObjectID('4c32c3720218236526000001'))
+  => #<User:0x00000100ccd408 @doc={"_id"=>BSON::ObjectID('4c32c3720218236526000001'), "name"=>"Ben Myles", "email"=>"me@somewhere.com"}, @removed=false>
+  
+== Indexes
+
+Mongomatic doesn't do anything special to support indexes, but here's the suggested convention:
+
+  class Person < Mongomatic::Base
+    validates_presence_of :name, :email
+  
+    class << self
+      def create_indexes
+        collection.create_index("email", :unique => true)
+      end
+    end
+  end
+  
+You can run Person.create_indexes whenever you add new indexes, it won't throw an error if they already exist.
+
+If you have defined a unique index and want Mongomatic to raise an exception on a duplicate insert you need to use insert_safe or update_safe. The error thrown will be Mongo::OperationFailure. See the test suite for examples.
 
 == Note on Patches/Pull Requests
  

data/lib/mongomatic/base.rb

@@ -26,8 +26,7 @@ module Mongomatic
         Mongomatic::Cursor.new(self, collection.find(query, opts))
       end
       
-      def find_one(query = nil, opts = {})
-        query = BSON::ObjectID(query) if query.is_a? String
+      def find_one(query={}, opts={})
         return nil unless doc = self.collection.find_one(query, opts)
         self.new(doc)
       end
@@ -98,6 +97,11 @@ module Mongomatic
       ret
     end
     
+    def insert_safe(opts={})
+      opts.merge!(:safe => true)
+      insert(opts)
+    end
+    
     def update(opts={},update_doc=@doc)
       return false if new? || removed? || !valid?
       self.send(:before_update) if self.respond_to?(:before_update)
@@ -108,6 +112,11 @@ module Mongomatic
       ret
     end
     
+    def update_safe(opts={},update_doc=@doc)
+      opts.merge!(:safe => true)
+      update(opts,update_doc)
+    end
+    
     def remove(opts={})
       return false if new?
       self.send(:before_remove) if self.respond_to?(:before_remove)
@@ -118,6 +127,11 @@ module Mongomatic
       ret
     end
     
+    def remove_safe(opts={})
+      opts.merge!(:safe => true)
+      remove(opts)
+    end
+    
     def to_hash
       @doc || {}
     end

data/test/helper.rb

@@ -13,6 +13,10 @@ class Person < Mongomatic::Base
   validates_presence_of :name
   attr_accessor :callback_tests
   
+  def self.create_indexes
+    collection.create_index("name", :unique => true)
+  end
+  
   def before_validate
     self.callback_tests ||= []
     self.callback_tests << :before_validate

data/test/test_mongomatic.rb

@@ -2,35 +2,50 @@ require 'helper'
 
 class TestMongomatic < Test::Unit::TestCase
   should "find one with a query" do
-    Person.collection.remove
+    Person.collection.drop
     p1 = Person.new(:name => "Jordan")
     p1.insert
     
     assert_equal p1, Person.find_one(:name => "Jordan")
   end
+  
   should "find one with an instance of BSON::ObjectID" do
-    Person.collection.remove
+    Person.collection.drop
     p1 = Person.new(:name => "Jordan")
     p1.insert
     
     assert_equal p1, Person.find_one(p1['_id'])
   end
-  should "find one with a string" do
-    Person.collection.remove
-    p1 = Person.new(:name => "Jordan")
-    p1.insert 
+  
+  should "find one with ObjectID or hash only" do
+    Person.collection.drop
+    Person.create_indexes
+    
+    p = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
+    assert p.insert_safe.is_a?(BSON::ObjectID)
+    assert_equal 1, Person.count
+    
+    found = Person.find({"_id" => BSON::ObjectID(p["_id"].to_s)}).next
+    assert_equal found, p
+    
+    assert_raise(TypeError) { Person.find_one(p["_id"].to_s) }
+    
+    found = Person.find_one({"_id" => p["_id"].to_s})
+    assert_equal found, nil
     
-    assert_equal p1, Person.find_one(p1['_id'].to_s)
+    found = Person.find_one({"_id" => BSON::ObjectID(p["_id"].to_s)})
+    assert_equal found, p
   end
+  
   should "return an instance of class when finding one" do
-    Person.collection.remove
+    Person.collection.drop
     p1 = Person.new(:name => "Jordan")
     p1.insert
     
     assert_equal Person, Person.find_one(:name => "Jordan").class
   end
   should "work with enumerable methods" do
-    Person.collection.remove
+    Person.collection.drop
     p1 = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
     p2 = Person.new(:name => "Ben2", :birth_year => 1986, :created_at => Time.now.utc, :admin => true)
     assert p1.insert.is_a?(BSON::ObjectID)
@@ -41,7 +56,7 @@ class TestMongomatic < Test::Unit::TestCase
   end
   
   should "be able to insert, update, remove documents" do
-    Person.collection.remove
+    Person.collection.drop
     
     p = Person.new
     
@@ -80,7 +95,7 @@ class TestMongomatic < Test::Unit::TestCase
   end
   
   should "be able to limit and sort" do
-    Person.collection.remove
+    Person.collection.drop
     p = Person.new(:name => "Ben", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
     assert p.insert.is_a?(BSON::ObjectID)
     assert_equal 1, Person.collection.count
@@ -112,7 +127,7 @@ class TestMongomatic < Test::Unit::TestCase
   end
   
   should "cursor implements enumerable" do
-    Person.collection.remove
+    Person.collection.drop
     1000.upto(2000) do |i|
       p = Person.new(:name => "Ben#{i}", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
       assert p.insert.is_a?(BSON::ObjectID)
@@ -128,7 +143,7 @@ class TestMongomatic < Test::Unit::TestCase
   end
   
   should "be able to merge hashes" do
-    Person.collection.remove
+    Person.collection.drop
     p = Person.new(:name => "Ben", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
     assert p.insert.is_a?(BSON::ObjectID)
     assert_equal 1, Person.collection.count
@@ -154,4 +169,18 @@ class TestMongomatic < Test::Unit::TestCase
     p.remove
     assert_equal [:before_remove, :after_remove], p.callback_tests
   end
+  
+  should "raise an error on unique index dup insert" do
+    Person.collection.drop
+    Person.create_indexes
+    
+    p = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
+    assert p.insert_safe.is_a?(BSON::ObjectID)
+    assert_equal 1, Person.count
+    
+    p = Person.new(:name => "Ben1", :birth_year => 1984, :created_at => Time.now.utc, :admin => true)
+    assert_raise(Mongo::OperationFailure) { p.insert_safe }
+    
+    assert_equal 1, Person.count
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ben Myles
@@ -21,7 +21,6 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -36,7 +35,6 @@ dependencies:
   name: bson
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -51,7 +49,6 @@ dependencies:
   name: bson_ext
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -66,7 +63,6 @@ dependencies:
   name: mongo
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -81,7 +77,6 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -130,8 +125,6 @@ files:
 - lib/mongomatic/validatable/validations/validation_base.rb
 - LICENSE
 - README.rdoc
-- test/helper.rb
-- test/test_mongomatic.rb
 has_rdoc: true
 homepage: http://github.com/benmyles/mongomatic
 licenses: []
@@ -142,7 +135,6 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -150,7 +142,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -160,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Mongomatic is a simple Ruby object mapper for Mongo