mongoid 7.1.1 → 8.1.0

data/lib/mongoid/association/referenced/has_one/nested_builder.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -22,8 +21,6 @@ module Mongoid
           # @param [ Document ] parent The parent document.
           #
           # @return [ Document ] The built document.
-          #
-          # @since 2.0.0
           def build(parent)
             return if reject?(parent, attributes)
             @existing = parent.send(association.name)
@@ -46,8 +43,6 @@ module Mongoid
           # @param [ Association ] association The association metadata.
           # @param [ Hash ] attributes The attributes hash to attempt to set.
           # @param [ Hash ] options The options defined.
-          #
-          # @since 2.0.0
           def initialize(association, attributes, options)
             @attributes = attributes.with_indifferent_access
             @association = association
@@ -65,11 +60,9 @@ module Mongoid
           # @example Is the id acceptable?
           #   one.acceptable_id?
           #
-          # @return [ true, false ] If the id part of the logic will allow an update.
-          #
-          # @since 2.0.0
+          # @return [ true | false ] If the id part of the logic will allow an update.
           def acceptable_id?
-            id = convert_id(existing.class, attributes[:id])
+            id = convert_id(existing.class, attributes[:_id])
             existing._id == id || id.nil? || (existing._id != id && update_only?)
           end
 
@@ -78,11 +71,9 @@ module Mongoid
           # @example Can the existing object be deleted?
           #   one.delete?
           #
-          # @return [ true, false ] If the association should be deleted.
-          #
-          # @since 2.0.0
+          # @return [ true | false ] If the association should be deleted.
           def delete?
-            destroyable? && !attributes[:id].nil?
+            destroyable? && !attributes[:_id].nil?
           end
 
           # Can the existing association potentially be destroyed?
@@ -90,10 +81,8 @@ module Mongoid
           # @example Is the object destroyable?
           #   one.destroyable?({ :_destroy => "1" })
           #
-          # @return [ true, false ] If the association can potentially be
+          # @return [ true | false ] If the association can potentially be
           #   destroyed.
-          #
-          # @since 2.0.0
           def destroyable?
             [ 1, "1", true, "true" ].include?(destroy) && allow_destroy?
           end
@@ -103,9 +92,7 @@ module Mongoid
           # @example Is the document to be replaced?
           #   one.replace?
           #
-          # @return [ true, false ] If the document should be replaced.
-          #
-          # @since 2.0.0
+          # @return [ true | false ] If the document should be replaced.
           def replace?
             !existing && !destroyable? && !attributes.blank?
           end
@@ -115,9 +102,7 @@ module Mongoid
           # @example Should the document be updated?
           #   one.update?
           #
-          # @return [ true, false ] If the object should have its attributes updated.
-          #
-          # @since 2.0.0
+          # @return [ true | false ] If the object should have its attributes updated.
           def update?
             existing && !destroyable? && acceptable_id?
           end

data/lib/mongoid/association/referenced/has_one/proxy.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -34,8 +33,6 @@ module Mongoid
           #
           # @example Nullify the association.
           #   person.game.nullify
-          #
-          # @since 2.0.0.rc.1
           def nullify
             unbind_one
             _target.save
@@ -51,15 +48,15 @@ module Mongoid
           # @param [ Array<Document> ] replacement The replacement target.
           #
           # @return [ One ] The association.
-          #
-          # @since 2.0.0.rc.1
           def substitute(replacement)
-            unbind_one
-            if persistable?
-              if _association.destructive?
-                send(_association.dependent)
-              else
-                save if persisted?
+            if self != replacement
+              unbind_one
+              if persistable?
+                if _association.destructive?
+                  send(_association.dependent)
+                else
+                  save if persisted?
+                end
               end
             end
             HasOne::Proxy.new(_base, replacement, _association) if replacement
@@ -82,9 +79,7 @@ module Mongoid
           # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the association is persistable.
-          #
-          # @since 2.1.0
+          # @return [ true | false ] If the association is persistable.
           def persistable?
             _base.persisted? && !_binding? && !_building?
           end
@@ -102,8 +97,6 @@ module Mongoid
             #   Referenced::One.embedded?
             #
             # @return [ false ] Always false.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               false
             end

data/lib/mongoid/association/referenced/has_one.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/referenced/has_one/binding'
 require 'mongoid/association/referenced/has_one/buildable'
@@ -11,8 +10,6 @@ module Mongoid
     module Referenced
 
       # The has_one association.
-      #
-      # @since 7.0
       class HasOne
         include Relatable
         include Buildable
@@ -21,37 +18,30 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :as,
             :autobuild,
             :autosave,
             :dependent,
             :foreign_key,
-            :primary_key
+            :primary_key,
+            :scope,
         ].freeze
 
         # The complete list of valid options for this association, including
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # The default foreign key suffix.
         #
         # @return [ String ] '_id'
-        #
-        # @since 7.0
         FOREIGN_KEY_SUFFIX = '_id'.freeze
 
         # The list of association complements.
         #
         # @return [ Array<Association> ] The association complements.
-        #
-        # @since 7.0
         def relation_complements
           @relation_complements ||= [ Referenced::BelongsTo ].freeze
         end
@@ -59,8 +49,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           self
@@ -70,8 +58,6 @@ module Mongoid
         #
         # @return [ String ] The foreign key field for saving the
         #   association reference.
-        #
-        # @since 7.0
         def foreign_key
           @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                              default_foreign_key_field
@@ -80,22 +66,16 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def embedded?; false; end
 
         # The default for validation the association object.
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def validation_default; true; end
 
         # Get the association proxy class for this association type.
         #
         # @return [ Association::HasOne::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -106,17 +86,13 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::Many ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::One.new(self, attributes, options)
         end
 
         # Is this association polymorphic?
         #
-        # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
+        # @return [ true | false ] Whether this association is polymorphic.
         def polymorphic?
           @polymorphic ||= !!as
         end
@@ -125,9 +101,7 @@ module Mongoid
         #
         # @note Only relevant for polymorphic associations.
         #
-        # @return [ String, nil ] The type field.
-        #
-        # @since 7.0
+        # @return [ String | nil ] The type field.
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -137,7 +111,7 @@ module Mongoid
         #
         # @param [ Document ] doc The document to be bound.
         #
-        # @return [ true, false ] Whether the document can be bound.
+        # @return [ true | false ] Whether the document can be bound.
         def bindable?(doc)
           forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key))
         end
@@ -152,19 +126,22 @@ module Mongoid
         # @param [ Document ] document The document to calculate on.
         #
         # @return [ Root ] The root atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Root.new(document)
         end
 
+        # Get the scope to be applied when querying the association.
+        #
+        # @return [ Proc | Symbol | nil ] The association scope, if any.
+        def scope
+          @options[:scope]
+        end
+
         private
 
         # Setup the instance methods on the class having this association type.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup_instance_methods!
           define_getter!
           define_setter!

data/lib/mongoid/association/referenced/syncable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -17,9 +16,7 @@ module Mongoid
         #
         # @param [ Association ] association The association metadata.
         #
-        # @return [ true, false ] If we can sync.
-        #
-        # @since 2.1.0
+        # @return [ true | false ] If we can sync.
         def _syncable?(association)
           !_synced?(association.foreign_key) && send(association.foreign_key_check)
         end
@@ -30,8 +27,6 @@ module Mongoid
         #   document._synced
         #
         # @return [ Hash ] The synced foreign keys.
-        #
-        # @since 2.1.0
         def _synced
           @_synced ||= {}
         end
@@ -43,9 +38,7 @@ module Mongoid
         #
         # @param [ String ] foreign_key The foreign key.
         #
-        # @return [ true, false ] If we can sync.
-        #
-        # @since 2.1.0
+        # @return [ true | false ] If we can sync.
         def _synced?(foreign_key)
           !!_synced[foreign_key]
         end
@@ -58,8 +51,6 @@ module Mongoid
         # @param [ Association ] association The association.
         #
         # @return [ Object ] The updated values.
-        #
-        # @since 2.2.1
         def remove_inverse_keys(association)
           foreign_keys = send(association.foreign_key)
           unless foreign_keys.nil? || foreign_keys.empty?
@@ -75,11 +66,9 @@ module Mongoid
         # @param [ Association ] association The document association.
         #
         # @return [ Object ] The updated values.
-        #
-        # @since 2.1.0
         def update_inverse_keys(association)
-          if changes.has_key?(association.foreign_key)
-            old, new = changes[association.foreign_key]
+          if previous_changes.has_key?(association.foreign_key)
+            old, new = previous_changes[association.foreign_key]
             adds, subs = new - (old || []), (old || []) - new
 
             # If we are autosaving we don't want a duplicate to get added - the
@@ -110,8 +99,6 @@ module Mongoid
           #   Person._synced(association)
           #
           # @param [ Association ] association The association metadata.
-          #
-          # @since 2.1.0
           def _synced(association)
             unless association.forced_nil_inverse?
               synced_save(association)
@@ -133,8 +120,6 @@ module Mongoid
           # @param [ Association ] association The association metadata.
           #
           # @return [ Class ] The class getting set up.
-          #
-          # @since 2.1.0
           def synced_save(association)
             set_callback(
                 :save,
@@ -154,8 +139,6 @@ module Mongoid
           # @param [ Association ] association The association metadata.
           #
           # @return [ Class ] The class getting set up.
-          #
-          # @since 2.2.1
           def synced_destroy(association)
             set_callback(
                 :destroy,

data/lib/mongoid/association/referenced.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/referenced/auto_save'
 require 'mongoid/association/referenced/counter_cache'

data/lib/mongoid/association/reflections.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -14,7 +13,7 @@ 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.
       def reflect_on_association(name)
@@ -26,7 +25,7 @@ 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.
       def reflect_on_all_association(*macros)
@@ -40,7 +39,7 @@ 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.
         def reflect_on_association(name)
@@ -52,7 +51,7 @@ 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.
         def reflect_on_all_associations(*macros)