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
- #
- A
- B
- C
- D
- E
- F
- G
- H
- I
- K
- L
- M
- N
- P
- R
- S
- T
- U
-
- usec,
- utc,
- utc?,
- utc_offset
- X
- Z
- Comparable START:includes
| [R] | time_zone |
# File activesupport/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
# File activesupport/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
# File activesupport/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
Use the time in UTC for comparisons.
So that self acts_like?(:time).
# File activesupport/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
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 activesupport/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
Alias for utc
# File activesupport/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
Alias for utc
Alias for localtime
Alias for utc
Alias for utc?
Alias for utc_offset
Alias for utc
Alias for utc_offset
Returns the simultaneous time in Time.zone, or the specified zone.
Alias for dst?
Alias for xmlschema
Alias for is_a?
Returns a Time.local() instance of the simultaneous time in your system’s ENV['TZ'] zone
Send the missing method to time instance, and wrap result in a new TimeWithZone with the existing time_zone.
Returns the underlying TZInfo::TimezonePeriod.
Ensure proxy class responds to all methods that underlying time instance responds to.
# File activesupport/lib/active_support/time_with_zone.rb, line 321 321: def respond_to?(sym, include_priv = false) 322: # consistently respond false to acts_like?(:date), regardless of whether #time is a Time or DateTime 323: return false if sym.to_s == 'acts_like_date?' 324: super || time.respond_to?(sym, include_priv) 325: end
Alias for rfc2822
# File activesupport/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
Replaces %Z and %z directives with zone and formatted_offset, respectively, before passing to Time#strftime, so that zone information is correct
Alias for to_s
:db format outputs time in UTC; all others output time in local. Uses TimeWithZone’s strftime, so %Z and %z work correctly.
# File activesupport/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
A TimeWithZone acts like a Time, so just return self.
Alias for to_i
# File activesupport/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