mongoid 7.0.13 → 7.1.0.rc0

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'mongoid/association/embedded/embeds_one/binding'
 require 'mongoid/association/embedded/embeds_one/buildable'
 require 'mongoid/association/embedded/embeds_one/proxy'
@@ -58,7 +61,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
@@ -72,7 +75,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.
@@ -92,10 +95,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.
         #
@@ -159,8 +162,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

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

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Association
     module Embedded
@@ -5,9 +8,9 @@ module Mongoid
 
         class Proxy < Association::One
 
-          # The valid options when defining this relation.
+          # The valid options when defining this association.
           #
-          # @return [ Array<Symbol> ] The allowed options when defining this relation.
+          # @return [ Array<Symbol> ] The allowed options when defining this association.
           #
           # @since 7.0
           VALID_OPTIONS = [
@@ -18,13 +21,13 @@ module Mongoid
               :store_as
           ].freeze
 
-          # Instantiate a new embeds_one relation.
+          # Instantiate a new embeds_one association.
           #
           # @example Create the new proxy.
           #   One.new(person, name, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Document ] target The child document in the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Document ] target The child document in the association.
           # @param [ Association ] association The association metadata.
           def initialize(base, target, association)
             init(base, target, association) do
@@ -37,14 +40,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)
@@ -69,24 +72,24 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   relation.binding([ address ])
           #
-          # @return [ Binding ] The relation's binding.
+          # @return [ Binding ] The association's binding.
           #
           # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
 
-          # Are we able to persist this relation?
+          # Are we able to persist this association?
           #
-          # @example Can we persist the relation?
+          # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the relation is persistable.
+          # @return [ true, false ] If the association is persistable.
           #
           # @since 2.1.0
           def persistable?
@@ -95,10 +98,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::EmbedsOne.embedded?
             #
             # @return [ true ] true.

data/lib/mongoid/association/macros.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
-    # This module contains the core macros for defining relations between
-    # documents. They can be either embedded or referenced (relational).
+    # This module contains the core macros for defining associations between
+    # documents. They can be either embedded or referenced.
     module Macros
       extend ActiveSupport::Concern
 
@@ -21,7 +23,7 @@ module Mongoid
       # @example Get the associations.
       #   person.associations
       #
-      # @return [ Hash ] The relations.
+      # @return [ Hash ] The associations.
       #
       # @since 2.3.1
       def associations
@@ -30,12 +32,12 @@ module Mongoid
 
       module ClassMethods
 
-        # Adds the relation back to the parent document. This macro is
+        # Adds the association back to the parent document. This macro is
         # necessary to set the references from the child back to the parent
-        # document. If a child does not define this relation calling
+        # document. If a child does not define this association calling
         # persistence methods on the child object will cause a save to fail.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -47,18 +49,18 @@ module Mongoid
         #     embedded_in :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def embedded_in(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds the relation from a parent document to its children. The name
-        # of the relation needs to be a pluralized form of the child class
+        # Adds the association from a parent document to its children. The name
+        # of the association needs to be a pluralized form of the child class
         # name.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -70,18 +72,18 @@ module Mongoid
         #     embedded_in :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def embeds_many(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds the relation from a parent document to its child. The name
-        # of the relation needs to be a singular form of the child class
+        # Adds the association from a parent document to its child. The name
+        # of the association needs to be a singular form of the child class
         # name.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -93,17 +95,17 @@ module Mongoid
         #     embedded_in :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def embeds_one(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational association from the child Document to a Document in
-        # another database or collection.
+        # Adds a referenced association from the child Document to a Document
+        # in another database or collection.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Game
         #     include Mongoid::Document
@@ -115,17 +117,17 @@ module Mongoid
         #     has_one :game
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def belongs_to(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational association from a parent Document to many
+        # Adds a referenced association from a parent Document to many
         # Documents in another database or collection.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -137,17 +139,17 @@ module Mongoid
         #     belongs_to :person
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def has_many(name, options = {}, &block)
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational many-to-many association between many of this
+        # Adds a referenced many-to-many association between many of this
         # Document and many of another Document.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Person
         #     include Mongoid::Document
@@ -159,8 +161,8 @@ module Mongoid
         #     has_and_belongs_to_many :people
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @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
@@ -168,10 +170,10 @@ module Mongoid
           define_association!(__method__, name, options, &block)
         end
 
-        # Adds a relational association from the child Document to a Document in
-        # another database or collection.
+        # Adds a referenced association from the child Document to a Document
+        # in another database or collection.
         #
-        # @example Define the relation.
+        # @example Define the association.
         #
         #   class Game
         #     include Mongoid::Document
@@ -183,8 +185,8 @@ module Mongoid
         #     has_one :game
         #   end
         #
-        # @param [ Symbol ] name The name of the relation.
-        # @param [ Hash ] options The relation options.
+        # @param [ Symbol ] name The name of the association.
+        # @param [ Hash ] options The association options.
         # @param [ Proc ] block Optional block for defining extensions.
         def has_one(name, options = {}, &block)
           define_association!(__method__, name, options, &block)

data/lib/mongoid/association/many.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Association
 
-    # This is the superclass for all many to one and many to many relation
+    # This is the superclass for all many to one and many to many association
     # proxies.
     class Many < Association::Proxy
       include ::Enumerable
@@ -10,19 +12,19 @@ module Mongoid
       delegate :avg, :max, :min, :sum, to: :criteria
       delegate :length, :size, to: :_target
 
-      # Is the relation empty?
+      # Is the association empty?
       #
-      # @example Is the relation empty??
+      # @example Is the association empty??
       #   person.addresses.blank?
       #
-      # @return [ true, false ] If the relation is empty or not.
+      # @return [ true, false ] If the association is empty or not.
       #
       # @since 2.1.0
       def blank?
         size == 0
       end
 
-      # Creates a new document on the references many relation. This will
+      # Creates a new document on the references many association. This will
       # save the document if the parent has been persisted.
       #
       # @example Create and save the new document.
@@ -45,7 +47,7 @@ module Mongoid
         end
       end
 
-      # Creates a new document on the references many relation. This will
+      # Creates a new document on the references many association. This will
       # save the document if the parent has been persisted and will raise an
       # error if validation fails.
       #
@@ -142,9 +144,9 @@ module Mongoid
           klass.respond_to?(name, include_private) || super
       end
 
-      # This is public access to the relation's criteria.
+      # This is public access to the association's criteria.
       #
-      # @example Get the scoped relation.
+      # @example Get the scoped association.
       #   relation.scoped
       #
       # @return [ Criteria ] The scoped criteria.
@@ -163,7 +165,7 @@ module Mongoid
       #
       # @param [ Hash ] options The options to pass.
       #
-      # @option options [ Symbol ] :include What relations to include
+      # @option options [ Symbol ] :include What associations to include
       # @option options [ Symbol ] :only Limit the fields to only these.
       # @option options [ Symbol ] :except Dont include these fields.
       #