mongoid 7.3.5 → 7.4.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -50,8 +49,6 @@ module Mongoid
           # @param [ Document, Array<Document> ] replacement The replacement.
           #
           # @return [ self, nil ] The association or nil.
-          #
-          # @since 2.0.0.rc.1
           def substitute(replacement)
             unbind_one
             if replacement
@@ -69,8 +66,6 @@ module Mongoid
           #   binding([ address ])
           #
           # @return [ Binding ] The binding object.
-          #
-          # @since 2.0.0.rc.1
           def binding
             BelongsTo::Binding.new(_base, _target, _association)
           end
@@ -85,8 +80,6 @@ module Mongoid
           # @param [ Document, Object ] replacement The replacement object.
           #
           # @return [ Document ] The document.
-          #
-          # @since 3.1.5
           def normalize(replacement)
             return replacement if replacement.is_a?(Document)
             _association.build(klass, replacement)
@@ -98,8 +91,6 @@ module Mongoid
           #   relation.persistable?
           #
           # @return [ true, false ] If the association is persistable.
-          #
-          # @since 2.1.0
           def persistable?
             _target.persisted? && !_binding? && !_building?
           end
@@ -112,8 +103,6 @@ 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
@@ -125,8 +114,6 @@ module Mongoid
             #   Association::BelongsTo::Proxy.embedded?
             #
             # @return [ false ] Always false.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               false
             end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/referenced/belongs_to/binding'
 require 'mongoid/association/referenced/belongs_to/buildable'
@@ -11,8 +10,6 @@ module Mongoid
     module Referenced
 
       # The BelongsTo type association.
-      #
-      # @since 7.0
       class BelongsTo
         include Relatable
         include Buildable
@@ -21,8 +18,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :autobuild,
             :autosave,
@@ -34,36 +29,29 @@ module Mongoid
             :primary_key,
             :touch,
             :optional,
-            :required
+            :required,
+            :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 [ Object ]
-        #
-        # @since 7.0
         FOREIGN_KEY_FIELD_TYPE = Object
 
         # The default foreign key suffix.
         #
         # @return [ String ] '_id'
-        #
-        # @since 7.0
         FOREIGN_KEY_SUFFIX = '_id'.freeze
 
         # The list of association complements.
         #
         # @return [ Array<Association> ] The association complements.
-        #
-        # @since 7.0
         def relation_complements
           @relation_complements ||= [ HasMany, HasOne ].freeze
         end
@@ -71,8 +59,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           @owner_class.aliased_fields[name.to_s] = foreign_key
@@ -82,29 +68,21 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def stores_foreign_key?; true; end
 
         # 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; false; end
 
         # 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
@@ -113,8 +91,6 @@ module Mongoid
         # Get the association proxy class for this association type.
         #
         # @return [ Association::BelongsTo::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -122,8 +98,6 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           @polymorphic ||= !!@options[:polymorphic]
         end
@@ -131,8 +105,6 @@ module Mongoid
         # The name of the field used to store the type of polymorphic association.
         #
         # @return [ String ] The field used to store the type of polymorphic association.
-        #
-        # @since 7.0
         def inverse_type
           (@inverse_type ||= "#{name}_type") if polymorphic?
         end
@@ -143,8 +115,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::One.new(self, attributes, options)
         end
@@ -157,12 +127,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!

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -8,15 +7,13 @@ module Mongoid
         extend ActiveSupport::Concern
 
         # Reset the given counter using the .count() query from the
-        # db. This method is usuful in case that a counter got
+        # db. This method is useful in case that a counter got
         # corrupted, or a new counter was added to the collection.
         #
         # @example Reset the given counter cache
         #   post.reset_counters(:comments)
         #
         # @param [ Symbol, Array ] counters One or more counter caches to reset
-        #
-        # @since 4.0.0
         def reset_counters(*counters)
           self.class.with(persistence_context) do |_class|
             _class.reset_counters(self, *counters)
@@ -26,7 +23,7 @@ module Mongoid
         module ClassMethods
 
           # Reset the given counter using the .count() query from the
-          # db. This method is usuful in case that a counter got
+          # db. This method is useful in case that a counter got
           # corrupted, or a new counter was added to the collection.
           #
           # @example Reset the given counter cache
@@ -34,8 +31,6 @@ module Mongoid
           #
           # @param [ String ] id The id of the object that will be reset.
           # @param [ Symbol, Array ] counters One or more counter caches to reset
-          #
-          # @since 3.1.0
           def reset_counters(id, *counters)
             document = id.is_a?(Document) ? id : find(id)
             counters.each do |name|
@@ -55,8 +50,6 @@ module Mongoid
           #
           # @param [ String ] id The id of the object to update.
           # @param [ Hash ] counters
-          #
-          # @since 3.1.0
           def update_counters(id, counters)
             where(:_id => id).inc(counters)
           end
@@ -70,8 +63,6 @@ module Mongoid
           #
           # @param [ Symbol ] counter_name Counter cache name
           # @param [ String ] id The id of the object that will have its counter incremented.
-          #
-          # @since 3.1.0
           def increment_counter(counter_name, id)
             update_counters(id, counter_name.to_sym => 1)
           end
@@ -85,8 +76,6 @@ module Mongoid
           #
           # @param [ Symbol ] counter_name Counter cache name
           # @param [ String ] id The id of the object that will have its counter decremented.
-          #
-          # @since 3.1.0
           def decrement_counter(counter_name, id)
             update_counters(id, counter_name.to_sym => -1)
           end
@@ -102,8 +91,6 @@ module Mongoid
         # @param [ Association ] association The association.
         #
         # @return [ Class ] The association's owning class.
-        #
-        # @since 7.0
         def self.define_callbacks!(association)
           name = association.name
           cache_column = association.counter_cache_column_name.to_sym

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       module Eager
 
         # Base class for eager load preload functions.
-        #
-        # @since 4.0.0
         class Base
 
           # Instantiate the eager load class.
@@ -20,8 +17,6 @@ module Mongoid
           # @param [ Array<Document> ] docs Documents to preload the associations
           #
           # @return [ Base ] The eager load preloader
-          #
-          # @since 4.0.0
           def initialize(associations, docs)
             @associations = associations
             @docs = docs
@@ -34,8 +29,6 @@ module Mongoid
           #   loader.run
           #
           # @return [ Array ] The list of documents given.
-          #
-          # @since 4.0.0
           def run
             @loaded = []
             while shift_association
@@ -53,8 +46,6 @@ module Mongoid
           #
           # @example Preload the current association into the documents.
           #   loader.preload
-          #
-          # @since 4.0.0
           def preload
             raise NotImplementedError
           end
@@ -64,8 +55,6 @@ module Mongoid
           # association is not polymorphic, all documents are retrieved in
           # a single query. If the association is polymorphic, one query is
           # issued per association target class.
-          #
-          # @since 4.0.0
           def each_loaded_document(&block)
             each_loaded_document_of_class(@association.klass, keys_from_docs, &block)
           end
@@ -81,7 +70,9 @@ module Mongoid
             # Upstream code is responsible for eliminating nils from keys.
             return cls.none if keys.empty?
 
-            criteria = cls.any_in(key => keys)
+            criteria = cls.criteria
+            criteria = criteria.apply_scope(@association.scope)
+            criteria = criteria.any_in(key => keys)
             criteria.inclusions = criteria.inclusions - [@association]
             criteria.each do |doc|
               yield doc
@@ -95,8 +86,6 @@ module Mongoid
           #
           # @param [ ObjectId ] id parent`s id
           # @param [ Document, Array ] element to push into the parent
-          #
-          # @since 4.0.0
           def set_on_parent(id, element)
             grouped_docs[id].each do |d|
               set_relation(d, element)
@@ -112,8 +101,6 @@ module Mongoid
           #   loader.grouped_docs
           #
           # @return [ Hash ] hash with grouped documents.
-          #
-          # @since 4.0.0
           def grouped_docs
             @grouped_docs[@association.name] ||= @docs.group_by do |doc|
               doc.send(group_by_key) if doc.respond_to?(group_by_key)
@@ -131,8 +118,6 @@ module Mongoid
           #   loader.keys_from_docs
           #
           # @return [ Array ] keys, ids
-          #
-          # @since 4.0.0
           def keys_from_docs
             grouped_docs.keys
           end
@@ -145,8 +130,6 @@ module Mongoid
           #   loader.group_by_key
           #
           # @return [ Symbol ] Key to group by the current documents.
-          #
-          # @since 4.0.0
           def group_by_key
             raise NotImplementedError
           end
@@ -158,8 +141,6 @@ module Mongoid
           #
           # @param [ Document ] doc The object to set the association on
           # @param [ Document, Array ] element to set into the parent
-          #
-          # @since 4.0.0
           def set_relation(doc, element)
             doc.set_relation(@association.name, element) unless doc.blank?
           end
@@ -172,8 +153,6 @@ module Mongoid
           #   loader.shift_association
           #
           # @return [ Association ] The association object.
-          #
-          # @since 4.0.0
           def shift_association
             @association = @associations.shift
           end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -17,8 +16,6 @@ module Mongoid
           #   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)
@@ -38,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))

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       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

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

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

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -25,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
@@ -51,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
@@ -85,11 +80,9 @@ module Mongoid
           # @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)
@@ -109,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
@@ -129,21 +120,19 @@ module Mongoid
           #   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.send(field)
+                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 => ipk)
               else
@@ -151,7 +140,7 @@ module Mongoid
               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|
@@ -183,8 +172,6 @@ module Mongoid
           # @param [ Array<Document> ] replacement The replacement target.
           #
           # @return [ Many ] The association.
-          #
-          # @since 2.0.0.rc.1
           def substitute(replacement)
             purge(replacement)
             unless replacement.blank?
@@ -202,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
@@ -217,8 +202,6 @@ module Mongoid
           #   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)
@@ -233,8 +216,6 @@ module Mongoid
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             HasAndBelongsToMany::Binding.new(_base, _target, _association)
           end
@@ -249,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?)
@@ -278,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
@@ -293,8 +270,6 @@ 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
@@ -306,8 +281,6 @@ module Mongoid
             #   Referenced::ManyToMany.embedded?
             #
             # @return [ false ] Always false.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               false
             end