A Time-like class that can represent a time in any time zone. Necessary because standard Ruby Time instances are limited to UTC and the system's ENV['TZ']zone.

You shouldn't ever need to create a TimeWithZone instance directly via new– instead, Rails provides the methods local, parse, atand nowon TimeZone instances, and in_time_zoneon Time and DateTime instances, for a more user-friendly syntax. Examples:

Time.zone = 'Eastern Time (US & Canada)'        # => 'Eastern Time (US & Canada)'
Time.zone.local(2007, 2, 10, 15, 30, 45)        # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone.parse('2007-02-01 15:30:45')          # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone.at(1170361845)                        # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone.now                                   # => Sun, 18 May 2008 13:07:55 EDT -04:00
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone  # => Sat, 10 Feb 2007 15:30:45 EST -05:00

See TimeZone and ActiveSupport::CoreExtensions::Time::Zones for further documentation for these methods.

TimeWithZone instances implement the same API as Ruby Time instances, so that Time and TimeWithZone instances are interchangable. Examples:

t = Time.zone.now                     # => Sun, 18 May 2008 13:27:25 EDT -04:00
t.hour                                # => 13
t.dst?                                # => true
t.utc_offset                          # => -14400
t.zone                                # => "EDT"
t.to_s(:rfc822)                       # => "Sun, 18 May 2008 13:27:25 -0400"
t + 1.day                             # => Mon, 19 May 2008 13:27:25 EDT -04:00
t.beginning_of_year                   # => Tue, 01 Jan 2008 00:00:00 EST -05:00
t > Time.utc(1999)                    # => true
t.is_a?(Time)                         # => true
t.is_a?(ActiveSupport::TimeWithZone)  # => true
Methods
#
A
B
C
D
E
F
G
H
I
K
L
M
N
P
R
S
T
U
X
Z
Included Modules
Attributes
[R] time_zone
Class Public methods
new(utc_time, time_zone, local_time = nil, period = nil)
# File activesupport/lib/active_support/time_with_zone.rb, line 37
def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @utc, @time_zone, @time = utc_time, time_zone, local_time
  @period = @utc ? period : get_period_and_ensure_valid_local_time
end
Instance Public methods
+(other)
# File activesupport/lib/active_support/time_with_zone.rb, line 193
def +(other)
  # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
  # otherwise move forward from #utc, for accuracy when moving across DST boundaries
  if duration_of_variable_length?(other)
    method_missing(:+, other)
  else
    result = utc.acts_like?(:date) ? utc.since(other) : utc + other rescue utc.since(other)
    result.in_time_zone(time_zone)
  end
end
-(other)
# File activesupport/lib/active_support/time_with_zone.rb, line 204
def -(other)
  # If we're subtracting a Duration of variable length (i.e., years, months, days), move backwards from #time,
  # otherwise move backwards #utc, for accuracy when moving across DST boundaries
  if other.acts_like?(:time)
    utc.to_f - other.to_f
  elsif duration_of_variable_length?(other)
    method_missing(:-, other)
  else
    result = utc.acts_like?(:date) ? utc.ago(other) : utc - other rescue utc.ago(other)
    result.in_time_zone(time_zone)
  end
end
<=>(other)

Use the time in UTC for comparisons.

# File activesupport/lib/active_support/time_with_zone.rb, line 169
def <=>(other)
  utc <=> other
end
acts_like_time?()

So that self acts_like?(:time).

# File activesupport/lib/active_support/time_with_zone.rb, line 277
def acts_like_time?
  true
end
advance(options)
# File activesupport/lib/active_support/time_with_zone.rb, line 231
def advance(options)
  # If we're advancing a value of variable length (i.e., years, weeks, months, days), advance from #time,
  # otherwise advance from #utc, for accuracy when moving across DST boundaries
  if options.values_at(:years, :weeks, :months, :days).any?
    method_missing(:advance, options)
  else
    utc.advance(options).in_time_zone(time_zone)
  end
end
ago(other)
# File activesupport/lib/active_support/time_with_zone.rb, line 227
def ago(other)
  since(-other)
end
as_json(options = nil)

Coerces the date to a string for JSON encoding.

ISO 8601 format is used if ActiveSupport::JSON::Encoding.use_standard_json_time_format is set.

Examples

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
Time.utc(2005,2,1,15,15,10).in_time_zone.to_json
# => "2005-02-01T15:15:10Z"
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
Time.utc(2005,2,1,15,15,10).in_time_zone.to_json
# => "2005/02/01 15:15:10 +0000"
# File activesupport/lib/active_support/time_with_zone.rb, line 124
def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema
  else
    %Q(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end
between?(min, max)
# File activesupport/lib/active_support/time_with_zone.rb, line 173
def between?(min, max)
  utc.between?(min, max)
end
comparable_time()
dst?()
Also aliased as: isdst
# File activesupport/lib/active_support/time_with_zone.rb, line 73
def dst?
  period.dst?
end
eql?(other)
# File activesupport/lib/active_support/time_with_zone.rb, line 189
def eql?(other)
  utc == other
end
formatted_offset(colon = true, alternate_utc_string = nil)
# File activesupport/lib/active_support/time_with_zone.rb, line 89
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
end
freeze()
# File activesupport/lib/active_support/time_with_zone.rb, line 287
def freeze
  period; utc; time # preload instance variables before freezing
  super
end
future?()
# File activesupport/lib/active_support/time_with_zone.rb, line 185
def future?
  utc.future?
end
getgm()
getlocal()
getutc()
gmt?()
gmt_offset()
gmtime()
gmtoff()
hash()
httpdate()
# File activesupport/lib/active_support/time_with_zone.rb, line 140
def httpdate
  utc.httpdate
end
in_time_zone(new_zone = ::Time.zone)

Returns the simultaneous time in Time.zone, or the specified zone.

# File activesupport/lib/active_support/time_with_zone.rb, line 62
def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end
inspect()
# File activesupport/lib/active_support/time_with_zone.rb, line 98
def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end
is_a?(klass)

Say we're a Time to thwart type checking.

Also aliased as: kind_of?
# File activesupport/lib/active_support/time_with_zone.rb, line 282
def is_a?(klass)
  klass == ::Time || super
end
isdst()
iso8601(fraction_digits = 0)
kind_of?(klass)
localtime()

Returns a Time.local()instance of the simultaneous time in your system's ENV['TZ']zone

Also aliased as: getlocal
# File activesupport/lib/active_support/time_with_zone.rb, line 68
def localtime
  utc.getlocal
end
marshal_dump()
# File activesupport/lib/active_support/time_with_zone.rb, line 292
def marshal_dump
  [utc, time_zone.name, time]
end
marshal_load(variables)
# File activesupport/lib/active_support/time_with_zone.rb, line 296
def marshal_load(variables)
  initialize(variables[0].utc, ::Time.__send__(:get_zone, variables[1]), variables[2].utc)
end
method_missing(sym, *args, &block)

Send the missing method to timeinstance, and wrap result in a new TimeWithZone with the existing time_zone.

# File activesupport/lib/active_support/time_with_zone.rb, line 308
def method_missing(sym, *args, &block)
  result = time.__send__(sym, *args, &block)
  result.acts_like?(:time) ? self.class.new(nil, time_zone, result) : result
end
past?()
# File activesupport/lib/active_support/time_with_zone.rb, line 177
def past?
  utc.past?
end
period()

Returns the underlying TZInfo::TimezonePeriod.

# File activesupport/lib/active_support/time_with_zone.rb, line 57
def period
  @period ||= time_zone.period_for_utc(@utc)
end
respond_to?(sym, include_priv = false)

Ensure proxy class responds to all methods that underlying time instance responds to.

# File activesupport/lib/active_support/time_with_zone.rb, line 301
def respond_to?(sym, include_priv = false)
  # consistently respond false to acts_like?(:date), regardless of whether #time is a Time or DateTime
  return false if sym.to_s == 'acts_like_date?'
  super || time.respond_to?(sym, include_priv)
end
rfc2822()
Also aliased as: rfc822
# File activesupport/lib/active_support/time_with_zone.rb, line 144
def rfc2822
  to_s(:rfc822)
end
rfc822()
since(other)
# File activesupport/lib/active_support/time_with_zone.rb, line 217
def since(other)
  # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
  # otherwise move forward from #utc, for accuracy when moving across DST boundaries
  if duration_of_variable_length?(other)
    method_missing(:since, other)
  else
    utc.since(other).in_time_zone(time_zone)
  end
end
strftime(format)

Replaces %Zand %zdirectives with zoneand formatted_offset, respectively, before passing to Time#strftime, so that zone information is correct

# File activesupport/lib/active_support/time_with_zone.rb, line 163
def strftime(format)
  format = format.gsub('%Z', zone).gsub('%z', formatted_offset(false))
  time.strftime(format)
end
time()

Returns a Time or DateTime instance that represents the time in time_zone.

# File activesupport/lib/active_support/time_with_zone.rb, line 43
def time
  @time ||= period.to_local(@utc)
end
to_a()
# File activesupport/lib/active_support/time_with_zone.rb, line 253
def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end
to_datetime()
# File activesupport/lib/active_support/time_with_zone.rb, line 272
def to_datetime
  utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
end
to_f()
# File activesupport/lib/active_support/time_with_zone.rb, line 257
def to_f
  utc.to_f
end
to_formatted_s(format = :default)
to_i()
Also aliased as: hash, tv_sec
# File activesupport/lib/active_support/time_with_zone.rb, line 261
def to_i
  utc.to_i
end
to_s(format = :default)

:dbformat outputs time in UTC; all others output time in local. Uses TimeWithZone's strftime, so %Z and %zwork correctly.

Also aliased as: to_formatted_s
# File activesupport/lib/active_support/time_with_zone.rb, line 151
def to_s(format = :default)
  return utc.to_s(format) if format == :db
  if formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby 1.9 Time#to_s format
  end
end
to_time()

A TimeWithZone acts like a Time, so just return self.

# File activesupport/lib/active_support/time_with_zone.rb, line 268
def to_time
  self
end
to_yaml(options = {})
# File activesupport/lib/active_support/time_with_zone.rb, line 132
def to_yaml(options = {})
  if options.kind_of?(YAML::Emitter)
    utc.to_yaml(options)
  else
    time.to_yaml(options).gsub('Z', formatted_offset(true, 'Z'))
  end
end
today?()
# File activesupport/lib/active_support/time_with_zone.rb, line 181
def today?
  time.today?
end
tv_sec()
usec()
# File activesupport/lib/active_support/time_with_zone.rb, line 249
def usec
  time.respond_to?(:usec) ? time.usec : 0
end
utc()

Returns a Time or DateTime instance that represents the time in UTC.

Also aliased as: comparable_time, getgm, getutc, gmtime
# File activesupport/lib/active_support/time_with_zone.rb, line 48
def utc
  @utc ||= period.to_utc(@time)
end
utc?()
Also aliased as: gmt?
# File activesupport/lib/active_support/time_with_zone.rb, line 78
def utc?
  time_zone.name == 'UTC'
end
utc_offset()
Also aliased as: gmt_offset, gmtoff
# File activesupport/lib/active_support/time_with_zone.rb, line 83
def utc_offset
  period.utc_total_offset
end
xmlschema(fraction_digits = 0)
Also aliased as: iso8601
# File activesupport/lib/active_support/time_with_zone.rb, line 102
def xmlschema(fraction_digits = 0)
  fraction = if fraction_digits > 0
    ".%i" % time.usec.to_s[0, fraction_digits]
  end
  "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}"
end
zone()

Time uses zoneto display the time zone abbreviation, so we're duck-typing it.

# File activesupport/lib/active_support/time_with_zone.rb, line 94
def zone
  period.zone_identifier.to_s
end