mongoid 5.4.1 → 7.4.0

data/lib/mongoid/attributes.rb

@@ -1,8 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "active_model/attribute_methods"
 require "mongoid/attributes/dynamic"
 require "mongoid/attributes/nested"
 require "mongoid/attributes/processing"
+require "mongoid/attributes/projector"
 require "mongoid/attributes/readonly"
 
 module Mongoid
@@ -26,10 +28,8 @@ module Mongoid
     # @param [ String, Symbol ] name The name of the attribute.
     #
     # @return [ true, false ] True if present, false if not.
-    #
-    # @since 1.0.0
     def attribute_present?(name)
-      attribute = read_attribute(name)
+      attribute = read_raw_attribute(name)
       !attribute.blank? || attribute == false
     rescue ActiveModel::MissingAttributeError
       false
@@ -41,8 +41,6 @@ module Mongoid
     #   document.attributes_before_type_cast
     #
     # @return [ Hash ] The uncast attributes.
-    #
-    # @since 3.1.0
     def attributes_before_type_cast
       @attributes_before_type_cast ||= {}
     end
@@ -55,8 +53,6 @@ module Mongoid
     # @param [ String, Symbol ] name The name of the attribute.
     #
     # @return [ true, false ] If the key is present in the attributes.
-    #
-    # @since 3.0.0
     def has_attribute?(name)
       attributes.key?(name.to_s)
     end
@@ -71,8 +67,6 @@ module Mongoid
     #
     # @return [ true, false ] If the key is present in the
     #   attributes_before_type_cast.
-    #
-    # @since 3.1.0
     def has_attribute_before_type_cast?(name)
       attributes_before_type_cast.key?(name.to_s)
     end
@@ -89,24 +83,16 @@ module Mongoid
     # @param [ String, Symbol ] name The name of the attribute to get.
     #
     # @return [ Object ] The value of the attribute.
-    #
-    # @since 1.0.0
     def read_attribute(name)
-      normalized = database_field_name(name.to_s)
-      if attribute_missing?(normalized)
-        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'."
-      end
-      if hash_dot_syntax?(normalized)
-        attributes.__nested__(normalized)
-      else
-        attributes[normalized]
-      end
+      field = fields[name.to_s]
+      raw = read_raw_attribute(name)
+      field ? field.demongoize(raw) : raw
     end
     alias :[] :read_attribute
 
     # Read a value from the attributes before type cast. If the value has not
     # yet been assigned then this will return the attribute's existing value
-    # using read_attribute.
+    # using read_raw_attribute.
     #
     # @example Read an attribute before type cast.
     #   person.read_attribute_before_type_cast(:price)
@@ -115,14 +101,12 @@ module Mongoid
     #
     # @return [ Object ] The value of the attribute before type cast, if
     #   available. Otherwise, the value of the attribute.
-    #
-    # @since 3.1.0
     def read_attribute_before_type_cast(name)
       attr = name.to_s
       if attributes_before_type_cast.key?(attr)
         attributes_before_type_cast[attr]
       else
-        read_attribute(attr)
+        read_raw_attribute(attr)
       end
     end
 
@@ -136,17 +120,13 @@ module Mongoid
     #
     # @raise [ Errors::ReadonlyAttribute ] If the field cannot be removed due
     #   to being flagged as reaodnly.
-    #
-    # @since 1.0.0
     def remove_attribute(name)
-      access = name.to_s
-      unless attribute_writable?(name)
-        raise Errors::ReadonlyAttribute.new(name, :nil)
-      end
-      _assigning do
-        attribute_will_change!(access)
-        delayed_atomic_unsets[atomic_attribute_name(access)] = [] unless new_record?
-        attributes.delete(access)
+      as_writable_attribute!(name) do |access|
+        _assigning do
+          attribute_will_change!(access)
+          delayed_atomic_unsets[atomic_attribute_name(access)] = [] unless new_record?
+          attributes.delete(access)
+        end
       end
     end
 
@@ -162,27 +142,32 @@ module Mongoid
     #
     # @param [ String, Symbol ] name The name of the attribute to update.
     # @param [ Object ] value The value to set for the attribute.
-    #
-    # @since 1.0.0
     def write_attribute(name, value)
-      access = database_field_name(name.to_s)
-      if attribute_writable?(access)
+      field_name = database_field_name(name)
+
+      if attribute_missing?(field_name)
+        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'"
+      end
+
+      if attribute_writable?(field_name)
         _assigning do
-          validate_attribute_value(access, value)
-          localized = fields[access].try(:localized?)
+          validate_attribute_value(field_name, value)
+          localized = fields[field_name].try(:localized?)
           attributes_before_type_cast[name.to_s] = value
-          typed_value = typed_value_for(access, value)
-          unless attributes[access] == typed_value || attribute_changed?(access)
-            attribute_will_change!(access)
+          typed_value = typed_value_for(field_name, value)
+          unless attributes[field_name] == typed_value || attribute_changed?(field_name)
+            attribute_will_change!(field_name)
           end
           if localized
-            attributes[access] ||= {}
-            attributes[access].merge!(typed_value)
+            attributes[field_name] ||= {}
+            attributes[field_name].merge!(typed_value)
           else
-            attributes[access] = typed_value
+            attributes[field_name] = typed_value
           end
           typed_value
         end
+      else
+        # TODO: MONGOID-5072
       end
     end
     alias :[]= :write_attribute
@@ -199,8 +184,6 @@ module Mongoid
     #   person.assign_attributes({ :title => "Mr." }, :as => :admin)
     #
     # @param [ Hash ] attrs The new attributes to set.
-    #
-    # @since 2.2.1
     def assign_attributes(attrs = nil)
       _assigning do
         process_attributes(attrs)
@@ -218,8 +201,6 @@ module Mongoid
     #   person.attributes = { :title => "Mr." }
     #
     # @param [ Hash ] attrs The new attributes to set.
-    #
-    # @since 1.0.0
     def write_attributes(attrs = nil)
       assign_attributes(attrs)
     end
@@ -234,33 +215,21 @@ module Mongoid
     # @param [ String ] name The name of the attribute.
     #
     # @return [ true, false ] If the attribute is missing.
-    #
-    # @since 4.0.0
     def attribute_missing?(name)
-      selection = __selected_fields
-      return false unless selection
-      field = fields[name]
-      (selection.values.first == 0 && selection_excluded?(name, selection, field)) ||
-        (selection.values.first == 1 && !selection_included?(name, selection, field))
+      !Projector.new(__selected_fields).attribute_or_path_allowed?(name)
     end
 
-    private
-
-    def selection_excluded?(name, selection, field)
-      if field && field.localized?
-        selection["#{name}.#{::I18n.locale}"] == 0
-      else
-        selection[name] == 0
-      end
+    # Return type-casted attributes.
+    #
+    # @example Type-casted attributes.
+    #   document.typed_attributes
+    #
+    # @return [ Object ] The hash with keys and values of the type-casted attributes.
+    def typed_attributes
+      attribute_names.map { |name| [name, send(name)] }.to_h
     end
 
-    def selection_included?(name, selection, field)
-      if field && field.localized?
-        selection.key?("#{name}.#{::I18n.locale}")
-      else
-        selection.key?(name) || selection.keys.collect { |k| k.partition('.').first }.include?(name)
-      end
-    end
+    private
 
     # Does the string contain dot syntax for accessing hashes?
     #
@@ -270,10 +239,8 @@ module Mongoid
     #   model.hash_dot_syntax?
     #
     # @return [ true, false ] If the string contains a "."
-    #
-    # @since 3.0.15
     def hash_dot_syntax?(string)
-      string.include?(".".freeze)
+      string.include?(".")
     end
 
     # Return the typecasted value for a field.
@@ -285,12 +252,26 @@ module Mongoid
     # @param [ Object ] value The uncast value.
     #
     # @return [ Object ] The cast value.
-    #
-    # @since 1.0.0
     def typed_value_for(key, value)
       fields.key?(key) ? fields[key].mongoize(value) : value.mongoize
     end
 
+    private
+
+    def read_raw_attribute(name)
+      normalized = database_field_name(name.to_s)
+
+      if attribute_missing?(normalized)
+        raise ActiveModel::MissingAttributeError, "Missing attribute: '#{name}'"
+      end
+
+      if hash_dot_syntax?(normalized)
+        attributes.__nested__(normalized)
+      else
+        attributes[normalized]
+      end
+    end
+
     module ClassMethods
 
       # Alias the provided name to the original field. This will provide an
@@ -306,47 +287,70 @@ module Mongoid
       #
       # @param [ Symbol ] name The new name.
       # @param [ Symbol ] original The original name.
-      #
-      # @since 2.3.0
       def alias_attribute(name, original)
         aliased_fields[name.to_s] = original.to_s
-        class_eval <<-RUBY
-          alias #{name}  #{original}
-          alias #{name}= #{original}=
-          alias #{name}? #{original}?
-          alias #{name}_change   #{original}_change
-          alias #{name}_changed? #{original}_changed?
-          alias reset_#{name}!   reset_#{original}!
-          alias reset_#{name}_to_default!   reset_#{original}_to_default!
-          alias #{name}_was      #{original}_was
-          alias #{name}_will_change! #{original}_will_change!
-          alias #{name}_before_type_cast #{original}_before_type_cast
-        RUBY
+
+        alias_method name, original
+        alias_method "#{name}=", "#{original}="
+        alias_method "#{name}?", "#{original}?"
+        alias_method "#{name}_change", "#{original}_change"
+        alias_method "#{name}_changed?", "#{original}_changed?"
+        alias_method "reset_#{name}!", "reset_#{original}!"
+        alias_method "reset_#{name}_to_default!", "reset_#{original}_to_default!"
+        alias_method "#{name}_was", "#{original}_was"
+        alias_method "#{name}_will_change!", "#{original}_will_change!"
+        alias_method "#{name}_before_type_cast", "#{original}_before_type_cast"
+      end
+
+      # Removes a field alias.
+      #
+      # @param [ Symbol ] name The aliased field name to remove.
+      def unalias_attribute(name)
+        unless aliased_fields.delete(name.to_s)
+          raise AttributeError, "Field #{name} is not an aliased field"
+        end
+
+        remove_method name
+        remove_method "#{name}="
+        remove_method "#{name}?"
+        remove_method "#{name}_change"
+        remove_method "#{name}_changed?"
+        remove_method "reset_#{name}!"
+        remove_method "reset_#{name}_to_default!"
+        remove_method "#{name}_was"
+        remove_method "#{name}_will_change!"
+        remove_method "#{name}_before_type_cast"
       end
     end
 
     private
 
-    # Validates an attribute value. This provides validation checking if
-    # the value is valid for given a field.
-    # For now, only Hash and Array fields are validated.
-    #
-    # @param [ String, Symbol ] access The name of the attribute to validate.
-    # @param [ Object ] value The to be validated.
-    #
-    # @since 3.0.10
-    def validate_attribute_value(access, value)
-      return unless fields[access] && value
+    # Validates an attribute value as being assignable to the specified field.
+    #
+    # For now, only Hash and Array fields are validated, and the value is
+    # being checked to be of an appropriate type (i.e. either Hash or Array,
+    # respectively, or nil).
+    #
+    # This method takes the name of the field as stored in the document
+    # in the database, not (necessarily) the Ruby method name used to read/write
+    # the said field.
+    #
+    # @param [ String, Symbol ] field_name The name of the field.
+    # @param [ Object ] value The value to be validated.
+    def validate_attribute_value(field_name, value)
+      return if value.nil?
+      field = fields[field_name]
+      return unless field
       validatable_types = [ Hash, Array ]
-      if validatable_types.include? fields[access].type
-        unless value.is_a? fields[access].type
-          raise Mongoid::Errors::InvalidValue.new(fields[access].type, value.class)
+      if validatable_types.include?(field.type)
+        unless value.is_a?(field.type)
+          raise Mongoid::Errors::InvalidValue.new(field.type, value.class)
         end
       end
     end
 
     def lookup_attribute_presence(name, value)
-      if localized_fields.has_key?(name)
+      if localized_fields.has_key?(name) && value
         value = localized_fields[name].send(:lookup, value)
       end
       value.present?

data/lib/mongoid/cacheable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Mongoid
+
+  # Encapsulates behavior around caching.
+  module Cacheable
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :cache_timestamp_format, instance_writer: false
+      self.cache_timestamp_format = :nsec
+    end
+
+    # Print out the cache key. This will append different values on the
+    # plural model name.
+    #
+    # If new_record?     - will append /new
+    # If not             - will append /id-updated_at.to_s(cache_timestamp_format)
+    # Without updated_at - will append /id
+    #
+    # This is usually called inside a cache() block
+    #
+    # @example Returns the cache key
+    #   document.cache_key
+    #
+    # @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_s(cache_timestamp_format)}" if do_or_do_not(:updated_at)
+      "#{model_key}/#{_id}"
+    end
+  end
+end

data/lib/mongoid/changeable.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
-  # Defines behaviour for dirty tracking.
-  #
-  # @since 4.0.0
+  # Defines behavior for dirty tracking.
   module Changeable
     extend ActiveSupport::Concern
 
@@ -13,8 +12,6 @@ module Mongoid
     #   model.changed
     #
     # @return [ Array<String> ] The changed attributes.
-    #
-    # @since 2.4.0
     def changed
       changed_attributes.keys.select { |attr| attribute_change(attr) }
     end
@@ -25,20 +22,15 @@ module Mongoid
     #   model.changed?
     #
     # @return [ true, false ] If the document is changed.
-    #
-    # @since 2.4.0
     def changed?
       changes.values.any? { |val| val } || children_changed?
     end
 
     # Have any children (embedded documents) of this document changed?
     #
-    # @example Have any children changed?
-    #   model.children_changed?
+    # @note This intentionally only considers children and not descendants.
     #
     # @return [ true, false ] If any children have changed.
-    #
-    # @since 2.4.1
     def children_changed?
       _children.any?(&:changed?)
     end
@@ -49,8 +41,6 @@ module Mongoid
     #   model.changed_attributes
     #
     # @return [ Hash<String, Object> ] The attribute changes.
-    #
-    # @since 2.4.0
     def changed_attributes
       @changed_attributes ||= {}
     end
@@ -61,8 +51,6 @@ module Mongoid
     #   model.changes
     #
     # @return [ Hash<String, Array<Object, Object> ] The changes.
-    #
-    # @since 2.4.0
     def changes
       _changes = {}
       changed.each do |attr|
@@ -79,8 +67,6 @@ module Mongoid
     #
     # @example Move the changes to previous.
     #   person.move_changes
-    #
-    # @since 2.1.0
     def move_changes
       @previous_changes = changes
       Atomic::UPDATES.each do |update|
@@ -93,10 +79,8 @@ module Mongoid
     #
     # @example Handle post persistence.
     #   document.post_persist
-    #
-    # @since 3.0.0
     def post_persist
-      reset_persisted_children
+      reset_persisted_descendants
       move_changes
     end
 
@@ -106,21 +90,17 @@ module Mongoid
     #   model.previous_changes
     #
     # @return [ Hash<String, Array<Object, Object> ] The previous changes.
-    #
-    # @since 2.4.0
     def previous_changes
       @previous_changes ||= {}
     end
 
     # Remove a change from the dirty attributes hash. Used by the single field
-    # atomic updators.
+    # atomic updaters.
     #
     # @example Remove a flagged change.
     #   model.remove_change(:field)
     #
     # @param [ Symbol, String ] name The name of the field.
-    #
-    # @since 2.1.0
     def remove_change(name)
       changed_attributes.delete(name.to_s)
     end
@@ -134,8 +114,6 @@ module Mongoid
     #   person.setters # returns { "title" => "Madam" }
     #
     # @return [ Hash ] A +Hash+ of atomic setters.
-    #
-    # @since 2.0.0
     def setters
       mods = {}
       changes.each_pair do |name, changes|
@@ -163,8 +141,6 @@ module Mongoid
     # @param [ String ] attr The name of the attribute.
     #
     # @return [ Array<Object> ] The old and new values.
-    #
-    # @since 2.1.0
     def attribute_change(attr)
       attr = database_field_name(attr)
       [changed_attributes[attr], attributes[attr]] if attribute_changed?(attr)
@@ -178,8 +154,6 @@ module Mongoid
     # @param [ String ] attr The name of the attribute.
     #
     # @return [ true, false ] Whether the attribute has changed.
-    #
-    # @since 2.1.6
     def attribute_changed?(attr)
       attr = database_field_name(attr)
       return false unless changed_attributes.key?(attr)
@@ -194,8 +168,6 @@ module Mongoid
     # @param [ String ] attr The name of the attribute.
     #
     # @return [ true, false ] If the attribute differs.
-    #
-    # @since 3.0.0
     def attribute_changed_from_default?(attr)
       field = fields[attr]
       return false unless field
@@ -208,8 +180,6 @@ module Mongoid
     #   model.attribute_was("name")
     #
     # @param [ String ] attr The attribute name.
-    #
-    # @since 2.4.0
     def attribute_was(attr)
       attr = database_field_name(attr)
       attribute_changed?(attr) ? changed_attributes[attr] : attributes[attr]
@@ -223,11 +193,9 @@ module Mongoid
     # @param [ String ] attr The name of the attribute.
     #
     # @return [ Object ] The old value.
-    #
-    # @since 2.3.0
     def attribute_will_change!(attr)
       unless changed_attributes.key?(attr)
-        changed_attributes[attr] = read_attribute(attr).__deep_copy__
+        changed_attributes[attr] = read_raw_attribute(attr).__deep_copy__
       end
     end
 
@@ -239,8 +207,6 @@ module Mongoid
     # @param [ String ] attr The name of the attribute.
     #
     # @return [ Object ] The old value.
-    #
-    # @since 2.4.0
     def reset_attribute!(attr)
       attr = database_field_name(attr)
       attributes[attr] = changed_attributes.delete(attr) if attribute_changed?(attr)
@@ -268,8 +234,6 @@ module Mongoid
       # @param [ String ] meth The name of the accessor.
       #
       # @return [ Module ] The fields module.
-      #
-      # @since 2.4.0
       def create_dirty_methods(name, meth)
         create_dirty_change_accessor(name, meth)
         create_dirty_change_check(name, meth)
@@ -278,6 +242,8 @@ module Mongoid
         create_dirty_previous_value_accessor(name, meth)
         create_dirty_reset(name, meth)
         create_dirty_reset_to_default(name, meth)
+        create_dirty_previously_changed?(name, meth)
+        create_dirty_previous_change(name, meth)
       end
 
       # Creates the dirty change accessor.
@@ -287,8 +253,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_change_accessor(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_change") do
@@ -304,8 +268,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_change_check(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_changed?") do
@@ -321,8 +283,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_default_change_check(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_changed_from_default?") do
@@ -338,8 +298,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_previous_value_accessor(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_was") do
@@ -355,8 +313,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_change_flag(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_will_change!") do
@@ -372,8 +328,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_reset(name, meth)
         generated_methods.module_eval do
           re_define_method("reset_#{meth}!") do
@@ -389,8 +343,6 @@ module Mongoid
       #
       # @param [ String ] name The attribute name.
       # @param [ String ] meth The name of the accessor.
-      #
-      # @since 3.0.0
       def create_dirty_reset_to_default(name, meth)
         generated_methods.module_eval do
           re_define_method("reset_#{meth}_to_default!") do
@@ -398,6 +350,36 @@ module Mongoid
           end
         end
       end
+
+      # Creates the dirty change check.
+      #
+      # @example Create the dirty change check.
+      #   Model.create_dirty_previously_changed?("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      def create_dirty_previously_changed?(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_previously_changed?") do
+            previous_changes.keys.include?(name)
+          end
+        end
+      end
+
+      # Creates the dirty change accessor.
+      #
+      # @example Create the dirty change accessor.
+      #   Model.create_dirty_previous_change("name", "alias")
+      #
+      # @param [ String ] name The attribute name.
+      # @param [ String ] meth The name of the accessor.
+      def create_dirty_previous_change(name, meth)
+        generated_methods.module_eval do
+          re_define_method("#{meth}_previous_change") do
+            previous_changes[name]
+          end
+        end
+      end
     end
   end
 end