-
Notifications
You must be signed in to change notification settings - Fork 100
/
time_or_datetime.rb
351 lines (309 loc) · 10.7 KB
/
time_or_datetime.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
require 'date'
require 'rational' unless defined?(Rational)
require 'time'
module TZInfo
# Used by TZInfo internally to represent either a Time, DateTime or
# an Integer timestamp (seconds since 1970-01-01 00:00:00).
class TimeOrDateTime
include Comparable
# 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.
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
# Returns the time as a Time.
#
# When converting from a DateTime, the result is truncated to microsecond
# precision.
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
# Returns the time as a DateTime.
#
# When converting from a Time, the result is truncated to microsecond
# precision.
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
# Returns the time as an integer timestamp.
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
# Returns the time as the original time passed to new.
def to_orig
@orig
end
# Returns a string representation of the TimeOrDateTime.
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
# Returns internal object state as a programmer-readable string.
def inspect
"#<#{self.class}: #{@orig.inspect}>"
end
# Returns the year.
def year
if @time
@time.year
elsif @datetime
@datetime.year
else
to_time.year
end
end
# Returns the month of the year (1..12).
def mon
if @time
@time.mon
elsif @datetime
@datetime.mon
else
to_time.mon
end
end
alias :month :mon
# Returns the day of the month (1..n).
def mday
if @time
@time.mday
elsif @datetime
@datetime.mday
else
to_time.mday
end
end
alias :day :mday
# Returns the day of the week (0..6 for Sunday to Saturday).
def wday
if @time
@time.wday
elsif @datetime
@datetime.wday
else
to_time.wday
end
end
# Returns the hour of the day (0..23).
def hour
if @time
@time.hour
elsif @datetime
@datetime.hour
else
to_time.hour
end
end
# Returns the minute of the hour (0..59).
def min
if @time
@time.min
elsif @datetime
@datetime.min
else
to_time.min
end
end
# Returns the second of the minute (0..60). (60 for a leap second).
def sec
if @time
@time.sec
elsif @datetime
@datetime.sec
else
to_time.sec
end
end
# Returns the number of microseconds for the time.
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
# 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#<=>.
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
# 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.
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
# 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.
def -(seconds)
self + (-seconds)
end
# 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.
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
# Returns true if todt represents the same time and was originally
# constructed with the same type (DateTime, Time or timestamp) as this
# TimeOrDateTime.
def eql?(todt)
todt.kind_of?(TimeOrDateTime) && to_orig.eql?(todt.to_orig)
end
# Returns a hash of this TimeOrDateTime.
def hash
@orig.hash
end
# 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.
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
end
end