mongoid 7.0.13 → 8.0.8

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

@@ -1,22 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       class HasAndBelongsToMany
 
-        # Binding class for all has_and_belongs_to_many relations.
+        # Binding class for all has_and_belongs_to_many associations.
         class Binding
           include Bindable
 
-          # Binds a single document with the inverse relation. Used
+          # Binds a single document with the inverse association. Used
           # specifically when appending to the proxy.
           #
           # @example Bind one document.
           #   person.preferences.bind_one(preference)
           #
           # @param [ Document ] doc The single document to bind.
-          #
-          # @since 2.0.0.rc.1
           def bind_one(doc)
             binding do
               inverse_keys = doc.you_must(_association.inverse_foreign_key)
@@ -36,8 +35,6 @@ module Mongoid
           #
           # @example Unbind the document.
           #   person.preferences.unbind_one(document)
-          #
-          # @since 2.0.0.rc.1
           def unbind_one(doc)
             binding do
               _base.send(_association.foreign_key).delete_one(record_id(doc))
@@ -53,11 +50,15 @@ module Mongoid
 
           # Find the inverse id referenced by inverse_keys
           def inverse_record_id(doc)
-            inverse_association = determine_inverse_association(doc)
-            if inverse_association
-              _base.__send__(inverse_association.primary_key)
+            if pk = _association.options[:inverse_primary_key]
+              _base.send(pk)
             else
-              _base._id
+              inverse_association = determine_inverse_association(doc)
+              if inverse_association
+                _base.__send__(inverse_association.primary_key)
+              else
+                _base._id
+              end
             end
           end
 

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

@@ -1,12 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       class HasAndBelongsToMany
 
         # The Builder behavior for has_and_belongs_to_many associations.
-        #
-        # @since 7.0
         module Buildable
 
           # This builder either takes a hash and queries for the
@@ -16,11 +15,12 @@ module Mongoid
           #   relation.build(association, attrs)
           #
           # @param [ Object ] base The base object.
-          # @param [ Object ] object The object to use to build the relation.
+          # @param [ Object ] object The object to use to build the association.
           # @param [ String ] type Not used in this context.
+          # @param [ nil ] selected_fields Must be nil.
           #
           # @return [ Array<Document> ] The documents.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             if query?(object)
               query_criteria(object)
             else

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced

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

@@ -1,14 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       class HasAndBelongsToMany
 
-        # This class defines the behaviour for all relations that are a
+        # This class defines the behavior for all associations that are a
         # many-to-many between documents in different collections.
         class Proxy < Referenced::HasMany::Proxy
 
-          # Appends a document or array of documents to the relation. Will set
+          # Appends a document or array of documents to the association. Will set
           # the parent and update the index in the process.
           #
           # @example Append a document.
@@ -20,19 +21,41 @@ module Mongoid
           # @example Concat with other documents.
           #   person.posts.concat([ post_one, post_two ])
           #
-          # @param [ Document, Array<Document> ] args Any number of documents.
+          # @param [ Document | Array<Document> ] args Any number of documents.
           #
           # @return [ Array<Document> ] The loaded docs.
-          #
-          # @since 2.0.0.beta.1
           def <<(*args)
             docs = args.flatten
             return concat(docs) if docs.size > 1
             if doc = docs.first
-              append(doc)
-              _base.add_to_set(foreign_key => doc.send(_association.primary_key))
-              if child_persistable?(doc)
-                doc.save
+              append(doc) do
+                # We ignore the changes to the value for the foreign key in the
+                # changed_attributes hash in this block of code for two reasons:
+                #
+                # 1) The add_to_set method deletes the value for the foreign
+                #    key in the changed_attributes hash, but if we enter this
+                #    method with a value for the foreign key in the
+                #    changed_attributes hash, then we want it to exist outside
+                #    this method as well. It's used later on in the Syncable
+                #    module to set the inverse foreign keys.
+                # 2) The reset_unloaded method accesses the value for the foreign
+                #    key on _base, which causes it to get added to the
+                #    changed_attributes hash. This happens because when reading
+                #    a "resizable" attribute, it is automatically added to the
+                #    changed_attributes hash. This is true only for the foreign
+                #    key value for HABTM associations as the other associations
+                #    use strings for their foreign key values. For consistency
+                #    with the other associations, we ignore this addition to
+                #    the changed_attributes hash.
+                #    See MONGOID-4843 for a longer discussion about this.
+                reset_foreign_key_changes do
+                  _base.add_to_set(foreign_key => doc.public_send(_association.primary_key))
+
+                  if child_persistable?(doc)
+                    doc.save
+                  end
+                  reset_unloaded
+                end
               end
             end
             unsynced(_base, foreign_key) and self
@@ -40,7 +63,7 @@ module Mongoid
 
           alias :push :<<
 
-          # Appends an array of documents to the relation. Performs a batch
+          # Appends an array of documents to the association. Performs a batch
           # insert of the documents instead of persisting one at a time.
           #
           # @example Concat with other documents.
@@ -49,20 +72,18 @@ module Mongoid
           # @param [ Array<Document> ] documents The docs to add.
           #
           # @return [ Array<Document> ] The documents.
-          #
-          # @since 2.4.0
           def concat(documents)
             ids, docs, inserts = {}, [], []
             documents.each do |doc|
               next unless doc
               append(doc)
               if persistable? || _creating?
-                ids[doc._id] = true
+                ids[doc.public_send(_association.primary_key)] = true
                 save_or_delay(doc, docs, inserts)
               else
-                existing = _base.send(foreign_key)
-                unless existing.include?(doc._id)
-                  existing.push(doc._id) and unsynced(_base, foreign_key)
+                existing = _base.public_send(foreign_key)
+                unless existing.include?(doc.public_send(_association.primary_key))
+                  existing.push(doc.public_send(_association.primary_key)) and unsynced(_base, foreign_key)
                 end
               end
             end
@@ -74,32 +95,31 @@ module Mongoid
           end
 
           # Build a new document from the attributes and append it to this
-          # relation without saving.
+          # association without saving.
           #
-          # @example Build a new document on the relation.
+          # @example Build a new document on the association.
           #   person.posts.build(:title => "A new post")
           #
           # @param [ Hash ] attributes The attributes of the new document.
           # @param [ Class ] type The optional subclass to build.
           #
           # @return [ Document ] The new document.
-          #
-          # @since 2.0.0.beta.1
           def build(attributes = {}, type = nil)
-            doc = Factory.build(type || klass, attributes)
-            _base.send(foreign_key).push(doc._id)
+            doc = Factory.execute_build(type || klass, attributes, execute_callbacks: false)
             append(doc)
             doc.apply_post_processed_defaults
+            _base.public_send(foreign_key).push(doc.public_send(_association.primary_key))
             unsynced(doc, inverse_foreign_key)
             yield(doc) if block_given?
+            doc.run_pending_callbacks
             doc
           end
 
           alias :new :build
 
-          # Delete the document from the relation. This will set the foreign key
-          # on the document to nil. If the dependent options on the relation are
-          # :delete or :destroy the appropriate removal will occur.
+          # Delete the document from the association. This will set the foreign key
+          # on the document to nil. If the dependent options on the association are
+          # :delete_all or :destroy the appropriate removal will occur.
           #
           # @example Delete the document.
           #   person.posts.delete(post)
@@ -107,44 +127,49 @@ module Mongoid
           # @param [ Document ] document The document to remove.
           #
           # @return [ Document ] The matching document.
-          #
-          # @since 2.1.0
           def delete(document)
             doc = super
             if doc && persistable?
-              _base.pull(foreign_key => doc.send(_association.primary_key))
+              _base.pull(foreign_key => doc.public_send(_association.primary_key))
               _target._unloaded = criteria
               unsynced(_base, foreign_key)
             end
             doc
           end
 
+          # Mongoid::Extensions::Array defines Array#delete_one, so we need
+          # to make sure that method behaves reasonably on proxies, too.
+          alias delete_one delete
+
           # Removes all associations between the base document and the target
           # documents by deleting the foreign keys and the references, orphaning
           # the target documents in the process.
           #
-          # @example Nullify the relation.
+          # @example Nullify the association.
           #   person.preferences.nullify
           #
           # @param [ Array<Document> ] replacement The replacement documents.
-          #
-          # @since 2.0.0.rc.1
           def nullify(replacement = [])
             _target.each do |doc|
               execute_callback :before_remove, doc
             end
             unless _association.forced_nil_inverse?
+              if field = _association.options[:inverse_primary_key]
+                ipk = _base.public_send(field)
+              else
+                ipk = _base._id
+              end
               if replacement
-                objects_to_clear = _base.send(foreign_key) - replacement.collect do |object|
-                  object.send(_association.primary_key)
+                objects_to_clear = _base.public_send(foreign_key) - replacement.collect do |object|
+                  object.public_send(_association.primary_key)
                 end
-                criteria(objects_to_clear).pull(inverse_foreign_key => _base._id)
+                criteria(objects_to_clear).pull(inverse_foreign_key => ipk)
               else
-                criteria.pull(inverse_foreign_key => _base._id)
+                criteria.pull(inverse_foreign_key => ipk)
               end
             end
             if persistable?
-              _base.set(foreign_key => _base.send(foreign_key).clear)
+              _base.set(foreign_key => _base.public_send(foreign_key).clear)
             end
             after_remove_error = nil
             many_to_many = _target.clear do |doc|
@@ -167,23 +192,22 @@ module Mongoid
           alias :purge :nullify
 
           # Substitutes the supplied target documents for the existing documents
-          # in the relation. If the new target is nil, perform the necessary
+          # in the association. If the new target is nil, perform the necessary
           # deletion.
           #
-          # @example Replace the relation.
+          # @example Replace the association.
           # person.preferences.substitute([ new_post ])
           #
           # @param [ Array<Document> ] replacement The replacement target.
           #
-          # @return [ Many ] The relation.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Many ] The association.
           def substitute(replacement)
             purge(replacement)
             unless replacement.blank?
               push(replacement.compact.uniq)
             else
               reset_unloaded
+              clear_foreign_key_changes
             end
             self
           end
@@ -195,39 +219,60 @@ module Mongoid
           #   person.preferences.unscoped
           #
           # @return [ Criteria ] The unscoped criteria.
-          #
-          # @since 2.4.0
           def unscoped
-            klass.unscoped.any_in(_id: _base.send(foreign_key))
+            klass.unscoped.any_in(_id: _base.public_send(foreign_key))
           end
 
           private
 
+          # Clears the foreign key from the changed_attributes hash.
+          #
+          # This is, in general, used to clear the foreign key from the
+          # changed_attributes hash for consistency with the other referenced
+          # associations.
+          #
+          # @api private
+          def clear_foreign_key_changes
+            _base.changed_attributes.delete(foreign_key)
+          end
+
+          # Reset the value in the changed_attributes hash for the foreign key
+          # to its value before executing the given block.
+          #
+          # @api private
+          def reset_foreign_key_changes
+            if _base.changed_attributes.key?(foreign_key)
+              fk = _base.changed_attributes[foreign_key].dup
+              yield if block_given?
+              _base.changed_attributes[foreign_key] = fk
+            else
+              yield if block_given?
+              clear_foreign_key_changes
+            end
+          end
+
           # Appends the document to the target array, updating the index on the
           # document at the same time.
           #
-          # @example Append the document to the relation.
+          # @example Append the document to the association.
           #   relation.append(document)
           #
           # @param [ Document ] document The document to append to the target.
-          #
-          # @since 2.0.0.rc.1
           def append(document)
-            execute_callback :before_add, document
-            _target.push(document)
-            characterize_one(document)
-            bind_one(document)
-            execute_callback :after_add, document
+            execute_callbacks_around(:add, document) do
+              _target.push(document)
+              characterize_one(document)
+              bind_one(document)
+              yield if block_given?
+            end
           end
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             HasAndBelongsToMany::Binding.new(_base, _target, _association)
           end
@@ -241,9 +286,7 @@ module Mongoid
           #
           # @param [ Document ] doc The document.
           #
-          # @return [ true, false ] If the document can be persisted.
-          #
-          # @since 3.0.20
+          # @return [ true | false ] If the document can be persisted.
           def child_persistable?(doc)
             (persistable? || _creating?) &&
                 !(doc.persisted? && _association.forced_nil_inverse?)
@@ -252,7 +295,7 @@ module Mongoid
           # Returns the criteria object for the target class with its documents set
           # to target.
           #
-          # @example Get a criteria for the relation.
+          # @example Get a criteria for the association.
           #   relation.criteria
           #
           # @return [ Criteria ] A new criteria.
@@ -271,8 +314,6 @@ module Mongoid
           # @param [ Symbol ] key The key to flag on the document.
           #
           # @return [ true ] true.
-          #
-          # @since 3.0.0
           def unsynced(doc, key)
             doc._synced[key] = false
             true
@@ -286,21 +327,17 @@ module Mongoid
             #
             # @param [ Association ] association The association object.
             # @param [ Array<Document> ] docs The array of documents.
-            #
-            # @since 7.0
             def eager_loader(association, docs)
               Eager.new(association, docs)
             end
 
-            # Returns true if the relation is an embedded one. In this case
+            # Returns true if the association is an embedded one. In this case
             # always false.
             #
-            # @example Is this relation embedded?
+            # @example Is this association embedded?
             #   Referenced::ManyToMany.embedded?
             #
             # @return [ false ] Always false.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               false
             end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/referenced/has_and_belongs_to_many/binding'
 require 'mongoid/association/referenced/has_and_belongs_to_many/buildable'
 require 'mongoid/association/referenced/has_and_belongs_to_many/proxy'
@@ -8,8 +10,6 @@ module Mongoid
     module Referenced
 
       # The HasAndBelongsToMany type association.
-      #
-      # @since 7.0
       class HasAndBelongsToMany
         include Relatable
         include Buildable
@@ -18,8 +18,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :after_add,
             :after_remove,
@@ -31,36 +29,31 @@ module Mongoid
             :foreign_key,
             :index,
             :order,
-            :primary_key
+            :primary_key,
+            :inverse_primary_key,
+            :inverse_foreign_key,
+            :scope,
         ].freeze
 
         # The complete list of valid options for this association, including
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # The type of the field holding the foreign key.
         #
         # @return [ Array ]
-        #
-        # @since 7.0
         FOREIGN_KEY_FIELD_TYPE = Array
 
         # The default foreign key suffix.
         #
         # @return [ String ] '_ids'
-        #
-        # @since 7.0
         FOREIGN_KEY_SUFFIX = '_ids'.freeze
 
         # The list of association complements.
         #
         # @return [ Array<Association> ] The association complements.
-        #
-        # @since 7.0
         def relation_complements
           @relation_complements ||= [ self.class ].freeze
         end
@@ -68,8 +61,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           self
@@ -78,22 +69,16 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def embedded?; false; end
 
         # The default for validation the association object.
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def validation_default; true; end
 
-        # Are ids only saved on this side of the relation?
+        # Are ids only saved on this side of the association?
         #
-        # @return [ true, false ] Whether this association has a forced nil inverse.
-        #
-        # @since 7.0
+        # @return [ true | false ] Whether this association has a forced nil inverse.
         def forced_nil_inverse?
           @forced_nil_inverse ||= @options.key?(:inverse_of) && !@options[:inverse_of]
         end
@@ -101,15 +86,11 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def stores_foreign_key?; true; end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::HasAndBelongsToMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -117,18 +98,14 @@ module Mongoid
         # Get the foreign key field for saving the association reference.
         #
         # @return [ String ] The foreign key field for saving the association reference.
-        #
-        # @since 7.0
         def foreign_key
           @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                              default_foreign_key_field
         end
 
-        # The criteria used for querying this relation.
-        #
-        # @return [ Mongoid::Criteria ] The criteria used for querying this relation.
+        # The criteria used for querying this association.
         #
-        # @since 7.0
+        # @return [ Mongoid::Criteria ] The criteria used for querying this association.
         def criteria(base, id_list = nil)
           query_criteria(id_list || base.send(foreign_key))
         end
@@ -137,11 +114,13 @@ module Mongoid
         #
         # @return [ String ] The foreign key field for saving the association reference
         #  on the inverse side.
-        #
-        # @since 7.0
         def inverse_foreign_key
-          if @options.key?(:inverse_of)
+          if @options.key?(:inverse_foreign_key)
+            @options[:inverse_foreign_key]
+          elsif @options.key?(:inverse_of)
             inverse_of ? "#{inverse_of.to_s.singularize}#{FOREIGN_KEY_SUFFIX}" : nil
+          elsif inv = inverse_association&.foreign_key
+            inv
           else
             "#{inverse_class_name.demodulize.underscore}#{FOREIGN_KEY_SUFFIX}"
           end
@@ -152,7 +131,7 @@ module Mongoid
         #
         # @param [ Document ] doc The document to be bound.
         #
-        # @return [ true, false ] Whether the document can be bound.
+        # @return [ true | false ] Whether the document can be bound.
         def bindable?(doc)
           forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key))
         end
@@ -161,8 +140,6 @@ module Mongoid
         #
         # @return [ String ] The foreign key setter for saving the association reference
         #  on the inverse side.
-        #
-        # @since 7.0
         def inverse_foreign_key_setter
           @inverse_foreign_key_setter ||= "#{inverse_foreign_key}=" if inverse_foreign_key
         end
@@ -173,8 +150,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::One ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::Many.new(self, attributes, options)
         end
@@ -187,12 +162,17 @@ module Mongoid
         # @param [ Document ] document The document to calculate on.
         #
         # @return [ Root ] The root atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Root.new(document)
         end
 
+        # Get the scope to be applied when querying the association.
+        #
+        # @return [ Proc | Symbol | nil ] The association scope, if any.
+        def scope
+          @options[:scope]
+        end
+
         private
 
         def setup_instance_methods!
@@ -241,7 +221,7 @@ module Mongoid
         def synced_save
           assoc = self
           inverse_class.set_callback(
-              :save,
+              :persist_parent,
               :after,
               if: ->(doc){ doc._syncable?(assoc) }
           ) do |doc|
@@ -250,6 +230,7 @@ module Mongoid
         end
 
         def create_foreign_key_field!
+          inverse_class.aliased_associations[foreign_key] = name.to_s
           @owner_class.field(
               foreign_key,
               type: FOREIGN_KEY_FIELD_TYPE,
@@ -281,7 +262,9 @@ module Mongoid
         end
 
         def query_criteria(id_list)
-          crit = relation_class.all_of(primary_key => {"$in" => id_list || []})
+          crit = relation_class.criteria
+          crit = crit.apply_scope(scope)
+          crit = crit.all_of(primary_key => {"$in" => id_list || []})
           with_ordering(crit)
         end
       end