mongoid 7.3.5 → 7.4.0

data/lib/mongoid/association/referenced/has_one.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/referenced/has_one/binding'
 require 'mongoid/association/referenced/has_one/buildable'
@@ -11,8 +10,6 @@ module Mongoid
     module Referenced
 
       # The has_one association.
-      #
-      # @since 7.0
       class HasOne
         include Relatable
         include Buildable
@@ -21,37 +18,30 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :as,
             :autobuild,
             :autosave,
             :dependent,
             :foreign_key,
-            :primary_key
+            :primary_key,
+            :scope,
         ].freeze
 
         # The complete list of valid options for this association, including
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # The default foreign key suffix.
         #
         # @return [ String ] '_id'
-        #
-        # @since 7.0
         FOREIGN_KEY_SUFFIX = '_id'.freeze
 
         # The list of association complements.
         #
         # @return [ Array<Association> ] The association complements.
-        #
-        # @since 7.0
         def relation_complements
           @relation_complements ||= [ Referenced::BelongsTo ].freeze
         end
@@ -59,8 +49,6 @@ module Mongoid
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           self
@@ -70,8 +58,6 @@ module Mongoid
         #
         # @return [ String ] The foreign key field for saving the
         #   association reference.
-        #
-        # @since 7.0
         def foreign_key
           @foreign_key ||= @options[:foreign_key] ? @options[:foreign_key].to_s :
                              default_foreign_key_field
@@ -80,22 +66,16 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def embedded?; false; end
 
         # The default for validation the association object.
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def validation_default; true; end
 
         # Get the association proxy class for this association type.
         #
         # @return [ Association::HasOne::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -106,8 +86,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::Many ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::One.new(self, attributes, options)
         end
@@ -115,8 +93,6 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           @polymorphic ||= !!as
         end
@@ -126,8 +102,6 @@ module Mongoid
         # @note Only relevant for polymorphic associations.
         #
         # @return [ String, nil ] The type field.
-        #
-        # @since 7.0
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -152,19 +126,22 @@ module Mongoid
         # @param [ Document ] document The document to calculate on.
         #
         # @return [ Root ] The root atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Root.new(document)
         end
 
+        # Get the scope to be applied when querying the association.
+        #
+        # @return [ Proc | Symbol | nil ] The association scope, if any.
+        def scope
+          @options[:scope]
+        end
+
         private
 
         # Setup the instance methods on the class having this association type.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup_instance_methods!
           define_getter!
           define_setter!

data/lib/mongoid/association/referenced/syncable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -18,8 +17,6 @@ module Mongoid
         # @param [ Association ] association The association metadata.
         #
         # @return [ true, false ] If we can sync.
-        #
-        # @since 2.1.0
         def _syncable?(association)
           !_synced?(association.foreign_key) && send(association.foreign_key_check)
         end
@@ -30,8 +27,6 @@ module Mongoid
         #   document._synced
         #
         # @return [ Hash ] The synced foreign keys.
-        #
-        # @since 2.1.0
         def _synced
           @_synced ||= {}
         end
@@ -44,8 +39,6 @@ module Mongoid
         # @param [ String ] foreign_key The foreign key.
         #
         # @return [ true, false ] If we can sync.
-        #
-        # @since 2.1.0
         def _synced?(foreign_key)
           !!_synced[foreign_key]
         end
@@ -58,8 +51,6 @@ module Mongoid
         # @param [ Association ] association The association.
         #
         # @return [ Object ] The updated values.
-        #
-        # @since 2.2.1
         def remove_inverse_keys(association)
           foreign_keys = send(association.foreign_key)
           unless foreign_keys.nil? || foreign_keys.empty?
@@ -75,8 +66,6 @@ module Mongoid
         # @param [ Association ] association The document association.
         #
         # @return [ Object ] The updated values.
-        #
-        # @since 2.1.0
         def update_inverse_keys(association)
           if changes.has_key?(association.foreign_key)
             old, new = changes[association.foreign_key]
@@ -110,8 +99,6 @@ module Mongoid
           #   Person._synced(association)
           #
           # @param [ Association ] association The association metadata.
-          #
-          # @since 2.1.0
           def _synced(association)
             unless association.forced_nil_inverse?
               synced_save(association)
@@ -133,8 +120,6 @@ module Mongoid
           # @param [ Association ] association The association metadata.
           #
           # @return [ Class ] The class getting set up.
-          #
-          # @since 2.1.0
           def synced_save(association)
             set_callback(
                 :save,
@@ -154,8 +139,6 @@ module Mongoid
           # @param [ Association ] association The association metadata.
           #
           # @return [ Class ] The class getting set up.
-          #
-          # @since 2.2.1
           def synced_destroy(association)
             set_callback(
                 :destroy,

data/lib/mongoid/association/referenced.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/referenced/auto_save'
 require 'mongoid/association/referenced/counter_cache'

data/lib/mongoid/association/reflections.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association

data/lib/mongoid/association/relatable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
@@ -8,8 +7,6 @@ module Mongoid
   module Association
 
     # This module provides behaviors shared between Association types.
-    #
-    # @since 7.0
     module Relatable
       include Constrainable
       include Options
@@ -17,8 +14,6 @@ module Mongoid
       # The options shared between all association types.
       #
       # @return [ Array<Symbol> ] The shared options.
-      #
-      # @since 7.0
       SHARED_OPTIONS = [
                          :class_name,
                          :inverse_of,
@@ -29,22 +24,16 @@ module Mongoid
       # The primary key default.
       #
       # @return [ String ] The primary key field default.
-      #
-      # @since 7.0
       PRIMARY_KEY_DEFAULT = '_id'.freeze
 
       # The name of the association.
       #
       # @return [ Symbol ] The name of the association.
-      #
-      # @since 7.0
       attr_reader :name
 
       # The options on this association.
       #
       # @return [ Hash ] The options.
-      #
-      # @since 7.0
       attr_reader :options
 
       # Initialize the Association.
@@ -53,8 +42,6 @@ module Mongoid
       # @param [ Symbol ] name The name of the association.
       # @param [ Hash ] opts The association options.
       # @param [ Block ] block The optional block.
-      #
-      # @since 7.0
       def initialize(_class, name, opts = {}, &block)
         @owner_class = _class
         @name = name
@@ -71,8 +58,6 @@ module Mongoid
       # Compare this association to another.
       #
       # @return [ Object ] The object to compare to this association.
-      #
-      # @since 7.0
       def ==(other)
         relation_class_name == other.relation_class_name &&
           inverse_class_name == other.inverse_class_name &&
@@ -86,8 +71,6 @@ module Mongoid
       #
       # @return [ Array<Proc, Symbol> ] A list of the callbacks, either method
       #   names or Procs.
-      #
-      # @since 7.0
       def get_callbacks(callback_type)
         Array(options[callback_type])
       end
@@ -96,8 +79,6 @@ module Mongoid
       # @note Only relevant for polymorphic associations that take the :as option.
       #
       # @return [ String ] The type setter method.
-      #
-      # @since 7.0
       def type_setter
         @type_setter ||= type.__setter__
       end
@@ -108,8 +89,6 @@ module Mongoid
       # @param [ Document ] doc The document to be bound.
       #
       # @return [ true, false ] Whether the document can be bound.
-      #
-      # @since 7.0
       def bindable?(doc); false; end
 
       # Get the inverse names.
@@ -118,8 +97,6 @@ module Mongoid
       #   determining inverses.
       #
       # @return [ Array<Symbol> ] The list of inverse names.
-      #
-      # @since 7.0
       def inverses(other = nil)
         return [ inverse_of ] if inverse_of
         return [] if @options.key?(:inverse_of) && !inverse_of
@@ -137,8 +114,6 @@ module Mongoid
       #   determining inverses.
       #
       # @return [ Association ] The inverse's association metadata.
-      #
-      # @since 7.0
       def inverse_association(other = nil)
         (other || relation_class).relations[inverse(other)]
       end
@@ -146,8 +121,6 @@ module Mongoid
       # Get the inverse type.
       #
       # @return [ nil ] Default is nil for an association.
-      #
-      # @since 7.0
       def inverse_type; end
 
       # The class name, possibly unqualified or :: prefixed, of the association
@@ -171,8 +144,6 @@ module Mongoid
       #   the +relation_class+ method.
       #
       # @return [ String ] The association objects' class name.
-      #
-      # @since 7.0
       def relation_class_name
         @class_name ||= @options[:class_name] || ActiveSupport::Inflector.classify(name)
       end
@@ -192,8 +163,6 @@ module Mongoid
       # happen to be defined with the same name as the association name).
       #
       # @return [ String ] The association objects' class.
-      #
-      # @since 7.0
       def relation_class
         @klass ||= begin
           cls_name = @options[:class_name] || ActiveSupport::Inflector.classify(name)
@@ -205,8 +174,6 @@ module Mongoid
       # The class name of the object owning this association.
       #
       # @return [ String ] The owning objects' class name.
-      #
-      # @since 7.0
       def inverse_class_name
         @inverse_class_name ||= @owner_class.name
       end
@@ -214,8 +181,6 @@ module Mongoid
       # The class of the object owning this association.
       #
       # @return [ String ] The owning objects' class.
-      #
-      # @since 7.0
       def inverse_class
         @owner_class
       end
@@ -225,8 +190,6 @@ module Mongoid
       # Otherwise, the primary key.
       #
       # @return [ Symbol, String ] The primary key.
-      #
-      # @since 7.0
       def key
         stores_foreign_key? ? foreign_key : primary_key
       end
@@ -234,8 +197,6 @@ module Mongoid
       # The name of the setter on this object for assigning an associated object.
       #
       # @return [ String ] The setter name.
-      #
-      # @since 7.0
       def setter
         @setter ||= "#{name}="
       end
@@ -243,8 +204,6 @@ module Mongoid
       # The name of the inverse setter method.
       #
       # @return [ String ] The name of the inverse setter.
-      #
-      # @since 7.0
       def inverse_setter(other = nil)
         @inverse_setter ||= "#{inverses(other).first}=" unless inverses(other).blank?
       end
@@ -252,8 +211,6 @@ module Mongoid
       # The name of the foreign key setter method.
       #
       # @return [ String ] The name of the foreign key setter.
-      #
-      # @since 7.0
       def foreign_key_setter
         # note: You can't check if this association stores foreign key
         # See HasOne and HasMany binding, they referenced foreign_key_setter
@@ -263,8 +220,6 @@ module Mongoid
       # The atomic path for this association.
       #
       # @return [  Mongoid::Atomic::Paths::Root ] The atomic path object.
-      #
-      # @since 7.0
       def path(document)
         relation.path(document)
       end
@@ -276,8 +231,6 @@ module Mongoid
       #   association.inverse_type_setter
       #
       # @return [ String ] The name of the setter.
-      #
-      # @since 7.0
       def inverse_type_setter
         @inverse_type_setter ||= inverse_type.__setter__
       end
@@ -288,8 +241,6 @@ module Mongoid
       #   association.foreign_key_check
       #
       # @return [ String ] The foreign key check.
-      #
-      # @since 7.0
       def foreign_key_check
         @foreign_key_check ||= "#{foreign_key}_changed?" if (stores_foreign_key? && foreign_key)
       end
@@ -301,8 +252,6 @@ module Mongoid
       #   association.
       #
       # @return [ Proxy ]
-      #
-      # @since 7.0
       def create_relation(owner, target)
         relation.new(owner, target, self)
       end
@@ -310,8 +259,6 @@ module Mongoid
       # Whether the dependent method is destructive.
       #
       # @return [ true, false ] If the dependent method is destructive.
-      #
-      # @since 7.0
       def destructive?
         @destructive ||= !!(dependent && (dependent == :delete_all || dependent == :destroy))
       end
@@ -319,8 +266,6 @@ module Mongoid
       # Get the counter cache column name.
       #
       # @return [ String ] The counter cache column name.
-      #
-      # @since 7.0
       def counter_cache_column_name
         @counter_cache_column_name ||= (@options[:counter_cache].is_a?(String) ||
             @options[:counter_cache].is_a?(Symbol)) ?
@@ -330,8 +275,6 @@ module Mongoid
       # Get the extension.
       #
       # @return [ Module ] The extension module, if one has been defined.
-      #
-      # @since 7.0
       def extension
         @extension ||= @options[:extend]
       end
@@ -339,8 +282,6 @@ module Mongoid
       # Get the inverse name.
       #
       # @return [ Symbol ] The inverse name.
-      #
-      # @since 7.0
       def inverse(other = nil)
         candidates = inverses(other)
         candidates.detect { |c| c } if candidates
@@ -350,8 +291,6 @@ module Mongoid
       #
       # @return [ true, false ] If the associated object(s)
       #   should be validated.
-      #
-      # @since 7.0
       def validate?
         @validate ||= if @options[:validate].nil?
                         validation_default

data/lib/mongoid/association.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/accessors'
 require 'mongoid/association/builders'
@@ -34,8 +33,6 @@ module Mongoid
     # Map the macros to their corresponding Association classes.
     #
     # @return [ Hash ] The mapping from macros to their Association class.
-    #
-    # @since 7.0
     MACRO_MAPPING = {
         embeds_one: Association::Embedded::EmbedsOne,
         embeds_many: Association::Embedded::EmbedsMany,
@@ -60,8 +57,6 @@ module Mongoid
     #   address.embedded?
     #
     # @return [ true, false ] True if the document has a parent document.
-    #
-    # @since 2.0.0.rc.1
     def embedded?
       @embedded ||= (cyclic ? _parent.present? : self.class.embedded?)
     end
@@ -72,8 +67,6 @@ module Mongoid
     #   address.embedded_many?
     #
     # @return [ true, false ] True if in an embeds many.
-    #
-    # @since 2.0.0.rc.1
     def embedded_many?
       _association && _association.is_a?(Association::Embedded::EmbedsMany)
     end
@@ -84,8 +77,6 @@ module Mongoid
     #   address.embedded_one?
     #
     # @return [ true, false ] True if in an embeds one.
-    #
-    # @since 2.0.0.rc.1
     def embedded_one?
       _association && _association.is_a?(Association::Embedded::EmbedsOne)
     end
@@ -99,8 +90,6 @@ module Mongoid
     # @raise [ Errors::NoMetadata ] If no association metadata is present.
     #
     # @return [ Symbol ] The association name.
-    #
-    # @since 3.0.0
     def association_name
       raise Errors::NoMetadata.new(self.class.name) unless _association
       _association.name
@@ -112,8 +101,6 @@ module Mongoid
     #   post.referenced_many?
     #
     # @return [ true, false ] True if in a references many.
-    #
-    # @since 2.0.0.rc.1
     def referenced_many?
       _association && _association.is_a?(Association::Referenced::HasMany)
     end
@@ -124,8 +111,6 @@ module Mongoid
     #   address.referenced_one?
     #
     # @return [ true, false ] True if in a references one.
-    #
-    # @since 2.0.0.rc.1
     def referenced_one?
       _association && _association.is_a?(Association::Referenced::HasOne)
     end
@@ -137,8 +122,6 @@ module Mongoid
     #   document.reload_relations
     #
     # @return [ Hash ] The association metadata.
-    #
-    # @since 2.1.6
     def reload_relations
       relations.each_pair do |name, meta|
         if instance_variable_defined?("@_#{name}")