mongoid 5.4.1 → 7.4.0

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,16 +31,15 @@ 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?
-        class_eval <<-READER, __FILE__, __LINE__ + 1
-          def #{name}
-            attribute_will_change!(#{name.inspect})
-            read_attribute(#{name.inspect})
+
+        class_eval do
+          define_method(name) do
+            attribute_will_change!(name)
+            read_raw_attribute(name)
           end
-        READER
+        end
       end
 
       # Define a reader method for a dynamic attribute before type cast.
@@ -54,15 +50,13 @@ 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 <<-READER, __FILE__, __LINE__ + 1
-          def #{name}_before_type_cast
-            attribute_will_change!(#{name.inspect})
-            read_attribute_before_type_cast(#{name.inspect})
+        class_eval do
+          define_method("#{name}_before_type_cast") do
+            attribute_will_change!(name)
+            read_attribute_before_type_cast(name)
           end
-        READER
+        end
       end
 
       # Define a writer method for a dynamic attribute.
@@ -73,16 +67,14 @@ 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?
 
-        class_eval <<-WRITER, __FILE__, __LINE__ + 1
-          def #{name}=(value)
-            write_attribute(#{name.inspect}, value)
+        class_eval do
+          define_method("#{name}=") do |value|
+            write_attribute(name, value)
           end
-        WRITER
+        end
       end
 
       # If the attribute is dynamic, add a field for it with a type of object
@@ -93,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
@@ -110,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
@@ -130,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)
@@ -147,7 +133,7 @@ module Mongoid
           getter = attr.reader
           define_dynamic_reader(getter)
           attribute_will_change!(attr.reader)
-          read_attribute(getter)
+          read_raw_attribute(getter)
         end
       end
     end

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?
@@ -42,21 +41,27 @@ module Mongoid
         #   to a class method to reject documents with.
         # @option *args [ Integer ] :limit The max number to create.
         # @option *args [ true, false ] :update_only Only update existing docs.
+        # @options *args [ true, false ] :autosave Whether autosave should be enabled on the
+        #   association. Note that since the default is true, setting autosave to nil will still
+        #   enable it.
         def accepts_nested_attributes_for(*args)
-          options = args.extract_options!
+          options = args.extract_options!.dup
+          options[:autosave] = true if options[:autosave].nil?
+
           options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
           args.each do |name|
             meth = "#{name}_attributes="
             self.nested_attributes["#{name}_attributes"] = meth
-            metadata = relations[name.to_s]
-            raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless metadata
-            autosave_nested_attributes(metadata)
+            association = relations[name.to_s]
+            raise Errors::NestedAttributesMetadataNotFound.new(self, name) unless association
+            autosave_nested_attributes(association) if options[:autosave]
+
             re_define_method(meth) do |attrs|
               _assigning do
-                if metadata.polymorphic? and metadata.inverse_type
-                  options = options.merge!(:class_name => self.send(metadata.inverse_type))
+                if association.polymorphic? and association.inverse_type
+                  options = options.merge!(:class_name => self.send(association.inverse_type))
                 end
-                metadata.nested_builder(attrs, options).build(self)
+                association.nested_builder(attrs, options).build(self)
               end
             end
           end
@@ -64,19 +69,22 @@ module Mongoid
 
         private
 
-        # Add the autosave information for the nested relation.
+        # Add the autosave information for the nested association.
         #
         # @api private
         #
         # @example Add the autosave if appropriate.
         #   Person.autosave_nested_attributes(metadata)
         #
-        # @param [ Metadata ] metadata The existing relation metadata.
-        #
-        # @since 3.1.4
-        def autosave_nested_attributes(metadata)
-          unless metadata.autosave == false
-            autosave(metadata.merge!(autosave: true))
+        # @param [ Association ] 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
+          # Association#autosave? is implemented by checking the autosave option, this is the most
+          # straightforward way to mark it.
+          if association.autosave? || (association.options[:autosave].nil? && !association.embedded?)
+            association.options[:autosave] = true
+            Association::Referenced::AutoSave.define_autosave!(association)
           end
         end
       end

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,25 +106,21 @@ 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|
-          metadata = relations[name]
+          association = relations[name]
           if value.is_a?(Hash)
-            metadata.nested_builder(value, {}).build(self)
+            association.nested_builder(value, {}).build(self)
           else
             send("#{name}=", value)
           end

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,10 +21,28 @@ 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?(database_field_name(name))
+        new_record? || (!readonly_attributes.include?(name) && _loaded?(name))
+      end
+
+      private
+
+      def as_writable_attribute!(name, value = :nil)
+        normalized_name = database_field_name(name)
+        if attribute_writable?(normalized_name)
+          yield(normalized_name)
+        else
+          raise Errors::ReadonlyAttribute.new(name, value)
+        end
+      end
+
+      def _loaded?(name)
+        __selected_fields.nil? || projected_field?(name)
+      end
+
+      def projected_field?(name)
+        projected = (__selected_fields || {}).keys.select { |f| __selected_fields[f] == 1 }
+        projected.empty? || projected.include?(name)
       end
 
       module ClassMethods
@@ -43,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)