mongoid 7.0.10 → 7.4.0

data/lib/mongoid/association/relatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
 
@@ -5,8 +7,6 @@ module Mongoid
   module Association
 
     # This module provides behaviors shared between Association types.
-    #
-    # @since 7.0
     module Relatable
       include Constrainable
       include Options
@@ -14,8 +14,6 @@ module Mongoid
       # The options shared between all association types.
       #
       # @return [ Array<Symbol> ] The shared options.
-      #
-      # @since 7.0
       SHARED_OPTIONS = [
                          :class_name,
                          :inverse_of,
@@ -26,32 +24,24 @@ module Mongoid
       # The primary key default.
       #
       # @return [ String ] The primary key field default.
-      #
-      # @since 7.0
       PRIMARY_KEY_DEFAULT = '_id'.freeze
 
       # The name of the association.
       #
-      # @return [ Symbol ] The name of the relation.
-      #
-      # @since 7.0
+      # @return [ Symbol ] The name of the association.
       attr_reader :name
 
       # The options on this association.
       #
       # @return [ Hash ] The options.
-      #
-      # @since 7.0
       attr_reader :options
 
       # 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
       def initialize(_class, name, opts = {}, &block)
         @owner_class = _class
         @name = name
@@ -68,8 +58,6 @@ module Mongoid
       # Compare this association to another.
       #
       # @return [ Object ] The object to compare to this association.
-      #
-      # @since 7.0
       def ==(other)
         relation_class_name == other.relation_class_name &&
           inverse_class_name == other.inverse_class_name &&
@@ -83,18 +71,14 @@ module Mongoid
       #
       # @return [ Array<Proc, Symbol> ] A list of the callbacks, either method
       #   names or Procs.
-      #
-      # @since 7.0
       def get_callbacks(callback_type)
         Array(options[callback_type])
       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.
-      #
-      # @since 7.0
       def type_setter
         @type_setter ||= type.__setter__
       end
@@ -105,8 +89,6 @@ module Mongoid
       # @param [ Document ] doc The document to be bound.
       #
       # @return [ true, false ] Whether the document can be bound.
-      #
-      # @since 7.0
       def bindable?(doc); false; end
 
       # Get the inverse names.
@@ -115,10 +97,10 @@ module Mongoid
       #   determining inverses.
       #
       # @return [ Array<Symbol> ] The list of inverse names.
-      #
-      # @since 7.0
       def inverses(other = nil)
         return [ inverse_of ] if inverse_of
+        return [] if @options.key?(:inverse_of) && !inverse_of
+
         if polymorphic?
           polymorphic_inverses(other)
         else
@@ -132,8 +114,6 @@ module Mongoid
       #   determining inverses.
       #
       # @return [ Association ] The inverse's association metadata.
-      #
-      # @since 7.0
       def inverse_association(other = nil)
         (other || relation_class).relations[inverse(other)]
       end
@@ -141,8 +121,6 @@ module Mongoid
       # Get the inverse type.
       #
       # @return [ nil ] Default is nil for an association.
-      #
-      # @since 7.0
       def inverse_type; end
 
       # The class name, possibly unqualified or :: prefixed, of the association
@@ -166,14 +144,12 @@ module Mongoid
       #   the +relation_class+ method.
       #
       # @return [ String ] The association objects' class name.
-      #
-      # @since 7.0
       def relation_class_name
         @class_name ||= @options[:class_name] || ActiveSupport::Inflector.classify(name)
       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.
@@ -187,8 +163,6 @@ module Mongoid
       # happen to be defined with the same name as the association name).
       #
       # @return [ String ] The association objects' class.
-      #
-      # @since 7.0
       def relation_class
         @klass ||= begin
           cls_name = @options[:class_name] || ActiveSupport::Inflector.classify(name)
@@ -197,31 +171,25 @@ 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.
-      #
-      # @since 7.0
       def inverse_class_name
         @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.
-      #
-      # @since 7.0
       def inverse_class
         @owner_class
       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.
-      #
-      # @since 7.0
       def key
         stores_foreign_key? ? foreign_key : primary_key
       end
@@ -229,8 +197,6 @@ module Mongoid
       # The name of the setter on this object for assigning an associated object.
       #
       # @return [ String ] The setter name.
-      #
-      # @since 7.0
       def setter
         @setter ||= "#{name}="
       end
@@ -238,8 +204,6 @@ module Mongoid
       # The name of the inverse setter method.
       #
       # @return [ String ] The name of the inverse setter.
-      #
-      # @since 7.0
       def inverse_setter(other = nil)
         @inverse_setter ||= "#{inverses(other).first}=" unless inverses(other).blank?
       end
@@ -247,32 +211,26 @@ module Mongoid
       # The name of the foreign key setter method.
       #
       # @return [ String ] The name of the foreign key setter.
-      #
-      # @since 7.0
       def foreign_key_setter
         # note: You can't check if this association stores foreign key
         # See HasOne and HasMany binding, they referenced foreign_key_setter
         @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.
-      #
-      # @since 7.0
       def path(document)
         relation.path(document)
       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
       #
       # @return [ String ] The name of the setter.
-      #
-      # @since 7.0
       def inverse_type_setter
         @inverse_type_setter ||= inverse_type.__setter__
       end
@@ -283,21 +241,17 @@ module Mongoid
       #   association.foreign_key_check
       #
       # @return [ String ] The foreign key check.
-      #
-      # @since 7.0
       def foreign_key_check
         @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 ]
-      #
-      # @since 7.0
       def create_relation(owner, target)
         relation.new(owner, target, self)
       end
@@ -305,8 +259,6 @@ module Mongoid
       # Whether the dependent method is destructive.
       #
       # @return [ true, false ] If the dependent method is destructive.
-      #
-      # @since 7.0
       def destructive?
         @destructive ||= !!(dependent && (dependent == :delete_all || dependent == :destroy))
       end
@@ -314,8 +266,6 @@ module Mongoid
       # Get the counter cache column name.
       #
       # @return [ String ] The counter cache column name.
-      #
-      # @since 7.0
       def counter_cache_column_name
         @counter_cache_column_name ||= (@options[:counter_cache].is_a?(String) ||
             @options[:counter_cache].is_a?(Symbol)) ?
@@ -325,8 +275,6 @@ module Mongoid
       # Get the extension.
       #
       # @return [ Module ] The extension module, if one has been defined.
-      #
-      # @since 7.0
       def extension
         @extension ||= @options[:extend]
       end
@@ -334,8 +282,6 @@ module Mongoid
       # Get the inverse name.
       #
       # @return [ Symbol ] The inverse name.
-      #
-      # @since 7.0
       def inverse(other = nil)
         candidates = inverses(other)
         candidates.detect { |c| c } if candidates
@@ -345,8 +291,6 @@ module Mongoid
       #
       # @return [ true, false ] If the associated object(s)
       #   should be validated.
-      #
-      # @since 7.0
       def validate?
         @validate ||= if @options[:validate].nil?
                         validation_default
@@ -358,7 +302,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/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,
@@ -57,32 +57,26 @@ module Mongoid
     #   address.embedded?
     #
     # @return [ true, false ] True if the document has a parent document.
-    #
-    # @since 2.0.0.rc.1
     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
     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
     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
     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
     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
@@ -150,8 +154,6 @@ module Mongoid
       # @param [ String ] field The field.
       #
       # @return [ true, false ] If this field is a conflict.
-      #
-      # @since 2.2.0
       def set_conflict?(field)
         name = field.split(".", 2)[0]
         pull_fields.has_key?(name) || push_fields.has_key?(name)
@@ -165,12 +167,10 @@ module Mongoid
       # @param [ String ] field The field.
       #
       # @return [ true, false ] If this field is a conflict.
-      #
-      # @since 2.2.0
       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,23 +16,19 @@ 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}"