mongoid 5.4.1 → 7.4.0

data/lib/mongoid/contextual/mongo.rb

@@ -1,29 +1,30 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/contextual/atomic"
 require "mongoid/contextual/aggregable/mongo"
 require "mongoid/contextual/command"
 require "mongoid/contextual/geo_near"
 require "mongoid/contextual/map_reduce"
-require "mongoid/relations/eager"
+require "mongoid/association/eager_loadable"
 
 module Mongoid
   module Contextual
     class Mongo
+      extend Forwardable
       include Enumerable
       include Aggregable::Mongo
       include Atomic
-      include Relations::Eager
+      include Association::EagerLoadable
       include Queryable
 
       # Options constant.
-      #
-      # @since 5.0.0
       OPTIONS = [ :hint,
                   :limit,
                   :skip,
                   :sort,
                   :batch_size,
                   :max_scan,
+                  :max_time_ms,
                   :snapshot,
                   :comment,
                   :read,
@@ -40,8 +41,6 @@ module Mongoid
       #   context.cached?
       #
       # @return [ true, false ] If the context is cached.
-      #
-      # @since 3.0.0
       def cached?
         !!@cache
       end
@@ -63,11 +62,28 @@ module Mongoid
       #   into the count.
       #
       # @return [ Integer ] The number of matches.
-      #
-      # @since 3.0.0
       def count(options = {}, &block)
         return super(&block) if block_given?
-        try_cache(:count) { view.count(options) }
+        try_cache(:count) { view.count_documents(options) }
+      end
+
+      # Get the estimated number of documents matching the query.
+      #
+      # Unlike count, estimated_count does not take a block because it is not
+      # traditionally defined (with a block) on Enumarable like count is.
+      #
+      # @example Get the estimated number of matching documents.
+      #   context.estimated_count
+      #
+      # @param [ Hash ] options The options, such as maxTimeMS to be factored
+      #   into the count.
+      #
+      # @return [ Integer ] The number of matches.
+      def estimated_count(options = {})
+        unless self.criteria.selector.empty?
+          raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass)
+        end
+        try_cache(:estimated_count) { view.estimated_document_count(options) }
       end
 
       # Delete all documents in the database that match the selector.
@@ -76,8 +92,6 @@ module Mongoid
       #   context.delete
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def delete
         view.delete_many.deleted_count
       end
@@ -89,12 +103,11 @@ module Mongoid
       #   context.destroy
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def destroy
         each.inject(0) do |count, doc|
           doc.destroy
-          count += 1
+          count += 1 if acknowledged_write?
+          count
         end
       end
       alias :destroy_all :destroy
@@ -107,10 +120,21 @@ module Mongoid
       # @param [ String, Symbol ] field The name of the field.
       #
       # @return [ Array<Object> ] The distinct values for the field.
-      #
-      # @since 3.0.0
       def distinct(field)
-        view.distinct(klass.database_field_name(field))
+        name = if Mongoid.legacy_pluck_distinct
+          klass.database_field_name(field)
+        else
+          klass.cleanse_localized_field_names(field)
+        end
+
+        view.distinct(name).map do |value|
+          if Mongoid.legacy_pluck_distinct
+            value.class.demongoize(value)
+          else
+            is_translation = "#{name}_translations" == field.to_s
+            recursive_demongoize(name, value, is_translation)
+          end
+        end
       end
 
       # Iterate over the context. If provided a block, yield to a Mongoid
@@ -122,8 +146,6 @@ module Mongoid
       #   end
       #
       # @return [ Enumerator ] The enumerator.
-      #
-      # @since 3.0.0
       def each(&block)
         if block_given?
           documents_for_iteration.each do |doc|
@@ -146,8 +168,6 @@ module Mongoid
       #   used to determine the value.
       #
       # @return [ true, false ] If the count is more than zero.
-      #
-      # @since 3.0.0
       def exists?
         return !documents.empty? if cached? && cache_loaded?
         return @count > 0 if instance_variable_defined?(:@count)
@@ -163,8 +183,6 @@ module Mongoid
       #   Band.where(name: "Depeche Mode").explain
       #
       # @return [ Hash ] The explain result.
-      #
-      # @since 3.0.0
       def explain
         view.explain
       end
@@ -183,8 +201,6 @@ module Mongoid
       # @option options [ true, false ] :upsert Create the document if it doesn't exist.
       #
       # @return [ Document ] The result of the command.
-      #
-      # @since 5.0.0
       def find_one_and_update(update, options = {})
         if doc = view.find_one_and_update(update, options)
           Factory.from_db(klass, doc)
@@ -205,8 +221,6 @@ module Mongoid
       # @option options [ true, false ] :upsert Create the document if it doesn't exist.
       #
       # @return [ Document ] The result of the command.
-      #
-      # @since 5.0.0
       def find_one_and_replace(replacement, options = {})
         if doc = view.find_one_and_replace(replacement, options)
           Factory.from_db(klass, doc)
@@ -220,8 +234,6 @@ module Mongoid
       #   context.find_one_and_delete
       #
       # @return [ Document ] The result of the command.
-      #
-      # @since 5.0.0
       def find_one_and_delete
         if doc = view.find_one_and_delete
           Factory.from_db(klass, doc)
@@ -233,21 +245,31 @@ module Mongoid
       # @example Get the first document.
       #   context.first
       #
-      # @note Mongoid previously added an _id sort when no sort parameters were
-      #   provided explicitly by the user. This caused bad performance issues
-      #   and was not expected, so #first/#last will no longer guarantee order
-      #   if no sorting parameters are provided. For order guarantees - a sort
-      #   must be explicitly provided.
+      # @note Automatically adding a sort on _id when no other sort is
+      #   defined on the criteria has the potential to cause bad performance issues.
+      #   If you experience unexpected poor performance when using #first or #last
+      #   and have no sort defined on the criteria, use the option { id_sort: :none }.
+      #   Be aware that #first/#last won't guarantee order in this case.
       #
-      # @return [ Document ] The first document.
+      # @param [ Hash ] opts The options for the query returning the first document.
+      #
+      # @option opts [ :none ] :id_sort Don't apply a sort on _id if no other sort
+      #   is defined on the criteria.
       #
-      # @since 3.0.0
-      def first
+      # @return [ Document ] The first document.
+      def first(opts = {})
         return documents.first if cached? && cache_loaded?
         try_cache(:first) do
-          if raw_doc = view.limit(-1).first
-            doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
-            eager_load([doc]).first
+          if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none)
+            if raw_doc = view.sort(sort).limit(1).first
+              doc = Factory.from_db(klass, raw_doc, criteria)
+              eager_load([doc]).first
+            end
+          else
+            if raw_doc = view.limit(1).first
+              doc = Factory.from_db(klass, raw_doc, criteria)
+              eager_load([doc]).first
+            end
           end
         end
       end
@@ -256,12 +278,10 @@ module Mongoid
       # Return the first result without applying sort
       #
       # @api private
-      #
-      # @since 4.0.2
       def find_first
         return documents.first if cached? && cache_loaded?
         if raw_doc = view.first
-          doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+          doc = Factory.from_db(klass, raw_doc, criteria)
           eager_load([doc]).first
         end
       end
@@ -284,7 +304,7 @@ module Mongoid
       #
       # @return [ GeoNear ] The GeoNear command.
       #
-      # @since 3.1.0
+      # @deprecated
       def geo_near(coordinates)
         GeoNear.new(collection, criteria, coordinates)
       end
@@ -319,37 +339,36 @@ module Mongoid
       #   Mongo.new(criteria)
       #
       # @param [ Criteria ] criteria The criteria.
-      #
-      # @since 3.0.0
       def initialize(criteria)
         @criteria, @klass, @cache = criteria, criteria.klass, criteria.options[:cache]
-        @collection = @klass.with(criteria.persistence_options || {}).collection
+        @collection = @klass.collection
         criteria.send(:merge_type_selection)
-        @view = collection.find(criteria.selector)
+        @view = collection.find(criteria.selector, session: _session)
         apply_options
       end
 
-      delegate(:database_field_name, to: :@klass)
+      def_delegator :@klass, :database_field_name
 
       # Get the last document in the database for the criteria's selector.
       #
       # @example Get the last document.
       #   context.last
       #
-      # @note Mongoid previously added an _id sort when no sort parameters were
-      #   provided explicitly by the user. This caused bad performance issues
-      #   and was not expected, so #first/#last will no longer guarantee order
-      #   if no sorting parameters are provided. For order guarantees - a sort
-      #   must be explicitly provided.
+      # @note Automatically adding a sort on _id when no other sort is
+      #   defined on the criteria has the potential to cause bad performance issues.
+      #   If you experience unexpected poor performance when using #first or #last
+      #   and have no sort defined on the criteria, use the option { id_sort: :none }.
+      #   Be aware that #first/#last won't guarantee order in this case.
       #
-      # @return [ Document ] The last document.
+      # @param [ Hash ] opts The options for the query returning the first document.
       #
-      # @since 3.0.0
-      def last
+      # @option opts [ :none ] :id_sort Don't apply a sort on _id if no other sort
+      #   is defined on the criteria.
+      def last(opts = {})
         try_cache(:last) do
-          with_inverse_sorting do
-            if raw_doc = view.limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+          with_inverse_sorting(opts) do
+            if raw_doc = view.limit(1).first
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           end
@@ -362,8 +381,6 @@ module Mongoid
       #   context.length
       #
       # @return [ Integer ] The number of documents.
-      #
-      # @since 3.0.0
       def length
         @length ||= self.count
       end
@@ -377,8 +394,6 @@ module Mongoid
       # @param [ Integer ] value The number of documents to return.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def limit(value)
         @view = view.limit(value) and self
       end
@@ -392,8 +407,6 @@ module Mongoid
       # @param [ String ] reduce The reduce js function.
       #
       # @return [ MapReduce ] The map/reduce lazy wrapper.
-      #
-      # @since 3.0.0
       def map_reduce(map, reduce)
         MapReduce.new(collection, criteria, map, reduce)
       end
@@ -410,17 +423,30 @@ module Mongoid
       # @param [ String, Symbol, Array ] fields Fields to pluck.
       #
       # @return [ Array<Object, Array> ] The plucked values.
-      #
-      # @since 3.1.0
       def pluck(*fields)
+        # Multiple fields can map to the same field name. For example, plucking
+        # a field and its _translations field map to the same field in the database.
+        # because of this, we need to keep track of the fields requested.
+        normalized_field_names = []
         normalized_select = fields.inject({}) do |hash, f|
-          hash[klass.database_field_name(f)] = 1
+          db_fn = klass.database_field_name(f)
+          normalized_field_names.push(db_fn)
+
+          if Mongoid.legacy_pluck_distinct
+            hash[db_fn] = true
+          else
+            hash[klass.cleanse_localized_field_names(f)] = true
+          end
           hash
         end
 
         view.projection(normalized_select).reduce([]) do |plucked, doc|
-          values = normalized_select.keys.map do |n|
-            n =~ /\./ ? doc[n.partition('.')[0]] : doc[n]
+          values = normalized_field_names.map do |n|
+            if Mongoid.legacy_pluck_distinct
+              n.include?('.') ? doc[n.partition('.')[0]] : doc[n]
+            else
+              extract_value(doc, n)
+            end
           end
           plucked << (values.size == 1 ? values.first : values)
         end
@@ -434,8 +460,6 @@ module Mongoid
       # @param [ Integer ] value The number of documents to skip.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def skip(value)
         @view = view.skip(value) and self
       end
@@ -449,8 +473,6 @@ module Mongoid
       #   pairs.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def sort(values = nil, &block)
         if block_given?
           super(&block)
@@ -468,12 +490,14 @@ module Mongoid
       #   context.update({ "$set" => { name: "Smiths" }})
       #
       # @param [ Hash ] attributes The new attributes for the document.
+      # @param [ Hash ] opts The update operation options.
       #
-      # @return [ nil, false ] False if no attributes were provided.
+      # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
+      #   an update should apply.
       #
-      # @since 3.0.0
-      def update(attributes = nil)
-        update_documents(attributes)
+      # @return [ nil, false ] False if no attributes were provided.
+      def update(attributes = nil, opts = {})
+        update_documents(attributes, :update_one, opts)
       end
 
       # Update all the matching documents atomically.
@@ -482,12 +506,14 @@ module Mongoid
       #   context.update_all({ "$set" => { name: "Smiths" }})
       #
       # @param [ Hash ] attributes The new attributes for each document.
+      # @param [ Hash ] opts The update operation options.
       #
-      # @return [ nil, false ] False if no attributes were provided.
+      # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
+      #   an update should apply.
       #
-      # @since 3.0.0
-      def update_all(attributes = nil)
-        update_documents(attributes, :update_many)
+      # @return [ nil, false ] False if no attributes were provided.
+      def update_all(attributes = nil, opts = {})
+        update_documents(attributes, :update_many, opts)
       end
 
       private
@@ -497,8 +523,6 @@ module Mongoid
       # @param [ String, Symbol ] key The instance variable name
       #
       # @return the result of the block
-      #
-      # @since 3.1.4
       def try_cache(key, &block)
         unless cached?
           yield
@@ -521,12 +545,10 @@ module Mongoid
       # @param [ Symbol ] method The method to use.
       #
       # @return [ true, false ] If the update succeeded.
-      #
-      # @since 3.0.4
-      def update_documents(attributes, method = :update_one)
+      def update_documents(attributes, method = :update_one, opts = {})
         return false unless attributes
         attributes = Hash[attributes.map { |k, v| [klass.database_field_name(k.to_s), v] }]
-        view.send(method, attributes.__consolidate__(klass))
+        view.send(method, attributes.__consolidate__(klass), opts)
       end
 
       # Apply the field limitations.
@@ -535,8 +557,6 @@ module Mongoid
       #
       # @example Apply the field limitations.
       #   context.apply_fields
-      #
-      # @since 3.0.0
       def apply_fields
         if spec = criteria.options[:fields]
           @view = view.projection(spec)
@@ -549,8 +569,6 @@ module Mongoid
       #
       # @example Apply all options.
       #   context.apply_options
-      #
-      # @since 3.1.0
       def apply_options
         apply_fields
         OPTIONS.each do |name|
@@ -567,8 +585,6 @@ module Mongoid
       #
       # @example Apply the skip option.
       #   context.apply_option(:skip)
-      #
-      # @since 3.1.0
       def apply_option(name)
         if spec = criteria.options[name]
           @view = view.send(name, spec)
@@ -581,12 +597,10 @@ module Mongoid
       #
       # @example Apply the inverse sorting params to the given block
       #   context.with_inverse_sorting
-      #
-      # @since 3.0.0
-      def with_inverse_sorting
+      def with_inverse_sorting(opts = {})
         begin
-          if spec = criteria.options[:sort]
-            @view = view.sort(Hash[spec.map{|k, v| [k, -1*v]}])
+          if sort = criteria.options[:sort] || ( { _id: 1 } unless opts[:id_sort] == :none )
+            @view = view.sort(Hash[sort.map{|k, v| [k, -1*v]}])
           end
           yield
         ensure
@@ -602,8 +616,6 @@ module Mongoid
       #   context.cacheable?
       #
       # @return [ true, false ] If caching, and the cache isn't loaded.
-      #
-      # @since 3.0.0
       def cacheable?
         cached? && !cache_loaded?
       end
@@ -617,8 +629,6 @@ module Mongoid
       #   context.cache_loaded?
       #
       # @return [ true, false ] If the cache is loaded.
-      #
-      # @since 3.0.0
       def cache_loaded?
         !!@cache_loaded
       end
@@ -631,8 +641,6 @@ module Mongoid
       #   context.documents
       #
       # @return [ Array<Document> ] The documents.
-      #
-      # @since 3.0.0
       def documents
         @documents ||= []
       end
@@ -651,12 +659,10 @@ module Mongoid
       #   context.documents_for_iteration
       #
       # @return [ Array<Document>, Mongo::Collection::View ] The docs to iterate.
-      #
-      # @since 3.0.0
       def documents_for_iteration
         return documents if cached? && !documents.empty?
         return view unless eager_loadable?
-        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
+        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria) }
         eager_load(docs)
       end
 
@@ -670,14 +676,123 @@ module Mongoid
       #   end
       #
       # @param [ Document ] document The document to yield to.
-      #
-      # @since 3.0.0
       def yield_document(document, &block)
         doc = document.respond_to?(:_id) ?
-            document : Factory.from_db(klass, document, criteria.options[:fields])
+            document : Factory.from_db(klass, document, criteria)
         yield(doc)
         documents.push(doc) if cacheable?
       end
+
+      private
+
+      def _session
+        @criteria.send(:_session)
+      end
+
+      def acknowledged_write?
+        collection.write_concern.nil? || collection.write_concern.acknowledged?
+      end
+
+      # Extracts the value for the given field name from the given attribute
+      # hash.
+      #
+      # @param [ Hash ] attrs The attributes hash.
+      # @param [ String ] field_name The name of the field to extract.
+      #
+      # @param [ Object ] The value for the given field name
+      def extract_value(attrs, field_name)
+        def fetch_and_demongoize(d, meth, klass)
+          res = d.try(:fetch, meth, nil)
+          if field = klass.fields[meth]
+            field.demongoize(res)
+          else
+            res.class.demongoize(res)
+          end
+        end
+
+        k = klass
+        meths = field_name.split('.')
+        meths.each_with_index.inject(attrs) do |curr, (meth, i)|
+          is_translation = false
+          if !k.fields.key?(meth) && !k.relations.key?(meth)
+            if tr = meth.match(/(.*)_translations\z/)&.captures&.first
+              is_translation = true
+              meth = tr
+            end
+          end
+
+          # 1. If curr is an array fetch from all elements in the array.
+          # 2. If the field is localized, and is not an _translations field
+          #    (_translations fields don't show up in the fields hash).
+          #    - If this is the end of the methods, return the translation for
+          #      the current locale.
+          #    - Otherwise, return the whole translations hash so the next method
+          #      can select the language it wants.
+          # 3. If the meth is an _translations field, do not demongoize the
+          #    value so the full hash is returned.
+          # 4. Otherwise, fetch and demongoize the value for the key meth.
+          if curr.is_a? Array
+            res = curr.map { |x| fetch_and_demongoize(x, meth, k) }
+            res.empty? ? nil : res
+          elsif !is_translation && k.fields[meth]&.localized?
+            if i < meths.length-1
+              curr.try(:fetch, meth, nil)
+            else
+              fetch_and_demongoize(curr, meth, k)
+            end
+          elsif is_translation
+            curr.try(:fetch, meth, nil)
+          else
+            fetch_and_demongoize(curr, meth, k)
+          end.tap do
+            if as = k.try(:aliased_associations)
+              if a = as.fetch(meth, nil)
+                meth = a
+              end
+            end
+
+            if relation = k.relations[meth]
+              k = relation.klass
+            end
+          end
+        end
+      end
+
+      # Recursively demongoize the given value. This method recursively traverses
+      # the class tree to find the correct field to use to demongoize the value.
+      #
+      # @param [ String ] field_name The name of the field to demongoize.
+      # @param [ Object ] value The value to demongoize.
+      # @param [ Boolean ] is_translation The field we are retrieving is an
+      #   _translations field.
+      #
+      # @return [ Object ] The demongoized value.
+      def recursive_demongoize(field_name, value, is_translation)
+        k = klass
+        field_name.split('.').each do |meth|
+          if as = k.try(:aliased_associations)
+            if a = as.fetch(meth, nil)
+              meth = a.to_s
+            end
+          end
+
+          if relation = k.relations[meth]
+            k = relation.klass
+          elsif field = k.fields[meth]
+            # If it's a localized field that's not a hash, don't demongoize
+            # again, we already have the translation. If it's an _translation
+            # field, don't demongoize, we want the full hash not just a
+            # specific translation.
+            if field.localized? && (!value.is_a?(Hash) || is_translation)
+              return value.class.demongoize(value)
+            else
+              return field.demongoize(value)
+            end
+          else
+            return value.class.demongoize(value)
+          end
+        end
+      end
     end
   end
 end