mongoid 7.3.2 → 7.4.0

data/lib/mongoid/association/many.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -19,8 +18,6 @@ module Mongoid
       #   person.addresses.blank?
       #
       # @return [ true, false ] If the association is empty or not.
-      #
-      # @since 2.1.0
       def blank?
         !any?
       end
@@ -36,8 +33,6 @@ module Mongoid
       # @param [ Class ] type The optional type of document to create.
       #
       # @return [ Document ] The newly created document.
-      #
-      # @since 2.0.0.beta.1
       def create(attributes = nil, type = nil, &block)
         if attributes.is_a?(::Array)
           attributes.map { |attrs| create(attrs, type, &block) }
@@ -61,8 +56,6 @@ module Mongoid
       # @raise [ Errors::Validations ] If validation failed.
       #
       # @return [ Document ] The newly created document.
-      #
-      # @since 2.0.0.beta.1
       def create!(attributes = nil, type = nil, &block)
         if attributes.is_a?(::Array)
           attributes.map { |attrs| create!(attrs, type, &block) }
@@ -123,8 +116,6 @@ module Mongoid
       #   relation.nil?
       #
       # @return [ false ] Always false.
-      #
-      # @since 2.0.0
       def nil?
         false
       end
@@ -138,8 +129,6 @@ module Mongoid
       # @param [ true, false ] include_private Whether to include private methods.
       #
       # @return [ true, false ] If the proxy responds to the method.
-      #
-      # @since 2.0.0
       def respond_to?(name, include_private = false)
         [].respond_to?(name, include_private) ||
           klass.respond_to?(name, include_private) || super
@@ -151,8 +140,6 @@ module Mongoid
       #   relation.scoped
       #
       # @return [ Criteria ] The scoped criteria.
-      #
-      # @since 2.1.0
       def scoped
         criteria
       end
@@ -171,8 +158,6 @@ module Mongoid
       # @option options [ Symbol ] :except Dont include these fields.
       #
       # @return [ Hash ] The documents, ready to be serialized.
-      #
-      # @since 2.0.0.rc.6
       def serializable_hash(options = {})
         _target.map { |document| document.serializable_hash(options) }
       end
@@ -184,8 +169,6 @@ module Mongoid
       #   person.addresses.unscoped
       #
       # @return [ Criteria ] The unscoped criteria.
-      #
-      # @since 2.4.0
       def unscoped
         criteria.unscoped
       end

data/lib/mongoid/association/marshalable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -11,8 +10,6 @@ module Mongoid
       #   Marshal.dump(proxy)
       #
       # @return [ Array<Object> ] The dumped data.
-      #
-      # @since 3.0.15
       def marshal_dump
         [ _base, _target, _association ]
       end
@@ -25,8 +22,6 @@ module Mongoid
       # @param [ Array<Object> ] data The data to set on the proxy.
       #
       # @return [ Array<Object> ] The loaded data.
-      #
-      # @since 3.0.15
       def marshal_load(data)
         @_base, @_target, @_association = data
         extend_proxy(_association.extension) if _association.extension

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -96,8 +95,6 @@ module Mongoid
         #
         # @param [ Document ] parent The parent document.
         # @param [ Hash ] attrs The single document attributes to process.
-        #
-        # @since 2.0.0
         def process_attributes(parent, attrs)
           return if reject?(parent, attrs)
           if id = attrs.extract_id
@@ -118,8 +115,6 @@ module Mongoid
         # @param [ Document ] parent The parent document.
         # @param [ Proxy ] relation The association proxy.
         # @param [ Document ] doc The doc to destroy.
-        #
-        # @since 3.0.10
         def destroy(parent, relation, doc)
           doc.flagged_for_destroy = true
           if !doc.embedded? || parent.new_record?
@@ -138,8 +133,6 @@ module Mongoid
         #
         # @param [ Proxy ] relation The association proxy.
         # @param [ Document ] doc The document to delete.
-        #
-        # @since 3.0.10
         def destroy_document(relation, doc)
           relation.delete(doc)
           doc.destroy unless doc.embedded? || doc.destroyed?
@@ -154,8 +147,6 @@ module Mongoid
         #
         # @param [ Document ] doc The document to update.
         # @param [ Hash ] attrs The attributes.
-        #
-        # @since 3.0.10
         def update_document(doc, attrs)
           attrs.delete_id
           if association.embedded?
@@ -175,8 +166,6 @@ module Mongoid
         # @param [ Document ] parent The parent document.
         # @param [ String, BSON::ObjectId ] id of the related document.
         # @param [ Hash ] attrs The single document attributes to process.
-        #
-        # @since 6.0.0
         def update_nested_relation(parent, id, attrs)
           first = existing.first
           converted = first ? convert_id(first.class, id) : id

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -14,8 +13,6 @@ module Mongoid
         #   builder.allow_destroy?
         #
         # @return [ true, false ] True if the allow destroy option was set.
-        #
-        # @since 2.0.0.rc.1
         def allow_destroy?
           options[:allow_destroy] || false
         end
@@ -29,8 +26,6 @@ module Mongoid
         # @param [ Hash ] attrs The attributes to check for rejection.
         #
         # @return [ true, false ] True and call proc or method if rejectable, false if not.
-        #
-        # @since 2.0.0.rc.1
         def reject?(document, attrs)
           case callback = options[:reject_if]
             when Symbol
@@ -49,8 +44,6 @@ module Mongoid
         #   builder.update_only?
         #
         # @return [ true, false ] True if the update_only option was set.
-        #
-        # @since 2.0.0.rc.1
         def update_only?
           options[:update_only] || false
         end
@@ -64,8 +57,6 @@ module Mongoid
         # @param [ String ] id The id, usually coming from the form.
         #
         # @return [ BSON::ObjectId, String, Object ] The converted id.
-        #
-        # @since 2.0.0.rc.6
         def convert_id(klass, id)
           klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -23,8 +22,6 @@ module Mongoid
         # @param [ Document ] parent The parent document.
         #
         # @return [ Document ] The built document.
-        #
-        # @since 2.0.0
         def build(parent)
           return if reject?(parent, attributes)
           @existing = parent.send(association.name)
@@ -47,8 +44,6 @@ module Mongoid
         # @param [ Association ] association The association metadata.
         # @param [ Hash ] attributes The attributes hash to attempt to set.
         # @param [ Hash ] options The options defined.
-        #
-        # @since 2.0.0
         def initialize(association, attributes, options)
           @attributes = attributes.with_indifferent_access
           @association = association
@@ -59,7 +54,7 @@ module Mongoid
 
         private
 
-        # Is the id in the attribtues acceptable for allowing an update to
+        # Is the id in the attributes acceptable for allowing an update to
         # the existing association?
         #
         # @api private
@@ -68,8 +63,6 @@ module Mongoid
         #   one.acceptable_id?
         #
         # @return [ true, false ] If the id part of the logic will allow an update.
-        #
-        # @since 2.0.0
         def acceptable_id?
           id = association.klass.extract_id_field(attributes)
           id = convert_id(existing.class, id)
@@ -82,8 +75,6 @@ module Mongoid
         #   one.delete?
         #
         # @return [ true, false ] If the association should be deleted.
-        #
-        # @since 2.0.0
         def delete?
           id = association.klass.extract_id_field(attributes)
           destroyable? && !id.nil?
@@ -96,8 +87,6 @@ module Mongoid
         #
         # @return [ true, false ] If the association can potentially be
         #   destroyed.
-        #
-        # @since 2.0.0
         def destroyable?
           Nested::DESTROY_FLAGS.include?(destroy) && allow_destroy?
         end
@@ -108,8 +97,6 @@ module Mongoid
         #   one.replace?
         #
         # @return [ true, false ] If the document should be replaced.
-        #
-        # @since 2.0.0
         def replace?
           !existing && !destroyable? && !attributes.blank?
         end
@@ -120,8 +107,6 @@ module Mongoid
         #   one.update?
         #
         # @return [ true, false ] If the object should have its attributes updated.
-        #
-        # @since 2.0.0
         def update?
           existing && !destroyable? && acceptable_id?
         end

data/lib/mongoid/association/nested.rb

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

data/lib/mongoid/association/one.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -13,9 +12,7 @@ module Mongoid
       # @example Clear the relation.
       #   relation.clear
       #
-      # @return [ true, false ] If the delete suceeded.
-      #
-      # @since 3.0.0
+      # @return [ true, false ] If the delete succeeded.
       def clear
         _target.delete
       end
@@ -26,8 +23,6 @@ module Mongoid
       #   relation.in_memory
       #
       # @return [ Array<Document> ] The documents in memory.
-      #
-      # @since 2.1.0
       def in_memory
         [ _target ]
       end
@@ -40,8 +35,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ true, false ] If the proxy responds to the method.
-      #
-      # @since 2.1.8
       def respond_to?(name, include_private = false)
         _target.respond_to?(name, include_private) || super
       end
@@ -52,8 +45,6 @@ module Mongoid
       #   proxy.__evolve_object_id__
       #
       # @return [ Object ] The proxy document's id.
-      #
-      # @since 4.0.0
       def __evolve_object_id__
         _target._id
       end

data/lib/mongoid/association/options.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -9,8 +8,6 @@ module Mongoid
       # Returns the name of the parent to a polymorphic child.
       #
       # @return [ String, Symbol ] The name.
-      #
-      # @since 7.0
       def as
         @options[:as]
       end
@@ -18,8 +15,6 @@ module Mongoid
       # Specify what happens to the associated object when the owner is destroyed.
       #
       # @return [ String ] The dependent option.
-      #
-      # @since 7.0
       def dependent
         @options[:dependent]
       end
@@ -27,8 +22,6 @@ module Mongoid
       # The custom sorting options on the association.
       #
       # @return [ Criteria::Queryable::Key ] The custom sorting options.
-      #
-      # @since 7.0
       def order
         @options[:order]
       end
@@ -36,8 +29,6 @@ module Mongoid
       # Whether to index the primary or foreign key field.
       #
       # @return [ true, false ]
-      #
-      # @since 7.0
       def indexed?
         @indexed ||= !!@options[:index]
       end
@@ -45,8 +36,6 @@ module Mongoid
       # Whether the association is autobuilding.
       #
       # @return [ true, false ]
-      #
-      # @since 7.0
       def autobuilding?
         !!@options[:autobuild]
       end
@@ -54,8 +43,6 @@ module Mongoid
       # Is the association cyclic.
       #
       # @return [ true, false ] Whether the association is cyclic.
-      #
-      # @since 7.0
       def cyclic?
         !!@options[:cyclic]
       end
@@ -63,8 +50,6 @@ module Mongoid
       # The name the owning object uses to refer to this association.
       #
       # @return [ String ] The inverse_of option.
-      #
-      # @since 7.0
       def inverse_of
         @options[:inverse_of]
       end
@@ -73,8 +58,6 @@ module Mongoid
       # You can override this and explicitly specify the primary key with the :primary_key option.
       #
       # @return [ Symbol, String ] The primary key.
-      #
-      # @since 7.0
       def primary_key
         @primary_key ||= @options[:primary_key] ? @options[:primary_key].to_s : Relatable::PRIMARY_KEY_DEFAULT
       end
@@ -83,8 +66,6 @@ module Mongoid
       # when the parent object is saved.
       #
       # @return [ true, false ] The autosave option.
-      #
-      # @since 7.0
       def autosave
         !!@options[:autosave]
       end
@@ -93,8 +74,6 @@ module Mongoid
       # Whether the association is counter-cached.
       #
       # @return [ true, false ]
-      #
-      # @since 7.0
       def counter_cached?
         !!@options[:counter_cache]
       end
@@ -102,15 +81,11 @@ module Mongoid
       # Whether this association is polymorphic.
       #
       # @return [ true, false ] Whether the association is polymorphic.
-      #
-      # @since 7.0
       def polymorphic?; false; end
 
       # Whether the association has callbacks cascaded down from the parent.
       #
       # @return [ true, false ] Whether callbacks are cascaded.
-      #
-      # @since 7.0
       def cascading_callbacks?
         !!@options[:cascade_callbacks]
       end
@@ -118,29 +93,21 @@ module Mongoid
       # The store_as option.
       #
       # @return [ nil ] Default is nil.
-      #
-      # @since 7.0
       def store_as; end
 
       # Whether the association has forced nil inverse (So no foreign keys are saved).
       #
       # @return [ false ] Default is false.
-      #
-      # @since 7.0
       def forced_nil_inverse?; false; end
 
       # The field for saving the associated object's type.
       #
       # @return [ nil ] Default is nil.
-      #
-      # @since 7.0
       def type; end
 
       # The field for saving the associated object's type.
       #
       # @return [ nil ] Default is nil.
-      #
-      # @since 7.0
       def touch_field
         @touch_field ||= options[:touch] if (options[:touch].is_a?(String) || options[:touch].is_a?(Symbol))
       end

data/lib/mongoid/association/proxy.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/association/marshalable"
 
@@ -51,8 +50,6 @@ module Mongoid
       # @param [ Document ] base The base document on the proxy.
       # @param [ Document, Array<Document> ] target The target of the proxy.
       # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
       def init(base, target, association)
         @_base, @_target, @_association = base, target, association
         yield(self) if block_given?
@@ -70,8 +67,6 @@ module Mongoid
       #   proxy.klass
       #
       # @return [ Class ] The association class.
-      #
-      # @since 3.0.15
       def klass
         _association ? _association.klass : nil
       end
@@ -81,8 +76,6 @@ module Mongoid
       #
       # @example Reset the association criteria.
       #   person.preferences.reset_relation_criteria
-      #
-      # @since 3.0.14
       def reset_unloaded
         _target.reset_unloaded(criteria)
       end
@@ -94,8 +87,6 @@ module Mongoid
       #   proxy.substitutable
       #
       # @return [ Object ] A clone of the target.
-      #
-      # @since 2.1.6
       def substitutable
         _target
       end
@@ -108,8 +99,6 @@ module Mongoid
       #   relation.collection
       #
       # @return [ Collection ] The root's collection.
-      #
-      # @since 2.0.0
       def collection
         root = _base._root
         root.collection unless root.embedded?
@@ -121,8 +110,6 @@ module Mongoid
       #   proxt.characterize_one(name)
       #
       # @param [ Document ] document The document to set on.
-      #
-      # @since 2.0.0.rc.4
       def characterize_one(document)
         document._association = _association unless document._association
       end
@@ -149,8 +136,6 @@ module Mongoid
       #   relation.raise_mixed
       #
       # @raise [ Errors::MixedRelations ] The error.
-      #
-      # @since 2.0.0
       def raise_mixed
         raise Errors::MixedRelations.new(_base.class, _association.klass)
       end
@@ -164,8 +149,6 @@ module Mongoid
       # @param [ Document ] doc The child document getting created.
       #
       # @raise [ Errors::UnsavedDocument ] The error.
-      #
-      # @since 2.0.0.rc.6
       def raise_unsaved(doc)
         raise Errors::UnsavedDocument.new(_base, doc)
       end
@@ -176,8 +159,6 @@ module Mongoid
       #   execute_callback(:before_add)
       #
       # @param [ Symbol ] callback to be executed
-      #
-      # @since 3.1.0
       def execute_callback(callback, doc)
         _association.get_callbacks(callback).each do |c|
           if c.is_a? Proc
@@ -199,8 +180,6 @@ module Mongoid
         # @param [ Association ] association The association metadata.
         #
         # @return [ Criteria ] The ordered criteria.
-        #
-        # @since 3.0.6
         def apply_ordering(criteria, association)
           association.order ? criteria.order_by(association.order) : criteria
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -14,8 +13,6 @@ module Mongoid
         #   document.autosaved?
         #
         # @return [ true, false ] Has the document already been autosaved?
-        #
-        # @since 3.0.0
         def autosaved?
           Threaded.autosaved?(self)
         end
@@ -24,8 +21,6 @@ module Mongoid
         #
         # @example Begin autosave.
         #   document.__autosaving__
-        #
-        # @since 3.1.3
         def __autosaving__
           Threaded.begin_autosave(self)
           yield
@@ -38,8 +33,6 @@ module Mongoid
         # @example Return true if there is changes on self or in
         #           autosaved associations.
         #   document.changed_for_autosave?
-        #
-        # @since 3.1.3
         def changed_for_autosave?(doc)
           doc.new_record? || doc.changed? || doc.marked_for_destruction?
         end
@@ -53,8 +46,6 @@ module Mongoid
         # @param [ Association ] association The association for which autosaving is enabled.
         #
         # @return [ Class ] The association's owner class.
-        #
-        # @since 7.0
         def self.define_autosave!(association)
           association.inverse_class.tap do |klass|
             save_method = :"autosave_documents_for_#{association.name}"

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -19,8 +18,6 @@ module Mongoid
           # @example Bind the documents.
           #   game.person.bind(:continue => true)
           #   game.person = Person.new
-          #
-          # @since 2.0.0.rc.1
           def bind_one
             binding do
               check_polymorphic_inverses!(_target)
@@ -44,8 +41,6 @@ module Mongoid
           # @example Unbind the document.
           #   game.person.unbind(:continue => true)
           #   game.person = nil
-          #
-          # @since 2.0.0.rc.1
           def unbind_one
             binding do
               inverse = _association.inverse(_target)
@@ -72,8 +67,6 @@ module Mongoid
           #   binding.check_inverses!(doc)
           #
           # @param [ Document ] doc The document to check.
-          #
-          # @since 3.0.0
           def check_polymorphic_inverses!(doc)
             inverses = _association.inverses(doc)
             if inverses.length > 1 && _base.send(_association.foreign_key).nil?

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class BelongsTo
 
         # The Builder behavior for belongs_to associations.
-        #
-        # @since 7.0
         module Buildable
 
           # This method either takes an _id or an object and queries for the
@@ -35,8 +32,10 @@ module Mongoid
           end
 
           def query_criteria(object, type)
-            model = type ? type.constantize : relation_class
-            model.where(primary_key => object)
+            cls = type ? type.constantize : relation_class
+            crit = cls.criteria
+            crit = crit.apply_scope(scope)
+            crit.where(primary_key => object)
           end
 
           def query?(object)

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

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