class ActiveSupport::TimeWithZone
t.is_a?(ActiveSupport::TimeWithZone) # => true
t.is_a?(Time) # => true
t > Time.utc(1999) # => true
t.beginning_of_year # => Tue, 01 Jan 2008 00:00:00 EST -05:00
t + 1.day # => Mon, 19 May 2008 13:27:25 EDT -04:00
t.to_s(:rfc822) # => “Sun, 18 May 2008 13:27:25 -0400”
t.zone # => “EDT”
t.utc_offset # => -14400
t.dst? # => true
t.hour # => 13
t = Time.zone.now # => Sun, 18 May 2008 13:27:25 EDT -04:00
that Time and TimeWithZone instances are interchangeable.
TimeWithZone instances implement the same API as Ruby Time instances, so
See Time and TimeZone for further documentation of these methods.
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone.now # => Sun, 18 May 2008 13:07:55 EDT -04:00
Time.zone.at(1171139445) # => 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.local(2007, 2, 10, 15, 30, 45) # => Sat, 10 Feb 2007 15:30:45 EST -05:00
Time.zone = ‘Eastern Time (US & Canada)’ # => ‘Eastern Time (US & Canada)’
and in_time_zone on Time and DateTime instances.
Instead use methods local, parse, at and now on TimeZone instances,
You shouldn’t ever need to create a TimeWithZone instance directly via new.
system’s ENV['TZ'] zone.
because standard Ruby Time instances are limited to UTC and the
A Time-like class that can represent a time in any time zone. Necessary
def self.name
def self.name 'Time' end
def +(other)
now + 24.hours # => Mon, 03 Nov 2014 00:26:28 EST -05:00
time + 1.day will advance 23-25 hours, depending on the day.
For instance, a time + 24.hours will advance exactly 24 hours, while a
when moving across DST boundaries.
move forward from #time, otherwise move forward from #utc, for accuracy
If we're adding a Duration of variable length (i.e., years, months, days),
now + 1000 # => Sun, 02 Nov 2014 01:43:08 EDT -04:00
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
value as a new TimeWithZone object.
Adds an interval of time to the current object's time and returns that
def +(other) 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
def -(other)
now - 24.hours # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
time - 1.day will subtract 23-25 hours, depending on the day.
For instance, a time - 24.hours will go subtract exactly 24 hours, while a
when moving across DST boundaries.
move backward from #time, otherwise move backward from #utc, for accuracy
If subtracting a Duration of variable length (i.e., years, months, days),
now - 1000 # => Mon, 03 Nov 2014 00:09:48 EST -05:00
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28 EST -05:00
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
the current object's time and the +other+ time.
Returns a new TimeWithZone object that represents the difference between
def -(other) if other.acts_like?(:time) to_time - other.to_time 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
def <=>(other)
def <=>(other) utc <=> other end
def acts_like_time?
def acts_like_time? true end
def advance(options)
now.advance(months: 1) # => Tue, 02 Dec 2014 01:26:28 EST -05:00
now.advance(weeks: 1) # => Sun, 09 Nov 2014 01:26:28 EST -05:00
now.advance(days: 1) # => Mon, 03 Nov 2014 01:26:28 EST -05:00
now.advance(hours: 1) # => Sun, 02 Nov 2014 01:26:28 EST -05:00
now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28 EDT -04:00
now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29 EDT -04:00
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
accuracy when moving across DST boundaries.
days), move forward from #time, otherwise move forward from #utc, for
If advancing by a value of variable length (i.e., years, weeks, months,
:hours, :minutes, :seconds.
:years, :months, :weeks, :days,
The +options+ parameter takes a hash with any of these keys:
new TimeWithZone object.
according to the proleptic Gregorian calendar. The result is returned as a
Uses Date to provide precise Time calculations for years, months, and days
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
def ago(other)
now.ago(24.hours) # => Sun, 02 Nov 2014 01:26:28 EDT -04:00
the day.
while time.ago(1.day) will move back 23-25 hours, depending on
For instance, time.ago(24.hours) will move back exactly 24 hours,
accuracy when moving across DST boundaries.
days), move backward from #time, otherwise move backward from #utc, for
If we're subtracting a Duration of variable length (i.e., years, months,
now.ago(1000) # => Mon, 03 Nov 2014 00:09:48 EST -05:00
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28 EST -05:00
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
the result as a new TimeWithZone object.
Subtracts an interval of time from the current object's time and returns
def ago(other) since(-other) end
def as_json(options = nil)
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").to_json
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
# => "2005-02-01T05:15:10.000-10:00"
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").to_json
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
to +false+.
ActiveSupport::JSON::Encoding.use_standard_json_time_format
You can get %Y/%m/%d %H:%M:%S +offset style by setting
Coerces time to a string for JSON encoding. The default format is ISO 8601.
def as_json(options = nil) if ActiveSupport::JSON::Encoding.use_standard_json_time_format xmlschema(ActiveSupport::JSON::Encoding.time_precision) else %(#{time.strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)}) end end
def between?(min, max)
Returns true if the current object's time is within the specified
def between?(min, max) utc.between?(min, max) end
def blank?
def blank? false end
def dst?
Time.zone.parse("2012-5-30").dst? # => true
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
specified time zone.
Returns true if the current time is within Daylight Savings Time for the
def dst? period.dst? end
def duration_of_variable_length?(obj)
def duration_of_variable_length?(obj) ActiveSupport::Duration === obj && obj.parts.any? {|p| [:years, :months, :weeks, :days].include?(p[0]) } end
def encode_with(coder) #:nodoc:
def encode_with(coder) #:nodoc: coder.tag = '!ruby/object:ActiveSupport::TimeWithZone' coder.map = { 'utc' => utc, 'zone' => time_zone, 'time' => time } end
def eql?(other)
def eql?(other) other.eql?(utc) end
def formatted_offset(colon = true, alternate_utc_string = nil)
Time.zone = 'UTC' # => "UTC"
Time.zone.now.formatted_offset(false) # => "-0500"
Time.zone.now.formatted_offset(true) # => "-05:00"
Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)"
string if the time zone is already UTC.
Returns a formatted string of the offset from UTC, or an alternative
def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon) end
def freeze
def freeze # preload instance variables before freezing period; utc; time; to_datetime; to_time super end
def future?
def future? utc.future? end
def get_period_and_ensure_valid_local_time(period)
def get_period_and_ensure_valid_local_time(period) # we don't want a Time.local instance enforcing its own DST rules as well, # so transfer time values to a utc constructor if necessary @time = transfer_time_values_to_utc_constructor(@time) unless @time.utc? begin period || @time_zone.period_for_local(@time) rescue ::TZInfo::PeriodNotFound # time is in the "spring forward" hour gap, so we're moving the time forward one hour and trying again @time += 1.hour retry end end
def hash
def hash utc.hash end
def httpdate
HTTP requests.
Returns a string of the object's date and time in the format used by
def httpdate utc.httpdate end
def in_time_zone(new_zone = ::Time.zone)
def in_time_zone(new_zone = ::Time.zone) return self if time_zone == new_zone utc.in_time_zone(new_zone) end
def init_with(coder) #:nodoc:
def init_with(coder) #:nodoc: initialize(coder['utc'], coder['zone'], coder['time']) end
def initialize(utc_time, time_zone, local_time = nil, period = nil)
def initialize(utc_time, time_zone, local_time = nil, period = nil) @utc = utc_time ? transfer_time_values_to_utc_constructor(utc_time) : nil @time_zone, @time = time_zone, local_time @period = @utc ? period : get_period_and_ensure_valid_local_time(period) end
def inspect
Returns a string of the object's date, time, zone and offset from UTC.
def inspect "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}" end
def is_a?(klass)
def is_a?(klass) klass == ::Time || super end
def localtime(utc_offset = nil)
def localtime(utc_offset = nil) utc.getlocal(utc_offset) end
def marshal_dump
def marshal_dump [utc, time_zone.name, time] end
def marshal_load(variables)
def marshal_load(variables) initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc) end
def method_missing(sym, *args, &block)
Send the missing method to +time+ instance, and wrap result in a new
def method_missing(sym, *args, &block) wrap_with_time_zone time.__send__(sym, *args, &block) rescue NoMethodError => e raise e, e.message.sub(time.inspect, self.inspect), e.backtrace end
def past?
def past? utc.past? end
def period
def period @period ||= time_zone.period_for_utc(@utc) end
def respond_to?(sym, include_priv = false)
respond_to_missing? is not called in some cases, such as when type conversion is
def respond_to?(sym, include_priv = false) # ensure that we're not going to throw and rescue from NoMethodError in method_missing which is slow return false if sym.to_sym == :to_str super end
def respond_to_missing?(sym, include_priv)
Ensure proxy class responds to all methods that underlying time instance
def respond_to_missing?(sym, include_priv) return false if sym.to_sym == :acts_like_date? time.respond_to?(sym, include_priv) end
def rfc2822
format.
Returns a string of the object's date and time in the RFC 2822 standard
def rfc2822 to_s(:rfc822) end
def strftime(format)
Replaces %Z directive with +zone before passing to Time#strftime,
def strftime(format) format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}") getlocal(utc_offset).strftime(format) end
def time
def time @time ||= period.to_local(@utc) end
def to_a
now = Time.zone.now # => Tue, 18 Aug 2015 02:29:27 UTC +00:00
[seconds, minutes, hours, day, month, year, weekday, yearday, dst?, zone].
Returns Array of parts of Time in sequence of
def to_a [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone] end
def to_datetime
Time.zone.now.to_datetime # => Tue, 18 Aug 2015 02:32:20 +0000
Returns an instance of DateTime with the timezone's UTC offset
def to_datetime utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end
def to_f
since the Epoch (January 1, 1970 00:00 UTC).
Returns the object's date and time as a floating point number of seconds
def to_f utc.to_f end
def to_i
since the Epoch (January 1, 1970 00:00 UTC).
Returns the object's date and time as an integer number of seconds
def to_i utc.to_i end
def to_r
since the Epoch (January 1, 1970 00:00 UTC).
Returns the object's date and time as a rational number of seconds
def to_r utc.to_r end
def to_s(format = :default)
* :db - format outputs time in UTC :db time. See Time#to_formatted_s(:db).
* :default - default value, mimics Ruby Time#to_s format.
Accepts an optional format:
Returns a string of the object's date and time.
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 Time#to_s format end end
def to_time
as +self+ or in the local system timezone depending on the setting
Returns an instance of +Time+, either with the same UTC offset
def to_time if preserve_timezone @to_time_with_instance_offset ||= getlocal(utc_offset) else @to_time_with_system_offset ||= getlocal end end
def today?
Returns true if the current object's time falls within
def today? time.today? end
def transfer_time_values_to_utc_constructor(time)
def transfer_time_values_to_utc_constructor(time) ::Time.utc(time.year, time.month, time.day, time.hour, time.min, time.sec + time.subsec) end
def utc
def utc @utc ||= period.to_utc(@time) end
def utc?
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
Time.zone.now.utc? # => true
Time.zone = 'UTC' # => 'UTC'
Returns true if the current time zone is set to UTC.
def utc? period.offset.abbreviation == :UTC || period.offset.abbreviation == :UCT end
def utc_offset
def utc_offset period.utc_total_offset end
def wrap_with_time_zone(time)
def wrap_with_time_zone(time) if time.acts_like?(:time) periods = time_zone.periods_for_local(time) self.class.new(nil, time_zone, time, periods.include?(period) ? period : nil) elsif time.is_a?(Range) wrap_with_time_zone(time.begin)..wrap_with_time_zone(time.end) else time end end
def xmlschema(fraction_digits = 0)
format.
Returns a string of the object's date and time in the ISO 8601 standard
def xmlschema(fraction_digits = 0) "#{time.strftime(PRECISIONS[fraction_digits.to_i])}#{formatted_offset(true, 'Z'.freeze)}" end
def zone
Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)"
Returns the time zone abbreviation.
def zone period.zone_identifier.to_s end