mongoid 6.4.8 → 7.0.13

data/lib/mongoid/contextual/mongo.rb

@@ -4,7 +4,7 @@ require "mongoid/contextual/aggregable/mongo"
 require "mongoid/contextual/command"
 require "mongoid/contextual/geo_near"
 require "mongoid/contextual/map_reduce"
-require "mongoid/relations/eager"
+require "mongoid/association/eager_loadable"
 
 module Mongoid
   module Contextual
@@ -12,7 +12,7 @@ module Mongoid
       include Enumerable
       include Aggregable::Mongo
       include Atomic
-      include Relations::Eager
+      include Association::EagerLoadable
       include Queryable
 
       # Options constant.
@@ -256,12 +256,12 @@ module Mongoid
         try_cache(:first) do
           if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none)
             if raw_doc = view.sort(sort).limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           else
             if raw_doc = view.limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           end
@@ -277,7 +277,7 @@ module Mongoid
       def find_first
         return documents.first if cached? && cache_loaded?
         if raw_doc = view.first
-          doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+          doc = Factory.from_db(klass, raw_doc, criteria)
           eager_load([doc]).first
         end
       end
@@ -368,7 +368,7 @@ module Mongoid
         try_cache(:last) do
           with_inverse_sorting(opts) do
             if raw_doc = view.limit(-1).first
-              doc = Factory.from_db(klass, raw_doc, criteria.options[:fields])
+              doc = Factory.from_db(klass, raw_doc, criteria)
               eager_load([doc]).first
             end
           end
@@ -683,7 +683,7 @@ module Mongoid
       def documents_for_iteration
         return documents if cached? && !documents.empty?
         return view unless eager_loadable?
-        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria.options[:fields]) }
+        docs = view.map{ |doc| Factory.from_db(klass, doc, criteria) }
         eager_load(docs)
       end
 
@@ -701,11 +701,13 @@ module Mongoid
       # @since 3.0.0
       def yield_document(document, &block)
         doc = document.respond_to?(:_id) ?
-            document : Factory.from_db(klass, document, criteria.options[:fields])
+            document : Factory.from_db(klass, document, criteria)
         yield(doc)
         documents.push(doc) if cacheable?
       end
 
+      private
+
       def _session
         @criteria.send(:_session)
       end

data/lib/mongoid/copyable.rb

@@ -69,15 +69,20 @@ module Mongoid
           attrs["#{name}_translations"] = value
         end
       end
-      klass.embedded_relations.each do |_, metadata|
-        next unless attrs.present? && attrs[metadata.key].present?
+      klass.embedded_relations.each do |_, association|
+        next unless attrs.present? && attrs[association.key].present?
 
-        if metadata.macro == :embeds_many
-          attrs[metadata.key].each do |attr|
-            process_localized_attributes(metadata.klass, attr)
+        if association.is_a?(Association::Embedded::EmbedsMany)
+          attrs[association.key].each do |attr|
+            embedded_klass = if type = attr['_type']
+              type.constantize
+            else
+              association.relation_class
+            end
+            process_localized_attributes(embedded_klass, attr)
           end
         else
-          process_localized_attributes(metadata.klass, attrs[metadata.key])
+          process_localized_attributes(association.klass, attrs[association.key])
         end
       end
     end

data/lib/mongoid/criteria/includable.rb

@@ -36,7 +36,7 @@ module Mongoid
       # @example Get the eager loading inclusions.
       #   Person.includes(:game).inclusions
       #
-      # @return [ Array<Metadata> ] The inclusions.
+      # @return [ Array<Association> ] The inclusions.
       #
       # @since 2.2.0
       def inclusions
@@ -46,11 +46,11 @@ module Mongoid
       # Set the inclusions for the criteria.
       #
       # @example Set the inclusions.
-      #   criteria.inclusions = [ meta ]
+      #   criteria.inclusions = [ association ]
       #
-      # @param [ Array<Metadata> ] value The inclusions.
+      # @param [ Array<Association> ] value The inclusions.
       #
-      # @return [ Array<Metadata> ] The new inclusions.
+      # @return [ Array<Association> ] The new inclusions.
       #
       # @since 3.0.0
       def inclusions=(value)
@@ -65,28 +65,28 @@ module Mongoid
       #   criteria.add_inclusion(Person, :posts)
       #
       # @param [ Class, String, Symbol ] _klass The class or string/symbol of the class name.
-      # @param [ Symbol ] metadata The relation.
+      # @param [ Symbol ] association The relation.
       #
       # @raise [ Errors::InvalidIncludes ] If no relation is found.
       #
       # @since 5.1.0
-      def add_inclusion(_klass, metadata)
-        inclusions.push(metadata) unless inclusions.include?(metadata)
+      def add_inclusion(_klass, association)
+        inclusions.push(association) unless inclusions.include?(association)
       end
 
       def extract_includes_list(_parent_class, *relations_list)
         relations_list.flatten.each do |relation_object|
           if relation_object.is_a?(Hash)
             relation_object.each do |relation, _includes|
-              metadata = _parent_class.reflect_on_association(relation)
-              raise Errors::InvalidIncludes.new(_klass, [ relation ]) unless metadata
-              add_inclusion(_parent_class, metadata)
-              extract_includes_list(metadata.klass, _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)
             end
           else
-            metadata = _parent_class.reflect_on_association(relation_object)
-            raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless metadata
-            add_inclusion(_parent_class, metadata)
+            association = _parent_class.reflect_on_association(relation_object)
+            raise Errors::InvalidIncludes.new(_parent_class, [ relation_object ]) unless association
+            add_inclusion(_parent_class, association)
           end
         end
       end

data/lib/mongoid/criteria/modifiable.rb

@@ -72,7 +72,8 @@ module Mongoid
       # @since 5.1.0
       def create_with(attrs = {})
         tap do
-          (@create_attrs ||= {}).merge!(attrs)
+          @create_attrs ||= {}
+          @create_attrs.update(attrs)
         end
       end
 
@@ -190,9 +191,13 @@ module Mongoid
         end
         if embedded?
           attributes[:_parent] = parent_document
-          attributes[:__metadata] = metadata
+          attributes[:_association] = association
+        end
+        if polymorphic? && @criterion
+          klass.__send__(method, attributes.merge(@criterion), &block)
+        else
+          klass.__send__(method, attributes, &block)
         end
-        klass.__send__(method, attributes, &block)
       end
 
       # Find the first object or create/initialize it.

data/lib/mongoid/criteria/options.rb

@@ -17,8 +17,8 @@ module Mongoid
         PersistenceContext.set(klass, options)
       end
 
-      def clear_persistence_context(original_cluster)
-        PersistenceContext.clear(klass, original_cluster)
+      def clear_persistence_context(original_cluster, original_context)
+        PersistenceContext.clear(klass, original_cluster, original_context)
       end
     end
   end

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

@@ -58,7 +58,7 @@ module Mongoid
             #
             # @since 1.0.0
             def __numeric__(object)
-              object.to_s =~ /(^[-+]?[0-9]+$)|(\.0+$)|(\.$)/ ? object.to_i : Float(object)
+              object.to_s =~ /(\A[-+]?[0-9]+\z)|(\.0+\z)|(\.\z)/ ? object.to_i : Float(object)
             end
 
             # Evolve the object to an integer.

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

@@ -10,7 +10,7 @@ module Mongoid
           # Is the object a regexp?
           #
           # @example Is the object a regex?
-          #   /^[123]/.regexp?
+          #   /\A[123]/.regexp?
           #
           # @return [ true ] Always true.
           #
@@ -22,7 +22,7 @@ module Mongoid
             # Evolve the object into a regex.
             #
             # @example Evolve the object to a regex.
-            #   Regexp.evolve("^[123]")
+            #   Regexp.evolve("\A[123]")
             #
             # @param [ Regexp, String ] object The object to evolve.
             #
@@ -53,7 +53,7 @@ module Mongoid
               # Evolve the object into a raw bson regex.
               #
               # @example Evolve the object to a regex.
-              #   BSON::Regexp::Raw.evolve("^[123]")
+              #   BSON::Regexp::Raw.evolve("\\A[123]")
               #
               # @param [ BSON::Regexp::Raw, String ] object The object to evolve.
               #

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

@@ -29,7 +29,7 @@ module Mongoid
           #
           # @since 1.0.0
           def __evolve_time__
-            ::Time.parse(self).utc
+            __mongoize_time__.utc
           end
 
           # Get the string as a mongo expression, adding $ to the front.

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

@@ -28,7 +28,7 @@ module Mongoid
           #
           # @since 1.0.0
           def __evolve_time__
-            utc
+            getutc
           end
 
           module ClassMethods

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

@@ -7,6 +7,18 @@ module Mongoid
         # This module contains additional time with zone behaviour.
         module TimeWithZone
 
+          # Evolve the time as a date, UTC midnight.
+          #
+          # @example Evolve the time to a date query format.
+          #   time.__evolve_date__
+          #
+          # @return [ Time ] The date at midnight UTC.
+          #
+          # @since 1.0.0
+          def __evolve_date__
+            ::Time.utc(year, month, day, 0, 0, 0, 0)
+          end
+
           # Evolve the time into a utc time.
           #
           # @example Evolve the time.

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

@@ -3,16 +3,75 @@ module Mongoid
   class Criteria
     module Queryable
 
-      # The key is a representation of a field in a queryable, that can be
-      # expanded to special MongoDB selectors.
+      # Key objects represent specifications for building query expressions
+      # utilizing MongoDB selectors.
+      #
+      # Simple key-value conditions are translated directly into expression
+      # hashes by Mongoid without utilizing Key objects. For example, the
+      # following condition:
+      #
+      #   Foo.where(price: 1)
+      #
+      # ... is translated to the following simple expression:
+      #
+      #   {price: 1}
+      #
+      # More complex conditions would start involving Key objects. For example:
+      #
+      #   Foo.where(:price.gt => 1)
+      #
+      # ... causes a Key instance to be created thusly:
+      #
+      #   Key.new(:price, :__override__, '$gt')
+      #
+      # This Key instance utilizes +operator+ but not +expanded+ nor +block+.
+      # The corresponding MongoDB query expression is:
+      #
+      #    {price: {'$gt' => 1}}
+      #
+      # A yet more more complex example is the following condition:
+      #
+      #   Foo.geo_spacial(:boundary.intersects_point => [1, 10])
+      #
+      # Processing this condition will cause a Key instance to be created as
+      # follows:
+      #
+      #   Key.new(:location, :__override__, '$geoIntersects', '$geometry') do |value|
+      #     { "type" => POINT, "coordinates" => value }
+      #   end
+      #
+      # ... eventually producing the following MongoDB query expression:
+      #
+      # {
+      #   boundary: {
+      #     '$geoIntersects' => {
+      #       '$geometry' => {
+      #         type: "Point" ,
+      #         coordinates: [ 1, 10 ]
+      #       }
+      #     }
+      #   }
+      # }
+      #
+      # Key instances can be thought of as procs that map a value to the
+      # MongoDB query expression required to obtain the key's condition,
+      # given the value.
       class Key
 
-        # @attribute [r] name The name of the field.
-        # @attribute [r] block The optional block to transform values.
-        # @attribute [r] operator The MongoDB query operator.
-        # @attribute [r] expanded The MongoDB expanded query operator.
-        # @attribute [r] strategy The name of the merge strategy.
-        attr_reader :block, :name, :operator, :expanded, :strategy
+        # @return [ String | Symbol ] The name of the field.
+        attr_reader :name
+
+        # @return [ String ] The MongoDB query operator.
+        attr_reader :operator
+
+        # @return [ String ] The MongoDB expanded query operator.
+        attr_reader :expanded
+
+        # @return [ Symbol ] The name of the merge strategy.
+        attr_reader :strategy
+
+        # @return [ Proc ] The optional block to transform values.
+        attr_reader :block
 
         # Does the key equal another object?
         #

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

@@ -45,7 +45,7 @@ module Mongoid
           use(:__union__)
         end
 
-        # Reset the stratgies to nil, used after cloning.
+        # Clear the current strategy and negating flag, used after cloning.
         #
         # @example Reset the strategies.
         #   mergeable.reset_strategies!
@@ -54,7 +54,8 @@ module Mongoid
         #
         # @since 1.0.0
         def reset_strategies!
-          self.strategy, self.negating = nil, nil
+          self.strategy = nil
+          self.negating = nil
         end
 
         private
@@ -167,7 +168,7 @@ module Mongoid
         # @example Add the criterion.
         #   mergeable.__override__([ 1, 2 ], "$in")
         #
-        # @param [ Hash ] criterion The criteria.
+        # @param [ Hash | Criteria ] criterion The criteria.
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
@@ -225,7 +226,7 @@ module Mongoid
         # @api private
         #
         # @example Add criterion with a strategy.
-        #   mergeable.with_strategy(:__union__, [ 1, 2, 3 ], "$in")
+        #   mergeable.with_strategy(:__union__, {field_name: [ 1, 2, 3 ]}, "$in")
         #
         # @param [ Symbol ] strategy The name of the strategy method.
         # @param [ Object ] criterion The criterion to add.

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

@@ -72,16 +72,21 @@ module Mongoid
         #
         # @example Add the unwind.
         #   pipeline.unwind(:field)
+        #   pipeline.unwind(document)
         #
-        # @param [ String, Symbol ] field The name of the field.
+        # @param [ String, Symbol, Hash ] field_or_doc The name of the field or a document.
         #
         # @return [ Pipeline ] The pipeline.
         #
         # @since 2.0.0
-        def unwind(field)
-          normalized = field.to_s
-          name = aliases[normalized] || normalized
-          push("$unwind" => name.__mongo_expression__)
+        def unwind(field_or_doc)
+          unless field_or_doc.respond_to? :keys
+            normalized = field_or_doc.to_s
+            name = aliases[normalized] || normalized
+            push("$unwind" => name.__mongo_expression__)
+          else
+            push("$unwind" => field_or_doc)
+          end
         end
 
         private

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

@@ -434,7 +434,7 @@ module Mongoid
         # @since 1.0.0
         def not(*criterion)
           if criterion.empty?
-            tap { |query| query.negating = true }
+            dup.tap { |query| query.negating = true }
           else
             __override__(criterion.first, "$not")
           end
@@ -562,6 +562,9 @@ module Mongoid
         #
         # @since 1.0.0
         def where(criterion = nil)
+          # We need to save the criterion in an instance variable so Modifiable methods
+          # know how to create a polymorphic object.
+          @criterion = criterion
           criterion.is_a?(String) ? js_query(criterion) : expr_query(criterion)
         end
 
@@ -627,8 +630,6 @@ module Mongoid
         # Take the provided criterion and store it as a selection in the query
         # selector.
         #
-        # @api private
-        #
         # @example Store the selection.
         #   selectable.selection({ field: "value" })
         #
@@ -637,6 +638,7 @@ module Mongoid
         # @return [ Selectable ] The cloned selectable.
         #
         # @since 1.0.0
+        # @api private
         def selection(criterion = nil)
           clone.tap do |query|
             if criterion

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

@@ -21,9 +21,10 @@ module Mongoid
           other.each_pair do |key, value|
             if value.is_a?(Hash) && self[key.to_s].is_a?(Hash)
               value = self[key.to_s].merge(value) do |_key, old_val, new_val|
-                if in?(_key)
+                case _key
+                when '$in'
                   new_val & old_val
-                elsif nin?(_key)
+                when '$nin'
                   (old_val + new_val).uniq
                 else
                   new_val
@@ -52,10 +53,13 @@ module Mongoid
         def store(key, value)
           name, serializer = storage_pair(key)
           if multi_selection?(name)
-            super(name, evolve_multi(value))
+            store_name = name
+            store_value = evolve_multi(value)
           else
-            super(localized_key(name, serializer), evolve(serializer, value))
+            store_name = localized_key(name, serializer)
+            store_value = evolve(serializer, value)
           end
+          super(store_name, store_value)
         end
         alias :[]= :store
 
@@ -178,33 +182,7 @@ module Mongoid
         #
         # @since 1.0.0
         def multi_selection?(key)
-          key =~ /\$and|\$or|\$nor/
-        end
-
-        # Determines if the selection operator takes a list. Returns true for $in and $nin.
-        #
-        # @api private
-        #
-        # @example Does the selection operator take multiple values?
-        #   selector.multi_value?("$nin")
-        #
-        # @param [ String ] key The key to check.
-        #
-        # @return [ true, false ] If the key is $in or $nin.
-        #
-        # @since 2.1.1
-        def multi_value?(key)
-          key =~ /\$nin|\$in/
-        end
-
-        private
-
-        def in?(key)
-          key =~ /\$in/
-        end
-
-        def nin?(key)
-          key =~ /\$nin/
+          %w($and $or $nor).include?(key)
         end
       end
     end

data/lib/mongoid/criteria.rb

@@ -27,8 +27,8 @@ module Mongoid
     include Modifiable
     include Scopable
     include Clients::Options
-    include Options
     include Clients::Sessions
+    include Options
 
     # Static array used to check with method missing - we only need to ever
     # instantiate once.
@@ -36,7 +36,7 @@ module Mongoid
     # @since 4.0.0
     CHECK = []
 
-    attr_accessor :embedded, :klass, :parent_document, :metadata
+    attr_accessor :embedded, :klass, :parent_document, :association
 
     # Returns true if the supplied +Enumerable+ or +Criteria+ is equal to the results
     # of this +Criteria+ or the criteria itself.
@@ -435,7 +435,13 @@ module Mongoid
     #
     # @since 3.1.0
     def for_js(javascript, scope = {})
-      js_query(BSON::CodeWithScope.new(javascript, scope))
+      code = if scope.empty?
+        # CodeWithScope is not supported for $where as of MongoDB 4.4
+        BSON::Code.new(javascript)
+      else
+        BSON::CodeWithScope.new(javascript, scope)
+      end
+      js_query(code)
     end
 
     private

data/lib/mongoid/document.rb

@@ -4,7 +4,6 @@ require "mongoid/evolvable"
 require "mongoid/extensions"
 require "mongoid/errors"
 require "mongoid/threaded"
-require "mongoid/relations"
 require "mongoid/atomic"
 require "mongoid/attributes"
 require "mongoid/contextual"
@@ -14,7 +13,9 @@ require "mongoid/criteria"
 require "mongoid/factory"
 require "mongoid/fields"
 require "mongoid/timestamps"
+require "mongoid/association"
 require "mongoid/composable"
+require "mongoid/touchable"
 
 module Mongoid
 
@@ -23,6 +24,7 @@ module Mongoid
   module Document
     extend ActiveSupport::Concern
     include Composable
+    include Mongoid::Touchable::InstanceMethods
 
     attr_accessor :__selected_fields
     attr_reader :new_record
@@ -178,6 +180,13 @@ module Mongoid
 
     # Calls #as_json on the document with additional, Mongoid-specific options.
     #
+    # @note Rails 6 changes return value of as_json for non-primitive types
+    #   such as BSON::ObjectId. In Rails <= 5, as_json returned these as
+    #   instances of the class. In Rails 6, these are returned serialized to
+    #   primitive types (e.g. {"$oid"=>"5bcfc40bde340b37feda98e9"}).
+    #   See https://github.com/rails/rails/commit/2e5cb980a448e7f4ab00df6e9ad4c1cc456616aa
+    #   for more information.
+    #
     # @example Get the document as json.
     #   document.as_json(compact: true)
     #
@@ -218,8 +227,9 @@ module Mongoid
       became = klass.new(clone_document)
       became._id = _id
       became.instance_variable_set(:@changed_attributes, changed_attributes)
-      became.instance_variable_set(:@errors, ActiveModel::Errors.new(became))
-      became.errors.instance_variable_set(:@messages, errors.instance_variable_get(:@messages))
+      new_errors = ActiveModel::Errors.new(became)
+      new_errors.copy!(errors)
+      became.instance_variable_set(:@errors, new_errors)
       became.instance_variable_set(:@new_record, new_record?)
       became.instance_variable_set(:@destroyed, destroyed?)
       became.changed_attributes["_type"] = self.class.to_s
@@ -281,7 +291,7 @@ module Mongoid
         without_autobuild do
           relation, stored = send(name), meta.store_as
           if attributes.key?(stored) || !relation.blank?
-            if relation
+            if !relation.nil?
               attributes[stored] = relation.send(:as_attributes)
             else
               attributes.delete(stored)

data/lib/mongoid/errors/invalid_dependent_strategy.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid
+  module Errors
+
+    # This error is raised when an invalid strategy is defined for an association dependency.
+    class InvalidDependentStrategy < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   InvalidDependentStrategy.new(association, invalid_strategy, valid_strategies)
+      #
+      # @param [ Mongoid::Association ] association The association for which this
+      #   dependency is defined.
+      # @param [ Symbol, String ] invalid_strategy The attempted invalid strategy.
+      # @param [ Array<Symbol> ] valid_strategies The valid strategies.
+      #
+      # @since 7.0.0
+      def initialize(association, invalid_strategy, valid_strategies)
+        super(
+            compose_message(
+                "invalid_dependent_strategy",
+                { association: association,
+                  invalid_strategy: invalid_strategy,
+                  valid_strategies: valid_strategies
+                }
+            )
+        )
+      end
+    end
+  end
+end