mongoid 7.5.4 → 8.1.7

data/spec/mongoid/timestamps_spec_models.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module TimestampsSpec
+  module Touch
+    class User
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      has_and_belongs_to_many :addresses, class_name: "TimestampsSpec::Touch::Address"
+      has_many :accounts, class_name: "TimestampsSpec::Touch::Account"
+      has_one :pet, class_name: "TimestampsSpec::Touch::Pet"
+    end
+
+    class Address
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      has_and_belongs_to_many :users, class_name: "TimestampsSpec::Touch::User"
+    end
+
+    class Account
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      belongs_to :user, required: false, touch: true, class_name: "TimestampsSpec::Touch::User"
+    end
+
+    class Pet
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      belongs_to :user, required: false, touch: true, class_name: "TimestampsSpec::Touch::User"
+    end
+  end
+
+  module NoTouch
+    class User
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      has_and_belongs_to_many :addresses, class_name: "TimestampsSpec::NoTouch::Address"
+      has_many :accounts, class_name: "TimestampsSpec::NoTouch::Account"
+      has_one :pet, class_name: "TimestampsSpec::NoTouch::Pet"
+    end
+
+    class Address
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      has_and_belongs_to_many :users, class_name: "TimestampsSpec::NoTouch::User"
+    end
+
+    class Account
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      belongs_to :user, required: false, touch: false, class_name: "TimestampsSpec::NoTouch::User"
+    end
+
+    class Pet
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      belongs_to :user, required: false, touch: false, class_name: "TimestampsSpec::NoTouch::User"
+    end
+  end
+end

data/spec/mongoid/touchable_spec.rb

@@ -89,7 +89,7 @@ describe Mongoid::Touchable do
         end
       end
 
-      shared_examples 'updates the parent when :touch is not set' do
+      shared_examples 'updates the parent when :touch is false' do
         it 'does not update updated_at on parent' do
           entrance
           update_time
@@ -130,7 +130,7 @@ describe Mongoid::Touchable do
 
         include_examples 'updates the child'
         include_examples 'updates the parent when :touch is true'
-        include_examples 'updates the parent when :touch is not set'
+        include_examples 'updates the parent when :touch is false'
 
         context 'when also updating an additional field' do
           it 'persists the update to the additional field' do
@@ -584,5 +584,393 @@ describe Mongoid::Touchable do
         end
       end
     end
+
+    context "when the touch option is true" do
+
+      shared_examples "updates the parent's updated_at" do
+
+        let!(:start_time) { Timecop.freeze(Time.at(Time.now.to_i)) }
+
+        let(:update_time) do
+          Timecop.freeze(Time.at(Time.now.to_i) + 2)
+        end
+
+        after do
+          Timecop.return
+        end
+
+        let(:building) do
+          parent_cls.create!
+        end
+
+        let(:floor) do
+          building.floors.create!
+        end
+
+        before do
+          floor
+          update_time
+          floor.level = 9
+          floor.send(meth)
+        end
+
+        it "the parent is not nil" do
+          expect(floor.building).to_not be nil
+        end
+
+        it "updates the parent's timestamp" do
+          building.updated_at.should == update_time
+          building.reload.updated_at.should == update_time
+        end
+      end
+
+      shared_examples "updates the child's updated_at" do
+
+        let!(:start_time) { Timecop.freeze(Time.at(Time.now.to_i)) }
+
+        let(:update_time) do
+          Timecop.freeze(Time.at(Time.now.to_i) + 2)
+        end
+
+        after do
+          Timecop.return
+        end
+
+        let(:building) do
+          parent_cls.create!
+        end
+
+        let(:floor) do
+          building.floors.create!
+        end
+
+        before do
+          floor
+          update_time
+          floor.level = 9
+          floor.send(meth)
+        end
+
+        it "the parent is not nil" do
+          expect(floor.building).to_not be nil
+        end
+
+        it "updates the child's timestamp" do
+          floor.updated_at.should == update_time
+          floor.reload.updated_at.should == update_time
+        end
+      end
+
+      [ :save!, :destroy, :touch].each do |meth|
+        context "with #{meth} on referenced associations" do
+          let(:parent_cls) { TouchableSpec::Referenced::Building }
+          let(:meth) { meth }
+
+          include_examples "updates the child's updated_at" unless meth == :destroy
+          include_examples "updates the parent's updated_at"
+        end
+
+        context "with #{meth} on embedded associations" do
+          let(:parent_cls) { TouchableSpec::Embedded::Building }
+          let(:meth) { meth }
+
+          include_examples "updates the child's updated_at" unless meth == :destroy
+          include_examples "updates the parent's updated_at"
+        end
+      end
+    end
+
+    context "when the touch option is false" do
+
+      shared_examples "does not update the parent" do
+
+        let!(:start_time) { Timecop.freeze(Time.at(Time.now.to_i)) }
+
+        let(:update_time) do
+          Timecop.freeze(Time.at(Time.now.to_i) + 2)
+        end
+
+        after do
+          Timecop.return
+        end
+
+        let(:building) do
+          parent_cls.create!
+        end
+
+        let(:entrance) do
+          building.entrances.create!
+        end
+
+        before do
+          entrance
+          update_time
+          entrance.touch
+        end
+
+        it "updates the child's timestamp" do
+          entrance.updated_at.should == update_time
+          entrance.reload.updated_at.should == update_time
+        end
+
+        it "does not update the parent's timestamp" do
+          building.updated_at.should == start_time
+          building.reload.updated_at.should == start_time
+        end
+      end
+
+      [ :save!, :destroy, :touch].each do |meth|
+        context "with #{meth} on belongs_to" do
+          let(:meth) { meth }
+          let(:parent_cls) { TouchableSpec::Referenced::Building }
+
+          include_examples "does not update the parent"
+        end
+
+        context "with #{meth} on embedded_in" do
+          let(:meth) { meth }
+          let(:parent_cls) { TouchableSpec::Embedded::Building }
+
+          before do
+            skip "MONGOID-5274"
+          end
+
+          include_examples "does not update the parent"
+        end
+      end
+    end
+  end
+
+  describe "when saving a document" do
+
+    let!(:start_time) { Timecop.freeze(Time.at(Time.now.to_i)) }
+
+    let(:update_time) do
+      Timecop.freeze(Time.at(Time.now.to_i) + 2)
+    end
+
+    after do
+      Timecop.return
+    end
+
+    context "when only using the root document" do
+
+      shared_examples "timeless is cleared" do
+        it "clears the timeless option" do
+          expect(doc.timeless?).to be false
+        end
+      end
+
+      shared_examples "touches the document" do
+        it "touches the document" do
+          expect(doc.created_at).to eq(start_time)
+          expect(doc.updated_at).to eq(start_time)
+        end
+      end
+
+      shared_examples "updates the document" do
+        it "updates the document" do
+          expect(doc.created_at).to eq(start_time)
+          expect(doc.updated_at).to eq(update_time)
+        end
+      end
+
+      let(:doc) { Dokument.new }
+
+      context "when saving a new document" do
+
+        context "when not passing a touch option" do
+
+          before do
+            doc.save!
+          end
+
+          include_examples "touches the document"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: true" do
+
+          before do
+            doc.save!(touch: true)
+          end
+
+          include_examples "touches the document"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: false" do
+
+          before do
+            doc.save!(touch: false)
+          end
+
+          include_examples "touches the document"
+          include_examples "timeless is cleared"
+        end
+      end
+
+      context "when updating a document" do
+        before do
+          doc.save!
+          doc.title = "title"
+          update_time
+        end
+
+        context "when not passing a touch option" do
+
+          before do
+            doc.save!
+          end
+
+          include_examples "updates the document"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: true" do
+
+          before do
+            doc.save!(touch: true)
+          end
+
+          include_examples "updates the document"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: false" do
+
+          before do
+            doc.save!(touch: false)
+          end
+
+          include_examples "touches the document"
+          include_examples "timeless is cleared"
+        end
+      end
+    end
+
+    context "when saving embedded associations with cascadable callbacks" do
+
+      shared_examples "timeless is cleared" do
+        it "clears the timeless option" do
+          expect(book.timeless?).to be false
+          expect(book.covers.first.timeless?).to be false
+        end
+      end
+
+      shared_examples "touches the document" do
+        it "touches the document" do
+          expect(book.created_at).to eq(start_time)
+          expect(book.updated_at).to eq(start_time)
+        end
+      end
+
+      shared_examples "updates the document" do
+        it "updates the document" do
+          expect(book.created_at).to eq(start_time)
+          expect(book.updated_at).to eq(update_time)
+        end
+      end
+
+      shared_examples "touches the children" do
+        it "touches the children" do
+          expect(book.covers.first.created_at).to eq(start_time)
+          expect(book.covers.first.updated_at).to eq(start_time)
+        end
+      end
+
+      shared_examples "updates the children" do
+        it "updates the children" do
+          expect(book.covers.first.created_at).to eq(start_time)
+          expect(book.covers.first.updated_at).to eq(update_time)
+        end
+      end
+
+      let(:book) do
+        Book.new(covers: [ cover ])
+      end
+
+      let(:cover) do
+        Cover.new
+      end
+
+      context "when saving a new document" do
+
+        context "when not passing a touch option" do
+
+          before do
+            book.save!
+          end
+
+          include_examples "touches the document"
+          include_examples "touches the children"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: true" do
+
+          before do
+            book.save!(touch: true)
+          end
+
+          include_examples "touches the document"
+          include_examples "touches the children"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: false" do
+
+          before do
+            book.save!(touch: false)
+          end
+
+          include_examples "touches the document"
+          include_examples "touches the children"
+          include_examples "timeless is cleared"
+        end
+      end
+
+      context "when updating a document" do
+        before do
+          book.save!
+          book.title = "title"
+          book.covers.first.title = "title"
+          update_time
+        end
+
+        context "when not passing a touch option" do
+
+          before do
+            book.save!
+          end
+
+          include_examples "updates the document"
+          include_examples "updates the children"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: true" do
+
+          before do
+            book.save!(touch: true)
+          end
+
+          include_examples "updates the document"
+          include_examples "updates the children"
+          include_examples "timeless is cleared"
+        end
+
+        context "when passing touch: false" do
+
+          before do
+            book.save!(touch: false)
+          end
+
+          include_examples "touches the document"
+          include_examples "touches the children"
+          include_examples "timeless is cleared"
+        end
+      end
+    end
   end
 end

data/spec/mongoid/touchable_spec_models.rb

@@ -6,15 +6,17 @@ module TouchableSpec
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      embeds_many :entrances
-      embeds_many :floors
+      field :title, type: String
+
+      embeds_many :entrances, class_name: "TouchableSpec::Embedded::Entrance"
+      embeds_many :floors, class_name: "TouchableSpec::Embedded::Floor"
     end
 
     class Entrance
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      embedded_in :building
+      embedded_in :building, touch: false, class_name: "TouchableSpec::Embedded::Building"
 
       field :last_used_at, type: Time
     end
@@ -23,7 +25,9 @@ module TouchableSpec
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      embedded_in :building, touch: true
+      field :level, type: Integer
+
+      embedded_in :building, touch: true, class_name: "TouchableSpec::Embedded::Building"
     end
   end
 
@@ -32,22 +36,24 @@ module TouchableSpec
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      has_many :entrances, inverse_of: :building
-      has_many :floors, inverse_of: :building
+      has_many :entrances, inverse_of: :building, class_name: "TouchableSpec::Referenced::Entrance"
+      has_many :floors, inverse_of: :building, class_name: "TouchableSpec::Referenced::Floor"
     end
 
     class Entrance
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      belongs_to :building
+      belongs_to :building, touch: false, class_name: "TouchableSpec::Referenced::Building"
     end
 
     class Floor
       include Mongoid::Document
       include Mongoid::Timestamps
 
-      belongs_to :building, touch: true
+      field :level, type: Integer
+
+      belongs_to :building, touch: true, class_name: "TouchableSpec::Referenced::Building"
     end
   end
 end

data/spec/mongoid/traversable_spec.rb

@@ -336,13 +336,7 @@ describe Mongoid::Traversable do
     end
 
     context "when the discriminator key is changed at the global level" do
-      before do
-        Mongoid.discriminator_key = "hello"
-      end
-
-      after do
-        Mongoid.discriminator_key = "_type"
-      end
+      config_override :discriminator_key, 'hello'
 
       it "sets the correct value globally" do
         expect(Mongoid.discriminator_key).to eq("hello")
@@ -537,9 +531,9 @@ describe Mongoid::Traversable do
         end
 
         context "before class creation" do
-          before do
-            Mongoid.discriminator_key = "test"
+          config_override :discriminator_key, "test"
 
+          before do
             class PreGlobalDiscriminatorParent
               include Mongoid::Document
             end
@@ -548,10 +542,6 @@ describe Mongoid::Traversable do
             end
           end
 
-          after do
-            Mongoid.discriminator_key = "_type"
-          end
-
           it "creates a field with new discriminator key in the parent" do
             expect(PreGlobalDiscriminatorParent.fields.keys).to include("test")
           end
@@ -683,9 +673,9 @@ describe Mongoid::Traversable do
         end
 
         context "before class creation" do
-          before do
-            Mongoid.discriminator_key = :test
+          config_override :discriminator_key, :test
 
+          before do
             class PreGlobalSymDiscriminatorParent
               include Mongoid::Document
             end
@@ -694,10 +684,6 @@ describe Mongoid::Traversable do
             end
           end
 
-          after do
-            Mongoid.discriminator_key = "_type"
-          end
-
           it "creates a field with new discriminator key as a string in the parent" do
             expect(PreGlobalSymDiscriminatorParent.fields.keys).to include("test")
           end
@@ -835,8 +821,9 @@ describe Mongoid::Traversable do
     end
 
     context "when setting a field equal to discriminator key and duplicate_fields_exception is true" do
+      config_override :duplicate_fields_exception, true
+
       before do
-        Mongoid.duplicate_fields_exception = true
 
         class DuplicateDiscriminatorKeyParent
           include Mongoid::Document
@@ -847,10 +834,6 @@ describe Mongoid::Traversable do
         end
       end
 
-      after do
-        Mongoid.duplicate_fields_exception = false
-      end
-
       it "does not raise an error" do
         expect do
           DuplicateDiscriminatorKeyParent.discriminator_key = "dkey"
@@ -877,9 +860,10 @@ describe Mongoid::Traversable do
     end
 
     context "when setting a field equal to global discriminator key and duplicate_fields_exception is true" do
+      config_override :duplicate_fields_exception, true
+      config_override :discriminator_key, "dkey"
+
       before do
-        Mongoid.duplicate_fields_exception = true
-        Mongoid.discriminator_key = "dkey"
 
         class GlobalDuplicateDiscriminatorKeyParent
           include Mongoid::Document
@@ -889,11 +873,6 @@ describe Mongoid::Traversable do
         end
       end
 
-      after do
-        Mongoid.duplicate_fields_exception = false
-        Mongoid.discriminator_key = "_type"
-      end
-
       it "raises an error" do
         expect do
           GlobalDuplicateDiscriminatorKeyParent.class_eval do
@@ -904,10 +883,9 @@ describe Mongoid::Traversable do
     end
 
     context "when the global discriminator key conflicts with mongoid's internals" do
-
-      after do
-        Mongoid.discriminator_key = "_type"
-      end
+      # This is not an override, it is meant to restore the original value
+      # after the test only.
+      config_override :discriminator_key, '_type'
 
       [:_association, :invalid].each do |meth|
         context "when the field is named #{meth}" do