mongoid 7.0.5 → 8.1.5

data/lib/mongoid/criteria/includable.rb

@@ -1,15 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
 
     # Module providing functionality for parsing (nested) inclusion definitions.
     module Includable
 
-      # Eager loads all the provided relations. Will load all the documents
+      # 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.
       #
-      # @note This will work for embedded relations that reference another
+      # @note This will work for embedded associations that reference another
       #   collection via belongs_to as well.
       #
       # @note Eager loading brings all the documents into memory, so there is a
@@ -17,42 +18,30 @@ module Mongoid
       #   eager loading becomes slower around 100k documents, but this will
       #   naturally depend on the specific application.
       #
-      # @example Eager load the provided relations.
+      # @example Eager load the provided associations.
       #   Person.includes(:posts, :game)
       #
-      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the relations to eager
-      #   load.
+      # @param [ [ Symbol | Hash ]... ] *relations The names of the association(s)
+      #   to eager load.
       #
       # @return [ Criteria ] The cloned criteria.
-      #
-      # @since 2.2.0
       def includes(*relations)
-        extract_includes_list(klass, relations)
+        extract_includes_list(klass, nil, relations)
         clone
       end
 
       # Get a list of criteria that are to be executed for eager loading.
       #
-      # @example Get the eager loading inclusions.
-      #   Person.includes(:game).inclusions
-      #
       # @return [ Array<Association> ] The inclusions.
-      #
-      # @since 2.2.0
       def inclusions
         @inclusions ||= []
       end
 
       # Set the inclusions for the criteria.
       #
-      # @example Set the inclusions.
-      #   criteria.inclusions = [ association ]
-      #
       # @param [ Array<Association> ] value The inclusions.
       #
       # @return [ Array<Association> ] The new inclusions.
-      #
-      # @since 3.0.0
       def inclusions=(value)
         @inclusions = value
       end
@@ -61,32 +50,41 @@ module Mongoid
 
       # Add an inclusion definition to the list of inclusions for the criteria.
       #
-      # @example Add an inclusion.
-      #   criteria.add_inclusion(Person, :posts)
-      #
-      # @param [ Class, String, Symbol ] _klass The class or string/symbol of the class name.
-      # @param [ Symbol ] association The relation.
-      #
-      # @raise [ Errors::InvalidIncludes ] If no relation is found.
-      #
-      # @since 5.1.0
-      def add_inclusion(_klass, association)
-        inclusions.push(association) unless inclusions.include?(association)
+      # @param [ Association ] association The association.
+      # @param [ String ] parent The name of the association above this one in
+      #   the inclusion tree, if it is a nested inclusion.
+      def add_inclusion(association, parent = nil)
+        if assoc = inclusions.detect { |a| a == association }
+          assoc.parent_inclusions.push(parent) if parent
+        else
+          assoc = association.dup
+          assoc.parent_inclusions = []
+          assoc.parent_inclusions.push(parent) if parent
+          inclusions.push(assoc)
+        end
       end
 
-      def extract_includes_list(_parent_class, *relations_list)
+      # Iterate through the list of relations and create the inclusions list.
+      #
+      # @param [ Class | String | Symbol ] _parent_class The class from which the
+      #   association originates.
+      # @param [ String ] parent The name of the association above this one in
+      #   the inclusion tree, if it is a nested inclusion.
+      # @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)
         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
-              add_inclusion(_parent_class, association)
-              extract_includes_list(association.klass, _includes)
+              add_inclusion(association, parent)
+              extract_includes_list(association.klass, association.name, _includes)
             end
           else
             association = _parent_class.reflect_on_association(relation_object)
             raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless association
-            add_inclusion(_parent_class, association)
+            add_inclusion(association, parent)
           end
         end
       end

data/lib/mongoid/criteria/inspectable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Inspectable
@@ -10,8 +11,6 @@ module Mongoid
       #   criteria.inspect
       #
       # @return [ String ] The inspection string.
-      #
-      # @since 1.0.0
       def inspect
 %Q{#<Mongoid::Criteria
   selector: #{selector.inspect}

data/lib/mongoid/criteria/marshalable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Marshalable
@@ -8,11 +9,12 @@ module Mongoid
       # @example Dump the criteria.
       #   Marshal.dump(criteria)
       #
-      # @return [ Array<Object> ] The dumped data.
+      # Note :mongo is written here for backwards compatibility with Mongoid 7
+      # and earlier.
       #
-      # @since 3.0.15
+      # @return [ Array<Object> ] The dumped data.
       def marshal_dump
-        data = [ klass, driver, inclusions, documents, strategy, negating ]
+        data = [ klass, :mongo, inclusions, documents, strategy, negating ]
         data.push(scoping_options).push(dump_hash(:selector)).push(dump_hash(:options))
       end
 
@@ -22,11 +24,14 @@ module Mongoid
       #   Marshal.load(criteria)
       #
       # @param [ Array ] data The raw data.
-      #
-      # @since 3.0.15
       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 = data
+
+        if driver == :mongo1x
+          raise NotImplementedError, "Mongoid no longer supports marshalling with driver version 1.x."
+        end
+
         @selector = load_hash(Queryable::Selector, raw_selector)
         @options = load_hash(Queryable::Options, raw_options)
       end

data/lib/mongoid/criteria/modifiable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Modifiable
@@ -17,8 +18,6 @@ module Mongoid
       #   Person.where(:age.gt => 5).build
       #
       # @return [ Document ] A non-persisted document.
-      #
-      # @since 2.0.0
       def build(attrs = {}, &block)
         create_document(:new, attrs, &block)
       end
@@ -34,8 +33,6 @@ module Mongoid
       #   Person.where(:age.gt => 5).create
       #
       # @return [ Document ] A newly created document.
-      #
-      # @since 2.0.0.rc.1
       def create(attrs = {}, &block)
         create_document(:create, attrs, &block)
       end
@@ -53,8 +50,6 @@ module Mongoid
       # @raise [ Errors::Validations ] on a validation error.
       #
       # @return [ Document ] A newly created document.
-      #
-      # @since 3.0.0
       def create!(attrs = {}, &block)
         create_document(:create!, attrs, &block)
       end
@@ -68,11 +63,10 @@ module Mongoid
       #   Person.create_with(job: 'Engineer').find_or_create_by(employer: 'MongoDB')
       #
       # @return [ Mongoid::Criteria ] A criteria.
-      #
-      # @since 5.1.0
       def create_with(attrs = {})
         tap do
-          (@create_attrs ||= {}).merge!(attrs)
+          @create_attrs ||= {}
+          @create_attrs.update(attrs)
         end
       end
 
@@ -127,8 +121,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly created document.
-      #
-      # @since 3.1.0
       def first_or_create(attrs = nil, &block)
         first_or(:create, attrs, &block)
       end
@@ -143,8 +135,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly created document.
-      #
-      # @since 3.1.0
       def first_or_create!(attrs = nil, &block)
         first_or(:create!, attrs, &block)
       end
@@ -158,8 +148,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly initialized document.
-      #
-      # @since 3.1.0
       def first_or_initialize(attrs = nil, &block)
         first_or(:new, attrs, &block)
       end
@@ -178,8 +166,6 @@ module Mongoid
       # @param [ Hash ] attrs Additional attributes to use.
       #
       # @return [ Document ] The new or saved document.
-      #
-      # @since 3.0.0
       def create_document(method, attrs = nil, &block)
         attrs = (create_attrs || {}).merge(attrs || {})
         attributes = selector.reduce(attrs) do |hash, (key, value)|
@@ -225,8 +211,6 @@ module Mongoid
       # @param [ Hash ] attrs The attributes to query or set.
       #
       # @return [ Document ] The first or new document.
-      #
-      # @since 3.1.0
       def first_or(method, attrs = {}, &block)
         first || create_document(method, attrs, &block)
       end

data/lib/mongoid/criteria/options.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
 
     # Module containing functionality for getting options on a Criteria object.
-    #
-    # @since 6.0.0
     module Options
 
       private

data/lib/mongoid/criteria/permission.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Permission
@@ -53,7 +54,7 @@ module Mongoid
       # @api private
       #
       # @param [ Object ] criteria
-      # @return [ Boolean ] if should permit
+      # @return [ true | false ] if should permit
       def should_permit?(criteria)
         if criteria.respond_to?(:permitted?)
           return criteria.permitted?

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

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
 
       # Provides a DSL around crafting aggregation framework commands.
-      #
-      # @since 2.0.0
       module Aggregable
         extend Macroable
 
@@ -21,9 +20,7 @@ module Mongoid
         # @example Is the aggregable aggregating?
         #   aggregable.aggregating?
         #
-        # @return [ true, false ] If the aggregable is aggregating.
-        #
-        # @since 2.0.0
+        # @return [ true | false ] If the aggregable is aggregating.
         def aggregating?
           !!@aggregating
         end
@@ -39,8 +36,6 @@ module Mongoid
         # @param [ Hash ] operation The group operation.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def group(operation)
           aggregation(operation) do |pipeline|
             pipeline.group(operation)
@@ -63,8 +58,6 @@ module Mongoid
         # @param [ Hash ] operation The projection to make.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def project(operation = nil)
           aggregation(operation) do |pipeline|
             pipeline.project(operation)
@@ -76,11 +69,9 @@ module Mongoid
         # @example Add an unwind to the pipeline.
         #   aggregable.unwind(:field)
         #
-        # @param [ String, Symbol ] field The name of the field to unwind.
+        # @param [ String | Symbol ] field The name of the field to unwind.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def unwind(field)
           aggregation(field) do |pipeline|
             pipeline.unwind(field)
@@ -101,8 +92,6 @@ module Mongoid
         # @param [ Hash ] operation The operation for the pipeline.
         #
         # @return [ Aggregable ] The cloned aggregable.
-        #
-        # @since 2.0.0
         def aggregation(operation)
           return self unless operation
           clone.tap do |query|

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Mongoid
+  class Criteria
+    module Queryable
+      # This module encapsulates methods that expand various high level
+      # query forms to the MongoDB hash condition selector syntax.
+      #
+      # @example Example high level form.
+      #   Band.where(:foo.gt => 5)
+      #
+      # @api private
+      module Expandable
+
+        private
+
+        # Expands the specified condition to MongoDB syntax.
+        #
+        # This method is meant to be called when processing the items of
+        # a condition hash and the key and the value of each item are
+        # already available separately.
+        #
+        # The following parameter forms are accepted:
+        #
+        # - field is a string or symbol; value is the field query expresision
+        # - 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.
+        #
+        # This method expands the field-value combination to the MongoDB
+        # selector syntax and returns an array of
+        # [expanded key, expanded value]. The expanded key is converted to
+        # a string if it wasn't already a string.
+        #
+        # @param [ String | Symbol | Key ] field The field to expand.
+        # @param [ Object ] value The field's value.
+        #
+        # @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]
+        end
+
+        # Expand criterion values to arrays, to be used with operators that
+        # take an array as argument such as $in.
+        #
+        # @example Convert all the values to arrays.
+        #   selectable.with_array_values({ key: 1...4 })
+        #
+        # @param [ Hash ] criterion The criterion.
+        #
+        # @return [ Hash ] The $in friendly criterion with array values.
+        #
+        # @api private
+        def expand_condition_to_array_values(criterion)
+          if criterion.nil?
+            raise ArgumentError, 'Criterion cannot be nil here'
+          end
+
+          Hash[criterion.map do |key, value|
+            [key, value.__array__]
+          end]
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # The array module adds custom behaviour for Origin onto the Array class.
+        # The array module adds custom behavior for Origin onto the Array class.
         module Array
 
           # Combine the two objects using the add strategy.
@@ -15,8 +16,6 @@ module Mongoid
           # @param [ Object ] object The object to add.
           #
           # @return [ Object ] The result of the add.
-          #
-          # @since 1.0.0
           def __add__(object)
             object.__add_from_array__(self)
           end
@@ -27,8 +26,6 @@ module Mongoid
           #   [ 1, 2 ].__array__
           #
           # @return [ Array ] self
-          #
-          # @since 1.0.0
           def __array__; self; end
 
           # Makes a deep copy of the array, deep copying every element inside the
@@ -38,8 +35,6 @@ module Mongoid
           #   [ 1, 2, 3 ].__deep_copy__
           #
           # @return [ Array ] The deep copy of the array.
-          #
-          # @since 1.0.0
           def __deep_copy__
             map { |value| value.__deep_copy__ }
           end
@@ -51,8 +46,6 @@ module Mongoid
           #   [ Date.new(2010, 1, 1) ].__evolve_date__
           #
           # @return [ Array<Time> ] The array as times at midnight UTC.
-          #
-          # @since 1.0.0
           def __evolve_date__
             map { |value| value.__evolve_date__ }
           end
@@ -63,8 +56,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Array ] The expanded array.
-          #
-          # @since 1.1.0
           def __expand_complex__
             map do |value|
               value.__expand_complex__
@@ -77,22 +68,18 @@ module Mongoid
           #   [ 1231231231 ].__evolve_time__
           #
           # @return [ Array<Time> ] The array as times.
-          #
-          # @since 1.0.0
           def __evolve_time__
             map { |value| value.__evolve_time__ }
           end
 
           # Combine the two objects using an intersection strategy.
           #
-          # @example Interset with the object.
+          # @example Intersect with the object.
           #   [ 1, 2 ].__intersect__(3)
           #
           # @param [ Object ] object The object to intersect with.
           #
           # @return [ Object ] The result of the intersection.
-          #
-          # @since 1.0.0
           def __intersect__(object)
             object.__intersect_from_array__(self)
           end
@@ -104,8 +91,6 @@ module Mongoid
           #   [ :field, 1 ].__sort_option__
           #
           # @return [ Hash ] The array as sort criterion.
-          #
-          # @since 1.0.0
           def __sort_option__
             multi.inject({}) do |options, criteria|
               options.merge!(criteria.__sort_pair__)
@@ -119,24 +104,8 @@ module Mongoid
           #   [ field, 1 ].__sort_pair__
           #
           # @return [ Hash ] The field/direction pair.
-          #
-          # @since 1.0.0
           def __sort_pair__
-            { first => last.to_direction }
-          end
-
-          # Update all the values in the hash with the provided block.
-          #
-          # @example Update the values in place.
-          #   [ 1, 2, 3 ].update_values(&:to_s)
-          #
-          # @param [ Proc ] block The block to execute on each value.
-          #
-          # @return [ Array ] the array.
-          #
-          # @since 1.0.0
-          def update_values(&block)
-            replace(map(&block))
+            { first => Mongoid::Criteria::Translator.to_direction(last) }
           end
 
           private
@@ -149,8 +118,6 @@ module Mongoid
           #   [ 1, 2, 3 ].multi
           #
           # @return [ Array ] The multi-dimensional array.
-          #
-          # @since 1.0.0
           def multi
             first.is_a?(::Symbol) || first.is_a?(::String) ? [ self ] : self
           end
@@ -165,10 +132,9 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Object ] The evolved object.
-            #
-            # @since 1.0.0
             def evolve(object)
-              if object.is_a?(::Array)
+              case object
+              when ::Array, ::Set
                 object.map { |obj| obj.class.evolve(obj) }
               else
                 object

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "bigdecimal"
 
 module Mongoid
@@ -6,25 +7,44 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # The big decimal module adds custom behaviour for Origin onto the
+        # The big decimal module adds custom behavior for Origin onto the
         # BigDecimal class.
         module BigDecimal
           module ClassMethods
 
-            # Evolves the big decimal into a MongoDB friendly value - in this case
-            # a string.
+            # Evolves the big decimal into a MongoDB friendly value.
             #
             # @example Evolve the big decimal
             #   BigDecimal.evolve(decimal)
             #
             # @param [ BigDecimal ] object The object to convert.
             #
-            # @return [ String ] The big decimal as a string.
-            #
-            # @since 1.0.0
+            # @return [ Object ] The big decimal as a string, a Decimal128,
+            #   or the inputted object if it is uncastable.
             def evolve(object)
               __evolve__(object) do |obj|
-                obj ? obj.to_s : obj
+                return if obj.nil?
+                case obj
+                when ::BigDecimal
+                  if Mongoid.map_big_decimal_to_decimal128
+                    BSON::Decimal128.new(obj)
+                  else
+                    obj.to_s
+                  end
+                # Always return on string for backwards compatibility with querying
+                # string-backed BigDecimal fields.
+                when BSON::Decimal128, String then obj
+                else
+                  if obj.numeric?
+                    if Mongoid.map_big_decimal_to_decimal128
+                      BSON::Decimal128.new(object.to_s)
+                    else
+                      obj.to_s
+                    end
+                  else
+                    obj
+                  end
+                end
               end
             end
           end

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
@@ -16,12 +17,10 @@ module Mongoid
             #
             # @param [ Object ] object The object to evolve.
             #
-            # @return [ true, false ] The boolean value.
-            #
-            # @since 1.0.0
+            # @return [ true | false ] The boolean value.
             def evolve(object)
               __evolve__(object) do |obj|
-                obj.to_s =~ (/\A(true|t|yes|y|on|1|1.0)\z/i) ? true : false
+                mongoize(obj)
               end
             end
           end
@@ -31,4 +30,4 @@ module Mongoid
   end
 end
 
-::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)
+Mongoid::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)