mongoid 3.1.6 → 4.0.2

data/lib/mongoid/relations/eager.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require "mongoid/relations/eager/base"
+require "mongoid/relations/eager/belongs_to"
+require "mongoid/relations/eager/has_one"
+require "mongoid/relations/eager/has_many"
+require "mongoid/relations/eager/has_and_belongs_to_many"
+
+module Mongoid
+  module Relations
+    module Eager
+
+      attr_accessor :eager_loaded
+
+      def with_eager_loading(document)
+        return nil unless document
+        doc = Factory.from_db(klass, document, criteria.options[:fields])
+        eager_load_one(doc)
+        doc
+      end
+
+      def eager_load_one(doc)
+        eager_load([doc])
+      end
+
+      def eager_loadable?(document = nil)
+        return false if criteria.inclusions.empty?
+        !eager_loaded
+      end
+
+      def eager_load(docs)
+        return false unless eager_loadable?
+        preload(criteria.inclusions, docs)
+        self.eager_loaded = true
+      end
+
+      def preload(relations, docs)
+
+        relations.group_by do |metadata|
+          metadata.relation
+        end.each do |relation, associations|
+          relation.eager_load_klass.new(associations, docs).run
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/eager/base.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Eager
+      # Base class for eager load preload functions.
+      #
+      # @since 4.0.0
+      class Base
+
+        # Instantiate the eager load class.
+        #
+        # @example Create the new belongs to eager load preloader.
+        #   BelongsTo.new(relations_metadata, parent_docs)
+        #
+        # @param [ Array<Metadata> ] Relations to eager load
+        # @param [ Array<Document> ] Documents to preload the relations
+        #
+        # @return [ Base ] The eager load preloader
+        #
+        # @since 4.0.0
+        def initialize(associations, docs)
+          @associations = associations
+          @docs = docs
+          @grouped_docs = {}
+        end
+
+        # Shift the current relation metadata
+        #
+        # @example Shift the current metadata.
+        #   loader.shift_metadata
+        #
+        # @return [ Object ] The relation metadata object.
+        #
+        # @since 4.0.0
+        def shift_metadata
+          @metadata = @associations.shift
+        end
+
+        # Run the preloader.
+        #
+        # @example Preload the relations into the documents.
+        #   loader.run
+        #
+        # @return [ Array ] The list of documents given.
+        #
+        # @since 4.0.0
+        def run
+          while shift_metadata
+            preload
+          end
+          @docs
+        end
+
+        # Preload the current relation.
+        #
+        # This method should be implemented in the subclass
+        #
+        # @example Preload the current relation into the documents.
+        #   loader.preload
+        #
+        # @since 4.0.0
+        def preload
+          raise NotImplementedError
+        end
+
+        # Run the preloader.
+        #
+        # @example Iterate over the documents loadded for the current relation
+        #   loader.each_loaded_document { |doc| }
+        #
+        # @since 4.0.0
+        def each_loaded_document
+          @metadata.klass.any_in(key => keys_from_docs).each do |doc|
+            yield doc
+          end
+        end
+
+        # Set the pre-loaded document into its parent.
+        #
+        # @example Set docs into parent with pk = "foo"
+        #   loader.set_on_parent("foo", docs)
+        #
+        # @param [ ObjectId ] parent`s id
+        # @param [ Document, Array ] element to push into the parent
+        #
+        # @since 4.0.0
+        def set_on_parent(id, element)
+          grouped_docs[id].each do |d|
+            set_relation(d, element)
+          end
+        end
+
+        # Return a hash with the current documents grouped by key.
+        #
+        # @example Return a hash with the current documents grouped by key.
+        #   loader.grouped_docs
+        #
+        # @return [ Hash ] hash with groupd documents.
+        #
+        # @since 4.0.0
+        def grouped_docs
+          @grouped_docs[@metadata.name] ||= @docs.group_by do |doc|
+            doc.send(group_by_key)
+          end
+        end
+
+        # Group the documents and return the keys
+        #
+        # @example
+        #   loader.keys_from_docs
+        #
+        # @return [ Array ] keys, ids
+        #
+        # @since 4.0.0
+        def keys_from_docs
+          grouped_docs.keys
+        end
+
+        # Return the key to group the current documents.
+        #
+        # This method should be implemented in the subclass
+        #
+        # @example Return the key for group
+        #   loader.group_by_key
+        #
+        # @return [ Symbol ] Key to group by the current documents.
+        #
+        # @since 4.0.0
+        def group_by_key
+          raise NotImplementedError
+        end
+
+        protected
+        # Set the pre-loaded document into its parent.
+        #
+        # @example Set docs into parent using the current relation name.
+        #   loader.set_relation(doc, docs)
+        #
+        # @param [ Document ] document
+        # @param [ Document, Array ] element to set into the parent
+        #
+        # @since 4.0.0
+        def set_relation(doc, element)
+          doc.set_relation(@metadata.name, element)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/eager/belongs_to.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Eager
+
+      class BelongsTo < Base
+
+        def preload
+          raise Errors::EagerLoad.new(@metadata.name) if @metadata.polymorphic?
+
+          @docs.each do |d|
+            set_relation(d, nil)
+          end
+
+          each_loaded_document do |doc|
+            id = doc.send(key)
+            set_on_parent(id, doc)
+          end
+        end
+
+        def group_by_key
+          @metadata.foreign_key
+        end
+
+        def key
+          @metadata.primary_key
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/eager/has_and_belongs_to_many.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Eager
+
+      class HasAndBelongsToMany < Base
+
+        def preload
+          @docs.each do |d|
+            set_relation(d, [])
+          end
+
+          entries = {}
+          each_loaded_document do |doc|
+            entries[doc.send(key)] = doc
+          end
+
+          @docs.each do |d|
+            keys = d.send(group_by_key)
+            docs = entries.values_at(*keys)
+            set_relation(d, docs)
+          end
+        end
+
+        def keys_from_docs
+          keys = Set.new
+          @docs.each do |d|
+            keys += d.send(group_by_key)
+          end
+          keys.to_a
+        end
+
+        def set_relation(doc, element)
+          doc.__build__(@metadata.name, element, @metadata)
+        end
+
+        def group_by_key
+          @metadata.foreign_key
+        end
+
+        def key
+          @metadata.primary_key
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/eager/has_many.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Eager
+
+      class HasMany < Base
+
+        def preload
+          @docs.each do |d|
+            set_relation(d, [])
+          end
+
+          entries = Hash.new { |hash, key| hash[key] = [] }
+          each_loaded_document do |doc|
+            fk = doc.send(key)
+            entries[fk] << doc
+          end
+
+          entries.each do |id, docs|
+            set_on_parent(id, docs)
+          end
+        end
+
+        def set_relation(doc, element)
+          doc.__build__(@metadata.name, element, @metadata)
+        end
+
+        def group_by_key
+          @metadata.primary_key
+        end
+
+        def key
+          @metadata.foreign_key
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/eager/has_one.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Mongoid
+  module Relations
+    module Eager
+
+      class HasOne < Base
+
+        def preload
+          @docs.each do |d|
+            set_relation(d, nil)
+          end
+
+          each_loaded_document do |doc|
+            id = doc.send(key)
+            set_on_parent(id, doc)
+          end
+        end
+
+        def group_by_key
+          @metadata.primary_key
+        end
+
+        def key
+          @metadata.foreign_key
+        end
+
+      end
+    end
+  end
+end

data/lib/mongoid/relations/embedded/batchable.rb

@@ -6,7 +6,7 @@ module Mongoid
       # Contains behaviour for executing operations in batch on embedded
       # documents.
       module Batchable
-        include Mongoid::Atomic::Positionable
+        include Positional
 
         # Insert new documents as a batch push ($pushAll). This ensures that
         # all callbacks are run at the appropriate time and only 1 request is
@@ -198,9 +198,9 @@ module Mongoid
         def normalize_docs(docs)
           if docs.first.is_a?(::Hash)
             docs.map do |doc|
-              attributes = { metadata: metadata, _parent: base }
+              attributes = { __metadata: __metadata, _parent: base }
               attributes.merge!(doc)
-              Factory.build(klass, attributes, base.send(:mass_assignment_options))
+              Factory.build(klass, attributes)
             end
           else
             docs
@@ -296,7 +296,7 @@ module Mongoid
           docs.map do |doc|
             self.path = doc.atomic_path unless path
             execute_callback :before_remove, doc
-            if !_assigning? && !metadata.versioned?
+            unless _assigning?
               doc.cascade!
               doc.run_before_callbacks(:destroy) if method == :destroy
             end
@@ -346,7 +346,6 @@ module Mongoid
             doc.run_after_callbacks(:destroy) if method == :destroy
             doc.freeze
             doc.destroyed = true
-            IdentityMap.remove(doc)
           end
         end
       end

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

@@ -61,7 +61,7 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def binding
-          Bindings::Embedded::In.new(base, target, metadata)
+          Bindings::Embedded::In.new(base, target, __metadata)
         end
 
         # Characterize the document.
@@ -73,8 +73,8 @@ module Mongoid
         #
         # @since 2.1.0
         def characterize_one(document)
-          unless base.metadata
-            base.metadata = metadata.inverse_metadata(document)
+          unless base.__metadata
+            base.__metadata = __metadata.inverse_metadata(document)
           end
         end
 
@@ -209,7 +209,7 @@ module Mongoid
           #
           # @since 2.1.0
           def valid_options
-            [ :autobuild, :cyclic, :polymorphic ]
+            [ :autobuild, :cyclic, :polymorphic, :touch ]
           end
 
           # Get the default validation setting for the relation. Determines if

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

@@ -71,7 +71,6 @@ module Mongoid
         #
         # @overload build(attributes = {}, options = {}, type = nil)
         #   @param [ Hash ] attributes The attributes to build the document with.
-        #   @param [ Hash ] options The scoped assignment options.
         #   @param [ Class ] type Optional class to build the document with.
         #
         # @overload build(attributes = {}, type = nil)
@@ -79,11 +78,8 @@ module Mongoid
         #   @param [ Class ] type Optional class to build the document with.
         #
         # @return [ Document ] The new document.
-        def build(attributes = {}, options = {}, type = nil)
-          if options.is_a?(Class)
-            options, type = {}, options
-          end
-          doc = Factory.build(type || metadata.klass, attributes, options)
+        def build(attributes = {}, type = nil)
+          doc = Factory.build(type || __metadata.klass, attributes)
           append(doc)
           doc.apply_post_processed_defaults
           yield(doc) if block_given?
@@ -133,13 +129,9 @@ module Mongoid
           execute_callback :before_remove, document
           doc = target.delete_one(document)
           if doc && !_binding?
-            _unscoped.delete_one(doc) unless doc.paranoid?
+            _unscoped.delete_one(doc)
             if _assigning?
-              if doc.paranoid?
-                doc.destroy(suppress: true)
-              else
-                base.add_atomic_pull(doc)
-              end
+              base.add_atomic_pull(doc)
             else
               doc.delete(suppress: true)
               unbind_one(doc)
@@ -150,18 +142,6 @@ module Mongoid
           doc
         end
 
-        # For use only with Mongoid::Paranoia - will be removed in 4.0.
-        #
-        # @example Get the deleted documents from the relation.
-        #   person.paranoid_phones.deleted
-        #
-        # @return [ Criteria ] The deleted documents.
-        #
-        # @since 3.0.10
-        def deleted
-          unscoped.deleted
-        end
-
         # Delete all the documents in the association without running callbacks.
         #
         # @example Delete all documents from the relation.
@@ -228,10 +208,10 @@ module Mongoid
         # methods.
         #
         # @example Find a document by its id.
-        #   person.addresses.find(Moped::BSON::ObjectId.new)
+        #   person.addresses.find(BSON::ObjectId.new)
         #
         # @example Find documents for multiple ids.
-        #   person.addresses.find([ Moped::BSON::ObjectId.new, Moped::BSON::ObjectId.new ])
+        #   person.addresses.find([ BSON::ObjectId.new, BSON::ObjectId.new ])
         #
         # @param [ Array<Object> ] args Various arguments.
         #
@@ -361,7 +341,7 @@ module Mongoid
         #
         # @since 2.0.0.rc.1
         def binding
-          Bindings::Embedded::Many.new(base, target, metadata)
+          Bindings::Embedded::Many.new(base, target, __metadata)
         end
 
         # Returns the criteria object for the target class with its documents set
@@ -375,7 +355,9 @@ module Mongoid
           criterion = klass.scoped
           criterion.embedded = true
           criterion.documents = target
-          Many.apply_ordering(criterion, metadata)
+          criterion.parent_document = base
+          criterion.metadata = relation_metadata
+          Many.apply_ordering(criterion, __metadata)
         end
 
         # Deletes one document from the target and unscoped.
@@ -421,7 +403,7 @@ module Mongoid
         def method_missing(name, *args, &block)
           return super if target.respond_to?(name)
           klass.send(:with_scope, criteria) do
-            criteria.send(name, *args, &block)
+            criteria.public_send(name, *args, &block)
           end
         end
 
@@ -463,8 +445,8 @@ module Mongoid
         #
         # @since 2.4.0
         def scope(docs)
-          return docs unless metadata.order || metadata.klass.default_scoping?
-          crit = metadata.klass.order_by(metadata.order)
+          return docs unless __metadata.order || __metadata.klass.default_scoping?
+          crit = __metadata.klass.order_by(__metadata.order)
           crit.embedded = true
           crit.documents = docs
           crit.entries
@@ -635,7 +617,7 @@ module Mongoid
           # @since 2.1.0
           def valid_options
             [
-              :as, :cascade_callbacks, :cyclic, :order, :versioned, :store_as,
+              :as, :cascade_callbacks, :cyclic, :order, :store_as,
               :before_add, :after_add, :before_remove, :after_remove
             ]
           end