mongoid 7.0.12 → 7.3.3

data/lib/mongoid/association/embedded/embeds_one/proxy.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -5,9 +8,9 @@ module Mongoid
 
         class Proxy < Association::One
 
-          # The valid options when defining this relation.
+          # The valid options when defining this association.
           #
-          # @return [ Array<Symbol> ] The allowed options when defining this relation.
+          # @return [ Array<Symbol> ] The allowed options when defining this association.
           #
           # @since 7.0
           VALID_OPTIONS = [
@@ -18,13 +21,13 @@ module Mongoid
               :store_as
           ].freeze
 
-          # Instantiate a new embeds_one relation.
+          # Instantiate a new embeds_one association.
           #
           # @example Create the new proxy.
           #   One.new(person, name, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Document ] target The child document in the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Document ] target The child document in the association.
           # @param [ Association ] association The association metadata.
           def initialize(base, target, association)
             init(base, target, association) do
@@ -37,14 +40,14 @@ module Mongoid
           end
 
           # Substitutes the supplied target documents for the existing document
-          # in the relation.
+          # in the association.
           #
           # @example Substitute the new document.
           #   person.name.substitute(new_name)
           #
           # @param [ Document ] replacement A document to replace the target.
           #
-          # @return [ Document, nil ] The relation or nil.
+          # @return [ Document, nil ] The association or nil.
           #
           # @since 2.0.0.rc.1
           def substitute(replacement)
@@ -69,24 +72,24 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
           #
-          # @return [ Binding ] The relation's binding.
+          # @return [ Binding ] The association's binding.
           #
           # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
 
-          # Are we able to persist this relation?
+          # Are we able to persist this association?
           #
-          # @example Can we persist the relation?
+          # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the relation is persistable.
+          # @return [ true, false ] If the association is persistable.
           #
           # @since 2.1.0
           def persistable?
@@ -95,10 +98,10 @@ module Mongoid
 
           class << self
 
-            # 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 true.
             #
-            # @example Is this relation embedded?
+            # @example Is this association embedded?
             #   Association::Embedded::EmbedsOne.embedded?
             #
             # @return [ true ] true.

data/lib/mongoid/association/embedded/embeds_one.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/embeds_one/binding'
 require 'mongoid/association/embedded/embeds_one/buildable'
 require 'mongoid/association/embedded/embeds_one/proxy'
@@ -58,7 +61,7 @@ module Mongoid
 
         # The key that is used to get the attributes for the associated object.
         #
-        # @return [ String ] The name of the field used to store the relation.
+        # @return [ String ] The name of the field used to store the association.
         #
         # @since 7.0
         def key
@@ -72,7 +75,7 @@ module Mongoid
         # @since 7.0
         def embedded?; true; end
 
-        # Get the default validation setting for the relation. Determines if
+        # Get the default validation setting for the association. Determines if
         # by default a validates associated will occur.
         #
         # @example Get the validation default.
@@ -92,10 +95,10 @@ module Mongoid
 
         # The primary key
         #
-        # @return [ nil ] Not relevant for this relation
+        # @return [ nil ] Not relevant for this association
         def primary_key; end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
         #

data/lib/mongoid/association/embedded.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/cyclic'
 require 'mongoid/association/embedded/embedded_in'
 require 'mongoid/association/embedded/embeds_many'

data/lib/mongoid/association/macros.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
-    # This module contains the core macros for defining relations between
-    # documents. They can be either embedded or referenced (relational).
+    # This module contains the core macros for defining associations between
+    # documents. They can be either embedded or referenced.
     module Macros
       extend ActiveSupport::Concern
 
@@ -21,7 +23,7 @@ module Mongoid
       # @example Get the associations.
       #   person.associations
       #
-      # @return [ Hash ] The relations.
+      # @return [ Hash ] The associations.
       #
       # @since 2.3.1
       def associations
@@ -30,12 +32,12 @@ module Mongoid
 
       module ClassMethods
 
-        # Adds the relation back to the parent document. This macro is
+        # Adds the association back to the parent document. This macro is
         # necessary to set the references from the child back to the parent
-        # document. If a child does not define this relation calling
+        # document. If a child does not define this association calling
         # persistence methods on the child object will cause a save to fail.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -47,18 +49,18 @@ module Mongoid
         #     embedded_in :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def embedded_in(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds the relation from a parent document to its children. The name
-        # of the relation needs to be a pluralized form of the child class
+        # Adds the association from a parent document to its children. The name
+        # of the association needs to be a pluralized form of the child class
         # name.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -70,18 +72,18 @@ module Mongoid
         #     embedded_in :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def embeds_many(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds the relation from a parent document to its child. The name
-        # of the relation needs to be a singular form of the child class
+        # Adds the association from a parent document to its child. The name
+        # of the association needs to be a singular form of the child class
         # name.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -93,17 +95,17 @@ module Mongoid
         #     embedded_in :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def embeds_one(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational association from the child Document to a Document in
-        # another database or collection.
+        # Adds a referenced association from the child Document to a Document
+        # in another database or collection.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Game
         #     include Mongoid::Document
@@ -115,17 +117,17 @@ module Mongoid
         #     has_one :game
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def belongs_to(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational association from a parent Document to many
+        # Adds a referenced association from a parent Document to many
         # Documents in another database or collection.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -137,17 +139,17 @@ module Mongoid
         #     belongs_to :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def has_many(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational many-to-many association between many of this
+        # Adds a referenced many-to-many association between many of this
         # Document and many of another Document.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -159,8 +161,8 @@ module Mongoid
         #     has_and_belongs_to_many :people
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         #
         # @since 2.0.0.rc.1
@@ -168,10 +170,10 @@ module Mongoid
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational association from the child Document to a Document in
-        # another database or collection.
+        # Adds a referenced association from the child Document to a Document
+        # in another database or collection.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Game
         #     include Mongoid::Document
@@ -183,8 +185,8 @@ module Mongoid
         #     has_one :game
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def has_one(name, options = {}, &block)
           define_association!(__method__, name, options, &block)

data/lib/mongoid/association/many.rb

@@ -1,28 +1,31 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
-    # This is the superclass for all many to one and many to many relation
+    # This is the superclass for all many to one and many to many association
     # proxies.
     class Many < Association::Proxy
+      extend Forwardable
       include ::Enumerable
 
-      delegate :avg, :max, :min, :sum, to: :criteria
-      delegate :length, :size, to: :_target
+      def_delegators :criteria, :avg, :max, :min, :sum
+      def_delegators :_target, :length, :size, :any?
 
-      # Is the relation empty?
+      # Is the association empty?
       #
-      # @example Is the relation empty??
+      # @example Is the association empty??
       #   person.addresses.blank?
       #
-      # @return [ true, false ] If the relation is empty or not.
+      # @return [ true, false ] If the association is empty or not.
       #
       # @since 2.1.0
       def blank?
-        size == 0
+        !any?
       end
 
-      # Creates a new document on the references many relation. This will
+      # Creates a new document on the references many association. This will
       # save the document if the parent has been persisted.
       #
       # @example Create and save the new document.
@@ -45,7 +48,7 @@ module Mongoid
         end
       end
 
-      # Creates a new document on the references many relation. This will
+      # Creates a new document on the references many association. This will
       # save the document if the parent has been persisted and will raise an
       # error if validation fails.
       #
@@ -142,9 +145,9 @@ module Mongoid
           klass.respond_to?(name, include_private) || super
       end
 
-      # This is public access to the relation's criteria.
+      # This is public access to the association's criteria.
       #
-      # @example Get the scoped relation.
+      # @example Get the scoped association.
       #   relation.scoped
       #
       # @return [ Criteria ] The scoped criteria.
@@ -163,7 +166,7 @@ module Mongoid
       #
       # @param [ Hash ] options The options to pass.
       #
-      # @option options [ Symbol ] :include What relations to include
+      # @option options [ Symbol ] :include What associations to include
       # @option options [ Symbol ] :only Limit the fields to only these.
       # @option options [ Symbol ] :except Dont include these fields.
       #
@@ -204,7 +207,7 @@ module Mongoid
       #
       # @return [ Document ] A matching document or a new/created one.
       def find_or(method, attrs = {}, type = nil, &block)
-        attrs["_type"] = type.to_s if type
+        attrs[klass.discriminator_key] = type.discriminator_value if type
         where(attrs).first || send(method, attrs, type, &block)
       end
     end

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/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.
@@ -179,8 +181,8 @@ module Mongoid
           first = existing.first
           converted = first ? convert_id(first.class, id) : id
 
-          if existing.where(id: converted).exists?
-            # document exists in relation
+          if existing.where(_id: converted).exists?
+            # 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
         #
@@ -69,28 +71,30 @@ module Mongoid
         #
         # @since 2.0.0
         def acceptable_id?
-          id = convert_id(existing.class, attributes[:id])
+          id = association.klass.extract_id_field(attributes)
+          id = convert_id(existing.class, id)
           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?
+          id = association.klass.extract_id_field(attributes)
+          destroyable? && !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/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/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.