mongoid 7.0.2 → 8.1.1

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Nested
@@ -8,21 +9,19 @@ module Mongoid
         attr_accessor :destroy
 
 
-        # Builds the relation depending on the attributes and the options
+        # Builds the association depending on the attributes and the options
         # passed to the macro.
         #
         # @example Build a 1-1 nested document.
         #   one.build(person, as: :admin)
         #
         # @note This attempts to perform 3 operations, either one of an update of
-        #   the existing relation, a replacement of the relation with a new
-        #   document, or a removal of the relation.
+        #   the existing association, a replacement of the association with a new
+        #   document, or a removal of the association.
         #
         # @param [ Document ] parent The parent document.
         #
         # @return [ Document ] The built document.
-        #
-        # @since 2.0.0
         def build(parent)
           return if reject?(parent, attributes)
           @existing = parent.send(association.name)
@@ -33,11 +32,13 @@ 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
 
         # Create the new builder for nested attributes on one-to-one
-        # relations.
+        # associations.
         #
         # @example Instantiate the builder.
         #   One.new(association, attributes)
@@ -45,8 +46,6 @@ module Mongoid
         # @param [ Association ] association The association metadata.
         # @param [ Hash ] attributes The attributes hash to attempt to set.
         # @param [ Hash ] options The options defined.
-        #
-        # @since 2.0.0
         def initialize(association, attributes, options)
           @attributes = attributes.with_indifferent_access
           @association = association
@@ -57,43 +56,49 @@ module Mongoid
 
         private
 
-        # Is the id in the attribtues acceptable for allowing an update to
-        # the existing relation?
+        # 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?
         #
         # @api private
         #
         # @example Is the id acceptable?
         #   one.acceptable_id?
         #
-        # @return [ true, false ] If the id part of the logic will allow an update.
-        #
-        # @since 2.0.0
+        # @return [ true | false ] If the id part of the logic will allow an update.
         def acceptable_id?
-          id = convert_id(existing.class, attributes[:id])
+          id = extracted_id
           existing._id == id || id.nil? || (existing._id != id && update_only?)
         end
 
-        # Can the existing relation be deleted?
+        # Can the existing association be deleted?
         #
         # @example Can the existing object be deleted?
         #   one.delete?
         #
-        # @return [ true, false ] If the relation should be deleted.
-        #
-        # @since 2.0.0
+        # @return [ true | false ] If the association should be deleted.
         def delete?
-          destroyable? && !attributes[:id].nil?
+          id = association.klass.extract_id_field(attributes)
+          destroyable? && !id.nil?
         end
 
-        # Can the existing relation potentially be destroyed?
+        # Can the existing association potentially be destroyed?
         #
         # @example Is the object destroyable?
         #   one.destroyable?({ :_destroy => "1" })
         #
-        # @return [ true, false ] If the relation can potentially be
+        # @return [ true | false ] If the association can potentially be
         #   destroyed.
-        #
-        # @since 2.0.0
         def destroyable?
           Nested::DESTROY_FLAGS.include?(destroy) && allow_destroy?
         end
@@ -103,9 +108,7 @@ module Mongoid
         # @example Is the document to be replaced?
         #   one.replace?
         #
-        # @return [ true, false ] If the document should be replaced.
-        #
-        # @since 2.0.0
+        # @return [ true | false ] If the document should be replaced.
         def replace?
           !existing && !destroyable? && !attributes.blank?
         end
@@ -115,12 +118,36 @@ module Mongoid
         # @example Should the document be updated?
         #   one.update?
         #
-        # @return [ true, false ] If the object should have its attributes updated.
-        #
-        # @since 2.0.0
+        # @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/nested.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/nested/nested_buildable'
 require 'mongoid/association/nested/many'
 require 'mongoid/association/nested/one'
@@ -6,9 +8,7 @@ module Mongoid
   module Association
     module Nested
 
-      # The flags indicating that a relation can be destroyed.
-      #
-      # @since 7.0
+      # The flags indicating that an association can be destroyed.
       DESTROY_FLAGS = [1, "1", true, "true"].freeze
     end
   end

data/lib/mongoid/association/one.rb

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
     # This is the superclass for one to one relations and defines the common
-    # behaviour or those proxies.
+    # behavior or those proxies.
     class One < Association::Proxy
 
       # Clear this relation - same as calling #delete on the document.
@@ -11,9 +12,7 @@ module Mongoid
       # @example Clear the relation.
       #   relation.clear
       #
-      # @return [ true, false ] If the delete suceeded.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the delete succeeded.
       def clear
         _target.delete
       end
@@ -24,8 +23,6 @@ module Mongoid
       #   relation.in_memory
       #
       # @return [ Array<Document> ] The documents in memory.
-      #
-      # @since 2.1.0
       def in_memory
         [ _target ]
       end
@@ -37,9 +34,7 @@ module Mongoid
       #
       # @param [ Symbol ] name The method name.
       #
-      # @return [ true, false ] If the proxy responds to the method.
-      #
-      # @since 2.1.8
+      # @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
@@ -50,8 +45,6 @@ module Mongoid
       #   proxy.__evolve_object_id__
       #
       # @return [ Object ] The proxy document's id.
-      #
-      # @since 4.0.0
       def __evolve_object_id__
         _target._id
       end

data/lib/mongoid/association/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
@@ -5,9 +7,7 @@ module Mongoid
 
       # Returns the name of the parent to a polymorphic child.
       #
-      # @return [ String, Symbol ] The name.
-      #
-      # @since 7.0
+      # @return [ String | Symbol ] The name.
       def as
         @options[:as]
       end
@@ -15,53 +15,41 @@ module Mongoid
       # Specify what happens to the associated object when the owner is destroyed.
       #
       # @return [ String ] The dependent option.
-      #
-      # @since 7.0
       def dependent
         @options[:dependent]
       end
 
-      # The custom sorting options on the relation.
+      # The custom sorting options on the association.
       #
       # @return [ Criteria::Queryable::Key ] The custom sorting options.
-      #
-      # @since 7.0
       def order
         @options[:order]
       end
 
       # Whether to index the primary or foreign key field.
       #
-      # @return [ true, false ]
-      #
-      # @since 7.0
+      # @return [ true | false ]
       def indexed?
         @indexed ||= !!@options[:index]
       end
 
       # Whether the association is autobuilding.
       #
-      # @return [ true, false ]
-      #
-      # @since 7.0
+      # @return [ true | false ]
       def autobuilding?
         !!@options[:autobuild]
       end
 
-      # Is the relation cyclic.
-      #
-      # @return [ true, false ] Whether the relation is cyclic.
+      # Is the association cyclic.
       #
-      # @since 7.0
+      # @return [ true | false ] Whether the association is cyclic.
       def cyclic?
         !!@options[:cyclic]
       end
 
-      # The name the owning object uses to refer to this relation.
+      # The name the owning object uses to refer to this association.
       #
       # @return [ String ] The inverse_of option.
-      #
-      # @since 7.0
       def inverse_of
         @options[:inverse_of]
       end
@@ -69,9 +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.
-      #
-      # @since 7.0
+      # @return [ Symbol | String ] The primary key.
       def primary_key
         @primary_key ||= @options[:primary_key] ? @options[:primary_key].to_s : Relatable::PRIMARY_KEY_DEFAULT
       end
@@ -79,9 +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.
-      #
-      # @since 7.0
+      # @return [ true | false ] The autosave option.
       def autosave
         !!@options[:autosave]
       end
@@ -89,25 +73,19 @@ module Mongoid
 
       # Whether the association is counter-cached.
       #
-      # @return [ true, false ]
-      #
-      # @since 7.0
+      # @return [ true | false ]
       def counter_cached?
         !!@options[:counter_cache]
       end
 
       # Whether this association is polymorphic.
       #
-      # @return [ true, false ] Whether the association is polymorphic.
-      #
-      # @since 7.0
+      # @return [ true | false ] Whether the association is polymorphic.
       def polymorphic?; false; end
 
-      # Whether the relation has callbacks cascaded down from the parent.
-      #
-      # @return [ true, false ] Whether callbacks are cascaded.
+      # Whether the association has callbacks cascaded down from the parent.
       #
-      # @since 7.0
+      # @return [ true | false ] Whether callbacks are cascaded.
       def cascading_callbacks?
         !!@options[:cascade_callbacks]
       end
@@ -115,29 +93,21 @@ module Mongoid
       # The store_as option.
       #
       # @return [ nil ] Default is nil.
-      #
-      # @since 7.0
       def store_as; end
 
       # Whether the association has forced nil inverse (So no foreign keys are saved).
       #
       # @return [ false ] Default is false.
-      #
-      # @since 7.0
       def forced_nil_inverse?; false; end
 
       # The field for saving the associated object's type.
       #
       # @return [ nil ] Default is nil.
-      #
-      # @since 7.0
       def type; end
 
       # The field for saving the associated object's type.
       #
       # @return [ nil ] Default is nil.
-      #
-      # @since 7.0
       def touch_field
         @touch_field ||= options[:touch] if (options[:touch].is_a?(String) || options[:touch].is_a?(Symbol))
       end
@@ -149,4 +119,4 @@ module Mongoid
       end
     end
   end
-end
+end

data/lib/mongoid/association/proxy.rb

@@ -1,29 +1,45 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/association/marshalable"
 
 module Mongoid
   module Association
 
-    # This class is the superclass for all relation proxy objects, and contains
-    # common behaviour for all of them.
+    # This class is the superclass for all association proxy objects, and contains
+    # common behavior for all of them.
     class Proxy
+      extend Forwardable
+
       alias :extend_proxy :extend
 
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
         undef_method(method) unless
-          method =~ /^(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)$/
+          method =~ /\A(?:__.*|send|object_id|equal\?|respond_to\?|respond_to_missing\?|tap|public_send|extend_proxy|extend_proxies)\z/
       end
 
       include Threaded::Lifecycle
       include Marshalable
 
-      attr_accessor :_base, :_association, :_target
+      # Model instance for the base of the association.
+      #
+      # For example, if a Post embeds_many Comments, _base is a particular
+      # instance of the Post model.
+      attr_accessor :_base
+
+      attr_accessor :_association
+
+      # Model instance for one to one associations, or array of model instances
+      # for one to many associations, for the target of the association.
+      #
+      # For example, if a Post embeds_many Comments, _target is an array of
+      # Comment models embedded in a particular Post.
+      attr_accessor :_target
 
       # Backwards compatibility with Mongoid beta releases.
-      delegate :foreign_key, :inverse_foreign_key, to: :_association
-      delegate :bind_one, :unbind_one, to: :binding
-      delegate :collection_name, to: :_base
+      def_delegators :_association, :foreign_key, :inverse_foreign_key
+      def_delegators :binding, :bind_one, :unbind_one
+      def_delegator :_base, :collection_name
 
       # Convenience for setting the target and the association metadata properties since
       # all proxies will need to do this.
@@ -32,10 +48,8 @@ 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.
-      #
-      # @since 2.0.0.rc.1
       def init(base, target, association)
         @_base, @_target, @_association = base, target, association
         yield(self) if block_given?
@@ -52,33 +66,27 @@ module Mongoid
       # @example Get the class.
       #   proxy.klass
       #
-      # @return [ Class ] The relation class.
-      #
-      # @since 3.0.15
+      # @return [ Class ] The association class.
       def klass
         _association ? _association.klass : nil
       end
 
-      # Resets the criteria inside the relation proxy. Used by many to many
-      # relations to keep the underlying ids array in sync.
+      # Resets the criteria inside the association proxy. Used by many to many
+      # associations to keep the underlying ids array in sync.
       #
-      # @example Reset the relation criteria.
+      # @example Reset the association criteria.
       #   person.preferences.reset_relation_criteria
-      #
-      # @since 3.0.14
       def reset_unloaded
         _target.reset_unloaded(criteria)
       end
 
-      # The default substitutable object for a relation proxy is the clone of
+      # The default substitutable object for an association proxy is the clone of
       # the target.
       #
       # @example Get the substitutable.
       #   proxy.substitutable
       #
       # @return [ Object ] A clone of the target.
-      #
-      # @since 2.1.6
       def substitutable
         _target
       end
@@ -91,8 +99,6 @@ module Mongoid
       #   relation.collection
       #
       # @return [ Collection ] The root's collection.
-      #
-      # @since 2.0.0
       def collection
         root = _base._root
         root.collection unless root.embedded?
@@ -104,8 +110,6 @@ module Mongoid
       #   proxt.characterize_one(name)
       #
       # @param [ Document ] document The document to set on.
-      #
-      # @since 2.0.0.rc.4
       def characterize_one(document)
         document._association = _association unless document._association
       end
@@ -113,13 +117,17 @@ 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.
-      #
-      def method_missing(name, *args, &block)
+      # @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
 
+      # @api private
+      ruby2_keywords def respond_to_missing?(name, *args)
+        _target.respond_to?(name, *args)
+      end
+
       # When the base document illegally references an embedded document this
       # error will get raised.
       #
@@ -127,14 +135,12 @@ module Mongoid
       #   relation.raise_mixed
       #
       # @raise [ Errors::MixedRelations ] The error.
-      #
-      # @since 2.0.0
       def raise_mixed
         raise Errors::MixedRelations.new(_base.class, _association.klass)
       end
 
       # When the base is not yet saved and the user calls create or create!
-      # on the relation, this error will get raised.
+      # on the association, this error will get raised.
       #
       # @example Raise the error.
       #   relation.raise_unsaved(post)
@@ -142,8 +148,6 @@ module Mongoid
       # @param [ Document ] doc The child document getting created.
       #
       # @raise [ Errors::UnsavedDocument ] The error.
-      #
-      # @since 2.0.0.rc.6
       def raise_unsaved(doc)
         raise Errors::UnsavedDocument.new(_base, doc)
       end
@@ -154,8 +158,6 @@ module Mongoid
       #   execute_callback(:before_add)
       #
       # @param [ Symbol ] callback to be executed
-      #
-      # @since 3.1.0
       def execute_callback(callback, doc)
         _association.get_callbacks(callback).each do |c|
           if c.is_a? Proc
@@ -166,9 +168,21 @@ 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 relation.
+        # Apply ordering to the criteria if it was defined on the association.
         #
         # @example Apply the ordering.
         #   Proxy.apply_ordering(criteria, association)
@@ -177,8 +191,6 @@ module Mongoid
         # @param [ Association ] association The association metadata.
         #
         # @return [ Criteria ] The ordered criteria.
-        #
-        # @since 3.0.6
         def apply_ordering(criteria, association)
           association.order ? criteria.order_by(association.order) : criteria
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
@@ -10,9 +12,7 @@ module Mongoid
         # @example Is the document autosaved?
         #   document.autosaved?
         #
-        # @return [ true, false ] Has the document already been autosaved?
-        #
-        # @since 3.0.0
+        # @return [ true | false ] Has the document already been autosaved?
         def autosaved?
           Threaded.autosaved?(self)
         end
@@ -21,8 +21,6 @@ module Mongoid
         #
         # @example Begin autosave.
         #   document.__autosaving__
-        #
-        # @since 3.1.3
         def __autosaving__
           Threaded.begin_autosave(self)
           yield
@@ -33,10 +31,8 @@ module Mongoid
         # Check if there is changes for auto-saving
         #
         # @example Return true if there is changes on self or in
-        #           autosaved relations.
+        #           autosaved associations.
         #   document.changed_for_autosave?
-        #
-        # @since 3.1.3
         def changed_for_autosave?(doc)
           doc.new_record? || doc.changed? || doc.marked_for_destruction?
         end
@@ -50,8 +46,6 @@ module Mongoid
         # @param [ Association ] association The association for which autosaving is enabled.
         #
         # @return [ Class ] The association's owner class.
-        #
-        # @since 7.0
         def self.define_autosave!(association)
           association.inverse_class.tap do |klass|
             save_method = :"autosave_documents_for_#{association.name}"
@@ -60,9 +54,10 @@ module Mongoid
                 self.before_callback_halted = false
               else
                 __autosaving__ do
-                  if relation = ivar(association.name)
-                    Array(relation).each do |doc|
-                      doc.with(persistence_context) do |d|
+                  if assoc_value = ivar(association.name)
+                    Array(assoc_value).each do |doc|
+                      pc = doc.persistence_context? ? doc.persistence_context : persistence_context
+                      doc.with(pc) do |d|
                         d.save
                       end
                     end
@@ -70,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