mongoid 7.0.0 → 7.4.0

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.
@@ -23,14 +24,12 @@ module Mongoid
           # @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))
+              _base.add_to_set(foreign_key => doc.public_send(_association.primary_key))
               if child_persistable?(doc)
                 doc.save
               end
@@ -40,7 +39,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 +48,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,20 +71,18 @@ 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)
+            _base.public_send(foreign_key).push(doc.public_send(_association.primary_key))
             append(doc)
             doc.apply_post_processed_defaults
             unsynced(doc, inverse_foreign_key)
@@ -97,9 +92,9 @@ module Mongoid
 
           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,12 +102,10 @@ 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
@@ -123,26 +116,31 @@ module Mongoid
           # 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(&:id)
-                criteria(objects_to_clear).pull(inverse_foreign_key => _base._id)
+                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 => 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|
@@ -165,17 +163,15 @@ 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?
@@ -193,10 +189,8 @@ 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
@@ -204,12 +198,10 @@ module Mongoid
           # 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)
@@ -218,14 +210,12 @@ module Mongoid
             execute_callback :after_add, document
           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
@@ -240,8 +230,6 @@ module Mongoid
           # @param [ Document ] doc The document.
           #
           # @return [ true, false ] If the document can be persisted.
-          #
-          # @since 3.0.20
           def child_persistable?(doc)
             (persistable? || _creating?) &&
                 !(doc.persisted? && _association.forced_nil_inverse?)
@@ -250,7 +238,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.
@@ -269,8 +257,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
@@ -284,21 +270,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
         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,10 +114,10 @@ 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
           else
             "#{inverse_class_name.demodulize.underscore}#{FOREIGN_KEY_SUFFIX}"
@@ -161,8 +138,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 +148,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 +160,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!
@@ -281,7 +259,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

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
@@ -8,13 +9,11 @@ module Mongoid
         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.posts.bind_one(post)
-          #
-          # @since 2.0.0.rc.1
           def bind_one(doc)
             binding do
               bind_from_relational_parent(doc)
@@ -25,8 +24,6 @@ module Mongoid
           #
           # @example Unbind the document.
           #   person.posts.unbind_one(document)
-          #
-          # @since 2.0.0.rc.1
           def unbind_one(doc)
             binding do
               unbind_from_relational_parent(doc)

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

@@ -1,12 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Referenced
       class HasMany
 
         # The Builder behavior for has_many associations.
-        #
-        # @since 7.0
         module Buildable
 
           # This method either takes an _id or an object and queries for the
@@ -16,11 +15,12 @@ module Mongoid
           #   relation.build(meta, 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 The type of document to query for.
+          # @param [ nil ] selected_fields Must be nil.
           #
           # @return [ Document ] A single document.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             return (object || []) unless query?(object)
             return [] if object.is_a?(Array)
             query_criteria(object, base)

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

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