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
- +
- -
- <=>
- acts_like_time?
- advance
- ago
- as_json
- between?
- dst?
- encode_with
- eql?
- formatted_offset
- freeze
- future?
- httpdate
- in_time_zone
- inspect
- is_a?
- localtime
- marshal_dump
- marshal_load
- method_missing
- name
- new
- past?
- period
- respond_to?
- rfc2822
- since
- strftime
- time
- to_a
- to_datetime
- to_f
- to_i
- to_s
- to_time
- to_yaml
- today?
- usec
- utc
- utc?
- utc_offset
- xmlschema
- zone
- Comparable
[R] | time_zone |
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 36 def self.name 'Time' # Report class name as 'Time' to thwart type checking end
[ show source ]
# File activesupport/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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 206 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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 217 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.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 182 def <=>(other) utc <=> other end
So that self acts_like?(:time).
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 290 def acts_like_time? true end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 244 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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 240 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"
[ show source ]
# File activesupport/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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 186 def between?(min, max) utc.between?(min, max) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 79 def dst? period.dst? end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 138 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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 202 def eql?(other) utc == other end
[ show source ]
# File activesupport/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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 300 def freeze period; utc; time # preload instance variables before freezing super end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 198 def future? utc.future? end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 152 def httpdate utc.httpdate end
Returns the simultaneous time in Time.zone, or the specified zone.
[ show source ]
# File activesupport/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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 104 def inspect "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}" end
Say we’re a Time to thwart type checking.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 295 def is_a?(klass) klass == ::Time || super end
Returns a Time.local() instance of the simultaneous time in your system’s ENV['TZ'] zone
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 74 def localtime utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 305 def marshal_dump [utc, time_zone.name, time] end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 309 def marshal_load(variables) initialize(variables[0].utc, ::Time.__send__(:get_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.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 321 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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 190 def past? utc.past? end
Returns the underlying TZInfo::TimezonePeriod.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 63 def period @period ||= time_zone.period_for_utc(@utc) end
Ensure proxy class responds to all methods that underlying time instance responds to.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 314 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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 156 def rfc2822 to_s(:rfc822) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 230 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
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 176 def strftime(format) format = format.gsub('%Z', zone).gsub('%z', formatted_offset(false)) time.strftime(format) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 49 def time @time ||= period.to_local(@utc) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 266 def to_a [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone] end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 285 def to_datetime utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 270 def to_f utc.to_f end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 274 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.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 163 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.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 281 def to_time self end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 146 def to_yaml(options = {}) return super if defined?(YAML::ENGINE) && !YAML::ENGINE.syck? utc.to_yaml(options) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 194 def today? time.today? end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 262 def usec time.respond_to?(:usec) ? time.usec : 0 end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 54 def utc @utc ||= period.to_utc(@time) end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 84 def utc? time_zone.name == 'UTC' end
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 89 def utc_offset period.utc_total_offset end
[ show source ]
# File activesupport/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
Time uses zone to display the time zone abbreviation, so we’re duck-typing it.
[ show source ]
# File activesupport/lib/active_support/time_with_zone.rb, line 100 def zone period.zone_identifier.to_s end