mongoid 8.1.9 → 9.0.0

data/spec/mongoid/touchable_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "spec_helper"
 require_relative './touchable_spec_models'
@@ -26,6 +27,11 @@ describe Mongoid::Touchable do
         updatable.touch
         expect(updatable.updated_at).to be > updated_at
       end
+
+      it 'does not leave model in changed state' do
+        updatable.touch
+        expect(updatable).not_to be_changed
+      end
     end
 
     context 'when the document has a parent association' do
@@ -58,7 +64,7 @@ describe Mongoid::Touchable do
           update_time
           entrance.touch
 
-          entrance.updated_at.should == update_time
+          expect(entrance.updated_at).to eq(update_time)
         end
 
         it "persists the changes" do
@@ -66,7 +72,7 @@ describe Mongoid::Touchable do
           update_time
           entrance.touch
 
-          entrance.reload.updated_at.should == update_time
+          expect(entrance.reload.updated_at).to eq(update_time)
         end
       end
 
@@ -77,7 +83,7 @@ describe Mongoid::Touchable do
           update_time
           floor.touch
 
-          building.updated_at.should == update_time
+          expect(building.updated_at).to eq(update_time)
         end
 
         it 'persists updated updated_at on parent' do
@@ -85,17 +91,17 @@ describe Mongoid::Touchable do
           update_time
           floor.touch
 
-          building.reload.updated_at.should == update_time
+          expect(building.reload.updated_at).to eq(update_time)
         end
       end
 
-      shared_examples 'updates the parent when :touch is false' do
+      shared_examples 'does not update 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
+          expect(building.updated_at).to eq(start_time)
         end
 
         it 'does not persist updated updated_at on parent' do
@@ -103,26 +109,12 @@ describe Mongoid::Touchable do
           update_time
           entrance.touch
 
-          building.reload.updated_at.should == update_time
+          expect(building.reload.updated_at).to eq(start_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
+        it_behaves_like 'does not update the parent when :touch is false'
       end
 
       context "when the document is embedded" do
@@ -130,9 +122,9 @@ 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 false'
+        include_examples 'does not update the parent when :touch is not set'
 
-        context 'when also updating an additional field' do
+        context 'when also updating an additional field when :touch is true' do
           it 'persists the update to the additional field' do
             entrance
             update_time
@@ -142,11 +134,29 @@ describe Mongoid::Touchable do
             building.reload
 
             # This is the assertion we want.
-            entrance.last_used_at.should == update_time
+            expect(entrance.last_used_at).to eq(update_time)
+
+            # Check other timestamps for good measure.
+            expect(entrance.updated_at).to eq(update_time)
+            expect(building.updated_at).to eq(start_time)
+          end
+        end
+
+        context 'when also updating an additional field when :touch is not set' do
+          it 'persists the update to the additional field' do
+            floor
+            update_time
+            floor.touch(:last_used_at)
+
+            floor.reload
+            building.reload
+
+            # This is the assertion we want.
+            expect(floor.last_used_at).to eq(update_time)
 
             # Check other timestamps for good measure.
-            entrance.updated_at.should == update_time
-            building.updated_at.should == update_time
+            expect(floor.updated_at).to eq(update_time)
+            expect(building.updated_at).to eq(update_time)
           end
         end
       end
@@ -156,17 +166,12 @@ describe Mongoid::Touchable do
 
         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'
+        include_examples 'does not update the parent when :touch is false'
       end
     end
 
     context "when no relations have touch options" do
 
-      before do
-        Person.send(:include, Mongoid::Touchable::InstanceMethods)
-        Agent.send(:include, Mongoid::Touchable::InstanceMethods)
-      end
-
       context "when no updated at is defined" do
 
         let(:person) do
@@ -251,8 +256,8 @@ describe Mongoid::Touchable do
             expect(touched).to be true
           end
 
-          it "keeps changes for next callback" do
-            expect(agent.changes).to_not be_empty
+          it "clears changes" do
+            expect(agent.changes).to be_empty
           end
         end
 
@@ -286,8 +291,8 @@ describe Mongoid::Touchable do
             expect(touched).to be true
           end
 
-          it "keeps changes for next callback" do
-            expect(agent.changes).to_not be_empty
+          it "clears changes" do
+            expect(agent.changes).to be_empty
           end
         end
       end
@@ -386,11 +391,6 @@ describe Mongoid::Touchable do
 
       context "when the relation is a parent of an embedded doc" do
 
-        before do
-          Page.send(:include, Mongoid::Touchable::InstanceMethods)
-          Edit.send(:include, Mongoid::Touchable::InstanceMethods)
-        end
-
         let(:page) do
           WikiPage.create!(title: "test")
         end
@@ -411,10 +411,6 @@ describe Mongoid::Touchable do
 
       context "when the parent of embedded doc has cascade callbacks" do
 
-        before do
-          Band.send(:include, Mongoid::Touchable::InstanceMethods)
-        end
-
         let!(:book) do
           Book.new
         end
@@ -619,8 +615,8 @@ describe Mongoid::Touchable do
         end
 
         it "updates the parent's timestamp" do
-          building.updated_at.should == update_time
-          building.reload.updated_at.should == update_time
+          expect(building.updated_at).to eq(update_time)
+          expect(building.reload.updated_at).to eq(update_time)
         end
       end
 
@@ -683,12 +679,8 @@ describe Mongoid::Touchable do
     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
+        let(:update_time) { Timecop.freeze(Time.at(Time.now.to_i) + 2) }
 
         after do
           Timecop.return
@@ -705,17 +697,22 @@ describe Mongoid::Touchable do
         before do
           entrance
           update_time
-          entrance.touch
+          entrance.level = 1
+          entrance.send(meth)
         end
 
         it "updates the child's timestamp" do
-          entrance.updated_at.should == update_time
-          entrance.reload.updated_at.should == update_time
+          if entrance.destroyed?
+            expect(entrance.updated_at).to eq(start_time)
+          else
+            expect(entrance.updated_at).to eq(update_time)
+            expect(entrance.reload.updated_at).to eq(update_time)
+          end
         end
 
         it "does not update the parent's timestamp" do
-          building.updated_at.should == start_time
-          building.reload.updated_at.should == start_time
+          expect(building.updated_at).to eq(start_time)
+          expect(building.reload.updated_at).to eq(start_time)
         end
       end
 
@@ -731,11 +728,353 @@ describe Mongoid::Touchable do
           let(:meth) { meth }
           let(:parent_cls) { TouchableSpec::Embedded::Building }
 
-          before do
-            skip "MONGOID-5274"
+          include_examples "does not update the parent"
+        end
+      end
+    end
+
+    context 'multi-level' do
+
+      let!(:start_time) { Timecop.freeze(Time.at(Time.now.to_i)) }
+
+      let(:update_time) { Timecop.freeze(Time.at(Time.now.to_i) + 2) }
+
+      let(:child_name) do
+        child_cls.name.demodulize.underscore
+      end
+
+      let(:grandchild_name) do
+        grandchild_cls.name.demodulize.underscore
+      end
+
+      let(:parent) do
+        parent_cls.create!
+      end
+
+      let(:child) do
+        parent.send(child_name.pluralize).create!
+      end
+
+      let(:grandchild) do
+        grandchild = child.send(grandchild_name.pluralize).create!
+        grandchild.created_at = Time.now + 1.day # arbitrary change so save! works
+        grandchild
+      end
+
+      shared_examples "updates the parent" do
+        it "updates the parent's timestamp" do
+          expect(parent.updated_at).to eq(update_time)
+          expect(parent.reload.updated_at).to eq(update_time)
+        end
+      end
+
+      shared_examples "does not update the parent" do
+        it "does not update the parent's timestamp" do
+          expect(parent.updated_at).to eq(start_time)
+          expect(parent.reload.updated_at).to eq(start_time)
+        end
+      end
+
+      shared_examples "updates the child" do
+        it "updates the child's timestamp" do
+          expect(child.updated_at).to eq(update_time)
+          expect(child.reload.updated_at).to eq(update_time)
+        end
+      end
+
+      shared_examples "does not update the child" do
+        it "does not update the child's timestamp" do
+          expect(child.updated_at).to eq(start_time)
+          expect(child.reload.updated_at).to eq(start_time)
+        end
+      end
+
+      shared_examples "updates the grandchild" do
+        it "updates the grandchild's timestamp" do
+          if grandchild.destroyed?
+            expect(grandchild.updated_at).to eq(start_time)
+          else
+            expect(grandchild.updated_at).to eq(update_time)
+            expect(grandchild.reload.updated_at).to eq(update_time)
           end
+        end
+      end
 
-          include_examples "does not update the parent"
+      shared_examples "does not update the grandchild" do
+        it "does not update the grandchild's timestamp" do
+          expect(grandchild.updated_at).to eq(start_time)
+          expect(grandchild.reload.updated_at).to eq(start_time) unless grandchild.destroyed?
+        end
+      end
+
+      before do
+        grandchild
+        update_time
+        grandchild.send(meth)
+      end
+
+      after do
+        Timecop.return
+      end
+
+      context 'parent > embedded child > embedded grandchild' do
+
+        let(:parent_cls) { TouchableSpec::Embedded::Building }
+
+        context 'child touch: true' do
+
+          let(:child_cls) do
+            TouchableSpec::Embedded::Floor
+          end
+
+          context 'grandchild touch: true' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Embedded::Sofa
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "updates the parent"
+                it_behaves_like "updates the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+
+          context 'grandchild touch: false' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Embedded::Chair
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "does not update the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+        end
+
+        context 'child touch: false' do
+
+          let(:child_cls) do
+            TouchableSpec::Embedded::Entrance
+          end
+
+          context 'grandchild touch: true' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Embedded::Camera
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "updates the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+
+          context 'grandchild touch: false' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Embedded::Keypad
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "does not update the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+        end
+      end
+
+      context 'parent > referenced child > embedded grandchild' do
+
+        let(:parent_cls) { TouchableSpec::Referenced::Building }
+
+        context 'child touch: true' do
+
+          let(:child_cls) do
+            TouchableSpec::Referenced::Floor
+          end
+
+          context 'grandchild touch: true' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Sofa
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "updates the parent"
+                it_behaves_like "updates the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+
+          context 'grandchild touch: false' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Chair
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "does not update the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+        end
+
+        context 'child touch: false' do
+
+          let(:child_cls) do
+            TouchableSpec::Referenced::Entrance
+          end
+
+          context 'grandchild touch: true' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Camera
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "updates the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+
+          context 'grandchild touch: false' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Keypad
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "does not update the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+        end
+      end
+
+      context 'parent > referenced child > referenced grandchild' do
+
+        let(:parent_cls) { TouchableSpec::Referenced::Building }
+
+        context 'child touch: true' do
+
+          let(:child_cls) do
+            TouchableSpec::Referenced::Floor
+          end
+
+          context 'grandchild touch: true' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Window
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "updates the parent"
+                it_behaves_like "updates the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+
+          context 'grandchild touch: false' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Plant
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "does not update the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+        end
+
+        context 'child touch: false' do
+
+          let(:child_cls) do
+            TouchableSpec::Referenced::Entrance
+          end
+
+          context 'grandchild touch: true' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Window
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "updates the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
+
+          context 'grandchild touch: false' do
+
+            let(:grandchild_cls) do
+              TouchableSpec::Referenced::Plant
+            end
+
+            [ :save!, :destroy, :touch ].each do |meth|
+              context "when calling #{meth} method" do
+                let(:meth) { meth }
+
+                it_behaves_like "does not update the parent"
+                it_behaves_like "does not update the child"
+                it_behaves_like "updates the grandchild"
+              end
+            end
+          end
         end
       end
     end
@@ -849,7 +1188,7 @@ describe Mongoid::Touchable do
       end
     end
 
-    context "when saving embedded associations with cascadable callbacks" do
+    context "when saving embedded associations with cascading callbacks" do
 
       shared_examples "timeless is cleared" do
         it "clears the timeless option" do
@@ -973,4 +1312,93 @@ describe Mongoid::Touchable do
       end
     end
   end
+
+  context 'when updated after touch' do
+    let(:touch_time) { Timecop.freeze(Time.at(Time.now.to_i) + 2) }
+
+    let(:update_time) { Timecop.freeze(Time.at(Time.now.to_i) + 4) }
+
+    let!(:book) { Book.create! }
+
+    after do
+      Timecop.return
+    end
+
+    it 'updates updated_at' do
+      touch_time
+      book.touch
+      update_time
+      book.title = 'This book has no name'
+      book.save!
+      expect(book.updated_at).to eq(update_time)
+    end
+  end
+
+  context 'callbacks' do
+    class TouchableParent
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      attr_reader :before_touch_called, :after_touch_called
+
+      set_callback(:touch, :before) do
+        @before_touch_called = true
+      end
+
+      set_callback(:touch, :after) do
+        @after_touch_called = true
+      end
+
+      embeds_one :child, inverse_of: :parent, class_name: 'TouchableChild'
+    end
+
+    class TouchableChild
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      attr_reader :before_touch_called, :after_touch_called
+
+      set_callback(:touch, :before) do
+        @before_touch_called = true
+      end
+
+      set_callback(:touch, :after) do
+        @after_touch_called = true
+      end
+
+      embedded_in :parent, inverse_of: :child, class_name: 'TouchableParent', touch: true
+    end
+
+    let(:parent) do
+      TouchableParent.create!.tap do |parent|
+        parent.child = TouchableChild.create!(parent: parent)
+      end
+    end
+
+    let(:child) do
+      parent.child
+    end
+
+    it 'calls touch callbacks on parent' do
+      parent.touch
+      expect(parent.before_touch_called).to eq(true)
+      expect(parent.after_touch_called).to eq(true)
+    end
+
+    context 'when touch is calles on a child' do
+      before do
+        child.touch
+      end
+
+      it 'calls touch callbacks on parent' do
+        expect(parent.before_touch_called).to eq(true)
+        expect(parent.after_touch_called).to eq(true)
+      end
+
+      it 'calls touch callbacks on child' do
+        expect(child.before_touch_called).to eq(true)
+        expect(child.after_touch_called).to eq(true)
+      end
+    end
+  end
 end