mongoid 7.0.13 → 7.1.0.rc0

data/lib/mongoid/association/constrainable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
@@ -8,7 +10,7 @@ module Mongoid
     module Constrainable
 
       # Convert the supplied object to the appropriate type to set as the
-      # foreign key for a relation.
+      # foreign key for an association.
       #
       # @example Convert the object.
       #   constraint.convert("12345")
@@ -31,7 +33,7 @@ module Mongoid
       end
 
       private
-      
+
       def convert_polymorphic(object)
         if object.is_a?(Mongoid::Document)
           object.id

data/lib/mongoid/association/depending.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
 
-    # This module defines the behaviour for setting up cascading deletes and
-    # nullifies for relations, and how to delegate to the appropriate strategy.
+    # This module defines the behavior for setting up cascading deletes and
+    # nullifies for associations, and how to delegate to the appropriate strategy.
     module Depending
       extend ActiveSupport::Concern
 

data/lib/mongoid/association/eager_loadable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/association/referenced/eager"
 
 module Mongoid

data/lib/mongoid/association/embedded.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/cyclic'
 require 'mongoid/association/embedded/embedded_in'
 require 'mongoid/association/embedded/embeds_many'

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
 
-      # Contains behaviour for executing operations in batch on embedded
+      # Contains behavior for executing operations in batch on embedded
       # documents.
       module Batchable
         include Positional
@@ -24,7 +26,7 @@ module Mongoid
           execute_batch_push(docs)
         end
 
-        # Clear all of the docs out of the relation in a single swipe.
+        # Clear all of the docs out of the association in a single swipe.
         #
         # @example Clear all docs.
         #   batchable.batch_clear(docs)

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
 
       # This module provides convenience macros for using cyclic embedded
-      # relations.
+      # associations.
       module Cyclic
         extend ActiveSupport::Concern
 
@@ -14,7 +16,7 @@ module Mongoid
 
         module ClassMethods
 
-          # Create a cyclic embedded relation that creates a tree hierarchy for
+          # Create a cyclic embedded association that creates a tree hierarchy for
           # the document and many embedded child documents.
           #
           # @example Set up a recursive embeds many.
@@ -44,7 +46,7 @@ module Mongoid
             embedded_in cyclic_parent_name, class_name: self.name, cyclic: true
           end
 
-          # Create a cyclic embedded relation that creates a single self
+          # Create a cyclic embedded association that creates a single self
           # referencing relationship for a parent and a single child.
           #
           # @example Set up a recursive embeds one.
@@ -85,7 +87,7 @@ module Mongoid
           #
           # @since 2.0.0.rc.1
           def cyclic_parent_name
-            ("parent_" << self.name.demodulize.underscore.singularize).to_sym
+            ("parent_#{self.name.demodulize.underscore.singularize}").to_sym
           end
 
           # Determines the child name given the class.
@@ -93,14 +95,14 @@ module Mongoid
           # @example Determine the child name.
           #   Role.cyclic_child_name
           #
-          # @param [ true, false ] many Is the a many relation?
+          # @param [ true, false ] many Is the a many association?
           #
           # @return [ String ] "child_" plus the class name underscored in
           #   singular or plural form.
           #
           # @since 2.0.0.rc.1
           def cyclic_child_name(many = true)
-            ("child_" << self.name.demodulize.underscore.send(many ? :pluralize : :singularize)).to_sym
+            ("child_#{self.name.demodulize.underscore.send(many ? :pluralize : :singularize)}").to_sym
           end
         end
       end

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'
@@ -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/embedded_in/binding.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -9,7 +12,7 @@ module Mongoid
         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/embedded_in/buildable.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -18,12 +21,15 @@ module Mongoid
           # @param [ Object ] base The object.
           # @param [ Object ] object The parent hash or 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?
-              Factory.from_db(klass, object)
+              Factory.from_db(klass, object, nil, selected_fields)
             else
               Factory.build(klass, object)
             end

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/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.
         #
@@ -197,8 +200,7 @@ module Mongoid
         def determine_inverses(other)
           matches = relation_class.relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
-              # https://jira.mongodb.org/browse/MONGOID-4882
-              rel.relation_class_name.sub(/\A::/, '') == inverse_class_name
+                rel.relation_class_name == inverse_class_name
           end
           if matches.size > 1
             raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)

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,13 @@ module Mongoid
 
           alias :new :build
 
-          # Clear the relation. Will delete the documents from the db if they are
+          # Clear the association. Will delete the documents from the db if they are
           # already persisted.
           #
-          # @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 +112,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 +139,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 +159,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 +177,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 +190,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 +216,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 +237,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 +249,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 +274,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 +300,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 +313,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
@@ -352,7 +355,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 ])
@@ -388,7 +391,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.
@@ -419,12 +422,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?
@@ -435,7 +438,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
@@ -467,10 +470,10 @@ module Mongoid
             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 +523,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.