mongoid 9.0.11 → 9.1.1

data/lib/mongoid/association/relatable.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
 
 module Mongoid
   module Association
-
     # This module provides behaviors shared between Association types.
     module Relatable
       include Constrainable
@@ -15,17 +13,17 @@ module Mongoid
       # The options shared between all association types.
       #
       # @return [ Array<Symbol> ] The shared options.
-      SHARED_OPTIONS = [
-                         :class_name,
-                         :inverse_of,
-                         :validate,
-                         :extend
-                       ].freeze
+      SHARED_OPTIONS = %i[
+        class_name
+        inverse_of
+        validate
+        extend
+      ].freeze
 
       # The primary key default.
       #
       # @return [ String ] The primary key field default.
-      PRIMARY_KEY_DEFAULT = '_id'.freeze
+      PRIMARY_KEY_DEFAULT = '_id'
 
       # The name of the association.
       #
@@ -37,6 +35,11 @@ module Mongoid
       # @return [ Hash ] The options.
       attr_reader :options
 
+      # The class that owns this association.
+      #
+      # @return [ Class ] The owner class.
+      attr_reader :owner_class
+
       # Initialize the Association.
       #
       # @param [ Class ] _class The class of the model who owns this association.
@@ -62,8 +65,8 @@ module Mongoid
       def ==(other)
         relation_class_name == other.relation_class_name &&
           inverse_class_name == other.inverse_class_name &&
-            name == other.name &&
-              options == other.options
+          name == other.name &&
+          options == other.options
       end
 
       # Get the callbacks for a given type.
@@ -90,7 +93,9 @@ module Mongoid
       # @param [ Document ] doc The document to be bound.
       #
       # @return [ true | false ] Whether the document can be bound.
-      def bindable?(doc); false; end
+      def bindable?(_doc)
+        false
+      end
 
       # Get the inverse names.
       #
@@ -148,7 +153,7 @@ module Mongoid
       def relation_class_name
         @class_name ||= @options[:class_name] || ActiveSupport::Inflector.classify(name)
       end
-      alias :class_name :relation_class_name
+      alias class_name relation_class_name
 
       # The class of the association object(s).
       #
@@ -170,7 +175,24 @@ module Mongoid
           resolve_name(inverse_class, cls_name)
         end
       end
-      alias :klass :relation_class
+      alias klass relation_class
+
+      # The class of the association target, or nil when the named class is
+      # not defined.
+      #
+      # An association may name a class that never gets defined. The
+      # association is then unusable, but its owner still has to be. Callers
+      # that walk every association of every model, rather than following the
+      # one the application asked for, use this instead of relation_class.
+      #
+      # @return [ Class | nil ] The association objects' class.
+      #
+      # @api private
+      def try_relation_class
+        relation_class
+      rescue NameError
+        nil
+      end
 
       # The class name of the object owning this association.
       #
@@ -185,7 +207,7 @@ module Mongoid
       def inverse_class
         @owner_class
       end
-      alias :inverse_klass :inverse_class
+      alias inverse_klass inverse_class
 
       # The foreign key field if this association stores a foreign key.
       # Otherwise, the primary key.
@@ -213,7 +235,7 @@ module Mongoid
       #
       # @return [ String ] The name of the foreign key setter.
       def foreign_key_setter
-        # note: You can't check if this association stores foreign key
+        # 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
@@ -243,7 +265,7 @@ module Mongoid
       #
       # @return [ String ] The foreign key check.
       def foreign_key_check
-        @foreign_key_check ||= "#{foreign_key}_previously_changed?" if (stores_foreign_key? && foreign_key)
+        @foreign_key_check ||= "#{foreign_key}_previously_changed?" if stores_foreign_key? && foreign_key
       end
 
       # Create an association proxy object using the owner and target.
@@ -261,16 +283,19 @@ module Mongoid
       #
       # @return [ true | false ] If the dependent method is destructive.
       def destructive?
-        @destructive ||= !!(dependent && (dependent == :delete_all || dependent == :destroy))
+        @destructive ||= !!(dependent && %i[delete_all destroy].include?(dependent))
       end
 
       # Get the counter cache column name.
       #
       # @return [ String ] The counter cache column name.
       def counter_cache_column_name
-        @counter_cache_column_name ||= (@options[:counter_cache].is_a?(String) ||
-            @options[:counter_cache].is_a?(Symbol)) ?
-            @options[:counter_cache] : "#{inverse || inverse_class_name.demodulize.underscore.pluralize}_count"
+        @counter_cache_column_name ||= if @options[:counter_cache].is_a?(String) ||
+                                          @options[:counter_cache].is_a?(Symbol)
+                                         @options[:counter_cache]
+                                       else
+                                         "#{inverse || inverse_class_name.demodulize.underscore.pluralize}_count"
+                                       end
       end
 
       # Get the extension.
@@ -303,7 +328,7 @@ module Mongoid
       # The associations above this one in the inclusion tree.
       #
       # @return [ Array<String> ] The associations.
-      attr_accessor :parent_inclusions
+      attr_writer :parent_inclusions
 
       # The associations above this one in the inclusion tree.
       #
@@ -316,14 +341,14 @@ module Mongoid
       #
       # @return [ true | false ] true if it is a *_many association, false if not.
       def many?
-        [Referenced::HasMany, Embedded::EmbedsMany].any? { |a| self.is_a?(a) }
+        [ Referenced::HasMany, Embedded::EmbedsMany ].any? { |a| is_a?(a) }
       end
 
       # Is this association an embeds_one or has_one association?
       #
       # @return [ true | false ] true if it is a *_one association, false if not.
       def one?
-        [Referenced::HasOne, Embedded::EmbedsOne].any? { |a| self.is_a?(a) }
+        [ Referenced::HasOne, Embedded::EmbedsOne ].any? { |a| is_a?(a) }
       end
 
       # Is this association an embedded_in or belongs_to association?
@@ -331,7 +356,16 @@ module Mongoid
       # @return [ true | false ] true if it is an embedded_in or belongs_to
       #   association, false if not.
       def in_to?
-        [Referenced::BelongsTo, Embedded::EmbeddedIn].any? { |a| self.is_a?(a) }
+        [ Referenced::BelongsTo, Embedded::EmbeddedIn ].any? { |a| is_a?(a) }
+      end
+
+      # Is this association a many-to-many association? Such an association stores
+      # its foreign keys as an array on the document itself.
+      #
+      # @return [ true | false ] true if it is a has_and_belongs_to_many
+      #   association, false if not.
+      def many_to_many?
+        is_a?(Referenced::HasAndBelongsToMany)
       end
 
       private
@@ -347,15 +381,15 @@ module Mongoid
       end
 
       def define_touchable!
-        if touchable?
-          Touchable.define_touchable!(self)
-        end
+        return unless touchable?
+
+        Touchable.define_touchable!(self)
       end
 
       def define_autosaver!
-        if autosave?
-          Association::Referenced::AutoSave.define_autosave!(self)
-        end
+        return unless autosave?
+
+        Association::Referenced::AutoSave.define_autosave!(self)
       end
 
       def define_builder!
@@ -387,15 +421,15 @@ module Mongoid
       end
 
       def define_counter_cache_callbacks!
-        if counter_cached?
-          Association::Referenced::CounterCache.define_callbacks!(self)
-        end
+        return unless counter_cached?
+
+        Association::Referenced::CounterCache.define_callbacks!(self)
       end
 
       def define_dependency!
-        if dependent
-          Association::Depending.define_dependency!(self)
-        end
+        return unless dependent
+
+        Association::Depending.define_dependency!(self)
       end
 
       def validate!
@@ -405,27 +439,39 @@ module Mongoid
           end
         end
 
-        [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
-          if Mongoid.destructive_fields.include?(n)
-            raise Errors::InvalidRelation.new(@owner_class, n)
+        if @options.key?(:fallback)
+          unless @options[:fallback].respond_to?(:call)
+            raise ArgumentError,
+                  "The :fallback option for association '#{name}' on " \
+                  "#{@owner_class} must be a Proc or lambda."
+          end
+
+          if @options.key?(:autobuild)
+            raise ArgumentError,
+                  "The :fallback option for association '#{name}' on " \
+                  "#{@owner_class} cannot be combined with :autobuild."
           end
         end
+
+        [ name, :"#{name}?", :"#{name}=" ].each do |n|
+          raise Errors::InvalidRelation.new(@owner_class, n) if Mongoid.destructive_fields.include?(n)
+        end
       end
 
       def polymorph!
-        if polymorphic?
-          @owner_class.polymorphic = true
-        end
+        return unless polymorphic?
+
+        @owner_class.polymorphic = true
       end
 
       def create_extension!(&block)
-        if block
-          extension_module_name = "#{@owner_class.to_s.demodulize}#{name.to_s.camelize}RelationExtension"
-          silence_warnings do
-            @owner_class.const_set(extension_module_name, Module.new(&block))
-          end
-          @extension = "#{@owner_class}::#{extension_module_name}".constantize
+        return unless block
+
+        extension_module_name = "#{@owner_class.to_s.demodulize}#{name.to_s.camelize}RelationExtension"
+        silence_warnings do
+          @owner_class.const_set(extension_module_name, Module.new(&block))
         end
+        @extension = "#{@owner_class}::#{extension_module_name}".constantize
       end
 
       def default_inverse
@@ -438,7 +484,7 @@ module Mongoid
       # [Foo::Bar, Foo, Object].
       def namespace_hierarchy(mod)
         parent = Object
-        hier = [parent]
+        hier = [ parent ]
 
         # name is not present on anonymous modules
         if mod.name
@@ -463,31 +509,28 @@ module Mongoid
         parts = name.to_s.split('::')
         if parts.first == ''
           parts.shift
-          hierarchy = [Object]
+          hierarchy = [ Object ]
         else
           hierarchy = namespace_hierarchy(mod)
         end
         hierarchy.each do |ns|
-          begin
-            parts.each do |part|
-              # Simple const_get sometimes pulls names out of weird scopes,
-              # perhaps confusing the receiver (ns in this case) with the
-              # local scope. Walk the class hierarchy ourselves one node
-              # at a time by specifying false as the second argument.
-              ns = ns.const_get(part, false)
-            end
-            cls = ns
-            break
-          rescue NameError => e
-            if exc.nil?
-              exc = e
-            end
+          parts.each do |part|
+            # Simple const_get sometimes pulls names out of weird scopes,
+            # perhaps confusing the receiver (ns in this case) with the
+            # local scope. Walk the class hierarchy ourselves one node
+            # at a time by specifying false as the second argument.
+            ns = ns.const_get(part, false)
           end
+          cls = ns
+          break
+        rescue NameError => e
+          exc = e if exc.nil?
         end
         if cls.nil?
           # Raise the first exception, this is from the most specific namespace
           raise exc
         end
+
         cls
       end
     end

data/lib/mongoid/association.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/accessors'
 require 'mongoid/association/builders'
@@ -19,7 +18,6 @@ require 'mongoid/association/reflections'
 require 'mongoid/association/eager_loadable'
 
 module Mongoid
-
   # Mixin module which adds association behavior to a Mongoid document.
   # Adds methods such as #embedded? which indicate a document's
   # relative association state.
@@ -39,13 +37,20 @@ module Mongoid
     #
     # @return [ Hash ] The mapping from macros to their Association class.
     MACRO_MAPPING = {
-        embeds_one: Association::Embedded::EmbedsOne,
-        embeds_many: Association::Embedded::EmbedsMany,
-        embedded_in: Association::Embedded::EmbeddedIn,
-        has_one: Association::Referenced::HasOne,
-        has_many: Association::Referenced::HasMany,
-        has_and_belongs_to_many: Association::Referenced::HasAndBelongsToMany,
-        belongs_to: Association::Referenced::BelongsTo,
+      embeds_one: Association::Embedded::EmbedsOne,
+      embeds_many: Association::Embedded::EmbedsMany,
+      embedded_in: Association::Embedded::EmbeddedIn,
+      has_one: Association::Referenced::HasOne,
+      has_many: Association::Referenced::HasMany,
+      has_and_belongs_to_many: Association::Referenced::HasAndBelongsToMany,
+      belongs_to: Association::Referenced::BelongsTo
+    }.freeze
+
+    # Internal mapping used when :through option is present. Not exposed as
+    # callable macros.
+    THROUGH_MACRO_MAPPING = {
+      has_one: Association::Referenced::HasOneThrough,
+      has_many: Association::Referenced::HasManyThrough
     }.freeze
 
     attr_accessor :_association
@@ -97,6 +102,7 @@ module Mongoid
     # @return [ Symbol ] The association name.
     def association_name
       raise Errors::NoMetadata.new(self.class.name) unless _association
+
       _association.name
     end
 
@@ -128,12 +134,10 @@ module Mongoid
     #
     # @return [ Hash ] The association metadata.
     def reload_relations
-      relations.each_pair do |name, meta|
-        if instance_variable_defined?("@_#{name}")
-          if _parent.nil? || instance_variable_get("@_#{name}") != _parent
-            remove_instance_variable("@_#{name}")
-          end
-        end
+      relations.each_pair do |name, _meta|
+        next unless instance_variable_defined?("@_#{name}")
+
+        remove_instance_variable("@_#{name}") if _parent.nil? || instance_variable_get("@_#{name}") != _parent
       end
     end
   end

data/lib/mongoid/atomic/modifiers.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
-
     # This class contains the logic for supporting atomic operations against the
     # database.
     class Modifiers < Hash
-
       # Add the atomic $addToSet modifiers to the hash.
       #
       # @example Add the $addToSet modifiers.
@@ -18,10 +15,10 @@ module Mongoid
         modifications.each_pair do |field, value|
           if add_to_sets.has_key?(field)
             value.each do |val|
-              add_to_sets[field]["$each"].push(val)
+              add_to_sets[field]['$each'].push(val)
             end
           else
-            add_to_sets[field] = { "$each" => value }
+            add_to_sets[field] = { '$each' => value }
           end
         end
       end
@@ -35,7 +32,7 @@ module Mongoid
       def pull_all(modifications)
         modifications.each_pair do |field, value|
           add_operation(pull_alls, field, value)
-          pull_fields[field.split(".", 2)[0]] = field
+          pull_fields[field.split('.', 2)[0]] = field
         end
       end
 
@@ -48,7 +45,7 @@ module Mongoid
       def pull(modifications)
         modifications.each_pair do |field, value|
           pulls[field] = value
-          pull_fields[field.split(".", 2)[0]] = field
+          pull_fields[field.split('.', 2)[0]] = field
         end
       end
 
@@ -74,10 +71,11 @@ module Mongoid
       # @param [ Hash ] modifications The set modifiers.
       def set(modifications)
         modifications.each_pair do |field, value|
-          next if field == "_id"
+          next if field == '_id'
+
           mods = set_conflict?(field) ? conflicting_sets : sets
           add_operation(mods, field, value)
-          set_fields[field.split(".", 2)[0]] = field
+          set_fields[field.split('.', 2)[0]] = field
         end
       end
 
@@ -89,7 +87,18 @@ module Mongoid
       # @param [ Array<String> ] modifications The unset association names.
       def unset(modifications)
         modifications.each do |field|
-          unsets.update(field => true)
+          field = field.to_s
+
+          if unset_conflict?(field)
+            # If the conflicting $set covers the entire parent field (not just a
+            # sub-path), it writes the complete current state, which already
+            # reflects this unset. Skip the $unset — it's redundant.
+            next if unset_superseded_by_set?(field)
+
+            conflicting_unsets.update(field => true)
+          else
+            unsets.update(field => true)
+          end
         end
       end
 
@@ -119,7 +128,7 @@ module Mongoid
       end
 
       # Adds or appends an array operation with the $each specifier used
-      # in conjuction with $push.
+      # in conjunction with $push.
       #
       # @example Add the operation.
       #   modifications.add_operation(mods, field, value)
@@ -130,10 +139,10 @@ module Mongoid
       def add_each_operation(mods, field, value)
         if mods.has_key?(field)
           value.each do |val|
-            mods[field]["$each"].push(val)
+            mods[field]['$each'].push(val)
           end
         else
-          mods[field] = { "$each" => value }
+          mods[field] = { '$each' => value }
         end
       end
 
@@ -144,7 +153,7 @@ module Mongoid
       #
       # @return [ Hash ] The $addToSet operations.
       def add_to_sets
-        self["$addToSet"] ||= {}
+        self['$addToSet'] ||= {}
       end
 
       # Is the operation going to be a conflict for a $set?
@@ -156,10 +165,20 @@ module Mongoid
       #
       # @return [ true | false ] If this field is a conflict.
       def set_conflict?(field)
-        name = field.split(".", 2)[0]
+        name = field.split('.', 2)[0]
         pull_fields.has_key?(name) || push_fields.has_key?(name)
       end
 
+      # Is the operation going to be a conflict for an $unset?
+      #
+      # @param [ String ] field The field.
+      #
+      # @return [ true | false ] If this field is a conflict.
+      def unset_conflict?(field)
+        key = field.split('.', 2)[0]
+        set_fields.has_key?(key)
+      end
+
       # Is the operation going to be a conflict for a $push?
       #
       # @example Is this a conflict for a push?
@@ -169,11 +188,23 @@ module Mongoid
       #
       # @return [ true | false ] If this field is a conflict.
       def push_conflict?(field)
-        name = field.split(".", 2)[0]
+        name = field.split('.', 2)[0]
         set_fields.has_key?(name) || pull_fields.has_key?(name) ||
           (push_fields.keys.count { |item| item.split('.', 2).first == name } > 1)
       end
 
+      # Returns true if the $unset is made redundant by a $set that covers
+      # the entire root-level field. When $set "children" is issued, the
+      # current (live) state of the array already includes all pending changes
+      # (e.g., embedded association removed), so a $unset for any children.*.x
+      # field is unnecessary.
+      #
+      # @param [ String ] field the field
+      def unset_superseded_by_set?(field)
+        key = field.split('.', 2).first
+        sets(initialize: false).has_key?(key)
+      end
+
       # Get the conflicting pull modifications.
       #
       # @example Get the conflicting pulls.
@@ -181,7 +212,7 @@ module Mongoid
       #
       # @return [ Hash ] The conflicting pull operations.
       def conflicting_pulls
-        conflicts["$pullAll"] ||= {}
+        conflicts['$pullAll'] ||= {}
       end
 
       # Get the conflicting push modifications.
@@ -191,7 +222,7 @@ module Mongoid
       #
       # @return [ Hash ] The conflicting push operations.
       def conflicting_pushes
-        conflicts["$push"] ||= {}
+        conflicts['$push'] ||= {}
       end
 
       # Get the conflicting set modifications.
@@ -201,7 +232,14 @@ module Mongoid
       #
       # @return [ Hash ] The conflicting set operations.
       def conflicting_sets
-        conflicts["$set"] ||= {}
+        conflicts['$set'] ||= {}
+      end
+
+      # Get the conflicting unset modifications.
+      #
+      # @return [ Hash ] The conflicting unset operations.
+      def conflicting_unsets
+        conflicts['$unset'] ||= {}
       end
 
       # Get the push operations that would have conflicted with the sets.
@@ -251,7 +289,7 @@ module Mongoid
       #
       # @return [ Hash ] The $pullAll operations.
       def pull_alls
-        self["$pullAll"] ||= {}
+        self['$pullAll'] ||= {}
       end
 
       # Get the $pull operations or initialize a new one.
@@ -261,7 +299,7 @@ module Mongoid
       #
       # @return [ Hash ] The $pull operations.
       def pulls
-        self["$pull"] ||= {}
+        self['$pull'] ||= {}
       end
 
       # Get the $push/$each operations or initialize a new one.
@@ -271,7 +309,7 @@ module Mongoid
       #
       # @return [ Hash ] The $push/$each operations.
       def pushes
-        self["$push"] ||= {}
+        self['$push'] ||= {}
       end
 
       # Get the $set operations or initialize a new one.
@@ -280,8 +318,10 @@ module Mongoid
       #   modifiers.sets
       #
       # @return [ Hash ] The $set operations.
-      def sets
-        self["$set"] ||= {}
+      def sets(initialize: true)
+        return self['$set'] unless initialize
+
+        self['$set'] ||= {}
       end
 
       # Get the $unset operations or initialize a new one.
@@ -291,7 +331,7 @@ module Mongoid
       #
       # @return [ Hash ] The $unset operations.
       def unsets
-        self["$unset"] ||= {}
+        self['$unset'] ||= {}
       end
     end
   end

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

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Atomic
     module Paths
       module Embedded
-
         # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-n.
         class Many
@@ -19,7 +17,7 @@ module Mongoid
           # @param [ Document ] document The document to generate the paths for.
           def initialize(document)
             @document, @parent = document, document._parent
-            @insert_modifier, @delete_modifier ="$push", "$pull"
+            @insert_modifier, @delete_modifier = '$push', '$pull'
           end
 
           # Get the position of the document in the hierarchy. This will
@@ -32,12 +30,11 @@ module Mongoid
           # @return [ String ] The position of the document.
           def position
             pos = parent.atomic_position
-            locator = document.new_record? ? "" : ".#{document._index}"
-            "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
+            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
@@ -51,7 +48,7 @@ module Mongoid
             # @return [ String ] The position string.
             def position_without_document(parent, association)
               pos = parent.atomic_position
-              "#{pos}#{"." unless pos.blank?}#{association.store_as}"
+              "#{pos}#{'.' unless pos.blank?}#{association.store_as}"
             end
           end
         end