class ActiveSupport::TimeWithZone

Parent:
Object
Included modules:
DateAndTime::Compatibility

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
# File activesupport/lib/active_support/time_with_zone.rb, line 40
def self.name
  'Time'
end

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

new(utc_time, time_zone, local_time = nil, period = nil) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 47
def initialize(utc_time, time_zone, local_time = nil, period = nil)
  @utc = utc_time ? transfer_time_values_to_utc_constructor(utc_time) : nil
  @time_zone, @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 251
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 262
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)
    to_time - other.to_time
  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
# File activesupport/lib/active_support/time_with_zone.rb, line 217
def <=>(other)
  utc <=> other
end

Use the time in UTC for comparisons.

acts_like_time?() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 341
def acts_like_time?
  true
end

So that self acts_like?(:time).

advance(options) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 290
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 286
def ago(other)
  since(-other)
end
as_json(options = nil) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 156
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

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"
between?(min, max) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 223
def between?(min, max)
  utc.between?(min, max)
end

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

comparable_time()
Alias for: utc
dst?() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 90
def dst?
  period.dst?
end

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
Also aliased as: isdst
eql?(other) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 243
def eql?(other)
  other.eql?(utc)
end
formatted_offset(colon = true, alternate_utc_string = nil) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 121
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

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"
freeze() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 351
def freeze
  # preload instance variables before freezing
  period; utc; time; to_datetime; to_time
  super
end
Calls superclass method
future?() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 239
def future?
  utc.future?
end

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

getgm()
Alias for: utc
getlocal(utc_offset = nil)
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 247
def hash
  utc.hash
end
httpdate() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 180
def httpdate
  utc.httpdate
end

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"
in(other)
Alias for: since
in_time_zone(new_zone = ::Time.zone) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 73
def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

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

inspect() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 131
def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end
is_a?(klass) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 346
def is_a?(klass)
  klass == ::Time || super
end

Say we're a Time to thwart type checking.

Calls superclass method
Also aliased as: kind_of?
isdst()
Alias for: dst?
iso8601(fraction_digits = 0)
Alias for: xmlschema
kind_of?(klass)
Alias for: is_a?
localtime(utc_offset = nil) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 79
def localtime(utc_offset = nil)
  utc.getlocal(utc_offset)
end

Returns a Time instance of the simultaneous time in the system timezone.

Also aliased as: getlocal
marshal_dump() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 357
def marshal_dump
  [utc, time_zone.name, time]
end
marshal_load(variables) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 361
def marshal_load(variables)
  initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
end
method_missing(sym, *args, &block) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 382
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

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

past?() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 228
def past?
  utc.past?
end

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

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

Returns the underlying TZInfo::TimezonePeriod.

respond_to?(sym, include_priv = false) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 367
def respond_to?(sym, include_priv = false)
  # ensure that we're not going to throw and rescue from NoMethodError in method_missing which is slow
  return false if sym.to_sym == :to_str
  super
end

respond_to_missing? is not called in some cases, such as when type conversion is performed with Kernel#String

Calls superclass method
respond_to_missing?(sym, include_priv) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 375
def respond_to_missing?(sym, include_priv)
  return false if sym.to_sym == :acts_like_date?
  time.respond_to?(sym, include_priv)
end

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

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

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"
Also aliased as: rfc822
rfc822()
Alias for: rfc2822
since(other) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 275
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
Also aliased as: in
strftime(format) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 211
def strftime(format)
  format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}")
  getlocal(utc_offset).strftime(format)
end

Replaces %Z directive with +zone before passing to Time#strftime, so that zone information is correct.

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

Returns a Time instance that represents the time in time_zone.

to_a() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 308
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
  @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 312
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 316
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 321
def to_r
  utc.to_r
end
to_s(format = :default) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 198
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

Returns a string of the object's date and time. Accepts an optional format:

  • :default - default value, mimics Ruby 1.9 Time#to_s format.

  • :db - format outputs time in UTC :db time. See Time#to_formatted_s(:db).

  • Any key in Time::DATE_FORMATS can be used. See active_support/core_ext/time/conversions.rb.

Also aliased as: to_formatted_s
to_time() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 332
def to_time
  if preserve_timezone
    @to_time_with_instance_offset ||= getlocal(utc_offset)
  else
    @to_time_with_system_offset ||= getlocal
  end
end

Returns an instance of Time, either with the same UTC offset as self or in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.

today?() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 234
def today?
  time.today?
end

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

tv_sec()
Alias for: to_i
utc() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 59
def utc
  @utc ||= period.to_utc(@time)
end

Returns a Time instance of the simultaneous time in the UTC timezone.

Also aliased as: comparable_time, getgm, getutc, gmtime
utc?() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 101
def utc?
  time_zone.name == 'UTC'
end

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
Also aliased as: gmt?
utc_offset() Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 107
def utc_offset
  period.utc_total_offset
end

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

Also aliased as: gmt_offset, gmtoff
xmlschema(fraction_digits = 0) Show source
# File activesupport/lib/active_support/time_with_zone.rb, line 135
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
# File activesupport/lib/active_support/time_with_zone.rb, line 127
def zone
  period.zone_identifier.to_s
end

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

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.