MONGOID-5262 Implement local time zone override for tests (#5480)

Author: neilshweky

spec/mongoid/criteria/queryable/extensions/string_spec.rb

@@ -73,10 +73,7 @@
 
       context "when using active support's time zone" do
         config_override :use_activesupport_time_zone, true
-
-        before do
-          ::Time.zone = "Tokyo"
-        end
+        time_zone_override "Tokyo"
 
         let(:date) do
           "2010-01-01 5:00:00"
@@ -93,10 +90,7 @@
 
       context "when not using active support's time zone" do
         config_override :use_activesupport_time_zone, false
-
-        before do
-          ::Time.zone = nil
-        end
+        time_zone_override nil
 
         let(:date) do
           "2010-01-01 5:00:00"

spec/mongoid/extensions/time_spec.rb

@@ -50,14 +50,7 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
-
-        before do
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
+        time_zone_override "Stockholm"
 
         context "when demongoizing a Time" do
 
@@ -123,19 +116,12 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
+        time_zone_override "Stockholm"
 
         let(:time) do
           Time.utc(2010, 11, 19, 0, 30)
         end
 
-        before do
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
-
         it "returns utc" do
           expect(Time.demongoize(time)).to eq(
             ActiveSupport::TimeZone['UTC'].local(2010, 11, 19, 0, 30)
@@ -855,20 +841,13 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
+        # if this is actually your time zone, the following tests are useless
+        time_zone_override "Stockholm"
 
         let(:datetime) do
           DateTime.new(2010, 11, 19)
         end
 
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
-
         it "assumes the given time is local" do
           expect(Time.mongoize(datetime)).to eq(
             Time.utc(2010, 11, 19)
@@ -945,20 +924,13 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
+        # if this is actually your time zone, the following tests are useless
+        time_zone_override "Stockholm"
 
         let(:date) do
           Date.new(2010, 11, 19)
         end
 
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
-
         it "assumes the given time is local" do
           expect(Time.mongoize(date)).to eq(Time.utc(2010, 11, 18, 23))
         end
@@ -977,15 +949,8 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
-
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
+        # if this is actually your time zone, the following tests are useless
+        time_zone_override "Stockholm"
 
         it "assumes the given time is local" do
           expect(Time.mongoize(array)).to eq(

spec/mongoid/extensions/time_with_zone_spec.rb

@@ -50,14 +50,7 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
-
-        before do
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
+        time_zone_override "Stockholm"
 
         it "returns an ActiveSupport::TimeWithZone" do
           expect(ActiveSupport::TimeWithZone.demongoize(time).class).to eq(ActiveSupport::TimeWithZone)
@@ -113,19 +106,12 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
+        time_zone_override "Stockholm"
 
         let(:time) do
           Time.utc(2010, 11, 19, 0, 30)
         end
 
-        before do
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
-
         it "returns utc" do
           expect(ActiveSupport::TimeWithZone.demongoize(time)).to eq(
             ActiveSupport::TimeZone['UTC'].local(2010, 11, 19, 0, 30)
@@ -203,15 +189,8 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
-
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
+        # if this is actually your time zone, the following tests are useless
+        time_zone_override "Stockholm"
 
         context "when the local time is not observing daylight saving" do
 
@@ -247,20 +226,12 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
+        time_zone_override "Stockholm"
 
         let(:datetime) do
           DateTime.new(2010, 11, 19)
         end
 
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
-
         it "assumes the given time is local" do
           expect(ActiveSupport::TimeWithZone.mongoize(datetime)).to eq(
             Time.utc(2010, 11, 19)
@@ -317,20 +288,12 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
+        time_zone_override "Stockholm"
 
         let(:date) do
           Date.new(2010, 11, 19)
         end
 
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
-
         it "assumes the given time is local" do
           expect(ActiveSupport::TimeWithZone.mongoize(date)).to eq(Time.utc(2010, 11, 18, 23))
         end
@@ -349,15 +312,7 @@
 
       context "when using the ActiveSupport time zone" do
         config_override :use_activesupport_time_zone, true
-
-        before do
-          # if this is actually your time zone, the following tests are useless
-          Time.zone = "Stockholm"
-        end
-
-        after do
-          Time.zone = nil
-        end
+        time_zone_override "Stockholm"
 
         it "assumes the given time is local" do
           expect(ActiveSupport::TimeWithZone.mongoize(array)).to eq(

spec/mongoid/fields_spec.rb

@@ -1082,14 +1082,7 @@
       end
 
       context "when reading the field" do
-
-        before do
-          Time.zone = "Berlin"
-        end
-
-        after do
-          Time.zone = nil
-        end
+        time_zone_override "Berlin"
 
         it "performs the necessary time conversions" do
           expect(person.lunch_time.to_s).to eq(time.getlocal.to_s)

spec/mongoid/findable_spec.rb

@@ -901,10 +901,7 @@
   context 'when Mongoid is configured to use activesupport time zone' do
     config_override :use_utc, false
     config_override :use_activesupport_time_zone, true
-
-    before do
-      Time.zone = "Asia/Kolkata"
-    end
+    time_zone_override "Asia/Kolkata"
 
     let!(:time) do
       Time.zone.now.tap do |t|

spec/mongoid/timestamps_spec.rb

@@ -17,12 +17,7 @@
 
     let(:time_zone) { "Pacific Time (US & Canada)" }
 
-    around do |ex|
-      z = Time.zone
-      Time.zone = time_zone
-      ex.run
-      Time.zone = z
-    end
+    time_zone_override "Pacific Time (US & Canada)"
 
     before do
       document.run_callbacks(:create)

spec/support/macros.rb

@@ -102,6 +102,15 @@ def persistence_context_override(component, value)
       end
     end
 
+    def time_zone_override(tz)
+      around do |example|
+        old_tz = Time.zone
+        Time.zone = tz
+        example.run
+        Time.zone = old_tz
+      end
+    end
+
     def with_default_i18n_configs
       around do |example|
         I18n.locale = :en