ActiveSupport::TimeZone

Constants

MAPPING: Keys are Rails TimeZone names, values are TZInfo identifiers
UTC_OFFSET_WITH_COLON
UTC_OFFSET_WITHOUT_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 350
350:       def [](arg)
351:         case arg
352:           when String
353:           begin
354:             zones_map[arg] ||= lookup(arg).tap { |tz| tz.utc_offset }
355:           rescue TZInfo::InvalidTimezoneIdentifier
356:             nil
357:           end
358:           when Numeric, ActiveSupport::Duration
359:             arg *= 3600 if arg.abs <= 13
360:             all.find { |z| z.utc_offset == arg.to_i }
361:           else
362:             raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}"
363:         end
364:       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 337
337:       def all
338:         @zones ||= zones_map.values.sort
339:       end

create(name) 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 319
319:     def self.find_tzinfo(name)
320:       require 'active_support/tzinfo' unless defined?(::TZInfo)
321:       ::TZInfo::TimezoneProxy.new(MAPPING[name] || name)
322:     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 330
330:       def new(name)
331:         self[name]
332:       end

Also aliased as: create

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
197:     def initialize(name, utc_offset = nil, tzinfo = nil)
198:       begin
199:         require 'tzinfo'
200:       rescue LoadError => e
201:         $stderr.puts "You don't have tzinfo installed in your application. Please add it to your Gemfile and run bundle install"
202:         raise e
203:       end
204:       @name = name
205:       @utc_offset = utc_offset
206:       @tzinfo = tzinfo || TimeZone.find_tzinfo(name)
207:       @current_period = nil
208:     end

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
181:     def self.seconds_to_utc_offset(seconds, colon = true)
182:       format = colon ? UTC_OFFSET_WITH_COLON : UTC_OFFSET_WITHOUT_COLON
183:       sign = (seconds < 0 ? '-' : '+')
184:       hours = seconds.abs / 3600
185:       minutes = (seconds.abs % 3600) / 60
186:       format % [sign, hours, minutes]
187:     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 368
368:       def us_zones
369:         @us_zones ||= all.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ }
370:       end

zones_map() click to toggle source

     # File lib/active_support/values/time_zone.rb, line 341
341:       def zones_map
342:         @zones_map ||= Hash[MAPPING.map { |place, _| [place, create(place)] }]
343:       end

Private Class Methods

lookup(name) click to toggle source

     # File lib/active_support/values/time_zone.rb, line 374
374:         def lookup(name)
375:           (tzinfo = find_tzinfo(name)) && create(tzinfo.name.freeze)
376:         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 227
227:     def <=>(zone)
228:       result = (utc_offset <=> zone.utc_offset)
229:       result = (name <=> zone.name) if result == 0
230:       result
231:     end

=~(re) click to toggle source

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

     # File lib/active_support/values/time_zone.rb, line 235
235:     def =~(re)
236:       return true if name =~ re || MAPPING[name] =~ re
237:     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 258
258:     def at(secs)
259:       utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs)
260:       utc.in_time_zone(self)
261:     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 221
221:     def formatted_offset(colon=true, alternate_utc_string = nil)
222:       utc_offset == 0 && alternate_utc_string || self.class.seconds_to_utc_offset(utc_offset, colon)
223:     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 248
248:     def local(*args)
249:       time = Time.utc_time(*args)
250:       ActiveSupport::TimeWithZone.new(nil, self, time)
251:     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 304
304:     def local_to_utc(time, dst=true)
305:       tzinfo.local_to_utc(time, dst)
306:     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 288
288:     def now
289:       Time.now.utc.in_time_zone(self)
290:     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 272
272:     def parse(str, now=now)
273:       date_parts = Date._parse(str)
274:       return if date_parts.blank?
275:       time = Time.parse(str, now) rescue DateTime.parse(str)
276:       if date_parts[:offset].nil?
277:         ActiveSupport::TimeWithZone.new(nil, self, time)
278:       else
279:         time.in_time_zone(self)
280:       end
281:     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 314
314:     def period_for_local(time, dst=true)
315:       tzinfo.period_for_local(time, dst)
316:     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 309
309:     def period_for_utc(time)
310:       tzinfo.period_for_utc(time)
311:     end

to_s() click to toggle source

Returns a textual representation of this time zone.

     # File lib/active_support/values/time_zone.rb, line 240
240:     def to_s
241:       "(GMT#{formatted_offset}) #{name}"
242:     end

today() click to toggle source

Return the current date in this time zone.

     # File lib/active_support/values/time_zone.rb, line 293
293:     def today
294:       tzinfo.now.to_date
295:     end

utc_offset() click to toggle source

     # File lib/active_support/values/time_zone.rb, line 210
210:     def utc_offset
211:       if @utc_offset
212:         @utc_offset
213:       else
214:         @current_period ||= tzinfo.try(:current_period)
215:         @current_period.try(:utc_offset)
216:       end
217:     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 299
299:     def utc_to_local(time)
300:       tzinfo.utc_to_local(time)
301:     end

Home Classes Methods

In Files

Parent

Methods