mongoid 7.2.1 → 9.0.0

data/lib/mongoid/association/accessors.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -16,16 +16,14 @@ module Mongoid
       # @example Build the association.
       #   person.__build__(:addresses, { :_id => 1 }, association)
       #
-      # @param [ String, Symbol ] name The name of the association.
-      # @param [ Hash, BSON::ObjectId ] object The id or attributes to use.
-      # @param [ Association ] association The association metadata.
+      # @param [ String | Symbol ] name The name of the association.
+      # @param [ Hash | BSON::ObjectId ] object The id or attributes to use.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ Hash ] selected_fields Fields which were retrieved via #only.
       #   If selected_fields is specified, fields not listed in it will not be
       #   accessible in the built document.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 2.0.0.rc.1
       def __build__(name, object, association, selected_fields = nil)
         relation = create_relation(object, association, selected_fields)
         set_relation(name, relation)
@@ -36,19 +34,32 @@ module Mongoid
       # @example Create the association.
       #   person.create_relation(document, association)
       #
-      # @param [ Document, Array<Document> ] object The association target.
-      # @param [ Association ] association The association metadata.
+      # @param [ Document | Array<Document> ] object The association target.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ Hash ] selected_fields Fields which were retrieved via #only.
       #   If selected_fields is specified, fields not listed in it will not be
       #   accessible in the created association document.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 2.0.0.rc.1
       def create_relation(object, association, selected_fields = nil)
         type = @attributes[association.inverse_type]
-        target = association.build(self, object, type, selected_fields)
-        target ? association.create_relation(self, target) : nil
+        target = if t = association.build(self, object, type, selected_fields)
+          association.create_relation(self, t)
+        else
+          nil
+        end
+
+        # Only need to do this on embedded associations. The pending callbacks
+        # are only added when materializing the documents, which only happens
+        # on embedded associations. There is no call to the database in the
+        # construction of a referenced association.
+        if association.embedded?
+          Array(target).each do |doc|
+            doc.try(:run_pending_callbacks)
+          end
+        end
+
+        target
       end
 
       # Resets the criteria inside the association proxy. Used by many-to-many
@@ -58,8 +69,6 @@ module Mongoid
       #   person.reset_relation_criteria(:preferences)
       #
       # @param [ Symbol ] name The name of the association.
-      #
-      # @since 3.0.14
       def reset_relation_criteria(name)
         if instance_variable_defined?("@_#{name}")
           send(name).reset_unloaded
@@ -72,12 +81,10 @@ module Mongoid
       # @example Set the proxy on the document.
       #   person.set(:addresses, addresses)
       #
-      # @param [ String, Symbol ] name The name of the association.
+      # @param [ String | Symbol ] name The name of the association.
       # @param [ Proxy ] relation The association to set.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 2.0.0.rc.1
       def set_relation(name, relation)
         instance_variable_set("@_#{name}", relation)
       end
@@ -93,14 +100,25 @@ module Mongoid
       #   document.get_relation(:name, association)
       #
       # @param [ Symbol ] name The name of the association.
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       # @param [ Object ] object The object used to build the association.
-      # @param [ true, false ] reload If the association is to be reloaded.
+      # @param [ true | false ] reload If the association is to be reloaded.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 3.0.16
       def get_relation(name, association, object, reload = false)
+        field_name = database_field_name(name)
+
+        # As per the comments under MONGOID-5034, I've decided to only raise on
+        # embedded associations for a missing attribute. Rails does not raise
+        # for a missing attribute on referenced associations.
+        # We also don't want to raise if we're retrieving an association within
+        # the codebase. This is often done when retrieving the inverse association
+        # during binding or when cascading callbacks. Whenever we retrieve
+        # associations within the codebase, we use without_autobuild.
+        if !without_autobuild? && association.embedded? && attribute_missing?(field_name)
+          raise Mongoid::Errors::AttributeNotLoaded.new(self.class, field_name)
+        end
+
         if !reload && (value = ivar(name)) != false
           value
         else
@@ -121,6 +139,9 @@ module Mongoid
       # (embedded) association with the given key, or nil if no projection
       # is to be performed.
       #
+      # Also returns nil if exclusionary projection was requested but it does
+      # not exclude the field of the association.
+      #
       # For example, if __selected_fields is {'a' => 1, 'b.c' => 2, 'b.c.f' => 3},
       # and assoc_key is 'b', return value would be {'c' => 2, 'c.f' => 3}.
       #
@@ -132,6 +153,15 @@ module Mongoid
       def _mongoid_filter_selected_fields(assoc_key)
         return nil unless __selected_fields
 
+        # If the list of fields was specified using #without instead of #only
+        # and the provided list does not include the association, any of its
+        # fields should be allowed.
+        if __selected_fields.values.all? { |v| v == 0 } &&
+          __selected_fields.keys.none? { |k| k.split('.', 2).first == assoc_key }
+        then
+          return nil
+        end
+
         projecting_assoc = false
 
         filtered = {}
@@ -177,7 +207,7 @@ module Mongoid
 
         # Positional projection is specified as "foo.$". In this case the
         # document that the $ is referring to should be retrieved with all
-        # fields. See https://docs.mongodb.com/manual/reference/operator/projection/positional/
+        # fields. See https://www.mongodb.com/docs/manual/reference/operator/projection/positional/
         # and https://jira.mongodb.org/browse/MONGOID-4769.
         if filtered.keys == %w($)
           filtered = nil
@@ -196,9 +226,7 @@ module Mongoid
       # @example Is autobuild disabled?
       #   document.without_autobuild?
       #
-      # @return [ true, false ] If autobuild is disabled.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If autobuild is disabled.
       def without_autobuild?
         Threaded.executing?(:without_autobuild)
       end
@@ -211,8 +239,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
       def without_autobuild
         Threaded.begin_execution("without_autobuild")
         yield
@@ -226,11 +252,9 @@ module Mongoid
       # @example Parse the args.
       #   doc.parse_args(:name => "Joe")
       #
-      # @param [ Array ] args The arguments.
+      # @param [ Hash... ] *args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [args.first || {}, args.size > 1 ? args[1] : {}]
       end
@@ -245,11 +269,9 @@ module Mongoid
       #   person.has_game?
       #   person.game?
       #
-      # @param [ Association ] association The association.
+      # @param [ Mongoid::Association::Relatable ] association The association.
       #
       # @return [ Class ] The model being set up.
-      #
-      # @since 3.0.0
       def self.define_existence_check!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -269,11 +291,9 @@ module Mongoid
       # @example Set up the getter for the association.
       #   Person.define_getter!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_getter!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -293,14 +313,14 @@ module Mongoid
       # @example Set up the ids getter for the association.
       #   Person.define_ids_getter!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_ids_getter!(association)
         ids_method = "#{association.name.to_s.singularize}_ids"
         association.inverse_class.tap do |klass|
           klass.re_define_method(ids_method) do
-            send(association.name).only(:id).map(&:id)
+            send(association.name).pluck(:_id)
           end
         end
       end
@@ -313,23 +333,20 @@ module Mongoid
       # @example Set up the setter for the association.
       #   Person.define_setter!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_setter!(association)
         name = association.name
         association.inverse_class.tap do |klass|
           klass.re_define_method("#{name}=") do |object|
             without_autobuild do
               if value = get_relation(name, association, object)
-                if value.respond_to?(:substitute)
-                  set_relation(name, value.substitute(object.substitutable))
-                else
-                  value = __build__(name, value, association)
-                  set_relation(name, value.substitute(object.substitutable))
+                if !value.respond_to?(:substitute)
+                  value = __build__(name, value, association) 
                 end
+
+                set_relation(name, value.substitute(object.substitutable))
               else
                 __build__(name, object.substitutable, association)
               end
@@ -347,11 +364,12 @@ module Mongoid
       # @example Set up the id_setter for the association.
       #   Person.define_ids_setter!(association)
       #
-      #  @param [ Association ] association The association for the association.
+      #  @param [ Mongoid::Association::Relatable ] association The association for the association.
       #
       #  @return [ Class ] The class being set up.
       def self.define_ids_setter!(association)
         ids_method = "#{association.name.to_s.singularize}_ids="
+        association.inverse_class.aliased_associations[ids_method.chop] = association.name.to_s
         association.inverse_class.tap do |klass|
           klass.re_define_method(ids_method) do |ids|
             send(association.setter, association.relation_class.find(ids.reject(&:blank?)))
@@ -365,11 +383,9 @@ module Mongoid
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -392,11 +408,9 @@ module Mongoid
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         name = association.name
         association.inverse_class.tap do |klass|

data/lib/mongoid/association/bindable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -16,10 +16,8 @@ module Mongoid
       #   Binding.new(base, target, association)
       #
       # @param [ Document ] base The base of the binding.
-      # @param [ Document, Array<Document> ] target The target of the binding.
-      # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
+      # @param [ Document | Array<Document> ] target The target of the binding.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       def initialize(base, target, association)
         @_base, @_target, @_association = base, target, association
       end
@@ -32,8 +30,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
       def binding
         unless _binding?
           _binding do
@@ -54,8 +50,6 @@ module Mongoid
       # @param [ Document ] doc The document getting bound.
       #
       # @raise [ Errors::InverseNotFound ] If no inverse found.
-      #
-      # @since 3.0.0
       def check_inverse!(doc)
         unless _association.bindable?(doc)
           raise Errors::InverseNotFound.new(
@@ -67,6 +61,53 @@ module Mongoid
         end
       end
 
+      # Remove the associated document from the inverse's association.
+      #
+      # @param [ Document ] doc The document to remove.
+      def remove_associated(doc)
+        if inverse = _association.inverse(doc)
+          if _association.many?
+            remove_associated_many(doc, inverse)
+          elsif _association.in_to?
+            remove_associated_in_to(doc, inverse)
+          end
+        end
+      end
+
+      # Remove the associated document from the inverse's association.
+      #
+      # This method removes the associated on *_many relationships.
+      #
+      # @param [ Document ] doc The document to remove.
+      # @param [ Symbol ] inverse The name of the inverse.
+      def remove_associated_many(doc, inverse)
+        # We only want to remove the inverse association when the inverse
+        # document is in memory.
+        if inv = doc.ivar(inverse)
+          # This first condition is needed because when assigning the
+          # embeds_many association using the same embeds_many
+          # association, we delete from the array we are about to assign.
+          if _base != inv && (associated = inv.ivar(_association.name))
+            associated.delete(doc)
+          end
+        end
+      end
+
+      # Remove the associated document from the inverse's association.
+      #
+      # This method removes associated on belongs_to and embedded_in
+      # associations.
+      #
+      # @param [ Document ] doc The document to remove.
+      # @param [ Symbol ] inverse The name of the inverse.
+      def remove_associated_in_to(doc, inverse)
+        # We only want to remove the inverse association when the inverse
+        # document is in memory.
+        if associated = doc.ivar(inverse)
+          associated.send(_association.setter, nil)
+        end
+      end
+
       # Set the id of the related document in the foreign key field on the
       # keyed document.
       #
@@ -77,11 +118,9 @@ module Mongoid
       #
       # @param [ Document ] keyed The document that stores the foreign key.
       # @param [ Object ] id The id of the bound document.
-      #
-      # @since 3.0.0
       def bind_foreign_key(keyed, id)
         unless keyed.frozen?
-          keyed.you_must(_association.foreign_key_setter, id)
+          try_method(keyed, _association.foreign_key_setter, id)
         end
       end
 
@@ -95,11 +134,9 @@ module Mongoid
       #
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
-      #
-      # @since 3.0.0
       def bind_polymorphic_type(typed, name)
-        if _association.type
-          typed.you_must(_association.type_setter, name)
+        if _association.type && !typed.frozen?
+          try_method(typed, _association.type_setter, name)
         end
       end
 
@@ -113,11 +150,9 @@ module Mongoid
       #
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
-      #
-      # @since 3.0.0
       def bind_polymorphic_inverse_type(typed, name)
-        if _association.inverse_type
-          typed.you_must(_association.inverse_type_setter, name)
+        if _association.inverse_type && !typed.frozen?
+          try_method(typed, _association.inverse_type_setter, name)
         end
       end
 
@@ -131,11 +166,9 @@ module Mongoid
       #
       # @param [ Document ] doc The base document.
       # @param [ Document ] inverse The inverse document.
-      #
-      # @since 3.0.0
       def bind_inverse(doc, inverse)
-        if doc.respond_to?(_association.inverse_setter)
-          doc.you_must(_association.inverse_setter, inverse)
+        if doc.respond_to?(_association.inverse_setter) && !doc.frozen?
+          try_method(doc, _association.inverse_setter, inverse)
         end
       end
 
@@ -147,10 +180,9 @@ module Mongoid
       #   binding.bind_from_relational_parent(doc)
       #
       # @param [ Document ] doc The document to bind.
-      #
-      # @since 3.0.0
       def bind_from_relational_parent(doc)
         check_inverse!(doc)
+        remove_associated(doc)
         bind_foreign_key(doc, record_id(_base))
         bind_polymorphic_type(doc, _base.class.name)
         bind_inverse(doc, _base)
@@ -169,9 +201,7 @@ module Mongoid
       # @example Set the base association.
       #   binding.set_base_association
       #
-      # @return [ true, false ] If the association changed.
-      #
-      # @since 2.4.4
+      # @return [ true | false ] If the association changed.
       def set_base_association
         inverse_association = _association.inverse_association(_target)
         if inverse_association != _association && !inverse_association.nil?
@@ -187,14 +217,30 @@ module Mongoid
       #   unbinding.unbind_from_relational_parent(doc)
       #
       # @param [ Document ] doc The document to unbind.
-      #
-      # @since 3.0.0
       def unbind_from_relational_parent(doc)
         check_inverse!(doc)
         bind_foreign_key(doc, nil)
         bind_polymorphic_type(doc, nil)
         bind_inverse(doc, nil)
       end
+
+      # Convenience method to perform +#try+ but return
+      # nil if the method argument is nil.
+      #
+      # @example Call method if it exists.
+      #   object.try_method(:use, "The Force")
+      #
+      # @example Return nil if method argument is nil.
+      #   object.try_method(nil, "The Force") #=> nil
+      #
+      # @param [ String | Symbol ] method_name The method name.
+      # @param [ Object... ] *args The arguments.
+      #
+      # @return [ Object | nil ] The result of the try or nil if the
+      #   method does not exist.
+      def try_method(object, method_name, *args)
+        object.try(method_name, *args) if method_name
+      end
     end
   end
 end

data/lib/mongoid/association/builders.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -17,8 +17,6 @@ module Mongoid
     #   # The following methods get created:
     #   person.build_name({ :first_name => "Durran" })
     #   person.create_name({ :first_name => "Durran" })
-    #
-    # @since 2.0.0.rc.1
     module Builders
       extend ActiveSupport::Concern
 
@@ -30,11 +28,9 @@ module Mongoid
       # @example Parse the args.
       #   doc.parse_args(:name => "Joe")
       #
-      # @param [ Array ] args The arguments.
+      # @param [ Hash... ] *args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [ args.first || {}, args.size > 1 ? args[1] : {} ]
       end
@@ -44,18 +40,17 @@ module Mongoid
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("build_#{association.name}") do |*args|
             attributes, _options = parse_args(*args)
-            document = Factory.build(association.relation_class, attributes)
+            document = Factory.execute_build(association.relation_class, attributes, execute_callbacks: false)
             _building do
               child = send("#{association.name}=", document)
+              child.run_pending_callbacks
               child.run_callbacks(:build)
               child
             end
@@ -69,19 +64,18 @@ module Mongoid
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association metadata for the association.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("create_#{association.name}") do |*args|
             attributes, _options = parse_args(*args)
-            document = Factory.build(association.relation_class, attributes)
+            document = Factory.execute_build(association.relation_class, attributes, execute_callbacks: false)
             doc = _assigning do
               send("#{association.name}=", document)
             end
+            doc.run_pending_callbacks
             doc.save
             save if new_record? && association.stores_foreign_key?
             doc

data/lib/mongoid/association/constrainable.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
 
     # Used for converting foreign key values to the correct type based on the
     # types of ids that the document stores.
-    #
     module Constrainable
 
       # Convert the supplied object to the appropriate type to set as the
@@ -18,8 +17,6 @@ module Mongoid
       # @param [ Object ] object The object to convert.
       #
       # @return [ Object ] The object cast to the correct type.
-      #
-      # @since 2.0.0.rc.7
       def convert_to_foreign_key(object)
         return convert_polymorphic(object) if polymorphic?
         field = relation_class.fields["_id"]
@@ -36,7 +33,7 @@ module Mongoid
 
       def convert_polymorphic(object)
         if object.is_a?(Mongoid::Document)
-          object.id
+          object._id
         else
           BSON::ObjectId.mongoize(object)
         end

data/lib/mongoid/association/depending.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -20,6 +20,12 @@ module Mongoid
       end
 
       class_methods do
+
+        # Returns all dependent association metadata objects.
+        #
+        # @return [ Array<Mongoid::Association::Relatable> ] The dependent
+        #   association metadata.
+        #
         # @api private
         def _all_dependents
           superclass_dependents = superclass.respond_to?(:_all_dependents) ? superclass._all_dependents : []
@@ -31,8 +37,6 @@ module Mongoid
       end
 
       # The valid dependent strategies.
-      #
-      # @since 7.0
       STRATEGIES = [
           :delete_all,
           :destroy,
@@ -47,11 +51,9 @@ module Mongoid
       # @example Set up cascading information
       #   Mongoid::Association::Depending.define_dependency!(association)
       #
-      # @param [ Association ] association The association metadata.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
       #
       # @return [ Class ] The class of the document.
-      #
-      # @since 2.0.0.rc.1
       def self.define_dependency!(association)
         validate!(association)
         association.inverse_class.tap do |klass|
@@ -66,6 +68,14 @@ module Mongoid
         end
       end
 
+      # Validates that an association's dependent strategy is
+      # within the allowed enumeration.
+      #
+      # @param [ Mongoid::Association::Relatable ] association
+      #   The association to validate.
+      #
+      # @raises [ Mongoid::Errors::InvalidDependentStrategy ]
+      #   Error if invalid.
       def self.validate!(association)
         unless STRATEGIES.include?(association.dependent)
           raise Errors::InvalidDependentStrategy.new(association,
@@ -78,13 +88,11 @@ module Mongoid
       # the appropriate strategy to perform the operation.
       #
       # @example Execute cascades.
-      #   document.apply_delete_dependencies!
-      #
-      # @since 2.0.0.rc.1
-      def apply_delete_dependencies!
+      #   document.apply_destroy_dependencies!
+      def apply_destroy_dependencies!
         self.class._all_dependents.each do |association|
-          if association.try(:dependent)
-            send("_dependent_#{association.dependent}!", association)
+          if dependent = association.try(:dependent)
+            send("_dependent_#{dependent}!", association)
           end
         end
       end