mongoid 7.0.10 → 7.4.0

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

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Atomic
     module Paths
       module Embedded
 
-        # This class encapsulates behaviour for locating and updating
+        # This class encapsulates behavior for locating and updating
         # documents that are defined as an embedded 1-1.
         class One
           include Embedded
@@ -15,23 +16,19 @@ module Mongoid
           #   One.new(document)
           #
           # @param [ Document ] document The document to generate the paths for.
-          #
-          # @since 2.1.0
           def initialize(document)
             @document, @parent = document, document._parent
             @insert_modifier, @delete_modifier ="$set", "$unset"
           end
 
           # Get the position of the document in the hierarchy. This will
-          # include indexes of 1-n embedded relations that may sit above the
+          # include indexes of 1-n embedded associations that may sit above the
           # embedded one.
           #
           # @example Get the position.
           #   one.position
           #
           # @return [ String ] The position of the document.
-          #
-          # @since 2.1.0
           def position
             pos = parent.atomic_position
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}"

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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/atomic/paths/embedded/one"
 require "mongoid/atomic/paths/embedded/many"
 
@@ -17,8 +18,6 @@ module Mongoid
         #   many.path
         #
         # @return [ String ] The path to the document.
-        #
-        # @since 2.1.0
         def path
           @path ||= position.sub(/\.\d+\z/, "")
         end

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

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Atomic
     module Paths
 
-      # This class encapsulates behaviour for locating and updating root
+      # This class encapsulates behavior for locating and updating root
       # documents atomically.
       class Root
 
@@ -15,21 +16,17 @@ module Mongoid
         #   Root.new(document)
         #
         # @param [ Document ] document The document to generate the paths for.
-        #
-        # @since 2.1.0
         def initialize(document)
           @document, @path, @position = document, "", ""
         end
 
         # Asking for the insert modifier on a document with a root path
-        # indicates a mixed relation most likely happened.
+        # indicates a mixed association most likely happened.
         #
         # @example Attempt to get the insert modifier.
         #   root.insert_modifier
         #
         # @raise [ Errors::InvalidPath ] The error for the attempt.
-        #
-        # @since 3.0.14
         def insert_modifier
           raise Errors::InvalidPath.new(document.class)
         end

data/lib/mongoid/atomic/paths.rb

@@ -1,3 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/atomic/paths/embedded"
 require "mongoid/atomic/paths/root"

data/lib/mongoid/atomic.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/atomic/modifiers"
 require "mongoid/atomic/paths"
 
@@ -32,8 +33,6 @@ module Mongoid
     #   person.add_atomic_pull(address)
     #
     # @param [ Document ] document The embedded document to pull.
-    #
-    # @since 2.2.0
     def add_atomic_pull(document)
       document.flagged_for_destroy = true
       key = document.association_name.to_s
@@ -49,8 +48,6 @@ module Mongoid
     # @param [ Document ] document The child document.
     #
     # @return [ Array<Document> ] The children.
-    #
-    # @since 3.0.0
     def add_atomic_unset(document)
       document.flagged_for_destroy = true
       key = document.association_name.to_s
@@ -64,8 +61,6 @@ module Mongoid
     #   address.atomic_attribute_name(:city)
     #
     # @return [ String ] The path to the document attribute in the database
-    #
-    # @since 3.0.0
     def atomic_attribute_name(name)
       embedded? ? "#{atomic_position}.#{name}" : name
     end
@@ -76,8 +71,6 @@ module Mongoid
     #   person.atomic_array_pushes
     #
     # @return [ Hash ] The array pushes.
-    #
-    # @since 2.4.0
     def atomic_array_pushes
       @atomic_array_pushes ||= {}
     end
@@ -88,8 +81,6 @@ module Mongoid
     #   person.atomic_array_pulls
     #
     # @return [ Hash ] The array pulls.
-    #
-    # @since 2.4.0
     def atomic_array_pulls
       @atomic_array_pulls ||= {}
     end
@@ -100,8 +91,6 @@ module Mongoid
     #   person.atomic_array_add_to_sets
     #
     # @return [ Hash ] The array add_to_sets.
-    #
-    # @since 2.4.0
     def atomic_array_add_to_sets
       @atomic_array_add_to_sets ||= {}
     end
@@ -127,13 +116,11 @@ module Mongoid
     #   person.atomic_updates(children)
     #
     # @return [ Hash ] The updates and their modifiers.
-    #
-    # @since 2.1.0
     def atomic_updates(_use_indexes = false)
       process_flagged_destroys
       mods = Modifiers.new
       generate_atomic_updates(mods, self)
-      _children.each do |child|
+      _descendants.each do |child|
         child.process_flagged_destroys
         generate_atomic_updates(mods, child)
       end
@@ -190,8 +177,6 @@ module Mongoid
     #   document.atomic_paths
     #
     # @return [ Object ] The associated path.
-    #
-    # @since 2.1.0
     def atomic_paths
       @atomic_paths ||= begin
         if _association
@@ -208,8 +193,6 @@ module Mongoid
     #   person.atomic_pulls
     #
     # @return [ Array<Hash> ] The $pullAll operations.
-    #
-    # @since 2.2.0
     def atomic_pulls
       pulls = {}
       delayed_atomic_pulls.each_pair do |_, docs|
@@ -229,8 +212,6 @@ module Mongoid
     #   person.atomic_pushes
     #
     # @return [ Hash ] The $push and $each operations.
-    #
-    # @since 2.1.0
     def atomic_pushes
       pushable? ? { atomic_position => as_attributes } : {}
     end
@@ -241,8 +222,6 @@ module Mongoid
     #   person.atomic_sets
     #
     # @return [ Hash ] The $set operations.
-    #
-    # @since 2.1.0
     def atomic_sets
       updateable? ? setters : settable? ? { atomic_path => as_attributes } : {}
     end
@@ -253,8 +232,6 @@ module Mongoid
     #   person.atomic_unsets
     #
     # @return [ Array<Hash> ] The $unset operations.
-    #
-    # @since 2.2.0
     def atomic_unsets
       unsets = []
       delayed_atomic_unsets.each_pair do |name, docs|
@@ -273,8 +250,6 @@ module Mongoid
     #   person.delayed_atomic_sets
     #
     # @return [ Hash ] The delayed $sets.
-    #
-    # @since 2.3.0
     def delayed_atomic_sets
       @delayed_atomic_sets ||= {}
     end
@@ -285,8 +260,6 @@ module Mongoid
     #   document.delayed_atomic_pulls
     #
     # @return [ Hash ] name/document pairs.
-    #
-    # @since 2.3.2
     def delayed_atomic_pulls
       @delayed_atomic_pulls ||= {}
     end
@@ -297,8 +270,6 @@ module Mongoid
     #   document.delayed_atomic_unsets
     #
     # @return [ Hash ] The atomic unsets
-    #
-    # @since 3.0.0
     def delayed_atomic_unsets
       @delayed_atomic_unsets ||= {}
     end
@@ -309,8 +280,6 @@ module Mongoid
     #   document.flag_as_destroyed
     #
     # @return [ String ] The atomic path.
-    #
-    # @since 3.0.0
     def flag_as_destroyed
       self.destroyed = true
       self.flagged_for_destroy = false
@@ -323,8 +292,6 @@ module Mongoid
     #   document.flagged_destroys
     #
     # @return [ Array<Proc> ] The flagged destroys.
-    #
-    # @since 3.0.10
     def flagged_destroys
       @flagged_destroys ||= []
     end
@@ -335,8 +302,6 @@ module Mongoid
     #   document.process_flagged_destroys
     #
     # @return [ Array ] The cleared array.
-    #
-    # @since 3.0.10
     def process_flagged_destroys
       _assigning do
         flagged_destroys.each(&:call)
@@ -353,8 +318,6 @@ module Mongoid
     #
     # @param [ Modifiers ] mods The atomic modifications.
     # @param [ Document ] doc The document to update for.
-    #
-    # @since 2.2.0
     def generate_atomic_updates(mods, doc)
       mods.unset(doc.atomic_unsets)
       mods.pull(doc.atomic_pulls)
@@ -377,17 +340,39 @@ module Mongoid
     # @param [ Symbol ] field The optional field.
     #
     # @return [ Hash ] The atomic updates.
-    #
-    # @since 3.0.6
     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|
-        key_regex = /updated_at|u_at#{"|" + field if field.present?}/
-        touches.merge!({ key => value }) if key =~ key_regex
+        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/attributes/dynamic.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Attributes
 
     # This module contains the behavior for dynamic attributes.
-    #
-    # @since 4.0.0
     module Dynamic
       extend ActiveSupport::Concern
 
@@ -17,8 +16,6 @@ module Mongoid
       # @param [ true, false ] include_private
       #
       # @return [ true, false ] True if it does, false if not.
-      #
-      # @since 4.0.0
       def respond_to?(name, include_private = false)
         super || (
           attributes &&
@@ -34,8 +31,6 @@ module Mongoid
       #   model.define_dynamic_reader(:field)
       #
       # @param [ String ] name The name of the field.
-      #
-      # @since 4.0.0
       def define_dynamic_reader(name)
         return unless name.valid_method_name?
 
@@ -55,8 +50,6 @@ module Mongoid
       #   model.define_dynamic_before_type_cast_reader(:field)
       #
       # @param [ String ] name The name of the field.
-      #
-      # @since 4.0.0
       def define_dynamic_before_type_cast_reader(name)
         class_eval do
           define_method("#{name}_before_type_cast") do
@@ -74,8 +67,6 @@ module Mongoid
       #   model.define_dynamic_writer(:field)
       #
       # @param [ String ] name The name of the field.
-      #
-      # @since 4.0.0
       def define_dynamic_writer(name)
         return unless name.valid_method_name?
 
@@ -94,8 +85,6 @@ module Mongoid
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Object ] value The value of the field.
-      #
-      # @since 4.0.0
       def process_attribute(name, value)
         responds = respond_to?("#{name}=")
         if !responds
@@ -111,10 +100,8 @@ module Mongoid
       #   document.inspect_dynamic_fields
       #
       # @return [ String ] An array of pretty printed dynamic field values.
-      #
-      # @since 4.0.0
       def inspect_dynamic_fields
-        keys = attributes.keys - fields.keys - relations.keys - ["_id", "_type"]
+        keys = attributes.keys - fields.keys - relations.keys - ["_id", self.class.discriminator_key]
         return keys.map do |name|
           "#{name}: #{attributes[name].inspect}"
         end
@@ -131,8 +118,6 @@ module Mongoid
       # @param [ Array ] args The arguments to the method.
       #
       # @return [ Object ] The result of the method call.
-      #
-      # @since 4.0.0
       def method_missing(name, *args)
         attr = name.to_s
         return super unless attributes.has_key?(attr.reader)

data/lib/mongoid/attributes/nested.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Attributes
 
-    # Defines behaviour around that lovel Rails feature nested attributes.
-    #
-    # @since 1.0.0
+    # Defines behavior around that lovel Rails feature nested attributes.
     module Nested
       extend ActiveSupport::Concern
 
@@ -19,8 +18,8 @@ module Mongoid
           attributes.all? { |key, value| key == '_destroy' || value.blank? }
         }
 
-        # Used when needing to update related models from a parent relation. Can
-        # be used on embedded or referenced relations.
+        # Used when needing to update related models from a parent association. Can
+        # be used on embedded or referenced associations.
         #
         # @example Defining nested attributes.
         #
@@ -34,7 +33,7 @@ module Mongoid
         #     accepts_nested_attributes_for :addresses, :game, :posts
         #   end
         #
-        # @param [ Array<Symbol>, Hash ] args A list of relation names, followed
+        # @param [ Array<Symbol>, Hash ] args A list of association names, followed
         #   by a hash of options.
         #
         # @option *args [ true, false ] :allow_destroy Can deletion occur?
@@ -70,7 +69,7 @@ module Mongoid
 
         private
 
-        # Add the autosave information for the nested relation.
+        # Add the autosave information for the nested association.
         #
         # @api private
         #
@@ -78,8 +77,6 @@ module Mongoid
         #   Person.autosave_nested_attributes(metadata)
         #
         # @param [ Association ] association The existing association metadata.
-        #
-        # @since 3.1.4
         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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Attributes
 
@@ -7,15 +8,13 @@ module Mongoid
 
       # 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 suppied +Hash+ so that no extra nil values get
+      # attributes provided in the supplied +Hash+ so that no extra nil values get
       # put into the document's attributes.
       #
       # @example Process the attributes.
       #   person.process_attributes(:title => "sir", :age => 40)
       #
       # @param [ Hash ] attrs The attributes to set.
-      #
-      # @since 2.0.0.rc.7
       def process_attributes(attrs = nil)
         attrs ||= {}
         if !attrs.empty?
@@ -31,7 +30,7 @@ module Mongoid
 
       private
 
-      # If the key provided is the name of a relation or a nested attribute, we
+      # If the key provided is the name of an association or a nested attribute, we
       # need to wait until all other attributes are set before processing
       # these.
       #
@@ -42,8 +41,6 @@ module Mongoid
       # @param [ Object ] value The value of the attribute.
       #
       # @return [ true, false ] True if pending, false if not.
-      #
-      # @since 2.0.0.rc.7
       def pending_attribute?(key, value)
         name = key.to_s
         if relations.has_key?(name)
@@ -57,14 +54,12 @@ module Mongoid
         return false
       end
 
-      # Get all the pending relations that need to be set.
+      # Get all the pending associations that need to be set.
       #
-      # @example Get the pending relations.
+      # @example Get the pending associations.
       #   document.pending_relations
       #
-      # @return [ Hash ] The pending relations in key/value pairs.
-      #
-      # @since 2.0.0.rc.7
+      # @return [ Hash ] The pending associations in key/value pairs.
       def pending_relations
         @pending_relations ||= {}
       end
@@ -75,8 +70,6 @@ module Mongoid
       #   document.pending_nested
       #
       # @return [ Hash ] The pending nested attributes in key/value pairs.
-      #
-      # @since 2.0.0.rc.7
       def pending_nested
         @pending_nested ||= {}
       end
@@ -89,8 +82,6 @@ module Mongoid
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Object ] value The value of the field.
-      #
-      # @since 2.0.0.rc.7
       def process_attribute(name, value)
         if !respond_to?("#{name}=", true) && store_as = aliased_fields.invert[name.to_s]
           name = store_as
@@ -105,8 +96,6 @@ module Mongoid
       #
       # @example Process the nested attributes.
       #   document.process_nested
-      #
-      # @since 2.0.0.rc.7
       def process_nested
         pending_nested.each_pair do |name, value|
           send("#{name}=", value)
@@ -117,20 +106,16 @@ module Mongoid
       #
       # @example Process the pending items.
       #   document.process_pending
-      #
-      # @since 2.0.0.rc.7
       def process_pending
         process_nested and process_relations
         pending_nested.clear and pending_relations.clear
       end
 
-      # Process all the pending relations that needed to wait until ids were set
+      # Process all the pending associations that needed to wait until ids were set
       # to fire off.
       #
-      # @example Process the relations.
+      # @example Process the associations.
       #   document.process_relations
-      #
-      # @since 2.0.0.rc.7
       def process_relations
         pending_relations.each_pair do |name, value|
           association = relations[name]

data/lib/mongoid/attributes/projector.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Attributes
+
+    # This module defines projection helpers.
+    #
+    # Projection rules are rather non-trivial. See
+    # https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection
+    # for server documentation.
+    # 4.4 server (and presumably all older ones) requires that a projection
+    # for content fields is either exclusionary or inclusionary, i.e. one
+    # cannot mix exclusions and inclusions in the same query.
+    # However, _id can be excluded in a projection that includes content
+    # fields.
+    # Integer projection values other than 0 and 1 aren't officially
+    # documented as of this writing; see DOCSP-15266.
+    # 4.4 server also allows nested hash projection specification
+    # in addition to dot notation, which I assume Mongoid doesn't handle yet.
+    #
+    # @api private
+    class Projector
+      def initialize(projection)
+        if projection
+          @content_projection = projection.dup
+          @content_projection.delete('_id')
+          @id_projection_value = projection['_id']
+        else
+          @content_projection = nil
+          @id_projection_value = nil
+        end
+      end
+
+      attr_reader :id_projection_value
+      attr_reader :content_projection
+
+      # Determine if the specified attribute, or a dot notation path, is allowed
+      # by the configured projection, if any.
+      #
+      # If there is no configured projection, returns true.
+      #
+      # @param [ String ] name The name of the attribute or a dot notation path.
+      #
+      # @return [ true, false ] Whether the attribute is allowed by projection.
+      #
+      # @api private
+      def attribute_or_path_allowed?(name)
+        # Special handling for _id.
+        if name == '_id'
+          result = unless id_projection_value.nil?
+            value_inclusionary?(id_projection_value)
+          else
+            true
+          end
+          return result
+        end
+
+        if content_projection.nil?
+          # No projection (as opposed to an empty projection).
+          # All attributes are allowed.
+          return true
+        end
+
+        # Find an item which matches or is a parent of the requested name/path.
+        # This handles the case when, for example, the projection was
+        # {foo: true} and we want to know if foo.bar is allowed.
+        item, value = content_projection.detect do |path, value|
+          (name + '.').start_with?(path + '.')
+        end
+        if item
+          return value_inclusionary?(value)
+        end
+
+        if content_inclusionary?
+          # Find an item which would be a strict child of the requested name/path.
+          # This handles the case when, for example, the projection was
+          # {"foo.bar" => true} and we want to know if foo is allowed.
+          # (It is as a container of bars.)
+          item, value = content_projection.detect do |path, value|
+            (path + '.').start_with?(name + '.')
+          end
+          if item
+            return true
+          end
+        end
+
+        !content_inclusionary?
+      end
+
+      private
+
+      # Determines whether the projection for content fields is inclusionary.
+      #
+      # An empty projection is inclusionary.
+      def content_inclusionary?
+        if content_projection.empty?
+          return value_inclusionary?(id_projection_value)
+        end
+
+        value_inclusionary?(content_projection.values.first)
+      end
+
+      def value_inclusionary?(value)
+        case value
+        when Integer
+          value >= 1
+        when true
+          true
+        when false
+          false
+        else
+          # The various expressions that are permitted as projection arguments
+          # imply an inclusionary projection.
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/attributes/readonly.rb

@@ -1,8 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Attributes
 
-    # This module defines behaviour for readonly attributes.
+    # This module defines behavior for readonly attributes.
     module Readonly
       extend ActiveSupport::Concern
 
@@ -20,8 +21,6 @@ module Mongoid
       #
       # @return [ true, false ] If the document is new, or if the field is not
       #   readonly.
-      #
-      # @since 3.0.0
       def attribute_writable?(name)
         new_record? || (!readonly_attributes.include?(name) && _loaded?(name))
       end
@@ -63,8 +62,6 @@ module Mongoid
         #   end
         #
         # @param [ Array<Symbol> ] names The names of the fields.
-        #
-        # @since 3.0.0
         def attr_readonly(*names)
           names.each do |name|
             readonly_attributes << database_field_name(name)