mongoid 9.0.11 → 9.1.1

data/lib/mongoid/criteria/includable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Module providing functionality for parsing (nested) inclusion definitions.
     module Includable
-
       # 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.
@@ -27,10 +24,35 @@ module Mongoid
       #
       # @return [ Criteria ] The cloned criteria.
       def includes(*relations)
-        extract_includes_list(klass, nil, relations)
+        extract_includes_list(klass, nil, false, *relations)
+        clone
+      end
+
+      # Eager loads all the provided associations using aggregation $lookup.
+      # The behavior should be identical to #includes.
+      #
+      # @example Eager load the provided associations.
+      #   Person.eager_load(:posts, :game)
+      #
+      # @param [ [ Symbol | Hash ]... ] *relations The names of the association(s)
+      #   to eager load.
+      #
+      # @return [ Criteria ] The cloned criteria.
+      def eager_load(*relations)
+        extract_includes_list(klass, nil, true, *relations)
+        @use_lookup = !embedded?
         clone
       end
 
+      # Returns whether to use $lookup aggregation for eager loading. Only when
+      # eager_load was requested and there is something to load: an empty
+      # inclusion list (e.g. eager_load([])) falls back to the normal path.
+      #
+      # @return [ true | false ] Whether to use $lookup.
+      def use_lookup?
+        !!@use_lookup && inclusions.any?
+      end
+
       # Get a list of criteria that are to be executed for eager loading.
       #
       # @return [ Array<Mongoid::Association::Relatable> ] The inclusions.
@@ -71,24 +93,55 @@ module Mongoid
       #   association originates.
       # @param [ String ] parent The name of the association above this one in
       #   the inclusion tree, if it is a nested inclusion.
+      # @param [ Boolean ] is_eager_load Whether this is an eager load operation.
       # @param [ [ Symbol | Hash | Array<Symbol | Hash> ]... ] *relations_list
       #   The names of the association(s) to eager load.
-      def extract_includes_list(_parent_class, parent, *relations_list)
+      def extract_includes_list(_parent_class, parent, is_eager_load = false, *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
+          # Normalize a bare association name to a hash with no nested
+          # inclusions, so both forms share one resolution path below.
+          relations = relation_object.is_a?(Hash) ? relation_object : { relation_object => nil }
+
+          relations.each do |relation, nested|
+            associations = resolve_inclusion_associations(_parent_class, relation, is_eager_load)
+            raise_eager_error(is_eager_load, _parent_class, relation) if associations.empty?
+
+            associations.each do |association|
               add_inclusion(association, parent)
-              extract_includes_list(association.klass, association.name, _includes)
+              extract_includes_list(association.klass, association.name, is_eager_load, nested) if nested
             end
-          else
-            association = _parent_class.reflect_on_association(relation_object)
-            raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless association
-            add_inclusion(association, parent)
           end
         end
       end
+
+      # Resolve the association(s) matching the given relation name. For the
+      # regular #includes path, only the parent class is consulted. For the
+      # #eager_load ($lookup) path, its subclasses are consulted as well, so
+      # associations defined only on a subclass can also be eager-loaded when
+      # querying through the superclass.
+      #
+      # @param [ Class ] parent_class The class to start the lookup from.
+      # @param [ Symbol | String ] relation The association name.
+      # @param [ Boolean ] is_eager_load Whether to consider subclasses.
+      #
+      # @return [ Array<Mongoid::Association::Relatable> ] Matching associations.
+      def resolve_inclusion_associations(parent_class, relation, is_eager_load)
+        if association = parent_class.reflect_on_association(relation)
+          return [ association ]
+        end
+
+        return [] unless is_eager_load
+
+        parent_class.descendants.filter_map { |sub| sub.reflect_on_association(relation) }
+      end
+    end
+
+    def raise_eager_error(is_eager_load, klass, relation)
+      if is_eager_load
+        raise ArgumentError, "Eager loading only supports arguments that are the names of associations on #{klass}"
+      end
+
+      raise Errors::InvalidIncludes.new(klass, [ relation ])
     end
   end
 end

data/lib/mongoid/criteria/inspectable.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Mixin module included in Mongoid::Criteria which adds custom
     # +#inspect+ method functionality.
     module Inspectable
-
       # Get a pretty string representation of the criteria, including the
       # selector, options, matching count and documents for inspection.
       #
@@ -16,12 +13,12 @@ module Mongoid
       #
       # @return [ String ] The inspection string.
       def inspect
-%Q{#<Mongoid::Criteria
+        %(#<Mongoid::Criteria
   selector: #{selector.inspect}
   options:  #{options.inspect}
   class:    #{klass}
   embedded: #{embedded?}>
-}
+)
       end
     end
   end

data/lib/mongoid/criteria/marshalable.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Mixin module for Mongoid::Criteria which adds custom
     # Marshal.dump functionality.
     module Marshalable
-
       # Provides the data needed to Marshal.dump a criteria.
       #
       # @example Dump the criteria.
@@ -18,7 +15,7 @@ module Mongoid
       #
       # @return [ Array<Object> ] The dumped data.
       def marshal_dump
-        data = [ klass, :mongo, inclusions, documents, strategy, negating ]
+        data = [ klass, :mongo, inclusions, documents, strategy, negating, use_lookup? ]
         data.push(scoping_options).push(dump_hash(:selector)).push(dump_hash(:options))
       end
 
@@ -30,10 +27,10 @@ module Mongoid
       # @param [ Array ] data The raw data.
       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, @use_lookup = data
 
         if driver == :mongo1x
-          raise NotImplementedError, "Mongoid no longer supports marshalling with driver version 1.x."
+          raise NotImplementedError, 'Mongoid no longer supports marshalling with driver version 1.x.'
         end
 
         @selector = load_hash(Queryable::Selector, raw_selector)
@@ -43,9 +40,8 @@ module Mongoid
       private
 
       def dump_hash(name)
-        send(name).inject({}) do |raw, (key, value)|
+        send(name).each_with_object({}) do |(key, value), raw|
           raw[key] = value
-          raw
         end
       end
 

data/lib/mongoid/criteria/modifiable.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Mixin module for Mongoid::Criteria which adds the ability
     # to build or create new documents with attributes initialized
     # to the conditions of the criteria.
     module Modifiable
-
       # @attribute [r] create_attrs Additional attributes to add to the Document upon creation.
       # @api private
       attr_reader :create_attrs
@@ -26,7 +23,7 @@ module Mongoid
       def build(attrs = {}, &block)
         create_document(:new, attrs, &block)
       end
-      alias :new :build
+      alias new build
 
       # Create a document in the database given the selector and return it.
       # Complex criteria, such as $in and $or operations will get ignored.
@@ -173,11 +170,8 @@ module Mongoid
       # @return [ Document ] The new or saved document.
       def create_document(method, attrs = nil, &block)
         attrs = (create_attrs || {}).merge(attrs || {})
-        attributes = selector.reduce(attrs) do |hash, (key, value)|
-          unless invalid_key?(hash, key) || invalid_embedded_doc?(value)
-            hash[key] = value
-          end
-          hash
+        attributes = selector.each_with_object(attrs) do |(key, value), hash|
+          hash[key] = value unless invalid_key?(hash, key) || invalid_embedded_doc?(value)
         end
         if embedded?
           attributes[:_parent] = parent_document
@@ -220,8 +214,6 @@ module Mongoid
         first || create_document(method, attrs, &block)
       end
 
-      private
-
       def invalid_key?(hash, key)
         # @todo Change this to BSON::String::ILLEGAL_KEY when ruby driver 2.3.0 is
         # released and mongoid is updated to depend on driver >= 2.3.0

data/lib/mongoid/criteria/options.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Module containing functionality for getting options on a Criteria object.
     module Options
-
       private
 
       def persistence_context

data/lib/mongoid/criteria/permission.rb

@@ -1,50 +1,47 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
-
     # Mixin module for Mongoid::Criteria which adds strong
     # parameters validation when using ActionController::Parameters
     # objects as arguments to condition methods.
     module Permission
-
-      [:all,
-       :all_in,
-       :and,
-       :all_of,
-       :between,
-       :elem_match,
-       :exists,
-       :gt,
-       :gte,
-       :in,
-       :any_in,
-       :lt,
-       :lte,
-       :max_distance,
-       :mod,
-       :ne,
-       :excludes,
-       :near,
-       :near_sphere,
-       :nin,
-       :not_in,
-       :nor,
-       :negating?,
-       :not,
-       :or,
-       :any_of,
-       :with_size,
-       :with_type,
-       :where,
-       :within_box,
-       :within_circle,
-       :within_polygon,
-       :within_spherical_circle
-      ].each do |method|
+      %i[all
+         all_in
+         and
+         all_of
+         between
+         elem_match
+         exists
+         gt
+         gte
+         in
+         any_in
+         lt
+         lte
+         max_distance
+         mod
+         ne
+         excludes
+         near
+         near_sphere
+         nin
+         not_in
+         nor
+         negating?
+         not
+         or
+         any_of
+         with_size
+         with_type
+         where
+         within_box
+         within_circle
+         within_polygon
+         within_spherical_circle].each do |method|
         define_method(method) do |*criteria|
           raise Errors::CriteriaNotPermitted.new(klass, method, criteria) unless should_permit?(criteria)
+
           super(*criteria)
         end
       end

data/lib/mongoid/criteria/queryable/aggregable.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
-
       # Provides a DSL around crafting aggregation framework commands.
       module Aggregable
         extend Macroable
@@ -42,14 +40,14 @@ module Mongoid
             pipeline.group(operation)
           end
         end
-        key :avg, :override, "$avg"
-        key :max, :override, "$max"
-        key :min, :override, "$min"
-        key :sum, :override, "$sum"
-        key :last, :override, "$last"
-        key :push, :override, "$push"
-        key :first, :override, "$first"
-        key :add_to_set, :override, "$addToSet"
+        key :avg, :override, '$avg'
+        key :max, :override, '$max'
+        key :min, :override, '$min'
+        key :sum, :override, '$sum'
+        key :last, :override, '$last'
+        key :push, :override, '$push'
+        key :first, :override, '$first'
+        key :add_to_set, :override, '$addToSet'
 
         # Add a projection ($project) to the aggregation pipeline.
         #
@@ -95,6 +93,7 @@ module Mongoid
         # @return [ Aggregable ] The cloned aggregable.
         def aggregation(operation)
           return self unless operation
+
           clone.tap do |query|
             unless aggregating?
               query.pipeline.concat(query.selector.to_pipeline)

data/lib/mongoid/criteria/queryable/expandable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -12,7 +11,6 @@ module Mongoid
       #
       # @api private
       module Expandable
-
         private
 
         # Expands the specified condition to MongoDB syntax.
@@ -23,7 +21,7 @@ module Mongoid
         #
         # The following parameter forms are accepted:
         #
-        # - field is a string or symbol; value is the field query expresision
+        # - field is a string or symbol; value is the field query expression
         # - field is a Key instance; value is the field query expression
         # - field is a string corresponding to a MongoDB operator; value is
         #   the operator value expression.
@@ -39,7 +37,7 @@ module Mongoid
         # @return [ Array<String, Object> ] The expanded field and value.
         def expand_one_condition(field, value)
           kv = field.__expr_part__(value.__expand_complex__, negating?)
-          [kv.keys.first.to_s, kv.values.first]
+          [ kv.keys.first.to_s, kv.values.first ]
         end
 
         # Expand criterion values to arrays, to be used with operators that
@@ -54,15 +52,12 @@ module Mongoid
         #
         # @api private
         def expand_condition_to_array_values(criterion)
-          if criterion.nil?
-            raise ArgumentError, 'Criterion cannot be nil here'
-          end
+          raise ArgumentError, 'Criterion cannot be nil here' if criterion.nil?
 
           Hash[criterion.map do |key, value|
-            [key, value.__array__]
+            [ key, value.__array__ ]
           end]
         end
-
       end
     end
   end

data/lib/mongoid/criteria/queryable/extensions/array.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
-
         # Adds query type-casting behavior to Array class.
         module Array
-
           # Combine the two objects using the add strategy.
           #
           # @example Add the object to the array.
@@ -27,7 +24,9 @@ module Mongoid
           #   [ 1, 2 ].__array__
           #
           # @return [ Array ] self
-          def __array__; self; end
+          def __array__
+            self
+          end
 
           # Makes a deep copy of the array, deep copying every element inside the
           # array.
@@ -93,9 +92,8 @@ module Mongoid
           #
           # @return [ Hash ] The array as sort criterion.
           def __sort_option__
-            multi.inject({}) do |options, criteria|
+            multi.each_with_object({}) do |criteria, options|
               options.merge!(criteria.__sort_pair__)
-              options
             end
           end
 
@@ -120,11 +118,10 @@ module Mongoid
           #
           # @return [ Array ] The multi-dimensional array.
           def multi
-            first.is_a?(::Symbol) || first.is_a?(::String) ? [ self ] : self
+            (first.is_a?(::Symbol) || first.is_a?(::String)) ? [ self ] : self
           end
 
           module ClassMethods
-
             # Evolve the object when the serializer is defined as an array.
             #
             # @example Evolve the object.
@@ -148,5 +145,5 @@ module Mongoid
   end
 end
 
-::Array.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Array)
-::Array.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Array::ClassMethods)
+Array.include Mongoid::Criteria::Queryable::Extensions::Array
+Array.extend Mongoid::Criteria::Queryable::Extensions::Array::ClassMethods

data/lib/mongoid/criteria/queryable/extensions/big_decimal.rb

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "bigdecimal"
+require 'bigdecimal'
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
-
         # Adds query type-casting behavior to BigDecimal class.
         module BigDecimal
           module ClassMethods
-
             # Evolves the big decimal into a MongoDB friendly value.
             #
             # @example Evolve the big decimal
@@ -24,6 +21,7 @@ module Mongoid
             def evolve(object)
               __evolve__(object) do |obj|
                 return if obj.nil?
+
                 case obj
                 when ::BigDecimal
                   if Mongoid.map_big_decimal_to_decimal128
@@ -52,4 +50,4 @@ module Mongoid
   end
 end
 
-::BigDecimal.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::BigDecimal::ClassMethods)
+BigDecimal.extend Mongoid::Criteria::Queryable::Extensions::BigDecimal::ClassMethods

data/lib/mongoid/criteria/queryable/extensions/boolean.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
-
         # Adds query type-casting behavior to Mongoid::Boolean class.
         module Boolean
           module ClassMethods
-
             # Evolve the value into a boolean value stored in MongoDB. Will return
             # true for any of these values: true, t, yes, y, 1, 1.0.
             #
@@ -31,4 +28,4 @@ module Mongoid
   end
 end
 
-Mongoid::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)
+Mongoid::Boolean.extend Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods

data/lib/mongoid/criteria/queryable/extensions/date.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
-
         # Adds query type-casting behavior to Date class.
         module Date
-
           # Evolve the date into a mongo friendly time, UTC midnight.
           #
           # @example Evolve the date.
@@ -30,7 +27,6 @@ module Mongoid
           end
 
           module ClassMethods
-
             # Evolve the object to an date.
             #
             # @example Evolve dates.
@@ -60,5 +56,5 @@ module Mongoid
   end
 end
 
-::Date.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Date)
-::Date.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Date::ClassMethods)
+Date.include Mongoid::Criteria::Queryable::Extensions::Date
+Date.extend Mongoid::Criteria::Queryable::Extensions::Date::ClassMethods

data/lib/mongoid/criteria/queryable/extensions/date_time.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
-
         # Adds query type-casting behavior to DateTime class.
         module DateTime
-
           # Evolve the date time into a mongo friendly UTC time.
           #
           # @example Evolve the date time.
@@ -16,13 +13,12 @@ module Mongoid
           #
           # @return [ Time ] The converted time in UTC.
           def __evolve_time__
-            usec = strftime("%6N").to_f
+            usec = strftime('%6N').to_f
             u = utc
             ::Time.utc(u.year, u.month, u.day, u.hour, u.min, u.sec, usec)
           end
 
           module ClassMethods
-
             # Evolve the object to an date.
             #
             # @example Evolve dates.
@@ -49,5 +45,5 @@ module Mongoid
   end
 end
 
-::DateTime.__send__(:include, Mongoid::Criteria::Queryable::Extensions::DateTime)
-::DateTime.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::DateTime::ClassMethods)
+DateTime.include Mongoid::Criteria::Queryable::Extensions::DateTime
+DateTime.extend Mongoid::Criteria::Queryable::Extensions::DateTime::ClassMethods

data/lib/mongoid/criteria/queryable/extensions/hash.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
-
         # Adds query type-casting behavior to Hash class.
         module Hash
-
           # Add an object to a hash using the merge strategies.
           #
           # @example Add an object to a hash.
@@ -161,4 +158,4 @@ module Mongoid
   end
 end
 
-::Hash.__send__(:include, Mongoid::Criteria::Queryable::Extensions::Hash)
+Hash.include Mongoid::Criteria::Queryable::Extensions::Hash