Methods
#
A
C
F
L
N
P
R
S
T
U
Z
Included Modules
Constants
MAPPING = { "International Date Line West" => "Pacific/Midway", "Midway Island" => "Pacific/Midway", "American 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/Guyana", "Greenland" => "America/Godthab", "Mid-Atlantic" => "Atlantic/South_Georgia", "Azores" => "Atlantic/Azores", "Cape Verde Is." => "Atlantic/Cape_Verde", "Dublin" => "Europe/Dublin", "Edinburgh" => "Europe/London", "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", "Kyiv" => "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/Kathmandu", "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", "Tokelau Is." => "Pacific/Fakaofo", "Samoa" => "Pacific/Apia" }.each { |name, zone| name.freeze; zone.freeze }
 

Keys are Rails TimeZone names, values are TZInfo identifiers

UTC_OFFSET_WITH_COLON = '%s%02d:%02d'
 
UTC_OFFSET_WITHOUT_COLON = UTC_OFFSET_WITH_COLON.sub(':', '')
 
Attributes
[R] name
[R] tzinfo
Class Public methods
create(name, utc_offset = nil, tzinfo = nil)
Alias for: new
find_tzinfo(name)
# File activesupport/lib/active_support/values/time_zone.rb, line 326
def self.find_tzinfo(name)
  TZInfo::TimezoneProxy.new(MAPPING[name] || name)
end
new(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).

Also aliased as: create
# File activesupport/lib/active_support/values/time_zone.rb, line 199
def initialize(name, utc_offset = nil, tzinfo = nil)
  self.class.send(:require_tzinfo)

  @name = name
  @utc_offset = utc_offset
  @tzinfo = tzinfo || TimeZone.find_tzinfo(name)
  @current_period = nil
end
seconds_to_utc_offset(seconds, colon = true)

Assumes self represents an offset from UTC in seconds (as returned from Time#utc_offset) and turns this into an +HH:MM formatted string. Example:

TimeZone.seconds_to_utc_offset(-21_600) # => "-06:00"
# File activesupport/lib/active_support/values/time_zone.rb, line 183
def self.seconds_to_utc_offset(seconds, colon = true)
  format = colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON
  sign = (seconds < 0 ? '-' : '+')
  hours = seconds.abs / 3600
  minutes = (seconds.abs % 3600) / 60
  format % [sign, hours, minutes]
end
Instance Public methods
<=>(zone)

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

# File activesupport/lib/active_support/values/time_zone.rb, line 225
def <=>(zone)
  result = (utc_offset <=> zone.utc_offset)
  result = (name <=> zone.name) if result == 0
  result
end
=~(re)

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

# File activesupport/lib/active_support/values/time_zone.rb, line 233
def =~(re)
  return true if name =~ re || MAPPING[name] =~ re
end
[](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 nilif no such time zone is known to the system.

# File activesupport/lib/active_support/values/time_zone.rb, line 361
def [](arg)
  case arg
    when String
    begin
      lazy_zones_map[arg] ||= lookup(arg).tap { |tz| tz.utc_offset }
    rescue TZInfo::InvalidTimezoneIdentifier
      nil
    end
    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()

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 activesupport/lib/active_support/values/time_zone.rb, line 343
def all
  @zones ||= zones_map.values.sort
end
at(secs)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of selffrom 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 activesupport/lib/active_support/values/time_zone.rb, line 256
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)

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

# File activesupport/lib/active_support/values/time_zone.rb, line 219
def formatted_offset(colon=true, alternate_utc_string = nil)
  utc_offset == 0 && alternate_utc_string || self.class.seconds_to_utc_offset(utc_offset, colon)
end
local(*args)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of selffrom 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 activesupport/lib/active_support/values/time_zone.rb, line 246
def local(*args)
  time = Time.utc_time(*args)
  ActiveSupport::TimeWithZone.new(nil, self, time)
end
local_to_utc(time, dst=true)

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

# File activesupport/lib/active_support/values/time_zone.rb, line 312
def local_to_utc(time, dst=true)
  tzinfo.local_to_utc(time, dst)
end
new(name)

Return a TimeZone instance with the given name, or nilif no such TimeZone instance exists. (This exists to support the use of this class with the composed_ofmacro.)

# File activesupport/lib/active_support/values/time_zone.rb, line 336
def new(name)
  self[name]
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 activesupport/lib/active_support/values/time_zone.rb, line 296
def now
  Time.now.utc.in_time_zone(self)
end
parse(str, now=now)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of selffrom 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 #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 activesupport/lib/active_support/values/time_zone.rb, line 270
def parse(str, now=now)
  parts = Date._parse(str, false)
  return if parts.empty?

  time = Time.utc(
    parts.fetch(:year, now.year),
    parts.fetch(:mon, now.month),
    parts.fetch(:mday, now.day),
    parts.fetch(:hour, 0),
    parts.fetch(:min, 0),
    parts.fetch(:sec, 0),
    parts.fetch(:sec_fraction, 0) * 1000000
  )

  if parts[:offset]
    TimeWithZone.new(time - parts[:offset], self)
  else
    TimeWithZone.new(nil, self, time)
  end
end
period_for_local(time, dst=true)

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

# File activesupport/lib/active_support/values/time_zone.rb, line 322
def period_for_local(time, dst=true)
  tzinfo.period_for_local(time, dst)
end
period_for_utc(time)

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

# File activesupport/lib/active_support/values/time_zone.rb, line 317
def period_for_utc(time)
  tzinfo.period_for_utc(time)
end
to_s()

Returns a textual representation of this time zone.

# File activesupport/lib/active_support/values/time_zone.rb, line 238
def to_s
  "(GMT#{formatted_offset}) #{name}"
end
today()

Return the current date in this time zone.

# File activesupport/lib/active_support/values/time_zone.rb, line 301
def today
  tzinfo.now.to_date
end
us_zones()

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

# File activesupport/lib/active_support/values/time_zone.rb, line 379
def us_zones
  @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ }
end
utc_offset()
# File activesupport/lib/active_support/values/time_zone.rb, line 208
def utc_offset
  if @utc_offset
    @utc_offset
  else
    @current_period ||= tzinfo.try(:current_period)
    @current_period.try(:utc_offset)
  end
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 activesupport/lib/active_support/values/time_zone.rb, line 307
def utc_to_local(time)
  tzinfo.utc_to_local(time)
end
zones_map()
# File activesupport/lib/active_support/values/time_zone.rb, line 347
def zones_map
  @zones_map ||= begin
    new_zones_names = MAPPING.keys - lazy_zones_map.keys
    new_zones       = Hash[new_zones_names.map { |place| [place, create(place)] }]

    lazy_zones_map.merge(new_zones)
  end
end
Instance Protected methods
require_tzinfo()
# File activesupport/lib/active_support/values/time_zone.rb, line 385
def require_tzinfo
  require 'tzinfo' unless defined?(::TZInfo)
rescue LoadError
  $stderr.puts "You don't have tzinfo installed in your application. Please add it to your Gemfile and run bundle install"
  raise
end