mongoid 0.4.0 → 0.4.1

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/mongoid.rb

@@ -34,28 +34,28 @@ require "mongo"
 require "mongoid/associations"
 require "mongoid/criteria"
 require "mongoid/extensions"
+require "mongoid/commands"
 require "mongoid/document"
 
 module Mongoid
 
-  # Thrown when the database connection has not been set up.
-  class NoConnectionError < RuntimeError
-  end
+  # Raised when the database connection has not been set up.
+  class NoConnectionError < RuntimeError; end
 
-  # Thrown when :document_class is not provided in the attributes
+  # Raised when :document_class is not provided in the attributes
   # hash when creating a new Document
-  class ClassNotProvidedError < RuntimeError
-  end
+  class ClassNotProvidedError < RuntimeError; end
 
-  # Thrown when an association is defined on the class, but the
+  # Raised when an association is defined on the class, but the
   # attribute in the hash is not an Array or Hash.
-  class TypeMismatchError < RuntimeError
-  end
+  class TypeMismatchError < RuntimeError; end
 
-  # Thrown when an association is defined that is not valid. Must
+  # Raised when an association is defined that is not valid. Must
   # be belongs_to, has_many, has_one
-  class InvalidAssociationError < RuntimeError
-  end
+  class InvalidAssociationError < RuntimeError; end
+
+  # Raised when a persisence method ending in ! fails validation.
+  class ValidationsError < RuntimeError; end
 
   # Connect to the database name supplied. This should be run
   # for initial setup, potentially in a rails initializer.

data/lib/mongoid/commands.rb

@@ -0,0 +1,105 @@
+require "mongoid/commands/create"
+require "mongoid/commands/delete"
+require "mongoid/commands/delete_all"
+require "mongoid/commands/destroy"
+require "mongoid/commands/destroy_all"
+require "mongoid/commands/save"
+
+module Mongoid #:nodoc:
+
+  # This module is included in the +Document+ to provide all the persistence
+  # methods required on the +Document+ object and class. The following methods
+  # are provided:
+  #
+  # <tt>create</tt>,
+  # <tt>create!</tt>,
+  # <tt>delete</tt>,
+  # <tt>delete_all</tt>,
+  # <tt>destroy</tt>,
+  # <tt>destroy_all</tt>,
+  # <tt>save</tt>,
+  # <tt>save!</tt>,
+  # <tt>update_attributes</tt>,
+  # <tt>update_attributes!</tt>
+  #
+  # These methods will delegate to their respective commands.
+  module Commands
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+      end
+    end
+
+    module InstanceMethods
+
+      # Delete the +Document+ from the database. Delegates to the Delete
+      # command.
+      def delete
+        Delete.execute(self)
+      end
+
+      # Destroy the +Document+. Delegates to the Destroy command.
+      def destroy
+        Destroy.execute(self)
+      end
+
+      # Save the +Document+. Delegates to the Save command.
+      def save
+        Save.execute(self)
+      end
+
+      # Save the +Document+. Delegates to the Save command. If the command
+      # returns false then a +ValidationError+ will be raised.
+      def save!
+        Save.execute(self) || (raise ValidationsError)
+      end
+
+      # Update the attributes of the +Document+. Will call save after the
+      # attributes have been updated.
+      def update_attributes(attributes = {})
+        self.attributes = attributes; save
+      end
+
+      # Update the attributes of the +Document+. Will call save! after the
+      # attributes have been updated, causing a +ValidationError+ if the
+      # +Document+ failed validation.
+      def update_attributes!(attribtues = {})
+        self.attributes = attributes; save!
+      end
+
+    end
+
+    module ClassMethods
+
+      # Create a new +Document+ with the supplied attributes. Will delegate to
+      # the Create command.
+      def create(attributes = {})
+        Create.execute(new(attributes))
+      end
+
+      # Create a new +Document+ with the supplied attributes. Will delegate to
+      # the Create command or raise +ValidationError+ if the save failed
+      # validation.
+      def create!(attributes = {})
+        document = Create.execute(new(attributes))
+        raise ValidationsError unless document.errors.empty?
+        return document
+      end
+
+      # Delete all the +Documents+ in the database given the supplied
+      # conditions.
+      def delete_all(conditions = {})
+        DeleteAll.execute(self, conditions)
+      end
+
+      # Destroy all the +Documents+ in the database given the supplied
+      # conditions.
+      def destroy_all(conditions = {})
+        DestroyAll.execute(self, conditions)
+      end
+
+    end
+
+  end
+end

data/lib/mongoid/commands/create.rb

@@ -0,0 +1,20 @@
+module Mongoid #:nodoc:
+  module Commands
+    class Create #:nodoc:
+      # Performs a create of the supplied Document, with the necessary
+      # callbacks. It then delegates to the Save command.
+      #
+      # Options:
+      #
+      # doc: A new +Document+ that is going to be persisted.
+      #
+      # Returns: +Document+.
+      def self.execute(doc)
+        doc.run_callbacks :before_create
+        Save.execute(doc)
+        doc.run_callbacks :after_create
+        return doc
+      end
+    end
+  end
+end

data/lib/mongoid/commands/delete.rb

@@ -0,0 +1,14 @@
+module Mongoid #:nodoc:
+  module Commands
+    class Delete #:nodoc:
+      # Performs a delete of the supplied +Document+ without any callbacks.
+      #
+      # Options:
+      #
+      # doc: A new +Document+ that is going to be deleted.
+      def self.execute(doc)
+        doc.collection.remove(:_id => doc.id)
+      end
+    end
+  end
+end

data/lib/mongoid/commands/delete_all.rb

@@ -0,0 +1,20 @@
+module Mongoid #:nodoc:
+  module Commands
+    class DeleteAll #:nodoc:
+      # Performs a delete of the all the +Documents+ that match the criteria
+      # supplied.
+      #
+      # Options:
+      #
+      # params: A set of conditions to find the +Documents+ by.
+      # klass: The class of the +Document+ to execute the find on.
+      #
+      # Example:
+      #
+      # <tt>DeleteAll.execute(Person, :conditions => { :field => "value" })</tt>
+      def self.execute(klass, params)
+        klass.find(:all, params).each { |doc| Delete.execute(doc) }
+      end
+    end
+  end
+end

data/lib/mongoid/commands/destroy.rb

@@ -0,0 +1,17 @@
+module Mongoid #:nodoc:
+  module Commands
+    class Destroy #:nodoc:
+      # Performs a destroy of the supplied +Document+, with the necessary
+      # callbacks. It then deletes the record from the collection.
+      #
+      # Options:
+      #
+      # doc: A new +Document+ that is going to be destroyed.
+      def self.execute(doc)
+        doc.run_callbacks :before_destroy
+        doc.collection.remove(:_id => doc.id)
+        doc.run_callbacks :after_destroy
+      end
+    end
+  end
+end

data/lib/mongoid/commands/destroy_all.rb

@@ -0,0 +1,20 @@
+module Mongoid #:nodoc:
+  module Commands
+    class DestroyAll #:nodoc:
+      # Performs a destroy of the all the +Documents+ that match the criteria
+      # supplied. Will execute all the destroy callbacks for each +Document+.
+      #
+      # Options:
+      #
+      # params: A set of conditions to find the +Documents+ by.
+      # klass: The class of the +Document+ to execute the find on.
+      #
+      # Example:
+      #
+      # <tt>DestroyAll.execute(Person, :conditions => { :field => "value" })</tt>
+      def self.execute(klass, params)
+        klass.find(:all, params).each { |doc| Destroy.execute(doc) }
+      end
+    end
+  end
+end

data/lib/mongoid/commands/save.rb

@@ -0,0 +1,22 @@
+module Mongoid #:nodoc:
+  module Commands
+    class Save #:nodoc:
+      # Performs a save of the supplied +Document+, handling all associated
+      # callbacks and validation.
+      #
+      # Options:
+      #
+      # doc: A +Document+ that is going to be persisted.
+      #
+      # Returns: +Document+ if validation passes, +false+ if not.
+      def self.execute(doc)
+        return false unless doc.valid?
+        doc.run_callbacks :before_save
+        parent = doc.parent
+        parent ? Save.execute(parent) : doc.collection.save(doc.attributes)
+        doc.run_callbacks :after_save
+        return doc
+      end
+    end
+  end
+end

data/lib/mongoid/document.rb

@@ -2,16 +2,19 @@ module Mongoid #:nodoc:
   class Document #:nodoc:
     include ActiveSupport::Callbacks
     include Validatable
+    include Commands
 
     AGGREGATE_REDUCE = "function(obj, prev) { prev.count++; }"
     GROUP_BY_REDUCE = "function(obj, prev) { prev.group.push(obj); }"
 
-    attr_reader :attributes, :parent
+    attr_accessor :attributes, :parent
 
     define_callbacks \
       :after_create,
+      :after_destroy,
       :after_save,
       :before_create,
+      :before_destroy,
       :before_save
 
     class << self
@@ -33,17 +36,6 @@ module Mongoid #:nodoc:
         @collection ||= Mongoid.database.collection(@collection_name)
       end
 
-      # Create a new Document with the supplied attribtues, and insert it into the database.
-      def create(attributes = {})
-        new(attributes).save(true)
-      end
-
-      # Deletes all records from the collection. Will actually call drop on the
-      # Mongo::Collection for efficiency.
-      def destroy_all
-        collection.drop
-      end
-
       # Defines all the fields that are accessable on the Document
       # For each field that is defined, a getter and setter will be
       # added as an instance method to the Document.
@@ -135,11 +127,6 @@ module Mongoid #:nodoc:
       self.class.collection
     end
 
-    # Delete this Document from the database.
-    def destroy
-      collection.remove(:_id => id)
-    end
-
     # Get the Mongo::ObjectID associated with this object.
     # This is in essence the primary key.
     def id
@@ -158,39 +145,11 @@ module Mongoid #:nodoc:
       @attributes[:_id].nil?
     end
 
-    # Set the parent to this document.
-    def parent=(document)
-      @parent = document
-    end
-
-    # Save this document to the database. If this document is the root document
-    # in the object graph, it will save itself, and return self. If the
-    # document is embedded within another document, or is multiple levels down
-    # the tree, the root object will get saved, and return itself.
-    def save(creating = false)
-      if @parent
-        @parent.save
-      else
-        return false unless valid?
-        run_callbacks(:before_create) if creating
-        run_callbacks(:before_save)
-        collection.save(@attributes)
-        run_callbacks(:after_create) if creating
-        run_callbacks(:after_save)
-        creating ? self : true
-      end
-    end
-
     # Returns the id of the Document
     def to_param
       id.to_s
     end
 
-    # Update the attributes of this Document and return true
-    def update_attributes(attributes)
-      @attributes = attributes.symbolize_keys!; save; true
-    end
-
     private
 
     class << self

data/mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Durran Jordan"]
-  s.date = %q{2009-10-10}
+  s.date = %q{2009-10-11}
   s.email = %q{durran@gmail.com}
   s.extra_rdoc_files = [
     "README.textile"
@@ -28,6 +28,13 @@ Gem::Specification.new do |s|
      "lib/mongoid/associations/factory.rb",
      "lib/mongoid/associations/has_many_association.rb",
      "lib/mongoid/associations/has_one_association.rb",
+     "lib/mongoid/commands.rb",
+     "lib/mongoid/commands/create.rb",
+     "lib/mongoid/commands/delete.rb",
+     "lib/mongoid/commands/delete_all.rb",
+     "lib/mongoid/commands/destroy.rb",
+     "lib/mongoid/commands/destroy_all.rb",
+     "lib/mongoid/commands/save.rb",
      "lib/mongoid/criteria.rb",
      "lib/mongoid/document.rb",
      "lib/mongoid/extensions.rb",
@@ -42,6 +49,12 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/associations/factory_spec.rb",
      "spec/unit/mongoid/associations/has_many_association_spec.rb",
      "spec/unit/mongoid/associations/has_one_association_spec.rb",
+     "spec/unit/mongoid/commands/create_spec.rb",
+     "spec/unit/mongoid/commands/delete_all_spec.rb",
+     "spec/unit/mongoid/commands/delete_spec.rb",
+     "spec/unit/mongoid/commands/destroy_all_spec.rb",
+     "spec/unit/mongoid/commands/destroy_spec.rb",
+     "spec/unit/mongoid/commands/save_spec.rb",
      "spec/unit/mongoid/criteria_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",
@@ -60,6 +73,12 @@ Gem::Specification.new do |s|
      "spec/unit/mongoid/associations/factory_spec.rb",
      "spec/unit/mongoid/associations/has_many_association_spec.rb",
      "spec/unit/mongoid/associations/has_one_association_spec.rb",
+     "spec/unit/mongoid/commands/create_spec.rb",
+     "spec/unit/mongoid/commands/delete_all_spec.rb",
+     "spec/unit/mongoid/commands/delete_spec.rb",
+     "spec/unit/mongoid/commands/destroy_all_spec.rb",
+     "spec/unit/mongoid/commands/destroy_spec.rb",
+     "spec/unit/mongoid/commands/save_spec.rb",
      "spec/unit/mongoid/criteria_spec.rb",
      "spec/unit/mongoid/document_spec.rb",
      "spec/unit/mongoid/extensions/array/conversions_spec.rb",

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ Mongoid.connect_to("mongoid_test")
 
 Spec::Runner.configure do |config|
   config.mock_with :mocha
+  Mocha::Configuration.prevent(:stubbing_non_existent_method)
 end
 
 class Person < Mongoid::Document

data/spec/unit/mongoid/commands/create_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
+
+describe Mongoid::Commands::Create do
+
+  describe "#execute" do
+
+    before do
+      @document = stub(:run_callbacks)
+    end
+
+    it "executes a save command" do
+      Mongoid::Commands::Save.expects(:execute).with(@document).returns(@document)
+      Mongoid::Commands::Create.execute(@document)
+    end
+
+    it "runs the before and after create callbacks" do
+      @document.expects(:run_callbacks).with(:before_create)
+      Mongoid::Commands::Save.expects(:execute).with(@document).returns(@document)
+      @document.expects(:run_callbacks).with(:after_create)
+      Mongoid::Commands::Create.execute(@document)
+    end
+
+    it "returns the document" do
+      Mongoid::Commands::Save.expects(:execute).with(@document).returns(@document)
+      Mongoid::Commands::Create.execute(@document).should == @document
+    end
+
+  end
+
+end

data/spec/unit/mongoid/commands/delete_all_spec.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
+
+describe Mongoid::Commands::DeleteAll do
+
+  describe "#execute" do
+
+    before do
+      @doc = mock
+      @docs = [@doc]
+      @klass = mock
+      @conditions = { :conditions => { :title => "Sir" } }
+    end
+
+    it "destroys each document that the criteria finds" do
+      @klass.expects(:find).with(:all, @conditions).returns(@docs)
+      Mongoid::Commands::Delete.expects(:execute).with(@doc)
+      Mongoid::Commands::DeleteAll.execute(@klass, @conditions)
+    end
+
+  end
+
+end

data/spec/unit/mongoid/commands/delete_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
+
+describe Mongoid::Commands::Delete do
+
+  describe "#execute" do
+
+    before do
+      @collection = mock
+      @document = stub(:collection => @collection, :id => "1")
+    end
+
+    it "removes the document from its collection" do
+      @collection.expects(:remove).with({ :_id => @document.id })
+      Mongoid::Commands::Delete.execute(@document)
+    end
+
+  end
+
+end

data/spec/unit/mongoid/commands/destroy_all_spec.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
+
+describe Mongoid::Commands::DestroyAll do
+
+  describe "#execute" do
+
+    before do
+      @doc = mock
+      @docs = [@doc]
+      @klass = mock
+      @conditions = { :conditions => { :title => "Sir" } }
+    end
+
+    it "destroys each document that the criteria finds" do
+      @klass.expects(:find).with(:all, @conditions).returns(@docs)
+      Mongoid::Commands::Destroy.expects(:execute).with(@doc)
+      Mongoid::Commands::DestroyAll.execute(@klass, @conditions)
+    end
+
+  end
+
+end

data/spec/unit/mongoid/commands/destroy_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
+
+describe Mongoid::Commands::Destroy do
+
+  describe "#execute" do
+
+    before do
+      @collection = stub_everything
+      @document = stub(:run_callbacks => true,
+                       :collection => @collection,
+                       :id => "1")
+    end
+
+    it "runs the before and after destroy callbacks" do
+      @document.expects(:run_callbacks).with(:before_destroy)
+      @document.expects(:run_callbacks).with(:after_destroy)
+      Mongoid::Commands::Destroy.execute(@document)
+    end
+
+    it "removes the document from its collection" do
+      @collection.expects(:remove).with({ :_id => @document.id })
+      Mongoid::Commands::Destroy.execute(@document)
+    end
+
+  end
+
+end

data/spec/unit/mongoid/commands/save_spec.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), "/../../../spec_helper.rb")
+
+describe Mongoid::Commands::Save do
+
+  describe "#execute" do
+
+    before do
+      @parent_collection = stub(:save)
+      @doc_collection = stub(:save)
+      @parent = stub(:collection => @parent_collection,
+                     :valid? => true,
+                     :run_callbacks => true,
+                     :parent => nil,
+                     :attributes => {})
+      @document = stub(:collection => @doc_collection,
+                       :run_callbacks => true,
+                       :parent => @parent,
+                       :attributes => {})
+    end
+
+    context "when document is valid" do
+
+      before do
+        @document.expects(:valid?).returns(true)
+      end
+
+      it "runs the before and after callbacks" do
+        @document.expects(:run_callbacks).with(:before_save)
+        @document.expects(:run_callbacks).with(:after_save)
+        Mongoid::Commands::Save.execute(@document)
+      end
+
+      it "returns the document" do
+        Mongoid::Commands::Save.execute(@document).should == @document
+      end
+
+      context "when the document has a parent" do
+
+        it "executes a save on the parent" do
+          @parent_collection.expects(:save).with(@parent.attributes)
+          Mongoid::Commands::Save.execute(@document)
+        end
+
+      end
+
+      context "when the document has no parent" do
+
+        before do
+          @document.expects(:parent).returns(nil)
+        end
+
+        it "calls save on the document collection" do
+          @doc_collection.expects(:save).with(@document.attributes)
+          Mongoid::Commands::Save.execute(@document)
+        end
+
+      end
+
+    end
+
+    context "when document is invalid" do
+
+      before do
+        @document.expects(:valid?).returns(false)
+      end
+
+      it "returns false" do
+        Mongoid::Commands::Save.execute(@document).should be_false
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/mongoid/document_spec.rb

@@ -85,8 +85,8 @@ describe Mongoid::Document do
 
       it "returns nil" do
         id = Mongo::ObjectID.new
-        @collection.expects(:remove).with(:_id => id)
         person = Person.new(:_id => id)
+        Mongoid::Commands::Destroy.expects(:execute).with(person)
         person.destroy.should be_nil
       end
 
@@ -97,7 +97,7 @@ describe Mongoid::Document do
   describe "#destroy_all" do
 
     it "deletes all documents from the collection" do
-      @collection.expects(:drop)
+      Mongoid::Commands::DestroyAll.expects(:execute).with(Person, {})
       Person.destroy_all
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongoid
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Durran Jordan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 -04:00
+date: 2009-10-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,13 @@ files:
 - lib/mongoid/associations/factory.rb
 - lib/mongoid/associations/has_many_association.rb
 - lib/mongoid/associations/has_one_association.rb
+- lib/mongoid/commands.rb
+- lib/mongoid/commands/create.rb
+- lib/mongoid/commands/delete.rb
+- lib/mongoid/commands/delete_all.rb
+- lib/mongoid/commands/destroy.rb
+- lib/mongoid/commands/destroy_all.rb
+- lib/mongoid/commands/save.rb
 - lib/mongoid/criteria.rb
 - lib/mongoid/document.rb
 - lib/mongoid/extensions.rb
@@ -88,6 +95,12 @@ files:
 - spec/unit/mongoid/associations/factory_spec.rb
 - spec/unit/mongoid/associations/has_many_association_spec.rb
 - spec/unit/mongoid/associations/has_one_association_spec.rb
+- spec/unit/mongoid/commands/create_spec.rb
+- spec/unit/mongoid/commands/delete_all_spec.rb
+- spec/unit/mongoid/commands/delete_spec.rb
+- spec/unit/mongoid/commands/destroy_all_spec.rb
+- spec/unit/mongoid/commands/destroy_spec.rb
+- spec/unit/mongoid/commands/save_spec.rb
 - spec/unit/mongoid/criteria_spec.rb
 - spec/unit/mongoid/document_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb
@@ -128,6 +141,12 @@ test_files:
 - spec/unit/mongoid/associations/factory_spec.rb
 - spec/unit/mongoid/associations/has_many_association_spec.rb
 - spec/unit/mongoid/associations/has_one_association_spec.rb
+- spec/unit/mongoid/commands/create_spec.rb
+- spec/unit/mongoid/commands/delete_all_spec.rb
+- spec/unit/mongoid/commands/delete_spec.rb
+- spec/unit/mongoid/commands/destroy_all_spec.rb
+- spec/unit/mongoid/commands/destroy_spec.rb
+- spec/unit/mongoid/commands/save_spec.rb
 - spec/unit/mongoid/criteria_spec.rb
 - spec/unit/mongoid/document_spec.rb
 - spec/unit/mongoid/extensions/array/conversions_spec.rb