class ActiveSupport::TimeZone
def self.find_tzinfo(name)
def self.find_tzinfo(name) require 'active_support/tzinfo' unless defined?(::TZInfo) ::TZInfo::TimezoneProxy.new(MAPPING[name] || name) end
def self.seconds_to_utc_offset(seconds, colon = true)
and turns this into an +HH:MM formatted string. Example:
Assumes self represents an offset from UTC in seconds (as returned from Time#utc_offset)
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) 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) return true if name =~ re || MAPPING[name] =~ re 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 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"
Method for creating new ActiveSupport::TimeWithZone instance in time zone of +self+ from number of seconds since the Unix epoch. Example:
def at(secs) utc = Time.at(secs).utc rescue DateTime.civil(1970).since(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 that
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) begin require 'tzinfo' rescue LoadError => e $stderr.puts "You don't have tzinfo installed in your application. Please add it to your Gemfile and run bundle install" raise e end @name = name @utc_offset = utc_offset @tzinfo = tzinfo || TimeZone.find_tzinfo(name) @current_period = nil end
def local(*args)
Time.zone = "Hawaii" # => "Hawaii"
Method for creating new ActiveSupport::TimeWithZone instance in time zone of +self+ from given values. Example:
def local(*args) time = Time.utc_time(*args) ActiveSupport::TimeWithZone.new(nil, self, time) end
def local_to_utc(time, dst=true)
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"
in the time zone represented by +self+. Example:
Returns an ActiveSupport::TimeWithZone instance representing the current time
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
If upper components are missing from the string, they are supplied from TimeZone#now:
Time.zone.parse('1999-12-31 14:00:00') # => Fri, 31 Dec 1999 14:00:00 HST -10:00
Time.zone = "Hawaii" # => "Hawaii"
Method for creating new ActiveSupport::TimeWithZone instance in time zone of +self+ from parsed string. Example:
def parse(str, now=now) date_parts = Date._parse(str) return if date_parts.blank? time = Time.parse(str, now) rescue DateTime.parse(str) if date_parts[:offset].nil? ActiveSupport::TimeWithZone.new(nil, self, time) else time.in_time_zone(self) end end
def period_for_local(time, dst=true)
def period_for_local(time, dst=true) tzinfo.period_for_local(time, dst) end
def period_for_utc(time)
def period_for_utc(time) tzinfo.period_for_utc(time) 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)
Adjust the given time to the simultaneous time in the time zone represented by +self+. Returns a
def utc_to_local(time) tzinfo.utc_to_local(time) end
def zones_map
def zones_map @zones_map ||= Hash[MAPPING.map { |place, _| [place, create(place)] }] end