- <=>
- []
- all
- at
- formatted_offset
- local
- local_to_utc
- new
- new
- now
- parse
- period_for_local
- period_for_utc
- to_s
- today
- tzinfo
- us_zones
- utc_offset
- utc_to_local
- 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/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" |
| Keys are Rails TimeZone names, values are TZInfo identifiers | ||
| ZONES | = | [] |
| ZONES_MAP | = | {} |
| US_ZONES | = | ZONES.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ } |
| [R] | name |
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 lib/active_support/values/time_zone.rb, line 377
377: def [](arg)
378: case arg
379: when String
380: ZONES_MAP[arg]
381: when Numeric, ActiveSupport::Duration
382: arg *= 3600 if arg.abs <= 13
383: all.find { |z| z.utc_offset == arg.to_i }
384: else
385: raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}"
386: end
387: 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 lib/active_support/values/time_zone.rb, line 368
368: def all
369: ZONES
370: 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 lib/active_support/values/time_zone.rb, line 180
180: def initialize(name, utc_offset, tzinfo = nil)
181: @name = name
182: @utc_offset = utc_offset
183: @tzinfo = tzinfo
184: 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 lib/active_support/values/time_zone.rb, line 361
361: def new(name)
362: self[name]
363: end
A convenience method for returning a collection of TimeZone objects for time zones in the USA.
[ show source ]
# File lib/active_support/values/time_zone.rb, line 391
391: def us_zones
392: US_ZONES
393: end
Compare this time zone to the parameter. The two are comapred first on their offsets, and then by name.
[ show source ]
# File lib/active_support/values/time_zone.rb, line 198
198: def <=>(zone)
199: result = (utc_offset <=> zone.utc_offset)
200: result = (name <=> zone.name) if result == 0
201: result
202: 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 lib/active_support/values/time_zone.rb, line 223
223: def at(secs)
224: utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs)
225: utc.in_time_zone(self)
226: end
Returns the offset of this time zone as a formatted string, of the format "+HH:MM".
[ show source ]
# File lib/active_support/values/time_zone.rb, line 192
192: def formatted_offset(colon=true, alternate_utc_string = nil)
193: utc_offset == 0 && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
194: 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 lib/active_support/values/time_zone.rb, line 213
213: def local(*args)
214: time = Time.utc_time(*args)
215: ActiveSupport::TimeWithZone.new(nil, self, time)
216: end
Adjust the given time to the simultaneous time in UTC. Returns a Time.utc() instance.
[ show source ]
# File lib/active_support/values/time_zone.rb, line 269
269: def local_to_utc(time, dst=true)
270: tzinfo.local_to_utc(time, dst)
271: 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 lib/active_support/values/time_zone.rb, line 253
253: def now
254: Time.now.utc.in_time_zone(self)
255: 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 lib/active_support/values/time_zone.rb, line 237
237: def parse(str, now=now)
238: date_parts = Date._parse(str)
239: return if date_parts.blank?
240: time = Time.parse(str, now) rescue DateTime.parse(str)
241: if date_parts[:offset].nil?
242: ActiveSupport::TimeWithZone.new(nil, self, time)
243: else
244: time.in_time_zone(self)
245: end
246: end
Available so that TimeZone instances respond like TZInfo::Timezone instances
[ show source ]
# File lib/active_support/values/time_zone.rb, line 279
279: def period_for_local(time, dst=true)
280: tzinfo.period_for_local(time, dst)
281: end
Available so that TimeZone instances respond like TZInfo::Timezone instances
[ show source ]
# File lib/active_support/values/time_zone.rb, line 274
274: def period_for_utc(time)
275: tzinfo.period_for_utc(time)
276: end
Returns a textual representation of this time zone.
[ show source ]
# File lib/active_support/values/time_zone.rb, line 205
205: def to_s
206: "(GMT#{formatted_offset}) #{name}"
207: end
Return the current date in this time zone.
[ show source ]
# File lib/active_support/values/time_zone.rb, line 258
258: def today
259: tzinfo.now.to_date
260: end
TODO: Preload instead of lazy load for thread safety
[ show source ]
# File lib/active_support/values/time_zone.rb, line 284
284: def tzinfo
285: @tzinfo ||= TZInfo::Timezone.get(MAPPING[name])
286: end
[ show source ]
# File lib/active_support/values/time_zone.rb, line 186
186: def utc_offset
187: @utc_offset ||= tzinfo.current_period.utc_offset
188: 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 lib/active_support/values/time_zone.rb, line 264
264: def utc_to_local(time)
265: tzinfo.utc_to_local(time)
266: end