mongoid 0.6.1 → 0.6.2

data/README.textile

@@ -35,8 +35,9 @@ Example of a simple domain model:
 
 <pre>
   class Person < Mongoid::Document
+    include Mongoid::Versioning
     field :title
-    field :age, :default => 0
+    field :age, :type => Integer, :default => 0
     has_many :addresses
     has_one :name
   end
@@ -50,9 +51,9 @@ Example of a simple domain model:
   end
 
   class Name < Mongoid::Document
+    include Mongoid::Timestamps
     field :first_name
     field :last_name
-    has_timestamps
   end
 </pre>
 
@@ -88,6 +89,12 @@ Deleting:
   Person.delete_all(:title => "Sir")
 </pre>
 
+Count:
+
+<pre>
+  Person.count
+</pre>
+
 Retrieval of Documents from the database can be done in the traditional ActiveRecord
 manner or done using the Mongoid criteria DSL.
 
@@ -104,6 +111,7 @@ New School:
 
 <pre>
   Person.select(:first_name, :last_name).where(:title => "Sir").skip(10).limit(10).execute
+  Person.select(:title).aggregate
   Criteria.translate(:conditions => { :title => "Sir" }).execute
 </pre>
 
@@ -113,6 +121,25 @@ Paginate Document search results:
   Person.paginate(:conditions => {:title => "Esquire"}, :page => 1, :per_page => 20)
 </pre>
 
+Versioning:
+
+Versioning can be added by including Mongoid::Versioning in your document. This will give
+a version field, and will update the version number with each save. Additionally each
+version of the document will be stored in a versions array, embedded within the document.
+
+<pre>
+  class Person < Mongoid::Document
+    include Mongoid::Versioning
+    field :title
+  end
+
+  @person = Person.new
+  @person.save # Version 1
+  @person.title = "Madam"
+  @person.save # Version 2
+  @person.versions.size = 1
+</pre>
+
 Validations:
 
 Mongoid supports all validations provided by Jay Fields' <tt>Validatable</tt> gem.

data/Rakefile

@@ -24,7 +24,6 @@ rescue LoadError
 end
 
 Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << "lib" << "spec"
   spec.pattern = "spec/**/*_spec.rb"
   spec.spec_opts = ['--options', "spec/spec.opts"]
 end

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.6.2

data/lib/mongoid.rb

@@ -38,8 +38,9 @@ require "mongoid/commands"
 require "mongoid/criteria"
 require "mongoid/extensions"
 require "mongoid/field"
-require "mongoid/document"
 require "mongoid/timestamps"
+require "mongoid/versioning"
+require "mongoid/document"
 
 module Mongoid
 

data/lib/mongoid/criteria.rb

@@ -100,8 +100,13 @@ module Mongoid #:nodoc:
     # objects of the type of class provided.
     def execute(klass = nil)
       @klass = klass if klass
-      return @klass.new(klass.collection.find_one(@selector, @options)) if type == :first
-      return @klass.collection.find(@selector, @options).collect { |doc| @klass.new(doc) }
+      if type == :first
+        attributes = klass.collection.find_one(@selector, @options)
+        attributes ? @klass.new(attributes) : nil
+      else
+        attributes = @klass.collection.find(@selector, @options)
+        attributes ? attributes.collect { |doc| @klass.new(doc) } : []
+      end
     end
 
     # Adds a criterion to the +Criteria+ that specifies additional options

data/lib/mongoid/timestamps.rb

@@ -6,8 +6,7 @@ module Mongoid
         include InstanceMethods
         field :created_at, :type => Time
         field :modified_at, :type => Time
-        before_create :update_created_at, :update_modified_at
-        before_save :update_modified_at
+        before_save :update_created_at, :update_modified_at
       end
     end
 
@@ -16,7 +15,7 @@ module Mongoid
       # Update the created_at field on the Document to the current time. This is
       # only called on create.
       def update_created_at
-        self.created_at = Time.now.utc
+        self.created_at = Time.now.utc if !created_at
       end
 
       # Update the last_modified field on the Document to the current time.

data/lib/mongoid/versioning.rb

@@ -0,0 +1,27 @@
+module Mongoid #:nodoc:
+  # Include this module to get automatic versioning of root level documents.
+  # This will add a version field to the +Document+ and a has_many association
+  # with all the versions contained in it.
+  module Versioning
+    def self.included(base)
+      base.class_eval do
+        field :version, :type => Integer, :default => 1
+        has_many :versions, :class_name => self.name
+        before_save :revise
+        include InstanceMethods
+      end
+    end
+    module InstanceMethods
+      # Create a new version of the +Document+. This will load the previous
+      # document from the database and set it as the next version before saving
+      # the current document. It then increments the version number.
+      def revise
+        last_version = self.class.find(id)
+        if last_version
+          self.versions << last_version
+          self.version = version + 1
+        end
+      end
+    end
+  end
+end

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.6.1"
+  s.version = "0.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2009-10-31}
+  s.date = %q{2009-11-01}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.textile"
@@ -56,6 +56,7 @@ Gem::Specification.new do |s|
      "lib/mongoid/extensions/time/conversions.rb",
      "lib/mongoid/field.rb",
      "lib/mongoid/timestamps.rb",
+     "lib/mongoid/versioning.rb",
      "mongoid.gemspec",
      "spec/integration/mongoid/document_spec.rb",
      "spec/spec.opts",
@@ -91,7 +92,8 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/extensions/symbol/inflections_spec.rb",
      "spec/unit/mongoid/extensions/time/conversions_spec.rb",
      "spec/unit/mongoid/field_spec.rb",
-     "spec/unit/mongoid/timestamps_spec.rb"
+     "spec/unit/mongoid/timestamps_spec.rb",
+     "spec/unit/mongoid/versioning_spec.rb"
   ]
   s.homepage = %q{http://github.com/durran/mongoid}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -132,7 +134,8 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/extensions/symbol/inflections_spec.rb",
      "spec/unit/mongoid/extensions/time/conversions_spec.rb",
      "spec/unit/mongoid/field_spec.rb",
-     "spec/unit/mongoid/timestamps_spec.rb"
+     "spec/unit/mongoid/timestamps_spec.rb",
+     "spec/unit/mongoid/versioning_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/integration/mongoid/document_spec.rb

@@ -1,5 +1,36 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  include Mongoid::Timestamps
+  field :title
+  field :terms, :type => Boolean
+  field :age, :type => Integer, :default => 100
+  field :dob, :type => Date
+  has_many :addresses
+  has_one :name
+end
+
+class Address < Mongoid::Document
+  field :street
+  field :city
+  field :state
+  field :comment_code
+  key :street
+  belongs_to :person
+end
+
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
+class Comment < Mongoid::Document
+  include Mongoid::Versioning
+  field :text
+end
+
 describe Mongoid::Document do
 
   before do
@@ -199,4 +230,21 @@ describe Mongoid::Document do
 
   end
 
+  context "versioning" do
+
+    before do
+      @comment = Comment.new(:text => "Testing")
+      @comment.save
+    end
+
+    it "versions on save" do
+      @from_db = Comment.find(@comment.id)
+      @from_db.text = "New"
+      @from_db.save
+      @from_db.versions.size.should == 1
+      @from_db.version.should == 2
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -14,63 +14,3 @@ Spec::Runner.configure do |config|
   config.mock_with :mocha
   Mocha::Configuration.prevent(:stubbing_non_existent_method)
 end
-
-class MixedDrink < Mongoid::Document
-  field :name
-end
-
-class Person < Mongoid::Document
-  include Mongoid::Timestamps
-  field :title
-  field :terms, :type => Boolean
-  field :age, :type => Integer, :default => 100
-  field :dob, :type => Date
-  field :mixed_drink, :type => MixedDrink
-  has_many :addresses
-  has_many :phone_numbers, :class_name => "Phone"
-  has_one :name
-  has_one :pet, :class_name => "Animal"
-end
-
-class Address < Mongoid::Document
-  field :street
-  field :city
-  field :state
-  field :post_code
-  key :street
-  belongs_to :person
-end
-
-class Phone < Mongoid::Document
-  field :number
-  key :number
-  belongs_to :person
-  has_one :country_code
-end
-
-class CountryCode < Mongoid::Document
-  field :code, :type => Integer
-  key :code
-  belongs_to :phone_number
-end
-
-class Animal < Mongoid::Document
-  field :name
-  key :name
-  belongs_to :person
-end
-
-class Name < Mongoid::Document
-  field :first_name
-  field :last_name
-  key :first_name, :last_name
-  belongs_to :person
-end
-
-class Decorated
-  include Mongoid::Associations::Decorator
-
-  def initialize(doc)
-    @document = doc
-  end
-end

data/spec/unit/mongoid/associations/belongs_to_association_spec.rb

@@ -1,5 +1,12 @@
 require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
 
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
 describe Mongoid::Associations::BelongsToAssociation do
 
   before do

data/spec/unit/mongoid/associations/decorator_spec.rb

@@ -1,5 +1,34 @@
 require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  field :terms, :type => Boolean
+  field :age, :type => Integer, :default => 100
+  field :dob, :type => Date
+  has_many :addresses
+  has_one :name
+end
+
+class Address < Mongoid::Document
+  field :street
+  key :street
+  belongs_to :person
+end
+
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
+class Decorated
+  include Mongoid::Associations::Decorator
+  def initialize(doc)
+    @document = doc
+  end
+end
+
 describe Mongoid::Associations::Decorator do
 
   describe "#included" do

data/spec/unit/mongoid/associations/factory_spec.rb

@@ -1,5 +1,24 @@
 require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  has_many :addresses
+  has_one :name
+end
+
+class Address < Mongoid::Document
+  field :street
+  key :street
+  belongs_to :person
+end
+
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
 describe Mongoid::Associations::Factory do
 
   describe "#create" do

data/spec/unit/mongoid/associations/has_many_association_spec.rb

@@ -1,5 +1,16 @@
 require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  has_many :addresses
+end
+
+class Address < Mongoid::Document
+  field :street
+  key :street
+  belongs_to :person
+end
+
 describe Mongoid::Associations::HasManyAssociation do
 
   before do

data/spec/unit/mongoid/associations/has_one_association_spec.rb

@@ -1,5 +1,9 @@
 require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
 
+class MixedDrink < Mongoid::Document
+  field :name
+end
+
 describe Mongoid::Associations::HasOneAssociation do
 
   before do

data/spec/unit/mongoid/associations_spec.rb

@@ -1,5 +1,48 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  has_many :addresses
+  has_many :phone_numbers, :class_name => "Phone"
+  has_one :name
+  has_one :pet, :class_name => "Animal"
+end
+
+class Animal < Mongoid::Document
+  field :name
+  key :name
+  belongs_to :person
+end
+
+class CountryCode < Mongoid::Document
+  field :code, :type => Integer
+  key :code
+  belongs_to :phone_number
+end
+
+class Address < Mongoid::Document
+  field :street
+  field :city
+  field :state
+  field :post_code
+  key :street
+  belongs_to :person
+end
+
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
+class Phone < Mongoid::Document
+  field :number
+  key :number
+  belongs_to :person
+  has_one :country_code
+end
+
 describe Mongoid::Associations do
 
   before do

data/spec/unit/mongoid/attributes_spec.rb

@@ -1,5 +1,10 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :terms, :type => Boolean
+  field :age, :type => Integer, :default => 100
+end
+
 describe Mongoid::Attributes do
 
   describe "#process" do
@@ -22,7 +27,7 @@ describe Mongoid::Attributes do
         }
       end
 
-      it "returns a properly cast HashWithIndifferentAccess" do
+      it "returns a properly cast the attributes" do
         attrs = Person.new(@attributes).attributes
         attrs[:age].should == 30
         attrs[:terms].should == true

data/spec/unit/mongoid/commands_spec.rb

@@ -1,5 +1,9 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+end
+
 describe Mongoid::Commands do
 
   context "instance methods" do

data/spec/unit/mongoid/criteria_spec.rb

@@ -1,5 +1,9 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+end
+
 describe Mongoid::Criteria do
 
   before do
@@ -90,12 +94,34 @@ describe Mongoid::Criteria do
 
     context "when type is :first" do
 
-      it "calls find on the collection with the selector and options" do
-        criteria = Mongoid::Criteria.new(:first)
-        collection = mock
-        Person.expects(:collection).returns(collection)
-        collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns({})
-        criteria.execute(Person).should be_a_kind_of(Person)
+      context "when documents exist" do
+
+        before do
+          @collection = mock
+          Person.expects(:collection).returns(@collection)
+          @collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns({ :title => "Sir" })
+        end
+
+        it "calls find on the collection with the selector and options" do
+          criteria = Mongoid::Criteria.new(:first)
+          criteria.execute(Person).should be_a_kind_of(Person)
+        end
+
+      end
+
+      context "when no documents exist" do
+
+        before do
+          @collection = mock
+          Person.expects(:collection).returns(@collection)
+          @collection.expects(:find_one).with(@criteria.selector, @criteria.options).returns(nil)
+        end
+
+        it "returns nil" do
+          criteria = Mongoid::Criteria.new(:first)
+          criteria.execute(Person).should be_nil
+        end
+
       end
 
     end

data/spec/unit/mongoid/document_spec.rb

@@ -1,5 +1,31 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class MixedDrink < Mongoid::Document
+  field :name
+end
+
+class Person < Mongoid::Document
+  field :title
+  field :terms, :type => Boolean
+  field :age, :type => Integer, :default => 100
+  field :mixed_drink, :type => MixedDrink
+  has_many :addresses
+  has_one :name
+end
+
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
+class Address < Mongoid::Document
+  field :street
+  key :street
+  belongs_to :person
+end
+
 describe Mongoid::Document do
 
   before do
@@ -237,7 +263,7 @@ describe Mongoid::Document do
   describe "#first" do
 
     before do
-      @attributes = HashWithIndifferentAccess.new(:age => 100)
+      @attributes = { "age" => 100, "version" => 1 }
     end
 
     context "when a selector is provided" do

data/spec/unit/mongoid/extensions/array/conversions_spec.rb

@@ -1,5 +1,10 @@
 require File.join(File.dirname(__FILE__), "/../../../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  field :age, :type => Integer, :default => 100
+end
+
 describe Mongoid::Extensions::Array::Conversions do
 
   describe "#mongoidize" do

data/spec/unit/mongoid/extensions/object/conversions_spec.rb

@@ -1,5 +1,10 @@
 require File.join(File.dirname(__FILE__), "/../../../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  field :age, :type => Integer, :default => 100
+end
+
 describe Mongoid::Extensions::Object::Conversions do
 
   describe "#mongoidize" do

data/spec/unit/mongoid/extensions/object/parentization_spec.rb

@@ -1,5 +1,17 @@
 require File.join(File.dirname(__FILE__), "/../../../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  field :title
+  has_one :name
+end
+
+class Name < Mongoid::Document
+  field :first_name
+  field :last_name
+  key :first_name, :last_name
+  belongs_to :person
+end
+
 describe Mongoid::Extensions::Object::Parentization do
 
   describe "#parentize" do

data/spec/unit/mongoid/timestamps_spec.rb

@@ -1,5 +1,9 @@
 require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
 
+class Person < Mongoid::Document
+  include Mongoid::Timestamps
+end
+
 describe Mongoid::Timestamps do
 
   describe "#included" do
@@ -15,7 +19,7 @@ describe Mongoid::Timestamps do
     end
 
     it "forces the timestamps to UTC" do
-      @person.run_callbacks(:before_create)
+      @person.run_callbacks(:before_save)
       @person.created_at.should be_close(Time.now.utc, 10.seconds)
       @person.modified_at.should be_close(Time.now.utc, 10.seconds)
     end

data/spec/unit/mongoid/versioning_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "/../../spec_helper.rb")
+
+class Post < Mongoid::Document
+  include Mongoid::Versioning
+  field :title
+end
+
+describe Mongoid::Versioning do
+
+  describe "#version" do
+
+    before do
+      @post = Post.new
+    end
+
+    it "defaults to 1" do
+      @post.version.should == 1
+    end
+
+    context "when document is saved" do
+
+      before do
+        @post.title = "New"
+        @version = Post.new(:title => "Test")
+        Post.expects(:find).at_least(1).with(@post.id).returns(@version)
+        @post.revise
+      end
+
+      it "increments the version" do
+        @post.version.should == 2
+      end
+
+      it "adds a snapshot of the document to the versions" do
+        @post.title.should == "New"
+        @post.version.should == 2
+        @post.versions.size.should == 1
+        version = @post.versions.first
+        version.title.should == "Test"
+        version.version.should == 1
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-31 00:00:00 -04:00
+date: 2009-11-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,6 +112,7 @@ files:
 - lib/mongoid/extensions/time/conversions.rb
 - lib/mongoid/field.rb
 - lib/mongoid/timestamps.rb
+- lib/mongoid/versioning.rb
 - mongoid.gemspec
 - spec/integration/mongoid/document_spec.rb
 - spec/spec.opts
@@ -148,6 +149,7 @@ files:
 - spec/unit/mongoid/extensions/time/conversions_spec.rb
 - spec/unit/mongoid/field_spec.rb
 - spec/unit/mongoid/timestamps_spec.rb
+- spec/unit/mongoid/versioning_spec.rb
 has_rdoc: true
 homepage: http://github.com/durran/mongoid
 licenses: []
@@ -211,3 +213,4 @@ test_files:
 - spec/unit/mongoid/extensions/time/conversions_spec.rb
 - spec/unit/mongoid/field_spec.rb
 - spec/unit/mongoid/timestamps_spec.rb
+- spec/unit/mongoid/versioning_spec.rb