mongoid 2.4.10 → 3.0.0

data/lib/mongoid/relations/targets/enumerable.rb

@@ -1,22 +1,22 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
-  module Relations #:nodoc:
-    module Targets #:nodoc:
+module Mongoid
+  module Relations
+    module Targets
 
       # This class is the wrapper for all relational associations that have a
-      # target that can be a criteria or array of loaded documents. This
+      # target that can be a criteria or array of _loaded documents. This
       # handles both cases or a combination of the two.
       class Enumerable
         include ::Enumerable
 
         # The three main instance variables are collections of documents.
         #
-        # @attribute [rw] added Documents that have been appended.
-        # @attribute [rw] loaded Persisted documents that have been loaded.
-        # @attribute [rw] unloaded A criteria representing persisted docs.
-        attr_accessor :added, :loaded, :unloaded
+        # @attribute [rw] _added Documents that have been appended.
+        # @attribute [rw] _loaded Persisted documents that have been _loaded.
+        # @attribute [rw] _unloaded A criteria representing persisted docs.
+        attr_accessor :_added, :_loaded, :_unloaded
 
-        delegate :===, :is_a?, :kind_of?, :to => :added
+        delegate :===, :is_a?, :kind_of?, to: []
 
         # Check if the enumerable is equal to the other object.
         #
@@ -44,7 +44,8 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def <<(document)
-          added.push(document)
+          _added[document.id] = document
+          self
         end
         alias :push :<<
 
@@ -59,14 +60,14 @@ module Mongoid #:nodoc:
         #     doc.unbind
         #   end
         #
-        # @return [ Array<Document> ] The cleared out added docs.
+        # @return [ Array<Document> ] The cleared out _added docs.
         #
         # @since 2.1.0
         def clear
           if block_given?
             in_memory { |doc| yield(doc) }
           end
-          loaded.clear and added.clear
+          _loaded.clear and _added.clear
         end
 
         # Clones each document in the enumerable.
@@ -94,15 +95,15 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def delete(document)
-          (loaded.delete(document) || added.delete(document)).tap do |doc|
-            unless doc
-              if unloaded && unloaded.where(:_id => document.id).exists?
-                yield(document) if block_given?
-                return document
-              end
+          doc = (_loaded.delete(document.id) || _added.delete(document.id))
+          unless doc
+            if _unloaded && _unloaded.where(_id: document.id).exists?
+              yield(document) if block_given?
+              return document
             end
-            yield(doc) if block_given?
           end
+          yield(doc) if block_given?
+          doc
         end
 
         # Deletes every document in the enumerable for where the block returns
@@ -120,50 +121,52 @@ module Mongoid #:nodoc:
         # @since 2.1.0
         def delete_if(&block)
           load_all!
-          tap do
-            loaded.delete_if(&block)
-            added.delete_if(&block)
+          deleted = in_memory.select(&block)
+          deleted.each do |doc|
+            _loaded.delete(doc.id)
+            _added.delete(doc.id)
           end
+          self
         end
 
         # Iterating over this enumerable has to handle a few different
         # scenarios.
         #
-        # If the enumerable has its criteria loaded into memory then it yields
-        # to all the loaded docs and all the added docs.
+        # If the enumerable has its criteria _loaded into memory then it yields
+        # to all the _loaded docs and all the _added docs.
         #
-        # If the enumerable has not loaded the criteria then it iterates over
+        # If the enumerable has not _loaded the criteria then it iterates over
         # the cursor while loading the documents and then iterates over the
-        # added docs.
+        # _added docs.
         #
         # @example Iterate over the enumerable.
         #   enumerable.each do |doc|
         #     puts doc
         #   end
         #
-        # @return [ true ] That the enumerable is now loaded.
+        # @return [ true ] That the enumerable is now _loaded.
         #
         # @since 2.1.0
         def each
-          if loaded?
-            loaded.each do |doc|
+          if _loaded?
+            _loaded.each_pair do |id, doc|
               yield(doc)
             end
           else
-            unloaded.each do |doc|
-              document = added.delete_one(doc) || loaded.delete_one(doc) || doc
+            _unloaded.each do |doc|
+              document = _added.delete(doc.id) || _loaded.delete(doc.id) || doc
               yield(document)
-              loaded.push(document)
+              _loaded[document.id] = document
             end
           end
-          added.each do |doc|
+          _added.each_pair do |id, doc|
             yield(doc)
           end
           @executed = true
         end
 
         # Is the enumerable empty? Will determine if the count is zero based on
-        # whether or not it is loaded.
+        # whether or not it is _loaded.
         #
         # @example Is the enumerable empty?
         #   enumerable.empty?
@@ -172,10 +175,10 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def empty?
-          if loaded?
+          if _loaded?
             in_memory.count == 0
           else
-            unloaded.count + added.count == 0
+            _unloaded.count + _added.count == 0
           end
         end
 
@@ -189,7 +192,7 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def first
-          added.first || (loaded? ? loaded.first : unloaded.first)
+          matching_document(:first)
         end
 
         # Initialize the new enumerable either with a criteria or an array.
@@ -205,12 +208,31 @@ module Mongoid #:nodoc:
         # @since 2.1.0
         def initialize(target)
           if target.is_a?(Criteria)
-            @added, @loaded, @unloaded = [], [], target
+            @_added, @executed, @_loaded, @_unloaded = {}, false, {}, target
           else
-            @added, @executed, @loaded = [], true, target
+            @_added, @executed = {}, true
+            @_loaded = target.inject({}) do |_target, doc|
+              _target[doc.id] = doc
+              _target
+            end
           end
         end
 
+        # Does the target include the provided document?
+        #
+        # @example Does the target include the document?
+        #   enumerable.include?(document)
+        #
+        # @param [ Document ] doc The document to check.
+        #
+        # @return [ true, false ] If the document is in the target.
+        #
+        # @since 3.0.0
+        def include?(doc)
+          return super unless _unloaded
+          _unloaded.where(_id: doc.id).exists? || _added.has_key?(doc.id)
+        end
+
         # Inspection will just inspect the entries for nice array-style
         # printing.
         #
@@ -224,8 +246,8 @@ module Mongoid #:nodoc:
           entries.inspect
         end
 
-        # Return all the documents in the enumerable that have been loaded or
-        # added.
+        # Return all the documents in the enumerable that have been _loaded or
+        # _added.
         #
         # @note When passed a block it yields to each document.
         #
@@ -236,9 +258,9 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def in_memory
-          (loaded + added).tap do |docs|
-            docs.each { |doc| yield(doc) } if block_given?
-          end
+          docs = (_loaded.values + _added.values)
+          docs.each { |doc| yield(doc) } if block_given?
+          docs
         end
 
         # Get the last document in the enumerable. Will check the new
@@ -251,7 +273,7 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def last
-          added.last || (loaded? ? loaded.last : unloaded.last)
+          matching_document(:last)
         end
 
         # Loads all the documents in the enumerable from the database.
@@ -259,21 +281,21 @@ module Mongoid #:nodoc:
         # @example Load all the documents.
         #   enumerable.load_all!
         #
-        # @return [ true ] That the enumerable is loaded.
+        # @return [ true ] That the enumerable is _loaded.
         #
         # @since 2.1.0
         alias :load_all! :entries
 
-        # Has the enumerable been loaded? This will be true if the criteria has
+        # Has the enumerable been _loaded? This will be true if the criteria has
         # been executed or we manually load the entire thing.
         #
-        # @example Is the enumerable loaded?
-        #   enumerable.loaded?
+        # @example Is the enumerable _loaded?
+        #   enumerable._loaded?
         #
-        # @return [ true, false ] If the enumerable has been loaded.
+        # @return [ true, false ] If the enumerable has been _loaded.
         #
         # @since 2.1.0
-        def loaded?
+        def _loaded?
           !!@executed
         end
 
@@ -286,7 +308,7 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def reset
-          loaded.clear and added.clear
+          _loaded.clear and _added.clear
           @executed = false
         end
 
@@ -316,11 +338,11 @@ module Mongoid #:nodoc:
         #
         # @since 2.1.0
         def size
-          count = (unloaded ? unloaded.count : loaded.count)
+          count = (_unloaded ? _unloaded.count : _loaded.count)
           if count.zero?
-            count + added.count
+            count + _added.count
           else
-            count + added.count{ |d| d.new_record? }
+            count + _added.values.count{ |d| d.new_record? }
           end
         end
         alias :length :size
@@ -332,7 +354,7 @@ module Mongoid #:nodoc:
         #
         # @param [ Hash ] options Optional parameters.
         #
-        # @return [ String ] The entries all loaded as a string.
+        # @return [ String ] The entries all _loaded as a string.
         #
         # @since 2.2.0
         def to_json(options = {})
@@ -346,7 +368,7 @@ module Mongoid #:nodoc:
         #
         # @param [ Hash ] options Optional parameters.
         #
-        # @return [ Hash ] The entries all loaded as a hash.
+        # @return [ Hash ] The entries all _loaded as a hash.
         #
         # @since 2.2.0
         def as_json(options = {})
@@ -372,6 +394,13 @@ module Mongoid #:nodoc:
         def method_missing(name, *args, &block)
           entries.send(name, *args, &block)
         end
+
+        def matching_document(location)
+          _loaded.try(:values).try(location) ||
+            _added[_unloaded.try(location).try(:id)] ||
+            _unloaded.try(location) ||
+            _added.values.try(location)
+        end
       end
     end
   end

data/lib/mongoid/relations/touchable.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Touchable
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :touchables
+        self.touchables = []
+      end
+
+      module ClassMethods
+
+        # Add the metadata to the touchable relations if the touch option was
+        # provided.
+        #
+        # @example Add the touchable.
+        #   Model.touchable(meta)
+        #
+        # @param [ Metadata ] metadata The relation metadata.
+        #
+        # @return [ Class ] The model class.
+        #
+        # @since 3.0.0
+        def touchable(metadata)
+          self.touchables.push(metadata.name) if metadata.touchable?
+          self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations.rb

@@ -13,21 +13,20 @@ require "mongoid/relations/one"
 require "mongoid/relations/options"
 require "mongoid/relations/polymorphic"
 require "mongoid/relations/targets/enumerable"
-require "mongoid/relations/embedded/atomic"
 require "mongoid/relations/embedded/in"
 require "mongoid/relations/embedded/many"
 require "mongoid/relations/embedded/one"
-require "mongoid/relations/referenced/batch"
 require "mongoid/relations/referenced/in"
 require "mongoid/relations/referenced/many"
 require "mongoid/relations/referenced/many_to_many"
 require "mongoid/relations/referenced/one"
 require "mongoid/relations/reflections"
 require "mongoid/relations/synchronization"
+require "mongoid/relations/touchable"
 require "mongoid/relations/metadata"
 require "mongoid/relations/macros"
 
-module Mongoid # :nodoc:
+module Mongoid
 
   # All classes and modules under the relations namespace handle the
   # functionality that has to do with embedded and referenced (relational)
@@ -43,6 +42,7 @@ module Mongoid # :nodoc:
     include Polymorphic
     include Reflections
     include Synchronization
+    include Touchable
 
     attr_accessor :metadata
 
@@ -83,6 +83,22 @@ module Mongoid # :nodoc:
       metadata && metadata.macro == :embeds_one
     end
 
+    # Get the metadata name for this document. If no metadata was defined
+    # will raise an error.
+    #
+    # @example Get the metadata name.
+    #   document.metadata_name
+    #
+    # @raise [ Errors::NoMetadata ] If no metadata is present.
+    #
+    # @return [ Symbol ] The metadata name.
+    #
+    # @since 3.0.0
+    def metadata_name
+      raise Errors::NoMetadata.new(self.class.name) unless metadata
+      metadata.name
+    end
+
     # Determine if the document is part of an references_many relation.
     #
     # @example Is the document in a references many?
@@ -92,7 +108,7 @@ module Mongoid # :nodoc:
     #
     # @since 2.0.0.rc.1
     def referenced_many?
-      metadata && metadata.macro == :references_many
+      metadata && metadata.macro == :has_many
     end
 
     # Determine if the document is part of an references_one relation.
@@ -104,7 +120,7 @@ module Mongoid # :nodoc:
     #
     # @since 2.0.0.rc.1
     def referenced_one?
-      metadata && metadata.macro == :references_one
+      metadata && metadata.macro == :has_one
     end
 
     # Convenience method for iterating through the loaded relations and
@@ -126,7 +142,7 @@ module Mongoid # :nodoc:
       end
     end
 
-    module ClassMethods #:nodoc:
+    module ClassMethods
 
       # This is convenience for librarys still on the old API.
       #

data/lib/mongoid/reloading.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-module Mongoid #:nodoc:
+module Mongoid
   # This module handles reloading behaviour of documents.
   module Reloading
 
@@ -16,18 +16,16 @@ module Mongoid #:nodoc:
     #
     # @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)
+      reloaded = _reload
+      if Mongoid.raise_not_found_error && reloaded.empty?
+        raise Errors::DocumentNotFound.new(self.class, id, id)
       end
+      @attributes = reloaded
+      changed_attributes.clear
+      apply_defaults
+      reload_relations
+      run_callbacks(:initialize)
+      self
     end
 
     private
@@ -54,7 +52,7 @@ module Mongoid #:nodoc:
     #
     # @since 2.3.2
     def reload_root_document
-      {}.merge(collection.find_one(:_id => id) || {})
+      {}.merge(collection.find(_id: id).one || {})
     end
 
     # Reload the embedded document.
@@ -67,7 +65,7 @@ module Mongoid #:nodoc:
     # @since 2.3.2
     def reload_embedded_document
       extract_embedded_attributes({}.merge(
-        _root.collection.find_one(:_id => _root.id)
+        _root.collection.find(_id: _root.id).one
       ))
     end