mongoid-with-auth 1.9.4

data/lib/mongoid/persistence.rb

@@ -0,0 +1,222 @@
+# encoding: utf-8
+require "mongoid/persistence/command"
+require "mongoid/persistence/insert"
+require "mongoid/persistence/insert_embedded"
+require "mongoid/persistence/remove"
+require "mongoid/persistence/remove_all"
+require "mongoid/persistence/remove_embedded"
+require "mongoid/persistence/update"
+
+module Mongoid #:nodoc:
+  # The persistence module is a mixin to provide database accessor methods for
+  # the document. These correspond to the appropriate accessors on a
+  # +Mongo::Collection+ and retain the same DSL.
+  #
+  # Examples:
+  #
+  # <tt>document.insert</tt>
+  # <tt>document.update</tt>
+  # <tt>document.upsert</tt>
+  module Persistence
+    extend ActiveSupport::Concern
+    module InstanceMethods #:nodoc:
+      # Remove the +Document+ from the datbase with callbacks.
+      #
+      # Example:
+      #
+      # <tt>document.destroy</tt>
+      #
+      # TODO: Will get rid of other #destroy once new persistence complete.
+      def destroy
+        run_callbacks(:before_destroy)
+        if _remove
+          self.destroyed = true
+          run_callbacks(:after_destroy)
+        end; true
+      end
+
+      # Insert a new +Document+ into the database. Will return the document
+      # itself whether or not the save was successful.
+      #
+      # Example:
+      #
+      # <tt>document.insert</tt>
+      def insert(validate = true)
+        Insert.new(self, validate).persist
+      end
+
+      # Remove the +Document+ from the datbase.
+      #
+      # Example:
+      #
+      # <tt>document._remove</tt>
+      #
+      # TODO: Will get rid of other #remove once observable pattern killed.
+      def _remove
+        Remove.new(self).persist
+      end
+
+      alias :delete :_remove
+
+      # Save the document - will perform an insert if the document is new, and
+      # update if not. If a validation error occurs a
+      # Mongoid::Errors::Validations error will get raised.
+      #
+      # Example:
+      #
+      # <tt>document.save!</tt>
+      #
+      # Returns:
+      #
+      # +true+ if validation passed, will raise error otherwise.
+      def save!
+        self.class.fail_validate!(self) unless upsert; true
+      end
+
+      # Update the +Document+ in the datbase.
+      #
+      # Example:
+      #
+      # <tt>document.update</tt>
+      def update(validate = true)
+        Update.new(self, validate).persist
+      end
+
+      # Update the +Document+ attributes in the datbase.
+      #
+      # Example:
+      #
+      # <tt>document.update_attributes(:title => "Sir")</tt>
+      #
+      # Returns:
+      #
+      # +true+ if validation passed, +false+ if not.
+      def update_attributes(attributes = {})
+        write_attributes(attributes); update
+      end
+
+      # Update the +Document+ attributes in the datbase.
+      #
+      # Example:
+      #
+      # <tt>document.update_attributes(:title => "Sir")</tt>
+      #
+      # Returns:
+      #
+      # +true+ if validation passed, raises an error if not
+      def update_attributes!(attributes = {})
+        write_attributes(attributes)
+        result = update
+        self.class.fail_validate!(self) unless result
+        result
+      end
+
+      # Upsert the document - will perform an insert if the document is new, and
+      # update if not.
+      #
+      # Example:
+      #
+      # <tt>document.upsert</tt>
+      #
+      # Returns:
+      #
+      # A +Boolean+ for updates.
+      def upsert(validate = true)
+        validate = parse_validate(validate)
+        if new_record?
+          insert(validate).errors.any? ? false : true
+        else
+          update(validate)
+        end
+      end
+
+      # Save is aliased so that users familiar with active record can have some
+      # semblance of a familiar API.
+      #
+      # Example:
+      #
+      # <tt>document.save</tt>
+      alias :save :upsert
+
+      protected
+      # Alternative validation params.
+      def parse_validate(validate)
+        if validate.is_a?(Hash) && validate.has_key?(:validate)
+          validate = validate[:validate]
+        end
+        validate
+      end
+    end
+
+    module ClassMethods #:nodoc:
+
+      # Create a new +Document+. This will instantiate a new document and
+      # insert it in a single call. Will always return the document
+      # whether save passed or not.
+      #
+      # Example:
+      #
+      # <tt>Person.create(:title => "Mr")</tt>
+      #
+      # Returns: the +Document+.
+      def create(attributes = {})
+        document = new(attributes); document.insert
+      end
+
+      # Create a new +Document+. This will instantiate a new document and
+      # insert it in a single call. Will always return the document
+      # whether save passed or not, and if validation fails an error will be
+      # raise.
+      #
+      # Example:
+      #
+      # <tt>Person.create!(:title => "Mr")</tt>
+      #
+      # Returns: the +Document+.
+      def create!(attributes = {})
+        document = new(attributes)
+        fail_validate!(document) if document.insert.errors.any?
+        document
+      end
+
+      # Delete all documents given the supplied conditions. If no conditions
+      # are passed, the entire collection will be dropped for performance
+      # benefits. Does not fire any callbacks.
+      #
+      # Example:
+      #
+      # <tt>Person.delete_all(:conditions => { :title => "Sir" })</tt>
+      # <tt>Person.delete_all</tt>
+      #
+      # Returns: true or raises an error.
+      def delete_all(conditions = {})
+        RemoveAll.new(
+          self,
+          false,
+          conditions[:conditions] || {}
+        ).persist
+      end
+
+      # Delete all documents given the supplied conditions. If no conditions
+      # are passed, the entire collection will be dropped for performance
+      # benefits. Fires the destroy callbacks if conditions were passed.
+      #
+      # Example:
+      #
+      # <tt>Person.destroy_all(:conditions => { :title => "Sir" })</tt>
+      # <tt>Person.destroy_all</tt>
+      #
+      # Returns: true or raises an error.
+      def destroy_all(conditions = {})
+        documents = all(conditions)
+        count = documents.count
+        documents.each { |doc| doc.destroy }; count
+      end
+
+      # Raise an error if validation failed.
+      def fail_validate!(document)
+        raise Errors::Validations.new(document.errors)
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/command.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Persistence commands extend from this class to get basic functionality on
+    # initialization.
+    class Command
+      attr_reader \
+        :collection,
+        :document,
+        :klass,
+        :options,
+        :selector,
+        :validate
+
+      # Initialize the persistence +Command+.
+      #
+      # Options:
+      #
+      # document_or_class: The +Document+ or +Class+ to get the collection.
+      # validate: Is the document to be validated.
+      # selector: Optional selector to use in query.
+      #
+      # Example:
+      #
+      # <tt>DeleteAll.new(Person, false, {})</tt>
+      def initialize(document_or_class, validate = true, selector = {})
+        if document_or_class.is_a?(Mongoid::Document)
+          @document = document_or_class
+          @collection = @document.embedded? ? @document._root.collection : @document.collection
+        else
+          @klass = document_or_class
+          @collection = @klass.collection
+        end
+        @selector, @validate = selector, validate
+        @options = { :safe => Mongoid.persist_in_safe_mode }
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/insert.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Insert is a persistence command responsible for taking a document that
+    # has not been saved to the database and saving it.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.insert(
+    #     { "_id" : 1, "field" : "value" },
+    #     false
+    #   );
+    class Insert < Command
+      # Insert the new document in the database. This delegates to the standard
+      # MongoDB collection's insert command.
+      #
+      # Example:
+      #
+      # <tt>Insert.persist</tt>
+      #
+      # Returns:
+      #
+      # The +Document+, whether the insert succeeded or not.
+      def persist
+        return @document if @validate && !@document.valid?
+        @document.run_callbacks(:before_create)
+        @document.run_callbacks(:before_save)
+        if insert
+          @document.new_record = false
+          # TODO: All child document new_record flags must get set to false
+          # here or somewhere - this will cause problems.
+          @document.move_changes
+          @document.run_callbacks(:after_create)
+          @document.run_callbacks(:after_save)
+        end
+        @document
+      end
+
+      protected
+      # Insert the document into the database.
+      def insert
+        if @document.embedded?
+          Persistence::InsertEmbedded.new(@document, @validate).persist
+        else
+          @collection.insert(@document.raw_attributes, @options)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/insert_embedded.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Insert is a persistence command responsible for taking a document that
+    # has not been saved to the database and saving it. This specific class
+    # handles the case when the document is embedded in another.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.insert(
+    #     { "_id" : 1, "field" : "value" },
+    #     false
+    #   );
+    class InsertEmbedded < Command
+      # Insert the new document in the database. If the document's parent is a
+      # new record, we will call save on the parent, otherwise we will $push
+      # the document onto the parent.
+      #
+      # Example:
+      #
+      # <tt>Insert.persist</tt>
+      #
+      # Returns:
+      #
+      # The +Document+, whether the insert succeeded or not.
+      def persist
+        parent = @document._parent
+        if parent.new_record?
+          parent.insert
+        else
+          update = { @document._inserter => { @document._position => @document.raw_attributes } }
+          @collection.update(parent._selector, update, @options.merge(:multi => false))
+        end
+        @document.new_record = false; @document
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/remove.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Remove is a persistence command responsible for deleting a document from
+    # the database.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.remove(
+    #     { "_id" : 1 },
+    #     false
+    #   );
+    class Remove < Command
+      # Remove the document from the database: delegates to the MongoDB
+      # collection remove method.
+      #
+      # Example:
+      #
+      # <tt>Remove.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ if success, +false+ if not.
+      def persist
+        remove
+      end
+
+      protected
+      # Remove the document from the database.
+      def remove
+        if @document.embedded?
+          Persistence::RemoveEmbedded.new(@document, @validate).persist
+        else
+          @collection.remove({ :_id => @document.id }, @options)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/remove_all.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Remove is a persistence command responsible for deleting a document from
+    # the database.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.remove(
+    #     { "field" : value },
+    #     false
+    #   );
+    class RemoveAll < Command
+      # Remove the document from the database: delegates to the MongoDB
+      # collection remove method.
+      #
+      # Example:
+      #
+      # <tt>Remove.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ if success, +false+ if not.
+      def persist
+        remove
+      end
+
+      protected
+      # Remove the document from the database.
+      def remove
+        count = @collection.find(@selector.merge(:_type => @klass.name)).count
+        @collection.remove(@selector, @options)
+        count
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/remove_embedded.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Remove is a persistence command responsible for deleting a document from
+    # the database.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.remove(
+    #     { "_id" : 1 },
+    #     false
+    #   );
+    class RemoveEmbedded < Command
+      # Insert the new document in the database. If the document's parent is a
+      # new record, we will call save on the parent, otherwise we will $push
+      # the document onto the parent.
+      #
+      # Remove the document from the database. If the parent is a new record,
+      # it will get removed in Ruby only. If the parent is not a new record
+      # then either an $unset or $set will occur, depending if it's an
+      # embeds_one or embeds_many.
+      #
+      # Example:
+      #
+      # <tt>RemoveEmbedded.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ or +false+, depending on if the removal passed.
+      def persist
+        parent = @document._parent
+        parent.remove(@document)
+        unless parent.new_record?
+          update = { @document._remover => removal_selector }
+          @collection.update(parent._selector, update, @options.merge(:multi => false))
+        end; true
+      end
+
+      protected
+      # Get the value to pass to the removal modifier.
+      def setter
+        @document._index ? @document.id : true
+      end
+
+      def removal_selector
+        @document._index ? { @document._pull => { "_id" => @document.id } } : { @document._path => setter }
+      end
+    end
+  end
+end