Class: ActiveSupport::TimeZone

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
activesupport/lib/active_support/values/time_zone.rb

Constant Summary

MAPPING =

Keys are Rails TimeZone names, values are TZInfo identifiers

{
  "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/Sao_Paulo",
  "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/Colombo",
  "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"
}.each { |name, zone| name.freeze; zone.freeze }

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (TimeZone) initialize(name, utc_offset = nil, 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).



181
182
183
184
185
186
# File 'activesupport/lib/active_support/values/time_zone.rb', line 181

def initialize(name, utc_offset = nil, tzinfo = nil)
  @name = name
  @utc_offset = utc_offset
  @tzinfo = tzinfo || TimeZone.find_tzinfo(name)
  @current_period = nil
end

Instance Attribute Details

- (Object) name (readonly)

Returns the value of attribute name



174
175
176
# File 'activesupport/lib/active_support/values/time_zone.rb', line 174

def name
  @name
end

- (Object) tzinfo (readonly)

Returns the value of attribute tzinfo



175
176
177
# File 'activesupport/lib/active_support/values/time_zone.rb', line 175

def tzinfo
  @tzinfo
end

Class Method Details

+ (Object) [](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.



387
388
389
390
391
392
393
394
395
396
397
# File 'activesupport/lib/active_support/values/time_zone.rb', line 387

def [](arg)
  case arg
    when String
      zones_map[arg] ||= lookup(arg)
    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

+ (Object) 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.



317
318
319
# File 'activesupport/lib/active_support/values/time_zone.rb', line 317

def all
  @zones ||= zones_map.values.sort
end

+ (Object) create



305
# File 'activesupport/lib/active_support/values/time_zone.rb', line 305

alias_method :create, :new

+ (Object) find_tzinfo(name)

TODO: Preload instead of lazy load for thread safety



297
298
299
300
301
302
# File 'activesupport/lib/active_support/values/time_zone.rb', line 297

def self.find_tzinfo(name)
  require 'tzinfo' unless defined?(TZInfo)
  ::TZInfo::Timezone.get(MAPPING[name] || name)
rescue TZInfo::InvalidTimezoneIdentifier
  nil
end

+ (Object) 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.)



310
311
312
# File 'activesupport/lib/active_support/values/time_zone.rb', line 310

def new(name)
  self[name]
end

+ (Object) us_zones

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



401
402
403
# File 'activesupport/lib/active_support/values/time_zone.rb', line 401

def us_zones
  @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ }
end

+ (Object) zones_map



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'activesupport/lib/active_support/values/time_zone.rb', line 321

def zones_map
  unless defined?(@zones_map)
    @zones_map = {}
    [[-39_600, "International Date Line West", "Midway Island", "Samoa" ],
     [-36_000, "Hawaii" ],
     [-32_400, "Alaska" ],
     [-28_800, "Pacific Time (US & Canada)", "Tijuana" ],
     [-25_200, "Mountain Time (US & Canada)", "Chihuahua", "Mazatlan",
               "Arizona" ],
     [-21_600, "Central Time (US & Canada)", "Saskatchewan", "Guadalajara",
               "Mexico City", "Monterrey", "Central America" ],
     [-18_000, "Eastern Time (US & Canada)", "Indiana (East)", "Bogota",
               "Lima", "Quito" ],
     [-16_200, "Caracas" ],
     [-14_400, "Atlantic Time (Canada)", "La Paz", "Santiago" ],
     [-12_600, "Newfoundland" ],
     [-10_800, "Brasilia", "Buenos Aires", "Georgetown", "Greenland" ],
     [ -7_200, "Mid-Atlantic" ],
     [ -3_600, "Azores", "Cape Verde Is." ],
     [      0, "Dublin", "Edinburgh", "Lisbon", "London", "Casablanca",
               "Monrovia", "UTC" ],
     [  3_600, "Belgrade", "Bratislava", "Budapest", "Ljubljana", "Prague",
               "Sarajevo", "Skopje", "Warsaw", "Zagreb", "Brussels",
               "Copenhagen", "Madrid", "Paris", "Amsterdam", "Berlin",
               "Bern", "Rome", "Stockholm", "Vienna",
               "West Central Africa" ],
     [  7_200, "Bucharest", "Cairo", "Helsinki", "Kyev", "Riga", "Sofia",
               "Tallinn", "Vilnius", "Athens", "Istanbul", "Minsk",
               "Jerusalem", "Harare", "Pretoria" ],
     [ 10_800, "Moscow", "St. Petersburg", "Volgograd", "Kuwait", "Riyadh",
               "Nairobi", "Baghdad" ],
     [ 12_600, "Tehran" ],
     [ 14_400, "Abu Dhabi", "Muscat", "Baku", "Tbilisi", "Yerevan" ],
     [ 16_200, "Kabul" ],
     [ 18_000, "Ekaterinburg", "Islamabad", "Karachi", "Tashkent" ],
     [ 19_800, "Chennai", "Kolkata", "Mumbai", "New Delhi", "Sri Jayawardenepura" ],
     [ 20_700, "Kathmandu" ],
     [ 21_600, "Astana", "Dhaka", "Almaty",
               "Novosibirsk" ],
     [ 23_400, "Rangoon" ],
     [ 25_200, "Bangkok", "Hanoi", "Jakarta", "Krasnoyarsk" ],
     [ 28_800, "Beijing", "Chongqing", "Hong Kong", "Urumqi",
               "Kuala Lumpur", "Singapore", "Taipei", "Perth", "Irkutsk",
               "Ulaan Bataar" ],
     [ 32_400, "Seoul", "Osaka", "Sapporo", "Tokyo", "Yakutsk" ],
     [ 34_200, "Darwin", "Adelaide" ],
     [ 36_000, "Canberra", "Melbourne", "Sydney", "Brisbane", "Hobart",
               "Vladivostok", "Guam", "Port Moresby" ],
     [ 39_600, "Magadan", "Solomon Is.", "New Caledonia" ],
     [ 43_200, "Fiji", "Kamchatka", "Marshall Is.", "Auckland",
               "Wellington" ],
     [ 46_800, "Nuku'alofa" ]].
     each do |offset, *places|
       places.each do |place|
         @zones_map[place] = create(place, offset)
       end
     end
  end
  @zones_map
end

Instance Method Details

- (Object) <=>(zone)

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



205
206
207
208
209
# File 'activesupport/lib/active_support/values/time_zone.rb', line 205

def <=>(zone)
  result = (utc_offset <=> zone.utc_offset)
  result = (name <=> zone.name) if result == 0
  result
end

- (Object) =~(re)

Compare #name and TZInfo identifier to a supplied regexp, returning true if a match is found.



213
214
215
# File 'activesupport/lib/active_support/values/time_zone.rb', line 213

def =~(re)
  return true if name =~ re || MAPPING[name] =~ re
end

- (Object) 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


236
237
238
239
# File 'activesupport/lib/active_support/values/time_zone.rb', line 236

def at(secs)
  utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs)
  utc.in_time_zone(self)
end

- (Object) formatted_offset(colon = true, alternate_utc_string = nil)

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



199
200
201
# File 'activesupport/lib/active_support/values/time_zone.rb', line 199

def formatted_offset(colon=true, alternate_utc_string = nil)
  utc_offset == 0 && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
end

- (Object) 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


226
227
228
229
# File 'activesupport/lib/active_support/values/time_zone.rb', line 226

def local(*args)
  time = Time.utc_time(*args)
  ActiveSupport::TimeWithZone.new(nil, self, time)
end

- (Object) local_to_utc(time, dst = true)

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



282
283
284
# File 'activesupport/lib/active_support/values/time_zone.rb', line 282

def local_to_utc(time, dst=true)
  tzinfo.local_to_utc(time, dst)
end

- (Object) 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


266
267
268
# File 'activesupport/lib/active_support/values/time_zone.rb', line 266

def now
  Time.now.utc.in_time_zone(self)
end

- (Object) 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


250
251
252
253
254
255
256
257
258
259
# File 'activesupport/lib/active_support/values/time_zone.rb', line 250

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

- (Object) period_for_local(time, dst = true)

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



292
293
294
# File 'activesupport/lib/active_support/values/time_zone.rb', line 292

def period_for_local(time, dst=true)
  tzinfo.period_for_local(time, dst)
end

- (Object) period_for_utc(time)

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



287
288
289
# File 'activesupport/lib/active_support/values/time_zone.rb', line 287

def period_for_utc(time)
  tzinfo.period_for_utc(time)
end

- (Object) to_s

Returns a textual representation of this time zone.



218
219
220
# File 'activesupport/lib/active_support/values/time_zone.rb', line 218

def to_s
  "(GMT#{formatted_offset}) #{name}"
end

- (Object) today

Return the current date in this time zone.



271
272
273
# File 'activesupport/lib/active_support/values/time_zone.rb', line 271

def today
  tzinfo.now.to_date
end

- (Object) utc_offset



188
189
190
191
192
193
194
195
# File 'activesupport/lib/active_support/values/time_zone.rb', line 188

def utc_offset
  if @utc_offset
    @utc_offset
  else
    @current_period ||= tzinfo.current_period
    @current_period.utc_offset
  end
end

- (Object) 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.



277
278
279
# File 'activesupport/lib/active_support/values/time_zone.rb', line 277

def utc_to_local(time)
  tzinfo.utc_to_local(time)
end