# class ActiveSupport::TimeZone

### Constants

MAPPING

  Keys are Rails TimeZone names, values are TZInfo identifiers

UTC_OFFSET_WITHOUT_COLON
UTC_OFFSET_WITH_COLON

### 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 349
    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() 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 331
    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

    # File lib/active_support/values/time_zone.rb, line 314
    def self.find_tzinfo(name)
      TZInfo::TimezoneProxy.new(MAPPING[name] || name)
    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 324
    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 197
    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

Also aliased as: create
seconds_to_utc_offset(seconds, colon = true) click to toggle source

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 lib/active_support/values/time_zone.rb, line 181
    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

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 367
    def us_zones
      @us_zones ||= all.find_all { |z| z.name =~ %rUS|Arizona|Indiana|Hawaii|Alaska/ }
    end

zones_map() click to toggle source

    # File lib/active_support/values/time_zone.rb, line 335
    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

### Protected Class Methods

require_tzinfo() click to toggle source

    # File lib/active_support/values/time_zone.rb, line 373
    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

### Public Instance Methods

<=>(zone) click to toggle source

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

    # File lib/active_support/values/time_zone.rb, line 223
    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 231
    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 254
    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 217
    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) 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 244
    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 300
    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 284
    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 #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 268
    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 310
    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 305
    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 236
    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 289
    def today
      tzinfo.now.to_date
    end

utc_offset() click to toggle source

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