mongoid 2.3.1 → 2.3.2

data/lib/mongoid/relations/proxy.rb

@@ -5,6 +5,7 @@ module Mongoid # :nodoc:
     # This class is the superclass for all relation proxy objects, and contains
     # common behaviour for all of them.
     class Proxy
+      include Threaded::Lifecycle
 
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
@@ -50,54 +51,6 @@ module Mongoid # :nodoc:
 
       protected
 
-      # Is the current thread in assigning mode?
-      #
-      # @example Is the current thread in assigning mode?
-      #   proxy._assigning?
-      #
-      # @return [ true, false ] If the thread is assigning.
-      #
-      # @since 2.1.0
-      def _assigning?
-        Threaded.assigning?
-      end
-
-      # Is the current thread in binding mode?
-      #
-      # @example Is the current thread in binding mode?
-      #   proxy.binding?
-      #
-      # @return [ true, false ] If the thread is binding.
-      #
-      # @since 2.1.0
-      def binding?
-        Threaded.binding?
-      end
-
-      # Is the current thread in building mode?
-      #
-      # @example Is the current thread in building mode?
-      #   proxy._building?
-      #
-      # @return [ true, false ] If the thread is building.
-      #
-      # @since 2.1.0
-      def _building?
-        Threaded.building?
-      end
-
-      # Is the current thread in creating mode?
-      #
-      # @example Is the current thread in creating mode?
-      #   proxy.creating?
-      #
-      # @return [ true, false ] If the thread is creating.
-      #
-      # @since 2.1.0
-      def creating?
-        Threaded.creating?
-      end
-
       # Get the collection from the root of the hierarchy.
       #
       # @example Get the collection.

data/lib/mongoid/relations/referenced/in.rb

@@ -71,7 +71,7 @@ module Mongoid # :nodoc:
         #
         # @since 2.1.0
         def persistable?
-          target.persisted? && !binding? && !_building?
+          target.persisted? && !_binding? && !_building?
         end
 
         class << self
@@ -82,6 +82,7 @@ module Mongoid # :nodoc:
           # @example Get the builder.
           #   Referenced::In.builder(meta, object)
           #
+          # @param [ Document ] base The base document.
           # @param [ Metadata ] meta The metadata of the relation.
           # @param [ Document, Hash ] object A document or attributes to build
           #   with.
@@ -89,8 +90,8 @@ module Mongoid # :nodoc:
           # @return [ Builder ] A new builder object.
           #
           # @since 2.0.0.rc.1
-          def builder(meta, object, loading = false)
-            Builders::Referenced::In.new(meta, object, loading)
+          def builder(base, meta, object)
+            Builders::Referenced::In.new(base, meta, object)
           end
 
           # Get the standard criteria used for querying this relation.

data/lib/mongoid/relations/referenced/many.rb

@@ -408,7 +408,7 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def persistable?
-          base.persisted? && !binding? && !_building?
+          _creating? || base.persisted? && !_binding? && !_building?
         end
 
         # Deletes all related documents from the database given the supplied
@@ -445,6 +445,7 @@ module Mongoid #:nodoc:
           # @example Get the builder.
           #   Referenced::Many.builder(meta, object)
           #
+          # @param [ Document ] base The base document.
           # @param [ Metadata ] meta The metadata of the relation.
           # @param [ Document, Hash ] object A document or attributes to build
           #   with.
@@ -452,8 +453,8 @@ module Mongoid #:nodoc:
           # @return [ Builder ] A new builder object.
           #
           # @since 2.0.0.rc.1
-          def builder(meta, object, loading = false)
-            Builders::Referenced::Many.new(meta, object || [], loading)
+          def builder(base, meta, object)
+            Builders::Referenced::Many.new(base, meta, object || [])
           end
 
           # Get the standard criteria used for querying this relation.

data/lib/mongoid/relations/referenced/many_to_many.rb

@@ -30,7 +30,7 @@ module Mongoid # :nodoc:
               args.flatten.each do |doc|
                 next unless doc
                 append(doc)
-                if persistable? || creating?
+                if persistable? || _creating?
                   ids.push(doc.id)
                   doc.save
                 else
@@ -38,7 +38,7 @@ module Mongoid # :nodoc:
                   base.synced[metadata.foreign_key] = false
                 end
               end
-              if persistable? || creating?
+              if persistable? || _creating?
                 base.push_all(metadata.foreign_key, ids)
                 base.synced[metadata.foreign_key] = false
               end
@@ -216,6 +216,7 @@ module Mongoid # :nodoc:
           # @example Get the builder.
           #   Referenced::ManyToMany.builder(meta, object)
           #
+          # @param [ Document ] base The base document.
           # @param [ Metadata ] meta The metadata of the relation.
           # @param [ Document, Hash ] object A document or attributes to build
           #   with.
@@ -223,8 +224,8 @@ module Mongoid # :nodoc:
           # @return [ Builder ] A new builder object.
           #
           # @since 2.0.0.rc.1
-          def builder(meta, object, loading = false)
-            Builders::Referenced::ManyToMany.new(meta, object, loading)
+          def builder(base, meta, object)
+            Builders::Referenced::ManyToMany.new(base, meta, object)
           end
 
           # Create the standard criteria for this relation given the supplied

data/lib/mongoid/relations/referenced/one.rb

@@ -82,7 +82,7 @@ module Mongoid # :nodoc:
         #
         # @since 2.1.0
         def persistable?
-          base.persisted? && !binding? && !_building?
+          base.persisted? && !_binding? && !_building?
         end
 
         class << self
@@ -93,6 +93,7 @@ module Mongoid # :nodoc:
           # @example Get the builder.
           #   Referenced::One.builder(meta, object)
           #
+          # @param [ Document ] base The base document.
           # @param [ Metadata ] meta The metadata of the relation.
           # @param [ Document, Hash ] object A document or attributes to build
           #   with.
@@ -100,8 +101,8 @@ module Mongoid # :nodoc:
           # @return [ Builder ] A new builder object.
           #
           # @since 2.0.0.rc.1
-          def builder(meta, object, loading = false)
-            Builders::Referenced::One.new(meta, object, loading)
+          def builder(base, meta, object)
+            Builders::Referenced::One.new(base, meta, object)
           end
 
           # Get the standard criteria used for querying this relation.

data/lib/mongoid/reloading.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  # This module handles reloading behaviour of documents.
+  module Reloading
+
+    # Reloads the +Document+ attributes from the database. If the document has
+    # not been saved then an error will get raised if the configuration option
+    # was set. This can reload root documents or embedded documents.
+    #
+    # @example Reload the document.
+    #   person.reload
+    #
+    # @raise [ Errors::DocumentNotFound ] If the document was deleted.
+    #
+    # @return [ Document ] The document, reloaded.
+    #
+    # @since 1.0.0
+    def reload
+      _reload.tap do |reloaded|
+        if Mongoid.raise_not_found_error && reloaded.empty?
+          raise Errors::DocumentNotFound.new(self.class, id)
+        end
+        @attributes = reloaded
+      end
+      tap do |doc|
+        doc.changed_attributes.clear
+        doc.apply_defaults
+        doc.reload_relations
+        doc.run_callbacks(:initialize)
+      end
+    end
+
+    private
+
+    # Reload the document, determining if it's embedded or not and what
+    # behaviour to use.
+    #
+    # @example Reload the document.
+    #   document._reload
+    #
+    # @return [ Hash ] The reloaded attributes.
+    #
+    # @since 2.3.2
+    def _reload
+      embedded? ? reload_embedded_document : reload_root_document
+    end
+
+    # Reload the root document.
+    #
+    # @example Reload the document.
+    #   document.reload_root_document
+    #
+    # @return [ Hash ] The reloaded attributes.
+    #
+    # @since 2.3.2
+    def reload_root_document
+      {}.merge(collection.find_one(id) || {})
+    end
+
+    # Reload the embedded document.
+    #
+    # @example Reload the document.
+    #   document.reload_embedded_document
+    #
+    # @return [ Hash ] The reloaded attributes.
+    #
+    # @since 2.3.2
+    def reload_embedded_document
+      extract_embedded_attributes({}.merge(
+        _root.collection.find_one(_root.id)
+      ))
+    end
+
+    # Extract only the desired embedded document from the attributes.
+    #
+    # @example Extract the embedded document.
+    #   document.extract_embedded_attributes(attributes)
+    #
+    # @param [ Hash ] attributes The document in the db.
+    #
+    # @return [ Hash ] The document's extracted attributes.
+    #
+    # @since 2.3.2
+    def extract_embedded_attributes(attributes)
+      atomic_position.split(".").inject(attributes) do |attrs, part|
+        attrs = attrs[part =~ /\d/ ? part.to_i : part]
+        attrs
+      end
+    end
+  end
+end

data/lib/mongoid/state.rb

@@ -5,6 +5,8 @@ module Mongoid #:nodoc:
   # document can transition through.
   module State
 
+    attr_writer :destroyed, :flagged_for_destroy, :new_record
+
     # Returns true if the +Document+ has not been persisted to the database,
     # false if it has. This is determined by the variable @new_record
     # and NOT if the object has an id.
@@ -18,18 +20,6 @@ module Mongoid #:nodoc:
     end
     alias :new? :new_record?
 
-    # Sets the new_record boolean - used after document is saved.
-    #
-    # @example Set whether the document is new.
-    #   person.new_record = true
-    #
-    # @param [ true, false ] saved The value to set for new_record.
-    #
-    # @return [ true, false ] The new_record value.
-    def new_record=(saved)
-      @new_record = saved
-    end
-
     # Checks if the document has been saved to the database. Returns false
     # if the document has been destroyed.
     #
@@ -41,6 +31,19 @@ module Mongoid #:nodoc:
       !new_record? && !destroyed?
     end
 
+    # Returns whether or not the document has been flagged for deletion, but
+    # not destroyed yet. Used for atomic pulls of child documents.
+    #
+    # @example Is the document flagged?
+    #   document.flagged_for_destroy?
+    #
+    # @return [ true, false ] If the document is flagged.
+    #
+    # @since 2.3.2
+    def flagged_for_destroy?
+      !!@flagged_for_destroy
+    end
+
     # Returns true if the +Document+ has been succesfully destroyed, and false
     # if it hasn't. This is determined by the variable @destroyed and NOT
     # by checking the database.
@@ -54,16 +57,6 @@ module Mongoid #:nodoc:
     end
     alias :deleted? :destroyed?
 
-    # Sets the destroyed boolean - used after document is destroyed.
-    #
-    # @example Set the destroyed flag.
-    #   person.destroyed = true
-    #
-    # @return [ true, false ] The value set for destroyed.
-    def destroyed=(destroyed)
-      @destroyed = destroyed && true
-    end
-
     # Determine if the document can be pushed.
     #
     # @example Is this pushable?

data/lib/mongoid/threaded.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require "mongoid/threaded/lifecycle"
+
 module Mongoid #:nodoc:
 
   # This module contains logic for easy access to objects that have a lifecycle
@@ -54,6 +56,18 @@ module Mongoid #:nodoc:
       create_stack.push(true)
     end
 
+    # Begins a creating block.
+    #
+    # @example Begin the load.
+    #   Threaded.begin_load
+    #
+    # @return [ true ] Always true.
+    #
+    # @since 2.3.2
+    def begin_load
+      load_stack.push(true)
+    end
+
     # Begin validating a document on the current thread.
     #
     # @example Begin validation.
@@ -114,6 +128,18 @@ module Mongoid #:nodoc:
       !create_stack.empty?
     end
 
+    # Is the current thread in creating mode?
+    #
+    # @example Is the thread in creating mode?
+    #   Threaded.creating?
+    #
+    # @return [ true, false ] If the thread is in creating mode?
+    #
+    # @since 2.3.2
+    def loading?
+      !load_stack.empty?
+    end
+
     # Get the assign stack for the current thread. Is simply an array of calls
     # to Mongoid's assigning method.
     #
@@ -166,6 +192,19 @@ module Mongoid #:nodoc:
       Thread.current[:"[mongoid]:create-stack"] ||= []
     end
 
+    # Get the load stack for the current thread. Is simply an array of calls
+    # to Mongoid's loading method.
+    #
+    # @example Get the load stack.
+    #   Threaded.load_stack
+    #
+    # @return [ Array ] The array of load calls.
+    #
+    # @since 2.3.2
+    def load_stack
+      Thread.current[:"[mongoid]:load-stack"] ||= []
+    end
+
     # Clear out all the safety options set using the safely proxy.
     #
     # @example Clear out the options.
@@ -237,6 +276,18 @@ module Mongoid #:nodoc:
       create_stack.pop
     end
 
+    # Exit the loading block.
+    #
+    # @example Exit the loading block.
+    #   Threaded.exit_load
+    #
+    # @return [ true ] The last element in the stack.
+    #
+    # @since 2.1.9
+    def exit_load
+      load_stack.pop
+    end
+
     # Exit validating a document on the current thread.
     #
     # @example Exit validation.

data/lib/mongoid/threaded/lifecycle.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Threaded #:nodoc:
+
+    # This module contains convenience methods for document lifecycle that
+    # resides on thread locals.
+    module Lifecycle
+      extend ActiveSupport::Concern
+
+      private
+
+      # Begin the assignment of attributes. While in this block embedded
+      # documents will not autosave themselves in order to allow the document to
+      # be in a valid state.
+      #
+      # @example Execute the assignment.
+      #   _assigning do
+      #     person.attributes = { :addresses => [ address ] }
+      #   end
+      #
+      # @return [ Object ] The yielded value.
+      #
+      # @since 2.2.0
+      def _assigning
+        Threaded.begin_assign
+        yield
+      ensure
+        Threaded.exit_assign
+      end
+
+      # Is the current thread in assigning mode?
+      #
+      # @example Is the current thread in assigning mode?
+      #   proxy._assigning?
+      #
+      # @return [ true, false ] If the thread is assigning.
+      #
+      # @since 2.1.0
+      def _assigning?
+        Threaded.assigning?
+      end
+
+      # Execute a block in binding mode.
+      #
+      # @example Execute in binding mode.
+      #   binding do
+      #     relation.push(doc)
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.1.0
+      def _binding
+        Threaded.begin_bind
+        yield
+      ensure
+        Threaded.exit_bind
+      end
+
+      # Is the current thread in binding mode?
+      #
+      # @example Is the current thread in binding mode?
+      #   proxy.binding?
+      #
+      # @return [ true, false ] If the thread is binding.
+      #
+      # @since 2.1.0
+      def _binding?
+        Threaded.binding?
+      end
+
+      # Execute a block in building mode.
+      #
+      # @example Execute in building mode.
+      #   _building do
+      #     relation.push(doc)
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.1.0
+      def _building
+        Threaded.begin_build
+        yield
+      ensure
+        Threaded.exit_build
+      end
+
+      # Is the current thread in building mode?
+      #
+      # @example Is the current thread in building mode?
+      #   proxy._building?
+      #
+      # @return [ true, false ] If the thread is building.
+      #
+      # @since 2.1.0
+      def _building?
+        Threaded.building?
+      end
+
+      # Is the current thread in creating mode?
+      #
+      # @example Is the current thread in creating mode?
+      #   proxy.creating?
+      #
+      # @return [ true, false ] If the thread is creating.
+      #
+      # @since 2.1.0
+      def _creating?
+        Threaded.creating?
+      end
+
+      # Execute a block in loading mode.
+      #
+      # @example Execute in loading mode.
+      #   _loading do
+      #     relation.push(doc)
+      #   end
+      #
+      # @return [ Object ] The return value of the block.
+      #
+      # @since 2.3.2
+      def _loading
+        Threaded.begin_load
+        yield
+      ensure
+        Threaded.exit_load
+      end
+
+      # Is the current thread in loading mode?
+      #
+      # @example Is the current thread in loading mode?
+      #   proxy._loading?
+      #
+      # @return [ true, false ] If the thread is loading.
+      #
+      # @since 2.3.2
+      def _loading?
+        Threaded.loading?
+      end
+
+      module ClassMethods #:nodoc:
+
+        # Execute a block in creating mode.
+        #
+        # @example Execute in creating mode.
+        #   creating do
+        #     relation.push(doc)
+        #   end
+        #
+        # @return [ Object ] The return value of the block.
+        #
+        # @since 2.1.0
+        def _creating
+          Threaded.begin_create
+          yield
+        ensure
+          Threaded.exit_create
+        end
+      end
+    end
+  end
+end