mongoid 7.3.2 → 7.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27ef7fb0ba8610ab6cd4cf814a5a47361fe909247a85535c807d90dbf70c1563
-  data.tar.gz: fe110c6f5439f985325f3df374bfc87fa5c9133eb97cac501dd9166b8d45cf60
+  metadata.gz: efce0ba93d948e87b85aa1a6e1a0768ecb2bd17a052d5e34afb426c357391492
+  data.tar.gz: 39784e3b229e457971b79962c26e22f3f1e721c68d72268bdafafa821c245c80
 SHA512:
-  metadata.gz: 3f963e5e7fb3a7705d36ce9a6d24fb09106ca2ccca52d1a2cf24ddbf9a98773206d315374d4ecc40ad6a208be75ad0de5e44a6d43285faa3304ec641d91de3fa
-  data.tar.gz: 167e2188b8801cb0a4eb15ec98727e3f331eab9f0588923f80f5f3cf2e29eec8b9cf6a01ace242d6412ea578a9fa7e4de309278a309c0d84b5cc07091f74828f
+  metadata.gz: f690e5ca59dfdf1e658ac922c5e8c0e0de1bef099f005205cab26b4e27922ce82b64dae38e803673b32e73f9327746562548c3f9667a4d3fd275483729e6ff3d
+  data.tar.gz: b87aef76b5145507b5e48f8516f4b27b99f401d7afb2fa56441d1d47540eac6f3f7bf198fadfd995e9fc08b0563727b6a5c4f7ce5014456e0dd4a6d345cdf3bb

data/lib/config/locales/en.yml

@@ -80,6 +80,12 @@ en:
             different collections so a simple id lookup is not sufficient enough."
           resolution: "Don't attempt to perform this action and have patience,
             maybe this will be supported in the future."
+        empty_config_file:
+          message: "Empty configuration file: %{path}."
+          summary: "Your mongoid.yml configuration file appears to be empty."
+          resolution: "Ensure your configuration file contains the correct contents.
+            Please consult the following page with respect to Mongoid's configuration:
+            https://docs.mongodb.com/mongoid/current/reference/configuration/"
         invalid_collection:
           message: "Access to the collection for %{klass} is not allowed."
           summary: "%{klass}.collection was called, and %{klass} is an embedded
@@ -94,6 +100,13 @@ en:
             A collation option is only supported if the query is executed on a MongoDB server
             with version >= 3.4."
           resolution: "Remove the collation option from the query."
+        invalid_config_file:
+          message: "Invalid configuration file: %{path}."
+          summary: "Your mongoid.yml configuration file does not contain the
+            correct file structure."
+          resolution: "Ensure your configuration file contains the correct contents.
+            Please consult the following page with respect to Mongoid's configuration:
+            https://docs.mongodb.com/mongoid/current/reference/configuration/"
         invalid_config_option:
           message: "Invalid configuration option: %{name}."
           summary: "A invalid configuration option was provided in your

data/lib/mongoid/association/embedded/batchable.rb

@@ -82,6 +82,8 @@ module Mongoid
         def batch_replace(docs)
           if docs.blank?
             if _assigning? && !empty?
+              _base.delayed_atomic_sets.delete(path)
+              clear_atomic_path_cache
               _base.add_atomic_unset(first)
               target_duplicate = _target.dup
               pre_process_batch_remove(target_duplicate, :delete)
@@ -93,6 +95,8 @@ module Mongoid
             _base.delayed_atomic_sets.clear unless _assigning?
             docs = normalize_docs(docs).compact
             _target.clear and _unscoped.clear
+            _base.delayed_atomic_unsets.delete(path)
+            clear_atomic_path_cache
             inserts = execute_batch_set(docs)
             add_atomic_sets(inserts)
           end
@@ -250,7 +254,22 @@ module Mongoid
         #
         # @since 3.0.0
         def path
-          @path ||= _unscoped.first.atomic_path
+          @path ||= if _unscoped.empty?
+            Mongoid::Atomic::Paths::Embedded::Many.position_without_document(_base, _association)
+          else
+            _unscoped.first.atomic_path
+          end
+        end
+
+        # Clear the cache for path and atomic_paths. This method is used when
+        # the path method is used, and the association has not been set on the
+        # document yet, which can cause path and atomic_paths to be calculated
+        # incorrectly later.
+        #
+        # @api private
+        def clear_atomic_path_cache
+          self.path = nil
+          _base.instance_variable_set("@atomic_paths", nil)
         end
 
         # Set the atomic path.

data/lib/mongoid/association/referenced/has_many/enumerable.rb

@@ -209,9 +209,9 @@ module Mongoid
           # @since 2.1.0
           def empty?
             if _loaded?
-              in_memory.count == 0
+              in_memory.empty?
             else
-              _unloaded.count + _added.count == 0
+              _added.empty? && !_unloaded.exists?
             end
           end
 
@@ -242,11 +242,7 @@ module Mongoid
           def any?(*args)
             return super if args.any? || block_given?
 
-            if _loaded?
-              in_memory.length > 0
-            else
-              _unloaded.exists? || _added.length > 0
-            end
+            !empty?
           end
 
           # Get the first document in the enumerable. Will check the persisted

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -506,8 +506,8 @@ module Mongoid
             selector = conditions || {}
             removed = klass.send(method, selector.merge!(criteria.selector))
             _target.delete_if do |doc|
-              if doc._matches?(selector)
-                unbind_one(doc) and true
+              doc._matches?(selector).tap do |b|
+                unbind_one(doc) if b
               end
             end
             removed

data/lib/mongoid/association/relatable.rb

@@ -122,6 +122,8 @@ module Mongoid
       # @since 7.0
       def inverses(other = nil)
         return [ inverse_of ] if inverse_of
+        return [] if @options.key?(:inverse_of) && !inverse_of
+
         if polymorphic?
           polymorphic_inverses(other)
         else

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

@@ -39,6 +39,25 @@ module Mongoid
             locator = document.new_record? ? "" : ".#{document._index}"
             "#{pos}#{"." unless pos.blank?}#{document._association.store_as}#{locator}"
           end
+
+          class << self
+
+            # Get the position of where the document would go for the given
+            # association. The use case for this function is when trying to
+            # persist an empty list for an embedded association. All of the
+            # existing functions for getting the position to store a document
+            # require passing in a document to store, which we don't have when
+            # trying to store the empty list.
+            #
+            # @param [ Document ] parent The parent document to store in.
+            # @param [ Association ] association The association.
+            #
+            # @return [ String ] The position string.
+            def position_without_document(parent, association)
+              pos = parent.atomic_position
+              "#{pos}#{"." unless pos.blank?}#{association.store_as}"
+            end
+          end
         end
       end
     end

data/lib/mongoid/atomic.rb

@@ -385,11 +385,35 @@ module Mongoid
       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/config/environment.rb

@@ -52,7 +52,15 @@ module Mongoid
       # @api private
       def load_yaml(path, environment = nil)
         env = environment ? environment.to_s : env_name
-        YAML.load(ERB.new(File.new(path).read).result)[env]
+        contents = File.new(path).read
+        if contents.empty?
+          raise Mongoid::Errors::EmptyConfigFile.new(path)
+        end
+        data = YAML.load(ERB.new(contents).result)
+        unless data.is_a?(Hash)
+          raise Mongoid::Errors::InvalidConfigFile.new(path)
+        end
+        data[env]
       end
     end
   end

data/lib/mongoid/contextual/atomic.rb

@@ -173,13 +173,18 @@ module Mongoid
       # @example Unset the field on the matches.
       #   context.unset(:name)
       #
-      # @param [ String, Symbol, Array ] args The name of the fields.
+      # @param [ String | Symbol | Array<String|Symbol> | Hash ] args
+      #   The name(s) of the field(s) to unset.
+      #   If a Hash is specified, its keys will be used irrespective of what
+      #   each key's value is, even if the value is nil or false.
       #
       # @return [ nil ] Nil.
       #
       # @since 3.0.0
       def unset(*args)
-        fields = args.__find_args__.collect { |f| [database_field_name(f), true] }
+        fields = args.map { |a| a.is_a?(Hash) ? a.keys : a }
+                     .__find_args__
+                     .map { |f| [database_field_name(f), true] }
         view.update_many("$unset" => Hash[fields])
       end
 

data/lib/mongoid/contextual/none.rb

@@ -112,6 +112,9 @@ module Mongoid
         entries.length
       end
       alias :size :length
+
+      alias :find_first :first
+      alias :one :first
     end
   end
 end

data/lib/mongoid/criteria/queryable/selectable.rb

@@ -597,7 +597,7 @@ module Mongoid
               end
               _mongoid_expand_keys(new_s).each do |k, v|
                 k = k.to_s
-                if c.selector[k] || k[0] == ?$
+                if c.selector[k] || k.start_with?('$')
                   c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and')
                 else
                   if v.is_a?(Hash)
@@ -890,7 +890,7 @@ module Mongoid
           clone.tap do |query|
             normalized.each do |field, value|
               field_s = field.to_s
-              if field_s[0] == ?$
+              if field_s.start_with?('$')
                 # Query expression-level operator, like $and or $where
                 query.add_operator_expression(field_s, value)
               else

data/lib/mongoid/criteria/queryable/storable.rb

@@ -38,7 +38,7 @@ module Mongoid
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field[0] == ?$
+          if field.start_with?('$')
             raise ArgumentError, "Field cannot be an operator (i.e. begin with $): #{field}"
           end
 
@@ -48,14 +48,14 @@ module Mongoid
             if value.is_a?(Hash) && selector[field].is_a?(Hash) &&
               value.keys.all? { |key|
                 key_s = key.to_s
-                key_s[0] == ?$ && !selector[field].key?(key_s)
+                key_s.start_with?('$') && !selector[field].key?(key_s)
               }
             then
               # Multiple operators can be combined on the same field by
               # adding them to the existing hash.
               new_value = selector[field].merge(value)
               selector.store(field, new_value)
-            else
+            elsif selector[field] != value
               add_operator_expression('$and', [{field => value}])
             end
           else
@@ -185,7 +185,7 @@ module Mongoid
             raise ArgumentError, "Operator must be a string: #{operator}"
           end
 
-          unless operator[0] == ?$
+          unless operator.start_with?('$')
             raise ArgumentError, "Operator must begin with $: #{operator}"
           end
 
@@ -220,7 +220,7 @@ module Mongoid
             raise ArgumentError, "Field must be a string: #{field}"
           end
 
-          if field[0] == ?$
+          if field.start_with?('$')
             add_operator_expression(field, value)
           else
             add_field_expression(field, value)

data/lib/mongoid/document.rb

@@ -194,8 +194,8 @@ module Mongoid
     #
     # @param [ Hash ] options The options.
     #
-    # @option options [ true, false ] :compact Whether to include fields with
-    #   nil values in the json document.
+    # @option options [ true, false ] :compact (Deprecated) Whether to include fields
+    #   with nil values in the json document.
     #
     # @return [ Hash ] The document as json.
     #
@@ -203,6 +203,7 @@ module Mongoid
     def as_json(options = nil)
       rv = super
       if options && options[:compact]
+        Mongoid.logger.warn('#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.')
         rv = rv.compact
       end
       rv

data/lib/mongoid/errors/empty_config_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    # This error is raised when an empty configuration file is attempted to be
+    # loaded.
+    class EmptyConfigFile < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ String ] path The path of the config file used.
+      #
+      # @api private
+      def initialize(path)
+        super(
+          compose_message(
+            "empty_config_file",
+            { path: path }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_config_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad configuration file is attempted to be
+    # loaded.
+    class InvalidConfigFile < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ String ] path The path of the config file used.
+      #
+      # @api private
+      def initialize(path)
+        super(
+          compose_message(
+            "invalid_config_file",
+            { path: path }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors.rb

@@ -8,8 +8,10 @@ require "mongoid/errors/criteria_argument_required"
 require "mongoid/errors/document_not_destroyed"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/eager_load"
+require "mongoid/errors/empty_config_file"
 require "mongoid/errors/in_memory_collation_not_supported"
 require "mongoid/errors/invalid_collection"
+require "mongoid/errors/invalid_config_file"
 require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"

data/lib/mongoid/persistable/upsertable.rb

@@ -23,7 +23,7 @@ module Mongoid
       # @since 3.0.0
       def upsert(options = {})
         prepare_upsert(options) do
-          collection.find(atomic_selector).update_one(
+          collection.find(atomic_selector).replace_one(
               as_attributes, upsert: true, session: _session)
         end
       end

data/lib/mongoid/persistence_context.rb

@@ -237,7 +237,9 @@ module Mongoid
       # @since 6.0.0
       def clear(object, cluster = nil, original_context = nil)
         if context = get(object)
-          context.client.close unless (context.cluster.equal?(cluster) || cluster.nil?)
+          unless cluster.nil? || context.cluster.equal?(cluster)
+            context.client.close
+          end
         end
       ensure
         Thread.current["[mongoid][#{object.object_id}]:context"] = original_context

data/lib/mongoid/query_cache.rb

@@ -7,8 +7,14 @@ module Mongoid
   #
   # @since 4.0.0
   module QueryCache
-    class << self
+    # @api private
+    LEGACY_WARNING = <<~DOC
+      You are using the legacy Mongoid query cache which has known issues.
+      Please upgrade the `mongo' gem to at least 2.14.0 to use the improved driver query cache.
+      Refer to: https://docs.mongodb.com/mongoid/current/tutorials/mongoid-queries/#the-improved-driver-query-cache
+    DOC
 
+    class << self
       # Get the cached queries.
       #
       # @example Get the cached queries from the current thread.
@@ -86,6 +92,10 @@ module Mongoid
         if defined?(Mongo::QueryCache)
           Mongo::QueryCache.cache(&block)
         else
+          @legacy_query_cache_warned ||= begin
+            Mongoid.logger.warn(LEGACY_WARNING)
+            true
+          end
           enabled = QueryCache.enabled?
           QueryCache.enabled = true
           begin

data/lib/mongoid/tasks/database.rb

@@ -123,7 +123,7 @@ module Mongoid
           next if model.shard_config.nil?
 
           if model.embedded? && !model.cyclic?
-            logger.warn("MONGOID: #{model} has shard config but is emdedded")
+            logger.warn("MONGOID: #{model} has shard config but is embedded")
             next
           end
 

data/lib/mongoid/touchable.rb

@@ -41,6 +41,16 @@ module Mongoid
           # _association.inverse_association.options but inverse_association
           # seems to not always/ever be set here. See MONGOID-5014.
           _parent.touch
+
+          if field
+            # If we are told to also touch a field, perform a separate write
+            # for that field. See MONGOID-5136.
+            # In theory we should combine the writes, which would require
+            # passing the fields to be updated to the parents - MONGOID-5142.
+            sets = set_field_atomic_updates(field)
+            selector = atomic_selector
+            _root.collection.find(selector).update_one(positionally(selector, sets), session: _session)
+          end
         else
           # If the current document is not embedded, it is composition root
           # and we need to persist the write here.

data/lib/mongoid/version.rb

@@ -2,5 +2,5 @@
 # encoding: utf-8
 
 module Mongoid
-  VERSION = "7.3.2"
+  VERSION = "7.3.5"
 end

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -80,8 +80,13 @@ development:
         # (default: 10)
         # connect_timeout: 10
 
-        # The timeout to wait to execute operations on a socket before raising an error.
-        # (default: 5)
+        # How long to wait for a response for each operation sent to the
+        # server. This timeout should be set to a value larger than the
+        # processing time for the longest operation that will be executed
+        # by the application. Note that this is a client-side timeout;
+        # the server may continue executing an operation after the client
+        # aborts it with the SocketTimeout exception.
+        # (default: nil, meaning no timeout)
         # socket_timeout: 5
 
         # The name of the replica set to connect to. Servers provided as seeds that do

data/spec/integration/associations/embeds_many_spec.rb

@@ -65,4 +65,143 @@ describe 'embeds_many associations' do
       include_examples 'does not delete the target from the database'
     end
   end
+
+  context 'assigning attributes to the same association' do
+    context 'setting then clearing' do
+      let(:canvas) do
+        Canvas.create!(shapes: [Shape.new])
+      end
+
+      shared_examples 'persists correctly' do
+        it 'persists correctly' do
+          canvas.shapes.should be_empty
+          _canvas = Canvas.find(canvas.id)
+          _canvas.shapes.should be_empty
+        end
+      end
+
+      context 'via assignment operator' do
+        before do
+          canvas.shapes = [Shape.new, Shape.new]
+          canvas.shapes = []
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+
+      context 'via attributes=' do
+        before do
+          canvas.attributes = {shapes: [Shape.new, Shape.new]}
+          canvas.attributes = {shapes: []}
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+
+      context 'via assign_attributes' do
+        before do
+          canvas.assign_attributes(shapes: [Shape.new, Shape.new])
+          canvas.assign_attributes(shapes: [])
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+    end
+
+    context 'clearing then setting' do
+      let(:canvas) do
+        Canvas.create!(shapes: [Shape.new])
+      end
+
+      shared_examples 'persists correctly' do
+        it 'persists correctly' do
+          canvas.shapes.length.should eq 2
+          _canvas = Canvas.find(canvas.id)
+          _canvas.shapes.length.should eq 2
+        end
+      end
+
+      context 'via assignment operator' do
+        before do
+          canvas.shapes = []
+          canvas.shapes = [Shape.new, Shape.new]
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+
+      context 'via attributes=' do
+        before do
+          canvas.attributes = {shapes: []}
+          canvas.attributes = {shapes: [Shape.new, Shape.new]}
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+
+      context 'via assign_attributes' do
+        before do
+          canvas.assign_attributes(shapes: [])
+          canvas.assign_attributes(shapes: [Shape.new, Shape.new])
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+    end
+
+    context 'updating a child then clearing' do
+      let(:canvas) do
+        Canvas.create!(shapes: [Shape.new])
+      end
+
+      shared_examples 'persists correctly' do
+        it 'persists correctly' do
+          canvas.shapes.should be_empty
+          _canvas = Canvas.find(canvas.id)
+          _canvas.shapes.should be_empty
+        end
+      end
+
+      context 'via assignment operator' do
+        before do
+          # Mongoid uses the new value of `x` in the $pullAll query,
+          # which doesn't match the document that is in the database,
+          # resulting in the empty array assignment not taking effect.
+          pending 'MONGOID-5037'
+
+          canvas.shapes.first.x = 1
+          canvas.shapes = []
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+
+      context 'via attributes=' do
+        before do
+          canvas.shapes.first.x = 1
+          canvas.attributes = {shapes: []}
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+
+      context 'via assign_attributes' do
+        before do
+          canvas.shapes.first.x = 1
+          canvas.assign_attributes(shapes: [])
+          canvas.save!
+        end
+
+        include_examples 'persists correctly'
+      end
+    end
+  end
 end