mongoid 7.2.1 → 9.0.0

data/lib/mongoid/criteria/includable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -22,39 +22,27 @@ module Mongoid
       # @example Eager load the provided associations.
       #   Person.includes(:posts, :game)
       #
-      # @param [ Array<Symbol>, Array<Hash> ] relations The names of the associations 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
+      # @return [ Array<Mongoid::Association::Relatable> ] The inclusions.
       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.
+      # @param [ Array<Mongoid::Association::Relatable> ] value The inclusions.
       #
-      # @since 3.0.0
+      # @return [ Array<Mongoid::Association::Relatable> ] The new inclusions.
       def inclusions=(value)
         @inclusions = value
       end
@@ -63,32 +51,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 association.
-      #
-      # @raise [ Errors::InvalidIncludes ] If no association is found.
-      #
-      # @since 5.1.0
-      def add_inclusion(_klass, association)
-        inclusions.push(association) unless inclusions.include?(association)
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
+      # @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,8 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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
@@ -12,8 +15,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,8 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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.
@@ -10,11 +13,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
 
@@ -24,11 +28,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,8 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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.
@@ -19,8 +23,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
@@ -36,8 +38,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
@@ -55,8 +55,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
@@ -70,8 +68,6 @@ 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 ||= {}
@@ -130,8 +126,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
@@ -146,8 +140,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
@@ -161,8 +153,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
@@ -181,8 +171,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)|
@@ -228,8 +216,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,12 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 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,8 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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,
@@ -55,7 +59,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,13 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
 
       # Provides a DSL around crafting aggregation framework commands.
-      #
-      # @since 2.0.0
       module Aggregable
         extend Macroable
 
@@ -23,9 +21,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
@@ -41,8 +37,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)
@@ -65,8 +59,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)
@@ -78,11 +70,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)
@@ -103,8 +93,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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   class Criteria
@@ -15,30 +15,6 @@ module Mongoid
 
         private
 
-        # Expands the specified condition to MongoDB syntax.
-        #
-        # The condition must be a hash in one of the following forms:
-        # - {field_name: value}
-        # - {'field_name' => value}
-        # - {key_instance: value}
-        # - {'$operator' => operator_value_expression}
-        #
-        # This method expands the key instance form to the the operator form,
-        # and also converts hash key to string.
-        #
-        # The hash may contain multiple items, each representing a separate
-        # condition.
-        #
-        # @param [ Hash ] condition The condition to expand.
-        #
-        # @return [ Hash ] The expanded condition.
-        def expand_condition(condition)
-          mapped = condition.map do |field, value|
-            expand_one_condition(field, value)
-          end
-          Hash[mapped]
-        end
-
         # Expands the specified condition to MongoDB syntax.
         #
         # This method is meant to be called when processing the items of

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # The array module adds custom behavior for Origin onto the Array class.
+        # Adds query type-casting behavior to Array class.
         module Array
 
           # Combine the two objects using the add strategy.
@@ -17,8 +17,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
@@ -29,8 +27,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
@@ -40,8 +36,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
@@ -53,8 +47,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
@@ -65,8 +57,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Array ] The expanded array.
-          #
-          # @since 1.1.0
           def __expand_complex__
             map do |value|
               value.__expand_complex__
@@ -79,22 +69,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
@@ -106,8 +92,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__)
@@ -121,24 +105,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
@@ -151,8 +119,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
@@ -167,10 +133,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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "bigdecimal"
 
@@ -8,25 +8,41 @@ module Mongoid
     module Queryable
       module Extensions
 
-        # The big decimal module adds custom behavior for Origin onto the
-        # BigDecimal class.
+        # Adds query type-casting behavior to 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
+                when BSON::Decimal128 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,12 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   class Criteria
     module Queryable
       module Extensions
 
-        # This module contains extensions for boolean selection.
+        # Adds query type-casting behavior to Mongoid::Boolean class.
         module Boolean
           module ClassMethods
 
@@ -18,12 +18,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
@@ -33,4 +31,4 @@ module Mongoid
   end
 end
 
-::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)
+Mongoid::Boolean.__send__(:extend, Mongoid::Criteria::Queryable::Extensions::Boolean::ClassMethods)