Parent

Included Modules

Class Index [+]

Quicksearch

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

Attributes

time_zone[R]

Public Class Methods

name() click to toggle source
    # File lib/active_support/time_with_zone.rb, line 38
38:     def self.name
39:       'Time' # Report class name as 'Time' to thwart type checking
40:     end
new(utc_time, time_zone, local_time = nil, period = nil) click to toggle source
    # File lib/active_support/time_with_zone.rb, line 45
45:     def initialize(utc_time, time_zone, local_time = nil, period = nil)
46:       @utc, @time_zone, @time = utc_time, time_zone, local_time
47:       @period = @utc ? period : get_period_and_ensure_valid_local_time
48:     end

Public Instance Methods

+(other) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 213
213:     def +(other)
214:       # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
215:       # otherwise move forward from #utc, for accuracy when moving across DST boundaries
216:       if duration_of_variable_length?(other)
217:         method_missing(:+, other)
218:       else
219:         result = utc.acts_like?(:date) ? utc.since(other) : utc + other rescue utc.since(other)
220:         result.in_time_zone(time_zone)
221:       end
222:     end
-(other) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 224
224:     def -(other)
225:       # If we're subtracting a Duration of variable length (i.e., years, months, days), move backwards from #time,
226:       # otherwise move backwards #utc, for accuracy when moving across DST boundaries
227:       if other.acts_like?(:time)
228:         utc.to_f - other.to_f
229:       elsif duration_of_variable_length?(other)
230:         method_missing(:-, other)
231:       else
232:         result = utc.acts_like?(:date) ? utc.ago(other) : utc - other rescue utc.ago(other)
233:         result.in_time_zone(time_zone)
234:       end
235:     end
<=>(other) click to toggle source

Use the time in UTC for comparisons.

     # File lib/active_support/time_with_zone.rb, line 185
185:     def <=>(other)
186:       utc <=> other
187:     end
acts_like_time?() click to toggle source

So that self acts_like?(:time).

     # File lib/active_support/time_with_zone.rb, line 296
296:     def acts_like_time?
297:       true
298:     end
advance(options) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 251
251:     def advance(options)
252:       # If we're advancing a value of variable length (i.e., years, weeks, months, days), advance from #time,
253:       # otherwise advance from #utc, for accuracy when moving across DST boundaries
254:       if options.values_at(:years, :weeks, :months, :days).any?
255:         method_missing(:advance, options)
256:       else
257:         utc.advance(options).in_time_zone(time_zone)
258:       end
259:     end
ago(other) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 247
247:     def ago(other)
248:       since(-other)
249:     end
as_json(options = nil) click to toggle 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.

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 lib/active_support/time_with_zone.rb, line 133
133:     def as_json(options = nil)
134:       if ActiveSupport::JSON::Encoding.use_standard_json_time_format
135:         xmlschema
136:       else
137:         %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
138:       end
139:     end
between?(min, max) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 189
189:     def between?(min, max)
190:       utc.between?(min, max)
191:     end
comparable_time() click to toggle source
Alias for: utc
dst?() click to toggle source
    # File lib/active_support/time_with_zone.rb, line 81
81:     def dst?
82:       period.dst?
83:     end
Also aliased as: isdst
encode_with(coder) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 141
141:     def encode_with(coder)
142:       if coder.respond_to?(:represent_object)
143:         coder.represent_object(nil, utc)
144:       else
145:         coder.represent_scalar(nil, utc.strftime("%Y-%m-%d %H:%M:%S.%9NZ"))
146:       end
147:     end
eql?(other) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 205
205:     def eql?(other)
206:       utc.eql?(other)
207:     end
formatted_offset(colon = true, alternate_utc_string = nil) click to toggle source
    # File lib/active_support/time_with_zone.rb, line 97
97:     def formatted_offset(colon = true, alternate_utc_string = nil)
98:       utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
99:     end
freeze() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 306
306:     def freeze
307:       period; utc; time # preload instance variables before freezing
308:       super
309:     end
future?() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 201
201:     def future?
202:       utc.future?
203:     end
getgm() click to toggle source
Alias for: utc
getlocal() click to toggle source
Alias for: localtime
getutc() click to toggle source
Alias for: utc
gmt?() click to toggle source
Alias for: utc?
gmt_offset() click to toggle source
Alias for: utc_offset
gmtime() click to toggle source
Alias for: utc
gmtoff() click to toggle source
Alias for: utc_offset
hash() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 209
209:     def hash
210:       utc.hash
211:     end
httpdate() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 155
155:     def httpdate
156:       utc.httpdate
157:     end
in_time_zone(new_zone = ::Time.zone) click to toggle source

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

    # File lib/active_support/time_with_zone.rb, line 70
70:     def in_time_zone(new_zone = ::Time.zone)
71:       return self if time_zone == new_zone
72:       utc.in_time_zone(new_zone)
73:     end
inspect() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 106
106:     def inspect
107:       "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
108:     end
is_a?(klass) click to toggle source

Say we’re a Time to thwart type checking.

     # File lib/active_support/time_with_zone.rb, line 301
301:     def is_a?(klass)
302:       klass == ::Time || super
303:     end
Also aliased as: kind_of?
isdst() click to toggle source
Alias for: dst?
iso8601(fraction_digits = 0) click to toggle source
Alias for: xmlschema
kind_of?(klass) click to toggle source
Alias for: is_a?
localtime() click to toggle source

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

    # File lib/active_support/time_with_zone.rb, line 76
76:     def localtime
77:       utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal
78:     end
Also aliased as: getlocal
marshal_dump() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 311
311:     def marshal_dump
312:       [utc, time_zone.name, time]
313:     end
marshal_load(variables) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 315
315:     def marshal_load(variables)
316:       initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc)
317:     end
method_missing(sym, *args, &block) click to toggle source

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

     # File lib/active_support/time_with_zone.rb, line 327
327:     def method_missing(sym, *args, &block)
328:       result = time.__send__(sym, *args, &block)
329:       result.acts_like?(:time) ? self.class.new(nil, time_zone, result) : result
330:     end
past?() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 193
193:     def past?
194:       utc.past?
195:     end
period() click to toggle source

Returns the underlying TZInfo::TimezonePeriod.

    # File lib/active_support/time_with_zone.rb, line 65
65:     def period
66:       @period ||= time_zone.period_for_utc(@utc)
67:     end
respond_to?(sym, include_priv = false) click to toggle source

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

     # File lib/active_support/time_with_zone.rb, line 320
320:     def respond_to?(sym, include_priv = false)
321:       # consistently respond false to acts_like?(:date), regardless of whether #time is a Time or DateTime
322:       return false if sym.to_s == 'acts_like_date?'
323:       super || time.respond_to?(sym, include_priv)
324:     end
rfc2822() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 159
159:     def rfc2822
160:       to_s(:rfc822)
161:     end
Also aliased as: rfc822
rfc822() click to toggle source
Alias for: rfc2822
since(other) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 237
237:     def since(other)
238:       # If we're adding a Duration of variable length (i.e., years, months, days), move forward from #time,
239:       # otherwise move forward from #utc, for accuracy when moving across DST boundaries
240:       if duration_of_variable_length?(other)
241:         method_missing(:since, other)
242:       else
243:         utc.since(other).in_time_zone(time_zone)
244:       end
245:     end
strftime(format) click to toggle source

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

     # File lib/active_support/time_with_zone.rb, line 179
179:     def strftime(format)
180:       format = format.gsub('%Z', zone).gsub('%z', formatted_offset(false))
181:       time.strftime(format)
182:     end
time() click to toggle source

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

    # File lib/active_support/time_with_zone.rb, line 51
51:     def time
52:       @time ||= period.to_local(@utc)
53:     end
to_a() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 273
273:     def to_a
274:       [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
275:     end
to_datetime() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 291
291:     def to_datetime
292:       utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
293:     end
to_f() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 277
277:     def to_f
278:       utc.to_f
279:     end
to_formatted_s(format = :default) click to toggle source
Alias for: to_s
to_i() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 281
281:     def to_i
282:       utc.to_i
283:     end
Also aliased as: tv_sec
to_s(format = :default) click to toggle source

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

     # File lib/active_support/time_with_zone.rb, line 166
166:     def to_s(format = :default)
167:       if format == :db
168:         utc.to_s(format)
169:       elsif formatter = ::Time::DATE_FORMATS[format]
170:         formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
171:       else
172:         "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby 1.9 Time#to_s format
173:       end
174:     end
Also aliased as: to_formatted_s
to_time() click to toggle source

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

     # File lib/active_support/time_with_zone.rb, line 287
287:     def to_time
288:       utc
289:     end
to_yaml(options = {}) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 149
149:     def to_yaml(options = {})
150:       return super if defined?(YAML::ENGINE) && !YAML::ENGINE.syck?
151: 
152:       utc.to_yaml(options)
153:     end
today?() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 197
197:     def today?
198:       time.today?
199:     end
tv_sec() click to toggle source
Alias for: to_i
usec() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 269
269:     def usec
270:       time.respond_to?(:usec) ? time.usec : 0
271:     end
utc() click to toggle source

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

    # File lib/active_support/time_with_zone.rb, line 56
56:     def utc
57:       @utc ||= period.to_utc(@time)
58:     end
Also aliased as: comparable_time, getgm, getutc, gmtime
utc?() click to toggle source
    # File lib/active_support/time_with_zone.rb, line 86
86:     def utc?
87:       time_zone.name == 'UTC'
88:     end
Also aliased as: gmt?
utc_offset() click to toggle source
    # File lib/active_support/time_with_zone.rb, line 91
91:     def utc_offset
92:       period.utc_total_offset
93:     end
Also aliased as: gmt_offset, gmtoff
xmlschema(fraction_digits = 0) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 110
110:     def xmlschema(fraction_digits = 0)
111:       fraction = if fraction_digits > 0
112:         (".%06i" % time.usec)[0, fraction_digits + 1]
113:       end
114: 
115:       "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}"
116:     end
Also aliased as: iso8601
zone() click to toggle source

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

     # File lib/active_support/time_with_zone.rb, line 102
102:     def zone
103:       period.zone_identifier.to_s
104:     end

Private Instance Methods

duration_of_variable_length?(obj) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 350
350:       def duration_of_variable_length?(obj)
351:         ActiveSupport::Duration === obj && obj.parts.any? {|p| p[0].in?([:years, :months, :days]) }
352:       end
get_period_and_ensure_valid_local_time() click to toggle source
     # File lib/active_support/time_with_zone.rb, line 333
333:       def get_period_and_ensure_valid_local_time
334:         # we don't want a Time.local instance enforcing its own DST rules as well,
335:         # so transfer time values to a utc constructor if necessary
336:         @time = transfer_time_values_to_utc_constructor(@time) unless @time.utc?
337:         begin
338:           @time_zone.period_for_local(@time)
339:         rescue ::TZInfo::PeriodNotFound
340:           # time is in the "spring forward" hour gap, so we're moving the time forward one hour and trying again
341:           @time += 1.hour
342:           retry
343:         end
344:       end
transfer_time_values_to_utc_constructor(time) click to toggle source
     # File lib/active_support/time_with_zone.rb, line 346
346:       def transfer_time_values_to_utc_constructor(time)
347:         ::Time.utc_time(time.year, time.month, time.day, time.hour, time.min, time.sec, time.respond_to?(:usec) ? time.usec : 0)
348:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.