mongoid 7.3.2 → 7.4.0

data/lib/mongoid/fields/foreign_key.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Fields
@@ -18,8 +17,6 @@ module Mongoid
       # @param [ Hash ] mods The current modifications.
       # @param [ Array ] new_elements The new elements to add.
       # @param [ Array ] old_elements The old elements getting removed.
-      #
-      # @since 2.4.0
       def add_atomic_changes(document, name, key, mods, new_elements, old_elements)
         old = (old_elements || [])
         new = (new_elements || [])
@@ -47,8 +44,6 @@ module Mongoid
       #   field.foreign_key?
       #
       # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
       def foreign_key?
         true
       end
@@ -61,8 +56,6 @@ module Mongoid
       # @param [ Object ] object The object to evolve.
       #
       # @return [ Object ] The evolved object.
-      #
-      # @since 3.0.0
       def evolve(object)
         if object_id_field? || object.is_a?(Document)
           if association.polymorphic?
@@ -81,8 +74,6 @@ module Mongoid
       #   field.lazy?
       #
       # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
       def lazy?
         type.resizable?
       end
@@ -95,8 +86,6 @@ module Mongoid
       # @param [ Object ] object The object to Mongoize.
       #
       # @return [ Object ] The mongoized object.
-      #
-      # @since 3.0.0
       def mongoize(object)
         if type.resizable? || object_id_field?
           type.__mongoize_fk__(association, object)
@@ -111,8 +100,6 @@ module Mongoid
       #   field.object_id_field?
       #
       # @return [ true, false ] If the field is a BSON::ObjectId.
-      #
-      # @since 2.2.0
       def object_id_field?
         @object_id_field ||=
             association.polymorphic? ? true : association.klass.using_object_ids?
@@ -124,8 +111,6 @@ module Mongoid
       #   field.resizable?
       #
       # @return [ true, false ] If the field is resizable.
-      #
-      # @since 3.0.2
       def resizable?
         type.resizable?
       end
@@ -141,8 +126,6 @@ module Mongoid
       # @param [ Document ] doc The document.
       #
       # @return [ Object ] The called proc.
-      #
-      # @since 3.0.0
       def evaluate_default_proc(doc)
         serialize_default(default_val[])
       end
@@ -155,8 +138,6 @@ module Mongoid
       #   field.related_id_field
       #
       # @return [ Fields::Standard ] The field.
-      #
-      # @since 3.0.0
       def related_id_field
         @related_id_field ||= association.klass.fields["_id"]
       end
@@ -172,8 +153,6 @@ module Mongoid
       # @param [ Object ] object The default.
       #
       # @return [ Object ] The serialized default.
-      #
-      # @since 3.0.0
       def serialize_default(object); object; end
     end
   end

data/lib/mongoid/fields/localized.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Fields
@@ -14,8 +13,6 @@ module Mongoid
       # @param [ Hash ] object The hash of translations.
       #
       # @return [ Object ] The value for the current locale.
-      #
-      # @since 2.3.0
       def demongoize(object)
         if object
           type.demongoize(lookup(object))
@@ -28,8 +25,6 @@ module Mongoid
       #   field.localized?
       #
       # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
       def localized?
         true
       end
@@ -42,8 +37,6 @@ module Mongoid
       # @param [ String ] object The string to convert.
       #
       # @return [ Hash ] The locale with string translation.
-      #
-      # @since 2.3.0
       def mongoize(object)
         { ::I18n.locale.to_s => type.mongoize(object) }
       end
@@ -58,8 +51,6 @@ module Mongoid
       #   field.fallbacks?
       #
       # @return [ true, false ] If fallbacks should be used.
-      #
-      # @since 5.1.0
       def fallbacks?
         return true if options[:fallbacks].nil?
         !!options[:fallbacks]
@@ -75,8 +66,6 @@ module Mongoid
       # @param [ Hash ] object The localized object.
       #
       # @return [ Object ] The object for the locale.
-      #
-      # @since 3.0.0
       def lookup(object)
         locale = ::I18n.locale
 

data/lib/mongoid/fields/standard.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Fields
@@ -23,8 +22,6 @@ module Mongoid
       # @param [ Hash ] mods The current modifications.
       # @param [ Array ] new The new elements to add.
       # @param [ Array ] old The old elements getting removed.
-      #
-      # @since 2.4.0
       def add_atomic_changes(document, name, key, mods, new, old)
         mods[key] = new
       end
@@ -38,8 +35,6 @@ module Mongoid
       # @param [ Document ] doc The document the field belongs to.
       #
       # @return [ Object ] The serialized default value.
-      #
-      # @since 2.1.8
       def eval_default(doc)
         if fields = doc.__selected_fields
           evaluated_default(doc) if included?(fields)
@@ -54,8 +49,6 @@ module Mongoid
       #   field.foreign_key?
       #
       # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
       def foreign_key?
         false
       end
@@ -70,8 +63,6 @@ module Mongoid
       # @option options [ Class ] :type The class of the field.
       # @option options [ Object ] :default The default value for the field.
       # @option options [ String ] :label The field's label.
-      #
-      # @since 3.0.0
       def initialize(name, options = {})
         @name = name
         @options = options
@@ -92,8 +83,6 @@ module Mongoid
       #   field.lazy?
       #
       # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
       def lazy?
         false
       end
@@ -104,8 +93,6 @@ module Mongoid
       #   field.localized?
       #
       # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
       def localized?
         false
       end
@@ -116,8 +103,6 @@ module Mongoid
       #   field.metadata
       #
       # @return [ Metadata ] The association metadata.
-      #
-      # @since 2.2.0
       def association
         @association ||= options[:association]
       end
@@ -128,8 +113,6 @@ module Mongoid
       #   field.object_id_field?
       #
       # @return [ true, false ] If the field is a BSON::ObjectId.
-      #
-      # @since 2.2.0
       def object_id_field?
         @object_id_field ||= (type == BSON::ObjectId)
       end
@@ -140,8 +123,6 @@ module Mongoid
       #   field.pre_processed?
       #
       # @return [ true, false ] If the field's default is pre-processed.
-      #
-      # @since 3.0.0
       def pre_processed?
         @pre_processed ||=
           (options[:pre_processed] || (default_val && !default_val.is_a?(::Proc)))
@@ -153,8 +134,6 @@ module Mongoid
       #   field.type
       #
       # @return [ Class ] The name of the class.
-      #
-      # @since 2.1.0
       def type
         @type ||= options[:type] || Object
       end
@@ -169,8 +148,6 @@ module Mongoid
       #   field.default_name
       #
       # @return [ String ] The method name.
-      #
-      # @since 3.0.0
       def default_name
         @default_name ||= "__#{name}_default__"
       end
@@ -186,8 +163,6 @@ module Mongoid
       #
       # @param [ Class, Module ] object The class or module the field is
       #   defined on.
-      #
-      # @since 3.0.0
       def define_default_method(object)
         object.__send__(:define_method, default_name, default_val)
       end
@@ -203,8 +178,6 @@ module Mongoid
       # @param [ Hash ] fields The field limitations.
       #
       # @return [ true, false ] If the field was included.
-      #
-      # @since 2.4.4
       def included?(fields)
         (fields.values.first == 1 && fields[name.to_s] == 1) ||
           (fields.values.first == 0 && !fields.has_key?(name.to_s))
@@ -218,8 +191,6 @@ module Mongoid
       # @param [ Document ] doc The doc being applied to.
       #
       # @return [ Object ] The default value.
-      #
-      # @since 2.4.4
       def evaluated_default(doc)
         if default_val.respond_to?(:call)
           evaluate_default_proc(doc)
@@ -237,8 +208,6 @@ module Mongoid
       # @param [ Document ] doc The document.
       #
       # @return [ Object ] The called proc.
-      #
-      # @since 3.0.0
       def evaluate_default_proc(doc)
         serialize_default(doc.__send__(default_name))
       end
@@ -254,8 +223,6 @@ module Mongoid
       # @param [ Object ] object The default.
       #
       # @return [ Object ] The serialized default.
-      #
-      # @since 3.0.0
       def serialize_default(object)
         mongoize(object)
       end

data/lib/mongoid/fields/validators/macro.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Fields
@@ -10,8 +9,6 @@ module Mongoid
         extend self
 
         # The warning message to give when a field is of type Symbol.
-        #
-        # @since 7.0.0
         FIELD_TYPE_IS_SYMBOL = 'The BSON symbol type is deprecated; use String instead'.freeze
 
         OPTIONS = [
@@ -36,8 +33,6 @@ module Mongoid
         # @param [ Class ] klass The model class.
         # @param [ Symbol ] name The field name.
         # @param [ Hash ] options The provided options.
-        #
-        # @since 3.0.0
         def validate(klass, name, options)
           validate_field_name(klass, name)
           validate_name_uniqueness(klass, name, options)
@@ -52,8 +47,6 @@ module Mongoid
         # @param [ Class ] klass The model class.
         # @param [ Symbol ] name The field name.
         # @param [ Hash ] options The provided options.
-        #
-        # @since 6.0.0
         def validate_relation(klass, name, options = {})
           [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
             if Mongoid.destructive_fields.include?(n)
@@ -117,8 +110,6 @@ module Mongoid
         # @param [ Hash ] options The provided options.
         #
         # @raise [ Errors::InvalidFieldOption ] If an option is invalid.
-        #
-        # @since 3.0.0
         def validate_options(klass, name, options)
           options.keys.each do |option|
             if !OPTIONS.include?(option) && !Fields.options.include?(option)

data/lib/mongoid/fields/validators.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/fields/validators/macro"

data/lib/mongoid/fields.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/fields/standard"
 require "mongoid/fields/foreign_key"
@@ -16,8 +15,6 @@ module Mongoid
     Boolean = Mongoid::Boolean
 
     # For fields defined with symbols use the correct class.
-    #
-    # @since 4.0.0
     TYPE_MAPPINGS = {
       array: Array,
       big_decimal: BigDecimal,
@@ -79,6 +76,42 @@ module Mongoid
         end
         nil
       end
+
+      # Removes the _translations from the given field name. This is done only
+      # when there doesn't already exist a field name or relation with the
+      # same name (i.e. with the _translations suffix). This check for an
+      # existing field is done recursively
+      #
+      # @param [ String | Symbol ] name The name of the field to cleanse.
+      #
+      # @return [ Field ] The field name without _translations
+      def cleanse_localized_field_names(name)
+        name = database_field_name(name.to_s)
+
+        klass = self
+        [].tap do |res|
+          ar = name.split('.')
+          ar.each_with_index do |fn, i|
+            key = fn
+            unless klass.fields.key?(fn) || klass.relations.key?(fn)
+              if tr = fn.match(/(.*)_translations\z/)&.captures&.first
+                key = tr
+              else
+                key = fn
+              end
+
+            end
+            res.push(key)
+
+            if klass.fields.key?(fn)
+              res.push(ar.drop(i+1).join('.')) unless i == ar.length - 1
+              break
+            elsif klass.relations.key?(fn)
+              klass = klass.relations[key].klass
+            end
+          end
+        end.join('.')
+      end
     end
 
     included do
@@ -110,8 +143,6 @@ module Mongoid
     #   model.apply_pre_processed_defaults
     #
     # @return [ Array<String ] The names of the non-proc defaults.
-    #
-    # @since 2.4.0
     def apply_pre_processed_defaults
       pre_processed_defaults.each do |name|
         apply_default(name)
@@ -124,8 +155,6 @@ module Mongoid
     #   model.apply_post_processed_defaults
     #
     # @return [ Array<String ] The names of the proc defaults.
-    #
-    # @since 2.4.0
     def apply_post_processed_defaults
       post_processed_defaults.each do |name|
         apply_default(name)
@@ -138,8 +167,6 @@ module Mongoid
     #   model.apply_default("name")
     #
     # @param [ String ] name The name of the field.
-    #
-    # @since 2.4.0
     def apply_default(name)
       unless attributes.key?(name)
         if field = fields[name]
@@ -156,8 +183,6 @@ module Mongoid
     #
     # @example Apply all the defaults.
     #   model.apply_defaults
-    #
-    # @since 2.4.0
     def apply_defaults
       apply_pre_processed_defaults
       apply_post_processed_defaults
@@ -169,11 +194,9 @@ module Mongoid
     # method to automatically wrap params in JSON requests.
     #
     # @example Get the field names
-    #   docment.attribute_names
+    #   document.attribute_names
     #
     # @return [ Array<String> ] The field names
-    #
-    # @since 3.0.0
     def attribute_names
       self.class.attribute_names
     end
@@ -187,8 +210,6 @@ module Mongoid
     # @param [ String, Symbol ] name The name to get.
     #
     # @return [ String ] The name of the field as it's stored in the db.
-    #
-    # @since 3.0.7
     def database_field_name(name)
       self.class.database_field_name(name)
     end
@@ -202,8 +223,6 @@ module Mongoid
     # @param [ Object ] value The current value.
     #
     # @return [ true, false ] If we set the field lazily.
-    #
-    # @since 3.1.0
     def lazy_settable?(field, value)
       !frozen? && value.nil? && field.lazy?
     end
@@ -225,7 +244,7 @@ module Mongoid
       # Stores the provided block to be run when the option name specified is
       # defined on a field.
       #
-      # No assumptions are made about what sort of work the handler might
+      # No assumptions are made about what functionality the handler might
       # perform, so it will always be called if the `option_name` key is
       # provided in the field definition -- even if it is false or nil.
       #
@@ -237,8 +256,6 @@ module Mongoid
       # @param [ Symbol ] option_name the option name to match against
       # @param [ Proc ] block the handler to execute when the option is
       #   provided.
-      #
-      # @since 2.1.0
       def option(option_name, &block)
         options[option_name] = block
       end
@@ -250,8 +267,6 @@ module Mongoid
       #   # => { :required => #<Proc:0x00000100976b38> }
       #
       # @return [ Hash ] the option map
-      #
-      # @since 2.1.0
       def options
         @options ||= {}
       end
@@ -268,27 +283,43 @@ module Mongoid
       #   Model.attribute_names
       #
       # @return [ Array<String> ] The field names
-      #
-      # @since 3.0.0
       def attribute_names
         fields.keys
       end
 
       # Get the name of the provided field as it is stored in the database.
-      # Used in determining if the field is aliased or not.
+      # Used in determining if the field is aliased or not. Recursively
+      # finds aliases for embedded documents and fields, delimited with
+      # period "." character.
       #
-      # @example Get the database field name.
+      # @example Get the database field name of a field.
       #   Model.database_field_name(:authorization)
       #
-      # @param [ String, Symbol ] name The name to get.
+      # @example Get the database field name of an embedded field.
+      #   Model.database_field_name('customers.addresses.city')
       #
-      # @return [ String ] The name of the field as it's stored in the db.
+      # @param [ String, Symbol ] name The name to get.
       #
-      # @since 3.0.7
+      # @return [ String ] The name of the field as stored in the database.
       def database_field_name(name)
-        return nil unless name
-        normalized = name.to_s
-        aliased_fields[normalized] || normalized
+        if Mongoid.broken_alias_handling
+          return nil unless name
+          normalized = name.to_s
+          aliased_fields[normalized] || normalized
+        else
+          return nil unless name.present?
+          key = name.to_s
+          segment, remaining = key.split('.', 2)
+          segment = aliased_fields[segment]&.dup || segment
+          return segment unless remaining
+
+          relation = relations[aliased_associations[segment] || segment]
+          if relation
+            "#{segment}.#{relation.klass.database_field_name(remaining)}"
+          else
+            "#{segment}.#{remaining}"
+          end
+        end
       end
 
       # Defines all the fields that are accessible on the Document
@@ -325,8 +356,6 @@ module Mongoid
       # @param [ Class ] type The new type of field.
       #
       # @return [ Serializable ] The new field.
-      #
-      # @since 2.1.0
       def replace_field(name, type)
         remove_defaults(name)
         add_field(name, fields[name].options.merge(type: type))
@@ -339,8 +368,6 @@ module Mongoid
       #   person.using_object_ids?
       #
       # @return [ true, false ] If the class uses BSON::ObjectIds for the id.
-      #
-      # @since 1.0.0
       def using_object_ids?
         fields["_id"].object_id_field?
       end
@@ -354,8 +381,6 @@ module Mongoid
       #   Model.add_defaults(field)
       #
       # @param [ Field ] field The field to add for.
-      #
-      # @since 2.4.0
       def add_defaults(field)
         default, name = field.default_val, field.name.to_s
         remove_defaults(name)
@@ -424,8 +449,6 @@ module Mongoid
       # @param [ Symbol ] name The name of the field.
       # @param [ Symbol ] meth The name of the accessor.
       # @param [ Hash ] options The options.
-      #
-      # @since 2.0.0
       def create_accessors(name, meth, options = {})
         field = fields[name]
 
@@ -449,8 +472,6 @@ module Mongoid
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
       # @param [ Field ] field The field.
-      #
-      # @since 2.4.0
       def create_field_getter(name, meth, field)
         generated_methods.module_eval do
           re_define_method(meth) do
@@ -475,8 +496,6 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
-      #
-      # @since 3.1.0
       def create_field_getter_before_type_cast(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_before_type_cast") do
@@ -497,8 +516,6 @@ module Mongoid
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
       # @param [ Field ] field The field.
-      #
-      # @since 2.4.0
       def create_field_setter(name, meth, field)
         generated_methods.module_eval do
           re_define_method("#{meth}=") do |value|
@@ -518,8 +535,6 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
-      #
-      # @since 2.4.0
       def create_field_check(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}?") do
@@ -536,8 +551,6 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
-      #
-      # @since 2.4.0
       def create_translations_getter(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations") do
@@ -556,8 +569,6 @@ module Mongoid
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
       # @param [ Field ] field The field.
-      #
-      # @since 2.4.0
       def create_translations_setter(name, meth, field)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations=") do |value|
@@ -579,8 +590,6 @@ module Mongoid
       #   Person.generated_methods
       #
       # @return [ Module ] The module of generated methods.
-      #
-      # @since 2.0.0
       def generated_methods
         @generated_methods ||= begin
           mod = Module.new
@@ -595,8 +604,6 @@ module Mongoid
       #   Model.remove_defaults(name)
       #
       # @param [ String ] name The field name.
-      #
-      # @since 2.4.0
       def remove_defaults(name)
         pre_processed_defaults.delete_one(name)
         post_processed_defaults.delete_one(name)

data/lib/mongoid/findable.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
   # This module defines the finder methods that hang off the document at the
   # class level.
-  #
-  # @since 4.0.0
   module Findable
     extend Forwardable
 
@@ -149,8 +146,6 @@ module Mongoid
     # and Mongoid.raise_not_found_error is true.
     #
     # @return [ Document, nil ] A matching document.
-    #
-    # @since 3.0.0
     def find_by(attrs = {})
       result = where(attrs).find_first
       if result.nil? && Mongoid.raise_not_found_error