mongoid 7.2.1 → 9.0.0

data/lib/mongoid/association/one.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -13,9 +13,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 +24,6 @@ module Mongoid
       #   relation.in_memory
       #
       # @return [ Array<Document> ] The documents in memory.
-      #
-      # @since 2.1.0
       def in_memory
         [ _target ]
       end
@@ -39,9 +35,7 @@ module Mongoid
       #
       # @param [ Symbol ] name The method name.
       #
-      # @return [ true, false ] If the proxy responds to the method.
-      #
-      # @since 2.1.8
+      # @return [ true | false ] If the proxy responds to the method.
       def respond_to?(name, include_private = false)
         _target.respond_to?(name, include_private) || super
       end
@@ -52,8 +46,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,16 +1,15 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
 
+    # Options context used for all association types.
     module Options
 
       # Returns the name of the parent to a polymorphic child.
       #
-      # @return [ String, Symbol ] The name.
-      #
-      # @since 7.0
+      # @return [ String | Symbol ] The name.
       def as
         @options[:as]
       end
@@ -18,8 +17,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,35 +24,27 @@ 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
 
       # Whether to index the primary or foreign key field.
       #
-      # @return [ true, false ]
-      #
-      # @since 7.0
+      # @return [ true | false ]
       def indexed?
         @indexed ||= !!@options[:index]
       end
 
       # Whether the association is autobuilding.
       #
-      # @return [ true, false ]
-      #
-      # @since 7.0
+      # @return [ true | false ]
       def autobuilding?
         !!@options[:autobuild]
       end
 
       # Is the association cyclic.
       #
-      # @return [ true, false ] Whether the association is cyclic.
-      #
-      # @since 7.0
+      # @return [ true | false ] Whether the association is cyclic.
       def cyclic?
         !!@options[:cyclic]
       end
@@ -63,8 +52,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
@@ -72,9 +59,7 @@ module Mongoid
       # Mongoid assumes that the field used to hold the primary key of the association is id.
       # You can override this and explicitly specify the primary key with the :primary_key option.
       #
-      # @return [ Symbol, String ] The primary key.
-      #
-      # @since 7.0
+      # @return [ Symbol | String ] The primary key.
       def primary_key
         @primary_key ||= @options[:primary_key] ? @options[:primary_key].to_s : Relatable::PRIMARY_KEY_DEFAULT
       end
@@ -82,9 +67,7 @@ module Mongoid
       # Options to save any loaded members and destroy members that are marked for destruction
       # when the parent object is saved.
       #
-      # @return [ true, false ] The autosave option.
-      #
-      # @since 7.0
+      # @return [ true | false ] The autosave option.
       def autosave
         !!@options[:autosave]
       end
@@ -92,25 +75,19 @@ module Mongoid
 
       # Whether the association is counter-cached.
       #
-      # @return [ true, false ]
-      #
-      # @since 7.0
+      # @return [ true | false ]
       def counter_cached?
         !!@options[:counter_cache]
       end
 
       # Whether this association is polymorphic.
       #
-      # @return [ true, false ] Whether the association is polymorphic.
-      #
-      # @since 7.0
+      # @return [ true | false ] Whether the association is polymorphic.
       def polymorphic?; false; end
 
       # Whether the association has callbacks cascaded down from the parent.
       #
-      # @return [ true, false ] Whether callbacks are cascaded.
-      #
-      # @since 7.0
+      # @return [ true | false ] Whether callbacks are cascaded.
       def cascading_callbacks?
         !!@options[:cascade_callbacks]
       end
@@ -118,35 +95,32 @@ 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
 
-      private
-
+      # Whether the association object should be automatically touched
+      # when its inverse object is updated.
+      #
+      # @return [ true | false ] returns true if this association is
+      #   automatically touched, false otherwise. The default is false.
+      #
+      # @api private
       def touchable?
         !!@options[:touch]
       end

data/lib/mongoid/association/proxy.rb

@@ -1,22 +1,32 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
-require "mongoid/association/marshalable"
+require 'mongoid/association/marshalable'
 
 module Mongoid
   module Association
-
     # This class is the superclass for all association proxy objects, and contains
     # common behavior for all of them.
     class Proxy
       extend Forwardable
 
-      alias :extend_proxy :extend
+      alias extend_proxy extend
+
+      # specific methods to prevent from being undefined
+      KEEPER_METHODS = %i[
+        send
+        object_id
+        equal?
+        respond_to?
+        respond_to_missing?
+        tap
+        public_send
+        extend_proxy
+        extend_proxies
+      ].freeze
 
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
-        undef_method(method) unless
-          method =~ /\A(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)\z/
+        undef_method(method) unless method.to_s.start_with?('__') || KEEPER_METHODS.include?(method)
       end
 
       include Threaded::Lifecycle
@@ -42,18 +52,12 @@ module Mongoid
       def_delegators :binding, :bind_one, :unbind_one
       def_delegator :_base, :collection_name
 
-      # Convenience for setting the target and the association metadata properties since
-      # all proxies will need to do this.
-      #
-      # @example Initialize the proxy.
-      #   proxy.init(person, name, association)
+      # Sets the target and the association metadata properties.
       #
       # @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)
+      # @param [ Document | Array<Document> ] target The target of the proxy.
+      # @param [ Mongoid::Association::Relatable ] association The association metadata.
+      def initialize(base, target, association)
         @_base, @_target, @_association = base, target, association
         yield(self) if block_given?
         extend_proxies(association.extension) if association.extension
@@ -61,7 +65,7 @@ module Mongoid
 
       # Allow extension to be an array and extend each module
       def extend_proxies(*extension)
-        extension.flatten.each {|ext| extend_proxy(ext) }
+        extension.flatten.each { |ext| extend_proxy(ext) }
       end
 
       # Get the class from the association, or return nil if no association present.
@@ -70,10 +74,8 @@ module Mongoid
       #   proxy.klass
       #
       # @return [ Class ] The association class.
-      #
-      # @since 3.0.15
       def klass
-        _association ? _association.klass : nil
+        _association&.klass
       end
 
       # Resets the criteria inside the association proxy. Used by many to many
@@ -81,8 +83,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 +94,6 @@ module Mongoid
       #   proxy.substitutable
       #
       # @return [ Object ] A clone of the target.
-      #
-      # @since 2.1.6
       def substitutable
         _target
       end
@@ -108,8 +106,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 +117,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
@@ -130,13 +124,23 @@ module Mongoid
       # Default behavior of method missing should be to delegate all calls
       # to the target of the proxy. This can be overridden in special cases.
       #
-      # @param [ String, Symbol ] name The name of the method.
-      # @param [ Array ] args The arguments passed to the method.
-      #
-      def method_missing(name, *args, &block)
+      # @param [ String | Symbol ] name The name of the method.
+      # @param [ Object... ] *args The arguments passed to the method.
+      # @param &block Optional block to pass.
+      ruby2_keywords def method_missing(name, *args, &block)
         _target.send(name, *args, &block)
       end
 
+      # Whether the proxy can forward the method to the target.
+      #
+      # @param [ String | Symbol ] name The name of the method.
+      # @param [ Object... ] *args The +respond_to?+ arguments.
+      #
+      # @api private
+      ruby2_keywords def respond_to_missing?(name, *args)
+        _target.respond_to?(name, *args)
+      end
+
       # When the base document illegally references an embedded document this
       # error will get raised.
       #
@@ -144,8 +148,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
@@ -159,8 +161,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
@@ -171,8 +171,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
@@ -183,19 +181,28 @@ module Mongoid
         end
       end
 
-      class << self
+      # Execute the before and after callbacks for the given method.
+      #
+      # @param [ Symbol ] name The name of the callbacks to execute.
+      #
+      # @return [ Object ] The result of the given block
+      def execute_callbacks_around(name, doc)
+        execute_callback :"before_#{name}", doc
+        yield.tap do
+          execute_callback :"after_#{name}", doc
+        end
+      end
 
+      class << self
         # Apply ordering to the criteria if it was defined on the association.
         #
         # @example Apply the ordering.
         #   Proxy.apply_ordering(criteria, association)
         #
         # @param [ Criteria ] criteria The criteria to modify.
-        # @param [ Association ] association The association metadata.
+        # @param [ Mongoid::Association::Relatable ] 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,10 +1,13 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
     module Referenced
 
+      # Mixin module included into Mongoid::Document which adds
+      # the ability to automatically save opposite-side documents
+      # in referenced associations when saving the subject document.
       module AutoSave
         extend ActiveSupport::Concern
 
@@ -13,9 +16,7 @@ module Mongoid
         # @example Is the document autosaved?
         #   document.autosaved?
         #
-        # @return [ true, false ] Has the document already been autosaved?
-        #
-        # @since 3.0.0
+        # @return [ true | false ] Has the document already been autosaved?
         def autosaved?
           Threaded.autosaved?(self)
         end
@@ -24,8 +25,6 @@ module Mongoid
         #
         # @example Begin autosave.
         #   document.__autosaving__
-        #
-        # @since 3.1.3
         def __autosaving__
           Threaded.begin_autosave(self)
           yield
@@ -38,8 +37,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
@@ -50,11 +47,9 @@ module Mongoid
         # @example Define the autosave method:
         #   Association::Referenced::Autosave.define_autosave!(association)
         #
-        # @param [ Association ] association The association for which autosaving is enabled.
+        # @param [ Mongoid::Association::Relatable ] 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}"
@@ -63,9 +58,10 @@ module Mongoid
                 self.before_callback_halted = false
               else
                 __autosaving__ do
-                  if relation = ivar(association.name)
-                    Array(relation).each do |doc|
-                      doc.with(persistence_context) do |d|
+                  if assoc_value = ivar(association.name)
+                    Array(assoc_value).each do |doc|
+                      pc = doc.persistence_context? ? doc.persistence_context : persistence_context.for_child(doc)
+                      doc.with(pc) do |d|
                         d.save
                       end
                     end
@@ -73,7 +69,7 @@ module Mongoid
                 end
               end
             end
-            klass.after_save save_method, unless: :autosaved?
+            klass.after_persist_parent save_method, unless: :autosaved?
           end
         end
       end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -19,8 +19,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)
@@ -31,6 +29,7 @@ module Mongoid
                   if _base.referenced_many?
                     _target.__send__(inverse).push(_base)
                   else
+                    remove_associated(_target)
                     _target.set_relation(inverse, _base)
                   end
                 end
@@ -44,8 +43,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 +69,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,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -7,8 +7,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
@@ -31,12 +29,14 @@ module Mongoid
           private
 
           def execute_query(object, type)
-            query_criteria(object, type).limit(1).first(id_sort: :none)
+            query_criteria(object, type).take
           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,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -7,7 +7,7 @@ module Mongoid
       class BelongsTo
 
         # Eager class for belongs_to associations.
-        class Eager < Association::Referenced::Eager::Base
+        class Eager < Association::Eager
 
           private