Class: ActiveSupport::TimeZone
- Includes:
- Comparable
- Defined in:
- lib/active_support/values/time_zone.rb
Constant Summary collapse
- 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 }
- ZONES =
[]
- ZONES_MAP =
{}
- US_ZONES =
ZONES.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ }
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Returns the value of attribute name.
Class Method Summary collapse
-
.[](arg) ⇒ Object
Locate a specific time zone object.
-
.all ⇒ Object
Return an array of all TimeZone objects.
- .create ⇒ Object
-
.new(name) ⇒ Object
Return a TimeZone instance with the given name, or
nil
if no such TimeZone instance exists. -
.us_zones ⇒ Object
A convenience method for returning a collection of TimeZone objects for time zones in the USA.
Instance Method Summary collapse
-
#<=>(zone) ⇒ Object
Compare this time zone to the parameter.
-
#=~(re) ⇒ Object
Compare #name and TZInfo identifier to a supplied regexp, returning true if a match is found.
-
#at(secs) ⇒ Object
Method for creating new ActiveSupport::TimeWithZone instance in time zone of
self
from number of seconds since the Unix epoch. -
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
Returns the offset of this time zone as a formatted string, of the format “+HH:MM”.
-
#initialize(name, utc_offset, tzinfo = nil) ⇒ TimeZone
constructor
Create a new TimeZone object with the given name and offset.
-
#local(*args) ⇒ Object
Method for creating new ActiveSupport::TimeWithZone instance in time zone of
self
from given values. -
#local_to_utc(time, dst = true) ⇒ Object
Adjust the given time to the simultaneous time in UTC.
-
#now ⇒ Object
Returns an ActiveSupport::TimeWithZone instance representing the current time in the time zone represented by
self
. -
#parse(str, now = now) ⇒ Object
Method for creating new ActiveSupport::TimeWithZone instance in time zone of
self
from parsed string. -
#period_for_local(time, dst = true) ⇒ Object
Available so that TimeZone instances respond like TZInfo::Timezone instances.
-
#period_for_utc(time) ⇒ Object
Available so that TimeZone instances respond like TZInfo::Timezone instances.
-
#to_s ⇒ Object
Returns a textual representation of this time zone.
-
#today ⇒ Object
Return the current date in this time zone.
-
#tzinfo ⇒ Object
TODO: Preload instead of lazy load for thread safety.
- #utc_offset ⇒ Object
-
#utc_to_local(time) ⇒ Object
Adjust the given time to the simultaneous time in the time zone represented by
self
.
Constructor Details
#initialize(name, utc_offset, tzinfo = nil) ⇒ TimeZone
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).
180 181 182 183 184 |
# File 'lib/active_support/values/time_zone.rb', line 180 def initialize(name, utc_offset, tzinfo = nil) @name = name @utc_offset = utc_offset @tzinfo = tzinfo end |
Instance Attribute Details
#name ⇒ Object (readonly)
Returns the value of attribute name.
174 175 176 |
# File 'lib/active_support/values/time_zone.rb', line 174 def name @name end |
Class Method Details
.[](arg) ⇒ Object
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.
384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/active_support/values/time_zone.rb', line 384 def [](arg) case arg when String ZONES_MAP[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 |
.all ⇒ Object
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.
375 376 377 |
# File 'lib/active_support/values/time_zone.rb', line 375 def all ZONES end |
.create ⇒ Object
363 |
# File 'lib/active_support/values/time_zone.rb', line 363 alias_method :create, :new |
.new(name) ⇒ Object
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.)
368 369 370 |
# File 'lib/active_support/values/time_zone.rb', line 368 def new(name) self[name] end |
Instance Method Details
#<=>(zone) ⇒ Object
Compare this time zone to the parameter. The two are comapred first on their offsets, and then by name.
198 199 200 201 202 |
# File 'lib/active_support/values/time_zone.rb', line 198 def <=>(zone) result = (utc_offset <=> zone.utc_offset) result = (name <=> zone.name) if result == 0 result end |
#=~(re) ⇒ Object
Compare #name and TZInfo identifier to a supplied regexp, returning true if a match is found.
206 207 208 |
# File 'lib/active_support/values/time_zone.rb', line 206 def =~(re) return true if name =~ re || MAPPING[name] =~ re end |
#at(secs) ⇒ Object
229 230 231 232 |
# File 'lib/active_support/values/time_zone.rb', line 229 def at(secs) utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs) utc.in_time_zone(self) end |
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
Returns the offset of this time zone as a formatted string, of the format “+HH:MM”.
192 193 194 |
# File 'lib/active_support/values/time_zone.rb', line 192 def formatted_offset(colon=true, alternate_utc_string = nil) utc_offset == 0 && alternate_utc_string || utc_offset.to_utc_offset_s(colon) end |
#local(*args) ⇒ Object
219 220 221 222 |
# File 'lib/active_support/values/time_zone.rb', line 219 def local(*args) time = Time.utc_time(*args) ActiveSupport::TimeWithZone.new(nil, self, time) end |
#local_to_utc(time, dst = true) ⇒ Object
Adjust the given time to the simultaneous time in UTC. Returns a Time.utc() instance.
275 276 277 |
# File 'lib/active_support/values/time_zone.rb', line 275 def local_to_utc(time, dst=true) tzinfo.local_to_utc(time, dst) end |
#now ⇒ Object
259 260 261 |
# File 'lib/active_support/values/time_zone.rb', line 259 def now Time.now.utc.in_time_zone(self) end |
#parse(str, now = now) ⇒ Object
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
243 244 245 246 247 248 249 250 251 252 |
# File 'lib/active_support/values/time_zone.rb', line 243 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 |
#period_for_local(time, dst = true) ⇒ Object
Available so that TimeZone instances respond like TZInfo::Timezone instances
285 286 287 |
# File 'lib/active_support/values/time_zone.rb', line 285 def period_for_local(time, dst=true) tzinfo.period_for_local(time, dst) end |
#period_for_utc(time) ⇒ Object
Available so that TimeZone instances respond like TZInfo::Timezone instances
280 281 282 |
# File 'lib/active_support/values/time_zone.rb', line 280 def period_for_utc(time) tzinfo.period_for_utc(time) end |
#to_s ⇒ Object
Returns a textual representation of this time zone.
211 212 213 |
# File 'lib/active_support/values/time_zone.rb', line 211 def to_s "(GMT#{formatted_offset}) #{name}" end |
#today ⇒ Object
Return the current date in this time zone.
264 265 266 |
# File 'lib/active_support/values/time_zone.rb', line 264 def today tzinfo.now.to_date end |
#tzinfo ⇒ Object
TODO: Preload instead of lazy load for thread safety
290 291 292 |
# File 'lib/active_support/values/time_zone.rb', line 290 def tzinfo @tzinfo ||= TZInfo::Timezone.get(MAPPING[name]) end |
#utc_offset ⇒ Object
186 187 188 |
# File 'lib/active_support/values/time_zone.rb', line 186 def utc_offset @utc_offset ||= tzinfo.current_period.utc_offset end |
#utc_to_local(time) ⇒ Object
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.
270 271 272 |
# File 'lib/active_support/values/time_zone.rb', line 270 def utc_to_local(time) tzinfo.utc_to_local(time) end |