mongoid 7.5.3 → 8.1.2

data/lib/mongoid/association/macros.rb

@@ -34,10 +34,16 @@ module Mongoid
         #
         # @api private
         class_attribute :aliased_associations
+
+        # @return [ Set<String> ] The set of associations that are configured 
+        #   with :store_as parameter.
+        class_attribute :stored_as_associations
+
         self.embedded = false
         self.embedded_relations = BSON::Document.new
         self.relations = BSON::Document.new
         self.aliased_associations = {}
+        self.stored_as_associations = Set.new
       end
 
       # This is convenience for libraries still on the old API.
@@ -216,8 +222,9 @@ module Mongoid
           Association::MACRO_MAPPING[macro_name].new(self, name, options, &block).tap do |assoc|
             assoc.setup!
             self.relations = self.relations.merge(name => assoc)
-            if assoc.respond_to?(:store_as) && assoc.store_as != name
+            if assoc.embedded? && assoc.respond_to?(:store_as) && assoc.store_as != name
               self.aliased_associations[assoc.store_as] = name
+              self.stored_as_associations << assoc.store_as
             end
           end
         end

data/lib/mongoid/association/many.rb

@@ -17,7 +17,7 @@ module Mongoid
       # @example Is the association empty??
       #   person.addresses.blank?
       #
-      # @return [ true, false ] If the association is empty or not.
+      # @return [ true | false ] If the association is empty or not.
       def blank?
         !any?
       end
@@ -28,7 +28,6 @@ module Mongoid
       # @example Create and save the new document.
       #   person.posts.create(:text => "Testing")
       #
-      #
       # @param [ Hash ] attributes The attributes to create with.
       # @param [ Class ] type The optional type of document to create.
       #
@@ -61,6 +60,11 @@ module Mongoid
           attributes.map { |attrs| create!(attrs, type, &block) }
         else
           doc = build(attributes, type, &block)
+
+          Array(doc).each do |doc|
+            doc.try(:run_pending_callbacks)
+          end
+
           _base.persisted? ? doc.save! : raise_unsaved(doc)
           doc
         end
@@ -126,9 +130,9 @@ module Mongoid
       #   relation.respond_to?(:name)
       #
       # @param [ Symbol ] name The method name.
-      # @param [ true, false ] include_private Whether to include private methods.
+      # @param [ true | false ] include_private Whether to include private methods.
       #
-      # @return [ true, false ] If the proxy responds to the method.
+      # @return [ true | false ] If the proxy responds to the method.
       def respond_to?(name, include_private = false)
         [].respond_to?(name, include_private) ||
           klass.respond_to?(name, include_private) || super
@@ -153,9 +157,9 @@ module Mongoid
       #
       # @param [ Hash ] options The options to pass.
       #
-      # @option options [ Symbol ] :include What associations to include
-      # @option options [ Symbol ] :only Limit the fields to only these.
-      # @option options [ Symbol ] :except Dont include these fields.
+      # @option options [ Symbol | String | Array<Symbol | String> ] :except Do not include these field(s).
+      # @option options [ Symbol | String | Array<Symbol | String> ] :include Which association(s) to include.
+      # @option options [ Symbol | String | Array<Symbol | String> ] :only Limit the field(s) to only these.
       #
       # @return [ Hash ] The documents, ready to be serialized.
       def serializable_hash(options = {})

data/lib/mongoid/association/nested/many.rb

@@ -65,7 +65,7 @@ module Mongoid
         #
         # @param [ Hash ] attributes The attributes to pull the flag from.
         #
-        # @return [ true, false ] If the association can potentially be deleted.
+        # @return [ true | false ] If the association can potentially be deleted.
         def destroyable?(attributes)
           destroy = attributes.delete(:_destroy)
           Nested::DESTROY_FLAGS.include?(destroy) && allow_destroy?
@@ -79,7 +79,7 @@ module Mongoid
         #
         # @param [ Hash ] attributes The attributes being set.
         #
-        # @return [ true, false ] If the attributes exceed the limit.
+        # @return [ true | false ] If the attributes exceed the limit.
         def over_limit?(attributes)
           limit = options[:limit]
           limit ? attributes.size > limit : false
@@ -134,8 +134,9 @@ module Mongoid
         # @param [ Proxy ] relation The association proxy.
         # @param [ Document ] doc The document to delete.
         def destroy_document(relation, doc)
+          res = doc.destroy unless doc.embedded? || doc.destroyed?
           relation.delete(doc)
-          doc.destroy unless doc.embedded? || doc.destroyed?
+          res
         end
 
         # Update the document.
@@ -164,7 +165,7 @@ module Mongoid
         #   builder.update_nested_relation(parent, id, attrs)
         #
         # @param [ Document ] parent The parent document.
-        # @param [ String, BSON::ObjectId ] id of the related document.
+        # @param [ String | BSON::ObjectId ] id of the related document.
         # @param [ Hash ] attrs The single document attributes to process.
         def update_nested_relation(parent, id, attrs)
           first = existing.first

data/lib/mongoid/association/nested/nested_buildable.rb

@@ -12,7 +12,7 @@ module Mongoid
         # @example Do we allow a destroy?
         #   builder.allow_destroy?
         #
-        # @return [ true, false ] True if the allow destroy option was set.
+        # @return [ true | false ] True if the allow destroy option was set.
         def allow_destroy?
           options[:allow_destroy] || false
         end
@@ -25,7 +25,7 @@ module Mongoid
         # @param [ Document ] document The parent document of the association
         # @param [ Hash ] attrs The attributes to check for rejection.
         #
-        # @return [ true, false ] True and call proc or method if rejectable, false if not.
+        # @return [ true | false ] True and call proc or method if rejectable, false if not.
         def reject?(document, attrs)
           case callback = options[:reject_if]
             when Symbol
@@ -43,7 +43,7 @@ module Mongoid
         # @example Is this update only?
         #   builder.update_only?
         #
-        # @return [ true, false ] True if the update_only option was set.
+        # @return [ true | false ] True if the update_only option was set.
         def update_only?
           options[:update_only] || false
         end
@@ -56,7 +56,7 @@ module Mongoid
         # @param [ Class ] klass The class we're trying to convert for.
         # @param [ String ] id The id, usually coming from the form.
         #
-        # @return [ BSON::ObjectId, String, Object ] The converted id.
+        # @return [ BSON::ObjectId | String | Object ] The converted id.
         def convert_id(klass, id)
           klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
         end

data/lib/mongoid/association/nested/one.rb

@@ -32,6 +32,8 @@ module Mongoid
             parent.send(association.setter, Factory.build(@class_name, attributes))
           elsif delete?
             parent.send(association.setter, nil)
+          else
+            check_for_id_violation!
           end
         end
 
@@ -54,6 +56,17 @@ module Mongoid
 
         private
 
+        # Extracts and converts the id to the expected type.
+        #
+        # @return [ BSON::ObjectId | String | Object | nil ] The converted id,
+        #   or nil if no id is present in the attributes hash.
+        def extracted_id
+          @extracted_id ||= begin
+            id = association.klass.extract_id_field(attributes)
+            convert_id(existing.class, id)
+          end
+        end
+
         # Is the id in the attributes acceptable for allowing an update to
         # the existing association?
         #
@@ -62,10 +75,9 @@ module Mongoid
         # @example Is the id acceptable?
         #   one.acceptable_id?
         #
-        # @return [ true, false ] If the id part of the logic will allow an update.
+        # @return [ true | false ] If the id part of the logic will allow an update.
         def acceptable_id?
-          id = association.klass.extract_id_field(attributes)
-          id = convert_id(existing.class, id)
+          id = extracted_id
           existing._id == id || id.nil? || (existing._id != id && update_only?)
         end
 
@@ -74,7 +86,7 @@ module Mongoid
         # @example Can the existing object be deleted?
         #   one.delete?
         #
-        # @return [ true, false ] If the association should be deleted.
+        # @return [ true | false ] If the association should be deleted.
         def delete?
           id = association.klass.extract_id_field(attributes)
           destroyable? && !id.nil?
@@ -85,7 +97,7 @@ module Mongoid
         # @example Is the object destroyable?
         #   one.destroyable?({ :_destroy => "1" })
         #
-        # @return [ true, false ] If the association can potentially be
+        # @return [ true | false ] If the association can potentially be
         #   destroyed.
         def destroyable?
           Nested::DESTROY_FLAGS.include?(destroy) && allow_destroy?
@@ -96,7 +108,7 @@ module Mongoid
         # @example Is the document to be replaced?
         #   one.replace?
         #
-        # @return [ true, false ] If the document should be replaced.
+        # @return [ true | false ] If the document should be replaced.
         def replace?
           !existing && !destroyable? && !attributes.blank?
         end
@@ -106,10 +118,36 @@ module Mongoid
         # @example Should the document be updated?
         #   one.update?
         #
-        # @return [ true, false ] If the object should have its attributes updated.
+        # @return [ true | false ] If the object should have its attributes updated.
         def update?
           existing && !destroyable? && acceptable_id?
         end
+
+        # Checks to see if the _id attribute (which is supposed to be
+        # immutable) is being asked to change. If so, raise an exception.
+        #
+        # If Mongoid::Config.immutable_ids is false, this will do nothing,
+        # and the update operation will fail silently.
+        #
+        # @raise [ Errors::ImmutableAttribute ] if _id has changed, and
+        #   the document has been persisted.
+        def check_for_id_violation!
+          # look for the basic criteria of an update (see #update?)
+          return unless existing&.persisted? && !destroyable?
+
+          # if the id is either absent, or if it equals the existing record's
+          # id, there is no immutability violation.
+          id = extracted_id
+          return if existing._id == id || id.nil?
+
+          # otherwise, an attempt has been made to set the _id of an existing,
+          # persisted document.
+          if Mongoid::Config.immutable_ids
+            raise Errors::ImmutableAttribute.new(:_id, id)
+          else
+            Mongoid::Warnings.warn_mutable_ids
+          end
+        end
       end
     end
   end

data/lib/mongoid/association/one.rb

@@ -12,7 +12,7 @@ module Mongoid
       # @example Clear the relation.
       #   relation.clear
       #
-      # @return [ true, false ] If the delete succeeded.
+      # @return [ true | false ] If the delete succeeded.
       def clear
         _target.delete
       end
@@ -34,7 +34,7 @@ module Mongoid
       #
       # @param [ Symbol ] name The method name.
       #
-      # @return [ true, false ] If the proxy responds to the method.
+      # @return [ true | false ] If the proxy responds to the method.
       def respond_to?(name, include_private = false)
         _target.respond_to?(name, include_private) || super
       end

data/lib/mongoid/association/options.rb

@@ -7,7 +7,7 @@ module Mongoid
 
       # Returns the name of the parent to a polymorphic child.
       #
-      # @return [ String, Symbol ] The name.
+      # @return [ String | Symbol ] The name.
       def as
         @options[:as]
       end
@@ -28,21 +28,21 @@ module Mongoid
 
       # Whether to index the primary or foreign key field.
       #
-      # @return [ true, false ]
+      # @return [ true | false ]
       def indexed?
         @indexed ||= !!@options[:index]
       end
 
       # Whether the association is autobuilding.
       #
-      # @return [ true, false ]
+      # @return [ true | false ]
       def autobuilding?
         !!@options[:autobuild]
       end
 
       # Is the association cyclic.
       #
-      # @return [ true, false ] Whether the association is cyclic.
+      # @return [ true | false ] Whether the association is cyclic.
       def cyclic?
         !!@options[:cyclic]
       end
@@ -57,7 +57,7 @@ module Mongoid
       # Mongoid assumes that the field used to hold the primary key of the association is id.
       # You can override this and explicitly specify the primary key with the :primary_key option.
       #
-      # @return [ Symbol, String ] The primary key.
+      # @return [ Symbol | String ] The primary key.
       def primary_key
         @primary_key ||= @options[:primary_key] ? @options[:primary_key].to_s : Relatable::PRIMARY_KEY_DEFAULT
       end
@@ -65,7 +65,7 @@ module Mongoid
       # Options to save any loaded members and destroy members that are marked for destruction
       # when the parent object is saved.
       #
-      # @return [ true, false ] The autosave option.
+      # @return [ true | false ] The autosave option.
       def autosave
         !!@options[:autosave]
       end
@@ -73,19 +73,19 @@ module Mongoid
 
       # Whether the association is counter-cached.
       #
-      # @return [ true, false ]
+      # @return [ true | false ]
       def counter_cached?
         !!@options[:counter_cache]
       end
 
       # Whether this association is polymorphic.
       #
-      # @return [ true, false ] Whether the association is polymorphic.
+      # @return [ true | false ] Whether the association is polymorphic.
       def polymorphic?; false; end
 
       # Whether the association has callbacks cascaded down from the parent.
       #
-      # @return [ true, false ] Whether callbacks are cascaded.
+      # @return [ true | false ] Whether callbacks are cascaded.
       def cascading_callbacks?
         !!@options[:cascade_callbacks]
       end

data/lib/mongoid/association/proxy.rb

@@ -48,7 +48,7 @@ module Mongoid
       #   proxy.init(person, name, association)
       #
       # @param [ Document ] base The base document on the proxy.
-      # @param [ Document, Array<Document> ] target The target of the proxy.
+      # @param [ Document | Array<Document> ] target The target of the proxy.
       # @param [ Association ] association The association metadata.
       def init(base, target, association)
         @_base, @_target, @_association = base, target, association
@@ -117,9 +117,8 @@ module Mongoid
       # Default behavior of method missing should be to delegate all calls
       # to the target of the proxy. This can be overridden in special cases.
       #
-      # @param [ String, Symbol ] name The name of the method.
-      # @param [ Array ] args The arguments passed to the method.
-      #
+      # @param [ String | Symbol ] name The name of the method.
+      # @param [ Object... ] *args The arguments passed to the method.
       ruby2_keywords def method_missing(name, *args, &block)
         _target.send(name, *args, &block)
       end
@@ -169,6 +168,18 @@ module Mongoid
         end
       end
 
+      # Execute the before and after callbacks for the given method.
+      #
+      # @param [ Symbol ] name The name of the callbacks to execute.
+      #
+      # @return [ Object ] The result of the given block
+      def execute_callbacks_around(name, doc)
+        execute_callback :"before_#{name.to_s}", doc
+        yield.tap do
+          execute_callback :"after_#{name.to_s}", doc
+        end
+      end
+
       class << self
 
         # Apply ordering to the criteria if it was defined on the association.

data/lib/mongoid/association/referenced/auto_save.rb

@@ -12,7 +12,7 @@ module Mongoid
         # @example Is the document autosaved?
         #   document.autosaved?
         #
-        # @return [ true, false ] Has the document already been autosaved?
+        # @return [ true | false ] Has the document already been autosaved?
         def autosaved?
           Threaded.autosaved?(self)
         end
@@ -56,7 +56,8 @@ module Mongoid
                 __autosaving__ do
                   if assoc_value = ivar(association.name)
                     Array(assoc_value).each do |doc|
-                      doc.with(persistence_context) do |d|
+                      pc = doc.persistence_context? ? doc.persistence_context : persistence_context
+                      doc.with(pc) do |d|
                         d.save
                       end
                     end
@@ -64,7 +65,7 @@ module Mongoid
                 end
               end
             end
-            klass.after_save save_method, unless: :autosaved?
+            klass.after_persist_parent save_method, unless: :autosaved?
           end
         end
       end

data/lib/mongoid/association/referenced/belongs_to/binding.rb

@@ -28,6 +28,7 @@ module Mongoid
                   if _base.referenced_many?
                     _target.__send__(inverse).push(_base)
                   else
+                    remove_associated(_target)
                     _target.set_relation(inverse, _base)
                   end
                 end

data/lib/mongoid/association/referenced/belongs_to/buildable.rb

@@ -28,7 +28,7 @@ module Mongoid
           private
 
           def execute_query(object, type)
-            query_criteria(object, type).limit(1).first(id_sort: :none)
+            query_criteria(object, type).take
           end
 
           def query_criteria(object, type)

data/lib/mongoid/association/referenced/belongs_to/proxy.rb

@@ -18,7 +18,7 @@ module Mongoid
           #   Association::BelongsTo::Proxy.new(game, person, association)
           #
           # @param [ Document ] base The document this association hangs off of.
-          # @param [ Document, Array<Document> ] target The target (parent) of the
+          # @param [ Document | Array<Document> ] target The target (parent) of the
           #   association.
           # @param [ Association ] association The association object.
           def initialize(base, target, association)
@@ -34,7 +34,6 @@ module Mongoid
           #
           # @example Nullify the association.
           #   person.game.nullify
-          #
           def nullify
             unbind_one
             _target.save
@@ -46,9 +45,9 @@ module Mongoid
           # @example Substitute the association.
           #   name.substitute(new_name)
           #
-          # @param [ Document, Array<Document> ] replacement The replacement.
+          # @param [ Document | Array<Document> ] replacement The replacement.
           #
-          # @return [ self, nil ] The association or nil.
+          # @return [ self | nil ] The association or nil.
           def substitute(replacement)
             unbind_one
             if replacement
@@ -77,7 +76,7 @@ module Mongoid
           # @example Normalize the substitute.
           #   proxy.normalize(id)
           #
-          # @param [ Document, Object ] replacement The replacement object.
+          # @param [ Document | Object ] replacement The replacement object.
           #
           # @return [ Document ] The document.
           def normalize(replacement)
@@ -90,7 +89,7 @@ module Mongoid
           # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the association is persistable.
+          # @return [ true | false ] If the association is persistable.
           def persistable?
             _target.persisted? && !_binding? && !_building?
           end

data/lib/mongoid/association/referenced/belongs_to.rb

@@ -97,7 +97,7 @@ module Mongoid
 
         # Is this association polymorphic?
         #
-        # @return [ true, false ] Whether this association is polymorphic.
+        # @return [ true | false ] Whether this association is polymorphic.
         def polymorphic?
           @polymorphic ||= !!@options[:polymorphic]
         end
@@ -153,7 +153,7 @@ module Mongoid
           create_foreign_key_field!
           setup_index!
           define_touchable!
-          @owner_class.validates_associated(name) if validate?
+          @owner_class.validates_associated(name) if validate? || require_association?
           @owner_class.validates(name, presence: true) if require_association?
         end
 

data/lib/mongoid/association/referenced/counter_cache.rb

@@ -13,7 +13,7 @@ module Mongoid
         # @example Reset the given counter cache
         #   post.reset_counters(:comments)
         #
-        # @param [ Symbol, Array ] counters One or more counter caches to reset
+        # @param [ Symbol... ] *counters One or more counter caches to reset.
         def reset_counters(*counters)
           self.class.with(persistence_context) do |_class|
             _class.reset_counters(self, *counters)
@@ -30,7 +30,7 @@ module Mongoid
           #   Post.reset_counters('50e0edd97c71c17ea9000001', :comments)
           #
           # @param [ String ] id The id of the object that will be reset.
-          # @param [ Symbol, Array ] counters One or more counter caches to reset
+          # @param [ Symbol... ] *counters One or more counter caches to reset.
           def reset_counters(id, *counters)
             document = id.is_a?(Document) ? id : find(id)
             counters.each do |name|
@@ -97,18 +97,18 @@ module Mongoid
 
           association.inverse_class.tap do |klass|
             klass.after_update do
-              if record = __send__(name)
-                foreign_key = association.foreign_key
+              foreign_key = association.foreign_key
 
-                if attribute_changed?(foreign_key)
-                  original, current = attribute_change(foreign_key)
+              if send("#{foreign_key}_previously_changed?")
+                original, current = send("#{foreign_key}_previous_change")
 
-                  unless original.nil?
-                    record.class.with(persistence_context) do |_class|
-                      _class.decrement_counter(cache_column, original)
-                    end
+                unless original.nil?
+                  association.klass.with(persistence_context) do |_class|
+                    _class.decrement_counter(cache_column, original)
                   end
+                end
 
+                if record = __send__(name)
                   unless current.nil?
                     record[cache_column] = (record[cache_column] || 0) + 1
                     record.class.with(record.persistence_context) do |_class|

data/lib/mongoid/association/referenced/eager.rb

@@ -85,7 +85,7 @@ module Mongoid
           #   loader.set_on_parent("foo", docs)
           #
           # @param [ ObjectId ] id parent`s id
-          # @param [ Document, Array ] element to push into the parent
+          # @param [ Document | Array ] element to push into the parent
           def set_on_parent(id, element)
             grouped_docs[id].each do |d|
               set_relation(d, element)
@@ -140,7 +140,7 @@ module Mongoid
           #   loader.set_relation(doc, docs)
           #
           # @param [ Document ] doc The object to set the association on
-          # @param [ Document, Array ] element to set into the parent
+          # @param [ Document | Array ] element to set into the parent
           def set_relation(doc, element)
             doc.set_relation(@association.name, element) unless doc.blank?
           end