Class: ActiveSupport::TimeWithZone
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Comparable,
::DateAndTime::Compatibility
|
|
Inherits: | Object |
Defined in: | activesupport/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.
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.000000000 EST -05:00
Time.zone.parse('2007-02-10 15:30:45') # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.at(1171139445) # => Sat, 10 Feb 2007 15:30:45.000000000 EST -05:00
Time.zone.now # => Sun, 18 May 2008 13:07:55.754107581 EDT -04:00
Time.utc(2007, 2, 10, 20, 30, 45).in_time_zone # => Sat, 10 Feb 2007 15:30:45.000000000 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.
t = Time.zone.now # => Sun, 18 May 2008 13:27:25.031505668 EDT -04:00
t.hour # => 13
t.dst? # => true
t.utc_offset # => -14400
t.zone # => "EDT"
t.to_fs(:rfc822) # => "Sun, 18 May 2008 13:27:25 -0400"
t + 1.day # => Mon, 19 May 2008 13:27:25.031505668 EDT -04:00
t.beginning_of_year # => Tue, 01 Jan 2008 00:00:00.000000000 EST -05:00
t > Time.utc(1999) # => true
t.is_a?(Time) # => true
t.is_a?(ActiveSupport::TimeWithZone) # => true
Constant Summary
-
PRECISIONS =
# File 'activesupport/lib/active_support/time_with_zone.rb', line 45Hash.new { |h, n| h[n] = "%FT%T.%#{n}N" }
-
SECONDS_PER_DAY =
# File 'activesupport/lib/active_support/time_with_zone.rb', line 54786400
Class Method Summary
Instance Attribute Summary
-
#acts_like_time? ⇒ Boolean
readonly
So that
self
acts_like?(:time)
. -
#blank? ⇒ Boolean
readonly
An instance of
TimeWithZone
is never blank. -
#dst? ⇒ Boolean
(also: #isdst)
readonly
Returns true if the current time is within Daylight Savings
::Time
for the specified time zone. -
#future? ⇒ Boolean
readonly
Returns true if the current object’s time is in the future.
-
#gmt?
readonly
Alias for #utc?.
-
#isdst
readonly
Alias for #dst?.
-
#next_day?
readonly
Alias for #tomorrow?.
-
#past? ⇒ Boolean
readonly
Returns true if the current object’s time is in the past.
-
#prev_day?
readonly
Alias for #yesterday?.
- #time_zone readonly
-
#today? ⇒ Boolean
readonly
Returns true if the current object’s time falls within the current day.
-
#tomorrow? ⇒ Boolean
(also: #next_day?)
readonly
Returns true if the current object’s time falls within the next day (tomorrow).
-
#utc
(also: #comparable_time, #getgm, #getutc, #gmtime)
readonly
Returns a
::Time
instance of the simultaneous time in the UTC timezone. -
#utc? ⇒ Boolean
(also: #gmt?)
readonly
Returns true if the current time zone is set to UTC.
-
#yesterday? ⇒ Boolean
(also: #prev_day?)
readonly
Returns true if the current object’s time falls within the previous day (yesterday).
::DateAndTime::Compatibility
- Included
Instance Method Summary
-
#+(other)
(also: #since, #in)
Adds an interval of time to the current object’s time and returns that value as a new
TimeWithZone
object. -
#-(other)
Subtracts an interval of time and returns a new
TimeWithZone
object unless the other valueacts_like?
time. -
#<=>(other)
Use the time in UTC for comparisons.
-
#advance(options)
Uses Date to provide precise
::Time
calculations for years, months, and days according to the proleptic Gregorian calendar. - #after?
-
#ago(other)
Subtracts an interval of time from the current object’s time and returns the result as a new
TimeWithZone
object. -
#as_json(options = nil)
Coerces time to a string for
JSON
encoding. - #before?
-
#between?(min, max) ⇒ Boolean
Returns true if the current object’s time is within the specified
min
andmax
time. -
#change(options)
Returns a new
TimeWithZone
where one or more of the elements have been changed according to theoptions
parameter. -
#comparable_time
Alias for #utc.
-
#eql?(other) ⇒ Boolean
Returns
true
ifother
is equal to current object. -
#formatted_offset(colon = true, alternate_utc_string = nil)
Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.
- #freeze
-
#getgm
Alias for #utc.
-
#getlocal(utc_offset = nil)
Alias for #localtime.
-
#getutc
Alias for #utc.
-
#gmt_offset
Alias for #utc_offset.
-
#gmtime
Alias for #utc.
-
#gmtoff
Alias for #utc_offset.
- #hash
-
#httpdate
Returns a string of the object’s date and time in the format used by HTTP requests.
-
#in(other)
Alias for #+.
-
#in_time_zone(new_zone = ::Time.zone)
Returns the simultaneous time in Time.zone, or the specified zone.
-
#inspect
Returns a string of the object’s date, time, zone, and offset from UTC.
-
#is_a?(klass) ⇒ Boolean
(also: #kind_of?)
Say we’re a
::Time
to thwart type checking. -
#iso8601(fraction_digits = 0)
Alias for #xmlschema.
-
#kind_of?(klass)
Alias for #is_a?.
-
#localtime(utc_offset = nil)
(also: #getlocal)
Returns a
::Time
instance of the simultaneous time in the system timezone. - #marshal_dump
- #marshal_load(variables)
-
#method_missing
Send the missing method to #time instance, and wrap result in a new
TimeWithZone
with the existing #time_zone. -
#period
Returns the underlying
TZInfo::TimezonePeriod
. -
#respond_to?(sym, include_priv = false) ⇒ Boolean
respond_to_missing? is not called in some cases, such as when type conversion is performed with
Kernel.String
-
#respond_to_missing?(sym, include_priv) ⇒ Boolean
Ensure proxy class responds to all methods that underlying time instance responds to.
-
#rfc2822
(also: #rfc822)
Returns a string of the object’s date and time in the RFC 2822 standard format.
-
#rfc3339(fraction_digits = 0)
Alias for #xmlschema.
-
#rfc822
Alias for #rfc2822.
-
#since(other)
Alias for #+.
-
#strftime(format)
Replaces
%Z
directive with +zone before passing toTime#strftime
, so that zone information is correct. -
#time
Returns a
::Time
instance that represents the time in #time_zone. -
#to_a
Returns Array of parts of
::Time
in sequence of [seconds, minutes, hours, day, month, year, weekday, yearday, dst?, zone]. -
#to_datetime
Returns an instance of
::DateTime
with the timezone’s UTC offset. -
#to_f
Returns the object’s date and time as a floating-point number of seconds since the Epoch (January 1, 1970 00:00 UTC).
-
#to_formatted_s(format = :default)
Alias for #to_fs.
-
#to_fs(format = :default)
(also: #to_formatted_s)
Returns a string of the object’s date and time.
-
#to_i
(also: #tv_sec)
Returns the object’s date and time as an integer number of seconds since the Epoch (January 1, 1970 00:00 UTC).
-
#to_r
Returns the object’s date and time as a rational number of seconds since the Epoch (January 1, 1970 00:00 UTC).
-
#to_s
Returns a string of the object’s date and time.
-
#to_time
Returns an instance of
::Time
, either with the same UTC offset asself
or in the local system timezone depending on the setting of to_time_preserves_timezone. -
#tv_sec
Alias for #to_i.
-
#utc_offset
(also: #gmt_offset, #gmtoff)
Returns the offset from current time to UTC time in seconds.
-
#xmlschema(fraction_digits = 0)
(also: #iso8601, #rfc3339)
Returns a string of the object’s date and time in the ISO 8601 standard format.
-
#zone
Returns the time zone abbreviation.
Constructor Details
.new(utc_time, time_zone, local_time = nil, period = nil) ⇒ TimeWithZone
# File 'activesupport/lib/active_support/time_with_zone.rb', line 51
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
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing
Send the missing method to #time instance, and wrap result in a new TimeWithZone
with the existing #time_zone.
Instance Attribute Details
#acts_like_time? ⇒ Boolean
(readonly)
So that self
acts_like?(:time)
.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 494
def acts_like_time? true end
#blank? ⇒ Boolean
(readonly)
An instance of TimeWithZone
is never blank
# File 'activesupport/lib/active_support/time_with_zone.rb', line 505
def blank? false end
#dst? ⇒ Boolean
(readonly)
Also known as: #isdst
# File 'activesupport/lib/active_support/time_with_zone.rb', line 94
def dst? period.dst? end
#future? ⇒ Boolean
(readonly)
Returns true if the current object’s time is in the future.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 270
def future? utc.future? end
#gmt? (readonly)
Alias for #utc?.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 108
alias_method :gmt?, :utc?
#isdst (readonly)
Alias for #dst?.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 97
alias_method :isdst, :dst?
#next_day? (readonly)
Alias for #tomorrow?.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 260
alias :next_day? :tomorrow?
#past? ⇒ Boolean
(readonly)
Returns true if the current object’s time is in the past.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 245
def past? utc.past? end
#prev_day? (readonly)
Alias for #yesterday?.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 267
alias :prev_day? :yesterday?
#time_zone (readonly)
[ GitHub ]# File 'activesupport/lib/active_support/time_with_zone.rb', line 49
attr_reader :time_zone
#today? ⇒ Boolean
(readonly)
Returns true if the current object’s time falls within the current day.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 251
def today? time.today? end
#tomorrow? ⇒ Boolean
(readonly)
Also known as: #next_day?
Returns true if the current object’s time falls within the next day (tomorrow).
# File 'activesupport/lib/active_support/time_with_zone.rb', line 257
def tomorrow? time.tomorrow? end
#utc (readonly) Also known as: #comparable_time, #getgm, #getutc, #gmtime
Returns a ::Time
instance of the simultaneous time in the UTC timezone.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 63
def utc @utc ||= incorporate_utc_offset(@time, -utc_offset) end
#utc? ⇒ Boolean
(readonly)
Also known as: #gmt?
#yesterday? ⇒ Boolean
(readonly)
Also known as: #prev_day?
Returns true if the current object’s time falls within the previous day (yesterday).
# File 'activesupport/lib/active_support/time_with_zone.rb', line 264
def yesterday? time.yesterday? end
Instance Method Details
#+(other) Also known as: #since, #in
Adds an interval of time to the current object’s time and returns that value as a new TimeWithZone
object.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now + 1000 # => Sun, 02 Nov 2014 01:43:08.725182881 EDT -04:00
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.
For instance, a time + 24.hours will advance exactly 24 hours, while a time + 1.day will advance 23-25 hours, depending on the day.
now + 24.hours # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now + 1.day # => Mon, 03 Nov 2014 01:26:28.725182881 EST -05:00
# File 'activesupport/lib/active_support/time_with_zone.rb', line 299
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
#-(other)
Subtracts an interval of time and returns a new TimeWithZone
object unless the other value acts_like?
time. In which case, it will subtract the other time and return the difference in seconds as a ::Float
.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now - 1000 # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00
If subtracting a Duration
of variable length (i.e., years, months, days), move backward from #time, otherwise move backward from #utc, for accuracy when moving across DST boundaries.
For instance, a time - 24.hours will go subtract exactly 24 hours, while a time - 1.day will subtract 23-25 hours, depending on the day.
now - 24.hours # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now - 1.day # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00
If both the TimeWithZone
object and the other value act like ::Time
, a ::Float
will be returned.
Time.zone.now - 1.day.ago # => 86399.999967
# File 'activesupport/lib/active_support/time_with_zone.rb', line 333
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
#<=>(other)
Use the time in UTC for comparisons.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 232
def <=>(other) utc <=> other end
#advance(options)
Uses Date to provide precise ::Time
calculations for years, months, and days according to the proleptic Gregorian calendar. The result is returned as a new TimeWithZone
object.
The options
parameter takes a hash with any of these keys: :years
, :months
, :weeks
, :days
, :hours
, :minutes
, :seconds
.
If advancing by a value of variable length (i.e., years, weeks, months, days), move forward from #time, otherwise move forward from #utc, for accuracy when moving across DST boundaries.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Sun, 02 Nov 2014 01:26:28.558049687 EDT -04:00
now.advance(seconds: 1) # => Sun, 02 Nov 2014 01:26:29.558049687 EDT -04:00
now.advance(minutes: 1) # => Sun, 02 Nov 2014 01:27:28.558049687 EDT -04:00
now.advance(hours: 1) # => Sun, 02 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(days: 1) # => Mon, 03 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(weeks: 1) # => Sun, 09 Nov 2014 01:26:28.558049687 EST -05:00
now.advance(months: 1) # => Tue, 02 Dec 2014 01:26:28.558049687 EST -05:00
now.advance(years: 1) # => Mon, 02 Nov 2015 01:26:28.558049687 EST -05:00
# File 'activesupport/lib/active_support/time_with_zone.rb', line 422
def advance( ) # 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 .values_at(:years, :weeks, :months, :days).any? method_missing(:advance, ) else utc.advance( ).in_time_zone(time_zone) end end
#after?
[ GitHub ]# File 'activesupport/lib/active_support/time_with_zone.rb', line 236
alias_method :after?, :>
#ago(other)
Subtracts an interval of time from the current object’s time and returns the result as a new TimeWithZone
object.
Time.zone = 'Eastern Time (US & Canada)' # => 'Eastern Time (US & Canada)'
now = Time.zone.now # => Mon, 03 Nov 2014 00:26:28.725182881 EST -05:00
now.ago(1000) # => Mon, 03 Nov 2014 00:09:48.725182881 EST -05:00
If we’re subtracting a Duration
of variable length (i.e., years, months, days), move backward from #time, otherwise move backward from #utc, for accuracy when moving across DST boundaries.
For instance, time.ago(24.hours)
will move back exactly 24 hours, while time.ago(1.day)
will move back 23-25 hours, depending on the day.
now.ago(24.hours) # => Sun, 02 Nov 2014 01:26:28.725182881 EDT -04:00
now.ago(1.day) # => Sun, 02 Nov 2014 00:26:28.725182881 EDT -04:00
# File 'activesupport/lib/active_support/time_with_zone.rb', line 361
def ago(other) since(-other) end
#as_json(options = nil)
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 JSON::Encoding.use_standard_json_time_format to false
.
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").to_json
# => "2005-02-01T05:15:10.000-10:00"
# With ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
Time.utc(2005,2,1,15,15,10).in_time_zone("Hawaii").to_json
# => "2005/02/01 05:15:10 -1000"
# File 'activesupport/lib/active_support/time_with_zone.rb', line 166
def as_json( = 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
#before?
[ GitHub ]# File 'activesupport/lib/active_support/time_with_zone.rb', line 235
alias_method :before?, :<
#between?(min, max) ⇒ Boolean
Returns true if the current object’s time is within the specified min
and max
time.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 240
def between?(min, max) utc.between?(min, max) end
#change(options)
Returns a new TimeWithZone
where one or more of the elements have been changed according to the options
parameter. The time options (:hour
, :min
, :sec
, :usec
, :nsec
) reset cascadingly, so if only the hour is passed, then minute, sec, usec, and nsec is set to 0. If the hour and minute is passed, then sec, usec, and nsec is set to 0. The options
parameter takes a hash with any of these keys: :year
, :month
, :day
, :hour
, :min
, :sec
, :usec
, :nsec
, :offset
, :zone
. Pass either :usec
or :nsec
, not both. Similarly, pass either :zone
or :offset
, not both.
t = Time.zone.now # => Fri, 14 Apr 2017 11:45:15.116992711 EST -05:00
t.change(year: 2020) # => Tue, 14 Apr 2020 11:45:15.116992711 EST -05:00
t.change(hour: 12) # => Fri, 14 Apr 2017 12:00:00.116992711 EST -05:00
t.change(min: 30) # => Fri, 14 Apr 2017 11:30:00.116992711 EST -05:00
t.change(offset: "-10:00") # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00
t.change(zone: "Hawaii") # => Fri, 14 Apr 2017 11:45:15.116992711 HST -10:00
# File 'activesupport/lib/active_support/time_with_zone.rb', line 382
def change( ) if [:zone] && [:offset] raise ArgumentError, "Can't change both :offset and :zone at the same time: #{ .inspect}" end new_time = time.change( ) if [:zone] new_zone = ::Time.find_zone( [:zone]) elsif [:offset] new_zone = ::Time.find_zone(new_time.utc_offset) end new_zone ||= time_zone periods = new_zone.periods_for_local(new_time) self.class.new(nil, new_zone, new_time, periods.include?(period) ? period : nil) end
#comparable_time
Alias for #utc.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 66
alias_method :comparable_time, :utc
#eql?(other) ⇒ Boolean
Returns true
if other
is equal to current object.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 275
def eql?(other) other.eql?(utc) end
#formatted_offset(colon = true, alternate_utc_string = nil)
Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.
Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)"
Time.zone.now.formatted_offset(true) # => "-05:00"
Time.zone.now.formatted_offset(false) # => "-0500"
Time.zone = 'UTC' # => "UTC"
Time.zone.now.formatted_offset(true, "0") # => "0"
# File 'activesupport/lib/active_support/time_with_zone.rb', line 125
def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon) end
#freeze
[ GitHub ]# File 'activesupport/lib/active_support/time_with_zone.rb', line 509
def freeze # preload instance variables before freezing period; utc; time; to_datetime; to_time super end
#getgm
Alias for #utc.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 67
alias_method :getgm, :utc
#getlocal(utc_offset = nil)
Alias for #localtime.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 86
alias_method :getlocal, :localtime
#getutc
Alias for #utc.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 68
alias_method :getutc, :utc
#gmt_offset
Alias for #utc_offset.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 114
alias_method :gmt_offset, :utc_offset
#gmtime
Alias for #utc.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 69
alias_method :gmtime, :utc
#gmtoff
Alias for #utc_offset.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 115
alias_method :gmtoff, :utc_offset
#hash
[ GitHub ]# File 'activesupport/lib/active_support/time_with_zone.rb', line 279
def hash utc.hash end
#httpdate
# File 'activesupport/lib/active_support/time_with_zone.rb', line 186
def httpdate utc.httpdate end
#in(other)
Alias for #+.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 308
alias_method :in, :+
#in_time_zone(new_zone = ::Time.zone)
Returns the simultaneous time in Time.zone, or the specified zone.
#inspect
# File 'activesupport/lib/active_support/time_with_zone.rb', line 140
def inspect "#{time.strftime('%a, %d %b %Y %H:%M:%S.%9N')} #{zone} #{formatted_offset}" end
#is_a?(klass) ⇒ Boolean
Also known as: #kind_of?
Say we’re a ::Time
to thwart type checking.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 499
def is_a?(klass) klass == ::Time || super end
#iso8601(fraction_digits = 0)
Alias for #xmlschema.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 151
alias_method :iso8601, :xmlschema
#kind_of?(klass)
Alias for #is_a?.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 502
alias_method :kind_of?, :is_a?
#localtime(utc_offset = nil) Also known as: #getlocal
Returns a ::Time
instance of the simultaneous time in the system timezone.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 83
def localtime(utc_offset = nil) utc.getlocal(utc_offset) end
#marshal_dump
[ GitHub ]#marshal_load(variables)
[ GitHub ]#period
Returns the underlying TZInfo::TimezonePeriod
.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 72
def period @period ||= time_zone.period_for_utc(@utc) end
#respond_to?(sym, include_priv = false) ⇒ Boolean
respond_to_missing? is not called in some cases, such as when type conversion is performed with Kernel.String
# File 'activesupport/lib/active_support/time_with_zone.rb', line 525
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
#respond_to_missing?(sym, include_priv) ⇒ Boolean
Ensure proxy class responds to all methods that underlying time instance responds to.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 533
def respond_to_missing?(sym, include_priv) return false if sym.to_sym == :acts_like_date? time.respond_to?(sym, include_priv) end
#rfc2822 Also known as: #rfc822
#rfc3339(fraction_digits = 0)
Alias for #xmlschema.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 152
alias_method :rfc3339, :xmlschema
#rfc822
Alias for #rfc2822.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 197
alias_method :rfc822, :rfc2822
#since(other)
Alias for #+.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 307
alias_method :since, :+
#strftime(format)
Replaces %Z
directive with +zone before passing to Time#strftime
, so that zone information is correct.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 226
def strftime(format) format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}") getlocal(utc_offset).strftime(format) end
#time
Returns a ::Time
instance that represents the time in #time_zone.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 58
def time @time ||= incorporate_utc_offset(@utc, utc_offset) end
#to_a
#to_datetime
Returns an instance of ::DateTime
with the timezone’s UTC offset
Time.zone.now.to_datetime # => Tue, 18 Aug 2015 02:32:20 +0000
Time.current.in_time_zone('Hawaii').to_datetime # => Mon, 17 Aug 2015 16:32:20 -1000
# File 'activesupport/lib/active_support/time_with_zone.rb', line 478
def to_datetime @to_datetime ||= utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end
#to_f
# File 'activesupport/lib/active_support/time_with_zone.rb', line 453
def to_f utc.to_f end
#to_formatted_s(format = :default)
Alias for #to_fs.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 222
alias_method :to_formatted_s, :to_fs
#to_fs(format = :default) Also known as: #to_formatted_s
Returns a string of the object’s date and time.
This method is aliased to #to_formatted_s.
Accepts an optional format
:
-
:default
- default value, mimics RubyTime#to_s
format. -
:db
- format outputs time in UTC:db
time. See Time#to_fs(:db). -
Any key in Time::DATE_FORMATS can be used. See active_support/core_ext/time/conversions.rb.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 212
def to_fs(format = :default) if format == :db utc.to_fs(format) elsif formatter = ::Time::DATE_FORMATS[format] formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter) else # Change to to_s when deprecation is gone. "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" end end
#to_i Also known as: #tv_sec
# File 'activesupport/lib/active_support/time_with_zone.rb', line 461
def to_i utc.to_i end
#to_r
# File 'activesupport/lib/active_support/time_with_zone.rb', line 470
def to_r utc.to_r end
#to_s
Returns a string of the object’s date and time.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 200
def to_s "#{time.strftime("%Y-%m-%d %H:%M:%S")} #{formatted_offset(false, 'UTC')}" # mimicking Ruby Time#to_s format end
#to_time
Returns an instance of ::Time
, either with the same UTC offset as self
or in the local system timezone depending on the setting of ActiveSupport.to_time_preserves_timezone.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 485
def to_time if preserve_timezone @to_time_with_instance_offset ||= getlocal(utc_offset) else @to_time_with_system_offset ||= getlocal end end
#tv_sec
Alias for #to_i.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 464
alias_method :tv_sec, :to_i
#utc_offset Also known as: #gmt_offset, #gmtoff
Returns the offset from current time to UTC time in seconds.
# File 'activesupport/lib/active_support/time_with_zone.rb', line 111
def utc_offset period.observed_utc_offset end
#xmlschema(fraction_digits = 0) Also known as: #iso8601, #rfc3339
# File 'activesupport/lib/active_support/time_with_zone.rb', line 148
def xmlschema(fraction_digits = 0) "#{time.strftime(PRECISIONS[fraction_digits.to_i])}#{formatted_offset(true, 'Z')}" end
#zone
# File 'activesupport/lib/active_support/time_with_zone.rb', line 133
def zone period.abbreviation end