Class: ActiveSupport::TimeWithZone

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
activesupport/lib/active_support/time_with_zone.rb

Overview

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-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 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

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (TimeWithZone) initialize(utc_time, time_zone, local_time = nil, period = nil)

A new instance of TimeWithZone



44
45
46
47
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 44

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(sym, *args, &block)

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



323
324
325
326
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 323

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

Instance Attribute Details

- (Object) time_zone (readonly)

Returns the value of attribute time_zone



42
43
44
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 42

def time_zone
  @time_zone
end

Class Method Details

+ (Object) name 



37
38
39
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 37

def self.name
  'Time' # Report class name as 'Time' to thwart type checking
end

Instance Method Details

- (Object) +(other) 



208
209
210
211
212
213
214
215
216
217
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 208

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

- (Object) -(other) 



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 219

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

- (Object) <=>(other)

Use the time in UTC for comparisons.



184
185
186
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 184

def <=>(other)
  utc <=> other
end

- (Boolean) acts_like_time?

So that self acts_like?(:time).

Returns:

  • (Boolean) 


292
293
294
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 292

def acts_like_time?
  true
end

- (Object) advance(options) 



246
247
248
249
250
251
252
253
254
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 246

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

- (Object) ago(other) 



242
243
244
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 242

def ago(other)
  since(-other)
end

- (Object) as_json(options = nil)

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"


132
133
134
135
136
137
138
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 132

def as_json(options = nil)
  if ActiveSupport::JSON::Encoding.use_standard_json_time_format
    xmlschema
  else
    %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
  end
end

- (Boolean) between?(min, max)

Returns:

  • (Boolean) 


188
189
190
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 188

def between?(min, max)
  utc.between?(min, max)
end

- (Boolean) dst? Also known as: isdst

Returns:

  • (Boolean) 


80
81
82
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 80

def dst?
  period.dst?
end

- (Object) encode_with(coder) 



140
141
142
143
144
145
146
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 140

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

- (Boolean) eql?(other)

Returns:

  • (Boolean) 


204
205
206
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 204

def eql?(other)
  utc == other
end

- (Object) formatted_offset(colon = true, alternate_utc_string = nil) 



96
97
98
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 96

def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

- (Object) freeze 



302
303
304
305
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 302

def freeze
  period; utc; time # preload instance variables before freezing
  super
end

- (Boolean) future?

Returns:

  • (Boolean) 


200
201
202
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 200

def future?
  utc.future?
end

- (Object) httpdate 



154
155
156
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 154

def httpdate
  utc.httpdate
end

- (Object) in_time_zone(new_zone = ::Time.zone)

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



69
70
71
72
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 69

def in_time_zone(new_zone = ::Time.zone)
  return self if time_zone == new_zone
  utc.in_time_zone(new_zone)
end

- (Object) inspect 



105
106
107
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 105

def inspect
  "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}"
end

- (Boolean) is_a?(klass) Also known as: kind_of?

Say we're a Time to thwart type checking.

Returns:

  • (Boolean) 


297
298
299
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 297

def is_a?(klass)
  klass == ::Time || super
end

- (Object) localtime Also known as: getlocal

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



75
76
77
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 75

def localtime
  utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal
end

- (Object) marshal_dump 



307
308
309
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 307

def marshal_dump
  [utc, time_zone.name, time]
end

- (Object) marshal_load(variables) 



311
312
313
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 311

def marshal_load(variables)
  initialize(variables[0].utc, ::Time.__send__(:get_zone, variables[1]), variables[2].utc)
end

- (Boolean) past?

Returns:

  • (Boolean) 


192
193
194
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 192

def past?
  utc.past?
end

- (Object) period

Returns the underlying TZInfo::TimezonePeriod.



64
65
66
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 64

def period
  @period ||= time_zone.period_for_utc(@utc)
end

- (Boolean) respond_to?(sym, include_priv = false)

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

Returns:

  • (Boolean) 


316
317
318
319
320
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 316

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

- (Object) rfc2822 Also known as: rfc822 



158
159
160
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 158

def rfc2822
  to_s(:rfc822)
end

- (Object) since(other) 



232
233
234
235
236
237
238
239
240
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 232

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

- (Object) strftime(format)

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



178
179
180
181
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 178

def strftime(format)
  format = format.gsub('%Z', zone).gsub('%z', formatted_offset(false))
  time.strftime(format)
end

- (Object) time

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



50
51
52
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 50

def time
  @time ||= period.to_local(@utc)
end

- (Object) to_a 



268
269
270
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 268

def to_a
  [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone]
end

- (Object) to_datetime 



287
288
289
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 287

def to_datetime
  utc.to_datetime.new_offset(Rational(utc_offset, 86_400))
end

- (Object) to_f 



272
273
274
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 272

def to_f
  utc.to_f
end

- (Object) to_i Also known as: hash, tv_sec 



276
277
278
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 276

def to_i
  utc.to_i
end

- (Object) to_s(format = :default) Also known as: to_formatted_s

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



165
166
167
168
169
170
171
172
173
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 165

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

- (Object) to_time

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



283
284
285
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 283

def to_time
  self
end

- (Object) to_yaml(options = {}) 



148
149
150
151
152
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 148

def to_yaml(options = {})
  return super if defined?(YAML::ENGINE) && !YAML::ENGINE.syck?

  utc.to_yaml(options)
end

- (Boolean) today?

Returns:

  • (Boolean) 


196
197
198
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 196

def today?
  time.today?
end

- (Object) usec 



264
265
266
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 264

def usec
  time.respond_to?(:usec) ? time.usec : 0
end

- (Object) utc Also known as: comparable_time, getgm, getutc, gmtime

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



55
56
57
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 55

def utc
  @utc ||= period.to_utc(@time)
end

- (Boolean) utc? Also known as: gmt?

Returns:

  • (Boolean) 


85
86
87
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 85

def utc?
  time_zone.name == 'UTC'
end

- (Object) utc_offset Also known as: gmt_offset, gmtoff 



90
91
92
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 90

def utc_offset
  period.utc_total_offset
end

- (Object) xmlschema(fraction_digits = 0) Also known as: iso8601 



109
110
111
112
113
114
115
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 109

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

- (Object) zone

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



101
102
103
 
# File 'activesupport/lib/active_support/time_with_zone.rb', line 101

def zone
  period.zone_identifier.to_s
end