mongoid 7.3.2 → 7.4.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/batchable'
 
@@ -39,8 +38,6 @@ module Mongoid
           #   person.addresses.as_document
           #
           # @return [ Array<Hash> ] The association as stored in the db.
-          #
-          # @since 2.0.0.rc.1
           def as_document
             as_attributes.collect { |attrs| BSON::Document.new(attrs) }
           end
@@ -54,8 +51,6 @@ module Mongoid
           # @param [ Array<Document> ] docs The docs to add.
           #
           # @return [ Array<Document> ] The documents.
-          #
-          # @since 2.4.0
           def concat(docs)
             batch_insert(docs) unless docs.empty?
             self
@@ -77,7 +72,7 @@ module Mongoid
             doc.apply_post_processed_defaults
             yield(doc) if block_given?
             doc.run_callbacks(:build) { doc }
-            _base._reset_memoized_children!
+            _base._reset_memoized_descendants!
             doc
           end
 
@@ -107,12 +102,26 @@ module Mongoid
           #
           # Use #size if you want the total number of documents.
           #
+          # If args or block are present, #count will delegate to the
+          # #count method on +target+ and will include both persisted
+          # and non-persisted documents.
+          #
           # @example Get the count of persisted documents.
           #   person.addresses.count
           #
+          # @example Get the count of all documents matching a block.
+          #   person.addresses.count { |a| a.country == "FR" }
+          #
+          # @example Use #persisted? inside block to count persisted documents.
+          #   person.addresses.count { |a| a.persisted? && a.country == "FR" }
+          #
+          # @param [ Object, Array<Object> ] args Args to delegate to the target.
+          #
           # @return [ Integer ] The total number of persisted embedded docs, as
           #   flagged by the #persisted? method.
-          def count
+          def count(*args, &block)
+            return _target.count(*args, &block) if args.any? || block
+
             _target.select { |doc| doc.persisted? }.size
           end
 
@@ -125,8 +134,6 @@ module Mongoid
           # @param [ Document ] document The document to be deleted.
           #
           # @return [ Document, nil ] The deleted document or nil if nothing deleted.
-          #
-          # @since 2.0.0.rc.1
           def delete(document)
             execute_callback :before_remove, document
             doc = _target.delete_one(document)
@@ -168,8 +175,6 @@ module Mongoid
           #
           # @return [ Many, Enumerator ] The association or an enumerator if no
           #   block was provided.
-          #
-          # @since 3.1.0
           def delete_if
             if block_given?
               dup_target = _target.dup
@@ -210,17 +215,29 @@ module Mongoid
           # Finds a document in this association through several different
           # methods.
           #
+          # This method delegates to +Mongoid::Criteria#find+. If this method is
+          # not given a block, it returns one or many documents for the provided
+          # _id values.
+          #
+          # If this method is given a block, it returns the first document
+          # of those found by the current Criteria object for which the block
+          # returns a truthy value.
+          #
           # @example Find a document by its id.
           #   person.addresses.find(BSON::ObjectId.new)
           #
           # @example Find documents for multiple ids.
           #   person.addresses.find([ BSON::ObjectId.new, BSON::ObjectId.new ])
           #
+          # @example Finds the first matching document using a block.
+          #   person.addresses.find { |addr| addr.state == 'CA' }
+          #
           # @param [ Array<Object> ] args Various arguments.
+          # @param [ Proc ] block Optional block to pass.
           #
-          # @return [ Array<Document>, Document ] A single or multiple documents.
-          def find(*args)
-            criteria.find(*args)
+          # @return [ Document | Array<Document> | nil ] A document or matching documents.
+          def find(*args, &block)
+            criteria.find(*args, &block)
           end
 
           # Instantiate a new embeds_many association.
@@ -250,8 +267,6 @@ module Mongoid
           #   relation.in_memory
           #
           # @return [ Array<Document> ] The documents in memory.
-          #
-          # @since 2.1.0
           def in_memory
             _target
           end
@@ -269,8 +284,6 @@ module Mongoid
           #   provided.
           #
           # @return [ Document, Array<Document> ] The popped document(s).
-          #
-          # @since 3.0.0
           def pop(count = nil)
             if count
               if docs = _target[_target.size - count, _target.size]
@@ -313,8 +326,6 @@ module Mongoid
           # @param [ Array<Document> ] docs The replacement docs.
           #
           # @return [ Many ] The proxied association.
-          #
-          # @since 2.0.0.rc.1
           def substitute(docs)
             batch_replace(docs)
             self
@@ -327,8 +338,6 @@ module Mongoid
           #   person.addresses.unscoped
           #
           # @return [ Criteria ] The unscoped association.
-          #
-          # @since 2.4.0
           def unscoped
             criterion = klass.unscoped
             criterion.embedded = true
@@ -349,8 +358,6 @@ module Mongoid
           #   relation.append(document)
           #
           # @param [ Document ] document The document to append to the target.
-          #
-          # @since 2.0.0.rc.1
           def append(document)
             execute_callback :before_add, document
             unless object_already_related?(document)
@@ -368,8 +375,6 @@ module Mongoid
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The many binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
@@ -390,8 +395,6 @@ module Mongoid
           #   relation.delete_one(doc)
           #
           # @param [ Document ] document The document to delete.
-          #
-          # @since 2.4.7
           def delete_one(document)
             _target.delete_one(document)
             _unscoped.delete_one(document)
@@ -405,8 +408,6 @@ module Mongoid
           #   relation.integrate(document)
           #
           # @param [ Document ] document The document to integrate.
-          #
-          # @since 2.1.0
           def integrate(document)
             characterize_one(document)
             bind_one(document)
@@ -435,8 +436,6 @@ module Mongoid
           #   relation.persistable?
           #
           # @return [ true, false ] If the association is persistable.
-          #
-          # @since 2.1.0
           def persistable?
             _base.persisted? && !_binding?
           end
@@ -447,8 +446,6 @@ module Mongoid
           #
           # @example Reindex the association.
           #   person.addresses.reindex
-          #
-          # @since 2.0.0.rc.1
           def reindex
             _unscoped.each_with_index do |doc, index|
               doc._index = index
@@ -464,8 +461,6 @@ module Mongoid
           # @param [ Array<Document> ] docs The documents to scope.
           #
           # @return [ Array<Document> ] The scoped docs.
-          #
-          # @since 2.4.0
           def scope(docs)
             unless _association.order || _association.klass.default_scoping?
               return docs
@@ -500,8 +495,6 @@ module Mongoid
           #   relation._unscoped
           #
           # @return [ Array<Document> ] The unscoped documents.
-          #
-          # @since 2.4.0
           def _unscoped
             @_unscoped ||= []
           end
@@ -514,8 +507,6 @@ module Mongoid
           # @param [ Array<Document> ] docs The documents.
           #
           # @return [ Array<Document ] The unscoped docs.
-          #
-          # @since 2.4.0
           def _unscoped=(docs)
             @_unscoped = docs
           end
@@ -537,8 +528,6 @@ module Mongoid
             #   Association::Embedded::EmbedsMany.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -549,8 +538,6 @@ module Mongoid
             #   Association::Embedded::EmbedsMany.foreign_key_suffix
             #
             # @return [ nil ] nil.
-            #
-            # @since 3.0.0
             def foreign_key_suffix
               nil
             end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/embeds_many/binding'
 require 'mongoid/association/embedded/embeds_many/buildable'
@@ -10,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbedsMany type association.
-      #
-      # @since 7.0
       class EmbedsMany
         include Relatable
         include Buildable
@@ -20,8 +17,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :as,
             :cascade_callbacks,
@@ -38,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)
@@ -57,8 +48,6 @@ 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
@@ -66,8 +55,6 @@ module Mongoid
         # The key that is used to get the attributes for the associated object.
         #
         # @return [ String ] The name of the field used to store the association.
-        #
-        # @since 7.0
         def key
           store_as.to_s
         end
@@ -75,8 +62,6 @@ 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 association. Determines if
@@ -86,15 +71,11 @@ module Mongoid
         #   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
@@ -105,8 +86,6 @@ module Mongoid
         # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -114,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
@@ -125,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
@@ -137,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
@@ -152,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
@@ -162,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbedsOne
 
         # Binding class for all embeds_one associations.
-        #
-        # @since 7.0
         class Binding
           include Bindable
 
@@ -21,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
@@ -36,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbedsOne
 
         # Builder class for embeds_one associations.
-        #
-        # @since 7.0
         module Buildable
           include Threaded::Lifecycle
 

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -11,8 +10,6 @@ module Mongoid
           # The valid options when defining this association.
           #
           # @return [ Array<Symbol> ] The allowed options when defining this association.
-          #
-          # @since 7.0
           VALID_OPTIONS = [
               :autobuild,
               :as,
@@ -34,7 +31,7 @@ module Mongoid
               characterize_one(_target)
               bind_one
               characterize_one(_target)
-              _base._reset_memoized_children!
+              _base._reset_memoized_descendants!
               _target.save if persistable?
             end
           end
@@ -48,8 +45,6 @@ module Mongoid
           # @param [ Document ] replacement A document to replace the target.
           #
           # @return [ Document, nil ] The association or nil.
-          #
-          # @since 2.0.0.rc.1
           def substitute(replacement)
             if replacement != self
               if _assigning?
@@ -58,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
@@ -78,8 +98,6 @@ module Mongoid
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The association's binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
@@ -90,8 +108,6 @@ module Mongoid
           #   relation.persistable?
           #
           # @return [ true, false ] If the association is persistable.
-          #
-          # @since 2.1.0
           def persistable?
             _base.persisted? && !_binding? && !_building? && !_assigning?
           end
@@ -105,8 +121,6 @@ module Mongoid
             #   Association::Embedded::EmbedsOne.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -120,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/embeds_one/binding'
 require 'mongoid/association/embedded/embeds_one/buildable'
@@ -10,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbedsOne type association.
-      #
-      # @since 7.0
       class EmbedsOne
         include Relatable
         include Buildable
@@ -20,8 +17,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :autobuild,
             :as,
@@ -34,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)
@@ -53,8 +44,6 @@ 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
@@ -62,8 +51,6 @@ module Mongoid
         # The key that is used to get the attributes for the associated object.
         #
         # @return [ String ] The name of the field used to store the association.
-        #
-        # @since 7.0
         def key
           store_as.to_s
         end
@@ -71,8 +58,6 @@ 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 association. Determines if
@@ -82,15 +67,11 @@ module Mongoid
         #   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
@@ -101,8 +82,6 @@ module Mongoid
         # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -110,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
@@ -121,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
@@ -133,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/cyclic'
 require 'mongoid/association/embedded/embedded_in'

data/lib/mongoid/association/macros.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -13,9 +12,12 @@ module Mongoid
         class_attribute :embedded, instance_reader: false
         class_attribute :embedded_relations
         class_attribute :relations
+        # @api private
+        class_attribute :aliased_associations
         self.embedded = false
         self.embedded_relations = BSON::Document.new
         self.relations = BSON::Document.new
+        self.aliased_associations = {}
       end
 
       # This is convenience for libraries still on the old API.
@@ -24,8 +26,6 @@ module Mongoid
       #   person.associations
       #
       # @return [ Hash ] The associations.
-      #
-      # @since 2.3.1
       def associations
         self.relations
       end
@@ -164,8 +164,6 @@ module Mongoid
         # @param [ Symbol ] name The name of the association.
         # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
-        #
-        # @since 2.0.0.rc.1
         def has_and_belongs_to_many(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
@@ -198,6 +196,9 @@ module Mongoid
           Association::MACRO_MAPPING[macro_name].new(self, name, options, &block).tap do |assoc|
             assoc.setup!
             self.relations = self.relations.merge(name => assoc)
+            if assoc.respond_to?(:store_as) && assoc.store_as != name
+              self.aliased_associations[assoc.store_as] = name
+            end
           end
         end
       end