mongoid 8.1.9 → 9.0.0

data/lib/mongoid/association/relatable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'mongoid/association/constrainable'
 require 'mongoid/association/options'
@@ -80,7 +81,7 @@ module Mongoid
       #
       # @return [ String ] The type setter method.
       def type_setter
-        @type_setter ||= type.__setter__
+        @type_setter ||= "#{type}=" if type
       end
 
       # Whether trying to bind an object using this association should raise
@@ -113,7 +114,7 @@ module Mongoid
       # @param [ Object ] other The other model class or model object to use when
       #   determining inverses.
       #
-      # @return [ Association ] The inverse's association metadata.
+      # @return [ Mongoid::Association::Relatable ] The inverse's association metadata.
       def inverse_association(other = nil)
         (other || relation_class).relations[inverse(other)]
       end
@@ -232,7 +233,7 @@ module Mongoid
       #
       # @return [ String ] The name of the setter.
       def inverse_type_setter
-        @inverse_type_setter ||= inverse_type.__setter__
+        @inverse_type_setter ||= "#{inverse_type}=" if inverse_type
       end
 
       # Get the name of the method to check if the foreign key has changed.
@@ -299,9 +300,14 @@ module Mongoid
                       end
       end
 
-      # @return [ Array<String> ] The associations above this one in the inclusion tree.
+      # The associations above this one in the inclusion tree.
+      #
+      # @return [ Array<String> ] The associations.
       attr_accessor :parent_inclusions
 
+      # The associations above this one in the inclusion tree.
+      #
+      # @return [ Array<String> ] The associations.
       def parent_inclusions
         @parent_inclusions ||= []
       end

data/lib/mongoid/association.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'mongoid/association/accessors'
 require 'mongoid/association/builders'
@@ -18,6 +19,10 @@ require 'mongoid/association/reflections'
 require 'mongoid/association/eager_loadable'
 
 module Mongoid
+
+  # Mixin module which adds association behavior to a Mongoid document.
+  # Adds methods such as #embedded? which indicate a document's
+  # relative association state.
   module Association
     extend ActiveSupport::Concern
     include Embedded::Cyclic

data/lib/mongoid/atomic/modifiers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Atomic

data/lib/mongoid/atomic/paths/embedded/many.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Atomic
@@ -45,7 +46,7 @@ module Mongoid
             # trying to store the empty list.
             #
             # @param [ Document ] parent The parent document to store in.
-            # @param [ Association ] association The association.
+            # @param [ Mongoid::Association::Relatable ] association The association metadata.
             #
             # @return [ String ] The position string.
             def position_without_document(parent, association)

data/lib/mongoid/atomic/paths/embedded/one.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Atomic

data/lib/mongoid/atomic/paths/embedded.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/atomic/paths/embedded/one"
 require "mongoid/atomic/paths/embedded/many"

data/lib/mongoid/atomic/paths/root.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Atomic

data/lib/mongoid/atomic/paths.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/atomic/paths/embedded"
 require "mongoid/atomic/paths/root"

data/lib/mongoid/atomic.rb

@@ -1,27 +1,25 @@
 # frozen_string_literal: true
 
-require "mongoid/atomic/modifiers"
-require "mongoid/atomic/paths"
+require 'mongoid/atomic/modifiers'
+require 'mongoid/atomic/paths'
 
 module Mongoid
-
   # This module contains the logic for supporting atomic operations against the
   # database.
   module Atomic
     extend ActiveSupport::Concern
 
-    UPDATES = [
-      :atomic_array_pushes,
-      :atomic_array_pulls,
-      :atomic_array_add_to_sets,
-      :atomic_pulls,
-      :delayed_atomic_sets,
-      :delayed_atomic_pulls,
-      :delayed_atomic_unsets
-    ]
+    UPDATES = %i[
+      atomic_array_pushes
+      atomic_array_pulls
+      atomic_array_add_to_sets
+      atomic_pulls
+      delayed_atomic_sets
+      delayed_atomic_pulls
+      delayed_atomic_unsets
+    ].freeze
 
     included do
-
       # When MongoDB finally fully implements the positional operator, we can
       # get rid of all indexing related code in Mongoid.
       attr_accessor :_index
@@ -116,6 +114,8 @@ module Mongoid
     #   person.atomic_updates(children)
     #
     # @return [ Hash ] The updates and their modifiers.
+    #
+    # rubocop:disable Style/OptionalBooleanParameter
     def atomic_updates(_use_indexes = false)
       process_flagged_destroys
       mods = Modifiers.new
@@ -126,7 +126,8 @@ module Mongoid
       end
       mods
     end
-    alias :_updates :atomic_updates
+    alias _updates atomic_updates
+    # rubocop:enable Style/OptionalBooleanParameter
 
     # Get the removal modifier for the document. Will be nil on root
     # documents, $unset on embeds_one, $set on embeds_many.
@@ -203,7 +204,7 @@ module Mongoid
           path ||= doc.flag_as_destroyed
           doc._id
         end
-        pulls[path] = { "_id" => { "$in" => ids }} and path = nil
+        pulls[path] = { '_id' => { '$in' => ids } } and path = nil
       end
       pulls
     end
@@ -225,7 +226,13 @@ module Mongoid
     #
     # @return [ Hash ] The $set operations.
     def atomic_sets
-      updateable? ? setters : settable? ? { atomic_path => as_attributes } : {}
+      if updateable?
+        setters
+      elsif settable?
+        { atomic_path => as_attributes }
+      else
+        {}
+      end
     end
 
     # Get all the attributes that need to be unset.
@@ -337,51 +344,5 @@ module Mongoid
       mods.add_to_set(doc.atomic_array_add_to_sets)
       mods.pull_all(doc.atomic_array_pulls)
     end
-
-    # Get the atomic updates for a touch operation. Should only include the
-    # updated_at field and the optional extra field.
-    #
-    # @api private
-    #
-    # @example Get the touch atomic updates.
-    #   document.touch_atomic_updates
-    #
-    # @param [ Symbol ] field The optional field.
-    #
-    # @return [ Hash ] The atomic updates.
-    def touch_atomic_updates(field = nil)
-      updates = atomic_updates
-      return {} unless atomic_updates.key?("$set")
-      touches = {}
-      wanted_keys = %w(updated_at u_at)
-      # TODO this permits field to be passed as an empty string in which case
-      # it is ignored, get rid of this behavior.
-      if field.present?
-        wanted_keys << field.to_s
-      end
-      updates["$set"].each_pair do |key, value|
-        if wanted_keys.include?(key.split('.').last)
-          touches.update(key => value)
-        end
-      end
-      { "$set" => touches }
-    end
-
-    # Returns the $set atomic updates affecting the specified field.
-    #
-    # @param [ String ] field The field name.
-    #
-    # @api private
-    def set_field_atomic_updates(field)
-      updates = atomic_updates
-      return {} unless atomic_updates.key?("$set")
-      sets = {}
-      updates["$set"].each_pair do |key, value|
-        if key.split('.').last == field
-          sets.update(key => value)
-        end
-      end
-      { "$set" => sets }
-    end
   end
 end

data/lib/mongoid/atomic_update_preparer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Mongoid
+  # A singleton class to assist with preparing attributes for atomic
+  # updates.
+  #
+  # Once the deprecated Hash#__consolidate__ method is removed entirely,
+  # these methods may be moved into Mongoid::Contextual::Mongo as private
+  # methods.
+  #
+  # @api private
+  class AtomicUpdatePreparer
+    class << self
+      # Convert the key/values in the attributes into a hash of atomic updates.
+      # Non-operator keys are assumed to use $set operation.
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ Hash ] attributes The attributes to convert.
+      #
+      # @return [ Hash ] The prepared atomic updates.
+      def prepare(attributes, klass)
+        attributes.each_pair.with_object({}) do |(key, value), atomic_updates|
+          key = klass.database_field_name(key.to_s)
+
+          if key.to_s.start_with?('$')
+            (atomic_updates[key] ||= {}).update(prepare_operation(klass, key, value))
+          else
+            (atomic_updates['$set'] ||= {})[key] = mongoize_for(key, klass, key, value)
+          end
+        end
+      end
+
+      private
+
+      # Treats the key as if it were a MongoDB operator and prepares
+      # the value accordingly.
+      #
+      # @param [ Class ] klass the model class
+      # @param [ String | Symbol ] key the operator
+      # @param [ Hash ] value the operand
+      #
+      # @return [ Hash ] the prepared value.
+      def prepare_operation(klass, key, value)
+        value.each_with_object({}) do |(key2, value2), hash|
+          key2 = klass.database_field_name(key2)
+          hash[key2] = value_for(key, klass, value2)
+        end
+      end
+
+      # Get the value for the provided operator, klass, key and value.
+      #
+      # This is necessary for special cases like $rename, $addToSet and $push.
+      #
+      # @param [ String ] operator The operator.
+      # @param [ Class ] klass The model class.
+      # @param [ Object ] value The original value.
+      #
+      # @return [ Object ] Value prepared for the provided operator.
+      def value_for(operator, klass, value)
+        case operator
+        when '$rename' then value.to_s
+        when '$addToSet', '$push' then value.mongoize
+        else mongoize_for(operator, klass, operator, value)
+        end
+      end
+
+      # Mongoize for the klass, key and value.
+      #
+      # @param [ String ] operator The operator.
+      # @param [ Class ] klass The model class.
+      # @param [ String | Symbol ] key The field key.
+      # @param [ Object ] value The value to mongoize.
+      #
+      # @return [ Object ] The mongoized value.
+      def mongoize_for(operator, klass, key, value)
+        field = klass.fields[key.to_s]
+        return value unless field
+
+        mongoized = field.mongoize(value)
+        if Mongoid::Persistable::LIST_OPERATIONS.include?(operator) && field.resizable? && !value.is_a?(Array)
+          return mongoized.first
+        end
+
+        mongoized
+      end
+    end
+  end
+end

data/lib/mongoid/attributes/dynamic.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Attributes

data/lib/mongoid/attributes/embedded.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Attributes
+    # Utility module for working with embedded attributes.
+    module Embedded
+      extend self
+
+      # Fetch an embedded value or subset of attributes via dot notation.
+      #
+      # @example Fetch an embedded value via dot notation.
+      #   Embedded.traverse({ 'name' => { 'en' => 'test' } }, 'name.en')
+      #   #=> 'test'
+      #
+      # @param [ Hash ] attributes The document attributes.
+      # @param [ String ] path The dot notation string.
+      #
+      # @return [ Object | nil ] The attributes at the given path,
+      #   or nil if the path doesn't exist.
+      def traverse(attributes, path)
+        path.split('.').each do |key|
+          break if attributes.nil?
+
+          attributes = if attributes.try(:key?, key)
+                         attributes[key]
+                       elsif attributes.respond_to?(:each) && key.match?(/\A\d+\z/)
+                         attributes[key.to_i]
+                       end
+        end
+        attributes
+      end
+    end
+  end
+end

data/lib/mongoid/attributes/nested.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Attributes
 
-    # Defines behavior around that lovel Rails feature nested attributes.
+    # Defines behavior for the Rails nested attributes feature.
     module Nested
       extend ActiveSupport::Concern
 
@@ -76,7 +77,7 @@ module Mongoid
         # @example Add the autosave if appropriate.
         #   Person.autosave_nested_attributes(metadata)
         #
-        # @param [ Association ] association The existing association metadata.
+        # @param [ Mongoid::Association::Relatable ] association The existing association metadata.
         def autosave_nested_attributes(association)
           # In order for the autosave functionality to work properly, the association needs to be
           # marked as autosave despite the fact that the option isn't present. Because the method

data/lib/mongoid/attributes/processing.rb

@@ -2,10 +2,8 @@
 
 module Mongoid
   module Attributes
-
     # This module contains the behavior for processing attributes.
     module Processing
-
       # Process the provided attributes casting them to their proper values if a
       # field exists for them on the document. This will be limited to only the
       # attributes provided in the supplied +Hash+ so that no extra nil values get
@@ -17,10 +15,11 @@ module Mongoid
       # @param [ Hash ] attrs The attributes to set.
       def process_attributes(attrs = nil)
         attrs ||= {}
-        if !attrs.empty?
+        unless attrs.empty?
           attrs = sanitize_for_mass_assignment(attrs)
           attrs.each_pair do |key, value|
             next if pending_attribute?(key, value)
+
             process_attribute(key, value)
           end
         end
@@ -44,15 +43,15 @@ module Mongoid
       def pending_attribute?(key, value)
         name = key.to_s
         aliased = if aliased_associations.key?(name)
-          aliased_associations[name]
-        else
-          name
-        end
-        if relations.has_key?(aliased)
+                    aliased_associations[name]
+                  else
+                    name
+                  end
+        if relations.key?(aliased)
           set_pending_relation(name, aliased, value)
           return true
         end
-        if nested_attributes.has_key?(aliased)
+        if nested_attributes.key?(aliased)
           set_pending_nested(name, aliased, value)
           return true
         end
@@ -114,11 +113,12 @@ module Mongoid
       # @param [ Symbol ] name The name of the field.
       # @param [ Object ] value The value of the field.
       def process_attribute(name, value)
-        if !respond_to?("#{name}=", true) && store_as = aliased_fields.invert[name.to_s]
+        if !respond_to?("#{name}=", true) && (store_as = aliased_fields.invert[name.to_s])
           name = store_as
         end
         responds = respond_to?("#{name}=", true)
         raise Errors::UnknownAttribute.new(self.class, name) unless responds
+
         send("#{name}=", value)
       end
 
@@ -140,6 +140,7 @@ module Mongoid
       def process_pending
         process_nested and process_relations
         pending_nested.clear and pending_relations.clear
+        _reset_memoized_descendants!
       end
 
       # Process all the pending associations that needed to wait until ids were set

data/lib/mongoid/attributes/projector.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Attributes

data/lib/mongoid/attributes/readonly.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Attributes
@@ -22,7 +23,7 @@ module Mongoid
       # @return [ true | false ] If the document is new, or if the field is not
       #   readonly.
       def attribute_writable?(name)
-        new_record? || (!self.class.readonly_attributes.include?(name) && _loaded?(name))
+        new_record? || (!readonly_attributes.include?(name) && _loaded?(name))
       end
 
       private
@@ -62,17 +63,12 @@ module Mongoid
         #   end
         #
         # @param [ Symbol... ] *names The names of the fields.
-        # @note When a parent class contains readonly attributes and is then
-        # inherited by a child class, the child class will inherit the
-        # parent's readonly attributes at the time of its creation.
-        # Updating the parent does not propagate down to child classes after wards.
         def attr_readonly(*names)
-          self.readonly_attributes = self.readonly_attributes.dup
           names.each do |name|
-            self.readonly_attributes << database_field_name(name)
+            readonly_attributes << database_field_name(name)
           end
         end
       end
     end
   end
-end
+end

data/lib/mongoid/attributes.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "active_model/attribute_methods"
 require "mongoid/attributes/dynamic"
+require "mongoid/attributes/embedded"
 require "mongoid/attributes/nested"
 require "mongoid/attributes/processing"
 require "mongoid/attributes/projector"
@@ -31,7 +33,7 @@ module Mongoid
     def attribute_present?(name)
       attribute = read_raw_attribute(name)
       !attribute.blank? || attribute == false
-    rescue ActiveModel::MissingAttributeError
+    rescue Mongoid::Errors::AttributeNotLoaded
       false
     end
 
@@ -165,7 +167,7 @@ module Mongoid
       field_name = database_field_name(name)
 
       if attribute_missing?(field_name)
-        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'"
+        raise Mongoid::Errors::AttributeNotLoaded.new(self.class, field_name)
       end
 
       if attribute_writable?(field_name)
@@ -291,14 +293,14 @@ module Mongoid
       normalized = database_field_name(name.to_s)
 
       if attribute_missing?(normalized)
-        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'"
+        raise Mongoid::Errors::AttributeNotLoaded.new(self.class, name)
       end
 
       if hash_dot_syntax?(normalized)
         if fields.key?(normalized)
           attributes[normalized]
         else
-          attributes.__nested__(normalized)
+          Embedded.traverse(attributes, normalized)
         end
       else
         attributes[normalized]

data/lib/mongoid/cacheable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
 
@@ -26,7 +27,7 @@ module Mongoid
     # @return [ String ] the string with or without updated_at
     def cache_key
       return "#{model_key}/new" if new_record?
-      return "#{model_key}/#{_id}-#{updated_at.utc.to_formatted_s(cache_timestamp_format)}" if do_or_do_not(:updated_at)
+      return "#{model_key}/#{_id}-#{updated_at.utc.to_formatted_s(cache_timestamp_format)}" if try(:updated_at)
       "#{model_key}/#{_id}"
     end
   end