mongoid 7.5.0 → 7.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32597c6d6b536f273850be1989db0d876026d2bffda067d7923f173c3966faa6
-  data.tar.gz: 97fffa62c90ae5c20e7dcf00eb151b557c26ab5ae676c45b5651efa5143cf34c
+  metadata.gz: e67e9eccd518e5c987bbca2d4943a461d7ceaf382abd091842806fb300dffb1e
+  data.tar.gz: 441f04f551b51c8b5f3300e4158fd7d0b6b0c3406b39dfa073bf1ce11cead324
 SHA512:
-  metadata.gz: dbe0c003a7e058f5ab6ac5592170ef1a26e02bf9be729b889c55a3a70af4e0c8b6e52f7157cc9b40879545689972769bae5deabf6814ce1ebeb97fdf1a128212
-  data.tar.gz: d696cd95560d51b34318e7f25467450dde8461383dd17830f1177363cbf006c863b1268a2b79616e563343a3fd0e388c9d3bde67821b698b4cf0035bbfc9b719
+  metadata.gz: 31d1d76cbe4923b0cb2a54a62d3758183a80ef8c8833448760115d2299153724e8cb2e6160745989357f6a4bbd3e6873380e73f500e13ffb14b307dfa503a3a9
+  data.tar.gz: 9c3acad387939c0bfe4746102e73e24124597bf311adbd3ce301bfe9a6882a066dadbb67ccb05a470a983c6b0d55ca43cce01f247111cd9d64efb2653614fbd8

data/lib/mongoid/cacheable.rb

@@ -15,7 +15,7 @@ module Mongoid
     # plural model name.
     #
     # If new_record?     - will append /new
-    # If not             - will append /id-updated_at.to_s(cache_timestamp_format)
+    # If not             - will append /id-updated_at.to_formatted_s(cache_timestamp_format)
     # Without updated_at - will append /id
     #
     # This is usually called inside a cache() block
@@ -26,7 +26,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_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 do_or_do_not(:updated_at)
       "#{model_key}/#{_id}"
     end
   end

data/lib/mongoid/config.rb

@@ -116,6 +116,12 @@ module Mongoid
     # using and's instead of overwriting them.
     option :overwrite_chained_operators, default: true
 
+    # When this flag is true, the attributes method on a document will return
+    # a BSON::Document when that document is retrieved from the database, and
+    # a Hash otherwise. When this flag is false, the attributes method will
+    # always return a Hash.
+    option :legacy_attributes, default: true
+
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.
     #

data/lib/mongoid/document.rb

@@ -277,8 +277,15 @@ module Mongoid
       #   criteria.
       #
       # @return [ Document ] A new document.
+      #
+      # @api private
       def instantiate(attrs = nil, selected_fields = nil)
-        attributes = attrs || {}
+        attributes = if Mongoid.legacy_attributes
+          attrs
+        else
+          attrs&.to_h
+        end || {}
+
         doc = allocate
         doc.__selected_fields = selected_fields
         doc.instance_variable_set(:@attributes, attributes)

data/lib/mongoid/equality.rb

@@ -44,9 +44,9 @@ module Mongoid
     # @return [ true, false ] True if the classes are equal, false if not.
     def ===(other)
       if Mongoid.legacy_triple_equals
-        super
-      else
         other.class == Class ? self.class === other : self == other
+      else
+        super
       end
     end
 
@@ -73,9 +73,9 @@ module Mongoid
       # @return [ true, false ] True if the classes are equal, false if not.
       def ===(other)
         if Mongoid.legacy_triple_equals
-          other.is_a?(self)
-        else
           other.class == Class ? self <= other : other.is_a?(self)
+        else
+          other.is_a?(self)
         end
       end
     end

data/lib/mongoid/persistence_context.rb

@@ -122,6 +122,21 @@ module Mongoid
       options == other.options
     end
 
+    # Whether the client of the context can be reused later, and therefore should
+    # not be closed.
+    #
+    # If the persistence context is requested with :client option only, it means
+    # that the context should use a client configured in mongoid.yml.
+    # Such clients should not be closed when the context is cleared since they
+    # will be reused later.
+    #
+    # @return [ true | false ] True if client can be reused, otherwise false.
+    #
+    # @api private
+    def reusable_client?
+      @options.keys == [:client]
+    end
+
     private
 
     def set_options!(opts)
@@ -172,8 +187,7 @@ module Mongoid
       #
       # @return [ Mongoid::PersistenceContext ] The persistence context for the object.
       def set(object, options_or_context)
-        key = "[mongoid][#{object.object_id}]:context"
-        existing_context = Thread.current[key]
+        existing_context = get_context(object)
         existing_options = if existing_context
           existing_context.options
         else
@@ -184,7 +198,7 @@ module Mongoid
         end
         new_options = existing_options.merge(options_or_context)
         context = PersistenceContext.new(object, new_options)
-        Thread.current[key] = context
+        store_context(object, context)
       end
 
       # Get the persistence context for a particular class or model instance.
@@ -196,7 +210,7 @@ module Mongoid
       #
       # @return [ Mongoid::PersistenceContext ] The persistence context for the object.
       def get(object)
-        Thread.current["[mongoid][#{object.object_id}]:context"]
+        get_context(object)
       end
 
       # Clear the persistence context for a particular class or model instance.
@@ -211,11 +225,48 @@ module Mongoid
       def clear(object, cluster = nil, original_context = nil)
         if context = get(object)
           unless cluster.nil? || context.cluster.equal?(cluster)
-            context.client.close
+            context.client.close unless context.reusable_client?
           end
         end
       ensure
-        Thread.current["[mongoid][#{object.object_id}]:context"] = original_context
+        store_context(object, original_context)
+      end
+
+      private
+
+      # Key to store persistence contexts in the thread local storage.
+      #
+      # @api private
+      PERSISTENCE_CONTEXT_KEY = :"[mongoid]:persistence_context"
+
+      # Get the persistence context for a given object from the thread local
+      #   storage.
+      #
+      # @param [ Object ] object Object to get the persistance context for.
+      #
+      # @return [ Mongoid::PersistenceContext | nil ] The persistence context
+      #   for the object if previously stored, otherwise nil.
+      #
+      # @api private
+      def get_context(object)
+        Thread.current[PERSISTENCE_CONTEXT_KEY] ||= {}
+        Thread.current[PERSISTENCE_CONTEXT_KEY][object.object_id]
+      end
+
+      # Store persistence context for a given object in the thread local
+      #   storage.
+      #
+      # @param [ Object ] object Object to store the persistance context for.
+      # @param [ Mongoid::PersistenceContext ] context Context to store
+      #
+      # @api private
+      def store_context(object, context)
+        if context.nil?
+          Thread.current[PERSISTENCE_CONTEXT_KEY]&.delete(object.object_id)
+        else
+          Thread.current[PERSISTENCE_CONTEXT_KEY] ||= {}
+          Thread.current[PERSISTENCE_CONTEXT_KEY][object.object_id] = context
+        end
       end
     end
   end

data/lib/mongoid/scopable.rb

@@ -289,15 +289,17 @@ module Mongoid
       # @return [ Method ] The defined method.
       def define_scope_method(name)
         singleton_class.class_eval do
-          define_method(name) do |*args|
-            scoping = _declared_scopes[name]
-            scope = instance_exec(*args, &scoping[:scope])
-            extension = scoping[:extension]
-            to_merge = scope || queryable
-            criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
-            criteria.extend(extension)
-            criteria
-          end
+          ruby2_keywords(
+            define_method(name) do |*args|
+              scoping = _declared_scopes[name]
+              scope = instance_exec(*args, &scoping[:scope])
+              extension = scoping[:extension]
+              to_merge = scope || queryable
+              criteria = to_merge.empty_and_chainable? ? to_merge : with_default_scope.merge(to_merge)
+              criteria.extend(extension)
+              criteria
+            end
+          )
         end
       end
 

data/lib/mongoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mongoid
-  VERSION = "7.5.0"
+  VERSION = "7.5.2"
 end

data/spec/mongoid/association/referenced/has_and_belongs_to_many/proxy_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "spec_helper"
+require_relative "../has_and_belongs_to_many_models.rb"
 
 describe Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy do
 
@@ -3770,4 +3771,33 @@ describe Mongoid::Association::Referenced::HasAndBelongsToMany::Proxy do
       expect(p2.d_ids).to match_array([d2.id])
     end
   end
+
+  # This test is for MONGOID-5344 which tests that the initial call to
+  # signature_ids refers to the same array as subsequent calls to signature_ids.
+  # Prior to the change in that ticket, this test broke because the array
+  # returned from write_attribute (which is triggered the first time the
+  # foreign key array is referenced, to set the default), refers to a different
+  # array to the one stored in the attributes hash. This happened because,
+  # when retrieving a document from the database, the attributes hash is actually
+  # a BSON::Document, which applies a transformation to the array before
+  # storing it.
+  context "when executing concat on foreign key array from the db" do
+    config_override :legacy_attributes, false
+
+    before do
+      HabtmmContract.create!
+      HabtmmSignature.create!
+    end
+
+    let!(:contract) { HabtmmContract.first }
+    let!(:signature) { HabtmmSignature.first }
+
+    before do
+      contract.signature_ids.concat([signature.id])
+    end
+
+    it "works on the first attempt" do
+      expect(contract.signature_ids).to eq([signature.id])
+    end
+  end
 end

data/spec/mongoid/association/referenced/has_many/proxy_spec.rb

@@ -4089,4 +4089,24 @@ describe Mongoid::Association::Referenced::HasMany::Proxy do
       expect(band.same_name).to eq([agent])
     end
   end
+
+  context "when executing concat on foreign key array from the db" do
+    config_override :legacy_attributes, false
+
+    before do
+      Agent.create!
+      Basic.create!
+    end
+
+    let!(:agent) { Agent.first }
+    let!(:basic) { Basic.first }
+
+    before do
+      agent.basic_ids.concat([basic.id])
+    end
+
+    it "works on the first attempt" do
+      expect(agent.basic_ids).to eq([basic.id])
+    end
+  end
 end

data/spec/mongoid/attributes_spec.rb

@@ -1675,6 +1675,50 @@ describe Mongoid::Attributes do
         end
       end
     end
+
+    context "when comparing the object_ids of the written value" do
+      config_override :legacy_attributes, false
+
+      before do
+        Person.create!
+      end
+
+      let(:person) do
+        Person.first
+      end
+
+      context "when the field is not resizable" do
+        let(:test) do
+          person.write_attribute(:test, "aliased field to test")
+        end
+
+        it "has the same object_id as the attributes hash value" do
+          expect(test.object_id).to eq(person.test.object_id)
+        end
+      end
+
+      context "when the field is resizable" do
+
+        let(:arrays) do
+          person.write_attribute(:arrays, [])
+        end
+
+        it "has the same object_id as the attributes hash value" do
+          expect(arrays.object_id).to eq(person.arrays.object_id)
+        end
+      end
+
+      context "when the field is a HABTM foreign key array" do
+
+        let(:preference_ids) do
+          person.write_attribute(:preference_ids, [])
+        end
+
+        it "has the same object_id as the attributes hash value" do
+          expect(preference_ids.object_id).to eq(person.preference_ids.object_id)
+        end
+      end
+    end
   end
 
   describe "#typed_value_for" do

data/spec/mongoid/cacheable_spec.rb

@@ -45,7 +45,7 @@ describe Mongoid::Cacheable do
         context "with the default cache_timestamp_format" do
 
           let!(:updated_at) do
-            document.updated_at.utc.to_s(:nsec)
+            document.updated_at.utc.to_formatted_s(:nsec)
           end
 
           it "has the id and updated_at key name" do
@@ -64,7 +64,7 @@ describe Mongoid::Cacheable do
           end
 
           let!(:updated_at) do
-            document.updated_at.utc.to_s(:number)
+            document.updated_at.utc.to_formatted_s(:number)
           end
 
           it "has the id and updated_at key name" do
@@ -103,7 +103,7 @@ describe Mongoid::Cacheable do
       end
 
       let!(:updated_at) do
-        agent.updated_at.utc.to_s(:nsec)
+        agent.updated_at.utc.to_formatted_s(:nsec)
       end
 
       it "has the id and updated_at key name" do

data/spec/mongoid/clients_spec.rb

@@ -1012,6 +1012,36 @@ describe Mongoid::Clients do
         end
       end
     end
+
+    context 'when requesting named client' do
+      let(:secondary_client) do
+        double(Mongo::Client).tap do |client|
+          allow(client).to receive(:cluster).and_return(double("cluster"))
+        end
+      end
+
+      before do
+        expect(Mongoid::Clients::Factory).to receive(:create)
+          .with(:secondary)
+          .and_return(secondary_client)
+      end
+
+      after do
+        Mongoid::Clients.clients.delete(:secondary)
+      end
+
+      it 'does not close the client' do
+        expect(secondary_client).not_to receive(:close)
+
+        Band.with(client: :default) do |klass|
+          klass.mongo_client
+        end
+
+        Band.with(client: :secondary) do |klass|
+          klass.mongo_client
+        end
+      end
+    end
   end
 
   context "when overriding the default database" do

data/spec/mongoid/config_spec.rb

@@ -335,6 +335,13 @@ describe Mongoid::Config do
     it_behaves_like "a config option"
   end
 
+  context 'when setting the legacy_attributes option in the config' do
+    let(:option) { :legacy_attributes }
+    let(:default) { true }
+
+    it_behaves_like "a config option"
+  end
+
   describe "#load!" do
 
     before(:all) do

data/spec/mongoid/equality_spec.rb

@@ -85,8 +85,8 @@ describe Mongoid::Equality do
 
   describe ".===" do
 
-    context "when legacy_triple_equals is set" do
-      config_override :legacy_triple_equals, true
+    context "when legacy_triple_equals is not set" do
+      config_override :legacy_triple_equals, false
 
       context "when comparable is an instance of this document" do
 
@@ -128,8 +128,8 @@ describe Mongoid::Equality do
       end
     end
 
-    context "when legacy_triple_equals is not set" do
-      config_override :legacy_triple_equals, false
+    context "when legacy_triple_equals is set" do
+      config_override :legacy_triple_equals, true
 
       context "when comparable is an instance of this document" do
 
@@ -205,8 +205,8 @@ describe Mongoid::Equality do
 
         context "when the class is the same" do
 
-          it "returns false" do
-            expect(person === Person).to be false
+          it "returns true" do
+            expect(person === Person).to be true
           end
         end
 
@@ -219,8 +219,8 @@ describe Mongoid::Equality do
 
         context "when the class is a superclass" do
 
-          it "returns false" do
-            expect(Doctor.new === Person).to be false
+          it "returns true" do
+            expect(Doctor.new === Person).to be true
           end
         end
       end
@@ -256,8 +256,8 @@ describe Mongoid::Equality do
       context "when comparing to a class" do
         context "when the class is the same" do
 
-          it "returns true" do
-            expect(person === Person).to be true
+          it "returns false" do
+            expect(person === Person).to be false
           end
         end
 
@@ -270,8 +270,8 @@ describe Mongoid::Equality do
 
         context "when the class is a superclass" do
 
-          it "returns true" do
-            expect(Doctor.new === Person).to be true
+          it "returns false" do
+            expect(Doctor.new === Person).to be false
           end
         end
       end

data/spec/mongoid/persistence_context_spec.rb

@@ -39,7 +39,6 @@ describe Mongoid::PersistenceContext do
     end
   end
 
-
   describe '.get' do
 
     let(:options) do
@@ -134,6 +133,32 @@ describe Mongoid::PersistenceContext do
         end
       end
     end
+
+    context 'with reusable client' do
+      let(:options) do
+        {client: :some_client}
+      end
+
+      let(:cluster) do
+        double(Mongo::Cluster)
+      end
+
+      let(:client) do
+        double(Mongo::Client).tap do |client|
+          allow(client).to receive(:cluster).and_return(cluster)
+        end
+      end
+
+      before do
+        expect(Mongoid::Clients).to receive(:with_name).with(:some_client).and_return(client)
+        expect(client).not_to receive(:close)
+      end
+
+      it 'does not close the client' do
+        described_class.set(object, options)
+        described_class.clear(object, cluster.dup)
+      end
+    end
   end
 
   describe '#initialize' do

data/spec/mongoid/scopable_spec.rb

@@ -481,27 +481,45 @@ describe Mongoid::Scopable do
 
       context "when a block is provided" do
 
-        before do
-          Band.scope(:active, ->{ Band.where(active: true) }) do
-            def add_origin
-              tap { |c| c.selector[:origin] = "Deutschland" }
-            end
+        context "when with optional and keyword arguments" do
+          before do
+            Band.scope(:named_by, ->(name, deleted: false) {
+              Band.where(name: name, deleted: deleted)
+            })
           end
-        end
 
-        after do
-          class << Band
-            undef_method :active
+          let(:scope) do
+            Band.named_by("Emily", deleted: true)
           end
-          Band._declared_scopes.clear
-        end
 
-        let(:scope) do
-          Band.active.add_origin
+          it "sets the conditions from keyword arguments" do
+            scope.selector.should == {'name' => 'Emily', 'deleted' => true}
+          end
         end
 
-        it "adds the extension to the scope" do
-          expect(scope.selector).to eq({ "active" => true, "origin" => "Deutschland" })
+        context "when without arguments" do
+          before do
+            Band.scope(:active, ->{ Band.where(active: true) }) do
+              def add_origin
+                tap { |c| c.selector[:origin] = "Deutschland" }
+              end
+            end
+          end
+
+          after do
+            class << Band
+              undef_method :active
+            end
+            Band._declared_scopes.clear
+          end
+
+          let(:scope) do
+            Band.active.add_origin
+          end
+
+          it "adds the extension to the scope" do
+            expect(scope.selector).to eq({ "active" => true, "origin" => "Deutschland" })
+          end
         end
       end
 

data/spec/shared/lib/mrss/docker_runner.rb

@@ -123,6 +123,10 @@ module Mrss
     end
 
     def run_deployment
+      puts(BASE_TEST_COMMAND + tty_arg + extra_env + [
+        '-e', %q`TEST_CMD=watch -x bash -c "ps awwxu |egrep 'mongo|ocsp'"`,
+        '-e', 'BIND_ALL=true',
+      ] + port_forwards + [image_tag] + script.split(/\s+/))
       run_command(BASE_TEST_COMMAND + tty_arg + extra_env + [
         '-e', %q`TEST_CMD=watch -x bash -c "ps awwxu |egrep 'mongo|ocsp'"`,
         '-e', 'BIND_ALL=true',