Class: ActiveSupport::TimeWithZone

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, at and now on TimeZone instances, and in_time_zone on 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

Included Modules

Comparable

Attributes

[R]

time_zone

Public Class methods

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

[ show source ]

    # File activesupport/lib/active_support/time_with_zone.rb, line 37
37:     def initialize(utc_time, time_zone, local_time = nil, period = nil)
38:       @utc, @time_zone, @time = utc_time, time_zone, local_time
39:       @period = @utc ? period : get_period_and_ensure_valid_local_time
40:     end

Public Instance methods

+(other)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 193
193:     def +(other)
194:       # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
195:       # otherwise move forward from #utc, for accuracy when moving across DST boundaries
196:       if duration_of_variable_length?(other)
197:         method_missing(:+, other)
198:       else
199:         result = utc.acts_like?(:date) ? utc.since(other) : utc + other rescue utc.since(other)
200:         result.in_time_zone(time_zone)
201:       end
202:     end

-(other)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 204
204:     def -(other)
205:       # If we're subtracting a Duration of variable length (i.e., years, months, days), move backwards from #time,
206:       # otherwise move backwards #utc, for accuracy when moving across DST boundaries
207:       if other.acts_like?(:time)
208:         utc.to_f - other.to_f
209:       elsif duration_of_variable_length?(other)
210:         method_missing(:-, other)
211:       else
212:         result = utc.acts_like?(:date) ? utc.ago(other) : utc - other rescue utc.ago(other)
213:         result.in_time_zone(time_zone)
214:       end
215:     end

<=>(other)

Use the time in UTC for comparisons.

[ show source ]

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

acts_like_time?()

So that self acts_like?(:time).

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 278
278:     def acts_like_time?
279:       true
280:     end

advance(options)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 231
231:     def advance(options)
232:       # If we're advancing a value of variable length (i.e., years, weeks, months, days), advance from #time,
233:       # otherwise advance from #utc, for accuracy when moving across DST boundaries
234:       if options.values_at(:years, :weeks, :months, :days).any?
235:         method_missing(:advance, options)
236:       else
237:         utc.advance(options).in_time_zone(time_zone)
238:       end
239:     end

ago(other)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 227
227:     def ago(other)
228:       since(-other)
229:     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"

[ show source ]

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

between?(min, max)

[ show source ]

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

comparable_time()

Alias for utc

dst?()

This method is also aliased as isdst

[ show source ]

    # File activesupport/lib/active_support/time_with_zone.rb, line 73
73:     def dst?
74:       period.dst?
75:     end

eql?(other)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 189
189:     def eql?(other)
190:       utc == other
191:     end

formatted_offset(colon = true, alternate_utc_string = nil)

[ show source ]

    # File activesupport/lib/active_support/time_with_zone.rb, line 89
89:     def formatted_offset(colon = true, alternate_utc_string = nil)
90:       utc? && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
91:     end

freeze()

[ show source ]

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

future?()

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 185
185:     def future?
186:       utc.future?
187:     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()

Alias for to_i

httpdate()

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 140
140:     def httpdate
141:       utc.httpdate
142:     end

in_time_zone(new_zone = ::Time.zone)

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

[ show source ]

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

inspect()

[ show source ]

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

is_a?(klass)

Say we‘re a Time to thwart type checking.

This method is also aliased as kind_of?

[ show source ]

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

isdst()

Alias for dst?

iso8601(fraction_digits = 0)

Alias for xmlschema

kind_of?(klass)

Alias for is_a?

localtime()

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

This method is also aliased as getlocal

[ show source ]

    # File activesupport/lib/active_support/time_with_zone.rb, line 68
68:     def localtime
69:       utc.getlocal
70:     end

marshal_dump()

[ show source ]

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

marshal_load(variables)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 297
297:     def marshal_load(variables)
298:       initialize(variables[0].utc, ::Time.__send__(:get_zone, variables[1]), variables[2].utc)
299:     end

method_missing(sym, *args, &block)

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

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 309
309:     def method_missing(sym, *args, &block)
310:       result = time.__send__(sym, *args, &block)
311:       result.acts_like?(:time) ? self.class.new(nil, time_zone, result) : result
312:     end

past?()

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 177
177:     def past?
178:       utc.past?
179:     end

period()

Returns the underlying TZInfo::TimezonePeriod.

[ show source ]

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

respond_to?(sym, include_priv = false)

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

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 302
302:     def respond_to?(sym, include_priv = false)
303:       # consistently respond false to acts_like?(:date), regardless of whether #time is a Time or DateTime
304:       return false if sym.to_s == 'acts_like_date?'
305:       super || time.respond_to?(sym, include_priv)
306:     end

rfc2822()

This method is also aliased as rfc822

[ show source ]

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

rfc822()

Alias for rfc2822

since(other)

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 217
217:     def since(other)
218:       # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
219:       # otherwise move forward from #utc, for accuracy when moving across DST boundaries
220:       if duration_of_variable_length?(other)
221:         method_missing(:since, other)
222:       else
223:         utc.since(other).in_time_zone(time_zone)
224:       end
225:     end

strftime(format)

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

[ show source ]

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

time()

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

[ show source ]

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

to_a()

[ show source ]

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

to_datetime()

[ show source ]

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

to_f()

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 258
258:     def to_f
259:       utc.to_f
260:     end

to_formatted_s(format = :default)

Alias for to_s

to_i()

This method is also aliased as hash tv_sec

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 262
262:     def to_i
263:       utc.to_i
264:     end

to_s(format = :default)

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

This method is also aliased as to_formatted_s

[ show source ]

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

to_time()

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

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 269
269:     def to_time
270:       self
271:     end

to_yaml(options = {})

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 132
132:     def to_yaml(options = {})
133:       if options.kind_of?(YAML::Emitter)
134:         utc.to_yaml(options)
135:       else
136:         time.to_yaml(options).gsub('Z', formatted_offset(true, 'Z'))
137:       end
138:     end

today?()

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 181
181:     def today?
182:       time.today?
183:     end

tv_sec()

Alias for to_i

usec()

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 250
250:     def usec
251:       time.respond_to?(:usec) ? time.usec : 0
252:     end

utc()

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

This method is also aliased as comparable_time getgm getutc gmtime

[ show source ]

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

utc?()

This method is also aliased as gmt?

[ show source ]

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

utc_offset()

This method is also aliased as gmt_offset gmtoff

[ show source ]

    # File activesupport/lib/active_support/time_with_zone.rb, line 83
83:     def utc_offset
84:       period.utc_total_offset
85:     end

xmlschema(fraction_digits = 0)

This method is also aliased as iso8601

[ show source ]

     # File activesupport/lib/active_support/time_with_zone.rb, line 102
102:     def xmlschema(fraction_digits = 0)
103:       fraction = if fraction_digits > 0
104:         ".%i" % time.usec.to_s[0, fraction_digits]
105:       end
106: 
107:       "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}"
108:     end

zone()

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

[ show source ]

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