Class: TZInfo::TimeOrDateTime
- Inherits:
-
Object
- Object
- TZInfo::TimeOrDateTime
- Includes:
- Comparable
- Defined in:
- lib/tzinfo/time_or_datetime.rb
Overview
Used by TZInfo internally to represent either a Time, DateTime or an Integer timestamp (seconds since 1970-01-01 00:00:00).
Class Method Summary collapse
-
.wrap(timeOrDateTime) ⇒ Object
If no block is given, returns a TimeOrDateTime wrapping the given timeOrDateTime.
Instance Method Summary collapse
-
#+(seconds) ⇒ Object
Adds a number of seconds to the TimeOrDateTime.
-
#-(seconds) ⇒ Object
Subtracts a number of seconds from the TimeOrDateTime.
-
#<=>(timeOrDateTime) ⇒ Object
Compares this TimeOrDateTime with another Time, DateTime, timestamp (Integer) or TimeOrDateTime.
-
#add_with_convert(seconds) ⇒ Object
Similar to the + operator, but converts to a DateTime based TimeOrDateTime where the Time or Integer timestamp to go out of the allowed range for a Time, converts to a DateTime based TimeOrDateTime.
-
#eql?(todt) ⇒ Boolean
Returns true if todt represents the same time and was originally constructed with the same type (DateTime, Time or timestamp) as this TimeOrDateTime.
-
#hash ⇒ Object
Returns a hash of this TimeOrDateTime.
-
#hour ⇒ Object
Returns the hour of the day (0..23).
-
#initialize(timeOrDateTime) ⇒ TimeOrDateTime
constructor
Constructs a new TimeOrDateTime.
-
#inspect ⇒ Object
Returns internal object state as a programmer-readable string.
-
#mday ⇒ Object
(also: #day)
Returns the day of the month (1..n).
-
#min ⇒ Object
Returns the minute of the hour (0..59).
-
#mon ⇒ Object
(also: #month)
Returns the month of the year (1..12).
-
#sec ⇒ Object
Returns the second of the minute (0..60).
-
#to_datetime ⇒ Object
Returns the time as a DateTime.
-
#to_i ⇒ Object
Returns the time as an integer timestamp.
-
#to_orig ⇒ Object
Returns the time as the original time passed to new.
-
#to_s ⇒ Object
Returns a string representation of the TimeOrDateTime.
-
#to_time ⇒ Object
Returns the time as a Time.
-
#usec ⇒ Object
Returns the number of microseconds for the time.
-
#wday ⇒ Object
Returns the day of the week (0..6 for Sunday to Saturday).
-
#year ⇒ Object
Returns the year.
Constructor Details
#initialize(timeOrDateTime) ⇒ TimeOrDateTime
Constructs a new TimeOrDateTime. timeOrDateTime can be a Time, DateTime or Integer. If using a Time or DateTime, any time zone information is ignored.
Integer timestamps must be within the range supported by Time on the platform being used.
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/tzinfo/time_or_datetime.rb', line 17 def initialize(timeOrDateTime) @time = nil @datetime = nil @timestamp = nil if timeOrDateTime.is_a?(Time) @time = timeOrDateTime # Avoid using the slower Rational class unless necessary. nsec = RubyCoreSupport.time_nsec(@time) usec = nsec % 1000 == 0 ? nsec / 1000 : Rational(nsec, 1000) @time = Time.utc(@time.year, @time.mon, @time.mday, @time.hour, @time.min, @time.sec, usec) unless @time.utc? @orig = @time elsif timeOrDateTime.is_a?(DateTime) @datetime = timeOrDateTime @datetime = @datetime.new_offset(0) unless @datetime.offset == 0 @orig = @datetime else @timestamp = timeOrDateTime.to_i if !RubyCoreSupport.time_supports_64bit && (@timestamp > 2147483647 || @timestamp < -2147483648 || (@timestamp < 0 && !RubyCoreSupport.time_supports_negative)) raise RangeError, 'Timestamp is outside the supported range of Time on this platform' end @orig = @timestamp end end |
Class Method Details
.wrap(timeOrDateTime) ⇒ Object
If no block is given, returns a TimeOrDateTime wrapping the given timeOrDateTime. If a block is specified, a TimeOrDateTime is constructed and passed to the block. The result of the block must be a TimeOrDateTime.
The result of the block will be converted to the type of the originally passed in timeOrDateTime and then returned as the result of wrap.
timeOrDateTime can be a Time, DateTime, timestamp (Integer) or TimeOrDateTime. If a TimeOrDateTime is passed in, no new TimeOrDateTime will be constructed and the value passed to wrap will be used when calling the block.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/tzinfo/time_or_datetime.rb', line 331 def self.wrap(timeOrDateTime) t = timeOrDateTime.is_a?(TimeOrDateTime) ? timeOrDateTime : TimeOrDateTime.new(timeOrDateTime) if block_given? t = yield t if timeOrDateTime.is_a?(TimeOrDateTime) t elsif timeOrDateTime.is_a?(Time) t.to_time elsif timeOrDateTime.is_a?(DateTime) t.to_datetime else t.to_i end else t end end |
Instance Method Details
#+(seconds) ⇒ Object
Adds a number of seconds to the TimeOrDateTime. Returns a new TimeOrDateTime, preserving what the original constructed type was. If the original type is a Time and the resulting calculation goes out of range for Times, then an exception will be raised by the Time class.
263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/tzinfo/time_or_datetime.rb', line 263 def +(seconds) if seconds == 0 self else if @orig.is_a?(DateTime) TimeOrDateTime.new(@orig + OffsetRationals.rational_for_offset(seconds)) else # + defined for Time and Integer TimeOrDateTime.new(@orig + seconds) end end end |
#-(seconds) ⇒ Object
Subtracts a number of seconds from the TimeOrDateTime. Returns a new TimeOrDateTime, preserving what the original constructed type was. If the original type is a Time and the resulting calculation goes out of range for Times, then an exception will be raised by the Time class.
280 281 282 |
# File 'lib/tzinfo/time_or_datetime.rb', line 280 def -(seconds) self + (-seconds) end |
#<=>(timeOrDateTime) ⇒ Object
Compares this TimeOrDateTime with another Time, DateTime, timestamp (Integer) or TimeOrDateTime. Returns -1, 0 or +1 depending whether the receiver is less than, equal to, or greater than timeOrDateTime.
Returns nil if the passed in timeOrDateTime is not comparable with TimeOrDateTime instances.
Comparisons involving a DateTime will be performed using DateTime#<=>. Comparisons that don’t involve a DateTime, but include a Time will be performed with Time#<=>. Otherwise comparisons will be performed with Integer#<=>.
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/tzinfo/time_or_datetime.rb', line 236 def <=>(timeOrDateTime) return nil unless timeOrDateTime.is_a?(TimeOrDateTime) || timeOrDateTime.is_a?(Time) || timeOrDateTime.is_a?(DateTime) || timeOrDateTime.respond_to?(:to_i) unless timeOrDateTime.is_a?(TimeOrDateTime) timeOrDateTime = TimeOrDateTime.wrap(timeOrDateTime) end orig = timeOrDateTime.to_orig if @orig.is_a?(DateTime) || orig.is_a?(DateTime) # If either is a DateTime, assume it is there for a reason # (i.e. for its larger range of acceptable values on 32-bit systems). to_datetime <=> timeOrDateTime.to_datetime elsif @orig.is_a?(Time) || orig.is_a?(Time) to_time <=> timeOrDateTime.to_time else to_i <=> timeOrDateTime.to_i end end |
#add_with_convert(seconds) ⇒ Object
Similar to the + operator, but converts to a DateTime based TimeOrDateTime where the Time or Integer timestamp to go out of the allowed range for a Time, converts to a DateTime based TimeOrDateTime.
Note that the range of Time varies based on the platform.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/tzinfo/time_or_datetime.rb', line 289 def add_with_convert(seconds) if seconds == 0 self else if @orig.is_a?(DateTime) TimeOrDateTime.new(@orig + OffsetRationals.rational_for_offset(seconds)) else # A Time or timestamp. result = to_i + seconds if ((result > 2147483647 || result < -2147483648) && !RubyCoreSupport.time_supports_64bit) || (result < 0 && !RubyCoreSupport.time_supports_negative) result = TimeOrDateTime.new(to_datetime + OffsetRationals.rational_for_offset(seconds)) else result = TimeOrDateTime.new(@orig + seconds) end end end end |
#eql?(todt) ⇒ Boolean
Returns true if todt represents the same time and was originally constructed with the same type (DateTime, Time or timestamp) as this TimeOrDateTime.
311 312 313 |
# File 'lib/tzinfo/time_or_datetime.rb', line 311 def eql?(todt) todt.kind_of?(TimeOrDateTime) && to_orig.eql?(todt.to_orig) end |
#hash ⇒ Object
Returns a hash of this TimeOrDateTime.
316 317 318 |
# File 'lib/tzinfo/time_or_datetime.rb', line 316 def hash @orig.hash end |
#hour ⇒ Object
Returns the hour of the day (0..23).
176 177 178 179 180 181 182 183 184 |
# File 'lib/tzinfo/time_or_datetime.rb', line 176 def hour if @time @time.hour elsif @datetime @datetime.hour else to_time.hour end end |
#inspect ⇒ Object
Returns internal object state as a programmer-readable string.
125 126 127 |
# File 'lib/tzinfo/time_or_datetime.rb', line 125 def inspect "#<#{self.class}: #{@orig.inspect}>" end |
#mday ⇒ Object Also known as: day
Returns the day of the month (1..n).
153 154 155 156 157 158 159 160 161 |
# File 'lib/tzinfo/time_or_datetime.rb', line 153 def mday if @time @time.mday elsif @datetime @datetime.mday else to_time.mday end end |
#min ⇒ Object
Returns the minute of the hour (0..59).
187 188 189 190 191 192 193 194 195 |
# File 'lib/tzinfo/time_or_datetime.rb', line 187 def min if @time @time.min elsif @datetime @datetime.min else to_time.min end end |
#mon ⇒ Object Also known as: month
Returns the month of the year (1..12).
141 142 143 144 145 146 147 148 149 |
# File 'lib/tzinfo/time_or_datetime.rb', line 141 def mon if @time @time.mon elsif @datetime @datetime.mon else to_time.mon end end |
#sec ⇒ Object
Returns the second of the minute (0..60). (60 for a leap second).
198 199 200 201 202 203 204 205 206 |
# File 'lib/tzinfo/time_or_datetime.rb', line 198 def sec if @time @time.sec elsif @datetime @datetime.sec else to_time.sec end end |
#to_datetime ⇒ Object
Returns the time as a DateTime.
When converting from a Time, the result is truncated to microsecond precision.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/tzinfo/time_or_datetime.rb', line 74 def to_datetime # Thread-safety: It is possible that the value of @datetime may be # calculated multiple times in concurrently executing threads. It is not # worth the overhead of locking to ensure that @datetime is only # calculated once. unless @datetime # Avoid using Rational unless necessary. u = usec s = u == 0 ? sec : Rational(sec * 1000000 + u, 1000000) result = RubyCoreSupport.datetime_new(year, mon, mday, hour, min, s) return result if frozen? @datetime = result end @datetime end |
#to_i ⇒ Object
Returns the time as an integer timestamp.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/tzinfo/time_or_datetime.rb', line 93 def to_i # Thread-safety: It is possible that the value of @timestamp may be # calculated multiple times in concurrently executing threads. It is not # worth the overhead of locking to ensure that @timestamp is only # calculated once. unless @timestamp result = to_time.to_i return result if frozen? @timestamp = result end @timestamp end |
#to_orig ⇒ Object
Returns the time as the original time passed to new.
109 110 111 |
# File 'lib/tzinfo/time_or_datetime.rb', line 109 def to_orig @orig end |
#to_s ⇒ Object
Returns a string representation of the TimeOrDateTime.
114 115 116 117 118 119 120 121 122 |
# File 'lib/tzinfo/time_or_datetime.rb', line 114 def to_s if @orig.is_a?(Time) "Time: #{@orig.to_s}" elsif @orig.is_a?(DateTime) "DateTime: #{@orig.to_s}" else "Timestamp: #{@orig.to_s}" end end |
#to_time ⇒ Object
Returns the time as a Time.
When converting from a DateTime, the result is truncated to microsecond precision.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/tzinfo/time_or_datetime.rb', line 50 def to_time # Thread-safety: It is possible that the value of @time may be # calculated multiple times in concurrently executing threads. It is not # worth the overhead of locking to ensure that @time is only # calculated once. unless @time result = if @timestamp Time.at(@timestamp).utc else Time.utc(year, mon, mday, hour, min, sec, usec) end return result if frozen? @time = result end @time end |
#usec ⇒ Object
Returns the number of microseconds for the time.
209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/tzinfo/time_or_datetime.rb', line 209 def usec if @time @time.usec elsif @datetime # Ruby 1.8 has sec_fraction (of which the documentation says # 'I do NOT recommend you to use this method'). sec_fraction no longer # exists in Ruby 1.9. # Calculate the sec_fraction from the day_fraction. ((@datetime.day_fraction - OffsetRationals.rational_for_offset(@datetime.hour * 3600 + @datetime.min * 60 + @datetime.sec)) * 86400000000).to_i else 0 end end |
#wday ⇒ Object
Returns the day of the week (0..6 for Sunday to Saturday).
165 166 167 168 169 170 171 172 173 |
# File 'lib/tzinfo/time_or_datetime.rb', line 165 def wday if @time @time.wday elsif @datetime @datetime.wday else to_time.wday end end |
#year ⇒ Object
Returns the year.
130 131 132 133 134 135 136 137 138 |
# File 'lib/tzinfo/time_or_datetime.rb', line 130 def year if @time @time.year elsif @datetime @datetime.year else to_time.year end end |