Add Time Zone support to ActiveRecord, and config.time_zone property for specifying a default Time Zone. Closes #10982 [Geoff Buesing, rick]

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

2 files changed, 111 insertions, 2 deletions

diff --git a/activerecord/test/cases/attribute_methods_test.rb b/activerecord/test/cases/attribute_methods_test.rb
index d2bfb02846..427c14edbd 100755
--- a/activerecord/test/cases/attribute_methods_test.rb
+++ b/activerecord/test/cases/attribute_methods_test.rb
@@ -14,7 +14,6 @@ class AttributeMethodsTest < ActiveRecord::TestCase
     ActiveRecord::Base.attribute_method_suffix *@old_suffixes
   end
 
-
   def test_match_attribute_method_query_returns_match_data
     assert_not_nil md = @target.match_attribute_method?('title=')
     assert_equal 'title', md.pre_match
@@ -97,7 +96,7 @@ class AttributeMethodsTest < ActiveRecord::TestCase
   def test_only_time_related_columns_are_meant_to_be_cached_by_default
     expected = %w(datetime timestamp time date).sort
     assert_equal expected, ActiveRecord::Base.attribute_types_cached_by_default.map(&:to_s).sort
-end
+  end
 
   def test_declaring_attributes_as_cached_adds_them_to_the_attributes_cached_by_default
     default_attributes = Topic.cached_attributes
@@ -138,9 +137,67 @@ end
       end
     end
   end
+  
+  def test_time_attributes_are_retrieved_in_current_time_zone
+    in_time_zone "Pacific Time (US & Canada)" do
+      utc_time = Time.utc(2008, 1, 1)
+      record   = @target.new
+      record[:written_on] = utc_time
+      assert_equal utc_time, record.written_on # record.written on is equal to (i.e., simultaneous with) utc_time
+      assert_kind_of ActiveSupport::TimeWithZone, record.written_on # but is a TimeWithZone
+      assert_equal TimeZone["Pacific Time (US & Canada)"], record.written_on.time_zone # and is in the current Time.zone
+      assert_equal Time.utc(2007, 12, 31, 16), record.written_on.time # and represents time values adjusted accordingly
+    end
+  end
+  
+  def test_setting_time_zone_aware_attribute_to_utc
+    in_time_zone "Pacific Time (US & Canada)" do
+      utc_time = Time.utc(2008, 1, 1)
+      record   = @target.new
+      record.written_on = utc_time
+      assert_equal utc_time, record.written_on
+      assert_equal TimeZone["Pacific Time (US & Canada)"], record.written_on.time_zone
+      assert_equal Time.utc(2007, 12, 31, 16), record.written_on.time
+    end
+  end
+  
+  def test_setting_time_zone_aware_attribute_in_other_time_zone
+    utc_time = Time.utc(2008, 1, 1)
+    cst_time = utc_time.in_time_zone("Central Time (US & Canada)")
+    in_time_zone "Pacific Time (US & Canada)" do
+      record   = @target.new
+      record.written_on = cst_time
+      assert_equal utc_time, record.written_on
+      assert_equal TimeZone["Pacific Time (US & Canada)"], record.written_on.time_zone
+      assert_equal Time.utc(2007, 12, 31, 16), record.written_on.time
+    end
+  end
+  
+  def test_setting_time_zone_aware_attribute_in_current_time_zone
+    utc_time = Time.utc(2008, 1, 1)
+    in_time_zone "Pacific Time (US & Canada)" do
+      record   = @target.new
+      record.written_on = utc_time.in_current_time_zone
+      assert_equal utc_time, record.written_on
+      assert_equal TimeZone["Pacific Time (US & Canada)"], record.written_on.time_zone
+      assert_equal Time.utc(2007, 12, 31, 16), record.written_on.time
+    end
+  end
 
   private
   def time_related_columns_on_topic
     Topic.columns.select{|c| [:time, :date, :datetime, :timestamp].include?(c.type)}.map(&:name)
   end
+  
+  def in_time_zone(zone)
+    old_zone  = Time.zone
+    old_tz    = ActiveRecord::Base.time_zone_aware_attributes
+
+    Time.zone = zone ? TimeZone[zone] : nil
+    ActiveRecord::Base.time_zone_aware_attributes = !zone.nil?
+    yield
+  ensure
+    Time.zone = old_zone
+    ActiveRecord::Base.time_zone_aware_attributes = old_tz
+  end
 end
diff --git a/activerecord/test/cases/base_test.rb b/activerecord/test/cases/base_test.rb
index 04ed751eb5..bd076888e1 100755
--- a/activerecord/test/cases/base_test.rb
+++ b/activerecord/test/cases/base_test.rb
@@ -924,6 +924,58 @@ class BasicsTest < ActiveRecord::TestCase
     assert_equal Time.local(2004, 6, 24, 16, 24, 0), topic.written_on
   end
 
+  def test_multiparameter_attributes_on_time_with_utc
+    ActiveRecord::Base.default_timezone = :utc
+    attributes = {
+      "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",
+      "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => "00"
+    }
+    topic = Topic.find(1)
+    topic.attributes = attributes
+    assert_equal Time.utc(2004, 6, 24, 16, 24, 0), topic.written_on
+  ensure
+    ActiveRecord::Base.default_timezone = :local
+  end
+
+  def test_multiparameter_attributes_on_time_with_time_zone_aware_attributes
+    ActiveRecord::Base.time_zone_aware_attributes = true
+    ActiveRecord::Base.default_timezone = :utc
+    Time.zone = TimeZone[-28800]
+    attributes = {
+      "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",
+      "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => "00"
+    }
+    topic = Topic.find(1)
+    topic.attributes = attributes
+    assert_equal Time.utc(2004, 6, 24, 23, 24, 0), topic.written_on
+    assert_equal Time.utc(2004, 6, 24, 16, 24, 0), topic.written_on.time
+    assert_equal Time.zone, topic.written_on.time_zone
+  ensure
+    ActiveRecord::Base.time_zone_aware_attributes = false
+    ActiveRecord::Base.default_timezone = :local
+    Time.zone = nil
+  end
+  
+  def test_multiparameter_attributes_on_time_with_skip_time_zone_conversion_for_attributes
+    ActiveRecord::Base.time_zone_aware_attributes = true
+    ActiveRecord::Base.default_timezone = :utc
+    Time.zone = TimeZone[-28800]
+    Topic.skip_time_zone_conversion_for_attributes = [:written_on]
+    attributes = {
+      "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",
+      "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => "00"
+    }
+    topic = Topic.find(1)
+    topic.attributes = attributes
+    assert_equal Time.utc(2004, 6, 24, 16, 24, 0), topic.written_on
+    assert_equal false, topic.written_on.respond_to?(:time_zone)
+  ensure
+    ActiveRecord::Base.time_zone_aware_attributes = false
+    ActiveRecord::Base.default_timezone = :local
+    Time.zone = nil
+    Topic.skip_time_zone_conversion_for_attributes = []
+  end
+
   def test_multiparameter_attributes_on_time_with_empty_seconds
     attributes = {
       "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",