mongoid 7.0.10 → 7.4.0

data/lib/mongoid/association/accessors.rb

@@ -1,97 +1,94 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
-    # This module contains all the behaviour related to accessing relations
+    # This module contains all the behavior related to accessing associations
     # through the getters and setters, and how to delegate to builders to
     # create new ones.
     module Accessors
       extend ActiveSupport::Concern
 
-      # Builds the related document and creates the relation unless the
-      # document is nil, then sets the relation on this document.
+      # Builds the related document and creates the association unless the
+      # document is nil, then sets the association on this document.
       #
-      # @example Build the relation.
+      # @example Build the association.
       #   person.__build__(:addresses, { :_id => 1 }, association)
       #
-      # @param [ String, Symbol ] name The name of the relation.
+      # @param [ String, Symbol ] name The name of the association.
       # @param [ Hash, BSON::ObjectId ] object The id or attributes to use.
       # @param [ Association ] association The association metadata.
+      # @param [ Hash ] selected_fields Fields which were retrieved via #only.
+      #   If selected_fields is specified, fields not listed in it will not be
+      #   accessible in the built document.
       #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def __build__(name, object, association)
-        relation = create_relation(object, association)
+      # @return [ Proxy ] The association.
+      def __build__(name, object, association, selected_fields = nil)
+        relation = create_relation(object, association, selected_fields)
         set_relation(name, relation)
       end
 
-      # Create a relation from an object and association.
+      # Create an association from an object and association metadata.
       #
-      # @example Create the relation.
+      # @example Create the association.
       #   person.create_relation(document, association)
       #
-      # @param [ Document, Array<Document> ] object The relation target.
+      # @param [ Document, Array<Document> ] object The association target.
       # @param [ Association ] association The association metadata.
+      # @param [ Hash ] selected_fields Fields which were retrieved via #only.
+      #   If selected_fields is specified, fields not listed in it will not be
+      #   accessible in the created association document.
       #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 2.0.0.rc.1
-      def create_relation(object, association)
+      # @return [ Proxy ] The association.
+      def create_relation(object, association, selected_fields = nil)
         type = @attributes[association.inverse_type]
-        target = association.build(self, object, type)
+        target = association.build(self, object, type, selected_fields)
         target ? association.create_relation(self, target) : nil
       end
 
-      # Resets the criteria inside the relation proxy. Used by many-to-many
-      # relations to keep the underlying ids array in sync.
+      # Resets the criteria inside the association proxy. Used by many-to-many
+      # associations to keep the underlying ids array in sync.
       #
-      # @example Reset the relation criteria.
+      # @example Reset the association criteria.
       #   person.reset_relation_criteria(:preferences)
       #
-      # @param [ Symbol ] name The name of the relation.
-      #
-      # @since 3.0.14
+      # @param [ Symbol ] name The name of the association.
       def reset_relation_criteria(name)
         if instance_variable_defined?("@_#{name}")
           send(name).reset_unloaded
         end
       end
 
-      # Set the supplied relation to an instance variable on the class with the
+      # Set the supplied association to an instance variable on the class with the
       # provided name. Used as a helper just for code cleanliness.
       #
       # @example Set the proxy on the document.
       #   person.set(:addresses, addresses)
       #
-      # @param [ String, Symbol ] name The name of the relation.
-      # @param [ Proxy ] relation The relation to set.
-      #
-      # @return [ Proxy ] The relation.
+      # @param [ String, Symbol ] name The name of the association.
+      # @param [ Proxy ] relation The association to set.
       #
-      # @since 2.0.0.rc.1
+      # @return [ Proxy ] The association.
       def set_relation(name, relation)
         instance_variable_set("@_#{name}", relation)
       end
 
       private
 
-      # Get the relation. Extracted out from the getter method to avoid
+      # Get the association. Extracted out from the getter method to avoid
       # infinite recursion when overriding the getter.
       #
       # @api private
       #
-      # @example Get the relation.
+      # @example Get the association.
       #   document.get_relation(:name, association)
       #
-      # @param [ Symbol ] name The name of the relation.
+      # @param [ Symbol ] name The name of the association.
       # @param [ Association ] association The association metadata.
-      # @param [ Object ] object The object used to build the relation.
-      # @param [ true, false ] reload If the relation is to be reloaded.
+      # @param [ Object ] object The object used to build the association.
+      # @param [ true, false ] reload If the association is to be reloaded.
       #
-      # @return [ Proxy ] The relation.
-      #
-      # @since 3.0.16
+      # @return [ Proxy ] The association.
       def get_relation(name, association, object, reload = false)
         if !reload && (value = ivar(name)) != false
           value
@@ -101,13 +98,95 @@ module Mongoid
               if object && needs_no_database_query?(object, association)
                 __build__(name, object, association)
               else
-                __build__(name, attributes[association.key], association)
+                selected_fields = _mongoid_filter_selected_fields(association.key)
+                __build__(name, attributes[association.key], association, selected_fields)
               end
             end
           end
         end
       end
 
+      # Returns a subset of __selected_fields attribute applicable to the
+      # (embedded) association with the given key, or nil if no projection
+      # is to be performed.
+      #
+      # Also returns nil if exclusionary projection was requested but it does
+      # not exclude the field of the association.
+      #
+      # For example, if __selected_fields is {'a' => 1, 'b.c' => 2, 'b.c.f' => 3},
+      # and assoc_key is 'b', return value would be {'c' => 2, 'c.f' => 3}.
+      #
+      # @param [ String ] assoc_key
+      #
+      # @return [ Hash | nil ]
+      #
+      # @api private
+      def _mongoid_filter_selected_fields(assoc_key)
+        return nil unless __selected_fields
+
+        # If the list of fields was specified using #without instead of #only
+        # and the provided list does not include the association, any of its
+        # fields should be allowed.
+        if __selected_fields.values.all? { |v| v == 0 } &&
+          __selected_fields.keys.none? { |k| k.split('.', 2).first == assoc_key }
+        then
+          return nil
+        end
+
+        projecting_assoc = false
+
+        filtered = {}
+        __selected_fields.each do |k, v|
+          bits = k.split('.')
+
+          # If we are asked to project an association, we need all of that
+          # association's fields. However, we may be asked to project
+          # an association *and* its fields in the same query. In this case
+          # behavior differs according to server version:
+          #
+          # 4.2 and lower take the most recent projection specification, meaning
+          # projecting foo followed by foo.bar effectively projects foo.bar and
+          # projecting foo.bar followed by foo effectively projects foo.
+          # To match this behavior we need to track when we are being asked
+          # to project the association and when we are asked to project a field,
+          # and if we are asked to project the association last we need to
+          # remove any field projections.
+          #
+          # 4.4 (and presumably higher) do not allow projection to be on an
+          # association and its field, so it doesn't matter what we do. Hence
+          # we just need to handle the 4.2 and lower case correctly.
+          if bits.first == assoc_key
+            # Projecting the entire association OR some of its fields
+            if bits.length > 1
+              # Projecting a field
+              bits.shift
+              filtered[bits.join('.')] = v
+              projecting_assoc = false
+            else
+              # Projecting the entire association
+              projecting_assoc = true
+            end
+          end
+        end
+
+        if projecting_assoc
+          # The last projection was of the entire association; we may have
+          # also been projecting fields, but discard the field projections
+          # and return nil indicating we want the entire association.
+          return nil
+        end
+
+        # Positional projection is specified as "foo.$". In this case the
+        # document that the $ is referring to should be retrieved with all
+        # fields. See https://docs.mongodb.com/manual/reference/operator/projection/positional/
+        # and https://jira.mongodb.org/browse/MONGOID-4769.
+        if filtered.keys == %w($)
+          filtered = nil
+        end
+
+        filtered
+      end
+
       def needs_no_database_query?(object, association)
         object.is_a?(Document) && !object.embedded? &&
             object._id == attributes[association.key]
@@ -119,8 +198,6 @@ module Mongoid
       #   document.without_autobuild?
       #
       # @return [ true, false ] If autobuild is disabled.
-      #
-      # @since 3.0.0
       def without_autobuild?
         Threaded.executing?(:without_autobuild)
       end
@@ -133,8 +210,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
       def without_autobuild
         Threaded.begin_execution("without_autobuild")
         yield
@@ -151,18 +226,16 @@ module Mongoid
       # @param [ Array ] args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [args.first || {}, args.size > 1 ? args[1] : {}]
       end
 
-      # Adds the existence check for relations.
+      # Adds the existence check for associations.
       #
       # @example Add the existence check.
       #   Person.define_existence_check!(association)
       #
-      # @example Check if a relation exists.
+      # @example Check if an association exists.
       #   person = Person.new
       #   person.has_game?
       #   person.game?
@@ -170,8 +243,6 @@ module Mongoid
       # @param [ Association ] association The association.
       #
       # @return [ Class ] The model being set up.
-      #
-      # @since 3.0.0
       def self.define_existence_check!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -184,18 +255,16 @@ module Mongoid
         end
       end
 
-      # Defines the getter for the relation. Nothing too special here: just
-      # return the instance variable for the relation if it exists or build
+      # Defines the getter for the association. Nothing too special here: just
+      # return the instance variable for the association if it exists or build
       # the thing.
       #
-      # @example Set up the getter for the relation.
+      # @example Set up the getter for the association.
       #   Person.define_getter!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_getter!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -209,37 +278,35 @@ module Mongoid
         end
       end
 
-      # Defines the getter for the ids of documents in the relation. Should
-      # be specify only for referenced many relations.
+      # Defines the getter for the ids of documents in the association. Should
+      # be specify only for referenced many associations.
       #
-      # @example Set up the ids getter for the relation.
+      # @example Set up the ids getter for the association.
       #   Person.define_ids_getter!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
       def self.define_ids_getter!(association)
         ids_method = "#{association.name.to_s.singularize}_ids"
         association.inverse_class.tap do |klass|
           klass.re_define_method(ids_method) do
-            send(association.name).only(:id).map(&:id)
+            send(association.name).only(:_id).map(&:_id)
           end
         end
       end
 
-      # Defines the setter for the relation. This does a few things based on
+      # Defines the setter for the association. This does a few things based on
       # some conditions. If there is an existing association, a target
-      # substitution will take place, otherwise a new relation will be
+      # substitution will take place, otherwise a new association will be
       # created with the supplied target.
       #
-      # @example Set up the setter for the relation.
+      # @example Set up the setter for the association.
       #   Person.define_setter!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_setter!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -261,15 +328,15 @@ module Mongoid
       end
 
       # Defines the setter method that allows you to set documents
-      # in this relation by their ids. The defined setter, finds
-      # documents with given ids and invokes regular relation setter
+      # in this association by their ids. The defined setter, finds
+      # documents with given ids and invokes regular association setter
       # with found documents. Ids setters should be defined only for
-      # referenced many relations.
+      # referenced many associations.
       #
-      # @example Set up the id_setter for the relation.
+      # @example Set up the id_setter for the association.
       #   Person.define_ids_setter!(association)
       #
-      #  @param [ Association ] association The association for the relation.
+      #  @param [ Association ] association The association for the association.
       #
       #  @return [ Class ] The class being set up.
       def self.define_ids_setter!(association)
@@ -281,17 +348,15 @@ module Mongoid
         end
       end
 
-      # Defines a builder method for an embeds_one relation. This is
+      # Defines a builder method for an embeds_one association. This is
       # defined as #build_name.
       #
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association for the relation.
+      # @param [ Association ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -307,18 +372,16 @@ module Mongoid
         end
       end
 
-      # Defines a creator method for an embeds_one relation. This is
+      # Defines a creator method for an embeds_one association. This is
       # defined as #create_name. After the object is built it will
       # immediately save.
       #
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association for the relation.
+      # @param [ Association ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         name = association.name
         association.inverse_class.tap do |klass|

data/lib/mongoid/association/bindable.rb

@@ -1,8 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
-    # Superclass for all objects that bind relations together.
+    # Superclass for all objects that bind associations together.
     module Bindable
       include Threaded::Lifecycle
 
@@ -16,8 +17,6 @@ module Mongoid
       # @param [ Document ] base The base of the binding.
       # @param [ Document, Array<Document> ] target The target of the binding.
       # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
       def initialize(base, target, association)
         @_base, @_target, @_association = base, target, association
       end
@@ -30,8 +29,6 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
       def binding
         unless _binding?
           _binding do
@@ -52,8 +49,6 @@ module Mongoid
       # @param [ Document ] doc The document getting bound.
       #
       # @raise [ Errors::InverseNotFound ] If no inverse found.
-      #
-      # @since 3.0.0
       def check_inverse!(doc)
         unless _association.bindable?(doc)
           raise Errors::InverseNotFound.new(
@@ -75,8 +70,6 @@ module Mongoid
       #
       # @param [ Document ] keyed The document that stores the foreign key.
       # @param [ Object ] id The id of the bound document.
-      #
-      # @since 3.0.0
       def bind_foreign_key(keyed, id)
         unless keyed.frozen?
           keyed.you_must(_association.foreign_key_setter, id)
@@ -84,7 +77,7 @@ module Mongoid
       end
 
       # Set the type of the related document on the foreign type field, used
-      # when relations are polymorphic.
+      # when associations are polymorphic.
       #
       # @api private
       #
@@ -93,8 +86,6 @@ module Mongoid
       #
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
-      #
-      # @since 3.0.0
       def bind_polymorphic_type(typed, name)
         if _association.type
           typed.you_must(_association.type_setter, name)
@@ -102,7 +93,7 @@ module Mongoid
       end
 
       # Set the type of the related document on the foreign type field, used
-      # when relations are polymorphic.
+      # when associations are polymorphic.
       #
       # @api private
       #
@@ -111,8 +102,6 @@ module Mongoid
       #
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
-      #
-      # @since 3.0.0
       def bind_polymorphic_inverse_type(typed, name)
         if _association.inverse_type
           typed.you_must(_association.inverse_type_setter, name)
@@ -129,15 +118,13 @@ module Mongoid
       #
       # @param [ Document ] doc The base document.
       # @param [ Document ] inverse The inverse document.
-      #
-      # @since 3.0.0
       def bind_inverse(doc, inverse)
         if doc.respond_to?(_association.inverse_setter)
           doc.you_must(_association.inverse_setter, inverse)
         end
       end
 
-      # Bind the provided document with the base from the parent relation.
+      # Bind the provided document with the base from the parent association.
       #
       # @api private
       #
@@ -145,8 +132,6 @@ module Mongoid
       #   binding.bind_from_relational_parent(doc)
       #
       # @param [ Document ] doc The document to bind.
-      #
-      # @since 3.0.0
       def bind_from_relational_parent(doc)
         check_inverse!(doc)
         bind_foreign_key(doc, record_id(_base))
@@ -168,8 +153,6 @@ module Mongoid
       #   binding.set_base_association
       #
       # @return [ true, false ] If the association changed.
-      #
-      # @since 2.4.4
       def set_base_association
         inverse_association = _association.inverse_association(_target)
         if inverse_association != _association && !inverse_association.nil?
@@ -177,7 +160,7 @@ module Mongoid
         end
       end
 
-      # Bind the provided document with the base from the parent relation.
+      # Bind the provided document with the base from the parent association.
       #
       # @api private
       #
@@ -185,8 +168,6 @@ module Mongoid
       #   unbinding.unbind_from_relational_parent(doc)
       #
       # @param [ Document ] doc The document to unbind.
-      #
-      # @since 3.0.0
       def unbind_from_relational_parent(doc)
         check_inverse!(doc)
         bind_foreign_key(doc, nil)

data/lib/mongoid/association/builders.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Mongoid
   module Association
 
     # This module is responsible for defining the build and create methods used
-    # in one to one relations.
+    # in one to one associations.
     #
     # @example Methods that get created.
     #
@@ -16,8 +16,6 @@ module Mongoid
     #   # The following methods get created:
     #   person.build_name({ :first_name => "Durran" })
     #   person.create_name({ :first_name => "Durran" })
-    #
-    # @since 2.0.0.rc.1
     module Builders
       extend ActiveSupport::Concern
 
@@ -32,8 +30,6 @@ module Mongoid
       # @param [ Array ] args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [ args.first || {}, args.size > 1 ? args[1] : {} ]
       end
@@ -43,11 +39,9 @@ module Mongoid
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("build_#{association.name}") do |*args|
@@ -68,11 +62,9 @@ module Mongoid
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("create_#{association.name}") do |*args|

data/lib/mongoid/association/constrainable.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
@@ -8,7 +9,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")
@@ -16,8 +17,6 @@ module Mongoid
       # @param [ Object ] object The object to convert.
       #
       # @return [ Object ] The object cast to the correct type.
-      #
-      # @since 2.0.0.rc.7
       def convert_to_foreign_key(object)
         return convert_polymorphic(object) if polymorphic?
         field = relation_class.fields["_id"]
@@ -31,10 +30,10 @@ module Mongoid
       end
 
       private
-      
+
       def convert_polymorphic(object)
         if object.is_a?(Mongoid::Document)
-          object.id
+          object._id
         else
           BSON::ObjectId.mongoize(object)
         end