mongoid 7.0.12 → 7.3.3

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -5,13 +8,13 @@ module Mongoid
 
         class Proxy < Association::One
 
-          # Instantiate a new embedded_in relation.
+          # Instantiate a new embedded_in association.
           #
-          # @example Create the new relation.
+          # @example Create the new association.
           #   Association::Embedded::EmbeddedIn.new(person, address, association)
           #
-          # @param [ Document ] base The document the relation hangs off of.
-          # @param [ Document ] target The target (parent) of the relation.
+          # @param [ Document ] base The document the association hangs off of.
+          # @param [ Document ] target The target (parent) of the association.
           # @param [ Association ] association The association metadata.
           #
           # @return [ In ] The proxy.
@@ -23,14 +26,14 @@ module Mongoid
           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.
+          # @return [ Document, nil ] The association or nil.
           #
           # @since 2.0.0.rc.1
           def substitute(replacement)
@@ -47,7 +50,7 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   binding([ address ])
@@ -73,12 +76,12 @@ module Mongoid
             end
           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.
+          # @return [ true, false ] If the association is persistable.
           #
           # @since 2.1.0
           def persistable?
@@ -87,10 +90,10 @@ module Mongoid
 
           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::EmbeddedIn.embedded?
             #
             # @return [ true ] true.

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/embedded_in/binding'
 require 'mongoid/association/embedded/embedded_in/buildable'
 require 'mongoid/association/embedded/embedded_in/proxy'
@@ -23,7 +26,7 @@ module Mongoid
             :autobuild,
             :cyclic,
             :polymorphic,
-            :touch
+            :touch,
         ].freeze
 
         # The complete list of valid options for this association, including
@@ -54,7 +57,7 @@ module Mongoid
 
         # The primary key
         #
-        # @return [ nil ] Not relevant for this relation
+        # @return [ nil ] Not relevant for this association
         def primary_key; end
 
         # Does this association type store the foreign key?
@@ -73,14 +76,14 @@ module Mongoid
 
         # The key that is used to get the attributes for the associated object.
         #
-        # @return [ String ] The name of the relation.
+        # @return [ String ] The name of the association.
         #
         # @since 7.0
         def key
           @key ||= name.to_s
         end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbeddedIn::Proxy ] The proxy class.
         #

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

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
       class EmbedsMany
 
-        # Binding class for all embeds_many relations.
+        # Binding class for all embeds_many associations.
         #
         # @since 7.0
         class Binding
           include Bindable
 
-          # Binds a single document with the inverse relation. Used
+          # Binds a single document with the inverse association. Used
           # specifically when appending to the proxy.
           #
           # @example Bind one document.

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -18,17 +21,20 @@ module Mongoid
           #   Builder.new(meta, attrs).build
           #
           # @param [ Object ] base The base object.
-          # @param [ Object ] object The object to use to build the relation.
+          # @param [ Object ] object The object to use to build the association.
           # @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 documents.
           #
           # @return [ Array<Document ] The documents.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             return [] if object.blank?
             return object if object.first.is_a?(Document)
             docs = []
             object.each do |attrs|
               if _loading? && base.persisted?
-                docs.push(Factory.from_db(klass, attrs))
+                docs.push(Factory.from_db(klass, attrs, nil, selected_fields))
               else
                 docs.push(Factory.build(klass, attrs))
               end

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/batchable'
 
 module Mongoid
@@ -8,7 +11,7 @@ module Mongoid
         class Proxy < Association::Many
           include Batchable
 
-          # Appends a document or array of documents to the relation. Will set
+          # Appends a document or array of documents to the association. Will set
           # the parent and update the index in the process.
           #
           # @example Append a document.
@@ -30,19 +33,19 @@ module Mongoid
 
           alias :push :<<
 
-          # Get this relation as as its representation in the database.
+          # Get this association as as its representation in the database.
           #
-          # @example Convert the relation to an attributes hash.
+          # @example Convert the association to an attributes hash.
           #   person.addresses.as_document
           #
-          # @return [ Array<Hash> ] The relation as stored in the db.
+          # @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
 
-          # Appends an array of documents to the relation. Performs a batch
+          # Appends an array of documents to the association. Performs a batch
           # insert of the documents instead of persisting one at a time.
           #
           # @example Concat with other documents.
@@ -58,10 +61,10 @@ module Mongoid
             self
           end
 
-          # Builds a new document in the relation and appends it to the target.
+          # Builds a new document in the association and appends it to the target.
           # Takes an optional type if you want to specify a subclass.
           #
-          # @example Build a new document on the relation.
+          # @example Build a new document on the association.
           #   person.people.build(:name => "Bozo")
           #
           # @param [ Hash ] attributes The attributes to build the document with.
@@ -80,13 +83,20 @@ module Mongoid
 
           alias :new :build
 
-          # Clear the relation. Will delete the documents from the db if they are
-          # already persisted.
+          # Clear the association. Will delete the documents from the db
+          # if they are already persisted.
+          #
+          # If the host document is not persisted but its _id matches a
+          # persisted document, calling #clear on an association will remove
+          # the association's documents from the database even though the
+          # set of documents in the application (as loaded in the host)
+          # is different from what is in the database, and the host may
+          # not contain any persisted documents in the association either.
           #
-          # @example Clear the relation.
+          # @example Clear the association.
           #   person.addresses.clear
           #
-          # @return [ self ] The empty relation.
+          # @return [ self ] The empty association.
           def clear
             batch_clear(_target.dup)
             self
@@ -109,7 +119,7 @@ module Mongoid
           # Delete the supplied document from the target. This method is proxied
           # in order to reindex the array after the operation occurs.
           #
-          # @example Delete the document from the relation.
+          # @example Delete the document from the association.
           #   person.addresses.delete(address)
           #
           # @param [ Document ] document The document to be deleted.
@@ -136,10 +146,10 @@ module Mongoid
 
           # Delete all the documents in the association without running callbacks.
           #
-          # @example Delete all documents from the relation.
+          # @example Delete all documents from the association.
           #   person.addresses.delete_all
           #
-          # @example Conditionally delete documents from the relation.
+          # @example Conditionally delete documents from the association.
           #   person.addresses.delete_all({ :street => "Bond" })
           #
           # @param [ Hash ] conditions Conditions on which documents to delete.
@@ -156,7 +166,7 @@ module Mongoid
           #     doc.state == "GA"
           #   end
           #
-          # @return [ Many, Enumerator ] The relation or an enumerator if no
+          # @return [ Many, Enumerator ] The association or an enumerator if no
           #   block was provided.
           #
           # @since 3.1.0
@@ -174,10 +184,10 @@ module Mongoid
 
           # Destroy all the documents in the association whilst running callbacks.
           #
-          # @example Destroy all documents from the relation.
+          # @example Destroy all documents from the association.
           #   person.addresses.destroy_all
           #
-          # @example Conditionally destroy documents from the relation.
+          # @example Conditionally destroy documents from the association.
           #   person.addresses.destroy_all({ :street => "Bond" })
           #
           # @param [ Hash ] conditions Conditions on which documents to destroy.
@@ -187,7 +197,7 @@ module Mongoid
             remove_all(conditions, :destroy)
           end
 
-          # Determine if any documents in this relation exist in the database.
+          # Determine if any documents in this association exist in the database.
           #
           # @example Are there persisted documents?
           #   person.posts.exists?
@@ -213,13 +223,13 @@ module Mongoid
             criteria.find(*args)
           end
 
-          # Instantiate a new embeds_many relation.
+          # Instantiate a new embeds_many association.
           #
-          # @example Create the new relation.
+          # @example Create the new association.
           #   Many.new(person, addresses, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Array<Document> ] target The child documents of the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Array<Document> ] target The child documents of the association.
           # @param [ Association ] association The association metadata
           #
           # @return [ Many ] The proxy.
@@ -234,7 +244,7 @@ module Mongoid
             end
           end
 
-          # Get all the documents in the relation that are loaded into memory.
+          # Get all the documents in the association that are loaded into memory.
           #
           # @example Get the in memory documents.
           #   relation.in_memory
@@ -246,7 +256,7 @@ module Mongoid
             _target
           end
 
-          # Pop documents off the relation. This can be a single document or
+          # Pop documents off the association. This can be a single document or
           # multiples, and will automatically persist the changes.
           #
           # @example Pop a single document.
@@ -271,7 +281,7 @@ module Mongoid
             end
           end
 
-          # Shift documents off the relation. This can be a single document or
+          # Shift documents off the association. This can be a single document or
           # multiples, and will automatically persist the changes.
           #
           # @example Shift a single document.
@@ -297,12 +307,12 @@ module Mongoid
           # Substitutes the supplied target documents for the existing documents
           # in the relation.
           #
-          # @example Substitute the relation's target.
+          # @example Substitute the association's target.
           #   person.addresses.substitute([ address ])
           #
           # @param [ Array<Document> ] docs The replacement docs.
           #
-          # @return [ Many ] The proxied relation.
+          # @return [ Many ] The proxied association.
           #
           # @since 2.0.0.rc.1
           def substitute(docs)
@@ -310,13 +320,13 @@ module Mongoid
             self
           end
 
-          # Return the relation with all previous scoping removed. This is the
+          # Return the association with all previous scoping removed. This is the
           # exact representation of the docs in the database.
           #
           # @example Get the unscoped documents.
           #   person.addresses.unscoped
           #
-          # @return [ Criteria ] The unscoped relation.
+          # @return [ Criteria ] The unscoped association.
           #
           # @since 2.4.0
           def unscoped
@@ -329,7 +339,7 @@ module Mongoid
           private
 
           def object_already_related?(document)
-            _target.any? { |existing| existing.id && existing === document }
+            _target.any? { |existing| existing._id && existing === document }
           end
 
           # Appends the document to the target array, updating the index on the
@@ -352,7 +362,7 @@ module Mongoid
             execute_callback :after_add, document
           end
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Create the binding.
           #   relation.binding([ address ])
@@ -364,15 +374,12 @@ module Mongoid
             Binding.new(_base, _target, _association)
           end
 
-          # Returns the "#{criteria}"# object for the target class with its documents set
-          # to target.
-          #
-          # @example Get a criteria for the relation.
-          #   relation.criteria
+          # Returns the +Criteria+ object for the target class with its
+          # documents set to the list of target documents in the association.
           #
           # @return [ Criteria ] A new criteria.
           def criteria
-            @criteria ||= _association.criteria(_base, _target)
+            _association.criteria(_base, _target)
           end
 
           # Deletes one document from the target and unscoped.
@@ -391,7 +398,7 @@ module Mongoid
             reindex
           end
 
-          # Integrate the document into the relation. will set its metadata and
+          # Integrate the document into the association. will set its metadata and
           # attempt to bind the inverse.
           #
           # @example Integrate the document.
@@ -415,19 +422,19 @@ module Mongoid
           # @param [ Proc ] block Optional block to pass.
           #
           # @return [ Criteria, Object ] A Criteria or return value from the target.
-          def method_missing(name, *args, &block)
+          ruby2_keywords def method_missing(name, *args, &block)
             return super if _target.respond_to?(name)
             klass.send(:with_scope, criteria) do
               criteria.public_send(name, *args, &block)
             end
           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.
+          # @return [ true, false ] If the association is persistable.
           #
           # @since 2.1.0
           def persistable?
@@ -438,7 +445,7 @@ module Mongoid
           # operations on the proxied target directly and the indices need to
           # match that on the database side.
           #
-          # @example Reindex the relation.
+          # @example Reindex the association.
           #   person.addresses.reindex
           #
           # @since 2.0.0.rc.1
@@ -448,8 +455,8 @@ module Mongoid
             end
           end
 
-          # Apply the association ordering or the default scoping to the provided
-          # documents.
+          # Apply the association ordering and default scoping (defined on
+          # association's target class) to the provided documents.
           #
           # @example Apply scoping.
           #   person.addresses.scope(target)
@@ -460,17 +467,20 @@ module Mongoid
           #
           # @since 2.4.0
           def scope(docs)
-            return docs unless _association.order || _association.klass.default_scoping?
+            unless _association.order || _association.klass.default_scoping?
+              return docs
+            end
+
             crit = _association.klass.order_by(_association.order)
             crit.embedded = true
             crit.documents = docs
             crit.entries
           end
 
-          # Remove all documents from the relation, either with a delete or a
+          # Remove all documents from the association, either with a delete or a
           # destroy depending on what this was called through.
           #
-          # @example Destroy documents from the relation.
+          # @example Destroy documents from the association.
           #   relation.remove_all({ :num => 1 }, true)
           #
           # @param [ Hash ] conditions Conditions to filter by.
@@ -520,10 +530,10 @@ module Mongoid
 
           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 the relation embedded?
+            # @example Is the association embedded?
             #   Association::Embedded::EmbedsMany.embedded?
             #
             # @return [ true ] true.

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/embeds_many/binding'
 require 'mongoid/association/embedded/embeds_many/buildable'
 require 'mongoid/association/embedded/embeds_many/proxy'
@@ -62,7 +65,7 @@ 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 relation.
+        # @return [ String ] The name of the field used to store the association.
         #
         # @since 7.0
         def key
@@ -76,7 +79,7 @@ module Mongoid
         # @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.
@@ -96,10 +99,10 @@ module Mongoid
 
         # 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.
         #

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

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
       class EmbedsOne
 
-        # Binding class for all embeds_one relations.
+        # Binding class for all embeds_one associations.
         #
         # @since 7.0
         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

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -10,21 +13,24 @@ module Mongoid
           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