Class: TimeZone

Constants

NameValue
MAPPING { "International Date Line West" => "Pacific/Midway", "Midway Island" => "Pacific/Midway", "Samoa" => "Pacific/Pago_Pago", "Hawaii" => "Pacific/Honolulu", "Alaska" => "America/Juneau", "Pacific Time (US & Canada)" => "America/Los_Angeles", "Tijuana" => "America/Tijuana", "Mountain Time (US & Canada)" => "America/Denver", "Arizona" => "America/Phoenix", "Chihuahua" => "America/Chihuahua", "Mazatlan" => "America/Mazatlan", "Central Time (US & Canada)" => "America/Chicago", "Saskatchewan" => "America/Regina", "Guadalajara" => "America/Mexico_City", "Mexico City" => "America/Mexico_City", "Monterrey" => "America/Monterrey", "Central America" => "America/Guatemala", "Eastern Time (US & Canada)" => "America/New_York", "Indiana (East)" => "America/Indiana/Indianapolis", "Bogota" => "America/Bogota", "Lima" => "America/Lima", "Quito" => "America/Lima", "Atlantic Time (Canada)" => "America/Halifax", "Caracas" => "America/Caracas", "La Paz" => "America/La_Paz", "Santiago" => "America/Santiago", "Newfoundland" => "America/St_Johns", "Brasilia" => "America/Argentina/Buenos_Aires", "Buenos Aires" => "America/Argentina/Buenos_Aires", "Georgetown" => "America/Argentina/San_Juan", "Greenland" => "America/Godthab", "Mid-Atlantic" => "Atlantic/South_Georgia", "Azores" => "Atlantic/Azores", "Cape Verde Is." => "Atlantic/Cape_Verde", "Dublin" => "Europe/Dublin", "Edinburgh" => "Europe/Dublin", "Lisbon" => "Europe/Lisbon", "London" => "Europe/London", "Casablanca" => "Africa/Casablanca", "Monrovia" => "Africa/Monrovia", "UTC" => "Etc/UTC", "Belgrade" => "Europe/Belgrade", "Bratislava" => "Europe/Bratislava", "Budapest" => "Europe/Budapest", "Ljubljana" => "Europe/Ljubljana", "Prague" => "Europe/Prague", "Sarajevo" => "Europe/Sarajevo", "Skopje" => "Europe/Skopje", "Warsaw" => "Europe/Warsaw", "Zagreb" => "Europe/Zagreb", "Brussels" => "Europe/Brussels", "Copenhagen" => "Europe/Copenhagen", "Madrid" => "Europe/Madrid", "Paris" => "Europe/Paris", "Amsterdam" => "Europe/Amsterdam", "Berlin" => "Europe/Berlin", "Bern" => "Europe/Berlin", "Rome" => "Europe/Rome", "Stockholm" => "Europe/Stockholm", "Vienna" => "Europe/Vienna", "West Central Africa" => "Africa/Algiers", "Bucharest" => "Europe/Bucharest", "Cairo" => "Africa/Cairo", "Helsinki" => "Europe/Helsinki", "Kyev" => "Europe/Kiev", "Riga" => "Europe/Riga", "Sofia" => "Europe/Sofia", "Tallinn" => "Europe/Tallinn", "Vilnius" => "Europe/Vilnius", "Athens" => "Europe/Athens", "Istanbul" => "Europe/Istanbul", "Minsk" => "Europe/Minsk", "Jerusalem" => "Asia/Jerusalem", "Harare" => "Africa/Harare", "Pretoria" => "Africa/Johannesburg", "Moscow" => "Europe/Moscow", "St. Petersburg" => "Europe/Moscow", "Volgograd" => "Europe/Moscow", "Kuwait" => "Asia/Kuwait", "Riyadh" => "Asia/Riyadh", "Nairobi" => "Africa/Nairobi", "Baghdad" => "Asia/Baghdad", "Tehran" => "Asia/Tehran", "Abu Dhabi" => "Asia/Muscat", "Muscat" => "Asia/Muscat", "Baku" => "Asia/Baku", "Tbilisi" => "Asia/Tbilisi", "Yerevan" => "Asia/Yerevan", "Kabul" => "Asia/Kabul", "Ekaterinburg" => "Asia/Yekaterinburg", "Islamabad" => "Asia/Karachi", "Karachi" => "Asia/Karachi", "Tashkent" => "Asia/Tashkent", "Chennai" => "Asia/Kolkata", "Kolkata" => "Asia/Kolkata", "Mumbai" => "Asia/Kolkata", "New Delhi" => "Asia/Kolkata", "Kathmandu" => "Asia/Katmandu", "Astana" => "Asia/Dhaka", "Dhaka" => "Asia/Dhaka", "Sri Jayawardenepura" => "Asia/Dhaka", "Almaty" => "Asia/Almaty", "Novosibirsk" => "Asia/Novosibirsk", "Rangoon" => "Asia/Rangoon", "Bangkok" => "Asia/Bangkok", "Hanoi" => "Asia/Bangkok", "Jakarta" => "Asia/Jakarta", "Krasnoyarsk" => "Asia/Krasnoyarsk", "Beijing" => "Asia/Shanghai", "Chongqing" => "Asia/Chongqing", "Hong Kong" => "Asia/Hong_Kong", "Urumqi" => "Asia/Urumqi", "Kuala Lumpur" => "Asia/Kuala_Lumpur", "Singapore" => "Asia/Singapore", "Taipei" => "Asia/Taipei", "Perth" => "Australia/Perth", "Irkutsk" => "Asia/Irkutsk", "Ulaan Bataar" => "Asia/Ulaanbaatar", "Seoul" => "Asia/Seoul", "Osaka" => "Asia/Tokyo", "Sapporo" => "Asia/Tokyo", "Tokyo" => "Asia/Tokyo", "Yakutsk" => "Asia/Yakutsk", "Darwin" => "Australia/Darwin", "Adelaide" => "Australia/Adelaide", "Canberra" => "Australia/Melbourne", "Melbourne" => "Australia/Melbourne", "Sydney" => "Australia/Sydney", "Brisbane" => "Australia/Brisbane", "Hobart" => "Australia/Hobart", "Vladivostok" => "Asia/Vladivostok", "Guam" => "Pacific/Guam", "Port Moresby" => "Pacific/Port_Moresby", "Magadan" => "Asia/Magadan", "Solomon Is." => "Asia/Magadan", "New Caledonia" => "Pacific/Noumea", "Fiji" => "Pacific/Fiji", "Kamchatka" => "Asia/Kamchatka", "Marshall Is." => "Pacific/Majuro", "Auckland" => "Pacific/Auckland", "Wellington" => "Pacific/Auckland", "Nuku'alofa" => "Pacific/Tongatapu"
US_ZONES /US|Arizona|Indiana|Hawaii|Alaska/

Aliases

Old nameNew name
new create

Attributes

NameRead/write?
name R

Public Class Methods

[] (arg)

Locate a specific time zone object. If the argument is a string, it is interpreted to mean the name of the timezone to locate. If it is a numeric value it is either the hour offset, or the second offset, of the timezone to find. (The first one with that offset will be returned.) Returns nil if no such time zone is known to the system. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 340
340:     def [](arg)
341:       case arg
342:         when String
343:           all # force the zones to be loaded
344:           @@zones_map[arg]
345:         when Numeric, ActiveSupport::Duration
346:           arg *= 3600 if arg.abs <= 13
347:           all.find { |z| z.utc_offset == arg.to_i }
348:         else
349:           raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}"
350:       end
351:     end

all ()

Return an array of all TimeZone objects. There are multiple TimeZone objects per time zone, in many cases, to make it easier for users to find their own time zone. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 271
271:     def all
272:       unless @@zones
273:         @@zones = []
274:         @@zones_map = {}
275:         [[-39_600, "International Date Line West", "Midway Island", "Samoa" ],
276:          [-36_000, "Hawaii" ],
277:          [-32_400, "Alaska" ],
278:          [-28_800, "Pacific Time (US & Canada)", "Tijuana" ],
279:          [-25_200, "Mountain Time (US & Canada)", "Chihuahua", "Mazatlan",
280:                    "Arizona" ],
281:          [-21_600, "Central Time (US & Canada)", "Saskatchewan", "Guadalajara",
282:                    "Mexico City", "Monterrey", "Central America" ],
283:          [-18_000, "Eastern Time (US & Canada)", "Indiana (East)", "Bogota",
284:                    "Lima", "Quito" ],
285:          [-14_400, "Atlantic Time (Canada)", "Caracas", "La Paz", "Santiago" ],
286:          [-12_600, "Newfoundland" ],
287:          [-10_800, "Brasilia", "Buenos Aires", "Georgetown", "Greenland" ],
288:          [ -7_200, "Mid-Atlantic" ],
289:          [ -3_600, "Azores", "Cape Verde Is." ],
290:          [      0, "Dublin", "Edinburgh", "Lisbon", "London", "Casablanca",
291:                    "Monrovia", "UTC" ],
292:          [  3_600, "Belgrade", "Bratislava", "Budapest", "Ljubljana", "Prague",
293:                    "Sarajevo", "Skopje", "Warsaw", "Zagreb", "Brussels",
294:                    "Copenhagen", "Madrid", "Paris", "Amsterdam", "Berlin",
295:                    "Bern", "Rome", "Stockholm", "Vienna",
296:                    "West Central Africa" ],
297:          [  7_200, "Bucharest", "Cairo", "Helsinki", "Kyev", "Riga", "Sofia",
298:                    "Tallinn", "Vilnius", "Athens", "Istanbul", "Minsk",
299:                    "Jerusalem", "Harare", "Pretoria" ],
300:          [ 10_800, "Moscow", "St. Petersburg", "Volgograd", "Kuwait", "Riyadh",
301:                    "Nairobi", "Baghdad" ],
302:          [ 12_600, "Tehran" ],
303:          [ 14_400, "Abu Dhabi", "Muscat", "Baku", "Tbilisi", "Yerevan" ],
304:          [ 16_200, "Kabul" ],
305:          [ 18_000, "Ekaterinburg", "Islamabad", "Karachi", "Tashkent" ],
306:          [ 19_800, "Chennai", "Kolkata", "Mumbai", "New Delhi" ],
307:          [ 20_700, "Kathmandu" ],
308:          [ 21_600, "Astana", "Dhaka", "Sri Jayawardenepura", "Almaty",
309:                    "Novosibirsk" ],
310:          [ 23_400, "Rangoon" ],
311:          [ 25_200, "Bangkok", "Hanoi", "Jakarta", "Krasnoyarsk" ],
312:          [ 28_800, "Beijing", "Chongqing", "Hong Kong", "Urumqi",
313:                    "Kuala Lumpur", "Singapore", "Taipei", "Perth", "Irkutsk",
314:                    "Ulaan Bataar" ],
315:          [ 32_400, "Seoul", "Osaka", "Sapporo", "Tokyo", "Yakutsk" ],
316:          [ 34_200, "Darwin", "Adelaide" ],
317:          [ 36_000, "Canberra", "Melbourne", "Sydney", "Brisbane", "Hobart",
318:                    "Vladivostok", "Guam", "Port Moresby" ],
319:          [ 39_600, "Magadan", "Solomon Is.", "New Caledonia" ],
320:          [ 43_200, "Fiji", "Kamchatka", "Marshall Is.", "Auckland",
321:                    "Wellington" ],
322:          [ 46_800, "Nuku'alofa" ]].
323:         each do |offset, *places|
324:           places.each do |place|
325:             zone = create(place, offset)
326:             @@zones << zone
327:             @@zones_map[place] = zone
328:           end
329:         end
330:         @@zones.sort!
331:       end
332:       @@zones
333:     end

new (name, utc_offset, tzinfo = nil)

Create a new TimeZone object with the given name and offset. The offset is the number of seconds that this time zone is offset from UTC (GMT). Seconds were chosen as the offset unit because that is the unit that Ruby uses to represent time zone offsets (see Time#utc_offset). 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 155
155:   def initialize(name, utc_offset, tzinfo = nil)
156:     @name = name
157:     @utc_offset = utc_offset
158:     @tzinfo = tzinfo
159:   end

new (name)

Return a TimeZone instance with the given name, or nil if no such TimeZone instance exists. (This exists to support the use of this class with the composed_of macro.) 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 264
264:     def new(name)
265:       self[name]
266:     end

us_zones ()

A convenience method for returning a collection of TimeZone objects for time zones in the USA. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 359
359:     def us_zones
360:       all.find_all { |z| z.name =~ US_ZONES }
361:     end

Public Instance Methods

<=> (zone)

Compare this time zone to the parameter. The two are comapred first on their offsets, and then by name. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 173
173:   def <=>(zone)
174:     result = (utc_offset <=> zone.utc_offset)
175:     result = (name <=> zone.name) if result == 0
176:     result
177:   end

at (secs)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from number of seconds since the Unix epoch. Example: 

  Time.zone = "Hawaii"        # => "Hawaii"
  Time.utc(2000).to_f         # => 946684800.0
  Time.zone.at(946684800.0)   # => Fri, 31 Dec 1999 14:00:00 HST -10:00

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 198
198:   def at(secs)
199:     utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs)
200:     utc.in_time_zone(self)
201:   end

formatted_offset (colon=true, alternate_utc_string = nil)

Returns the offset of this time zone as a formatted string, of the format "+HH:MM". 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 167
167:   def formatted_offset(colon=true, alternate_utc_string = nil)
168:     utc_offset == 0 && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
169:   end

local (*args)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from given values. Example: 

  Time.zone = "Hawaii"                      # => "Hawaii"
  Time.zone.local(2007, 2, 1, 15, 30, 45)   # => Thu, 01 Feb 2007 15:30:45 HST -10:00

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 188
188:   def local(*args)
189:     time = Time.utc_time(*args)
190:     ActiveSupport::TimeWithZone.new(nil, self, time)
191:   end

local_to_utc (time, dst=true)

Adjust the given time to the simultaneous time in UTC. Returns a Time.utc() instance. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 238
238:   def local_to_utc(time, dst=true)
239:     tzinfo.local_to_utc(time, dst)
240:   end

now ()

Returns an ActiveSupport::TimeWithZone instance representing the current time in the time zone represented by self. Example: 

  Time.zone = 'Hawaii'  # => "Hawaii"
  Time.zone.now         # => Wed, 23 Jan 2008 20:24:27 HST -10:00

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 222
222:   def now
223:     Time.now.utc.in_time_zone(self)
224:   end

parse (str, now=now)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from parsed string. Example: 

  Time.zone = "Hawaii"                      # => "Hawaii"
  Time.zone.parse('1999-12-31 14:00:00')    # => 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.now                 # => Fri, 31 Dec 1999 14:00:00 HST -10:00
  Time.zone.parse('22:30:00')   # => Fri, 31 Dec 1999 22:30:00 HST -10:00

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 212
212:   def parse(str, now=now)
213:     time = Time.parse(str, now) rescue DateTime.parse(str)
214:     ActiveSupport::TimeWithZone.new(nil, self, time)
215:   end

period_for_local (time, dst=true)

Available so that TimeZone instances respond like TZInfo::Timezone instances 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 248
248:   def period_for_local(time, dst=true)
249:     tzinfo.period_for_local(time, dst)
250:   end

period_for_utc (time)

Available so that TimeZone instances respond like TZInfo::Timezone instances 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 243
243:   def period_for_utc(time)
244:     tzinfo.period_for_utc(time)
245:   end

to_s ()

Returns a textual representation of this time zone. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 180
180:   def to_s
181:     "(UTC#{formatted_offset}) #{name}"
182:   end

today ()

Return the current date in this time zone. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 227
227:   def today
228:     tzinfo.now.to_date
229:   end

tzinfo () 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 252
252:   def tzinfo
253:     @tzinfo ||= TZInfo::Timezone.get(MAPPING[name])
254:   end

utc_offset () 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 161
161:   def utc_offset
162:     @utc_offset ||= tzinfo.current_period.utc_offset
163:   end

utc_to_local (time)

Adjust the given time to the simultaneous time in the time zone represented by self. Returns a Time.utc() instance — if you want an ActiveSupport::TimeWithZone instance, use Time#in_time_zone() instead. 

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 233
233:   def utc_to_local(time)
234:     tzinfo.utc_to_local(time)
235:   end