mongoid 7.0.10 → 7.4.0

data/lib/mongoid/association/embedded/embeds_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/embedded/embeds_many/binding'
 require 'mongoid/association/embedded/embeds_many/buildable'
 require 'mongoid/association/embedded/embeds_many/proxy'
@@ -7,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbedsMany type association.
-      #
-      # @since 7.0
       class EmbedsMany
         include Relatable
         include Buildable
@@ -17,8 +17,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :as,
             :cascade_callbacks,
@@ -35,15 +33,11 @@ module Mongoid
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           @owner_class.embedded_relations = @owner_class.embedded_relations.merge(name => self)
@@ -54,17 +48,13 @@ module Mongoid
         # The field key used to store the list of association objects.
         #
         # @return [ String ] The field name.
-        #
-        # @since 7.0
         def store_as
           @store_as ||= (@options[:store_as].try(:to_s) || name.to_s)
         end
 
         # The key that is used to get the attributes for the associated object.
         #
-        # @return [ String ] The name of the field used to store the relation.
-        #
-        # @since 7.0
+        # @return [ String ] The name of the field used to store the association.
         def key
           store_as.to_s
         end
@@ -72,38 +62,30 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def embedded?; true; end
 
-        # Get the default validation setting for the relation. Determines if
+        # Get the default validation setting for the association. Determines if
         # by default a validates associated will occur.
         #
         # @example Get the validation default.
         #   Proxy.validation_default
         #
         # @return [ true ] Always true.
-        #
-        # @since 2.1.9
         def validation_default; true; end
 
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def stores_foreign_key?; false; end
 
         # The primary key
         #
-        # @return [ nil ] Not relevant for this relation
+        # @return [ nil ] Not relevant for this association
         def primary_key; end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -111,8 +93,6 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           @polymorphic ||= !!@options[:as]
         end
@@ -122,8 +102,6 @@ module Mongoid
         # @note Only relevant if the association is polymorphic.
         #
         # @return [ String, nil ] The field for storing the associated object's type.
-        #
-        # @since 7.0
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -134,8 +112,6 @@ 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::Many.new(self, attributes, options)
         end
@@ -149,8 +125,6 @@ module Mongoid
         #
         # @return [ Mongoid::Atomic::Paths::Embedded::Many ]
         #   The embedded many atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Embedded::Many.new(document)
         end
@@ -159,8 +133,6 @@ module Mongoid
         #
         # @param [ Document ] base The base document.
         # @param [ Document ] target The children documents.
-        #
-        # @since 7.0
         def criteria(base, target)
           criterion = klass.scoped
           criterion.embedded = true

data/lib/mongoid/association/embedded/embeds_one/binding.rb

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
       class EmbedsOne
 
-        # Binding class for all embeds_one relations.
-        #
-        # @since 7.0
+        # Binding class for all embeds_one associations.
         class Binding
           include Bindable
 
-          # Binds the base object to the inverse of the relation. This is so we
+          # Binds the base object to the inverse of the association. This is so we
           # are referenced to the actual objects themselves on both sides.
           #
           # This case sets the association metadata on the inverse object as well as the
@@ -18,8 +18,6 @@ module Mongoid
           # @example Bind the document.
           #   person.name.bind(:continue => true)
           #   person.name = Name.new
-          #
-          # @since 2.0.0.rc.1
           def bind_one
             _target.parentize(_base)
             binding do
@@ -33,8 +31,6 @@ module Mongoid
           # @example Unbind the document.
           #   person.name.unbind(:continue => true)
           #   person.name = nil
-          #
-          # @since 2.0.0.rc.1
           def unbind_one
             binding do
               _target.do_or_do_not(_association.inverse_setter(_target), nil)

data/lib/mongoid/association/embedded/embeds_one/buildable.rb

@@ -1,30 +1,33 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
       class EmbedsOne
 
         # Builder class for embeds_one associations.
-        #
-        # @since 7.0
         module Buildable
           include Threaded::Lifecycle
 
           # Builds the document out of the attributes using the provided
-          # association metadata on the relation. Instantiates through the factory in order
+          # association metadata on the association. Instantiates through the factory in order
           # to make sure subclasses and allocation are used if fitting.
           #
           # @example Build the document.
           #   Builder.new(meta, attrs).build
           #
-          # @param [ Document ] base The document this relation hangs off of.
+          # @param [ Document ] base The document this association hangs off of.
           # @param [ Document ] object The related document.
           # @param [ String ] _type Not used in this context.
+          # @param [ Hash ] selected_fields Fields which were retrieved via
+          #   #only. If selected_fields are specified, fields not listed in it
+          #   will not be accessible in the built document.
           #
           # @return [ Document ] A single document.
-          def build(base, object, _type = nil)
+          def build(base, object, _type = nil, selected_fields = nil)
             return object unless object.is_a?(Hash)
             if _loading? && base.persisted?
-              Factory.from_db(klass, object)
+              Factory.from_db(klass, object, nil, selected_fields)
             else
               Factory.build(klass, object)
             end

data/lib/mongoid/association/embedded/embeds_one/proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
@@ -5,11 +7,9 @@ module Mongoid
 
         class Proxy < Association::One
 
-          # The valid options when defining this relation.
-          #
-          # @return [ Array<Symbol> ] The allowed options when defining this relation.
+          # The valid options when defining this association.
           #
-          # @since 7.0
+          # @return [ Array<Symbol> ] The allowed options when defining this association.
           VALID_OPTIONS = [
               :autobuild,
               :as,
@@ -18,35 +18,33 @@ module Mongoid
               :store_as
           ].freeze
 
-          # Instantiate a new embeds_one relation.
+          # Instantiate a new embeds_one association.
           #
           # @example Create the new proxy.
           #   One.new(person, name, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Document ] target The child document in the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Document ] target The child document in the association.
           # @param [ Association ] association The association metadata.
           def initialize(base, target, association)
             init(base, target, association) do
               characterize_one(_target)
               bind_one
               characterize_one(_target)
-              _base._reset_memoized_children!
+              _base._reset_memoized_descendants!
               _target.save if persistable?
             end
           end
 
           # Substitutes the supplied target documents for the existing document
-          # in the relation.
+          # in the association.
           #
           # @example Substitute the new document.
           #   person.name.substitute(new_name)
           #
           # @param [ Document ] replacement A document to replace the target.
           #
-          # @return [ Document, nil ] The relation or nil.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Document, nil ] The association or nil.
           def substitute(replacement)
             if replacement != self
               if _assigning?
@@ -55,6 +53,31 @@ module Mongoid
                 # The associated object will be replaced by the below update if non-nil, so only
                 # run the callbacks and state-changing code by passing persist: false in that case.
                 _target.destroy(persist: !replacement) if persistable?
+
+                unless Mongoid.broken_updates
+                  # A little explanation on why this is needed... Say we have three assignments:
+                  #
+                  # canvas.palette = palette
+                  # canvas.palette = nil
+                  # canvas.palette = palette
+                  # Where canvas embeds_one palette.
+                  #
+                  # Previously, what was happening was, on the first assignment,
+                  # palette was considered a "new record" (new_record?=true) and
+                  # thus palette was being inserted into the database. However,
+                  # on the third assignment, we're trying to reassign the palette,
+                  # palette is no longer considered a new record, because it had
+                  # been inserted previously. This is not exactly accurate,
+                  # because the second assignment ultimately removed the palette
+                  # from the database, so it needs to be reinserted. Since the
+                  # palette's new_record is false, Mongoid ends up "updating" the
+                  # document, which doesn't reinsert it into the database.
+                  #
+                  # The change I introduce here, respecifies palette as a "new
+                  # record" when it gets removed from the database, so if it is
+                  # reassigned, it will be reinserted into the database.
+                  _target.new_record = true
+                end
               end
               unbind_one
               return nil unless replacement
@@ -69,41 +92,35 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
           #
-          # @return [ Binding ] The relation's binding.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Binding ] The association's binding.
           def binding
             Binding.new(_base, _target, _association)
           end
 
-          # Are we able to persist this relation?
+          # Are we able to persist this association?
           #
-          # @example Can we persist the relation?
+          # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the relation is persistable.
-          #
-          # @since 2.1.0
+          # @return [ true, false ] If the association is persistable.
           def persistable?
             _base.persisted? && !_binding? && !_building? && !_assigning?
           end
 
           class << self
 
-            # Returns true if the relation is an embedded one. In this case
+            # Returns true if the association is an embedded one. In this case
             # always true.
             #
-            # @example Is this relation embedded?
+            # @example Is this association embedded?
             #   Association::Embedded::EmbedsOne.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -117,8 +134,6 @@ module Mongoid
             #
             # @return [ Mongoid::Atomic::Paths::Embedded::One ]
             #   The embedded one atomic path calculator.
-            #
-            # @since 2.1.0
             def path(document)
               Mongoid::Atomic::Paths::Embedded::One.new(document)
             end

data/lib/mongoid/association/embedded/embeds_one.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/embedded/embeds_one/binding'
 require 'mongoid/association/embedded/embeds_one/buildable'
 require 'mongoid/association/embedded/embeds_one/proxy'
@@ -7,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbedsOne type association.
-      #
-      # @since 7.0
       class EmbedsOne
         include Relatable
         include Buildable
@@ -17,8 +17,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :autobuild,
             :as,
@@ -31,15 +29,11 @@ module Mongoid
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           @owner_class.embedded_relations = @owner_class.embedded_relations.merge(name => self)
@@ -50,17 +44,13 @@ module Mongoid
         # The field key used to store the association object.
         #
         # @return [ String ] The field name.
-        #
-        # @since 7.0
         def store_as
           @store_as ||= (@options[:store_as].try(:to_s) || name.to_s)
         end
 
         # The key that is used to get the attributes for the associated object.
         #
-        # @return [ String ] The name of the field used to store the relation.
-        #
-        # @since 7.0
+        # @return [ String ] The name of the field used to store the association.
         def key
           store_as.to_s
         end
@@ -68,38 +58,30 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def embedded?; true; end
 
-        # Get the default validation setting for the relation. Determines if
+        # Get the default validation setting for the association. Determines if
         # by default a validates associated will occur.
         #
         # @example Get the validation default.
         #   Proxy.validation_default
         #
         # @return [ true, false ] The validation default.
-        #
-        # @since 2.1.9
         def validation_default; true; end
 
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def stores_foreign_key?; false; end
 
         # The primary key
         #
-        # @return [ nil ] Not relevant for this relation
+        # @return [ nil ] Not relevant for this association
         def primary_key; end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -107,8 +89,6 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           @polymorphic ||= !!@options[:as]
         end
@@ -118,8 +98,6 @@ module Mongoid
         # @note Only relevant if the association is polymorphic.
         #
         # @return [ String, nil ] The field for storing the associated object's type.
-        #
-        # @since 7.0
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -130,8 +108,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::One ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::One.new(self, attributes, options)
         end

data/lib/mongoid/association/embedded.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/embedded/cyclic'
 require 'mongoid/association/embedded/embedded_in'
 require 'mongoid/association/embedded/embeds_many'