class ActiveSupport::TimeWithZone

Parent:: Object
Included modules:

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 use methods local, parse, at and now on TimeZone instances, and in_time_zone on Time and DateTime instances.

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-10 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 Time and TimeZone for further documentation of these methods.

TimeWithZone instances implement the same API as Ruby Time instances, so that Time and TimeWithZone instances are interchangeable.

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

Attributes

time_zone[R]

Public Class Methods

name() Show source

Report class name as 'Time' to thwart type checking.

# File activesupport/lib/active_support/time_with_zone.rb, line 39
def self.name
  'Time'
end

new(utc_time, time_zone, local_time = nil, period = nil) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 46
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(period)
end

Public Instance Methods

+(other) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 247
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) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 258
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) Show source

Use the time in UTC for comparisons.

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

acts_like_time?() Show source

So that self acts_like?(:time).

# File activesupport/lib/active_support/time_with_zone.rb, line 330
def acts_like_time?
  true
end

advance(options) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 285
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) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 281
def ago(other)
  since(-other)
end

as_json(options = nil) Show source

Coerces time to a string for JSON encoding. The default format is ISO 8601. You can get %Y/%m/%d %H:%M:%S +offset style by setting ActiveSupport::JSON::Encoding.use_standard_json_time_format to false.

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").to_json
# => "2005-02-01T05:15:10.000-10:00"

# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").to_json
# => "2005/02/01 05:15:10 -1000"

# File activesupport/lib/active_support/time_with_zone.rb, line 155
def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema(ActiveSupport::JSON::Encoding.time_precision)
  else
    %Q(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

between?(min, max) Show source

Returns true if the current object's time is within the specified min and max time.

# File activesupport/lib/active_support/time_with_zone.rb, line 219
def between?(min, max)
  utc.between?(min, max)
end

comparable_time()

Alias for: utc

dst?() Show source

Returns true if the current time is within Daylight Savings Time for the specified time zone.

Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
Time.zone.parse("2012-5-30").dst?           # => true
Time.zone.parse("2012-11-30").dst?          # => false

# File activesupport/lib/active_support/time_with_zone.rb, line 89
def dst?
  period.dst?
end

Also aliased as: isdst

encode_with(coder) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 163
def encode_with(coder)
  if coder.respond_to?(:represent_object)
    coder.represent_object(nil, utc)
  else
    coder.represent_scalar(nil, utc.strftime("%Y-%m-%d %H:%M:%S.%9NZ"))
  end
end

eql?(other) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 239
def eql?(other)
  utc.eql?(other)
end

formatted_offset(colon = true, alternate_utc_string = nil) Show source

Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.

Time.zone = 'Eastern Time (US & Canada)'   # => "Eastern Time (US & Canada)"
Time.zone.now.formatted_offset(true)       # => "-05:00"
Time.zone.now.formatted_offset(false)      # => "-0500"
Time.zone = 'UTC'                          # => "UTC"
Time.zone.now.formatted_offset(true, "0")  # => "0"

# File activesupport/lib/active_support/time_with_zone.rb, line 120
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

freeze() Show source

Calls superclass method

# File activesupport/lib/active_support/time_with_zone.rb, line 340
def freeze
  period; utc; time # preload instance variables before freezing
  super
end

future?() Show source

Returns true if the current object's time is in the future.

# File activesupport/lib/active_support/time_with_zone.rb, line 235
def future?
  utc.future?
end

getgm()

Alias for: utc

getlocal()

Alias for: localtime

getutc()

Alias for: utc

gmt?()

Alias for: utc?

gmt_offset()

Alias for: utc_offset

gmtime()

Alias for: utc

gmtoff()

Alias for: utc_offset

hash() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 243
def hash
  utc.hash
end

httpdate() Show source

Returns a string of the object's date and time in the format used by HTTP requests.

Time.zone.now.httpdate  # => "Tue, 01 Jan 2013 04:39:43 GMT"

# File activesupport/lib/active_support/time_with_zone.rb, line 175
def httpdate
  utc.httpdate
end

in_time_zone(new_zone = ::Time.zone) Show source

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

# File activesupport/lib/active_support/time_with_zone.rb, line 71
def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

inspect() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 130
def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end

is_a?(klass) Show source

Say we're a Time to thwart type checking.

Calls superclass method

# File activesupport/lib/active_support/time_with_zone.rb, line 335
def is_a?(klass)
  klass == ::Time || super
end

Also aliased as: kind_of?

isdst()

Alias for: dst?

iso8601(fraction_digits = 0)

Alias for: xmlschema

kind_of?(klass)

Alias for: is_a?

localtime() Show source

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

# File activesupport/lib/active_support/time_with_zone.rb, line 78
def localtime
  utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal
end

Also aliased as: getlocal

marshal_dump() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 345
def marshal_dump
  [utc, time_zone.name, time]
end

marshal_load(variables) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 349
def marshal_load(variables)
  initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
end

method_missing(sym, *args, &block) Show source

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

# File activesupport/lib/active_support/time_with_zone.rb, line 363
def method_missing(sym, *args, &block)
  wrap_with_time_zone time.__send__(sym, *args, &block)
rescue NoMethodError => e
  raise e, e.message.sub(time.inspect, self.inspect), e.backtrace
end

past?() Show source

Returns true if the current object's time is in the past.

# File activesupport/lib/active_support/time_with_zone.rb, line 224
def past?
  utc.past?
end

period() Show source

Returns the underlying TZInfo::TimezonePeriod.

# File activesupport/lib/active_support/time_with_zone.rb, line 66
def period
  @period ||= time_zone.period_for_utc(@utc)
end

respond_to_missing?(sym, include_priv) Show source

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

# File activesupport/lib/active_support/time_with_zone.rb, line 355
def respond_to_missing?(sym, include_priv)
  # consistently respond false to acts_like?(:date), regardless of whether #time is a Time or DateTime
  return false if sym.to_sym == :acts_like_date?
  time.respond_to?(sym, include_priv)
end

rfc2822() Show source

Returns a string of the object's date and time in the RFC 2822 standard format.

Time.zone.now.rfc2822  # => "Tue, 01 Jan 2013 04:51:39 +0000"

# File activesupport/lib/active_support/time_with_zone.rb, line 183
def rfc2822
  to_s(:rfc822)
end

Also aliased as: rfc822

rfc822()

Alias for: rfc2822

since(other) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 271
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) Show source

Replaces %Z and %z directives with zone and formatted_offset, respectively, before passing to Time#strftime, so that zone information is correct

# File activesupport/lib/active_support/time_with_zone.rb, line 204
def strftime(format)
  format = format.gsub('%Z', zone)
                 .gsub('%z',   formatted_offset(false))
                 .gsub('%:z',  formatted_offset(true))
                 .gsub('%::z', formatted_offset(true) + ":00")
  time.strftime(format)
end

time() Show source

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

# File activesupport/lib/active_support/time_with_zone.rb, line 52
def time
  @time ||= period.to_local(@utc)
end

to_a() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 303
def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end

to_datetime() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 325
def to_datetime
  utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
end

to_f() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 307
def to_f
  utc.to_f
end

to_formatted_s(format = :default)

Alias for: to_s

to_i() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 311
def to_i
  utc.to_i
end

Also aliased as: tv_sec

to_r() Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 316
def to_r
  utc.to_r
end

to_s(format = :default) Show source

:db format outputs time in UTC; all others output time in local. Uses TimeWithZone's strftime, so %Z and %z work correctly.

# File activesupport/lib/active_support/time_with_zone.rb, line 190
def to_s(format = :default)
  if format == :db
    utc.to_s(format)
  elsif 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

Also aliased as: to_formatted_s

to_time() Show source

Return an instance of Time in the system timezone.

# File activesupport/lib/active_support/time_with_zone.rb, line 321
def to_time
  utc.to_time
end

today?() Show source

Returns true if the current object's time falls within the current day.

# File activesupport/lib/active_support/time_with_zone.rb, line 230
def today?
  time.today?
end

tv_sec()

Alias for: to_i

utc() Show source

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

# File activesupport/lib/active_support/time_with_zone.rb, line 57
def utc
  @utc ||= period.to_utc(@time)
end

Also aliased as: comparable_time, getgm, getutc, gmtime

utc?() Show source

Returns true if the current time zone is set to UTC.

Time.zone = 'UTC'                           # => 'UTC'
Time.zone.now.utc?                          # => true
Time.zone = 'Eastern Time (US & Canada)'    # => 'Eastern Time (US & Canada)'
Time.zone.now.utc?                          # => false

# File activesupport/lib/active_support/time_with_zone.rb, line 100
def utc?
  time_zone.name == 'UTC'
end

Also aliased as: gmt?

utc_offset() Show source

Returns the offset from current time to UTC time in seconds.

# File activesupport/lib/active_support/time_with_zone.rb, line 106
def utc_offset
  period.utc_total_offset
end

Also aliased as: gmt_offset, gmtoff

xmlschema(fraction_digits = 0) Show source

# File activesupport/lib/active_support/time_with_zone.rb, line 134
def xmlschema(fraction_digits = 0)
  fraction = if fraction_digits.to_i > 0
    (".%06i" % time.usec)[0, fraction_digits.to_i + 1]
  end

  "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}"
end

Also aliased as: iso8601

zone() Show source

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

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