mongoid 9.0.11 → 9.1.1

data/lib/mongoid/association/referenced/has_and_belongs_to_many.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/referenced/has_and_belongs_to_many/binding'
 require 'mongoid/association/referenced/has_and_belongs_to_many/buildable'
@@ -9,7 +8,6 @@ require 'mongoid/association/referenced/has_and_belongs_to_many/eager'
 module Mongoid
   module Association
     module Referenced
-
       # The HasAndBelongsToMany type association.
       class HasAndBelongsToMany
         include Relatable
@@ -19,21 +17,21 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        ASSOCIATION_OPTIONS = [
-            :after_add,
-            :after_remove,
-            :autosave,
-            :before_add,
-            :before_remove,
-            :counter_cache,
-            :dependent,
-            :foreign_key,
-            :index,
-            :order,
-            :primary_key,
-            :inverse_primary_key,
-            :inverse_foreign_key,
-            :scope,
+        ASSOCIATION_OPTIONS = %i[
+          after_add
+          after_remove
+          autosave
+          before_add
+          before_remove
+          counter_cache
+          dependent
+          foreign_key
+          index
+          order
+          primary_key
+          inverse_primary_key
+          inverse_foreign_key
+          scope
         ].freeze
 
         # The complete list of valid options for this association, including
@@ -50,7 +48,7 @@ module Mongoid
         # The default foreign key suffix.
         #
         # @return [ String ] '_ids'
-        FOREIGN_KEY_SUFFIX = '_ids'.freeze
+        FOREIGN_KEY_SUFFIX = '_ids'
 
         # The list of association complements.
         #
@@ -70,12 +68,16 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        def embedded?; false; end
+        def embedded?
+          false
+        end
 
         # The default for validation the association object.
         #
         # @return [ false ] Always false.
-        def validation_default; true; end
+        def validation_default
+          true
+        end
 
         # Are ids only saved on this side of the association?
         #
@@ -87,7 +89,9 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        def stores_foreign_key?; true; end
+        def stores_foreign_key?
+          true
+        end
 
         # Get the association proxy class for this association type.
         #
@@ -100,8 +104,11 @@ module Mongoid
         #
         # @return [ String ] The foreign key field for saving the association reference.
         def foreign_key
-          @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
+          @foreign_key ||= if @options[:foreign_key]
+                             @options[:foreign_key].to_s
+                           else
                              default_foreign_key_field
+                           end
         end
 
         # The criteria used for querying this association.
@@ -203,17 +210,17 @@ module Mongoid
         end
 
         def setup_syncing!
-          unless forced_nil_inverse?
-            synced_save
-            synced_destroy
-          end
+          return if forced_nil_inverse?
+
+          synced_save
+          synced_destroy
         end
 
         def synced_destroy
           assoc = self
           inverse_class.set_callback(
-              :destroy,
-              :after
+            :destroy,
+            :after
           ) do |doc|
             doc.remove_inverse_keys(assoc)
           end
@@ -222,9 +229,9 @@ module Mongoid
         def synced_save
           assoc = self
           inverse_class.set_callback(
-              :persist_parent,
-              :after,
-              if: ->(doc){ doc._syncable?(assoc) }
+            :persist_parent,
+            :after,
+            if: ->(doc) { doc._syncable?(assoc) }
           ) do |doc|
             doc.update_inverse_keys(assoc)
           end
@@ -233,24 +240,22 @@ module Mongoid
         def create_foreign_key_field!
           inverse_class.aliased_associations[foreign_key] = name.to_s
           @owner_class.field(
-              foreign_key,
-              type: FOREIGN_KEY_FIELD_TYPE,
-              identity: true,
-              overwrite: true,
-              association: self,
-              default: nil
+            foreign_key,
+            type: FOREIGN_KEY_FIELD_TYPE,
+            identity: true,
+            overwrite: true,
+            association: self,
+            default: nil
           )
         end
 
         def determine_inverses(other)
           matches = (other || relation_class).relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
-                rel.relation_class_name == inverse_class_name
-
-          end
-          if matches.size > 1
-            raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
+              rel.relation_class_name == inverse_class_name
           end
+          raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches) if matches.size > 1
+
           matches.collect { |m| m.name } unless matches.blank?
         end
 
@@ -265,11 +270,16 @@ module Mongoid
         def query_criteria(id_list)
           crit = relation_class.criteria
           crit = if id_list
-            crit = crit.apply_scope(scope)
-            crit.all_of(primary_key => { "$in" => id_list })
-          else
-            crit.none
-          end
+                   crit = crit.apply_scope(scope)
+                   # A nil in the stored key array would match every document
+                   # whose primary key is null or absent, returning documents
+                   # that were never associated. Associating a target whose
+                   # custom primary key is unset stores such a nil.
+                   id_list = id_list.compact if id_list.is_a?(Array)
+                   crit.all_of(primary_key => { '$in' => id_list })
+                 else
+                   crit.none
+                 end
           with_ordering(crit)
         end
       end

data/lib/mongoid/association/referenced/has_many/binding.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Referenced
       class HasMany
-
         # Binding class for has_many associations.
         class Binding
           include Bindable

data/lib/mongoid/association/referenced/has_many/buildable.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Referenced
       class HasMany
-
         # The Builder behavior for has_many associations.
         module Buildable
-
           # This method either takes an _id or an object and queries for the
           # inverse side using the id or sets the object.
           #
@@ -21,9 +18,18 @@ module Mongoid
           # @param [ nil ] selected_fields Must be nil.
           #
           # @return [ Document ] A single document.
-          def build(base, object, type = nil, selected_fields = nil)
-            return (object || []) unless query?(object)
+          def build(base, object, _type = nil, selected_fields = nil)
+            return object || [] unless query?(object)
+
+            # Handle array of hashes from $lookup aggregation
+            if object.is_a?(Array) && object.all? { |o| o.is_a?(Hash) }
+              return object.map do |attrs|
+                Factory.execute_from_db(klass, attrs, nil, selected_fields, execute_callbacks: false)
+              end
+            end
+
             return [] if object.is_a?(Array)
+
             query_criteria(object, base)
           end
 

data/lib/mongoid/association/referenced/has_many/eager.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Referenced
       class HasMany
-
         # Eager class for has_many associations.
         class Eager < Association::Eager
-
           private
 
           def preload

data/lib/mongoid/association/referenced/has_many/enumerable.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
+require 'mongoid/field_readable'
 require 'mongoid/pluckable'
 
 module Mongoid
   module Association
     module Referenced
       class HasMany
-
         # This class is the wrapper for all referenced associations that have a
         # target that can be a criteria or array of _loaded documents. This
         # handles both cases or a combination of the two.
         class Enumerable
           extend Forwardable
           include ::Enumerable
+          include FieldReadable
           include Pluckable
 
           # The three main instance variables are collections of documents.
@@ -35,6 +35,7 @@ module Mongoid
           # @return [ true | false ] If the objects are equal.
           def ==(other)
             return false unless other.respond_to?(:entries)
+
             entries == other.entries
           end
 
@@ -49,6 +50,7 @@ module Mongoid
           # @return [ true | false ] If the objects are equal in a case.
           def ===(other)
             return false unless other.respond_to?(:entries)
+
             entries === other.entries
           end
 
@@ -65,7 +67,7 @@ module Mongoid
             self
           end
 
-          alias :push :<<
+          alias push <<
 
           # Clears out all the documents in this enumerable. If passed a block it
           # will yield to each document that is in memory.
@@ -79,10 +81,8 @@ module Mongoid
           #   end
           #
           # @return [ Array<Document> ] The cleared out _added docs.
-          def clear
-            if block_given?
-              in_memory { |doc| yield(doc) }
-            end
+          def clear(&block)
+            in_memory(&block) if block_given?
             _loaded.clear and _added.clear
           end
 
@@ -107,12 +107,10 @@ module Mongoid
           #
           # @return [ Document ] The deleted document.
           def delete(document)
-            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
+            doc = _loaded.delete(document._id) || _added.delete(document._id)
+            if !doc && _unloaded && _unloaded.where(_id: document._id).exists?
+              yield(document) if block_given?
+              return document
             end
             yield(doc) if block_given?
             doc
@@ -163,11 +161,10 @@ module Mongoid
           #
           # @return [ true ] That the enumerable is now _loaded.
           def each
-            unless block_given?
-              return to_enum
-            end
+            return to_enum unless block_given?
+
             if _loaded?
-              _loaded.each_pair do |id, doc|
+              _loaded.each_pair do |_id, doc|
                 document = _added.delete(doc._id) || doc
                 set_base(document)
                 yield(document)
@@ -180,7 +177,7 @@ module Mongoid
                 yield(document)
               end
             end
-            _added.each_pair do |id, doc|
+            _added.each_pair do |_id, doc|
               yield(doc)
             end
             @executed = true
@@ -248,15 +245,15 @@ module Mongoid
           # @return [ Document ] The first document found.
           def first(limit = nil)
             _loaded.try(:values).try(:first) ||
-                _added[(ul = _unloaded.try(:first, limit)).try(:_id)] ||
-                ul ||
-                _added.values.try(:first)
+              _added[(ul = _unloaded.try(:first, limit)).try(:_id)] ||
+              ul ||
+              _added.values.try(:first)
           end
 
           # Initialize the new enumerable either with a criteria or an array.
           #
           # @example Initialize the enumerable with a criteria.
-          #   Enumberable.new(Post.where(:person_id => id))
+          #   Enumerable.new(Post.where(:person_id => id))
           #
           # @example Initialize the enumerable with an array.
           #   Enumerable.new([ post ])
@@ -269,9 +266,8 @@ module Mongoid
               @_added, @executed, @_loaded, @_unloaded = {}, false, {}, target
             else
               @_added, @executed = {}, true
-              @_loaded = target.inject({}) do |_target, doc|
+              @_loaded = target.each_with_object({}) do |doc, _target|
                 _target[doc._id] = doc if doc
-                _target
               end
             end
           end
@@ -286,6 +282,7 @@ module Mongoid
           # @return [ true | false ] If the document is in the target.
           def include?(doc)
             return super unless _unloaded
+
             _unloaded.where(_id: doc._id).exists? || _added.has_key?(doc._id)
           end
 
@@ -333,9 +330,9 @@ module Mongoid
           # @return [ Document ] The last document found.
           def last(limit = nil)
             _added.values.try(:last) ||
-                _loaded.try(:values).try(:last) ||
-                _added[(ul = _unloaded.try(:last, limit)).try(:_id)] ||
-                ul
+              _loaded.try(:values).try(:last) ||
+              _added[(ul = _unloaded.try(:last, limit)).try(:_id)] ||
+              ul
           end
 
           # Loads all the documents in the enumerable from the database.
@@ -344,7 +341,7 @@ module Mongoid
           #   enumerable.load_all!
           #
           # @return [ true ] That the enumerable is _loaded.
-          alias :load_all! :entries
+          alias load_all! entries
 
           # Has the enumerable been _loaded? This will be true if the criteria has
           # been executed or we manually load the entire thing.
@@ -364,7 +361,7 @@ module Mongoid
           #
           # @return [ Array<Object> ] The dumped data.
           def marshal_dump
-            [_added, _loaded, _unloaded, @executed]
+            [ _added, _loaded, _unloaded, @executed ]
           end
 
           # Loads the data needed to Marshal.load an enumerable proxy.
@@ -398,11 +395,11 @@ module Mongoid
                 results.concat pluck_from_documents(docs, prepared[:field_names], document_class: klass)
               elsif _unloaded
                 criteria = if _added.any?
-                  ids_to_exclude = _added.keys
-                  _unloaded.not(:_id.in => ids_to_exclude)
-                else
-                  _unloaded
-                end
+                             ids_to_exclude = _added.keys
+                             _unloaded.not(:_id.in => ids_to_exclude)
+                           else
+                             _unloaded
+                           end
 
                 results.concat criteria.pluck(*keys)
               end
@@ -484,7 +481,7 @@ module Mongoid
             end
           end
 
-          alias :length :size
+          alias length size
 
           # Send #to_json to the entries.
           #
@@ -510,6 +507,71 @@ module Mongoid
             entries.as_json(options)
           end
 
+          # Get the sum of the provided field for all documents in the
+          # enumerable. When the association is loaded, computes in memory
+          # without querying the database.
+          #
+          # @example Get the sum of a field.
+          #   enumerable.sum(:likes)
+          #
+          # @param [ Symbol ] field The field to sum.
+          #
+          # @return [ Numeric ] The sum value.
+          def sum(field = nil)
+            return super(field || 0) if block_given?
+
+            field_values_for(field).sum || 0
+          end
+
+          # Get the average of the provided field for all documents in the
+          # enumerable. When the association is loaded, computes in memory
+          # without querying the database.
+          #
+          # @example Get the average of a field.
+          #   enumerable.avg(:likes)
+          #
+          # @param [ Symbol ] field The field to average.
+          #
+          # @return [ Float | nil ] The average value or nil if no documents.
+          def avg(field)
+            values = field_values_for(field)
+            return nil if values.empty?
+
+            values.sum / values.size.to_f
+          end
+
+          # Get the minimum value of the provided field for all documents in
+          # the enumerable. When the association is loaded, computes in memory
+          # without querying the database.
+          #
+          # @example Get the min of a field.
+          #   enumerable.min(:likes)
+          #
+          # @param [ Symbol ] field The field to min.
+          #
+          # @return [ Numeric | nil ] The min value or nil if no documents.
+          def min(field = nil)
+            return super() if block_given?
+
+            field_values_for(field).min
+          end
+
+          # Get the maximum value of the provided field for all documents in
+          # the enumerable. When the association is loaded, computes in memory
+          # without querying the database.
+          #
+          # @example Get the max of a field.
+          #   enumerable.max(:likes)
+          #
+          # @param [ Symbol ] field The field to max.
+          #
+          # @return [ Numeric | nil ] The max value or nil if no documents.
+          def max(field = nil)
+            return super() if block_given?
+
+            field_values_for(field).max
+          end
+
           # Return all the unique documents in the enumerable.
           #
           # @note This operation loads all documents from the database.
@@ -524,10 +586,19 @@ module Mongoid
 
           private
 
+          # Collect non-nil values for the given field from all documents.
+          #
+          # @param [ Symbol ] field The field name.
+          #
+          # @return [ Array<Numeric> ] The non-nil field values.
+          def field_values_for(field)
+            map { |doc| read_field_value(doc, field) }.compact
+          end
+
           def set_base(document)
-            if @_association.is_a?(Referenced::HasMany)
-              document.set_relation(@_association.inverse, @_base) if @_association
-            end
+            return unless @_association.is_a?(Referenced::HasMany)
+
+            document.set_relation(@_association.inverse, @_base) if @_association
           end
 
           ruby2_keywords def method_missing(name, *args, &block)