mongoid 7.2.1 → 9.0.0

data/lib/mongoid/fields/foreign_key.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Fields
+
+    # Represents a BSON document field definition which stores
+    # a foreign key that references the ID of another document.
+    # Used for association behavior.
     class ForeignKey < Standard
 
       # Adds the atomic changes for this type of resizable field.
@@ -10,7 +14,7 @@ module Mongoid
       # @example Add the atomic changes.
       #   field.add_atomic_changes(doc, "key", {}, [], [])
       #
-      # @todo: Durran: Refactor, big time.
+      # @todo: Refactor, big time.
       #
       # @param [ Document ] document The document to add to.
       # @param [ String ] name The name of the field.
@@ -18,8 +22,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 || [])
@@ -46,9 +48,7 @@ module Mongoid
       # @example Is the field a foreign key?
       #   field.foreign_key?
       #
-      # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
+      # @return [ true | false ] If the field is a foreign key.
       def foreign_key?
         true
       end
@@ -61,12 +61,12 @@ 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?
             association.convert_to_foreign_key(object)
+          elsif object.is_a?(Document) && object.respond_to?(association.primary_key)
+            primary_key_field.evolve(object.send(association.primary_key))
           else
             object.__evolve_object_id__
           end
@@ -80,9 +80,7 @@ module Mongoid
       # @example Is the field lazy?
       #   field.lazy?
       #
-      # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
+      # @return [ true | false ] If the field is lazy.
       def lazy?
         type.resizable?
       end
@@ -95,11 +93,9 @@ 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)
+          mongoize_foreign_key(object)
         else
           related_id_field.mongoize(object)
         end
@@ -110,9 +106,7 @@ module Mongoid
       # @example Is the field a BSON::ObjectId?
       #   field.object_id_field?
       #
-      # @return [ true, false ] If the field is a BSON::ObjectId.
-      #
-      # @since 2.2.0
+      # @return [ true | false ] If the field is a BSON::ObjectId.
       def object_id_field?
         @object_id_field ||=
             association.polymorphic? ? true : association.klass.using_object_ids?
@@ -123,15 +117,35 @@ module Mongoid
       # @example Is the field resizable?
       #   field.resizable?
       #
-      # @return [ true, false ] If the field is resizable.
-      #
-      # @since 3.0.2
+      # @return [ true | false ] If the field is resizable.
       def resizable?
         type.resizable?
       end
 
       private
 
+      # Convert the provided object to a Mongo-friendly foreign key.
+      #
+      # @example Convert the object to a foreign key.
+      #   mongoize_foreign_key(object)
+      #
+      # @param [ Object ] object The object to convert.
+      #
+      # @return [ Object ] The converted object.
+      def mongoize_foreign_key(object)
+        if type == Array || type == Set
+          object = object.to_a if type == Set || object.is_a?(Set)
+
+          if object.resizable?
+            object.blank? ? object : association.convert_to_foreign_key(object)
+          else
+            object.blank? ? [] : association.convert_to_foreign_key(Array(object))
+          end
+        elsif !(object.nil? || object == '')
+          association.convert_to_foreign_key(object)
+        end
+      end
+
       # Evaluate the default proc. In some cases we need to instance exec,
       # in others we don't.
       #
@@ -141,8 +155,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,12 +167,14 @@ 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
 
+      def primary_key_field
+        @primary_key_field ||= association.klass.fields[association.primary_key]
+      end
+
       # This is used when default values need to be serialized. Most of the
       # time just return the object.
       #
@@ -172,8 +186,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,8 +1,13 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Fields
+
+    # Represents a BSON document field definition which stores
+    # different values for different user locale keys in a Ruby
+    # hashmap (BSON "Object" type). Used for internationalization
+    # (I18n) support.
     class Localized < Standard
 
       # Demongoize the object based on the current locale. Will look in the
@@ -14,10 +19,10 @@ 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
+        return if object.nil?
+        case object
+        when Hash
           type.demongoize(lookup(object))
         end
       end
@@ -27,13 +32,21 @@ module Mongoid
       # @example Is the field localized?
       #   field.localized?
       #
-      # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
+      # @return [ true | false ] If the field is localized.
       def localized?
         true
       end
 
+      # Is the localized field enforcing values to be present?
+      #
+      # @example Is the localized field enforcing values to be present?
+      #   field.localize_present?
+      #
+      # @return [ true | false ] If the field enforces present.
+      def localize_present?
+        options[:localize] == :present
+      end
+
       # Convert the provided string into a hash for the locale.
       #
       # @example Serialize the value.
@@ -42,8 +55,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
@@ -57,9 +68,7 @@ module Mongoid
       # @example Should fallbacks be used.
       #   field.fallbacks?
       #
-      # @return [ true, false ] If fallbacks should be used.
-      #
-      # @since 5.1.0
+      # @return [ true | false ] If fallbacks should be used.
       def fallbacks?
         return true if options[:fallbacks].nil?
         !!options[:fallbacks]
@@ -75,8 +84,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
 
@@ -87,7 +94,10 @@ module Mongoid
         end
         return value unless value.nil?
         if fallbacks? && ::I18n.respond_to?(:fallbacks)
-          object[::I18n.fallbacks[locale].map(&:to_s).find{ |loc| object.has_key?(loc) }]
+          fallback_key = ::I18n.fallbacks[locale].find do |loc|
+            object.key?(loc.to_s) || object.key?(loc)
+          end
+          object[fallback_key.to_s] || object[fallback_key]
         end
       end
     end

data/lib/mongoid/fields/standard.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Fields
+
+    # Represents a standard field definition (name, type, etc.)
+    # used to enforce consistent schema structure to the BSON
+    # documents which Mongoid persists.
     class Standard
       extend Forwardable
 
@@ -23,8 +27,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 +40,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)
@@ -53,9 +53,7 @@ module Mongoid
       # @example Is the field a foreign key?
       #   field.foreign_key?
       #
-      # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
+      # @return [ true | false ] If the field is a foreign key.
       def foreign_key?
         false
       end
@@ -70,8 +68,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
@@ -91,9 +87,7 @@ module Mongoid
       # @example Is the field lazy?
       #   field.lazy?
       #
-      # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
+      # @return [ true | false ] If the field is lazy.
       def lazy?
         false
       end
@@ -103,21 +97,27 @@ module Mongoid
       # @example Is the field localized?
       #   field.localized?
       #
-      # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
+      # @return [ true | false ] If the field is localized.
       def localized?
         false
       end
 
+      # Is the localized field enforcing values to be present?
+      #
+      # @example Is the localized field enforcing values to be present?
+      #   field.localize_present?
+      #
+      # @return [ true | false ] If the field enforces present.
+      def localize_present?
+        false
+      end
+
       # Get the metadata for the field if its a foreign key.
       #
       # @example Get the metadata.
       #   field.metadata
       #
       # @return [ Metadata ] The association metadata.
-      #
-      # @since 2.2.0
       def association
         @association ||= options[:association]
       end
@@ -127,9 +127,7 @@ module Mongoid
       # @example Is the field a BSON::ObjectId?
       #   field.object_id_field?
       #
-      # @return [ true, false ] If the field is a BSON::ObjectId.
-      #
-      # @since 2.2.0
+      # @return [ true | false ] If the field is a BSON::ObjectId.
       def object_id_field?
         @object_id_field ||= (type == BSON::ObjectId)
       end
@@ -139,9 +137,7 @@ module Mongoid
       # @example Does the field pre-process the default?
       #   field.pre_processed?
       #
-      # @return [ true, false ] If the field's default is pre-processed.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the field's default is pre-processed.
       def pre_processed?
         @pre_processed ||=
           (options[:pre_processed] || (default_val && !default_val.is_a?(::Proc)))
@@ -153,8 +149,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 +163,6 @@ module Mongoid
       #   field.default_name
       #
       # @return [ String ] The method name.
-      #
-      # @since 3.0.0
       def default_name
         @default_name ||= "__#{name}_default__"
       end
@@ -184,10 +176,8 @@ module Mongoid
       #
       # @note Ruby's instance_exec was just too slow.
       #
-      # @param [ Class, Module ] object The class or module the field is
+      # @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
@@ -202,9 +192,7 @@ module Mongoid
       #
       # @param [ Hash ] fields The field limitations.
       #
-      # @return [ true, false ] If the field was included.
-      #
-      # @since 2.4.4
+      # @return [ true | false ] If the field was included.
       def included?(fields)
         (fields.values.first == 1 && fields[name.to_s] == 1) ||
           (fields.values.first == 0 && !fields.has_key?(name.to_s))
@@ -218,8 +206,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 +223,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 +238,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,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Fields
@@ -9,11 +9,6 @@ module Mongoid
       module Macro
         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 = [
           :as,
           :default,
@@ -25,7 +20,8 @@ module Mongoid
           :pre_processed,
           :subtype,
           :type,
-          :overwrite
+          :overwrite,
+          :encrypt
         ]
 
         # Validate the field definition.
@@ -36,8 +32,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 +46,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)
@@ -76,7 +68,7 @@ module Mongoid
         def validate_field_name(klass, name)
           [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
             if Mongoid.destructive_fields.include?(n)
-              raise Errors::InvalidField.new(klass, n)
+              raise Errors::InvalidField.new(klass, name, n)
             end
           end
         end
@@ -98,7 +90,7 @@ module Mongoid
         def validate_name_uniqueness(klass, name, options)
           if !options[:overwrite] && klass.fields.keys.include?(name.to_s)
             if Mongoid.duplicate_fields_exception
-              raise Errors::InvalidField.new(klass, name)
+              raise Errors::InvalidField.new(klass, name, name)
             else
               Mongoid.logger.warn("Overwriting existing field #{name} in class #{klass.name}.") if Mongoid.logger
             end
@@ -117,8 +109,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)
@@ -126,10 +116,7 @@ module Mongoid
             end
 
             if option == :type && options[option] == Symbol
-              @field_type_is_symbol_warned ||= begin
-                Mongoid.logger.warn(FIELD_TYPE_IS_SYMBOL)
-                true
-              end
+              Mongoid::Warnings.warn_symbol_type_deprecated
             end
           end
         end

data/lib/mongoid/fields/validators.rb

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