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
[R] | time_zone |
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 38 def self.name 'Time' # Report class name as 'Time' to thwart type checking end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 45 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
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 209 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
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 220 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
Use the time in UTC for comparisons.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 185 def <=>(other) utc <=> other end
So that self
acts_like?(:time)
.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 293 def acts_like_time? true end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 247 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
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 243 def ago(other) since(-other) 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"
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 133 def as_json(options = nil) if ActiveSupport::JSON::Encoding.use_standard_json_time_format xmlschema else %Q(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}) end end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 189 def between?(min, max) utc.between?(min, max) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 81 def dst? period.dst? end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 141 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
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 205 def eql?(other) utc == other end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 97 def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 303 def freeze period; utc; time # preload instance variables before freezing super end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 201 def future? utc.future? end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 155 def httpdate utc.httpdate end
Returns the simultaneous time in Time.zone
, or the specified
zone.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 70 def in_time_zone(new_zone = ::Time.zone) return self if time_zone == new_zone utc.in_time_zone(new_zone) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 106 def inspect "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}" end
Say we’re a Time to thwart type checking.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 298 def is_a?(klass) klass == ::Time || super end
Returns a Time.local()
instance of the simultaneous time in
your system’s ENV['TZ']
zone
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 76 def localtime utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 308 def marshal_dump [utc, time_zone.name, time] end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 312 def marshal_load(variables) initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc) end
Send the missing method to time
instance, and wrap result in a
new TimeWithZone with the existing
time_zone
.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 324 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
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 193 def past? utc.past? end
Returns the underlying TZInfo::TimezonePeriod.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 65 def period @period ||= time_zone.period_for_utc(@utc) end
Ensure proxy class responds to all methods that underlying time instance responds to.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 317 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
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 159 def rfc2822 to_s(:rfc822) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 233 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
Replaces %Z
and %z
directives with
zone
and formatted_offset
, respectively, before
passing to Time#strftime, so that zone information is correct
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 179 def strftime(format) format = format.gsub('%Z', zone).gsub('%z', formatted_offset(false)) time.strftime(format) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 51 def time @time ||= period.to_local(@utc) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 269 def to_a [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone] end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 288 def to_datetime utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 273 def to_f utc.to_f end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 277 def to_i utc.to_i end
:db
format outputs time in UTC; all others output time in
local. Uses TimeWithZone’s strftime
, so %Z
and
%z
work correctly.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 166 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
A TimeWithZone acts like a Time, so just return self
.
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 284 def to_time utc end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 149 def to_yaml(options = {}) return super if defined?(YAML::ENGINE) && !YAML::ENGINE.syck? utc.to_yaml(options) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 197 def today? time.today? end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 265 def usec time.respond_to?(:usec) ? time.usec : 0 end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 56 def utc @utc ||= period.to_utc(@time) end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 86 def utc? time_zone.name == 'UTC' end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 91 def utc_offset period.utc_total_offset end
Source: show
# File activesupport/lib/active_support/time_with_zone.rb, line 110 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