mongoid 7.0.13 → 7.1.0.rc0

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -13,8 +15,13 @@ module Mongoid
           # inverse side using the id or sets the object after clearing the
           # associated object.
           #
+          # @param [ Object ] base The base object.
+          # @param [ Object ] object The object to use to build the association.
+          # @param [ String ] type The type of the association.
+          # @param [ nil ] selected_fields Must be nil.
+          #
           # @return [ Document ] A single document.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             if query?(object)
               if !base.new_record?
                 execute_query(object, base)

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

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

data/lib/mongoid/association/referenced/has_one/nested_builder.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
@@ -7,15 +9,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.
           #
@@ -36,7 +38,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)
@@ -56,7 +58,7 @@ module Mongoid
           private
 
           # Is the id in the attribtues acceptable for allowing an update to
-          # the existing relation?
+          # the existing association?
           #
           # @api private
           #
@@ -71,24 +73,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/referenced/has_one/proxy.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
       class HasOne
 
-        # This class defines the behaviour for all relations that are a
+        # This class defines the behavior for all associations that are a
         # one-to-one between documents in different collections.
         class Proxy < Association::One
 
-          # Instantiate a new references_one relation. Will set the foreign key
+          # Instantiate a new references_one association. Will set the foreign key
           # and the base on the inverse object.
           #
-          # @example Create the new relation.
+          # @example Create the new association.
           #   Referenced::One.new(base, target, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Document ] target The target (child) of the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Document ] target The target (child) of the association.
           # @param [ Association ] association The association metadata.
           def initialize(base, target, association)
             init(base, target, association) do
@@ -30,7 +32,7 @@ module Mongoid
           # document by deleting the foreign key and the reference, orphaning
           # the target document in the process.
           #
-          # @example Nullify the relation.
+          # @example Nullify the association.
           #   person.game.nullify
           #
           # @since 2.0.0.rc.1
@@ -40,15 +42,15 @@ module Mongoid
           end
 
           # Substitutes the supplied target document for the existing document
-          # in the relation. If the new target is nil, perform the necessary
+          # in the association. If the new target is nil, perform the necessary
           # deletion.
           #
-          # @example Replace the relation.
+          # @example Replace the association.
           #   person.game.substitute(new_game)
           #
           # @param [ Array<Document> ] replacement The replacement target.
           #
-          # @return [ One ] The relation.
+          # @return [ One ] The association.
           #
           # @since 2.0.0.rc.1
           def substitute(replacement)
@@ -65,7 +67,7 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
@@ -75,12 +77,12 @@ module Mongoid
             HasOne::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?
@@ -93,10 +95,10 @@ module Mongoid
               Eager.new(association, docs)
             end
 
-            # 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 false.
             #
-            # @example Is this relation embedded?
+            # @example Is this association embedded?
             #   Referenced::One.embedded?
             #
             # @return [ false ] Always false.

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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Referenced
 
-      # This module handles the behaviour for synchronizing foreign keys between
-      # both sides of a many to many relations.
+      # This module handles the behavior for synchronizing foreign keys between
+      # both sides of a many to many associations.
       module Syncable
 
         # Is the document able to be synced on the inverse side? This is only if
-        # the key has changed and the relation bindings have not been run.
+        # the key has changed and the association bindings have not been run.
         #
         # @example Are the foreign keys syncable?
         #   document._syncable?(association)
@@ -65,7 +67,7 @@ module Mongoid
           end
         end
 
-        # Update the inverse keys for the relation.
+        # Update the inverse keys for the association.
         #
         # @example Update the inverse keys
         #   document.update_inverse_keys(association)
@@ -128,7 +130,7 @@ module Mongoid
           # @example Set up the save syncing.
           #   Person.synced_save(association)
           #
-          # @param [ Association ] association The relation association.
+          # @param [ Association ] association The association metadata.
           #
           # @return [ Class ] The class getting set up.
           #

data/lib/mongoid/association/reflections.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
@@ -9,10 +11,10 @@ module Mongoid
 
       # Returns the association metadata for the supplied name.
       #
-      # @example Find relation association by name.
+      # @example Find association metadata by name.
       #   person.reflect_on_association(:addresses)
       #
-      # @param [ String, Symbol ] name The name of the relation to find.
+      # @param [ String, Symbol ] name The name of the association to find.
       #
       # @return [ Association ] The matching association metadata.
       def reflect_on_association(name)
@@ -24,7 +26,7 @@ module Mongoid
       # @example Find multiple association metadata by macro.
       #   person.reflect_on_all_associations(:embeds_many)
       #
-      # @param [ Array<Symbol> ] macros The relation macros.
+      # @param [ Array<Symbol> ] macros The association macros.
       #
       # @return [ Array<Association> ] The matching association metadata.
       def reflect_on_all_association(*macros)
@@ -38,7 +40,7 @@ module Mongoid
         # @example Find association metadata by name.
         #   Person.reflect_on_association(:addresses)
         #
-        # @param [ String, Symbol ] name The name of the relation to find.
+        # @param [ String, Symbol ] name The name of the association to find.
         #
         # @return [ Association ] The matching association metadata.
         def reflect_on_association(name)
@@ -50,7 +52,7 @@ module Mongoid
         # @example Find multiple association metadata by macro.
         #   Person.reflect_on_all_associations(:embeds_many)
         #
-        # @param [ Array<Symbol> ] macros The relation macros.
+        # @param [ Array<Symbol> ] macros The association macros.
         #
         # @return [ Array<Association> ] The matching association metadata.
         def reflect_on_all_associations(*macros)

data/lib/mongoid/association/relatable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
 
@@ -32,7 +35,7 @@ module Mongoid
 
       # The name of the association.
       #
-      # @return [ Symbol ] The name of the relation.
+      # @return [ Symbol ] The name of the association.
       #
       # @since 7.0
       attr_reader :name
@@ -46,9 +49,9 @@ module Mongoid
 
       # Initialize the Association.
       #
-      # @param [ Class ] _class The class of the model who owns this relation.
+      # @param [ Class ] _class The class of the model who owns this association.
       # @param [ Symbol ] name The name of the association.
-      # @param [ Hash ] opts The relation options.
+      # @param [ Hash ] opts The association options.
       # @param [ Block ] block The optional block.
       #
       # @since 7.0
@@ -90,7 +93,7 @@ module Mongoid
       end
 
       # Get the type setter.
-      # @note Only relevant for polymorphic relations that take the :as option.
+      # @note Only relevant for polymorphic associations that take the :as option.
       #
       # @return [ String ] The type setter method.
       #
@@ -173,7 +176,7 @@ module Mongoid
       end
       alias :class_name :relation_class_name
 
-      # The class of the relation object(s).
+      # The class of the association object(s).
       #
       # This method returns the class instance corresponding to
       # +relation_class_name+, resolved relative to the host document class.
@@ -197,7 +200,7 @@ module Mongoid
       end
       alias :klass :relation_class
 
-      # The class name of the object owning this relation.
+      # The class name of the object owning this association.
       #
       # @return [ String ] The owning objects' class name.
       #
@@ -206,7 +209,7 @@ module Mongoid
         @inverse_class_name ||= @owner_class.name
       end
 
-      # The class of the object owning this relation.
+      # The class of the object owning this association.
       #
       # @return [ String ] The owning objects' class.
       #
@@ -216,7 +219,7 @@ module Mongoid
       end
       alias :inverse_klass :inverse_class
 
-      # The foreign key field if this relation stores a foreign key.
+      # The foreign key field if this association stores a foreign key.
       # Otherwise, the primary key.
       #
       # @return [ Symbol, String ] The primary key.
@@ -255,7 +258,7 @@ module Mongoid
         @foreign_key_setter ||= "#{foreign_key}=" if foreign_key
       end
 
-      # The atomic path for this relation.
+      # The atomic path for this association.
       #
       # @return [  Mongoid::Atomic::Paths::Root ] The atomic path object.
       #
@@ -265,7 +268,7 @@ module Mongoid
       end
 
       # Gets the setter for the field that sets the type of document on a
-      # polymorphic relation.
+      # polymorphic association.
       #
       # @example Get the inverse type setter.
       #   association.inverse_type_setter
@@ -289,11 +292,11 @@ module Mongoid
         @foreign_key_check ||= "#{foreign_key}_changed?" if (stores_foreign_key? && foreign_key)
       end
 
-      # Create a relation proxy object using the owner and target.
+      # Create an association proxy object using the owner and target.
       #
-      # @param [ Document ] owner The document this relation hangs off of.
+      # @param [ Document ] owner The document this association hangs off of.
       # @param [ Document, Array<Document> ] target The target (parent) of the
-      #   relation.
+      #   association.
       #
       # @return [ Proxy ]
       #
@@ -358,7 +361,7 @@ module Mongoid
       private
 
       # Gets the model classes with inverse associations of this model. This is used to determine
-      # the classes on the other end of polymorphic relations with models.
+      # the classes on the other end of polymorphic associations with models.
       def inverse_association_classes
         Mongoid::Config.models.map { |m| inverse_association(m) }.compact.map(&:inverse_class)
       end

data/lib/mongoid/atomic.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/atomic/modifiers"
 require "mongoid/atomic/paths"
 
@@ -36,9 +38,7 @@ module Mongoid
     # @since 2.2.0
     def add_atomic_pull(document)
       document.flagged_for_destroy = true
-      key = document.association_name.to_s
-      delayed_atomic_pulls[key] ||= []
-      delayed_atomic_pulls[key] << document
+      (delayed_atomic_pulls[document.association_name.to_s] ||= []).push(document)
     end
 
     # Add an atomic unset for the document.
@@ -53,9 +53,7 @@ module Mongoid
     # @since 3.0.0
     def add_atomic_unset(document)
       document.flagged_for_destroy = true
-      key = document.association_name.to_s
-      delayed_atomic_unsets[key] ||= []
-      delayed_atomic_unsets[key] << document
+      (delayed_atomic_unsets[document.association_name.to_s] ||= []).push(document)
     end
 
     # Returns path of the attribute for modification
@@ -193,13 +191,7 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_paths
-      @atomic_paths ||= begin
-        if _association
-          _association.path(self)
-        else
-          Atomic::Paths::Root.new(self)
-        end
-      end
+      @atomic_paths ||= _association ? _association.path(self) : Atomic::Paths::Root.new(self)
     end
 
     # Get all the attributes that need to be pulled.

data/lib/mongoid/atomic/modifiers.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Atomic
 
@@ -94,7 +96,7 @@ module Mongoid
       # @example Add unset operations.
       #   modifiers.unset([ "addresses" ])
       #
-      # @param [ Array<String> ] modifications The unset relation names.
+      # @param [ Array<String> ] modifications The unset association names.
       #
       # @since 2.2.0
       def unset(modifications)
@@ -130,6 +132,27 @@ module Mongoid
         end
       end
 
+      # Adds or appends an array operation with the $each specifier used
+      # in conjuction with $push.
+      #
+      # @example Add the operation.
+      #   modifications.add_operation(mods, field, value)
+      #
+      # @param [ Hash ] mods The modifications.
+      # @param [ String ] field The field.
+      # @param [ Hash ] value The atomic op.
+      #
+      # @since 7.0.0
+      def add_each_operation(mods, field, value)
+        if mods.has_key?(field)
+          value.each do |val|
+            mods[field]["$each"].push(val)
+          end
+        else
+          mods[field] = { "$each" => value }
+        end
+      end
+
       # Get the $addToSet operations or intialize a new one.
       #
       # @example Get the $addToSet operations.