class ActiveSupport::TimeZone
this will be used instead of the bundled version.)
install the TZInfo gem (if a recent version of the gem is installed locally,
If you need to use zones that aren’t defined by TimeZone, you’ll need to
definitions necessary to support the zones defined by the TimeZone class.
The version of TZInfo bundled with Active Support only includes the
Time.zone.now # => Sun, 18 May 2008 14:30:44 EDT -04:00
Time.zone.name # => “Eastern Time (US & Canada)”
Time.zone # => #<TimeZone:0x514834…>
end
config.time_zone = ‘Eastern Time (US & Canada)’
class Application < Rails::Application
# application.rb:
access this TimeZone object via Time.zone:
If you set config.time_zone in the Rails Application, you canparse, at and now methods.
* Create ActiveSupport::TimeWithZone instances via TimeZone’s local,
* Lazily load TZInfo::Timezone instances only when they’re needed.
(e.g., “Eastern Time (US & Canada)” instead of “America/New_York”).
* Retrieve and display zones with a friendlier name
zones.
* Limit the set of zones provided by TZInfo to a meaningful subset of 146
It allows us to do the following:
The TimeZone class serves as a wrapper around TZInfo::Timezone instances.
def self.find_tzinfo(name)
def self.find_tzinfo(name) TZInfo::TimezoneProxy.new(MAPPING[name] || name) end
def self.seconds_to_utc_offset(seconds, colon = true)
Time#utc_offset) and turns this into an +HH:MM formatted string.
Assumes self represents an offset from UTC in seconds (as returned from
def self.seconds_to_utc_offset(seconds, colon = true) format = colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON sign = (seconds < 0 ? '-' : '+') hours = seconds.abs / 3600 minutes = (seconds.abs % 3600) / 60 format % [sign, hours, minutes] end
def <=>(zone)
Compare this time zone to the parameter. The two are compared first on
def <=>(zone) return unless zone.respond_to? :utc_offset result = (utc_offset <=> zone.utc_offset) result = (name <=> zone.name) if result == 0 result end
def =~(re)
Compare #name and TZInfo identifier to a supplied regexp, returning +true+
def =~(re) re === name || re === MAPPING[name] end
def [](arg)
timezone to find. (The first one with that offset will be returned.)
numeric value it is either the hour offset, or the second offset, of the
is interpreted to mean the name of the timezone to locate. If it is a
Locate a specific time zone object. If the argument is a string, it
def [](arg) case arg when String begin lazy_zones_map[arg] ||= lookup(arg).tap { |tz| tz.utc_offset } rescue TZInfo::InvalidTimezoneIdentifier nil end when Numeric, ActiveSupport::Duration arg *= 3600 if arg.abs <= 13 all.find { |z| z.utc_offset == arg.to_i } else raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}" end end
def all
TimeZone objects per time zone, in many cases, to make it easier
Return an array of all TimeZone objects. There are multiple
def all @zones ||= zones_map.values.sort end
def at(secs)
Time.utc(2000).to_f # => 946684800.0
Time.zone = 'Hawaii' # => "Hawaii"
of +self+ from number of seconds since the Unix epoch.
Method for creating new ActiveSupport::TimeWithZone instance in time zone
def at(secs) Time.at(secs).utc.in_time_zone(self) end
def formatted_offset(colon=true, alternate_utc_string = nil)
Returns the offset of this time zone as a formatted string, of the
def formatted_offset(colon=true, alternate_utc_string = nil) utc_offset == 0 && alternate_utc_string || self.class.seconds_to_utc_offset(utc_offset, colon) end
def initialize(name, utc_offset = nil, tzinfo = nil)
(GMT). Seconds were chosen as the offset unit because that is the unit
offset is the number of seconds that this time zone is offset from UTC
Create a new TimeZone object with the given name and offset. The
def initialize(name, utc_offset = nil, tzinfo = nil) self.class.send(:require_tzinfo) @name = name @utc_offset = utc_offset @tzinfo = tzinfo || TimeZone.find_tzinfo(name) @current_period = nil end
def lazy_zones_map
def lazy_zones_map require_tzinfo @lazy_zones_map ||= Hash.new do |hash, place| hash[place] = create(place) if MAPPING.has_key?(place) end end
def local(*args)
Time.zone = 'Hawaii' # => "Hawaii"
of +self+ from given values.
Method for creating new ActiveSupport::TimeWithZone instance in time zone
def local(*args) time = Time.utc(*args) ActiveSupport::TimeWithZone.new(nil, self, time) end
def local_to_utc(time, dst=true)
Adjust the given time to the simultaneous time in UTC. Returns a
def local_to_utc(time, dst=true) tzinfo.local_to_utc(time, dst) end
def lookup(name)
def lookup(name) (tzinfo = find_tzinfo(name)) && create(tzinfo.name.freeze) end
def new(name)
such TimeZone instance exists. (This exists to support the use of
Return a TimeZone instance with the given name, or +nil+ if no
def new(name) self[name] end
def now
Time.zone = 'Hawaii' # => "Hawaii"
time in the time zone represented by +self+.
Returns an ActiveSupport::TimeWithZone instance representing the current
def now time_now.utc.in_time_zone(self) end
def parse(str, now=now())
Time.zone.now # => Fri, 31 Dec 1999 14:00:00 HST -10:00
TimeZone#now:
If upper components are missing from the string, they are supplied from
Time.zone.parse('1999-12-31 14:00:00') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Time.zone = 'Hawaii' # => "Hawaii"
of +self+ from parsed string.
Method for creating new ActiveSupport::TimeWithZone instance in time zone
def parse(str, now=now()) parts = Date._parse(str, false) return if parts.empty? time = Time.new( parts.fetch(:year, now.year), parts.fetch(:mon, now.month), parts.fetch(:mday, now.day), parts.fetch(:hour, 0), parts.fetch(:min, 0), parts.fetch(:sec, 0) + parts.fetch(:sec_fraction, 0), parts.fetch(:offset, 0) ) if parts[:offset] TimeWithZone.new(time.utc, self) else TimeWithZone.new(nil, self, time) end end
def period_for_local(time, dst=true)
Available so that TimeZone instances respond like TZInfo::Timezone
def period_for_local(time, dst=true) tzinfo.period_for_local(time, dst) end
def period_for_utc(time)
Available so that TimeZone instances respond like TZInfo::Timezone
def period_for_utc(time) tzinfo.period_for_utc(time) end
def require_tzinfo
def require_tzinfo require 'tzinfo' unless defined?(::TZInfo) rescue LoadError $stderr.puts "You don't have tzinfo installed in your application. Please add it to your Gemfile and run bundle install" raise end
def time_now
def time_now Time.now end
def to_s
def to_s "(GMT#{formatted_offset}) #{name}" end
def today
def today tzinfo.now.to_date end
def us_zones
A convenience method for returning a collection of TimeZone objects
def us_zones @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ } end
def utc_offset
def utc_offset if @utc_offset @utc_offset else @current_period ||= tzinfo.try(:current_period) @current_period.try(:utc_offset) end end
def utc_to_local(time)
represented by +self+. Returns a Time.utc() instance -- if you want an
Adjust the given time to the simultaneous time in the time zone
def utc_to_local(time) tzinfo.utc_to_local(time) end
def zones_map
def zones_map @zones_map ||= begin new_zones_names = MAPPING.keys - lazy_zones_map.keys new_zones = Hash[new_zones_names.map { |place| [place, create(place)] }] lazy_zones_map.merge(new_zones) end end