light_mongo 0.0.1 → 0.1.0

data/README.md

@@ -4,9 +4,14 @@ LightMongo is a lightweight Mongo object persistence layer for Ruby which makes
 
 Status
 -----------------
-LightMongo is only a few days old, so while most of the features demo'd below work, there's no strong integration testing yet, so I wouldn't use it for data you particularly care about until I release a gem.
+LightMongo is still new, but all the examples below are working.  Please check out the integration tests for usage indications, and please post any issues you find to the the Github issues page.
 
-Check out the development roadmap for an idea of my current priorities.
+Installation
+------------
+LightMongo is best installed via `gem install light_mongo` and required as normal.
+
+It is dependent on the gem `mongo`, which is the MongoDB Ruby driver.
+For performance reasons I would recommend also installing `mongo_ext`, the C extensions for the driver.
 
 The problem
 -----------
@@ -26,6 +31,9 @@ We're Ruby developers.  Let's act like it.
 
 An example
 ----------
+    require 'rubygems'
+    require 'light_mongo'
+    
     class Article
       include LightMongo::Document
     end
@@ -118,14 +126,10 @@ LightMongo uses its Document mixin to signify a collection, so if you embed a Li
     Article.find.first.author == Person.find.first
     => true
 
-Roadmap
--------
-1. Improved testbed to allow stronger integration testing.
-2. More intelligent and efficient object serialisation.
-3. Proper deserialisation of cross-collection objects (currently they go in, don't come back out).
-4. Nested hash serialisation.
-4. Migrations (e.g. when you rename classes or modify their collection style).
-5. Some kind of validations, perhaps.
+Future development
+------------------
+1. Migrations (e.g. when you rename classes or modify their collection style).
+2. Some kind of validations, perhaps.
 
 
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/integration/basic_storage_cycle_spec.rb

@@ -2,20 +2,39 @@ require File.expand_path(File.dirname(__FILE__) + '/support/integration_helper')
 
 class Article
   include LightMongo::Document
+  
+  attr_accessor :title
 end
 
 describe 'The basic storage cycle' do
   before(:each) do
-    @geology_article = Article.new(:title => (@title = 'Fluid Physics in Geology'),
-                                   :abstract => (@abstract = 'Lorem ipsum dolor..'))
+    @geology_params = {
+      :title => (@title = 'Fluid Physics in Geology'),
+      :abstract => (@abstract = 'Lorem ipsum dolor..')
+    }
   end
   
-  it "allows the storage and retrieval of documents." do
-    @geology_article.save
+  it "creates and reads." do
+    Article.create(@geology_params)
     stored_article = Article.find.first
     stored_article.instance_variable_get('@title').should == @title
     stored_article.instance_variable_get('@abstract').should == @abstract
   end
   
+  it "updates." do
+    article = Article.create(@geology_params)
+    article.update!(:title => 'On CRUD in Object Persistence', :abstract => 'Rolod muspi merol..')
+
+    stored_article = Article.find.first
+    stored_article.instance_variable_get('@title').should == 'On CRUD in Object Persistence'
+    stored_article.instance_variable_get('@abstract').should == 'Rolod muspi merol..'
+  end
+  
+  it "deletes." do
+    article = Article.create(@geology_params)
+    article.delete!
+    Article.find.should be_empty
+  end
+  
   db_teardown
 end

data/lib/document/persistence.rb

@@ -36,6 +36,25 @@ module LightMongo
         @_id = collection.save(self.to_hash)
       end
       
+      def update(params)
+        params.each_pair do |attr_name, attr_value|
+          self.instance_variable_set '@'+attr_name.to_s, attr_value
+        end
+        
+        return self
+      end
+      
+      def update!(params)
+        self.update(params).save
+      end
+      
+      def delete!
+        if result = collection.remove(:_id => @_id)
+          @_id = nil
+          return result
+        end
+      end
+      
       def id
         @_id
       end

data/spec/document/persistence_spec.rb

@@ -49,6 +49,74 @@ describe LightMongo::Document::Persistence do
     end
   end
   
+  describe "#update!(params)" do
+    before(:each) do
+      @test_object = TestClass.new(:name => 'Test object')
+      @test_object.stub!(:save => (@result = mock(:result)))
+    end
+
+    def update_object
+      @test_object.update! :name => (@name = mock(:name))
+    end
+    
+    it "updates the object's state" do
+      update_object
+      @test_object.name.should == @name
+    end
+    
+    it "saves the object" do
+      @test_object.should_receive(:save)
+      update_object
+    end
+    
+    it "returns the result of the save" do
+      update_object.should == @result
+    end
+  end
+
+  describe "#update(params)" do
+    before(:each) do
+      @test_object = TestClass.new(:name => 'Test object')
+    end
+
+    def update_object
+      @test_object.update :name => (@name = mock(:name))
+    end
+    
+    it "updates the object's state" do
+      update_object
+      @test_object.name.should == @name
+    end
+    
+    it "returns the object" do
+      update_object.should == @test_object
+    end
+  end
+
+  describe "#delete!" do
+    before(:each) do
+      @test_object = TestClass.new(:_id => (@id = mock(:id)), :name => 'Test object')
+    end
+
+    it "removes the object" do
+      @test_class_collection.should_receive(:remove).with(:_id => @id)
+      @test_object.delete!
+    end
+    
+    it "returns the result of the remove" do
+      @test_class_collection.stub!(:remove => (@result = mock(:result)))
+      @test_object.delete!.should == @result
+    end
+    
+    it "erases the document's id" do
+      @test_object.id.should == @id
+
+      @test_class_collection.stub!(:remove => true)
+      @test_object.delete!
+      @test_object.id.should be_nil
+    end
+  end
+  
   describe "#id" do
     before(:each) do
       @id = mock(:id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: light_mongo
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Elliot Crosby-McCullough
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-21 00:00:00 +00:00
+date: 2010-03-27 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency