mongoid 9.0.12 → 9.1.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/pluckable'
 
@@ -7,7 +6,6 @@ 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.
@@ -35,6 +33,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 +48,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 +65,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 +79,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 +105,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 +159,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 +175,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 +243,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 +264,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 +280,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 +328,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 +339,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 +359,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 +393,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 +479,7 @@ module Mongoid
             end
           end
 
-          alias :length :size
+          alias length size
 
           # Send #to_json to the entries.
           #
@@ -510,6 +505,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 +584,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| doc.public_send(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)

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

@@ -157,7 +157,7 @@ module Mongoid
           # @example Delete all documents in the association.
           #   person.posts.delete_all
           #
-          # @example Conditonally delete all documents in the association.
+          # @example Conditionally delete all documents in the association.
           #   person.posts.delete_all({ :title => "Testing" })
           #
           # @param [ Hash ] conditions Optional conditions to delete with.
@@ -260,9 +260,13 @@ module Mongoid
           #
           # @return [ Document | Array<Document> | nil ] A document or matching documents.
           def find(*args, &block)
-            matching = criteria.find(*args, &block)
-            Array(matching).each { |doc| _target.push(doc) }
-            matching
+            if block_given? && args.empty?
+              detect(&block)
+            else
+              matching = criteria.find(*args, &block)
+              Array(matching).each { |doc| _target.push(doc) }
+              matching
+            end
           end
 
           # Removes all associations between the base document and the target
@@ -475,7 +479,7 @@ module Mongoid
           #
           # @return [ Criteria | Object ] A Criteria or return value from the target.
           #
-          # TODO: make sure we are consistingly using respond_to_missing
+          # TODO: make sure we are consistently using respond_to_missing
           #   anywhere we define method_missing.
           # rubocop:disable Style/MissingRespondToMissing
           ruby2_keywords def method_missing(name, *args, &block)
@@ -525,7 +529,7 @@ module Mongoid
           # @example Delete all documents in the association.
           #   person.posts.delete_all
           #
-          # @example Conditonally delete all documents in the association.
+          # @example Conditionally delete all documents in the association.
           #   person.posts.delete_all({ :title => "Testing" })
           #
           # @param [ Hash ] conditions Optional conditions to delete with.
@@ -534,111 +538,12 @@ module Mongoid
           # @return [ Integer ] The number of documents deleted.
           def remove_all(conditions = nil, method = :delete_all)
             selector = conditions || {}
-            selector.merge!(criteria.selector)
-
-            # Scanning before the delete means scanning only what is already in
-            # memory, so it is only done where there is a pattern whose cost has
-            # to be bounded. Everywhere else the delete comes first and the scan
-            # sees the survivors, which is what this association has always
-            # done.
-            #
-            # The limit is read once and carried into whichever branch is taken.
-            # Letting the branch below ask again would read it a second time,
-            # across a server round trip, and a limit that had become positive
-            # in the meantime would put a deadline on the delete_if -- a query,
-            # and an unbind of every match -- which is the arrangement this
-            # branch exists to avoid.
-            limit = Matcher::RegexpBudget.limit_for(selector)
-            return remove_all_bounded(selector, method, limit) if limit
-
-            removed = klass.send(method, selector)
-
-            # No scope around this. The scan runs after the delete, so the
-            # association this loads comes back holding only what the delete did
-            # not match, and there is no pattern here to bound in any case.
-            # Opening a scope would save _matches? from deciding once per
-            # document -- 0.48us against 1.74us for the match itself -- but a
-            # scope with nothing to bound suppresses that decision for
-            # everything nested inside it, and loading the association runs
-            # find callbacks. A pattern in a selector one of those evaluates
-            # would go unguarded, which costs more than the saving is worth on a
-            # path that has just made two round trips.
+            removed = klass.send(method, selector.merge!(criteria.selector))
             _target.delete_if do |doc|
               doc._matches?(selector).tap do |b|
                 unbind_one(doc) if b
               end
             end
-
-            removed
-          end
-
-          # Deletes all related documents matching a selector that carries a
-          # regular expression, with the whole scan under one regexp budget.
-          #
-          # The scan runs before anything is deleted, so a budget that runs out
-          # leaves both the database and the association untouched rather than
-          # reporting a failure for a delete that has already happened. It also
-          # means the budget is closed by the time the association is mutated,
-          # so where the budget is enforced with Timeout there is no window for
-          # the exception to land in the middle of an unbind.
-          #
-          # @param [ Hash ] selector The selector to delete with.
-          # @param [ Symbol ] method The deletion method to call.
-          # @param [ Float ] limit The seconds the scan may spend, as read by
-          #   the caller when it chose this path.
-          #
-          # @return [ Integer ] The number of documents deleted.
-          def remove_all_bounded(selector, method, limit)
-            # Only what the association already holds. Iterating it instead
-            # would load the whole association before the delete, and for a
-            # broad pattern that is every document the association has: /.*/ is
-            # both the cheapest pattern an attacker can supply and the one that
-            # matches everything, so bounding the cost of the matching would
-            # have been paid for with an unbounded amount of memory. Nothing is
-            # missed by not loading, because the server evaluates the same
-            # selector for the delete itself.
-            #
-            # It also means the scan runs no query, so no deadline of ours can
-            # land on one. Where the budget is enforced with Timeout, covering
-            # a query would report a slow network as a regexp timeout and could
-            # deliver the asynchronous exception inside the driver's socket
-            # read.
-            documents = _target.in_memory
-
-            matching = Matcher::RegexpBudget.open_with(limit) do
-              documents.select { |doc| doc._matches?(selector) }
-            end
-
-            removed = klass.send(method, selector)
-
-            # The ids are already known to be in memory, so the loaded and added
-            # documents can be dropped directly. Enumerable#delete would look
-            # each one up by id and stop at the first hash that has it, which
-            # removes the wrong instance when both hashes hold one for the same
-            # id. Enumerable#delete_if drops it from both, as this does, but
-            # only after load_all!, which is the load this scan exists to avoid.
-            #
-            # Which documents get unbound has always depended on which ones
-            # happened to be in memory, and scanning only what is in memory
-            # keeps that. It matters for has_and_belongs_to_many, whose
-            # unbind_one pulls the id out of the foreign key array on _base and
-            # marks it dirty; the scan used to run after the delete, against an
-            # association that a cold proxy had just reloaded as holding only
-            # the survivors, so nothing matched and nothing was unbound.
-            #
-            # TODO: unbinding should not depend on what was in memory. Every
-            # matched document leaves the association, so every one of them
-            # should be unbound, which would also stop _base's foreign key
-            # array from keeping ids that no longer resolve. That is a
-            # behaviour change for has_and_belongs_to_many and belongs in a
-            # ticket of its own, with a release note; it should not ride along
-            # on this one.
-            matching.each do |doc|
-              unbind_one(doc)
-              _target._loaded.delete(doc._id)
-              _target._added.delete(doc._id)
-            end
-
             removed
           end
 

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/referenced/has_many/binding'
 require 'mongoid/association/referenced/has_many/buildable'
@@ -11,7 +10,6 @@ require 'mongoid/association/referenced/with_polymorphic_criteria'
 module Mongoid
   module Association
     module Referenced
-
       # The has_many association.
       class HasMany
         include Relatable
@@ -22,18 +20,18 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        ASSOCIATION_OPTIONS = [
-            :after_add,
-            :after_remove,
-            :as,
-            :autosave,
-            :before_add,
-            :before_remove,
-            :dependent,
-            :foreign_key,
-            :order,
-            :primary_key,
-            :scope,
+        ASSOCIATION_OPTIONS = %i[
+          after_add
+          after_remove
+          as
+          autosave
+          before_add
+          before_remove
+          dependent
+          foreign_key
+          order
+          primary_key
+          scope
         ].freeze
 
         # The complete list of valid options for this association, including
@@ -45,7 +43,7 @@ module Mongoid
         # The default foreign key suffix.
         #
         # @return [ String ] '_id'
-        FOREIGN_KEY_SUFFIX = '_id'.freeze
+        FOREIGN_KEY_SUFFIX = '_id'
 
         # The list of association complements.
         #
@@ -78,30 +76,38 @@ module Mongoid
           self
         end
 
-
         # Get the foreign key field on the inverse for saving the association reference.
         #
         # @return [ String ] The foreign key field on the inverse 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
 
         # 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 [ true ] Always true.
-        def validation_default; true; end
+        def validation_default
+          true
+        end
 
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        def stores_foreign_key?; false; end
+        def stores_foreign_key?
+          false
+        end
 
         # Get the association proxy class for this association type.
         #
@@ -200,18 +206,18 @@ module Mongoid
           @default_foreign_key_field ||= "#{inverse}#{FOREIGN_KEY_SUFFIX}"
         end
 
-        def polymorphic_inverses(other)
+        def polymorphic_inverses(_other)
           [ as ]
         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
-
+              rel.relation_class_name == inverse_class_name
           end
           if matches.size > 1
             return [ default_inverse.name ] if default_inverse
+
             raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
           end
           matches.collect { |m| m.name } unless matches.blank?
@@ -242,7 +248,7 @@ module Mongoid
         def with_inverse_field_criterion(criteria)
           inverse_association = inverse_association(klass)
           if inverse_association.try(:inverse_of)
-            criteria.any_in(inverse_association.inverse_of => [name, nil])
+            criteria.any_in(inverse_association.inverse_of => [ name, nil ])
           else
             criteria
           end

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

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

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/referenced/with_polymorphic_criteria'
 
@@ -7,7 +6,6 @@ module Mongoid
   module Association
     module Referenced
       class HasOne
-
         # The Builder behavior for has_one associations.
         module Buildable
           include WithPolymorphicCriteria
@@ -22,11 +20,15 @@ module Mongoid
           # @param [ nil ] selected_fields Must be nil.
           #
           # @return [ Document ] A single document.
-          def build(base, object, type = nil, selected_fields = nil)
+          def build(base, object, _type = nil, selected_fields = nil)
             if query?(object)
-              if !base.new_record?
-                execute_query(object, base)
+              # Handle array of hashes from $lookup aggregation
+              if object.is_a?(Array) && object.all? { |o| o.is_a?(Hash) }
+                doc = object.first
+                return doc ? Factory.execute_from_db(klass, doc, nil, selected_fields, execute_callbacks: false) : nil
               end
+
+              execute_query(object, base) unless base.new_record?
             else
               clear_associated(object)
               object
@@ -38,10 +40,10 @@ module Mongoid
           def clear_associated(object)
             unless inverse
               raise Errors::InverseNotFound.new(
-                  @owner_class,
-                  name,
-                  object.class,
-                  foreign_key,
+                @owner_class,
+                name,
+                object.class,
+                foreign_key
               )
             end
             if object && (associated = object.send(inverse))

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
@@ -7,7 +6,6 @@ module Mongoid
       class HasOne
         # Eager class for has_one associations.
         class Eager < Association::Eager
-
           private
 
           def preload
@@ -28,7 +26,6 @@ module Mongoid
           def key
             @association.foreign_key
           end
-
         end
       end
     end