Class: ActiveSupport::TimeWithZone

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
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

#initialize(utc_time, time_zone, local_time = nil, period = nil) ⇒ TimeWithZone

Returns a new instance of TimeWithZone.


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

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

#method_missing(sym, *args, &block) ⇒ Object

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


315
316
317
318
# File 'lib/active_support/time_with_zone.rb', line 315

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

#time_zoneObject (readonly)

Returns the value of attribute time_zone


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

def time_zone
  @time_zone
end

Class Method Details

.nameObject


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

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

Instance Method Details

#+(other) ⇒ Object


200
201
202
203
204
205
206
207
208
209
# File 'lib/active_support/time_with_zone.rb', line 200

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) ⇒ Object


211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/active_support/time_with_zone.rb', line 211

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) ⇒ Object

Use the time in UTC for comparisons.


176
177
178
# File 'lib/active_support/time_with_zone.rb', line 176

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

#acts_like_time?Boolean

So that self acts_like?(:time).

Returns:

  • (Boolean)

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

def acts_like_time?
  true
end

#advance(options) ⇒ Object


238
239
240
241
242
243
244
245
246
# File 'lib/active_support/time_with_zone.rb', line 238

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) ⇒ Object


234
235
236
# File 'lib/active_support/time_with_zone.rb', line 234

def ago(other)
  since(-other)
end

#as_json(options = nil) ⇒ Object

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"


130
131
132
133
134
135
136
# File 'lib/active_support/time_with_zone.rb', line 130

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

#between?(min, max) ⇒ Boolean

Returns:

  • (Boolean)

180
181
182
# File 'lib/active_support/time_with_zone.rb', line 180

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

#dst?Boolean Also known as: isdst

Returns:

  • (Boolean)

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

def dst?
  period.dst?
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)

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

def eql?(other)
  utc == other
end

#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object


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

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

#freezeObject


294
295
296
297
# File 'lib/active_support/time_with_zone.rb', line 294

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

#future?Boolean

Returns:

  • (Boolean)

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

def future?
  utc.future?
end

#httpdateObject


146
147
148
# File 'lib/active_support/time_with_zone.rb', line 146

def httpdate
  utc.httpdate
end

#in_time_zone(new_zone = ::Time.zone) ⇒ Object

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


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

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

#inspectObject


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

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

#is_a?(klass) ⇒ Boolean Also known as: kind_of?

Say we're a Time to thwart type checking.

Returns:

  • (Boolean)

289
290
291
# File 'lib/active_support/time_with_zone.rb', line 289

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

#localtimeObject Also known as: getlocal

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


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

def localtime
  utc.getlocal
end

#marshal_dumpObject


299
300
301
# File 'lib/active_support/time_with_zone.rb', line 299

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

#marshal_load(variables) ⇒ Object


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

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

#past?Boolean

Returns:

  • (Boolean)

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

def past?
  utc.past?
end

#periodObject

Returns the underlying TZInfo::TimezonePeriod.


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

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

#respond_to?(sym, include_priv = false) ⇒ Boolean

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

Returns:

  • (Boolean)

308
309
310
311
312
# File 'lib/active_support/time_with_zone.rb', line 308

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

#rfc2822Object Also known as: rfc822


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

def rfc2822
  to_s(:rfc822)
end

#since(other) ⇒ Object


224
225
226
227
228
229
230
231
232
# File 'lib/active_support/time_with_zone.rb', line 224

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) ⇒ Object

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


170
171
172
173
# File 'lib/active_support/time_with_zone.rb', line 170

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

#timeObject

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


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

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

#to_aObject


260
261
262
# File 'lib/active_support/time_with_zone.rb', line 260

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

#to_datetimeObject


279
280
281
# File 'lib/active_support/time_with_zone.rb', line 279

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

#to_fObject


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

def to_f
  utc.to_f
end

#to_iObject Also known as: hash, tv_sec


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

def to_i
  utc.to_i
end

#to_s(format = :default) ⇒ Object 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.


157
158
159
160
161
162
163
164
165
# File 'lib/active_support/time_with_zone.rb', line 157

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

#to_timeObject

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


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

def to_time
  self
end

#to_yaml(options = {}) ⇒ Object


138
139
140
141
142
143
144
# File 'lib/active_support/time_with_zone.rb', line 138

def to_yaml(options = {})
  if options.kind_of?(YAML::Emitter)
    utc.to_yaml(options)
  else
    time.to_yaml(options).gsub('Z', formatted_offset(true, 'Z'))
  end
end

#today?Boolean

Returns:

  • (Boolean)

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

def today?
  time.today?
end

#usecObject


256
257
258
# File 'lib/active_support/time_with_zone.rb', line 256

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

#utcObject Also known as: comparable_time, getgm, getutc, gmtime

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


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

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

#utc?Boolean Also known as: gmt?

Returns:

  • (Boolean)

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

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

#utc_offsetObject Also known as: gmt_offset, gmtoff


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

def utc_offset
  period.utc_total_offset
end

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


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

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

#zoneObject

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


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

def zone
  period.zone_identifier.to_s
end