Parent

Included Modules

Class/Module Index [+]

Quicksearch

ActiveSupport::TimeZone

Constants

MAPPING

Keys are Rails TimeZone names, values are TZInfo identifiers

Attributes

name[R]
tzinfo[R]

Public Class Methods

[](arg) click to toggle source

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.

# File lib/active_support/values/time_zone.rb, line 387
def [](arg)
  case arg
    when String
      if tz = zones_map[arg]
        tz
      elsif tz = lookup(arg)
        zones_map[arg] = tz
      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() click to toggle source

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 lib/active_support/values/time_zone.rb, line 317
def all
  @zones ||= zones_map.values.sort
end
create(name, utc_offset = nil, tzinfo = nil) click to toggle source
Alias for: new
find_tzinfo(name) click to toggle source

TODO: Preload instead of lazy load for thread safety

# File 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
new(name) click to toggle source

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

# File lib/active_support/values/time_zone.rb, line 310
def new(name)
  self[name]
end
new(name, utc_offset = nil, tzinfo = nil) click to toggle source

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

# File 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
Also aliased as: create
us_zones() click to toggle source

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

# File lib/active_support/values/time_zone.rb, line 405
def us_zones
  @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ }
end
zones_map() click to toggle source
# File 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

Public Instance Methods

<=>(zone) click to toggle source

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

# File 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
=~(re) click to toggle source

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

# File lib/active_support/values/time_zone.rb, line 213
def =~(re)
  return true if name =~ re || MAPPING[name] =~ re
end
at(secs) click to toggle source

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
# File 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
formatted_offset(colon=true, alternate_utc_string = nil) click to toggle source

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

# File 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
local(*args) click to toggle source

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
# File lib/active_support/values/time_zone.rb, line 226
def local(*args)
  time = Time.utc_time(*args)
  ActiveSupport::TimeWithZone.new(nil, self, time)
end
local_to_utc(time, dst=true) click to toggle source

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

# File lib/active_support/values/time_zone.rb, line 282
def local_to_utc(time, dst=true)
  tzinfo.local_to_utc(time, dst)
end
now() click to toggle source

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 lib/active_support/values/time_zone.rb, line 266
def now
  Time.now.utc.in_time_zone(self)
end
parse(str, now=now) click to toggle source

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
# File 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
period_for_local(time, dst=true) click to toggle source

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

# File lib/active_support/values/time_zone.rb, line 292
def period_for_local(time, dst=true)
  tzinfo.period_for_local(time, dst)
end
period_for_utc(time) click to toggle source

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

# File lib/active_support/values/time_zone.rb, line 287
def period_for_utc(time)
  tzinfo.period_for_utc(time)
end
to_s() click to toggle source

Returns a textual representation of this time zone.

# File lib/active_support/values/time_zone.rb, line 218
def to_s
  "(GMT#{formatted_offset}) #{name}"
end
today() click to toggle source

Return the current date in this time zone.

# File lib/active_support/values/time_zone.rb, line 271
def today
  tzinfo.now.to_date
end
utc_offset() click to toggle source
# File 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
utc_to_local(time) click to toggle source

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 lib/active_support/values/time_zone.rb, line 277
def utc_to_local(time)
  tzinfo.utc_to_local(time)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.