mongoid 7.3.2 → 7.4.0

data/lib/mongoid/contextual/mongo.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/contextual/atomic"
 require "mongoid/contextual/aggregable/mongo"
@@ -19,8 +18,6 @@ module Mongoid
       include Queryable
 
       # Options constant.
-      #
-      # @since 5.0.0
       OPTIONS = [ :hint,
                   :limit,
                   :skip,
@@ -44,8 +41,6 @@ module Mongoid
       #   context.cached?
       #
       # @return [ true, false ] If the context is cached.
-      #
-      # @since 3.0.0
       def cached?
         !!@cache
       end
@@ -67,8 +62,6 @@ 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_documents(options) }
@@ -99,8 +92,6 @@ module Mongoid
       #   context.delete
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def delete
         view.delete_many.deleted_count
       end
@@ -112,8 +103,6 @@ module Mongoid
       #   context.destroy
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def destroy
         each.inject(0) do |count, doc|
           doc.destroy
@@ -131,11 +120,20 @@ 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)).map do |value|
-          value.class.demongoize(value)
+        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
 
@@ -148,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|
@@ -172,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)
@@ -189,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
@@ -209,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)
@@ -231,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)
@@ -246,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)
@@ -271,8 +257,6 @@ module Mongoid
       #   is defined on the criteria.
       #
       # @return [ Document ] The first document.
-      #
-      # @since 3.0.0
       def first(opts = {})
         return documents.first if cached? && cache_loaded?
         try_cache(:first) do
@@ -294,8 +278,6 @@ 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
@@ -323,8 +305,6 @@ module Mongoid
       # @return [ GeoNear ] The GeoNear command.
       #
       # @deprecated
-      #
-      # @since 3.1.0
       def geo_near(coordinates)
         GeoNear.new(collection, criteria, coordinates)
       end
@@ -359,8 +339,6 @@ 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.collection
@@ -386,8 +364,6 @@ module Mongoid
       #
       # @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 last(opts = {})
         try_cache(:last) do
           with_inverse_sorting(opts) do
@@ -405,8 +381,6 @@ module Mongoid
       #   context.length
       #
       # @return [ Integer ] The number of documents.
-      #
-      # @since 3.0.0
       def length
         @length ||= self.count
       end
@@ -420,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
@@ -435,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
@@ -453,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
@@ -477,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
@@ -492,8 +473,6 @@ module Mongoid
       #   pairs.
       #
       # @return [ Mongo ] The context.
-      #
-      # @since 3.0.0
       def sort(values = nil, &block)
         if block_given?
           super(&block)
@@ -517,8 +496,6 @@ module Mongoid
       #   an update should apply.
       #
       # @return [ nil, false ] False if no attributes were provided.
-      #
-      # @since 3.0.0
       def update(attributes = nil, opts = {})
         update_documents(attributes, :update_one, opts)
       end
@@ -535,8 +512,6 @@ module Mongoid
       #   an update should apply.
       #
       # @return [ nil, false ] False if no attributes were provided.
-      #
-      # @since 3.0.0
       def update_all(attributes = nil, opts = {})
         update_documents(attributes, :update_many, opts)
       end
@@ -548,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
@@ -572,8 +545,6 @@ 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, opts = {})
         return false unless attributes
         attributes = Hash[attributes.map { |k, v| [klass.database_field_name(k.to_s), v] }]
@@ -586,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)
@@ -600,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|
@@ -618,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)
@@ -632,8 +597,6 @@ module Mongoid
       #
       # @example Apply the inverse sorting params to the given block
       #   context.with_inverse_sorting
-      #
-      # @since 3.0.0
       def with_inverse_sorting(opts = {})
         begin
           if sort = criteria.options[:sort] || ( { _id: 1 } unless opts[:id_sort] == :none )
@@ -653,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
@@ -668,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
@@ -682,8 +641,6 @@ module Mongoid
       #   context.documents
       #
       # @return [ Array<Document> ] The documents.
-      #
-      # @since 3.0.0
       def documents
         @documents ||= []
       end
@@ -702,8 +659,6 @@ 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?
@@ -721,8 +676,6 @@ 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)
@@ -739,6 +692,107 @@ module Mongoid
       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

data/lib/mongoid/contextual/none.rb

@@ -1,14 +1,38 @@
 # frozen_string_literal: true
-# encoding: utf-8
+
+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.
@@ -17,35 +41,31 @@ module Mongoid
       # @param [ Array ] other The other array.
       #
       # @return [ true, false ] If the objects are equal.
-      #
-      # @since 4.0.0
       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) }
@@ -57,23 +77,20 @@ 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.
       #
-      # @return [ Array ] Emtpy Array
+      # @return [ Array ] An empty Array.
       def pluck(*args)
         []
       end
@@ -84,34 +101,31 @@ module Mongoid
       #   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 last document in null context.
       #   context.last
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 4.0.0
       def last; 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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -16,8 +15,6 @@ module Mongoid
       #   context.blank?
       #
       # @return [ true, false ] If the context is empty.
-      #
-      # @since 3.0.0
       def blank?
         !exists?
       end

data/lib/mongoid/contextual.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/contextual/queryable"
 require "mongoid/contextual/mongo"
@@ -32,8 +31,6 @@ module Mongoid
     #   criteria.context
     #
     # @return [ Memory, Mongo ] The context.
-    #
-    # @since 3.0.0
     def context
       @context ||= create_context
     end
@@ -49,8 +46,6 @@ module Mongoid
     #   contextual.create_context
     #
     # @return [ Mongo, Memory ] The context.
-    #
-    # @since 3.0.0
     def create_context
       return None.new(self) if empty_and_chainable?
       embedded ? Memory.new(self) : Mongo.new(self)

data/lib/mongoid/copyable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
@@ -50,8 +49,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)
@@ -67,8 +64,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)