mongoid 7.0.6 → 7.1.2

data/lib/mongoid/association/marshalable.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Marshalable
 
-      # Provides the data needed to Marshal.dump a relation proxy.
+      # Provides the data needed to Marshal.dump an association proxy.
       #
       # @example Dump the proxy.
       #   Marshal.dump(proxy)

data/lib/mongoid/association/nested.rb

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

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

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Nested
       class Many
         include Buildable
 
-        # Builds the relation depending on the attributes and the options
+        # Builds the association depending on the attributes and the options
         # passed to the macro.
         #
         # This attempts to perform 3 operations, either one of an update of
-        # the existing relation, a replacement of the relation with a new
-        # document, or a removal of the relation.
+        # the existing association, a replacement of the association with a new
+        # document, or a removal of the association.
         #
         # @example Build the nested attrs.
         #   many.build(person)
         #
-        # @param [ Document ] parent The parent document of the relation.
+        # @param [ Document ] parent The parent document of the association.
         # @param [ Hash ] options The options.
         #
         # @return [ Array ] The attributes.
@@ -34,7 +36,7 @@ module Mongoid
         end
 
         # Create the new builder for nested attributes on one-to-many
-        # relations.
+        # associations.
         #
         # @example Initialize the builder.
         #   Many.new(association, attributes, options)
@@ -57,14 +59,14 @@ module Mongoid
 
         private
 
-        # Can the existing relation potentially be deleted?
+        # Can the existing association potentially be deleted?
         #
         # @example Is the document destroyable?
         #   destroyable?({ :_destroy => "1" })
         #
         # @param [ Hash ] attributes The attributes to pull the flag from.
         #
-        # @return [ true, false ] If the relation can potentially be deleted.
+        # @return [ true, false ] If the association can potentially be deleted.
         def destroyable?(attributes)
           destroy = attributes.delete(:_destroy)
           Nested::DESTROY_FLAGS.include?(destroy) && allow_destroy?
@@ -106,7 +108,7 @@ module Mongoid
         end
 
         # Destroy the child document, needs to do some checking for embedded
-        # relations and delay the destroy in case parent validation fails.
+        # associations and delay the destroy in case parent validation fails.
         #
         # @api private
         #
@@ -114,7 +116,7 @@ module Mongoid
         #   builder.destroy(parent, relation, doc)
         #
         # @param [ Document ] parent The parent document.
-        # @param [ Proxy ] relation The relation proxy.
+        # @param [ Proxy ] relation The association proxy.
         # @param [ Document ] doc The doc to destroy.
         #
         # @since 3.0.10
@@ -134,7 +136,7 @@ module Mongoid
         # @example Destroy the document.
         #   builder.destroy_document(relation, doc)
         #
-        # @param [ Proxy ] relation The relation proxy.
+        # @param [ Proxy ] relation The association proxy.
         # @param [ Document ] doc The document to delete.
         #
         # @since 3.0.10
@@ -163,11 +165,11 @@ module Mongoid
           end
         end
 
-        # Update nested relation.
+        # Update nested association.
         #
         # @api private
         #
-        # @example Update nested relation.
+        # @example Update nested association.
         #   builder.update_nested_relation(parent, id, attrs)
         #
         # @param [ Document ] parent The parent document.
@@ -180,7 +182,7 @@ module Mongoid
           converted = first ? convert_id(first.class, id) : id
 
           if existing.where(id: converted).exists?
-            # document exists in relation
+            # document exists in association
             doc = existing.find(converted)
             if destroyable?(attrs)
               destroy(parent, existing, doc)
@@ -188,8 +190,8 @@ module Mongoid
               update_document(doc, attrs)
             end
           else
-            # push existing document to relation
-            doc = existing.unscoped.find(converted)
+            # push existing document to association
+            doc = association.klass.unscoped.find(converted)
             update_document(doc, attrs)
             existing.push(doc) unless destroyable?(attrs)
           end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Nested
@@ -22,7 +25,7 @@ module Mongoid
         # @example Is there a reject proc?
         #   builder.reject?
         #
-        # @param [ Document ] document The parent document of the relation
+        # @param [ Document ] document The parent document of the association
         # @param [ Hash ] attrs The attributes to check for rejection.
         #
         # @return [ true, false ] True and call proc or method if rejectable, false if not.
@@ -40,7 +43,7 @@ module Mongoid
         end
 
         # Determines if only updates can occur. Only valid for one-to-one
-        # relations.
+        # associations.
         #
         # @example Is this update only?
         #   builder.update_only?
@@ -69,4 +72,4 @@ module Mongoid
       end
     end
   end
-end
+end

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Nested
@@ -8,15 +10,15 @@ module Mongoid
         attr_accessor :destroy
 
 
-        # Builds the relation depending on the attributes and the options
+        # Builds the association depending on the attributes and the options
         # passed to the macro.
         #
         # @example Build a 1-1 nested document.
         #   one.build(person, as: :admin)
         #
         # @note This attempts to perform 3 operations, either one of an update of
-        #   the existing relation, a replacement of the relation with a new
-        #   document, or a removal of the relation.
+        #   the existing association, a replacement of the association with a new
+        #   document, or a removal of the association.
         #
         # @param [ Document ] parent The parent document.
         #
@@ -37,7 +39,7 @@ module Mongoid
         end
 
         # Create the new builder for nested attributes on one-to-one
-        # relations.
+        # associations.
         #
         # @example Instantiate the builder.
         #   One.new(association, attributes)
@@ -58,7 +60,7 @@ module Mongoid
         private
 
         # Is the id in the attribtues acceptable for allowing an update to
-        # the existing relation?
+        # the existing association?
         #
         # @api private
         #
@@ -73,24 +75,24 @@ module Mongoid
           existing._id == id || id.nil? || (existing._id != id && update_only?)
         end
 
-        # Can the existing relation be deleted?
+        # Can the existing association be deleted?
         #
         # @example Can the existing object be deleted?
         #   one.delete?
         #
-        # @return [ true, false ] If the relation should be deleted.
+        # @return [ true, false ] If the association should be deleted.
         #
         # @since 2.0.0
         def delete?
           destroyable? && !attributes[:id].nil?
         end
 
-        # Can the existing relation potentially be destroyed?
+        # Can the existing association potentially be destroyed?
         #
         # @example Is the object destroyable?
         #   one.destroyable?({ :_destroy => "1" })
         #
-        # @return [ true, false ] If the relation can potentially be
+        # @return [ true, false ] If the association can potentially be
         #   destroyed.
         #
         # @since 2.0.0

data/lib/mongoid/association/one.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
     # This is the superclass for one to one relations and defines the common
-    # behaviour or those proxies.
+    # behavior or those proxies.
     class One < Association::Proxy
 
       # Clear this relation - same as calling #delete on the document.

data/lib/mongoid/association/options.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
 
@@ -21,7 +24,7 @@ module Mongoid
         @options[:dependent]
       end
 
-      # The custom sorting options on the relation.
+      # The custom sorting options on the association.
       #
       # @return [ Criteria::Queryable::Key ] The custom sorting options.
       #
@@ -48,16 +51,16 @@ module Mongoid
         !!@options[:autobuild]
       end
 
-      # Is the relation cyclic.
+      # Is the association cyclic.
       #
-      # @return [ true, false ] Whether the relation is cyclic.
+      # @return [ true, false ] Whether the association is cyclic.
       #
       # @since 7.0
       def cyclic?
         !!@options[:cyclic]
       end
 
-      # The name the owning object uses to refer to this relation.
+      # The name the owning object uses to refer to this association.
       #
       # @return [ String ] The inverse_of option.
       #
@@ -103,7 +106,7 @@ module Mongoid
       # @since 7.0
       def polymorphic?; false; end
 
-      # Whether the relation has callbacks cascaded down from the parent.
+      # Whether the association has callbacks cascaded down from the parent.
       #
       # @return [ true, false ] Whether callbacks are cascaded.
       #
@@ -149,4 +152,4 @@ module Mongoid
       end
     end
   end
-end
+end

data/lib/mongoid/association/proxy.rb

@@ -1,29 +1,46 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/association/marshalable"
 
 module Mongoid
   module Association
 
-    # This class is the superclass for all relation proxy objects, and contains
-    # common behaviour for all of them.
+    # 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
 
       # We undefine most methods to get them sent through to the target.
       instance_methods.each do |method|
         undef_method(method) unless
-          method =~ /^(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)$/
+          method =~ /\A(__.*|send|object_id|equal\?|respond_to\?|tap|public_send|extend_proxy|extend_proxies)\z/
       end
 
       include Threaded::Lifecycle
       include Marshalable
 
-      attr_accessor :_base, :_association, :_target
+      # Model instance for the base of the association.
+      #
+      # For example, if a Post embeds_many Comments, _base is a particular
+      # instance of the Post model.
+      attr_accessor :_base
+
+      attr_accessor :_association
+
+      # Model instance for one to one associations, or array of model instances
+      # for one to many associations, for the target of the association.
+      #
+      # For example, if a Post embeds_many Comments, _target is an array of
+      # Comment models embedded in a particular Post.
+      attr_accessor :_target
 
       # Backwards compatibility with Mongoid beta releases.
-      delegate :foreign_key, :inverse_foreign_key, to: :_association
-      delegate :bind_one, :unbind_one, to: :binding
-      delegate :collection_name, to: :_base
+      def_delegators :_association, :foreign_key, :inverse_foreign_key
+      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.
@@ -52,17 +69,17 @@ module Mongoid
       # @example Get the class.
       #   proxy.klass
       #
-      # @return [ Class ] The relation class.
+      # @return [ Class ] The association class.
       #
       # @since 3.0.15
       def klass
         _association ? _association.klass : nil
       end
 
-      # Resets the criteria inside the relation proxy. Used by many to many
-      # relations to keep the underlying ids array in sync.
+      # Resets the criteria inside the association proxy. Used by many to many
+      # associations to keep the underlying ids array in sync.
       #
-      # @example Reset the relation criteria.
+      # @example Reset the association criteria.
       #   person.preferences.reset_relation_criteria
       #
       # @since 3.0.14
@@ -70,7 +87,7 @@ module Mongoid
         _target.reset_unloaded(criteria)
       end
 
-      # The default substitutable object for a relation proxy is the clone of
+      # The default substitutable object for an association proxy is the clone of
       # the target.
       #
       # @example Get the substitutable.
@@ -134,7 +151,7 @@ module Mongoid
       end
 
       # When the base is not yet saved and the user calls create or create!
-      # on the relation, this error will get raised.
+      # on the association, this error will get raised.
       #
       # @example Raise the error.
       #   relation.raise_unsaved(post)
@@ -168,7 +185,7 @@ module Mongoid
 
       class << self
 
-        # Apply ordering to the criteria if it was defined on the relation.
+        # Apply ordering to the criteria if it was defined on the association.
         #
         # @example Apply the ordering.
         #   Proxy.apply_ordering(criteria, association)

data/lib/mongoid/association/referenced.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/referenced/auto_save'
 require 'mongoid/association/referenced/counter_cache'
 require 'mongoid/association/referenced/syncable'

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -33,7 +36,7 @@ module Mongoid
         # Check if there is changes for auto-saving
         #
         # @example Return true if there is changes on self or in
-        #           autosaved relations.
+        #           autosaved associations.
         #   document.changed_for_autosave?
         #
         # @since 3.1.3

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/referenced/belongs_to/binding'
 require 'mongoid/association/referenced/belongs_to/buildable'
 require 'mongoid/association/referenced/belongs_to/proxy'
@@ -107,7 +110,7 @@ module Mongoid
                              default_foreign_key_field
         end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::BelongsTo::Proxy ] The proxy class.
         #
@@ -125,9 +128,9 @@ module Mongoid
           @polymorphic ||= !!@options[:polymorphic]
         end
 
-        # The name of the field used to store the type of polymorphic relation.
+        # The name of the field used to store the type of polymorphic association.
         #
-        # @return [ String ] The field used to store the type of polymorphic relation.
+        # @return [ String ] The field used to store the type of polymorphic association.
         #
         # @since 7.0
         def inverse_type