mongoid 6.4.4 → 7.1.7

data/lib/mongoid/association.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'mongoid/association/accessors'
+require 'mongoid/association/builders'
+require 'mongoid/association/bindable'
+require 'mongoid/association/depending'
+require 'mongoid/association/proxy'
+
+require 'mongoid/association/many'
+require 'mongoid/association/one'
+require 'mongoid/association/relatable'
+require 'mongoid/association/nested'
+require 'mongoid/association/referenced'
+require 'mongoid/association/embedded'
+require 'mongoid/association/macros'
+
+require 'mongoid/association/reflections'
+require 'mongoid/association/eager_loadable'
+
+module Mongoid
+  module Association
+    extend ActiveSupport::Concern
+    include Embedded::Cyclic
+    include Referenced::AutoSave
+    include Referenced::CounterCache
+    include Referenced::Syncable
+    include Accessors
+    include Depending
+    include Builders
+    include Macros
+    include Reflections
+
+    # 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,
+        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
+
+    attr_accessor :_association
+
+    included do
+      class_attribute :polymorphic
+      self.polymorphic = false
+    end
+
+    # Determine if the document itself is embedded in another document via the
+    # proper channels. (If it has a parent document.)
+    #
+    # @example Is the document embedded?
+    #   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 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 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
+
+    # Get the association name for this document. If no association was defined
+    #   an error will be raised.
+    #
+    # @example Get the association name.
+    #   document.association_name
+    #
+    # @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 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 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 associations and
+    # reloading them.
+    #
+    # @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}")
+          if _parent.nil? || instance_variable_get("@_#{name}") != _parent
+            remove_instance_variable("@_#{name}")
+          end
+        end
+      end
+    end
+  end
+end

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.

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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
@@ -23,7 +25,7 @@ module Mongoid
           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.
@@ -35,7 +37,7 @@ module Mongoid
           def position
             pos = parent.atomic_position
             locator = document.new_record? ? "" : ".#{document._index}"
-            "#{pos}#{"." unless pos.blank?}#{document.__metadata.store_as}#{locator}"
+            "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
           end
         end
       end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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
@@ -23,7 +25,7 @@ module Mongoid
           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.
@@ -34,7 +36,7 @@ module Mongoid
           # @since 2.1.0
           def position
             pos = parent.atomic_position
-            "#{pos}#{"." unless pos.blank?}#{document.__metadata.store_as}"
+            "#{pos}#{"." unless pos.blank?}#{document._association.store_as}"
           end
         end
       end

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/atomic/paths/embedded/one"
 require "mongoid/atomic/paths/embedded/many"
 
@@ -20,7 +22,7 @@ module Mongoid
         #
         # @since 2.1.0
         def path
-          @path ||= position.sub(/\.\d+$/, "")
+          @path ||= position.sub(/\.\d+\z/, "")
         end
       end
     end

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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
 
@@ -22,7 +24,7 @@ module Mongoid
         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

data/lib/mongoid/atomic/paths.rb

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

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,7 +38,9 @@ module Mongoid
     # @since 2.2.0
     def add_atomic_pull(document)
       document.flagged_for_destroy = true
-      (delayed_atomic_pulls[document.metadata_name.to_s] ||= []).push(document)
+      key = document.association_name.to_s
+      delayed_atomic_pulls[key] ||= []
+      delayed_atomic_pulls[key] << document
     end
 
     # Add an atomic unset for the document.
@@ -51,7 +55,9 @@ module Mongoid
     # @since 3.0.0
     def add_atomic_unset(document)
       document.flagged_for_destroy = true
-      (delayed_atomic_unsets[document.metadata_name.to_s] ||= []).push(document)
+      key = document.association_name.to_s
+      delayed_atomic_unsets[key] ||= []
+      delayed_atomic_unsets[key] << document
     end
 
     # Returns path of the attribute for modification
@@ -189,7 +195,13 @@ module Mongoid
     #
     # @since 2.1.0
     def atomic_paths
-      @atomic_paths ||= __metadata ? __metadata.path(self) : Atomic::Paths::Root.new(self)
+      @atomic_paths ||= begin
+        if _association
+          _association.path(self)
+        else
+          Atomic::Paths::Root.new(self)
+        end
+      end
     end
 
     # Get all the attributes that need to be pulled.
@@ -218,7 +230,7 @@ module Mongoid
     # @example Get the pushes.
     #   person.atomic_pushes
     #
-    # @return [ Hash ] The The $push and $each operations.
+    # @return [ Hash ] The $push and $each operations.
     #
     # @since 2.1.0
     def atomic_pushes

data/lib/mongoid/attributes/dynamic.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Attributes
 
@@ -38,12 +40,13 @@ module Mongoid
       # @since 4.0.0
       def define_dynamic_reader(name)
         return unless name.valid_method_name?
-        class_eval <<-READER, __FILE__, __LINE__ + 1
-          def #{name}
-            attribute_will_change!(#{name.inspect})
-            read_attribute(#{name.inspect})
+
+        class_eval do
+          define_method(name) do
+            attribute_will_change!(name)
+            read_raw_attribute(name)
           end
-        READER
+        end
       end
 
       # Define a reader method for a dynamic attribute before type cast.
@@ -57,12 +60,12 @@ module Mongoid
       #
       # @since 4.0.0
       def define_dynamic_before_type_cast_reader(name)
-        class_eval <<-READER, __FILE__, __LINE__ + 1
-          def #{name}_before_type_cast
-            attribute_will_change!(#{name.inspect})
-            read_attribute_before_type_cast(#{name.inspect})
+        class_eval do
+          define_method("#{name}_before_type_cast") do
+            attribute_will_change!(name)
+            read_attribute_before_type_cast(name)
           end
-        READER
+        end
       end
 
       # Define a writer method for a dynamic attribute.
@@ -78,11 +81,11 @@ module Mongoid
       def define_dynamic_writer(name)
         return unless name.valid_method_name?
 
-        class_eval <<-WRITER, __FILE__, __LINE__ + 1
-          def #{name}=(value)
-            write_attribute(#{name.inspect}, value)
+        class_eval do
+          define_method("#{name}=") do |value|
+            write_attribute(name, value)
           end
-        WRITER
+        end
       end
 
       # If the attribute is dynamic, add a field for it with a type of object
@@ -147,7 +150,7 @@ module Mongoid
           getter = attr.reader
           define_dynamic_reader(getter)
           attribute_will_change!(attr.reader)
-          read_attribute(getter)
+          read_raw_attribute(getter)
         end
       end
     end

data/lib/mongoid/attributes/nested.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Attributes
 
-    # Defines behaviour around that lovel Rails feature nested attributes.
+    # Defines behavior around that lovel Rails feature nested attributes.
     #
     # @since 1.0.0
     module Nested
@@ -19,8 +21,8 @@ module Mongoid
           attributes.all? { |key, value| key == '_destroy' || value.blank? }
         }
 
-        # Used when needing to update related models from a parent relation. Can
-        # be used on embedded or referenced relations.
+        # Used when needing to update related models from a parent association. Can
+        # be used on embedded or referenced associations.
         #
         # @example Defining nested attributes.
         #
@@ -34,7 +36,7 @@ module Mongoid
         #     accepts_nested_attributes_for :addresses, :game, :posts
         #   end
         #
-        # @param [ Array<Symbol>, Hash ] args A list of relation names, followed
+        # @param [ Array<Symbol>, Hash ] args A list of association names, followed
         #   by a hash of options.
         #
         # @option *args [ true, false ] :allow_destroy Can deletion occur?
@@ -42,21 +44,27 @@ module Mongoid
         #   to a class method to reject documents with.
         # @option *args [ Integer ] :limit The max number to create.
         # @option *args [ true, false ] :update_only Only update existing docs.
+        # @options *args [ true, false ] :autosave Whether autosave should be enabled on the
+        #   association. Note that since the default is true, setting autosave to nil will still
+        #   enable it.
         def accepts_nested_attributes_for(*args)
-          options = args.extract_options!
+          options = args.extract_options!.dup
+          options[:autosave] = true if options[:autosave].nil?
+
           options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
           args.each do |name|
             meth = "#{name}_attributes="
             self.nested_attributes["#{name}_attributes"] = meth
-            metadata = relations[name.to_s]
-            raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless metadata
-            autosave_nested_attributes(metadata)
+            association = relations[name.to_s]
+            raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless association
+            autosave_nested_attributes(association) if options[:autosave]
+
             re_define_method(meth) do |attrs|
               _assigning do
-                if metadata.polymorphic? and metadata.inverse_type
-                  options = options.merge!(:class_name => self.send(metadata.inverse_type))
+                if association.polymorphic? and association.inverse_type
+                  options = options.merge!(:class_name => self.send(association.inverse_type))
                 end
-                metadata.nested_builder(attrs, options).build(self)
+                association.nested_builder(attrs, options).build(self)
               end
             end
           end
@@ -64,19 +72,24 @@ module Mongoid
 
         private
 
-        # Add the autosave information for the nested relation.
+        # Add the autosave information for the nested association.
         #
         # @api private
         #
         # @example Add the autosave if appropriate.
         #   Person.autosave_nested_attributes(metadata)
         #
-        # @param [ Metadata ] metadata The existing relation metadata.
+        # @param [ Association ] association The existing association metadata.
         #
         # @since 3.1.4
-        def autosave_nested_attributes(metadata)
-          unless metadata.autosave == false
-            autosave(metadata.merge!(autosave: true))
+        def autosave_nested_attributes(association)
+          # In order for the autosave functionality to work properly, the association needs to be
+          # marked as autosave despite the fact that the option isn't present. Because the method
+          # Association#autosave? is implemented by checking the autosave option, this is the most
+          # straightforward way to mark it.
+          if association.autosave? || (association.options[:autosave].nil? && !association.embedded?)
+            association.options[:autosave] = true
+            Association::Referenced::AutoSave.define_autosave!(association)
           end
         end
       end