Class: ActiveSupport::TimeWithZone
- Includes:
- Comparable, DateAndTime::Compatibility
- Defined in:
- 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 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.
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
Instance Attribute Summary collapse
-
#time_zone ⇒ Object
readonly
Returns the value of attribute time_zone.
Class Method Summary collapse
-
.name ⇒ Object
Report class name as ‘Time’ to thwart type checking.
Instance Method Summary collapse
- #+(other) ⇒ Object
- #-(other) ⇒ Object
-
#<=>(other) ⇒ Object
Use the time in UTC for comparisons.
-
#acts_like_time? ⇒ Boolean
So that
self
acts_like?(:time)
. - #advance(options) ⇒ Object
- #ago(other) ⇒ Object
-
#as_json(options = nil) ⇒ Object
Coerces time to a string for JSON encoding.
-
#between?(min, max) ⇒ Boolean
Returns true if the current object’s time is within the specified
min
andmax
time. -
#dst? ⇒ Boolean
(also: #isdst)
Returns true if the current time is within Daylight Savings Time for the specified time zone.
-
#encode_with(coder) ⇒ Object
:nodoc:.
- #eql?(other) ⇒ Boolean
-
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
Returns a formatted string of the offset from UTC, or an alternative string if the time zone is already UTC.
- #freeze ⇒ Object
-
#future? ⇒ Boolean
Returns true if the current object’s time is in the future.
- #hash ⇒ Object
-
#httpdate ⇒ Object
Returns a string of the object’s date and time in the format used by HTTP requests.
-
#in_time_zone(new_zone = ::Time.zone) ⇒ Object
Returns the simultaneous time in
Time.zone
, or the specified zone. -
#init_with(coder) ⇒ Object
:nodoc:.
-
#initialize(utc_time, time_zone, local_time = nil, period = nil) ⇒ TimeWithZone
constructor
A new instance of TimeWithZone.
- #inspect ⇒ Object
-
#is_a?(klass) ⇒ Boolean
(also: #kind_of?)
Say we’re a Time to thwart type checking.
-
#localtime(utc_offset = nil) ⇒ Object
(also: #getlocal)
Returns a
Time
instance of the simultaneous time in the system timezone. - #marshal_dump ⇒ Object
- #marshal_load(variables) ⇒ Object
-
#method_missing(sym, *args, &block) ⇒ Object
Send the missing method to
time
instance, and wrap result in a new TimeWithZone with the existingtime_zone
. -
#past? ⇒ Boolean
Returns true if the current object’s time is in the past.
-
#period ⇒ Object
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 ⇒ Object
(also: #rfc822)
Returns a string of the object’s date and time in the RFC 2822 standard format.
- #since(other) ⇒ Object (also: #in)
-
#strftime(format) ⇒ Object
Replaces
%Z
directive with +zone before passing to Time#strftime, so that zone information is correct. -
#time ⇒ Object
Returns a
Time
instance that represents the time intime_zone
. - #to_a ⇒ Object
- #to_datetime ⇒ Object
- #to_f ⇒ Object
- #to_i ⇒ Object (also: #tv_sec)
- #to_r ⇒ Object
-
#to_s(format = :default) ⇒ Object
(also: #to_formatted_s)
Returns a string of the object’s date and time.
-
#to_time ⇒ Object
Returns an instance of
Time
, either with the same UTC offset asself
or in the local system timezone depending on the setting ofActiveSupport.to_time_preserves_timezone
. -
#today? ⇒ Boolean
Returns true if the current object’s time falls within the current day.
-
#utc ⇒ Object
(also: #comparable_time, #getgm, #getutc, #gmtime)
Returns a
Time
instance of the simultaneous time in the UTC timezone. -
#utc? ⇒ Boolean
(also: #gmt?)
Returns true if the current time zone is set to UTC.
-
#utc_offset ⇒ Object
(also: #gmt_offset, #gmtoff)
Returns the offset from current time to UTC time in seconds.
- #xmlschema(fraction_digits = 0) ⇒ Object (also: #iso8601)
-
#zone ⇒ Object
Time uses
zone
to display the time zone abbreviation, so we’re duck-typing it.
Constructor Details
#initialize(utc_time, time_zone, local_time = nil, period = nil) ⇒ TimeWithZone
Returns a new instance of TimeWithZone.
47 48 49 50 51 |
# File 'lib/active_support/time_with_zone.rb', line 47 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(sym, *args, &block) ⇒ Object
Send the missing method to time
instance, and wrap result in a new TimeWithZone with the existing time_zone
.
382 383 384 385 386 |
# File 'lib/active_support/time_with_zone.rb', line 382 def method_missing(sym, *args, &block) wrap_with_time_zone time.__send__(sym, *args, &block) rescue NoMethodError => e raise e, e..sub(time.inspect, self.inspect), e.backtrace end |
Instance Attribute Details
#time_zone ⇒ Object (readonly)
Returns the value of attribute time_zone.
45 46 47 |
# File 'lib/active_support/time_with_zone.rb', line 45 def time_zone @time_zone end |
Class Method Details
.name ⇒ Object
Report class name as ‘Time’ to thwart type checking.
40 41 42 |
# File 'lib/active_support/time_with_zone.rb', line 40 def self.name 'Time' end |
Instance Method Details
#+(other) ⇒ Object
251 252 253 254 255 256 257 258 259 260 |
# File 'lib/active_support/time_with_zone.rb', line 251 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 |
#-(other) ⇒ Object
262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/active_support/time_with_zone.rb', line 262 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) 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) ⇒ Object
Use the time in UTC for comparisons.
217 218 219 |
# File 'lib/active_support/time_with_zone.rb', line 217 def <=>(other) utc <=> other end |
#acts_like_time? ⇒ Boolean
So that self
acts_like?(:time)
.
341 342 343 |
# File 'lib/active_support/time_with_zone.rb', line 341 def acts_like_time? true end |
#advance(options) ⇒ Object
290 291 292 293 294 295 296 297 298 |
# File 'lib/active_support/time_with_zone.rb', line 290 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 |
#ago(other) ⇒ Object
286 287 288 |
# File 'lib/active_support/time_with_zone.rb', line 286 def ago(other) since(-other) end |
#as_json(options = nil) ⇒ Object
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
.
# 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"
156 157 158 159 160 161 162 |
# File 'lib/active_support/time_with_zone.rb', line 156 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 |
#between?(min, max) ⇒ Boolean
Returns true if the current object’s time is within the specified min
and max
time.
223 224 225 |
# File 'lib/active_support/time_with_zone.rb', line 223 def between?(min, max) utc.between?(min, max) end |
#dst? ⇒ Boolean Also known as: isdst
90 91 92 |
# File 'lib/active_support/time_with_zone.rb', line 90 def dst? period.dst? end |
#encode_with(coder) ⇒ Object
:nodoc:
168 169 170 171 172 173 174 |
# File 'lib/active_support/time_with_zone.rb', line 168 def encode_with(coder) #:nodoc: 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 |
#eql?(other) ⇒ Boolean
243 244 245 |
# File 'lib/active_support/time_with_zone.rb', line 243 def eql?(other) other.eql?(utc) end |
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
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"
121 122 123 |
# File 'lib/active_support/time_with_zone.rb', line 121 def formatted_offset(colon = true, alternate_utc_string = nil) utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon) end |
#freeze ⇒ Object
351 352 353 354 355 |
# File 'lib/active_support/time_with_zone.rb', line 351 def freeze # preload instance variables before freezing period; utc; time; to_datetime; to_time super end |
#future? ⇒ Boolean
Returns true if the current object’s time is in the future.
239 240 241 |
# File 'lib/active_support/time_with_zone.rb', line 239 def future? utc.future? end |
#hash ⇒ Object
247 248 249 |
# File 'lib/active_support/time_with_zone.rb', line 247 def hash utc.hash end |
#httpdate ⇒ Object
180 181 182 |
# File 'lib/active_support/time_with_zone.rb', line 180 def httpdate utc.httpdate end |
#in_time_zone(new_zone = ::Time.zone) ⇒ Object
Returns the simultaneous time in Time.zone
, or the specified zone.
73 74 75 76 |
# File 'lib/active_support/time_with_zone.rb', line 73 def in_time_zone(new_zone = ::Time.zone) return self if time_zone == new_zone utc.in_time_zone(new_zone) end |
#init_with(coder) ⇒ Object
:nodoc:
164 165 166 |
# File 'lib/active_support/time_with_zone.rb', line 164 def init_with(coder) #:nodoc: initialize(coder['utc'], coder['zone'], coder['time']) end |
#inspect ⇒ Object
131 132 133 |
# File 'lib/active_support/time_with_zone.rb', line 131 def inspect "#{time.strftime('%a, %d %b %Y %H:%M:%S')} #{zone} #{formatted_offset}" end |
#is_a?(klass) ⇒ Boolean Also known as: kind_of?
Say we’re a Time to thwart type checking.
346 347 348 |
# File 'lib/active_support/time_with_zone.rb', line 346 def is_a?(klass) klass == ::Time || super end |
#localtime(utc_offset = nil) ⇒ Object Also known as: getlocal
Returns a Time
instance of the simultaneous time in the system timezone.
79 80 81 |
# File 'lib/active_support/time_with_zone.rb', line 79 def localtime(utc_offset = nil) utc.getlocal(utc_offset) end |
#marshal_dump ⇒ Object
357 358 359 |
# File 'lib/active_support/time_with_zone.rb', line 357 def marshal_dump [utc, time_zone.name, time] end |
#marshal_load(variables) ⇒ Object
361 362 363 |
# File 'lib/active_support/time_with_zone.rb', line 361 def marshal_load(variables) initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc) end |
#past? ⇒ Boolean
Returns true if the current object’s time is in the past.
228 229 230 |
# File 'lib/active_support/time_with_zone.rb', line 228 def past? utc.past? end |
#period ⇒ Object
Returns the underlying TZInfo::TimezonePeriod.
68 69 70 |
# File 'lib/active_support/time_with_zone.rb', line 68 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
367 368 369 370 371 |
# File 'lib/active_support/time_with_zone.rb', line 367 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.
375 376 377 378 |
# File 'lib/active_support/time_with_zone.rb', line 375 def respond_to_missing?(sym, include_priv) return false if sym.to_sym == :acts_like_date? time.respond_to?(sym, include_priv) end |
#rfc2822 ⇒ Object Also known as: rfc822
188 189 190 |
# File 'lib/active_support/time_with_zone.rb', line 188 def rfc2822 to_s(:rfc822) end |
#since(other) ⇒ Object Also known as: in
275 276 277 278 279 280 281 282 283 |
# File 'lib/active_support/time_with_zone.rb', line 275 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 |
#strftime(format) ⇒ Object
Replaces %Z
directive with +zone before passing to Time#strftime, so that zone information is correct.
211 212 213 214 |
# File 'lib/active_support/time_with_zone.rb', line 211 def strftime(format) format = format.gsub(/((?:\A|[^%])(?:%%)*)%Z/, "\\1#{zone}") getlocal(utc_offset).strftime(format) end |
#time ⇒ Object
Returns a Time
instance that represents the time in time_zone
.
54 55 56 |
# File 'lib/active_support/time_with_zone.rb', line 54 def time @time ||= period.to_local(@utc) end |
#to_a ⇒ Object
308 309 310 |
# File 'lib/active_support/time_with_zone.rb', line 308 def to_a [time.sec, time.min, time.hour, time.day, time.mon, time.year, time.wday, time.yday, dst?, zone] end |
#to_datetime ⇒ Object
325 326 327 |
# File 'lib/active_support/time_with_zone.rb', line 325 def to_datetime @to_datetime ||= utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end |
#to_f ⇒ Object
312 313 314 |
# File 'lib/active_support/time_with_zone.rb', line 312 def to_f utc.to_f end |
#to_i ⇒ Object Also known as: tv_sec
316 317 318 |
# File 'lib/active_support/time_with_zone.rb', line 316 def to_i utc.to_i end |
#to_r ⇒ Object
321 322 323 |
# File 'lib/active_support/time_with_zone.rb', line 321 def to_r utc.to_r end |
#to_s(format = :default) ⇒ Object Also known as: to_formatted_s
Returns a string of the object’s date and time. Accepts an optional format
:
-
:default
- default value, mimics Ruby 1.9 Time#to_s format. -
:db
- format outputs time in UTC :db time. See Time#to_formatted_s(:db). -
Any key in
Time::DATE_FORMATS
can be used. See active_support/core_ext/time/conversions.rb.
198 199 200 201 202 203 204 205 206 |
# File 'lib/active_support/time_with_zone.rb', line 198 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 |
#to_time ⇒ Object
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
.
332 333 334 335 336 337 338 |
# File 'lib/active_support/time_with_zone.rb', line 332 def to_time if preserve_timezone @to_time_with_instance_offset ||= getlocal(utc_offset) else @to_time_with_system_offset ||= getlocal end end |
#today? ⇒ Boolean
Returns true if the current object’s time falls within the current day.
234 235 236 |
# File 'lib/active_support/time_with_zone.rb', line 234 def today? time.today? end |
#utc ⇒ Object Also known as: comparable_time, getgm, getutc, gmtime
Returns a Time
instance of the simultaneous time in the UTC timezone.
59 60 61 |
# File 'lib/active_support/time_with_zone.rb', line 59 def utc @utc ||= period.to_utc(@time) end |
#utc? ⇒ Boolean Also known as: gmt?
101 102 103 |
# File 'lib/active_support/time_with_zone.rb', line 101 def utc? time_zone.name == 'UTC' end |
#utc_offset ⇒ Object Also known as: gmt_offset, gmtoff
Returns the offset from current time to UTC time in seconds.
107 108 109 |
# File 'lib/active_support/time_with_zone.rb', line 107 def utc_offset period.utc_total_offset end |
#xmlschema(fraction_digits = 0) ⇒ Object Also known as: iso8601
135 136 137 138 139 140 141 |
# File 'lib/active_support/time_with_zone.rb', line 135 def xmlschema(fraction_digits = 0) fraction = if fraction_digits.to_i > 0 (".%06i" % time.usec)[0, fraction_digits.to_i + 1] end "#{time.strftime("%Y-%m-%dT%H:%M:%S")}#{fraction}#{formatted_offset(true, 'Z')}" end |
#zone ⇒ Object
Time uses zone
to display the time zone abbreviation, so we’re duck-typing it.
127 128 129 |
# File 'lib/active_support/time_with_zone.rb', line 127 def zone period.zone_identifier.to_s end |