mongoid 7.0.2 → 8.1.1

data/spec/mongoid/touchable_spec.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "spec_helper"
+require_relative './touchable_spec_models'
 
 describe Mongoid::Touchable do
 
@@ -6,7 +9,7 @@ describe Mongoid::Touchable do
 
     context "when the document has no associations" do
       let(:updatable) do
-        Updatable.create
+        Updatable.create!
       end
 
       it "responds to #touch" do
@@ -25,30 +28,135 @@ describe Mongoid::Touchable do
       end
     end
 
-    context "when the document is embedded" do
+    context 'when the document has a parent association' do
 
-      before do
-        Label.send(:include, Mongoid::Touchable::InstanceMethods)
+      let(:building) do
+        parent_cls.create!
       end
 
-      let(:band) do
-        Band.create(name: "Placebo")
+      let(:entrance) do
+        building.entrances.create!
       end
 
-      let(:label) do
-        band.create_label(name: "Mute", updated_at: 10.days.ago)
+      let(:floor) do
+        building.floors.create!
       end
 
-      before do
-        label.touch
+      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
 
-      it "updates the updated_at timestamp" do
-        expect(label.updated_at).to be_within(1).of(Time.now)
+      after do
+        Timecop.return
       end
 
-      it "persists the changes" do
-        expect(label.reload.updated_at).to be_within(1).of(Time.now)
+      shared_examples 'updates the child' do
+        it "updates the updated_at timestamp" do
+          entrance
+          update_time
+          entrance.touch
+
+          entrance.updated_at.should == update_time
+        end
+
+        it "persists the changes" do
+          entrance
+          update_time
+          entrance.touch
+
+          entrance.reload.updated_at.should == update_time
+        end
+      end
+
+      shared_examples 'updates the parent when :touch is true' do
+
+        it 'updates updated_at on parent' do
+          floor
+          update_time
+          floor.touch
+
+          building.updated_at.should == update_time
+        end
+
+        it 'persists updated updated_at on parent' do
+          floor
+          update_time
+          floor.touch
+
+          building.reload.updated_at.should == update_time
+        end
+      end
+
+      shared_examples 'updates the parent when :touch is false' do
+        it 'does not update updated_at on parent' do
+          entrance
+          update_time
+          entrance.touch
+
+          building.updated_at.should == update_time
+        end
+
+        it 'does not persist updated updated_at on parent' do
+          entrance
+          update_time
+          entrance.touch
+
+          building.reload.updated_at.should == update_time
+        end
+      end
+
+      shared_examples 'does not update the parent when :touch is not set' do
+        it 'does not update updated_at on parent' do
+          entrance
+          update_time
+          entrance.touch
+
+          building.updated_at.should == start_time
+        end
+
+        it 'does not persist updated updated_at on parent' do
+          entrance
+          update_time
+          entrance.touch
+
+          building.reload.updated_at.should == start_time
+        end
+      end
+
+      context "when the document is embedded" do
+        let(:parent_cls) { TouchableSpec::Embedded::Building }
+
+        include_examples 'updates the child'
+        include_examples 'updates the parent when :touch is true'
+        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
+            entrance
+            update_time
+            entrance.touch(:last_used_at)
+
+            entrance.reload
+            building.reload
+
+            # This is the assertion we want.
+            entrance.last_used_at.should == update_time
+
+            # Check other timestamps for good measure.
+            entrance.updated_at.should == update_time
+            building.updated_at.should == update_time
+          end
+        end
+      end
+
+      context "when the document is referenced" do
+        let(:parent_cls) { TouchableSpec::Referenced::Building }
+
+        include_examples 'updates the child'
+        include_examples 'updates the parent when :touch is true'
+        include_examples 'does not update the parent when :touch is not set'
       end
     end
 
@@ -62,7 +170,7 @@ describe Mongoid::Touchable do
       context "when no updated at is defined" do
 
         let(:person) do
-          Person.create
+          Person.create!
         end
 
         context "when no attribute is provided" do
@@ -122,7 +230,7 @@ describe Mongoid::Touchable do
       context "when an updated at is defined" do
 
         let!(:agent) do
-          Agent.create(updated_at: 2.days.ago)
+          Agent.create!(updated_at: 2.days.ago)
         end
 
         context "when no attribute is provided" do
@@ -186,13 +294,13 @@ describe Mongoid::Touchable do
 
       context "when record is new" do
 
-        let(:agent) do
+        let!(:agent) do
           Agent.new(updated_at: 2.days.ago)
         end
 
         context "when no attribute is provided" do
 
-          let!(:touched) do
+          let(:touched) do
             agent.touch
           end
 
@@ -203,7 +311,7 @@ describe Mongoid::Touchable do
 
         context "when an attribute is provided" do
 
-          let!(:touched) do
+          let(:touched) do
             agent.touch(:dob)
           end
 
@@ -213,6 +321,45 @@ describe Mongoid::Touchable do
         end
       end
 
+      context "when record is destroyed" do
+
+        let!(:agent) do
+          Agent.create!(updated_at: 2.days.ago).tap do |agent|
+            agent.destroy
+          end
+        end
+
+        let(:frozen_error_cls) do
+          FrozenError
+        end
+
+        context "when no attribute is provided" do
+
+          let(:touched) do
+            agent.touch
+          end
+
+          it "raises FrozenError" do
+            expect do
+              touched
+            end.to raise_error(frozen_error_cls)
+          end
+        end
+
+        context "when an attribute is provided" do
+
+          let(:touched) do
+            agent.touch(:dob)
+          end
+
+          it "raises FrozenError" do
+            expect do
+              touched
+            end.to raise_error(frozen_error_cls)
+          end
+        end
+      end
+
       context "when creating the child" do
 
         let(:time) do
@@ -245,11 +392,11 @@ describe Mongoid::Touchable do
         end
 
         let(:page) do
-          WikiPage.create(title: "test")
+          WikiPage.create!(title: "test")
         end
 
         let!(:edit) do
-          page.edits.create
+          page.edits.create!
         end
 
         before do
@@ -274,7 +421,7 @@ describe Mongoid::Touchable do
 
         before do
           book.pages.new
-          book.save
+          book.save!
           book.unset(:updated_at)
           book.pages.first.touch
         end
@@ -292,7 +439,7 @@ describe Mongoid::Touchable do
 
         before do
           2.times { book.pages.new }
-          book.save
+          book.save!
           book.unset(:updated_at)
           book.pages.first.content  = "foo"
           book.pages.second.content = "bar"
@@ -307,7 +454,7 @@ describe Mongoid::Touchable do
       context "when the relation is nil" do
 
         let!(:agent) do
-          Agent.create
+          Agent.create!
         end
 
         context "when the relation autobuilds" do
@@ -325,7 +472,7 @@ describe Mongoid::Touchable do
       context "when the relation is not nil" do
 
         let!(:agent) do
-          Agent.create
+          Agent.create!
         end
 
         let!(:agency) do
@@ -350,7 +497,7 @@ describe Mongoid::Touchable do
       context "when creating the child" do
 
         let!(:agency) do
-          Agency.create
+          Agency.create!
         end
 
         let!(:updated) do
@@ -358,7 +505,7 @@ describe Mongoid::Touchable do
         end
 
         let!(:agent) do
-          agency.agents.create
+          agency.agents.create!
         end
 
         it "updates the parent's updated at" do
@@ -369,16 +516,16 @@ describe Mongoid::Touchable do
       context "when modifying the child" do
 
         let!(:agency) do
-          Agency.create
+          Agency.create!
         end
 
         let!(:agent) do
-          agency.agents.create(number: '1')
+          agency.agents.create!(number: '1')
         end
 
         it "updates the parent's updated at" do
           expect {
-            agent.update_attributes(number: '2')
+            agent.update_attributes!(number: '2')
           }.to change { agency.updated_at }
         end
       end
@@ -386,11 +533,11 @@ describe Mongoid::Touchable do
       context "when destroying the child" do
 
         let!(:agency) do
-          Agency.create
+          Agency.create!
         end
 
         let!(:agent) do
-          agency.agents.create
+          agency.agents.create!
         end
 
         let!(:updated) do
@@ -410,7 +557,7 @@ describe Mongoid::Touchable do
     context "when other document attributes have been changed" do
 
       let(:band) do
-        Band.create(name: "Placebo")
+        Band.create!(name: "Placebo")
       end
 
       context "when an attribute is provided" do
@@ -437,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