Class: TZInfo::TimeOrDateTime

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/tzinfo/time_or_datetime.rb

Overview

Used by TZInfo internally to represent either a Time, DateTime or integer timestamp (seconds since 1970-01-01 00:00:00).

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(timeOrDateTime) ⇒ TimeOrDateTime

Constructs a new TimeOrDateTime. timeOrDateTime can be a Time, DateTime or an integer. If using a Time or DateTime, any time zone information is ignored.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/tzinfo/time_or_datetime.rb', line 36

def initialize(timeOrDateTime)
  @time = nil
  @datetime = nil
  @timestamp = nil
  
  if timeOrDateTime.is_a?(Time)
    @time = timeOrDateTime        
    @time = Time.utc(@time.year, @time.mon, @time.mday, @time.hour, @time.min, @time.sec) unless @time.zone == '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
    @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. to_orig will be called on the result and the result of to_orig will be returned.

timeOrDateTime can be a Time, DateTime, integer timestamp or TimeOrDateTime. If a TimeOrDateTime is passed in, no new TimeOrDateTime will be constructed, the passed in value will be used.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/tzinfo/time_or_datetime.rb', line 255

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.



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/tzinfo/time_or_datetime.rb', line 203

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 timestamps
      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.



220
221
222
 
# File 'lib/tzinfo/time_or_datetime.rb', line 220

def -(seconds)
  self + (-seconds)
end

#<=>(timeOrDateTime) ⇒ Object

Compares this TimeOrDateTime with another Time, DateTime, integer timestamp or TimeOrDateTime. Returns -1, 0 or +1 depending whether the receiver is less than, equal to, or greater than timeOrDateTime.

Milliseconds and smaller units are ignored in the comparison.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/tzinfo/time_or_datetime.rb', line 175

def <=>(timeOrDateTime)
  if timeOrDateTime.is_a?(TimeOrDateTime)            
    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 range).
      to_datetime <=> timeOrDateTime.to_datetime
    elsif orig.is_a?(Time)
      to_time <=> timeOrDateTime.to_time
    else
      to_i <=> timeOrDateTime.to_i
    end        
  elsif @orig.is_a?(DateTime) || timeOrDateTime.is_a?(DateTime)
    # If either is a DateTime, assume it is there for a reason 
    # (i.e. for range).        
    to_datetime <=> TimeOrDateTime.wrap(timeOrDateTime).to_datetime
  elsif timeOrDateTime.is_a?(Time)
    to_time <=> timeOrDateTime
  else
    to_i <=> timeOrDateTime.to_i
  end
end

#add_with_convert(seconds) ⇒ Object

Similar to the + operator, but for cases where adding would cause a timestamp or time to go out of the allowed range, converts to a DateTime based TimeOrDateTime.



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/tzinfo/time_or_datetime.rb', line 227

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 < 0 || result > 2147483647
        result = TimeOrDateTime.new(to_datetime + OffsetRationals.rational_for_offset(seconds))
      else
        result = TimeOrDateTime.new(@orig + seconds)
      end
    end
  end
end

#hour ⇒ Object

Returns the hour of the day (0..23).



138
139
140
141
142
143
144
145
146
 
# File 'lib/tzinfo/time_or_datetime.rb', line 138

def hour
  if !@time.nil?
    @time.hour
  elsif !@datetime.nil?
    @datetime.hour
  else
    to_time.hour
  end
end

#mday ⇒ Object Also known as: day

Returns the day of the month (1..n).



126
127
128
129
130
131
132
133
134
 
# File 'lib/tzinfo/time_or_datetime.rb', line 126

def mday
  if !@time.nil?
    @time.mday
  elsif !@datetime.nil?
    @datetime.mday
  else
    to_time.mday
  end
end

#min ⇒ Object

Returns the minute of the hour (0..59).



149
150
151
152
153
154
155
156
157
 
# File 'lib/tzinfo/time_or_datetime.rb', line 149

def min
  if !@time.nil?
    @time.min
  elsif !@datetime.nil?
    @datetime.min
  else
    to_time.min
  end
end

#mon ⇒ Object Also known as: month

Returns the month of the year (1..12).



114
115
116
117
118
119
120
121
122
 
# File 'lib/tzinfo/time_or_datetime.rb', line 114

def mon
  if !@time.nil?
    @time.mon
  elsif !@datetime.nil?
    @datetime.mon
  else
    to_time.mon
  end
end

#sec ⇒ Object

Returns the second of the minute (0..60). (60 for a leap second).



160
161
162
163
164
165
166
167
168
 
# File 'lib/tzinfo/time_or_datetime.rb', line 160

def sec
  if !@time.nil?
    @time.sec
  elsif !@datetime.nil?
    @datetime.sec
  else
    to_time.sec
  end
end

#to_datetime ⇒ Object

Returns the time as a DateTime.



69
70
71
72
73
74
75
 
# File 'lib/tzinfo/time_or_datetime.rb', line 69

def to_datetime
  if @datetime.nil?
    @datetime = DateTime.new(year, mon, mday, hour, min, sec)
  end
  
  @datetime
end

#to_i ⇒ Object

Returns the time as an integer timestamp.



78
79
80
81
82
83
84
 
# File 'lib/tzinfo/time_or_datetime.rb', line 78

def to_i
  if @timestamp.nil?
    @timestamp = to_time.to_i
  end
  
  @timestamp
end

#to_orig ⇒ Object

Returns the time as the original time passed to new.



87
88
89
 
# File 'lib/tzinfo/time_or_datetime.rb', line 87

def to_orig
  @orig
end

#to_s ⇒ Object

Returns a string representation of the TimeOrDateTime.



92
93
94
95
96
97
98
99
100
 
# File 'lib/tzinfo/time_or_datetime.rb', line 92

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.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/tzinfo/time_or_datetime.rb', line 56

def to_time
  if @time.nil?        
    if !@timestamp.nil? 
      @time = Time.at(@timestamp).utc
    else
      @time = Time.utc(year, mon, mday, hour, min, sec)
    end
  end
  
  @time      
end

#year ⇒ Object

Returns the year.



103
104
105
106
107
108
109
110
111
 
# File 'lib/tzinfo/time_or_datetime.rb', line 103

def year
  if !@time.nil?
    @time.year
  elsif !@datetime.nil?
    @datetime.year
  else
    to_time.year
  end
end