mongoid 2.0.2 → 2.1.0

data/lib/mongoid/paranoia.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 module Mongoid #:nodoc:
+
   # Include this module to get soft deletion of root level documents.
   # This will add a deleted_at field to the +Document+, managed automatically.
   # Potentially incompatible with unique indices. (if collisions with deleted items)
   #
-  # To use:
-  #
+  # @example Make a document paranoid.
   #   class Person
   #     include Mongoid::Document
   #     include Mongoid::Paranoia
@@ -20,47 +20,44 @@ module Mongoid #:nodoc:
     # Delete the paranoid +Document+ from the database completely. This will
     # run the destroy callbacks.
     #
-    # Example:
-    #
-    # <tt>document.destroy!</tt>
+    # @example Hard destroy the document.
+    #   document.destroy!
     def destroy!
       run_callbacks(:destroy) { delete! }
     end
 
     # Delete the paranoid +Document+ from the database completely.
     #
-    # Example:
-    #
-    # <tt>document.delete!</tt>
+    # @example Hard delete the document.
+    #   document.delete!
     def delete!
       @destroyed = true
-      Mongoid::Persistence::Remove.new(self).persist
+      Persistence::Operations.remove(self).persist
     end
 
     # Delete the +Document+, will set the deleted_at timestamp and not actually
     # delete it.
     #
-    # Example:
+    # @example Soft remove the document.
+    #   document.remove
     #
-    # <tt>document.remove</tt>
+    # @param [ Hash ] options The database options.
     #
-    # Returns:
-    #
-    # true
+    # @return [ true ] True.
     def remove(options = {})
       now = Time.now
       collection.update({ :_id => id }, { '$set' => { :deleted_at => now } })
       @attributes["deleted_at"] = now
       true
     end
-
     alias :delete :remove
 
     # Determines if this document is destroyed.
     #
-    # Returns:
+    # @example Is the document destroyed?
+    #   person.destroyed?
     #
-    # true if the +Document+ was destroyed.
+    # @return [ true, false ] If the document is destroyed.
     def destroyed?
       @destroyed || !!deleted_at
     end
@@ -68,9 +65,8 @@ module Mongoid #:nodoc:
     # Restores a previously soft-deleted document. Handles this by removing the
     # deleted_at flag.
     #
-    # Example:
-    #
-    # <tt>document.restore</tt>
+    # @example Restore the document from deleted state.
+    #   document.restore
     def restore
       collection.update({ :_id => id }, { '$unset' => { :deleted_at => true } })
       @attributes.delete("deleted_at")
@@ -81,20 +77,24 @@ module Mongoid #:nodoc:
       # Override the default +Criteria+ accessor to only get existing
       # documents. Passes all arguments up to +NamedScope.criteria+
       #
-      # Returns:
+      # @example Override the criteria.
+      #   Person.criteria
+      #
+      # @param [ Array ] args The arguments.
       #
-      # A +Criteria+ for deleted_at not existing.
+      # @return [ Criteria ] The paranoid compliant criteria.
       def criteria(*args)
         super.where(:deleted_at.exists => false)
       end
 
       # Find deleted documents
       #
-      # Examples:
+      # @example Find deleted documents.
+      #   Person.deleted
+      #   Company.first.employees.deleted
+      #   Person.deleted.find("4c188dea7b17235a2a000001").first
       #
-      #   <tt>Person.deleted</tt>  # all deleted employees
-      #   <tt>Company.first.employees.deleted</tt>  # works with a join
-      #   <tt>Person.deleted.find("4c188dea7b17235a2a000001").first</tt>
+      # @return [ Criteria ] The deleted criteria.
       def deleted
         where(:deleted_at.exists => true)
       end

data/lib/mongoid/persistence.rb

@@ -1,12 +1,9 @@
 # encoding: utf-8
 require "mongoid/persistence/atomic"
-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"
+require "mongoid/persistence/deletion"
+require "mongoid/persistence/insertion"
+require "mongoid/persistence/modification"
+require "mongoid/persistence/operations"
 
 module Mongoid #:nodoc:
 
@@ -44,7 +41,7 @@ module Mongoid #:nodoc:
     #
     # @return [ Document ] The persisted document.
     def insert(options = {})
-      Insert.new(self, options).persist
+      Operations.insert(self, options).persist
     end
 
     # Remove the document from the datbase.
@@ -56,11 +53,7 @@ module Mongoid #:nodoc:
     #
     # @return [ TrueClass ] True.
     def remove(options = {})
-      if Remove.new(self, options).persist
-        attributes.freeze
-        self.destroyed = true
-        cascade!
-      end; true
+      Operations.remove(self, options).persist
     end
     alias :delete :remove
 
@@ -86,7 +79,7 @@ module Mongoid #:nodoc:
     #
     # @return [ true, false ] True if succeeded, false if not.
     def update(options = {})
-      Update.new(self, options).persist
+      Operations.update(self, options).persist
     end
 
     # Update a single attribute and persist the entire document.
@@ -165,7 +158,7 @@ module Mongoid #:nodoc:
       #
       # @return [ Document ] The newly created document.
       def create(attributes = {}, &block)
-        new(attributes, &block).tap(&:save)
+        new(attributes, &block).tap { |doc| doc.save }
       end
 
       # Create a new document. This will instantiate a new document and
@@ -198,12 +191,13 @@ module Mongoid #:nodoc:
       # @param [ Hash ] conditions Optional conditions to delete by.
       #
       # @return [ Integer ] The number of documents deleted.
-      def delete_all(conditions = {})
-        RemoveAll.new(
-          self,
-          { :validate => false },
-          conditions[:conditions] || {}
-        ).persist
+      def delete_all(conditions = nil)
+        selector = (conditions || {})[:conditions] || {}
+        selector.merge!(:_type => name) if hereditary?
+        collection.find(selector).count.tap do
+          collection.remove(selector, Safety.merge_safety_options)
+          Threaded.clear_safety_options!
+        end
       end
 
       # Delete all documents given the supplied conditions. If no conditions

data/lib/mongoid/persistence/atomic.rb

@@ -1,9 +1,16 @@
 # encoding: utf-8
 require "mongoid/persistence/atomic/operation"
 require "mongoid/persistence/atomic/add_to_set"
+require "mongoid/persistence/atomic/bit"
 require "mongoid/persistence/atomic/inc"
+require "mongoid/persistence/atomic/pop"
+require "mongoid/persistence/atomic/pull"
 require "mongoid/persistence/atomic/pull_all"
 require "mongoid/persistence/atomic/push"
+require "mongoid/persistence/atomic/push_all"
+require "mongoid/persistence/atomic/rename"
+require "mongoid/persistence/atomic/set"
+require "mongoid/persistence/atomic/unset"
 
 module Mongoid #:nodoc:
   module Persistence #:nodoc:
@@ -31,6 +38,29 @@ module Mongoid #:nodoc:
         AddToSet.new(self, field, value, options).persist
       end
 
+      # Performs an atomic $bit operation on the field with the provided hash
+      # of bitwise ops to execute in order.
+      #
+      # @example Execute a bitwise and on the field.
+      #   person.bit(:age, { :and => 12 })
+      #
+      # @example Execute a bitwise or on the field.
+      #   person.bit(:age, { :or => 12 })
+      #
+      # @example Execute a chain of bitwise operations.
+      #   person.bit(:age, { :and => 10, :or => 12 })
+      #
+      # @param [ Symbol ] field The name of the field.
+      # @param [ Hash ] value The bitwise operations to perform.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ Integer ] The new value of the field.
+      #
+      # @since 2.1.0
+      def bit(field, value, options = {})
+        Bit.new(self, field, value, options).persist
+      end
+
       # Performs an atomic $inc of the provided value on the supplied
       # field. If the field does not exist it will be initialized as
       # the provided value.
@@ -49,6 +79,45 @@ module Mongoid #:nodoc:
         Inc.new(self, field, value, options).persist
       end
 
+      # Performs an atomic $pop of the provided value on the supplied
+      # field.
+      #
+      # @example Pop the last value from the array.
+      #   person.pop(:aliases, 1)
+      #
+      # @example Pop the first value from the array.
+      #   person.pop(:aliases, -1)
+      #
+      # @param [ Symbol ] field The name of the field.
+      # @param [ Integer ] value Whether to pop the first or last.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ Array<Object> ] The new value of the field.
+      #
+      # @since 2.1.0
+      def pop(field, value, options = {})
+        Pop.new(self, field, value, options).persist
+      end
+
+      # Performs an atomic $pull of the provided value on the supplied
+      # field.
+      #
+      # @note Support for a $pull with an expression is not yet supported.
+      #
+      # @example Pull the value from the field.
+      #   person.pull(:aliases, "Bond")
+      #
+      # @param [ Symbol ] field The name of the field.
+      # @param [ Object ] value The value to pull.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ Array<Object> ] The new value of the field.
+      #
+      # @since 2.1.0
+      def pull(field, value, options = {})
+        Pull.new(self, field, value, options).persist
+      end
+
       # Performs an atomic $pullAll of the provided value on the supplied
       # field. If the field does not exist it will be initialized as an
       # empty array.
@@ -83,6 +152,72 @@ module Mongoid #:nodoc:
       def push(field, value, options = {})
         Push.new(self, field, value, options).persist
       end
+
+      # Performs an atomic $pushAll of the provided value on the supplied field. If
+      # the field does not exist it will be initialized as an empty array.
+      #
+      # @example Push the values onto the field.
+      #   person.push_all(:aliases, [ "Bond", "James" ])
+      #
+      # @param [ Symbol ] field The name of the field.
+      # @param [ Array<Object> ] value The values to push.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ Array<Object> ] The new value of the field.
+      #
+      # @since 2.1.0
+      def push_all(field, value, options = {})
+        PushAll.new(self, field, value, options).persist
+      end
+
+      # Performs the atomic $rename from the old field to the new field name.
+      #
+      # @example Rename the field.
+      #   person.rename(:age, :years)
+      #
+      # @param [ Symbol ] field The old field name.
+      # @param [ Symbol ] value The new field name.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ Object ] The value of the new field.
+      #
+      # @since 2.1.0
+      def rename(field, value, options = {})
+        Rename.new(self, field, value, options).persist
+      end
+
+      # Performs an atomic $set of the provided value on the supplied
+      # field. If the field does not exist it will be initialized as
+      # the provided value.
+      #
+      # @example Set a field.
+      #   person.set(:score, 2)
+      #
+      # @param [ Symbol ] field The name of the field.
+      # @param [ Integer ] value The value to set.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ Array<Object> ] The new value of the field.
+      #
+      # @since 2.1.0
+      def set(field, value = nil, options = {})
+        Set.new(self, field, value, options).persist
+      end
+
+      # Performs the atomic $unset on the supplied field.
+      #
+      # @example Remove the field.
+      #   person.unset(:age)
+      #
+      # @param [ Symbol ] field The field name.
+      # @param [ Hash ] options The mongo persistence options.
+      #
+      # @return [ nil ] Always nil.
+      #
+      # @since 2.1.0
+      def unset(field, options = {})
+        Unset.new(self, field, 1, options).persist
+      end
     end
   end
 end

data/lib/mongoid/persistence/atomic/add_to_set.rb

@@ -5,7 +5,8 @@ module Mongoid #:nodoc:
 
       # This class provides the ability to perform an explicit $addToSet
       # modification on a specific field.
-      class AddToSet < Operation
+      class AddToSet
+        include Operation
 
         # Sends the atomic $addToSet operation to the database.
         #
@@ -16,13 +17,15 @@ module Mongoid #:nodoc:
         #
         # @since 2.0.0
         def persist
-          document[field] = [] unless document[field]
-          values = document.send(field)
-          values.push(value) unless values.include?(value)
-          values.tap do
-            if document.persisted?
-              document.collection.update(document._selector, operation("$addToSet"), options)
-              document.changes.delete(field.to_s)
+          prepare do
+            document[field] = [] unless document[field]
+            values = document.send(field)
+            values.push(value) unless values.include?(value)
+            values.tap do
+              if document.persisted?
+                collection.update(document.atomic_selector, operation("$addToSet"), options)
+                document.remove_change(field)
+              end
             end
           end
         end

data/lib/mongoid/persistence/atomic/bit.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    module Atomic #:nodoc:
+
+      # This operation is for performing $bit atomic operations against the
+      # database.
+      class Bit
+        include Operation
+
+        # Execute the bitwise operation. This correlates to a $bit in MongoDB.
+        #
+        # @example Execute the op.
+        #   bit.persist
+        #
+        # @return [ Integer ] The new value.
+        #
+        # @since 2.1.0
+        def persist
+          prepare do
+            current = document[field]
+            return nil unless current
+            document[field] = value.inject(current) do |result, (bit, val)|
+              result = result & val if bit.to_s == "and"
+              result = result | val if bit.to_s == "or"
+              result
+            end
+            document[field].tap do
+              collection.update(document.atomic_selector, operation("$bit"), options)
+              document.remove_change(field)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/atomic/inc.rb

@@ -4,7 +4,8 @@ module Mongoid #:nodoc:
     module Atomic #:nodoc:
 
       # This class provides atomic $inc behaviour.
-      class Inc < Operation
+      class Inc
+        include Operation
 
         # Sends the atomic $inc operation to the database.
         #
@@ -15,11 +16,13 @@ module Mongoid #:nodoc:
         #
         # @since 2.0.0
         def persist
-          current = document[field] || 0
-          document[field] = current + value
-          document[field].tap do
-            document.collection.update(document._selector, operation("$inc"), options)
-            document.changes.delete(field.to_s)
+          prepare do
+            current = document[field] || 0
+            document[field] = current + value
+            document[field].tap do
+              collection.update(document.atomic_selector, operation("$inc"), options)
+              document.remove_change(field)
+            end
           end
         end
       end