Introduce ActiveSupport::TimeWithZone, for wrapping Time instances with a TimeZone. Introduce instance methods to Time for creating TimeWithZone instances, and class methods for managing a global time zone

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8696 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

1 files changed, 212 insertions, 0 deletions

diff --git a/activesupport/test/core_ext/time_with_zone_test.rb b/activesupport/test/core_ext/time_with_zone_test.rb
new file mode 100644
index 0000000000..5b0c0fd569
--- /dev/null
+++ b/activesupport/test/core_ext/time_with_zone_test.rb
@@ -0,0 +1,212 @@
+require 'abstract_unit'
+
+uses_tzinfo 'TimeWithZoneTest' do
+  
+  class TimeWithZoneTest < Test::Unit::TestCase
+
+    def setup
+      @utc = Time.utc(2000, 1, 1, 0)
+      @time_zone = TimeZone['Eastern Time (US & Canada)']
+      @twz = ActiveSupport::TimeWithZone.new(@utc, @time_zone)
+    end
+  
+    def test_utc
+      assert_equal @utc, @twz.utc
+    end
+  
+    def test_time
+      assert_equal Time.utc(1999, 12, 31, 19), @twz.time
+    end
+  
+    def test_time_zone
+      assert_equal @time_zone, @twz.time_zone
+    end
+  
+    def test_in_time_zone
+      assert_equal ActiveSupport::TimeWithZone.new(@utc, TimeZone['Alaska']), @twz.in_time_zone('Alaska')
+    end
+  
+    def test_in_current_time_zone
+      with_time_zone 'Alaska' do
+        assert_equal ActiveSupport::TimeWithZone.new(@utc, TimeZone['Alaska']), @twz.in_current_time_zone
+      end
+    end
+  
+    def test_change_time_zone
+      silence_warnings do # silence warnings raised by tzinfo gem
+        assert_equal ActiveSupport::TimeWithZone.new(nil, TimeZone['Alaska'], Time.utc(1999, 12, 31, 19)), @twz.change_time_zone('Alaska')
+      end
+    end
+  
+    def test_change_time_zone_to_current
+      with_time_zone 'Alaska' do
+        assert_equal ActiveSupport::TimeWithZone.new(nil, TimeZone['Alaska'], Time.utc(1999, 12, 31, 19)), @twz.change_time_zone_to_current
+      end
+    end
+  
+    def test_utc?
+      assert_equal false, @twz.utc?
+      assert_equal true, ActiveSupport::TimeWithZone.new(Time.utc(2000)).utc?
+    end
+      
+    def test_formatted_offset
+      assert_equal '-05:00', @twz.formatted_offset
+      assert_equal '-04:00', ActiveSupport::TimeWithZone.new(Time.utc(2000, 6), @time_zone).formatted_offset #dst
+    end
+      
+    def test_dst?
+      assert_equal false, @twz.dst?
+      assert_equal true, ActiveSupport::TimeWithZone.new(Time.utc(2000, 6), @time_zone).dst?
+    end
+      
+    def test_zone
+      assert_equal 'EST', @twz.zone
+      assert_equal 'EDT', ActiveSupport::TimeWithZone.new(Time.utc(2000, 6), @time_zone).zone #dst
+    end
+      
+    def test_to_json
+      assert_equal "\"1999/12/31 19:00:00 -0500\"", @twz.to_json
+    end
+      
+    def test_strftime
+      assert_equal '1999-12-31 19:00:00 EST -0500', @twz.strftime('%Y-%m-%d %H:%M:%S %Z %z')
+    end
+      
+    def test_inspect
+      assert_equal 'Fri, 31 Dec 1999 19:00:00 EST -05:00', @twz.inspect
+    end
+      
+    def test_to_s
+      assert_equal '1999-12-31 19:00:00 -0500', @twz.to_s
+    end
+      
+    def test_to_s_db
+      assert_equal '2000-01-01 00:00:00', @twz.to_s(:db)
+    end
+      
+    def test_xmlschema
+      assert_equal "1999-12-31T19:00:00-05:00", @twz.xmlschema
+    end
+      
+    def test_compare
+      assert_equal  1, @twz <=> Time.utc(1999, 12, 31, 23, 59, 59)
+      assert_equal  0, @twz <=> Time.utc(2000)
+      assert_equal(-1, @twz <=> Time.utc(2000, 1, 1, 0, 0, 1))
+    end
+      
+    def test_plus
+      assert_equal Time.utc(1999, 12, 31, 19, 0 ,5), (@twz + 5).time
+    end
+      
+    def test_plus_with_duration
+      assert_equal Time.utc(2000, 1, 5, 19, 0 ,0), (@twz + 5.days).time
+    end
+      
+    def test_minus
+      assert_equal Time.utc(1999, 12, 31, 18, 59 ,55), (@twz - 5).time
+    end
+      
+    def test_minus_with_duration
+      assert_equal Time.utc(1999, 12, 26, 19, 0 ,0), (@twz - 5.days).time
+    end
+      
+    def test_to_time
+      assert_equal @twz, @twz.to_time
+    end
+      
+    def test_acts_like_time
+      assert @twz.acts_like?(:time)
+    end
+    
+    def test_is_a
+      assert @twz.is_a?(Time)
+      assert @twz.kind_of?(Time)
+      assert @twz.is_a?(ActiveSupport::TimeWithZone)
+    end
+      
+    def test_method_missing_with_time_return_value
+      assert_instance_of ActiveSupport::TimeWithZone, @twz.months_since(1)
+      assert_equal Time.utc(2000, 1, 31, 19, 0 ,0), @twz.months_since(1).time
+    end
+      
+    def test_method_missing_with_non_time_return_value
+      assert_equal 1999, @twz.year
+      assert_equal 12, @twz.month
+      assert_equal 31, @twz.day
+    end
+  
+    protected
+      def with_time_zone(zone)
+        old_zone, Time.zone = Time.zone, Time.get_zone(zone)
+        yield
+      ensure
+        Time.zone = old_zone
+      end
+  end
+  
+  class TimeWithZoneMethodsForTimeAndDateTimeTest < Test::Unit::TestCase
+    def setup
+      @t, @dt = Time.utc(2000), DateTime.civil(2000)
+    end
+
+    def test_in_time_zone
+      silence_warnings do # silence warnings raised by tzinfo gem
+        with_time_zone 'Eastern Time (US & Canada)' do
+          assert_equal 'Fri, 31 Dec 1999 15:00:00 AKST -09:00', @t.in_time_zone('Alaska').inspect
+          assert_equal 'Fri, 31 Dec 1999 15:00:00 AKST -09:00', @dt.in_time_zone('Alaska').inspect
+          assert_equal 'Fri, 31 Dec 1999 14:00:00 HST -10:00', @t.in_time_zone('Hawaii').inspect
+          assert_equal 'Fri, 31 Dec 1999 14:00:00 HST -10:00', @dt.in_time_zone('Hawaii').inspect
+        end
+      end
+    end
+
+    def test_in_current_time_zone
+      with_time_zone 'Alaska' do
+        assert_equal 'Fri, 31 Dec 1999 15:00:00 AKST -09:00', @t.in_current_time_zone.inspect
+        assert_equal 'Fri, 31 Dec 1999 15:00:00 AKST -09:00', @dt.in_current_time_zone.inspect
+      end
+      with_time_zone 'Hawaii' do
+        assert_equal 'Fri, 31 Dec 1999 14:00:00 HST -10:00', @t.in_current_time_zone.inspect
+        assert_equal 'Fri, 31 Dec 1999 14:00:00 HST -10:00', @dt.in_current_time_zone.inspect
+      end
+      with_time_zone nil do
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 UTC +00:00', @t.in_current_time_zone.inspect
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 UTC +00:00', @dt.in_current_time_zone.inspect
+      end
+    end
+    
+    def test_change_time_zone
+      silence_warnings do # silence warnings raised by tzinfo gem
+        with_time_zone 'Eastern Time (US & Canada)' do
+          assert_equal 'Sat, 01 Jan 2000 00:00:00 AKST -09:00', @t.change_time_zone('Alaska').inspect
+          assert_equal 'Sat, 01 Jan 2000 00:00:00 AKST -09:00', @dt.change_time_zone('Alaska').inspect
+          assert_equal 'Sat, 01 Jan 2000 00:00:00 HST -10:00', @t.change_time_zone('Hawaii').inspect
+          assert_equal 'Sat, 01 Jan 2000 00:00:00 HST -10:00', @dt.change_time_zone('Hawaii').inspect
+        end
+      end
+    end
+    
+    def test_change_time_zone_to_current
+      with_time_zone 'Alaska' do
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 AKST -09:00', @t.change_time_zone_to_current.inspect
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 AKST -09:00', @dt.change_time_zone_to_current.inspect
+      end
+      with_time_zone 'Hawaii' do
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 HST -10:00', @t.change_time_zone_to_current.inspect
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 HST -10:00', @dt.change_time_zone_to_current.inspect
+      end
+      with_time_zone nil do
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 UTC +00:00', @t.change_time_zone_to_current.inspect
+        assert_equal 'Sat, 01 Jan 2000 00:00:00 UTC +00:00', @dt.change_time_zone_to_current.inspect
+      end
+    end
+    
+    protected
+      def with_time_zone(zone)
+        old_zone, Time.zone = Time.zone, Time.get_zone(zone)
+        yield
+      ensure
+        Time.zone = old_zone
+      end
+  end
+end