mongoid 7.0.13 → 8.0.8

data/lib/mongoid/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/accessors'
 require 'mongoid/association/builders'
 require 'mongoid/association/bindable'
@@ -31,8 +33,6 @@ module Mongoid
     # Map the macros to their corresponding Association classes.
     #
     # @return [ Hash ] The mapping from macros to their Association class.
-    #
-    # @since 7.0
     MACRO_MAPPING = {
         embeds_one: Association::Embedded::EmbedsOne,
         embeds_many: Association::Embedded::EmbedsMany,
@@ -56,33 +56,27 @@ module Mongoid
     # @example Is the document embedded?
     #   address.embedded?
     #
-    # @return [ true, false ] True if the document has a parent document.
-    #
-    # @since 2.0.0.rc.1
+    # @return [ true | false ] True if the document has a parent document.
     def embedded?
       @embedded ||= (cyclic ? _parent.present? : self.class.embedded?)
     end
 
-    # Determine if the document is part of an embeds_many relation.
+    # Determine if the document is part of an embeds_many association.
     #
     # @example Is the document in an embeds many?
     #   address.embedded_many?
     #
-    # @return [ true, false ] True if in an embeds many.
-    #
-    # @since 2.0.0.rc.1
+    # @return [ true | false ] True if in an embeds many.
     def embedded_many?
       _association && _association.is_a?(Association::Embedded::EmbedsMany)
     end
 
-    # Determine if the document is part of an embeds_one relation.
+    # Determine if the document is part of an embeds_one association.
     #
     # @example Is the document in an embeds one?
     #   address.embedded_one?
     #
-    # @return [ true, false ] True if in an embeds one.
-    #
-    # @since 2.0.0.rc.1
+    # @return [ true | false ] True if in an embeds one.
     def embedded_one?
       _association && _association.is_a?(Association::Embedded::EmbedsOne)
     end
@@ -96,46 +90,38 @@ module Mongoid
     # @raise [ Errors::NoMetadata ] If no association metadata is present.
     #
     # @return [ Symbol ] The association name.
-    #
-    # @since 3.0.0
     def association_name
       raise Errors::NoMetadata.new(self.class.name) unless _association
       _association.name
     end
 
-    # Determine if the document is part of an references_many relation.
+    # Determine if the document is part of an references_many association.
     #
     # @example Is the document in a references many?
     #   post.referenced_many?
     #
-    # @return [ true, false ] True if in a references many.
-    #
-    # @since 2.0.0.rc.1
+    # @return [ true | false ] True if in a references many.
     def referenced_many?
       _association && _association.is_a?(Association::Referenced::HasMany)
     end
 
-    # Determine if the document is part of an references_one relation.
+    # Determine if the document is part of an references_one association.
     #
     # @example Is the document in a references one?
     #   address.referenced_one?
     #
-    # @return [ true, false ] True if in a references one.
-    #
-    # @since 2.0.0.rc.1
+    # @return [ true | false ] True if in a references one.
     def referenced_one?
       _association && _association.is_a?(Association::Referenced::HasOne)
     end
 
-    # Convenience method for iterating through the loaded relations and
+    # Convenience method for iterating through the loaded associations and
     # reloading them.
     #
-    # @example Reload the relations.
+    # @example Reload the associations.
     #   document.reload_relations
     #
     # @return [ Hash ] The association metadata.
-    #
-    # @since 2.1.6
     def reload_relations
       relations.each_pair do |name, meta|
         if instance_variable_defined?("@_#{name}")

data/lib/mongoid/atomic/modifiers.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Atomic
 
@@ -12,8 +13,6 @@ module Mongoid
       #   modifiers.add_to_set({ "preference_ids" => [ "one" ] })
       #
       # @param [ Hash ] modifications The add to set modifiers.
-      #
-      # @since 2.4.0
       def add_to_set(modifications)
         modifications.each_pair do |field, value|
           if add_to_sets.has_key?(field)
@@ -32,8 +31,6 @@ module Mongoid
       #   modifiers.pull_all({ "addresses" => { "street" => "Bond" }})
       #
       # @param [ Hash ] modifications The pull all modifiers.
-      #
-      # @since 3.0.0
       def pull_all(modifications)
         modifications.each_pair do |field, value|
           add_operation(pull_alls, field, value)
@@ -47,8 +44,6 @@ module Mongoid
       #   modifiers.pull({ "addresses" => { "_id" => { "$in" => [ 1, 2, 3 ]}}})
       #
       # @param [ Hash ] modifications The pull all modifiers.
-      #
-      # @since 3.0.0
       def pull(modifications)
         modifications.each_pair do |field, value|
           pulls[field] = value
@@ -62,8 +57,6 @@ module Mongoid
       #   modifiers.push({ "addresses" => { "street" => "Bond" }})
       #
       # @param [ Hash ] modifications The push modifiers.
-      #
-      # @since 2.1.0
       def push(modifications)
         modifications.each_pair do |field, value|
           push_fields[field] = field
@@ -78,8 +71,6 @@ module Mongoid
       #   modifiers.set({ "title" => "sir" })
       #
       # @param [ Hash ] modifications The set modifiers.
-      #
-      # @since 2.1.0
       def set(modifications)
         modifications.each_pair do |field, value|
           next if field == "_id"
@@ -94,9 +85,7 @@ module Mongoid
       # @example Add unset operations.
       #   modifiers.unset([ "addresses" ])
       #
-      # @param [ Array<String> ] modifications The unset relation names.
-      #
-      # @since 2.2.0
+      # @param [ Array<String> ] modifications The unset association names.
       def unset(modifications)
         modifications.each do |field|
           unsets.update(field => true)
@@ -114,8 +103,6 @@ module Mongoid
       # @param [ Hash ] mods The modifications.
       # @param [ String ] field The field.
       # @param [ Hash ] value The atomic op.
-      #
-      # @since 2.2.0
       def add_operation(mods, field, value)
         if mods.has_key?(field)
           if mods[field].is_a?(Array)
@@ -130,14 +117,31 @@ module Mongoid
         end
       end
 
-      # Get the $addToSet operations or intialize a new one.
+      # 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.
+      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 initialize a new one.
       #
       # @example Get the $addToSet operations.
       #   modifiers.add_to_sets
       #
       # @return [ Hash ] The $addToSet operations.
-      #
-      # @since 2.4.0
       def add_to_sets
         self["$addToSet"] ||= {}
       end
@@ -149,9 +153,7 @@ module Mongoid
       #
       # @param [ String ] field The field.
       #
-      # @return [ true, false ] If this field is a conflict.
-      #
-      # @since 2.2.0
+      # @return [ true | false ] If this field is a conflict.
       def set_conflict?(field)
         name = field.split(".", 2)[0]
         pull_fields.has_key?(name) || push_fields.has_key?(name)
@@ -164,13 +166,11 @@ module Mongoid
       #
       # @param [ String ] field The field.
       #
-      # @return [ true, false ] If this field is a conflict.
-      #
-      # @since 2.2.0
+      # @return [ true | false ] If this field is a conflict.
       def push_conflict?(field)
         name = field.split(".", 2)[0]
         set_fields.has_key?(name) || pull_fields.has_key?(name) ||
-          (push_fields.keys.count { |item| item =~ /#{name}/ } > 1)
+          (push_fields.keys.count { |item| item.split('.', 2).first == name } > 1)
       end
 
       # Get the conflicting pull modifications.
@@ -179,8 +179,6 @@ module Mongoid
       #   modifiers.conflicting_pulls
       #
       # @return [ Hash ] The conflicting pull operations.
-      #
-      # @since 2.2.0
       def conflicting_pulls
         conflicts["$pullAll"] ||= {}
       end
@@ -191,8 +189,6 @@ module Mongoid
       #   modifiers.conflicting_pushs
       #
       # @return [ Hash ] The conflicting push operations.
-      #
-      # @since 2.2.0
       def conflicting_pushes
         conflicts["$push"] ||= {}
       end
@@ -203,8 +199,6 @@ module Mongoid
       #   modifiers.conflicting_sets
       #
       # @return [ Hash ] The conflicting set operations.
-      #
-      # @since 2.2.0
       def conflicting_sets
         conflicts["$set"] ||= {}
       end
@@ -215,8 +209,6 @@ module Mongoid
       #   modifiers.conflicts
       #
       # @return [ Hash ] The conflicting modifications.
-      #
-      # @since 2.1.0
       def conflicts
         self[:conflicts] ||= {}
       end
@@ -227,8 +219,6 @@ module Mongoid
       #   modifiers.pull_fields
       #
       # @return [ Array<String> ] The pull fields.
-      #
-      # @since 2.2.0
       def pull_fields
         @pull_fields ||= {}
       end
@@ -239,8 +229,6 @@ module Mongoid
       #   modifiers.push_fields
       #
       # @return [ Array<String> ] The push fields.
-      #
-      # @since 2.2.0
       def push_fields
         @push_fields ||= {}
       end
@@ -251,32 +239,26 @@ module Mongoid
       #   modifiers.set_fields
       #
       # @return [ Array<String> ] The set fields.
-      #
-      # @since 2.2.0
       def set_fields
         @set_fields ||= {}
       end
 
-      # Get the $pullAll operations or intialize a new one.
+      # Get the $pullAll operations or initialize a new one.
       #
       # @example Get the $pullAll operations.
       #   modifiers.pull_alls
       #
       # @return [ Hash ] The $pullAll operations.
-      #
-      # @since 3.0.0
       def pull_alls
         self["$pullAll"] ||= {}
       end
 
-      # Get the $pull operations or intialize a new one.
+      # Get the $pull operations or initialize a new one.
       #
       # @example Get the $pull operations.
       #   modifiers.pulls
       #
       # @return [ Hash ] The $pull operations.
-      #
-      # @since 3.0.0
       def pulls
         self["$pull"] ||= {}
       end
@@ -287,20 +269,16 @@ module Mongoid
       #   modifiers.pushes
       #
       # @return [ Hash ] The $push/$each operations.
-      #
-      # @since 2.1.0
       def pushes
         self["$push"] ||= {}
       end
 
-      # Get the $set operations or intialize a new one.
+      # Get the $set operations or initialize a new one.
       #
       # @example Get the $set operations.
       #   modifiers.sets
       #
       # @return [ Hash ] The $set operations.
-      #
-      # @since 2.1.0
       def sets
         self["$set"] ||= {}
       end
@@ -311,8 +289,6 @@ module Mongoid
       #   modifiers.unsets
       #
       # @return [ Hash ] The $unset operations.
-      #
-      # @since 2.2.0
       def unsets
         self["$unset"] ||= {}
       end

data/lib/mongoid/atomic/paths/embedded/many.rb

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Atomic
     module Paths
       module Embedded
 
-        # This class encapsulates behaviour for locating and updating
+        # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-n.
         class Many
           include Embedded
@@ -15,28 +16,43 @@ module Mongoid
           #   Many.new(document)
           #
           # @param [ Document ] document The document to generate the paths for.
-          #
-          # @since 2.1.0
           def initialize(document)
             @document, @parent = document, document._parent
             @insert_modifier, @delete_modifier ="$push", "$pull"
           end
 
           # Get the position of the document in the hierarchy. This will
-          # include indexes of 1-n embedded relations that may sit above the
+          # include indexes of 1-n embedded associations that may sit above the
           # embedded many.
           #
           # @example Get the position.
           #   many.position
           #
           # @return [ String ] The position of the document.
-          #
-          # @since 2.1.0
           def position
             pos = parent.atomic_position
             locator = document.new_record? ? "" : ".#{document._index}"
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
           end
+
+          class << self
+
+            # Get the position of where the document would go for the given
+            # association. The use case for this function is when trying to
+            # persist an empty list for an embedded association. All of the
+            # existing functions for getting the position to store a document
+            # require passing in a document to store, which we don't have when
+            # trying to store the empty list.
+            #
+            # @param [ Document ] parent The parent document to store in.
+            # @param [ Association ] association The association.
+            #
+            # @return [ String ] The position string.
+            def position_without_document(parent, association)
+              pos = parent.atomic_position
+              "#{pos}#{"." unless pos.blank?}#{association.store_as}"
+            end
+          end
         end
       end
     end

data/lib/mongoid/atomic/paths/embedded/one.rb

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Atomic
     module Paths
       module Embedded
 
-        # This class encapsulates behaviour for locating and updating
+        # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-1.
         class One
           include Embedded
@@ -15,23 +16,19 @@ module Mongoid
           #   One.new(document)
           #
           # @param [ Document ] document The document to generate the paths for.
-          #
-          # @since 2.1.0
           def initialize(document)
             @document, @parent = document, document._parent
             @insert_modifier, @delete_modifier ="$set", "$unset"
           end
 
           # Get the position of the document in the hierarchy. This will
-          # include indexes of 1-n embedded relations that may sit above the
+          # include indexes of 1-n embedded associations that may sit above the
           # embedded one.
           #
           # @example Get the position.
           #   one.position
           #
           # @return [ String ] The position of the document.
-          #
-          # @since 2.1.0
           def position
             pos = parent.atomic_position
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}"

data/lib/mongoid/atomic/paths/embedded.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/atomic/paths/embedded/one"
 require "mongoid/atomic/paths/embedded/many"
 
@@ -17,8 +18,6 @@ module Mongoid
         #   many.path
         #
         # @return [ String ] The path to the document.
-        #
-        # @since 2.1.0
         def path
           @path ||= position.sub(/\.\d+\z/, "")
         end

data/lib/mongoid/atomic/paths/root.rb

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Atomic
     module Paths
 
-      # This class encapsulates behaviour for locating and updating root
+      # This class encapsulates behavior for locating and updating root
       # documents atomically.
       class Root
 
@@ -15,21 +16,17 @@ module Mongoid
         #   Root.new(document)
         #
         # @param [ Document ] document The document to generate the paths for.
-        #
-        # @since 2.1.0
         def initialize(document)
           @document, @path, @position = document, "", ""
         end
 
         # Asking for the insert modifier on a document with a root path
-        # indicates a mixed relation most likely happened.
+        # indicates a mixed association most likely happened.
         #
         # @example Attempt to get the insert modifier.
         #   root.insert_modifier
         #
         # @raise [ Errors::InvalidPath ] The error for the attempt.
-        #
-        # @since 3.0.14
         def insert_modifier
           raise Errors::InvalidPath.new(document.class)
         end

data/lib/mongoid/atomic/paths.rb

@@ -1,3 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/atomic/paths/embedded"
 require "mongoid/atomic/paths/root"