mongoid 7.5.3 → 8.0.1

data/lib/mongoid/copyable.rb

@@ -10,7 +10,11 @@ module Mongoid
     # the exception of the document's id, and will reset all the
     # instance variables.
     #
-    # This clone also includes embedded documents.
+    # This clone also includes embedded documents. If there is an _id field in
+    # the embedded document, it will be maintained, unlike the root's _id.
+    #
+    # If cloning an embedded child, the embedded parent is not cloned and the
+    # embedded_in association is not set.
     #
     # @example Clone the document.
     #   document.clone
@@ -19,19 +23,42 @@ module Mongoid
     def clone
       # @note This next line is here to address #2704, even though having an
       # _id and id field in the document would cause problems with Mongoid
-      # elsewhere.
+      # elsewhere. Note this is only done on the root document as we want
+      # to maintain the same _id on the embedded documents.
       attrs = clone_document.except(*self.class.id_fields)
+      Copyable.clone_with_hash(self.class, attrs)
+    end
+    alias :dup :clone
+
+    private
+
+    # Create clone of a document of the given klass with the given attributes
+    # hash. This is used recursively so that embedded associations are cloned
+    # safely.
+    #
+    # @param klass [ Class ] The class of the document to create.
+    # @param attrs [ Hash ] The hash of the attributes.
+    #
+    # @return [ Document ] The new document.
+    def self.clone_with_hash(klass, attrs)
       dynamic_attrs = {}
-      _attribute_names = self.attribute_names
+      _attribute_names = klass.attribute_names
       attrs.reject! do |attr_name, value|
         unless _attribute_names.include?(attr_name)
           dynamic_attrs[attr_name] = value
           true
         end
       end
-      self.class.new(attrs).tap do |object|
+
+      Factory.build(klass, attrs).tap do |object|
         dynamic_attrs.each do |attr_name, value|
-          if object.respond_to?("#{attr_name}=")
+          assoc = object.embedded_relations[attr_name]
+          if assoc&.one? && Hash === value
+            object.send("#{attr_name}=", clone_with_hash(assoc.klass, value))
+          elsif assoc&.many? && Array === value
+            docs = value.map { |h| clone_with_hash(assoc.klass, h) }
+            object.send("#{attr_name}=", docs)
+          elsif object.respond_to?("#{attr_name}=")
             object.send("#{attr_name}=", value)
           else
             object.attributes[attr_name] = value
@@ -39,9 +66,6 @@ module Mongoid
         end
       end
     end
-    alias :dup :clone
-
-    private
 
     # Clone the document attributes
     #

data/lib/mongoid/criteria/includable.rb

@@ -26,15 +26,12 @@ module Mongoid
       #
       # @return [ Criteria ] The cloned criteria.
       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.
       def inclusions
         @inclusions ||= []
@@ -42,9 +39,6 @@ module Mongoid
 
       # 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.
@@ -56,30 +50,40 @@ 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.
-      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 relations_list The names of the associations 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/marshalable.rb

@@ -9,9 +9,12 @@ module Mongoid
       # @example Dump the criteria.
       #   Marshal.dump(criteria)
       #
+      # Note :mongo is written here for backwards compatibility with Mongoid 7
+      # and earlier.
+      #
       # @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
 
@@ -23,7 +26,12 @@ 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 = 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/queryable/extensions/array.rb

@@ -108,20 +108,6 @@ module Mongoid
             { 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.
-          #
-          # @deprecated
-          def update_values(&block)
-            replace(map(&block))
-          end
-
           private
 
           # Converts the array to a multi-dimensional array.
@@ -147,7 +133,8 @@ module Mongoid
             #
             # @return [ Object ] The evolved object.
             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

@@ -12,18 +12,39 @@ module Mongoid
         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.
+            # @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

@@ -20,7 +20,7 @@ module Mongoid
             # @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

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

@@ -45,7 +45,12 @@ module Mongoid
             #
             # @return [ Time ] The evolved date.
             def evolve(object)
-              object.__evolve_date__
+              res = begin
+                object.try(:__evolve_date__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -34,7 +34,12 @@ module Mongoid
             #
             # @return [ Time ] The evolved date time.
             def evolve(object)
-              object.__evolve_time__
+              res = begin
+                object.try(:__evolve_time__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -134,22 +134,6 @@ module Mongoid
             replacement
           end
 
-          # Update all the values in the hash with the provided block.
-          #
-          # @example Update the values in place.
-          #   { field: "1" }.update_values(&:to_i)
-          #
-          # @param [ Proc ] block The block to execute on each value.
-          #
-          # @return [ Hash ] the hash.
-          #
-          # @deprecated
-          def update_values(&block)
-            each_pair do |key, value|
-              store(key, block[value])
-            end
-          end
-
           private
 
           # Apply the provided strategy for the hash with the given object.

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

@@ -51,7 +51,7 @@ module Mongoid
             #
             # @return [ Object ] The converted number.
             def __numeric__(object)
-              object.to_s =~ /(\A[-+]?[0-9]+\z)|(\.0+\z)|(\.\z)/ ? object.to_i : Float(object)
+              object.to_s.match?(/\A[-+]?[0-9]*[0-9.]0*\z/) ? object.to_i : Float(object)
             end
 
             # Evolve the object to an integer.

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

@@ -167,7 +167,8 @@ module Mongoid
               when ::Range
                 object.__evolve_range__
               else
-                yield(object)
+                res = yield(object)
+                res.nil? ? object : res
               end
             end
           end

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

@@ -43,13 +43,21 @@ module Mongoid
           # @example Evolve the range.
           #   (11231312..213123131).__evolve_range__
           #
+          # @param [ Object ] serializer The optional serializer for the field.
+          #
           # @return [ Hash ] The $gte/$lte range query.
-          def __evolve_range__
+          #
+          # @api private
+          def __evolve_range__(serializer: nil)
             __evolve_range_naive__.transform_values! do |value|
-              case value
-              when Time, DateTime then value.__evolve_time__
-              when Date then value.__evolve_date__
-              else value
+              if serializer
+                serializer.evolve(value)
+              else
+                case value
+                when Time, DateTime then value.__evolve_time__
+                when Date then value.__evolve_date__
+                else value
+                end
               end
             end
           end

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

@@ -28,7 +28,7 @@ module Mongoid
             # @return [ Regexp ] The evolved regex.
             def evolve(object)
               __evolve__(object) do |obj|
-                ::Regexp.new(obj)
+                mongoize(obj)
               end
             end
           end

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

@@ -59,7 +59,9 @@ module Mongoid
             #
             # @return [ Symbol ] The value as a symbol.
             def evolve(object)
-              __evolve__(object) { |obj| obj.to_sym }
+              __evolve__(object) do |obj|
+                obj.try(:to_sym)
+              end
             end
           end
         end

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

@@ -42,7 +42,12 @@ module Mongoid
             #
             # @return [ Time ] The evolved date time.
             def evolve(object)
-              object.__evolve_time__
+              res = begin
+                object.try(:__evolve_time__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -42,7 +42,12 @@ module Mongoid
             #
             # @return [ Time ] The evolved date time.
             def evolve(object)
-              object.__evolve_time__
+              res = begin
+                object.try(:__evolve_time__)
+              rescue ArgumentError
+                nil
+              end
+              res.nil? ? object : res
             end
           end
         end

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

@@ -318,15 +318,9 @@ module Mongoid
         #
         # @return [ Optional ] The cloned optional.
         def add_sort_option(options, field, direction)
-          if driver == :mongo1x
-            sorting = (options[:sort] || []).dup
-            sorting.push([ field, direction ])
-            options.store(:sort, sorting)
-          else
-            sorting = (options[:sort] || {}).dup
-            sorting[field] = direction
-            options.store(:sort, sorting)
-          end
+          sorting = (options[:sort] || {}).dup
+          sorting[field] = direction
+          options.store(:sort, sorting)
         end
 
         # Take the provided criterion and store it as an option in the query

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

@@ -84,7 +84,7 @@ module Mongoid
         #
         # @return [ Options ] The copied options.
         def __deep_copy__
-          self.class.new(aliases, serializers) do |copy|
+          self.class.new(aliases, serializers, associations, aliased_associations) do |copy|
             each_pair do |key, value|
               copy.merge!(key => value.__deep_copy__)
             end

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

@@ -227,19 +227,6 @@ module Mongoid
           __merge__(criterion)
         end
 
-        # Alias for +geo_spatial+.
-        #
-        # @deprecated
-        def geo_spacial(criterion)
-          # Duplicate method body so that we can raise this exception with
-          # geo_spacial as the indicated operator rather than geo_spatial.
-          if criterion.nil?
-            raise Errors::CriteriaArgumentRequired, :geo_spacial
-          end
-
-          __merge__(criterion)
-        end
-
         key :intersects_line, :override, "$geoIntersects", "$geometry" do |value|
           { "type" => LINE_STRING, "coordinates" => value }
         end
@@ -679,16 +666,7 @@ module Mongoid
                 end]
               end
             end
-            # Should be able to do:
-            #where('$or' => exprs)
-            # But since that is broken do instead:
-            clone.tap do |query|
-              if query.selector['$or']
-                query.selector.store('$or', query.selector['$or'] + exprs)
-              else
-                query.selector.store('$or', exprs)
-              end
-            end
+            self.and('$or' => exprs)
           end
         end
 
@@ -874,7 +852,7 @@ module Mongoid
         # @param [ Hash ] criterion The criterion.
         def typed_override(criterion, operator)
           if criterion
-            criterion.update_values do |value|
+            criterion.transform_values! do |value|
               yield(value)
             end
           end

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

@@ -53,8 +53,7 @@ module Mongoid
             store_name = name
             store_value = evolve_multi(value)
           else
-            store_name = localized_key(name, serializer)
-            store_value = evolve(serializer, value)
+            store_name, store_value = store_creds(name, serializer, value)
           end
           super(store_name, store_value)
         end
@@ -74,6 +73,24 @@ module Mongoid
 
         private
 
+        # Get the store name and store value. If the value is of type range,
+        # we need may need to change the store_name as well as the store_value,
+        # therefore, we cannot just use the evole method.
+        #
+        # @param [ String ] name The name of the field.
+        # @param [ Object ] serializer The optional serializer for the field.
+        # @param [ Object ] value The value to serialize.
+        #
+        # @return [ Array<String, String> ] The store name and store value.
+        def store_creds(name, serializer, value)
+          store_name = localized_key(name, serializer)
+          if Range === value
+            evolve_range(store_name, serializer, value)
+          else
+            [ store_name, evolve(serializer, value) ]
+          end
+        end
+
         # Evolves a multi-list selection, like an $and or $or criterion, and
         # performs the necessary serialization.
         #
@@ -103,11 +120,10 @@ module Mongoid
               # some reason, although per its documentation Smash supposedly
               # owns both.
               name, serializer = storage_pair(key)
-              final_key = localized_key(name, serializer)
               # This performs type conversions on the value and transformations
               # that depend on the type of the field that the value is stored
               # in, but not transformations that have to do with query shape.
-              evolved_value = evolve(serializer, value)
+              final_key, evolved_value = store_creds(name, serializer, value)
 
               # This builds a query shape around the value, when the query
               # involves complex keys. For example, {:foo.lt => 5} produces
@@ -139,6 +155,8 @@ module Mongoid
             evolve_hash(serializer, value)
           when Array
             evolve_array(serializer, value)
+          when Range
+            value.__evolve_range__(serializer: serializer)
           else
             (serializer || value.class).evolve(value)
           end
@@ -182,6 +200,73 @@ module Mongoid
           end
         end
 
+        # Evolve a single key selection with range values. This method traverses
+        # the association tree to build a query for the given value and
+        # serializer. There are three parts to the query here:
+        #
+        # (1) "klass.child.gchild" => {
+        #       "$elemMatch" => {
+        #     (2) "ggchild.field" => (3) { "$gte" => 6, "$lte" => 10 }
+        #       }
+        #     }
+        # (1) The first n fields are dotted together until the last
+        #     embeds_many or field of type array. In the above case, gchild
+        #     would be an embeds_many or Array, and ggchild would be an
+        #     embeds_one or a hash.
+        # (2) The last fields are used inside the $elemMatch. This one is
+        #     actually optional, and will be ignored if the last field is an
+        #     array or embeds_many. If the last field is an array (1), (2) and
+        #     (3) will look like:
+        #
+        #       "klass.child.gchild.ggchild.field" => {
+        #         { "$elemMatch" => { "$gte" => 6, "$lte" => 10 } }
+        #       }
+        #
+        # (3) This is calculated by:
+        #
+        #       value.__evolve_range__(serializer: serializer).
+        #
+        # @api private
+        #
+        # @param [ String ] key The to store the range for.
+        # @param [ Object ] serializer The optional serializer for the field.
+        # @param [ Range ] value The Range to serialize.
+        #
+        # @return [ Array<String, Hash> ] The store name and serialized Range.
+        def evolve_range(key, serializer, value)
+          v = value.__evolve_range__(serializer: serializer)
+          assocs = []
+          Fields.traverse_association_tree(key, serializers, associations, aliased_associations) do |meth, obj, is_field|
+            assocs.push([meth, obj, is_field])
+          end
+
+          # Iterate backwards until you get a field with type
+          # Array or an embeds_many association.
+          inner_key = ""
+          loop do
+            # If there are no arrays or embeds_many associations, just return
+            # the key and value without $elemMatch.
+            return [ key, v ] if assocs.empty?
+
+            meth, obj, is_field = assocs.last
+            break if (is_field && obj.type == Array) || (!is_field && obj.is_a?(Association::Embedded::EmbedsMany))
+
+            assocs.pop
+            inner_key = "#{meth}.#{inner_key}"
+          end
+
+          # If the last array or embeds_many association is the last field,
+          # the inner key (2) is ignored, and the outer key (1) is the original
+          # key.
+          if inner_key.blank?
+            [ key, { "$elemMatch" => v }]
+          else
+            store_key = assocs.map(&:first).join('.')
+            store_value = { "$elemMatch" => { inner_key.chop => v } }
+            [ store_key,  store_value ]
+          end
+        end
+
         # Determines if the selection is a multi-select, like an $and or $or or $nor
         # selection.
         #