- <=>
- =~
- []
- all
- at
- find_tzinfo
- formatted_offset
- local
- local_to_utc
- new
- new
- now
- parse
- period_for_local
- period_for_utc
- to_s
- today
- us_zones
- utc_offset
- utc_to_local
- zones_map
- Comparable
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/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" |
Keys are Rails TimeZone names, values are TZInfo identifiers |
[R] | name | |
[R] | tzinfo |
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.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 387 387: def [](arg) 388: case arg 389: when String 390: zones_map[arg] ||= lookup(arg) 391: when Numeric, ActiveSupport::Duration 392: arg *= 3600 if arg.abs <= 13 393: all.find { |z| z.utc_offset == arg.to_i } 394: else 395: raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}" 396: end 397: end
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.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 317 317: def all 318: @zones ||= zones_map.values.sort 319: end
TODO: Preload instead of lazy load for thread safety
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 297 297: def self.find_tzinfo(name) 298: require 'tzinfo' unless defined?(TZInfo) 299: ::TZInfo::Timezone.get(MAPPING[name] || name) 300: rescue TZInfo::InvalidTimezoneIdentifier 301: nil 302: end
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.)
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 310 310: def new(name) 311: self[name] 312: end
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).
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 181 181: def initialize(name, utc_offset = nil, tzinfo = nil) 182: @name = name 183: @utc_offset = utc_offset 184: @tzinfo = tzinfo || TimeZone.find_tzinfo(name) 185: @current_period = nil 186: end
A convenience method for returning a collection of TimeZone objects for time zones in the USA.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 401 401: def us_zones 402: @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ } 403: end
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 321 321: def zones_map 322: unless defined?(@zones_map) 323: @zones_map = {} 324: [[-39_600, "International Date Line West", "Midway Island", "Samoa" ], 325: [-36_000, "Hawaii" ], 326: [-32_400, "Alaska" ], 327: [-28_800, "Pacific Time (US & Canada)", "Tijuana" ], 328: [-25_200, "Mountain Time (US & Canada)", "Chihuahua", "Mazatlan", 329: "Arizona" ], 330: [-21_600, "Central Time (US & Canada)", "Saskatchewan", "Guadalajara", 331: "Mexico City", "Monterrey", "Central America" ], 332: [-18_000, "Eastern Time (US & Canada)", "Indiana (East)", "Bogota", 333: "Lima", "Quito" ], 334: [-16_200, "Caracas" ], 335: [-14_400, "Atlantic Time (Canada)", "La Paz", "Santiago" ], 336: [-12_600, "Newfoundland" ], 337: [-10_800, "Brasilia", "Buenos Aires", "Georgetown", "Greenland" ], 338: [ -7_200, "Mid-Atlantic" ], 339: [ -3_600, "Azores", "Cape Verde Is." ], 340: [ 0, "Dublin", "Edinburgh", "Lisbon", "London", "Casablanca", 341: "Monrovia", "UTC" ], 342: [ 3_600, "Belgrade", "Bratislava", "Budapest", "Ljubljana", "Prague", 343: "Sarajevo", "Skopje", "Warsaw", "Zagreb", "Brussels", 344: "Copenhagen", "Madrid", "Paris", "Amsterdam", "Berlin", 345: "Bern", "Rome", "Stockholm", "Vienna", 346: "West Central Africa" ], 347: [ 7_200, "Bucharest", "Cairo", "Helsinki", "Kyev", "Riga", "Sofia", 348: "Tallinn", "Vilnius", "Athens", "Istanbul", "Minsk", 349: "Jerusalem", "Harare", "Pretoria" ], 350: [ 10_800, "Moscow", "St. Petersburg", "Volgograd", "Kuwait", "Riyadh", 351: "Nairobi", "Baghdad" ], 352: [ 12_600, "Tehran" ], 353: [ 14_400, "Abu Dhabi", "Muscat", "Baku", "Tbilisi", "Yerevan" ], 354: [ 16_200, "Kabul" ], 355: [ 18_000, "Ekaterinburg", "Islamabad", "Karachi", "Tashkent" ], 356: [ 19_800, "Chennai", "Kolkata", "Mumbai", "New Delhi", "Sri Jayawardenepura" ], 357: [ 20_700, "Kathmandu" ], 358: [ 21_600, "Astana", "Dhaka", "Almaty", 359: "Novosibirsk" ], 360: [ 23_400, "Rangoon" ], 361: [ 25_200, "Bangkok", "Hanoi", "Jakarta", "Krasnoyarsk" ], 362: [ 28_800, "Beijing", "Chongqing", "Hong Kong", "Urumqi", 363: "Kuala Lumpur", "Singapore", "Taipei", "Perth", "Irkutsk", 364: "Ulaan Bataar" ], 365: [ 32_400, "Seoul", "Osaka", "Sapporo", "Tokyo", "Yakutsk" ], 366: [ 34_200, "Darwin", "Adelaide" ], 367: [ 36_000, "Canberra", "Melbourne", "Sydney", "Brisbane", "Hobart", 368: "Vladivostok", "Guam", "Port Moresby" ], 369: [ 39_600, "Magadan", "Solomon Is.", "New Caledonia" ], 370: [ 43_200, "Fiji", "Kamchatka", "Marshall Is.", "Auckland", 371: "Wellington" ], 372: [ 46_800, "Nuku'alofa" ]]. 373: each do |offset, *places| 374: places.each do |place| 375: @zones_map[place] = create(place, offset) 376: end 377: end 378: end 379: @zones_map 380: end
Compare this time zone to the parameter. The two are comapred first on their offsets, and then by name.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 205 205: def <=>(zone) 206: result = (utc_offset <=> zone.utc_offset) 207: result = (name <=> zone.name) if result == 0 208: result 209: end
Compare name and TZInfo identifier to a supplied regexp, returning true if a match is found.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 213 213: def =~(re) 214: return true if name =~ re || MAPPING[name] =~ re 215: end
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
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 236 236: def at(secs) 237: utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs) 238: utc.in_time_zone(self) 239: end
Returns the offset of this time zone as a formatted string, of the format "+HH:MM".
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 199 199: def formatted_offset(colon=true, alternate_utc_string = nil) 200: utc_offset == 0 && alternate_utc_string || utc_offset.to_utc_offset_s(colon) 201: end
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
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 226 226: def local(*args) 227: time = Time.utc_time(*args) 228: ActiveSupport::TimeWithZone.new(nil, self, time) 229: end
Adjust the given time to the simultaneous time in UTC. Returns a Time.utc() instance.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 282 282: def local_to_utc(time, dst=true) 283: tzinfo.local_to_utc(time, dst) 284: end
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
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 266 266: def now 267: Time.now.utc.in_time_zone(self) 268: end
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
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 250 250: def parse(str, now=now) 251: date_parts = Date._parse(str) 252: return if date_parts.blank? 253: time = Time.parse(str, now) rescue DateTime.parse(str) 254: if date_parts[:offset].nil? 255: ActiveSupport::TimeWithZone.new(nil, self, time) 256: else 257: time.in_time_zone(self) 258: end 259: end
Available so that TimeZone instances respond like TZInfo::Timezone instances
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 292 292: def period_for_local(time, dst=true) 293: tzinfo.period_for_local(time, dst) 294: end
Available so that TimeZone instances respond like TZInfo::Timezone instances
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 287 287: def period_for_utc(time) 288: tzinfo.period_for_utc(time) 289: end
Returns a textual representation of this time zone.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 218 218: def to_s 219: "(GMT#{formatted_offset}) #{name}" 220: end
Return the current date in this time zone.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 271 271: def today 272: tzinfo.now.to_date 273: end
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 188 188: def utc_offset 189: if @utc_offset 190: @utc_offset 191: else 192: @current_period ||= tzinfo.current_period 193: @current_period.utc_offset 194: end 195: end
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.
[ show source ]
# File activesupport/lib/active_support/values/time_zone.rb, line 277 277: def utc_to_local(time) 278: tzinfo.utc_to_local(time) 279: end