mongoid 7.2.1 → 9.0.0

data/lib/mongoid/association/reflections.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Association
@@ -14,9 +14,9 @@ module Mongoid
       # @example Find association metadata by name.
       #   person.reflect_on_association(:addresses)
       #
-      # @param [ String, Symbol ] name The name of the association to find.
+      # @param [ String | Symbol ] name The name of the association to find.
       #
-      # @return [ Association ] The matching association metadata.
+      # @return [ Mongoid::Association::Relatable ] The matching association metadata.
       def reflect_on_association(name)
         self.class.reflect_on_association(name)
       end
@@ -26,9 +26,9 @@ module Mongoid
       # @example Find multiple association metadata by macro.
       #   person.reflect_on_all_associations(:embeds_many)
       #
-      # @param [ Array<Symbol> ] macros The association macros.
+      # @param [ Symbol... ] *macros The association macros.
       #
-      # @return [ Array<Association> ] The matching association metadata.
+      # @return [ Array<Mongoid::Association::Relatable> ] The matching association metadata.
       def reflect_on_all_association(*macros)
         self.class.reflect_on_all_associations(*macros)
       end
@@ -40,9 +40,9 @@ module Mongoid
         # @example Find association metadata by name.
         #   Person.reflect_on_association(:addresses)
         #
-        # @param [ String, Symbol ] name The name of the association to find.
+        # @param [ String | Symbol ] name The name of the association to find.
         #
-        # @return [ Association ] The matching association metadata.
+        # @return [ Mongoid::Association::Relatable ] The matching association metadata.
         def reflect_on_association(name)
           relations[name.to_s]
         end
@@ -52,9 +52,9 @@ module Mongoid
         # @example Find multiple association metadata by macro.
         #   Person.reflect_on_all_associations(:embeds_many)
         #
-        # @param [ Array<Symbol> ] macros The association macros.
+        # @param [ Symbol... ] *macros The association macros.
         #
-        # @return [ Array<Association> ] The matching association metadata.
+        # @return [ Array<Mongoid::Association::Relatable> ] The matching association metadata.
         def reflect_on_all_associations(*macros)
           all_associations = relations.values
           unless macros.empty?

data/lib/mongoid/association/relatable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
@@ -8,8 +8,6 @@ module Mongoid
   module Association
 
     # This module provides behaviors shared between Association types.
-    #
-    # @since 7.0
     module Relatable
       include Constrainable
       include Options
@@ -17,8 +15,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,
@@ -29,22 +25,16 @@ 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 association.
-      #
-      # @since 7.0
       attr_reader :name
 
       # The options on this association.
       #
       # @return [ Hash ] The options.
-      #
-      # @since 7.0
       attr_reader :options
 
       # Initialize the Association.
@@ -53,8 +43,6 @@ module Mongoid
       # @param [ Symbol ] name The name of the association.
       # @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
@@ -71,8 +59,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 &&
@@ -84,10 +70,8 @@ module Mongoid
       #
       # @param [ Symbol ] callback_type The type of callback type.
       #
-      # @return [ Array<Proc, Symbol> ] A list of the callbacks, either method
+      # @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
@@ -96,10 +80,8 @@ module Mongoid
       # @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__
+        @type_setter ||= "#{type}=" if type
       end
 
       # Whether trying to bind an object using this association should raise
@@ -107,9 +89,7 @@ module Mongoid
       #
       # @param [ Document ] doc The document to be bound.
       #
-      # @return [ true, false ] Whether the document can be bound.
-      #
-      # @since 7.0
+      # @return [ true | false ] Whether the document can be bound.
       def bindable?(doc); false; end
 
       # Get the inverse names.
@@ -118,10 +98,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
@@ -134,9 +114,7 @@ module Mongoid
       # @param [ Object ] other The other model class or model object to use when
       #   determining inverses.
       #
-      # @return [ Association ] The inverse's association metadata.
-      #
-      # @since 7.0
+      # @return [ Mongoid::Association::Relatable ] The inverse's association metadata.
       def inverse_association(other = nil)
         (other || relation_class).relations[inverse(other)]
       end
@@ -144,8 +122,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
@@ -169,8 +145,6 @@ 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
@@ -190,8 +164,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)
@@ -203,8 +175,6 @@ module Mongoid
       # 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
@@ -212,8 +182,6 @@ module Mongoid
       # The class of the object owning this association.
       #
       # @return [ String ] The owning objects' class.
-      #
-      # @since 7.0
       def inverse_class
         @owner_class
       end
@@ -222,9 +190,7 @@ module Mongoid
       # The foreign key field if this association stores a foreign key.
       # Otherwise, the primary key.
       #
-      # @return [ Symbol, String ] The primary key.
-      #
-      # @since 7.0
+      # @return [ Symbol | String ] The primary key.
       def key
         stores_foreign_key? ? foreign_key : primary_key
       end
@@ -232,8 +198,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
@@ -241,8 +205,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
@@ -250,8 +212,6 @@ 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
@@ -261,8 +221,6 @@ module Mongoid
       # 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
@@ -274,10 +232,8 @@ module Mongoid
       #   association.inverse_type_setter
       #
       # @return [ String ] The name of the setter.
-      #
-      # @since 7.0
       def inverse_type_setter
-        @inverse_type_setter ||= inverse_type.__setter__
+        @inverse_type_setter ||= "#{inverse_type}=" if inverse_type
       end
 
       # Get the name of the method to check if the foreign key has changed.
@@ -286,30 +242,24 @@ 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)
+        @foreign_key_check ||= "#{foreign_key}_previously_changed?" if (stores_foreign_key? && foreign_key)
       end
 
       # Create an association proxy object using the owner and target.
       #
       # @param [ Document ] owner The document this association hangs off of.
-      # @param [ Document, Array<Document> ] target The target (parent) of the
+      # @param [ Document | Array<Document> ] target The target (parent) of the
       #   association.
       #
       # @return [ Proxy ]
-      #
-      # @since 7.0
       def create_relation(owner, target)
         relation.new(owner, target, self)
       end
 
       # Whether the dependent method is destructive.
       #
-      # @return [ true, false ] If the dependent method is destructive.
-      #
-      # @since 7.0
+      # @return [ true | false ] If the dependent method is destructive.
       def destructive?
         @destructive ||= !!(dependent && (dependent == :delete_all || dependent == :destroy))
       end
@@ -317,8 +267,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)) ?
@@ -328,8 +276,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
@@ -337,8 +283,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
@@ -346,10 +290,8 @@ module Mongoid
 
       # Whether the associated object(s) should be validated.
       #
-      # @return [ true, false ] If the associated object(s)
+      # @return [ true | false ] If the associated object(s)
       #   should be validated.
-      #
-      # @since 7.0
       def validate?
         @validate ||= if @options[:validate].nil?
                         validation_default
@@ -358,6 +300,40 @@ module Mongoid
                       end
       end
 
+      # The associations above this one in the inclusion tree.
+      #
+      # @return [ Array<String> ] The associations.
+      attr_accessor :parent_inclusions
+
+      # The associations above this one in the inclusion tree.
+      #
+      # @return [ Array<String> ] The associations.
+      def parent_inclusions
+        @parent_inclusions ||= []
+      end
+
+      # Is this association an embeds_many or has_many association?
+      #
+      # @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) }
+      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) }
+      end
+
+      # Is this association an embedded_in or belongs_to association?
+      #
+      # @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) }
+      end
+
       private
 
       # Gets the model classes with inverse associations of this model. This is used to determine
@@ -463,10 +439,15 @@ module Mongoid
       def namespace_hierarchy(mod)
         parent = Object
         hier = [parent]
-        mod.name.split('::').each do |part|
-          parent = parent.const_get(part)
-          hier << parent
+
+        # name is not present on anonymous modules
+        if mod.name
+          mod.name.split('::').each do |part|
+            parent = parent.const_get(part)
+            hier << parent
+          end
         end
+
         hier.reverse
       end
 

data/lib/mongoid/association.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require 'mongoid/association/accessors'
 require 'mongoid/association/builders'
@@ -19,6 +19,10 @@ 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.
   module Association
     extend ActiveSupport::Concern
     include Embedded::Cyclic
@@ -34,8 +38,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,
@@ -59,9 +61,7 @@ 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
@@ -71,9 +71,7 @@ module Mongoid
     # @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
@@ -83,9 +81,7 @@ module Mongoid
     # @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
@@ -99,8 +95,6 @@ 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
@@ -111,9 +105,7 @@ module Mongoid
     # @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
@@ -123,9 +115,7 @@ module Mongoid
     # @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
@@ -137,8 +127,6 @@ module Mongoid
     #   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}")