From c1c1d6c2ea72424dfae0b5ee1991d904dcf0f252 Mon Sep 17 00:00:00 2001
From: gbuesing <gbuesing@gmail.com>
Date: Sun, 18 May 2008 14:13:47 -0500
Subject: Adding documentation for time zone features

---
 .../lib/active_support/core_ext/time/zones.rb      | 27 +++++++++++++++-------
 1 file changed, 19 insertions(+), 8 deletions(-)

(limited to 'activesupport/lib/active_support/core_ext/time')

diff --git a/activesupport/lib/active_support/core_ext/time/zones.rb b/activesupport/lib/active_support/core_ext/time/zones.rb
index 3ffc71407c..cf28d0fa95 100644
--- a/activesupport/lib/active_support/core_ext/time/zones.rb
+++ b/activesupport/lib/active_support/core_ext/time/zones.rb
@@ -1,9 +1,7 @@
 module ActiveSupport #:nodoc:
   module CoreExtensions #:nodoc:
     module Time #:nodoc:
-      # Methods for creating TimeWithZone objects from Time instances
       module Zones
-        
         def self.included(base) #:nodoc:
           base.extend(ClassMethods) if base == ::Time # i.e., don't include class methods in DateTime
         end
@@ -11,18 +9,31 @@ module ActiveSupport #:nodoc:
         module ClassMethods
           attr_accessor :zone_default
           
+          # Returns the TimeZone for the current request, if this has been set (via Time.zone=). 
+          # If Time.zone has not been set for the current request, returns the TimeZone specified in config.time_zone
           def zone
             Thread.current[:time_zone] || zone_default
           end
 
-          # Sets a global default time zone, separate from the system time zone in ENV['TZ']. 
-          # Accepts either a Rails TimeZone object, a string that identifies a 
-          # Rails TimeZone object (e.g., "Central Time (US & Canada)"), or a TZInfo::Timezone object.
+          # Sets Time.zone to a TimeZone object for the current request/thread. 
+          #
+          # This method accepts any of the following:
+          #
+          #   * a Rails TimeZone object
+          #   * an identifier for a Rails TimeZone object (e.g., "Eastern Time (US & Canada)", -5.hours)
+          #   * a TZInfo::Timezone object
+          #   * an identifier for a TZInfo::Timezone object (e.g., "America/New_York")
+          #
+          # Here's an example of how you might set Time.zone on a per request basis -- current_user.time_zone
+          # just needs to return a string identifying the user's preferred TimeZone:
           #
-          # Any Time or DateTime object can use this default time zone, via <tt>in_time_zone</tt>.
+          #   class ApplicationController < ActionController::Base
+          #     before_filter :set_time_zone
           #
-          #   Time.zone = 'Hawaii'          # => 'Hawaii'
-          #   Time.utc(2000).in_time_zone   # => Fri, 31 Dec 1999 14:00:00 HST -10:00
+          #     def set_time_zone
+          #       Time.zone = current_user.time_zone
+          #     end
+          #   end
           def zone=(time_zone)
             Thread.current[:time_zone] = get_zone(time_zone)
           end
-- 
cgit v1.2.3