mongoid 7.0.13 → 8.0.8

data/lib/mongoid/contextual/none.rb

@@ -1,12 +1,38 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "mongoid/contextual/aggregable/none"
+
 module Mongoid
   module Contextual
     class None
       include Enumerable
+      alias :old_sum :sum
+
+      include Aggregable::None
       include Queryable
 
       attr_reader :criteria, :klass
 
+      alias :new_sum :sum
+
+      # Get the sum in the null context.
+      #
+      # @example Get the sum of null context.
+      #     context.sum(_field)
+      #
+      # @param [ Symbol ] _field The field to sum.
+      #
+      # @return [ Integer | Symbol ] If Mongoid.broken_aggregables is
+      #   set to false, this will always be zero. Otherwise, it will return the
+      #   field name as a symbol.
+      def sum(_field = nil)
+        if Mongoid.broken_aggregables
+          old_sum(_field)
+        else
+          new_sum(_field)
+        end
+      end
+
       # Check if the context is equal to the other object.
       #
       # @example Check equality.
@@ -14,36 +40,32 @@ module Mongoid
       #
       # @param [ Array ] other The other array.
       #
-      # @return [ true, false ] If the objects are equal.
-      #
-      # @since 4.0.0
+      # @return [ true | false ] If the objects are equal.
       def ==(other)
         other.is_a?(None)
       end
 
-      # Allow distinct for null context.
+      # Get the distinct field values in null context.
       #
-      # @example Get the distinct values.
+      # @example Get the distinct values in null context.
       #   context.distinct(:name)
       #
-      # @param [ String, Symbol ] field the name of the field.
+      # @param [ String | Symbol ] _field The name of the field.
       #
-      # @return [ Array ] Empty Array
-      def distinct(field)
+      # @return [ Array ] An empty Array.
+      def distinct(_field)
         []
       end
 
       # Iterate over the null context. There are no documents to iterate over
       # in this case.
       #
-      # @example Iterate over the context.
+      # @example Iterate over the null context.
       #   context.each do |doc|
       #     puts doc.name
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 4.0.0
       def each
         if block_given?
           [].each { |doc| yield(doc) }
@@ -55,61 +77,117 @@ module Mongoid
 
       # Do any documents exist for the context.
       #
-      # @example Do any documents exist for the context.
+      # @example Do any documents exist in the null context.
       #   context.exists?
       #
-      # @return [ true, false ] If the count is more than zero.
-      #
-      # @since 4.0.0
+      # @return [ false ] Always false.
       def exists?; false; end
 
-
-      # Allow pluck for null context.
+      # Pluck the field values in null context.
       #
-      # @example Allow pluck for null context.
+      # @example Get the values for null context.
       #   context.pluck(:name)
       #
-      # @param [ String, Symbol, Array ] args Field or fields to pluck.
+      # @param [ String | Symbol ] *_fields Field(s) to pluck.
       #
-      # @return [ Array ] Emtpy Array
-      def pluck(*args)
+      # @return [ Array ] An empty Array.
+      def pluck(*_fields)
         []
       end
 
+      # Pick the field values in null context.
+      #
+      # @example Get the value for null context.
+      #   context.pick(:name)
+      #
+      # @param [ String | Symbol ] *_fields Field or fields to pick.
+      #
+      # @return [ nil ] Always reeturn nil.
+      def pick(*_fields)
+        nil
+      end
+
+      # Tally the field values in null context.
+      #
+      # @example Get the values for null context.
+      #   context.tally(:name)
+      #
+      # @param [ String | Symbol ] _field Field to tally.
+      #
+      # @return [ Hash ] An empty Hash.
+      def tally(_field)
+        {}
+      end
+
       # Create the new null context.
       #
       # @example Create the new context.
       #   Null.new(criteria)
       #
       # @param [ Criteria ] criteria The criteria.
-      #
-      # @since 4.0.0
       def initialize(criteria)
         @criteria, @klass = criteria, criteria.klass
       end
 
       # Always returns nil.
       #
-      # @example Get the last document.
+      # @example Get the first document in null context.
+      #   context.first
+      #
+      # @param [ Integer ] limit The number of documents to return.
+      #
+      # @return [ nil ] Always nil.
+      def first(limit = nil)
+        [] unless limit.nil?
+      end
+
+      # Always returns nil.
+      #
+      # @example Get the last document in null context.
       #   context.last
       #
+      # @param [ Integer ] limit The number of documents to return.
+      #
       # @return [ nil ] Always nil.
+      def last(limit = nil)
+        [] unless limit.nil?
+      end
+
+      # Returns nil or empty array.
+      #
+      # @example Take a document in null context.
+      #   context.take
       #
-      # @since 4.0.0
-      def last; nil; end
+      # @param [ Integer | nil ] limit The number of documents to take or nil.
+      #
+      # @return [ [] | nil ] Empty array or nil.
+      def take(limit = nil)
+        limit ? [] : nil
+      end
+
+      # Always raises an error.
+      #
+      # @example Take a document in null context.
+      #   context.take!
+      #
+      # @raises [ Mongoid::Errors::DocumentNotFound ] always raises.
+      def take!
+        raise Errors::DocumentNotFound.new(klass, nil, nil)
+      end
 
       # Always returns zero.
       #
-      # @example Get the length of matching documents.
+      # @example Get the length of null context.
       #   context.length
       #
       # @return [ Integer ] Always zero.
-      #
-      # @since 4.0.0
       def length
-        entries.length
+        Mongoid.broken_aggregables ? 0 : entries.length
       end
       alias :size :length
+
+      alias :find_first :first
+      alias :one :first
     end
   end
 end

data/lib/mongoid/contextual/queryable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     module Queryable
@@ -13,9 +14,7 @@ module Mongoid
       # @example Is the context empty?
       #   context.blank?
       #
-      # @return [ true, false ] If the context is empty.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the context is empty.
       def blank?
         !exists?
       end

data/lib/mongoid/contextual.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/contextual/queryable"
 require "mongoid/contextual/mongo"
 require "mongoid/contextual/memory"
@@ -6,21 +7,22 @@ require "mongoid/contextual/none"
 
 module Mongoid
   module Contextual
+    extend Forwardable
 
     # The aggregate operations provided in the aggregate module get delegated
     # through to the context from the criteria.
-    delegate(*Aggregable::Mongo.public_instance_methods(false), to: :context)
+    def_delegators :context, *Aggregable::Mongo.public_instance_methods(false)
 
     # The atomic operations provided in the atomic context get delegated
     # through to the context from the criteria.
-    delegate(*Atomic.public_instance_methods(false), to: :context)
+    def_delegators :context, *Atomic.public_instance_methods(false)
 
     # The methods in the contexts themselves should all get delegated to,
     # including destructive, modification, and optional methods.
-    delegate(*(Mongo.public_instance_methods(false) - [ :skip, :limit ]), to: :context)
+    def_delegators :context, *(Mongo.public_instance_methods(false) - [ :skip, :limit ])
 
     # This gets blank and empty included.
-    delegate(*Queryable.public_instance_methods(false), to: :context)
+    def_delegators :context, *Queryable.public_instance_methods(false)
 
     # Get the context in which criteria queries should execute. This is either
     # in memory (for embedded documents) or mongo (for root level documents.)
@@ -28,9 +30,7 @@ module Mongoid
     # @example Get the context.
     #   criteria.context
     #
-    # @return [ Memory, Mongo ] The context.
-    #
-    # @since 3.0.0
+    # @return [ Memory | Mongo ] The context.
     def context
       @context ||= create_context
     end
@@ -45,9 +45,7 @@ module Mongoid
     # @example Create the context.
     #   contextual.create_context
     #
-    # @return [ Mongo, Memory ] The context.
-    #
-    # @since 3.0.0
+    # @return [ Mongo | Memory ] The context.
     def create_context
       return None.new(self) if empty_and_chainable?
       embedded ? Memory.new(self) : Mongo.new(self)

data/lib/mongoid/copyable.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # This module contains the behaviour of Mongoid's clone/dup of documents.
+  # This module contains the behavior of Mongoid's clone/dup of documents.
   module Copyable
     extend ActiveSupport::Concern
 
@@ -9,7 +10,11 @@ module Mongoid
     # the exception of the document's id, and will reset all the
     # instance variables.
     #
-    # This clone also includes embedded documents.
+    # This clone also includes embedded documents. If there is an _id field in
+    # the embedded document, it will be maintained, unlike the root's _id.
+    #
+    # If cloning an embedded child, the embedded parent is not cloned and the
+    # embedded_in association is not set.
     #
     # @example Clone the document.
     #   document.clone
@@ -18,15 +23,42 @@ module Mongoid
     def clone
       # @note This next line is here to address #2704, even though having an
       # _id and id field in the document would cause problems with Mongoid
-      # elsewhere.
-      attrs = clone_document.except("_id", "id")
+      # elsewhere. Note this is only done on the root document as we want
+      # to maintain the same _id on the embedded documents.
+      attrs = clone_document.except(*self.class.id_fields)
+      Copyable.clone_with_hash(self.class, attrs)
+    end
+    alias :dup :clone
+
+    private
+
+    # Create clone of a document of the given klass with the given attributes
+    # hash. This is used recursively so that embedded associations are cloned
+    # safely.
+    #
+    # @param klass [ Class ] The class of the document to create.
+    # @param attrs [ Hash ] The hash of the attributes.
+    #
+    # @return [ Document ] The new document.
+    def self.clone_with_hash(klass, attrs)
       dynamic_attrs = {}
+      _attribute_names = klass.attribute_names
       attrs.reject! do |attr_name, value|
-        dynamic_attrs.merge!(attr_name => value) unless self.attribute_names.include?(attr_name)
+        unless _attribute_names.include?(attr_name)
+          dynamic_attrs[attr_name] = value
+          true
+        end
       end
-      self.class.new(attrs).tap do |object|
+
+      Factory.build(klass, attrs).tap do |object|
         dynamic_attrs.each do |attr_name, value|
-          if object.respond_to?("#{attr_name}=")
+          assoc = object.embedded_relations[attr_name]
+          if assoc&.one? && Hash === value
+            object.send("#{attr_name}=", clone_with_hash(assoc.klass, value))
+          elsif assoc&.many? && Array === value
+            docs = value.map { |h| clone_with_hash(assoc.klass, h) }
+            object.send("#{attr_name}=", docs)
+          elsif object.respond_to?("#{attr_name}=")
             object.send("#{attr_name}=", value)
           else
             object.attributes[attr_name] = value
@@ -34,9 +66,6 @@ module Mongoid
         end
       end
     end
-    alias :dup :clone
-
-    private
 
     # Clone the document attributes
     #
@@ -44,8 +73,6 @@ module Mongoid
     #
     # @example clone document
     #   model.clone_document
-    #
-    # @since 3.0.22
     def clone_document
       attrs = as_attributes.__deep_copy__
       process_localized_attributes(self, attrs)
@@ -61,8 +88,6 @@ module Mongoid
     #   model.process_localized_attributes(attributes)
     #
     # @param [ Hash ] attrs The attributes.
-    #
-    # @since 3.0.20
     def process_localized_attributes(klass, attrs)
       klass.localized_fields.keys.each do |name|
         if value = attrs.delete(name)
@@ -74,8 +99,8 @@ module Mongoid
 
         if association.is_a?(Association::Embedded::EmbedsMany)
           attrs[association.key].each do |attr|
-            embedded_klass = if type = attr['_type']
-              type.constantize
+            embedded_klass = if type = attr[self.class.discriminator_key]
+              association.relation_class.get_discriminator_mapping(type) || association.relation_class
             else
               association.relation_class
             end

data/lib/mongoid/criteria/findable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Findable
@@ -9,13 +10,11 @@ module Mongoid
       #   criteria.execute_or_raise(id)
       #
       # @param [ Object ] ids The arguments passed.
-      # @param [ true, false ] multi Whether there arguments were a list.
+      # @param [ true | false ] multi Whether there arguments were a list.
       #
       # @raise [ Errors::DocumentNotFound ] If nothing returned.
       #
-      # @return [ Document, Array<Document> ] The document(s).
-      #
-      # @since 2.0.0
+      # @return [ Document | Array<Document> ] The document(s).
       def execute_or_raise(ids, multi)
         result = multiple_from_db(ids)
         check_for_missing_documents!(result, ids)
@@ -24,17 +23,18 @@ module Mongoid
 
       # Find the matchind document(s) in the criteria for the provided ids.
       #
+      # @note Each argument can be an individual id, an array of ids or
+      #   a nested array. Each array will be flattened.
+      #
       # @example Find by an id.
       #   criteria.find(BSON::ObjectId.new)
       #
       # @example Find by multiple ids.
       #   criteria.find([ BSON::ObjectId.new, BSON::ObjectId.new ])
       #
-      # @param [ Array<BSON::ObjectId> ] args The ids to search for.
-      #
-      # @return [ Array<Document>, Document ] The matching document(s).
+      # @param [ Object | Array<Object> ] *args The ids to search for.
       #
-      # @since 1.0.0
+      # @return [ Document | Array<Document> ] The matching document(s).
       def find(*args)
         ids = args.__find_args__
         raise_invalid if ids.any?(&:nil?)
@@ -86,8 +86,6 @@ module Mongoid
       #   criteria.id_finder
       #
       # @return [ Symbol ] The name of the finder method.
-      #
-      # @since 3.1.0
       def id_finder
         @id_finder ||= extract_id ? :all_of : :where
       end
@@ -102,10 +100,16 @@ module Mongoid
       # @param [ Array<Object> ] ids The ids to fetch with.
       #
       # @return [ Array<Document> ] The matching documents.
-      #
-      # @since 3.0.0
       def from_database(ids)
-        (ids.size > 1 ? any_in(id: ids) : where(id: ids.first)).entries
+        from_database_selector(ids).entries
+      end
+
+      private def from_database_selector(ids)
+        if ids.size > 1
+          any_in(_id: ids)
+        else
+          where(_id: ids.first)
+        end
       end
 
       # Convert all the ids to their proper types.
@@ -118,11 +122,9 @@ module Mongoid
       # @param [ Array<Object> ] ids The ids to convert.
       #
       # @return [ Array<Object> ] The converted ids.
-      #
-      # @since 3.0.0
       def mongoize_ids(ids)
         ids.map do |id|
-          id = id[:id] if id.respond_to?(:keys) && id[:id]
+          id = id[:_id] if id.respond_to?(:keys) && id[:_id]
           klass.fields["_id"].mongoize(id)
         end
       end
@@ -133,8 +135,6 @@ module Mongoid
       #   criteria.raise_invalid
       #
       # @raise [ Errors::InvalidOptions ] The error.
-      #
-      # @since 2.0.0
       def raise_invalid
         raise Errors::InvalidFind.new
       end

data/lib/mongoid/criteria/includable.rb

@@ -1,15 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
 
     # Module providing functionality for parsing (nested) inclusion definitions.
     module Includable
 
-      # Eager loads all the provided relations. Will load all the documents
+      # Eager loads all the provided associations. Will load all the documents
       # into the identity map whose ids match based on the extra query for the
       # ids.
       #
-      # @note This will work for embedded relations that reference another
+      # @note This will work for embedded associations that reference another
       #   collection via belongs_to as well.
       #
       # @note Eager loading brings all the documents into memory, so there is a
@@ -17,42 +18,30 @@ module Mongoid
       #   eager loading becomes slower around 100k documents, but this will
       #   naturally depend on the specific application.
       #
-      # @example Eager load the provided relations.
+      # @example Eager load the provided associations.
       #   Person.includes(:posts, :game)
       #
-      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the relations to eager
+      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the associations to eager
       #   load.
       #
       # @return [ Criteria ] The cloned criteria.
-      #
-      # @since 2.2.0
       def includes(*relations)
-        extract_includes_list(klass, relations)
+        extract_includes_list(klass, nil, relations)
         clone
       end
 
       # Get a list of criteria that are to be executed for eager loading.
       #
-      # @example Get the eager loading inclusions.
-      #   Person.includes(:game).inclusions
-      #
       # @return [ Array<Association> ] The inclusions.
-      #
-      # @since 2.2.0
       def inclusions
         @inclusions ||= []
       end
 
       # Set the inclusions for the criteria.
       #
-      # @example Set the inclusions.
-      #   criteria.inclusions = [ association ]
-      #
       # @param [ Array<Association> ] value The inclusions.
       #
       # @return [ Array<Association> ] The new inclusions.
-      #
-      # @since 3.0.0
       def inclusions=(value)
         @inclusions = value
       end
@@ -61,32 +50,40 @@ module Mongoid
 
       # Add an inclusion definition to the list of inclusions for the criteria.
       #
-      # @example Add an inclusion.
-      #   criteria.add_inclusion(Person, :posts)
-      #
-      # @param [ Class, String, Symbol ] _klass The class or string/symbol of the class name.
-      # @param [ Symbol ] association The relation.
-      #
-      # @raise [ Errors::InvalidIncludes ] If no relation is found.
-      #
-      # @since 5.1.0
-      def add_inclusion(_klass, association)
-        inclusions.push(association) unless inclusions.include?(association)
+      # @param [ Association ] association The association.
+      # @param [ String ] parent The name of the association above this one in
+      #   the inclusion tree, if it is a nested inclusion.
+      def add_inclusion(association, parent = nil)
+        if assoc = inclusions.detect { |a| a == association }
+          assoc.parent_inclusions.push(parent) if parent
+        else
+          assoc = association.dup
+          assoc.parent_inclusions = []
+          assoc.parent_inclusions.push(parent) if parent
+          inclusions.push(assoc)
+        end
       end
 
-      def extract_includes_list(_parent_class, *relations_list)
+      # Iterate through the list of relations and create the inclusions list.
+      #
+      # @param [ Class | String | Symbol ] _parent_class The class from which the
+      #   association originates.
+      # @param [ String ] parent The name of the association above this one in
+      #   the inclusion tree, if it is a nested inclusion.
+      # @param relations_list The names of the associations to eager load.
+      def extract_includes_list(_parent_class, parent, *relations_list)
         relations_list.flatten.each do |relation_object|
           if relation_object.is_a?(Hash)
             relation_object.each do |relation, _includes|
               association = _parent_class.reflect_on_association(relation)
               raise Errors::InvalidIncludes.new(_klass, [ relation ]) unless association
-              add_inclusion(_parent_class, association)
-              extract_includes_list(association.klass, _includes)
+              add_inclusion(association, parent)
+              extract_includes_list(association.klass, association.name, _includes)
             end
           else
             association = _parent_class.reflect_on_association(relation_object)
             raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless association
-            add_inclusion(_parent_class, association)
+            add_inclusion(association, parent)
           end
         end
       end

data/lib/mongoid/criteria/inspectable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Inspectable
@@ -10,8 +11,6 @@ module Mongoid
       #   criteria.inspect
       #
       # @return [ String ] The inspection string.
-      #
-      # @since 1.0.0
       def inspect
 %Q{#<Mongoid::Criteria
   selector: #{selector.inspect}

data/lib/mongoid/criteria/marshalable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Marshalable
@@ -8,11 +9,12 @@ module Mongoid
       # @example Dump the criteria.
       #   Marshal.dump(criteria)
       #
-      # @return [ Array<Object> ] The dumped data.
+      # Note :mongo is written here for backwards compatibility with Mongoid 7
+      # and earlier.
       #
-      # @since 3.0.15
+      # @return [ Array<Object> ] The dumped data.
       def marshal_dump
-        data = [ klass, driver, inclusions, documents, strategy, negating ]
+        data = [ klass, :mongo, inclusions, documents, strategy, negating ]
         data.push(scoping_options).push(dump_hash(:selector)).push(dump_hash(:options))
       end
 
@@ -22,11 +24,14 @@ module Mongoid
       #   Marshal.load(criteria)
       #
       # @param [ Array ] data The raw data.
-      #
-      # @since 3.0.15
       def marshal_load(data)
         @scoping_options, raw_selector, raw_options = data.pop(3)
-        @klass, @driver, @inclusions, @documents, @strategy, @negating = data
+        @klass, driver, @inclusions, @documents, @strategy, @negating = data
+
+        if driver == :mongo1x
+          raise NotImplementedError, "Mongoid no longer supports marshalling with driver version 1.x."
+        end
+
         @selector = load_hash(Queryable::Selector, raw_selector)
         @options = load_hash(Queryable::Options, raw_options)
       end