Class: ActiveSupport::TimeWithZone
- Includes:
- Comparable
- 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. 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
Instance Attribute Summary collapse
-
#time_zone ⇒ Object
readonly
Returns the value of attribute time_zone.
Class Method Summary collapse
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
- #dst? ⇒ Boolean (also: #isdst)
- #encode_with(coder) ⇒ Object
- #eql?(other) ⇒ Boolean
- #formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
- #freeze ⇒ Object
- #future? ⇒ Boolean
- #hash ⇒ Object
- #httpdate ⇒ Object
-
#in_time_zone(new_zone = ::Time.zone) ⇒ Object
Returns the simultaneous time in
Time.zone
, or the specified zone. -
#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 ⇒ Object
(also: #getlocal)
Returns a
Time.local()
instance of the simultaneous time in your system’sENV['TZ']
zone. - #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
-
#period ⇒ Object
Returns the underlying TZInfo::TimezonePeriod.
-
#respond_to?(sym, include_priv = false) ⇒ Boolean
Ensure proxy class responds to all methods that underlying time instance responds to.
- #rfc2822 ⇒ Object (also: #rfc822)
- #since(other) ⇒ Object
-
#strftime(format) ⇒ Object
Replaces
%Z
and%z
directives withzone
andformatted_offset
, respectively, before passing to Time#strftime, so that zone information is correct. -
#time ⇒ Object
Returns a Time or DateTime instance that represents the time in
time_zone
. - #to_a ⇒ Object
- #to_datetime ⇒ Object
- #to_f ⇒ Object
- #to_i ⇒ Object (also: #tv_sec)
-
#to_s(format = :default) ⇒ Object
(also: #to_formatted_s)
:db
format outputs time in UTC; all others output time in local. -
#to_time ⇒ Object
A TimeWithZone acts like a Time, so just return
self
. - #to_yaml(options = {}) ⇒ Object
- #today? ⇒ Boolean
- #usec ⇒ Object
-
#utc ⇒ Object
(also: #comparable_time, #getgm, #getutc, #gmtime)
Returns a Time or DateTime instance that represents the time in UTC.
- #utc? ⇒ Boolean (also: #gmt?)
- #utc_offset ⇒ Object (also: #gmt_offset, #gmtoff)
- #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.
45 46 47 48 |
# File '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 |
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
.
331 332 333 334 |
# File 'lib/active_support/time_with_zone.rb', line 331 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 |
Instance Attribute Details
#time_zone ⇒ Object (readonly)
Returns the value of attribute time_zone.
43 44 45 |
# File 'lib/active_support/time_with_zone.rb', line 43 def time_zone @time_zone end |
Class Method Details
.name ⇒ Object
38 39 40 |
# File 'lib/active_support/time_with_zone.rb', line 38 def self.name 'Time' # Report class name as 'Time' to thwart type checking end |
Instance Method Details
#+(other) ⇒ Object
217 218 219 220 221 222 223 224 225 226 |
# File 'lib/active_support/time_with_zone.rb', line 217 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
228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/active_support/time_with_zone.rb', line 228 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 |
#<=>(other) ⇒ Object
Use the time in UTC for comparisons.
189 190 191 |
# File 'lib/active_support/time_with_zone.rb', line 189 def <=>(other) utc <=> other end |
#acts_like_time? ⇒ Boolean
So that self
acts_like?(:time)
.
300 301 302 |
# File 'lib/active_support/time_with_zone.rb', line 300 def acts_like_time? true end |
#advance(options) ⇒ Object
255 256 257 258 259 260 261 262 263 |
# File 'lib/active_support/time_with_zone.rb', line 255 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
251 252 253 |
# File 'lib/active_support/time_with_zone.rb', line 251 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.
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"
133 134 135 136 137 138 139 |
# File 'lib/active_support/time_with_zone.rb', line 133 def as_json( = 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 |
#between?(min, max) ⇒ Boolean
193 194 195 |
# File 'lib/active_support/time_with_zone.rb', line 193 def between?(min, max) utc.between?(min, max) end |
#dst? ⇒ Boolean Also known as: isdst
81 82 83 |
# File 'lib/active_support/time_with_zone.rb', line 81 def dst? period.dst? end |
#encode_with(coder) ⇒ Object
141 142 143 144 145 146 147 |
# File '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 |
#eql?(other) ⇒ Boolean
209 210 211 |
# File 'lib/active_support/time_with_zone.rb', line 209 def eql?(other) utc.eql?(other) end |
#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object
97 98 99 |
# File '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 |
#freeze ⇒ Object
310 311 312 313 |
# File 'lib/active_support/time_with_zone.rb', line 310 def freeze period; utc; time # preload instance variables before freezing super end |
#future? ⇒ Boolean
205 206 207 |
# File 'lib/active_support/time_with_zone.rb', line 205 def future? utc.future? end |
#hash ⇒ Object
213 214 215 |
# File 'lib/active_support/time_with_zone.rb', line 213 def hash utc.hash end |
#httpdate ⇒ Object
155 156 157 |
# File 'lib/active_support/time_with_zone.rb', line 155 def httpdate utc.httpdate end |
#in_time_zone(new_zone = ::Time.zone) ⇒ Object
Returns the simultaneous time in Time.zone
, or the specified zone.
70 71 72 73 |
# File '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 |
#inspect ⇒ Object
106 107 108 |
# File 'lib/active_support/time_with_zone.rb', line 106 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.
305 306 307 |
# File 'lib/active_support/time_with_zone.rb', line 305 def is_a?(klass) klass == ::Time || super end |
#localtime ⇒ Object Also known as: getlocal
Returns a Time.local()
instance of the simultaneous time in your system’s ENV['TZ']
zone
76 77 78 |
# File 'lib/active_support/time_with_zone.rb', line 76 def localtime utc.respond_to?(:getlocal) ? utc.getlocal : utc.to_time.getlocal end |
#marshal_dump ⇒ Object
315 316 317 |
# File 'lib/active_support/time_with_zone.rb', line 315 def marshal_dump [utc, time_zone.name, time] end |
#marshal_load(variables) ⇒ Object
319 320 321 |
# File 'lib/active_support/time_with_zone.rb', line 319 def marshal_load(variables) initialize(variables[0].utc, ::Time.find_zone(variables[1]), variables[2].utc) end |
#past? ⇒ Boolean
197 198 199 |
# File 'lib/active_support/time_with_zone.rb', line 197 def past? utc.past? end |
#period ⇒ Object
Returns the underlying TZInfo::TimezonePeriod.
65 66 67 |
# File 'lib/active_support/time_with_zone.rb', line 65 def period @period ||= time_zone.period_for_utc(@utc) end |
#respond_to?(sym, include_priv = false) ⇒ Boolean
Ensure proxy class responds to all methods that underlying time instance responds to.
324 325 326 327 328 |
# File 'lib/active_support/time_with_zone.rb', line 324 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 |
#rfc2822 ⇒ Object Also known as: rfc822
159 160 161 |
# File 'lib/active_support/time_with_zone.rb', line 159 def rfc2822 to_s(:rfc822) end |
#since(other) ⇒ Object
241 242 243 244 245 246 247 248 249 |
# File 'lib/active_support/time_with_zone.rb', line 241 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
and %z
directives with zone
and formatted_offset
, respectively, before passing to Time#strftime, so that zone information is correct
179 180 181 182 183 184 185 186 |
# File 'lib/active_support/time_with_zone.rb', line 179 def strftime(format) format = format.gsub('%Z', zone). gsub('%z', formatted_offset(false)). gsub('%:z', formatted_offset(true)). gsub('%::z', formatted_offset(true) + ":00") time.strftime(format) end |
#time ⇒ Object
Returns a Time or DateTime instance that represents the time in time_zone
.
51 52 53 |
# File 'lib/active_support/time_with_zone.rb', line 51 def time @time ||= period.to_local(@utc) end |
#to_a ⇒ Object
277 278 279 |
# File 'lib/active_support/time_with_zone.rb', line 277 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
295 296 297 |
# File 'lib/active_support/time_with_zone.rb', line 295 def to_datetime utc.to_datetime.new_offset(Rational(utc_offset, 86_400)) end |
#to_f ⇒ Object
281 282 283 |
# File 'lib/active_support/time_with_zone.rb', line 281 def to_f utc.to_f end |
#to_i ⇒ Object Also known as: tv_sec
285 286 287 |
# File 'lib/active_support/time_with_zone.rb', line 285 def to_i utc.to_i end |
#to_s(format = :default) ⇒ Object Also known as: to_formatted_s
:db
format outputs time in UTC; all others output time in local. Uses TimeWithZone’s strftime
, so %Z
and %z
work correctly.
166 167 168 169 170 171 172 173 174 |
# File '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 |
#to_time ⇒ Object
A TimeWithZone acts like a Time, so just return self
.
291 292 293 |
# File 'lib/active_support/time_with_zone.rb', line 291 def to_time utc end |
#to_yaml(options = {}) ⇒ Object
149 150 151 152 153 |
# File 'lib/active_support/time_with_zone.rb', line 149 def to_yaml( = {}) return super if defined?(YAML::ENGINE) && !YAML::ENGINE.syck? utc.to_yaml() end |
#today? ⇒ Boolean
201 202 203 |
# File 'lib/active_support/time_with_zone.rb', line 201 def today? time.today? end |
#usec ⇒ Object
273 274 275 |
# File 'lib/active_support/time_with_zone.rb', line 273 def usec time.respond_to?(:usec) ? time.usec : 0 end |
#utc ⇒ Object Also known as: comparable_time, getgm, getutc, gmtime
Returns a Time or DateTime instance that represents the time in UTC.
56 57 58 |
# File 'lib/active_support/time_with_zone.rb', line 56 def utc @utc ||= period.to_utc(@time) end |
#utc? ⇒ Boolean Also known as: gmt?
86 87 88 |
# File 'lib/active_support/time_with_zone.rb', line 86 def utc? time_zone.name == 'UTC' end |
#utc_offset ⇒ Object Also known as: gmt_offset, gmtoff
91 92 93 |
# File 'lib/active_support/time_with_zone.rb', line 91 def utc_offset period.utc_total_offset end |
#xmlschema(fraction_digits = 0) ⇒ Object Also known as: iso8601
110 111 112 113 114 115 116 |
# File 'lib/active_support/time_with_zone.rb', line 110 def xmlschema(fraction_digits = 0) fraction = if fraction_digits > 0 (".%06i" % time.usec)[0, fraction_digits + 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.
102 103 104 |
# File 'lib/active_support/time_with_zone.rb', line 102 def zone period.zone_identifier.to_s end |