mongoid 2.8.1 → 3.0.0.rc

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
-    module Referenced #:nodoc:
+module Mongoid
+  module Relations
+    module Referenced
 
       # This class defines the behaviour for all relations that are a
       # many-to-many between documents in different collections.
@@ -25,29 +25,51 @@ module Mongoid # :nodoc:
         #
         # @since 2.0.0.beta.1
         def <<(*args)
-          batched do
-            [].tap do |ids|
-              args.flatten.each do |doc|
-                next unless doc
-                append(doc)
-                if persistable? || _creating?
-                  ids.push(doc.id)
-                  doc.save
-                else
-                  base.send(metadata.foreign_key).push(doc.id)
-                  base.synced[metadata.foreign_key] = false
-                end
-              end
+          docs = args.flatten
+          return concat(docs) if docs.size > 1
+          if doc = docs.first
+            if !target.include?(doc)
+              append(doc)
+              base.push(foreign_key, doc.id)
               if persistable? || _creating?
-                base.push_all(metadata.foreign_key, ids)
-                base.synced[metadata.foreign_key] = false
+                doc.save
               end
             end
           end
+          unsynced(base, foreign_key) and self
         end
-        alias :concat :<<
         alias :push :<<
 
+        # Appends an array of documents to the relation. Performs a batch
+        # insert of the documents instead of persisting one at a time.
+        #
+        # @example Concat with other documents.
+        #   person.posts.concat([ post_one, post_two ])
+        #
+        # @param [ Array<Document> ] documents The docs to add.
+        #
+        # @return [ Array<Document> ] The documents.
+        #
+        # @since 2.4.0
+        def concat(documents)
+          ids, inserts = [], []
+          documents.each do |doc|
+            next if doc.nil? || target.include?(doc)
+            append(doc)
+            if persistable? || _creating?
+              ids.push(doc.id)
+              save_or_delay(doc, inserts)
+            else
+              base.send(foreign_key).push(doc.id) and unsynced(base, foreign_key)
+            end
+          end
+          if persistable? || _creating?
+            base.push_all(foreign_key, ids)
+          end
+          persist_delayed(inserts)
+          self
+        end
+
         # Build a new document from the attributes and append it to this
         # relation without saving.
         #
@@ -72,13 +94,13 @@ module Mongoid # :nodoc:
             options, type = {}, options
           end
 
-          Factory.build(type || klass, attributes, options).tap do |doc|
-            base.send(metadata.foreign_key).push(doc.id)
-            append(doc)
-            doc.apply_proc_defaults
-            doc.synced[metadata.inverse_foreign_key] = false
-            yield(doc) if block_given?
-          end
+          doc = Factory.build(type || klass, attributes, options)
+          base.send(foreign_key).push(doc.id)
+          append(doc)
+          doc.apply_post_processed_defaults
+          unsynced(doc, inverse_foreign_key)
+          yield(doc) if block_given?
+          doc
         end
         alias :new :build
 
@@ -95,12 +117,12 @@ module Mongoid # :nodoc:
         #
         # @since 2.1.0
         def delete(document)
-          super.tap do |doc|
-            if doc && persistable?
-              base.pull(metadata.foreign_key, doc.id)
-              base.synced[metadata.foreign_key] = false
-            end
+          doc = super
+          if doc && persistable?
+            base.pull(foreign_key, doc.id)
+            unsynced(base, foreign_key)
           end
+          doc
         end
 
         # Removes all associations between the base document and the target
@@ -113,12 +135,12 @@ module Mongoid # :nodoc:
         # @since 2.0.0.rc.1
         def nullify
           unless metadata.forced_nil_inverse?
-            criteria.pull(metadata.inverse_foreign_key, base.id)
+            criteria.pull(inverse_foreign_key, base.id)
           end
           if persistable?
             base.set(
-              metadata.foreign_key,
-              base.send(metadata.foreign_key).clear
+              foreign_key,
+              base.send(foreign_key).clear
             )
           end
           target.clear do |doc|
@@ -142,10 +164,9 @@ module Mongoid # :nodoc:
         #
         # @since 2.0.0.rc.1
         def substitute(replacement)
-          tap do |proxy|
-            proxy.purge
-            proxy.push(replacement.compact.uniq) unless replacement.blank?
-          end
+          purge
+          push(replacement.compact.uniq) unless replacement.blank?
+          self
         end
 
         # Get a criteria for the documents without the default scoping
@@ -158,7 +179,7 @@ module Mongoid # :nodoc:
         #
         # @since 2.4.0
         def unscoped
-          klass.unscoped.any_in(:_id => base.send(metadata.foreign_key))
+          klass.unscoped.any_in(_id: base.send(foreign_key))
         end
 
         private
@@ -198,7 +219,25 @@ module Mongoid # :nodoc:
         #
         # @return [ Criteria ] A new criteria.
         def criteria
-          ManyToMany.criteria(metadata, base.send(metadata.foreign_key))
+          ManyToMany.criteria(metadata, base.send(foreign_key))
+        end
+
+        # Flag the base as unsynced with respect to the foreign key.
+        #
+        # @api private
+        #
+        # @example Flag as unsynced.
+        #   relation.unsynced(doc, :preference_ids)
+        #
+        # @param [ Document ] doc The document to flag.
+        # @param [ Symbol ] key The key to flag on the document.
+        #
+        # @return [ true ] true.
+        #
+        # @since 3.0.0
+        def unsynced(doc, key)
+          doc.synced[key] = false
+          true
         end
 
         class << self
@@ -235,7 +274,7 @@ module Mongoid # :nodoc:
           #
           # @since 2.1.0
           def criteria(metadata, object, type = nil)
-            metadata.klass.any_in(:_id => object)
+            metadata.klass.all_of(_id: { "$in" => object })
           end
 
           # Get the criteria that is used to eager load a relation of this
@@ -245,13 +284,15 @@ module Mongoid # :nodoc:
           #   Proxy.eager_load(metadata, criteria)
           #
           # @param [ Metadata ] metadata The relation metadata.
-          # @param [ Criteria ] criteria The criteria being used.
+          # @param [ Array<Object> ] ids The ids of the documents to load.
           #
           # @return [ Criteria ] The criteria to eager load the relation.
           #
           # @since 2.2.0
-          def eager_load(metadata, criteria)
-            raise Errors::EagerLoad.new(metadata.name)
+          def eager_load(metadata, ids)
+            metadata.klass.any_in(_id: ids).each do |doc|
+              IdentityMap.set(doc)
+            end
           end
 
           # Returns true if the relation is an embedded one. In this case
@@ -267,6 +308,20 @@ module Mongoid # :nodoc:
             false
           end
 
+          # Get the foreign key for the provided name.
+          #
+          # @example Get the foreign key.
+          #   Referenced::ManyToMany.foreign_key(:person)
+          #
+          # @param [ Symbol ] name The name.
+          #
+          # @return [ String ] The foreign key.
+          #
+          # @since 3.0.0
+          def foreign_key(name)
+            "#{name.to_s.singularize}#{foreign_key_suffix}"
+          end
+
           # Get the default value for the foreign key.
           #
           # @example Get the default.
@@ -297,9 +352,9 @@ module Mongoid # :nodoc:
           # @example Get the macro.
           #   Referenced::ManyToMany.macro
           #
-          # @return [ Symbol ] :references_and_referenced_in_many
+          # @return [ Symbol ] :has_and_belongs_to_many
           def macro
-            :references_and_referenced_in_many
+            :has_and_belongs_to_many
           end
 
           # Return the nested builder that is responsible for generating the documents

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
-    module Referenced #:nodoc:
+module Mongoid
+  module Relations
+    module Referenced
 
       # This class defines the behaviour for all relations that are a
       # one-to-one between documents in different collections.
@@ -59,8 +59,7 @@ module Mongoid # :nodoc:
               save if persisted?
             end
           end
-          return nil unless replacement
-          One.new(base, replacement, metadata)
+          One.new(base, replacement, metadata) if replacement
         end
 
         private
@@ -122,7 +121,18 @@ module Mongoid # :nodoc:
           #
           # @since 2.1.0
           def criteria(metadata, object, type = nil)
-            metadata.klass.where(metadata.foreign_key => object)
+            crit = metadata.klass.where(metadata.foreign_key => object)
+
+            if metadata.polymorphic?
+              crit = crit.where(metadata.type => type.name)
+            end
+
+            inverse_metadata = metadata.inverse_metadata(metadata.klass)
+            if inverse_metadata.inverse_of_field
+              crit = crit.any_in(inverse_metadata.inverse_of_field => [metadata.name, nil])
+            end
+
+            crit
           end
 
           # Get the criteria that is used to eager load a relation of this
@@ -138,10 +148,7 @@ module Mongoid # :nodoc:
           #
           # @since 2.2.0
           def eager_load(metadata, ids)
-            klass, foreign_key = metadata.klass, metadata.foreign_key
-            klass.any_in(foreign_key => ids).each do |doc|
-              IdentityMap.set_one(doc, foreign_key => doc.send(foreign_key))
-            end
+            eager_load_ids(metadata, ids) { |doc, key| IdentityMap.set_one(doc, key) }
           end
 
           # Returns true if the relation is an embedded one. In this case
@@ -157,6 +164,20 @@ module Mongoid # :nodoc:
             false
           end
 
+          # Get the foreign key for the provided name.
+          #
+          # @example Get the foreign key.
+          #   Referenced::One.foreign_key(:person)
+          #
+          # @param [ Symbol ] name The name.
+          #
+          # @return [ String ] The foreign key.
+          #
+          # @since 3.0.0
+          def foreign_key(name)
+            "#{name}#{foreign_key_suffix}"
+          end
+
           # Get the default value for the foreign key.
           #
           # @example Get the default.
@@ -187,9 +208,9 @@ module Mongoid # :nodoc:
           # @example Get the macro.
           #   Referenced::One.macro
           #
-          # @return [ Symbol ] :references_one.
+          # @return [ Symbol ] :has_one.
           def macro
-            :references_one
+            :has_one
           end
 
           # Return the nested builder that is responsible for generating the documents
@@ -254,7 +275,7 @@ module Mongoid # :nodoc:
           #
           # @since 2.1.0
           def valid_options
-            [ :as, :autosave, :dependent, :foreign_key ]
+            [ :as, :autobuild, :autosave, :dependent, :foreign_key ]
           end
 
           # Get the default validation setting for the relation. Determines if

data/lib/mongoid/relations/reflections.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
+module Mongoid
+  module Relations
 
     # The reflections module provides convenience methods that can retrieve
     # useful information about associations.
@@ -31,7 +31,7 @@ module Mongoid # :nodoc:
         self.class.reflect_on_all_associations(*macros)
       end
 
-      module ClassMethods #:nodoc
+      module ClassMethods
 
         # Returns the relation metadata for the supplied name.
         #

data/lib/mongoid/relations/synchronization.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-module Mongoid # :nodoc:
-  module Relations #:nodoc:
+module Mongoid
+  module Relations
 
     # This module handles the behaviour for synchronizing foreign keys between
     # both sides of a many to many relations.
@@ -36,8 +36,6 @@ module Mongoid # :nodoc:
 
       # Has the document been synced for the foreign key?
       #
-      # @todo Change the sync to be key based.
-      #
       # @example Has the document been synced?
       #   document.synced?
       #
@@ -61,7 +59,7 @@ module Mongoid # :nodoc:
       #
       # @since 2.2.1
       def remove_inverse_keys(meta)
-        meta.criteria(send(meta.foreign_key)).pull(meta.inverse_foreign_key, id)
+        meta.criteria(send(meta.foreign_key), self.class).pull(meta.inverse_foreign_key, id)
       end
 
       # Update the inverse keys for the relation.
@@ -91,15 +89,15 @@ module Mongoid # :nodoc:
           end
 
           unless adds.empty?
-            meta.criteria(adds).add_to_set(meta.inverse_foreign_key, id)
+            meta.criteria(adds, self.class).add_to_set(meta.inverse_foreign_key, id)
           end
           unless subs.empty?
-            meta.criteria(subs).pull(meta.inverse_foreign_key, id)
+            meta.criteria(subs, self.class).pull(meta.inverse_foreign_key, id)
           end
         end
       end
 
-      module ClassMethods #:nodoc:
+      module ClassMethods
 
         # Set up the syncing of many to many foreign keys.
         #
@@ -133,15 +131,14 @@ module Mongoid # :nodoc:
         #
         # @since 2.1.0
         def synced_save(metadata)
-          tap do
-            set_callback(
-              :save,
-              :after,
-              :if => lambda { |doc| doc.syncable?(metadata) }
-            ) do |doc|
-              doc.update_inverse_keys(metadata)
-            end
+          set_callback(
+            :save,
+            :after,
+            if: ->(doc){ doc.syncable?(metadata) }
+          ) do |doc|
+            doc.update_inverse_keys(metadata)
           end
+          self
         end
 
         # Set up the sync of inverse keys that needs to happen on a destroy.
@@ -155,14 +152,13 @@ module Mongoid # :nodoc:
         #
         # @since 2.2.1
         def synced_destroy(metadata)
-          tap do
-            set_callback(
-              :destroy,
-              :after
-            ) do |doc|
-              doc.remove_inverse_keys(metadata)
-            end
+          set_callback(
+            :destroy,
+            :after
+          ) do |doc|
+            doc.remove_inverse_keys(metadata)
           end
+          self
         end
       end
     end

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