mongoid 5.4.1 → 7.4.0

data/lib/mongoid/fields.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/fields/standard"
 require "mongoid/fields/foreign_key"
 require "mongoid/fields/localized"
@@ -6,13 +7,14 @@ require "mongoid/fields/validators"
 
 module Mongoid
 
-  # This module defines behaviour for fields.
+  # This module defines behavior for fields.
   module Fields
     extend ActiveSupport::Concern
 
+    StringifiedSymbol = Mongoid::StringifiedSymbol
+    Boolean = Mongoid::Boolean
+
     # For fields defined with symbols use the correct class.
-    #
-    # @since 4.0.0
     TYPE_MAPPINGS = {
       array: Array,
       big_decimal: BigDecimal,
@@ -28,14 +30,89 @@ module Mongoid
       regexp: Regexp,
       set: Set,
       string: String,
+      stringified_symbol: StringifiedSymbol,
       symbol: Symbol,
       time: Time
     }.with_indifferent_access
 
-    # Constant for all names of the id field in a document.
+    # Constant for all names of the _id field in a document.
+    #
+    # This does not include aliases of _id field.
     #
-    # @since 5.0.0
-    IDS = [ :_id, :id, '_id', 'id' ].freeze
+    # @api private
+    IDS = [ :_id, '_id', ].freeze
+
+    module ClassMethods
+      # Returns the list of id fields for this model class, as both strings
+      # and symbols.
+      #
+      # @return [ Array<Symbol | String> ] List of id fields.
+      #
+      # @api private
+      def id_fields
+        IDS.dup.tap do |id_fields|
+          aliased_fields.each do |k, v|
+            if v == '_id'
+              id_fields << k.to_sym
+              id_fields << k
+            end
+          end
+        end
+      end
+
+      # Extracts the id field from the specified attributes hash based on
+      # aliases defined in this class.
+      #
+      # @param [ Hash ] attributes The attributes to inspect.
+      #
+      # @return [ Object ] The id value.
+      #
+      # @api private
+      def extract_id_field(attributes)
+        id_fields.each do |k|
+          if v = attributes[k]
+            return v
+          end
+        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
       class_attribute :aliased_fields
@@ -57,8 +134,7 @@ module Mongoid
         type: BSON::ObjectId
       )
 
-      alias :id :_id
-      alias :id= :_id=
+      alias_attribute(:id, :_id)
     end
 
     # Apply all default values to the document which are not procs.
@@ -67,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)
@@ -81,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)
@@ -95,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]
@@ -113,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
@@ -126,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
@@ -144,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
@@ -159,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
@@ -182,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.
       #
@@ -194,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
@@ -207,8 +267,6 @@ module Mongoid
       #   # => { :required => #<Proc:0x00000100976b38> }
       #
       # @return [ Hash ] the option map
-      #
-      # @since 2.1.0
       def options
         @options ||= {}
       end
@@ -225,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
@@ -282,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))
@@ -296,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
@@ -311,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)
@@ -381,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]
 
@@ -406,12 +472,10 @@ 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
-            raw = read_attribute(name)
+            raw = read_raw_attribute(name)
             if lazy_settable?(field, raw)
               write_attribute(name, field.eval_default(self))
             else
@@ -432,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
@@ -454,14 +516,12 @@ 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|
             val = write_attribute(name, value)
             if field.foreign_key?
-              remove_ivar(field.metadata.name)
+              remove_ivar(field.association.name)
             end
             val
           end
@@ -475,12 +535,10 @@ 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
-            value = read_attribute(name)
+            value = read_raw_attribute(name)
             lookup_attribute_presence(name, value)
           end
         end
@@ -493,12 +551,11 @@ 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
-            (attributes[name] ||= {}).with_indifferent_access
+            attributes[name] ||= {}
+            attributes[name].with_indifferent_access
           end
           alias_method :"#{meth}_t", :"#{meth}_translations"
         end
@@ -512,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|
@@ -535,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
@@ -551,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,18 +1,20 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # This module defines the finder methods that hang off the document at the
   # class level.
-  #
-  # @since 4.0.0
   module Findable
-    extend Origin::Forwardable
+    extend Forwardable
 
-    select_with :with_default_scope
+    def_delegators :with_default_scope, *(
+      Criteria::Queryable::Selectable.forwardables +
+      Criteria::Queryable::Optional.forwardables
+    )
 
     # These are methods defined on the criteria that should also be accessible
-    # directly from the the class level.
-    delegate \
+    # directly from the class level.
+    def_delegators :with_default_scope,
       :aggregates,
       :avg,
       :create_with,
@@ -41,7 +43,7 @@ module Mongoid
       :sum,
       :text_search,
       :update,
-      :update_all, to: :with_default_scope
+      :update_all
 
     # Returns a count of records in the database.
     # If you want to specify conditions use where.
@@ -55,6 +57,16 @@ module Mongoid
       with_default_scope.count
     end
 
+    # Returns an estimated count of records in the database.
+    #
+    # @example Get the count of matching documents.
+    #   Person.estimated_count
+    #
+    # @return [ Integer ] The number of matching documents.
+    def estimated_count
+      with_default_scope.estimated_count
+    end
+
     # Returns true if count is zero
     #
     # @example Are there no saved documents for this model?
@@ -76,20 +88,46 @@ module Mongoid
       with_default_scope.exists?
     end
 
-    # Find a +Document+ in several different ways.
-    #
-    # If a +String+ is provided, it will be assumed that it is a
-    # representation of a Mongo::ObjectID and will attempt to find a single
-    # +Document+ based on that id. If a +Symbol+ and +Hash+ is provided then
-    # it will attempt to find either a single +Document+ or multiples based
-    # on the conditions provided and the first parameter.
-    #
-    # @example Find a single document by an id.
-    #   Person.find(BSON::ObjectId)
-    #
-    # @param [ Array ] args An assortment of finder options.
-    #
-    # @return [ Document, nil, Criteria ] A document or matching documents.
+    # Finds a +Document+ or multiple documents by their _id values.
+    #
+    # If a single non-Array argument is given, this argument is interpreted
+    # as the _id value of a document to find. If there is a matching document
+    # in the database, this document is returned; otherwise, if the
+    # +raise_not_found_error+ Mongoid configuration option is truthy
+    # (which is the default), +Errors::DocumentNotFound+ is raised, and if
+    # +raise_not_found_error+ is falsy, +find+ returns +nil+.
+    #
+    # If multiple arguments are given, or an Array argument is given, the
+    # array is flattened and each array element is interpreted as the _id
+    # value of the document to find. Mongoid then attempts to retrieve all
+    # documents with the provided _id values. The return value is an array
+    # of found documents. Each document appears one time in the returned array,
+    # even if its _id is given multiple times in the argument to +find+.
+    # If the +raise_not_found_error+ Mongoid configuration option is truthy,
+    # +Errors::DocumentNotFound+ exception is raised if any of the specified
+    # _ids were not found in the database. If the ++raise_not_found_error+
+    # Mongoid configuration option is falsy, only those documents which are
+    # found are returned; if no documents are found, the return value is an
+    # empty array.
+    #
+    # Note that MongoDB does not allow the _id field to be an array.
+    #
+    # The argument undergoes customary Mongoid type conversions based on
+    # the type declared for the _id field. By default the _id field is a
+    # +BSON::ObjectId+; this allows strings to be passed to +find+ and the
+    # strings will be transparently converted to +BSON::ObjectId+ instances
+    # during query construction.
+    #
+    # The +find+ method takes into account the default scope defined on the
+    # model class, if any.
+    #
+    # @param [ Object | Array<Object> ] args The _id values to find or an
+    #   array thereof.
+    #
+    # @return [ Document | Array<Document> | nil ] A document or matching documents.
+    #
+    # @raise Errors::DocumentNotFound If not all documents are found and
+    #   the +raise_not_found_error+ Mongoid configuration option is truthy.
     def find(*args)
       with_default_scope.find(*args)
     end
@@ -108,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

data/lib/mongoid/indexable/specification.rb

@@ -1,16 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Indexable
 
-    # Encapsulates behaviour around an index specification.
-    #
-    # @since 4.0.0
+    # Encapsulates behavior around an index specification.
     class Specification
 
       # The mappings of nice Ruby-style names to the corresponding driver
       # option name.
-      #
-      # @since 4.0.0
       MAPPINGS = {
         expire_after_seconds: :expire_after
       }
@@ -31,8 +28,6 @@ module Mongoid
       # @param [ Specification ] other The spec to compare against.
       #
       # @return [ true, false ] If the specs are equal.
-      #
-      # @since 4.0.0
       def ==(other)
         fields == other.fields && key == other.key
       end
@@ -45,8 +40,6 @@ module Mongoid
       # @param [ Class ] klass The class the index is defined on.
       # @param [ Hash ] key The hash of name/direction pairs.
       # @param [ Hash ] opts the index options.
-      #
-      # @since 4.0.0
       def initialize(klass, key, opts = nil)
         options = opts || {}
         Validators::Options.validate(klass, key, options)
@@ -62,8 +55,6 @@ module Mongoid
       #   specification.name
       #
       # @return [ String ] name The index name.
-      #
-      # @since 5.0.2
       def name
         @name ||= key.reduce([]) do |n, (k,v)|
           n << "#{k}_#{v}"
@@ -82,8 +73,6 @@ module Mongoid
       # @param [ Hash ] key The index key(s).
       #
       # @return [ Hash ] The normalized specification.
-      #
-      # @since 4.0.0
       def normalize_key(key)
         normalized = {}
         key.each_pair do |name, direction|
@@ -102,8 +91,6 @@ module Mongoid
       # @param [ Hash ] opts The index options.
       #
       # @return [ Hash ] The normalized options.
-      #
-      # @since 4.0.0
       def normalize_options(opts)
         options = {}
         opts.each_pair do |option, value|

data/lib/mongoid/indexable/validators/options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Indexable
     module Validators
@@ -51,8 +52,6 @@ module Mongoid
         # @param [ Hash ] options The index options.
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
-        #
-        # @since 3.0.0
         def validate(klass, spec, options)
           validate_spec(klass, spec, options)
           validate_options(klass, spec, options)
@@ -72,8 +71,6 @@ module Mongoid
         # @param [ Hash ] options The index options.
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
-        #
-        # @since 3.0.0
         def validate_options(klass, spec, options)
           options.each_pair do |name, value|
             unless VALID_OPTIONS.include?(name)
@@ -94,8 +91,6 @@ module Mongoid
         # @param [ Hash ] options The index options.
         #
         # @raise [ Errors::InvalidIndex ] If validation failed.
-        #
-        # @since 3.0.0
         def validate_spec(klass, spec, options)
           raise Errors::InvalidIndex.new(klass, spec, options) if !spec.is_a?(::Hash)
           spec.each_pair do |name, value|