Class: TZInfo::TimezonePeriod

Inherits:
Object
  • Object
show all
Defined in:
lib/tzinfo/timezone_period.rb

Overview

A period of time in a timezone where the same offset from UTC applies.

All the methods that take times accept instances of Time or DateTime as well as Integer timestamps.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(start_transition, end_transition, offset = nil) ⇒ TimezonePeriod

Initializes a new TimezonePeriod.

TimezonePeriod instances should not normally be constructed manually.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/tzinfo/timezone_period.rb', line 43

def initialize(start_transition, end_transition, offset = nil)
  @start_transition = start_transition
  @end_transition = end_transition
  
  if offset
    raise ArgumentError, 'Offset specified with transitions' if @start_transition || @end_transition
    @offset = offset
  else
    if @start_transition 
      @offset = @start_transition.offset
    elsif @end_transition
      @offset = @end_transition.previous_offset
    else
      raise ArgumentError, 'No offset specified and no transitions to determine it from'
    end
  end
  
  @utc_total_offset_rational = nil      
end

Instance Attribute Details

#end_transition ⇒ Object (readonly)

The TimezoneTransition that defines the end of this TimezonePeriod (may be nil if unbounded).



35
36
37
 
# File 'lib/tzinfo/timezone_period.rb', line 35

def end_transition
  @end_transition
end

#offset ⇒ Object (readonly)

The TimezoneOffset for this period.



38
39
40
 
# File 'lib/tzinfo/timezone_period.rb', line 38

def offset
  @offset
end

#start_transition ⇒ Object (readonly)

The TimezoneTransition that defines the start of this TimezonePeriod (may be nil if unbounded).



31
32
33
 
# File 'lib/tzinfo/timezone_period.rb', line 31

def start_transition
  @start_transition
end

Instance Method Details

#==(p) ⇒ Object

Returns true if this TimezonePeriod is equal to p. This compares the start_transition, end_transition and offset using ==.



196
197
198
199
200
201
 
# File 'lib/tzinfo/timezone_period.rb', line 196

def ==(p)
  p.kind_of?(TimezonePeriod) &&
    start_transition == p.start_transition &&
    end_transition == p.end_transition &&
    offset == p.offset
end

#abbreviation ⇒ Object Also known as: zone_identifier

The identifier of this period, e.g. “GMT” (Greenwich Mean Time) or “BST” (British Summer Time) for “Europe/London”. The returned identifier is a symbol.



78
79
80
 
# File 'lib/tzinfo/timezone_period.rb', line 78

def abbreviation
  @offset.abbreviation
end

#dst? ⇒ Boolean

true if daylight savings is in effect for this period; otherwise false.

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/tzinfo/timezone_period.rb', line 146

def dst?
  @offset.dst?
end

#eql?(p) ⇒ Boolean

Returns true if this TimezonePeriods is equal to p. This compares the start_transition, end_transition and offset using eql?

Returns:

  • (Boolean) 


205
206
207
208
209
210
 
# File 'lib/tzinfo/timezone_period.rb', line 205

def eql?(p)
  p.kind_of?(TimezonePeriod) &&
    start_transition.eql?(p.start_transition) &&
    end_transition.eql?(p.end_transition) &&
    offset.eql?(p.offset)
end

#hash ⇒ Object

Returns a hash of this TimezonePeriod.



213
214
215
216
217
 
# File 'lib/tzinfo/timezone_period.rb', line 213

def hash
  result = @start_transition.hash ^ @end_transition.hash
  result ^= @offset.hash unless @start_transition || @end_transition
  result       
end

#inspect ⇒ Object

Returns internal object state as a programmer-readable string.



220
221
222
223
224
 
# File 'lib/tzinfo/timezone_period.rb', line 220

def inspect
  result = "#<#{self.class}: #{@start_transition.inspect},#{@end_transition.inspect}"
  result << ",#{@offset.inspect}>" unless @start_transition || @end_transition
  result + '>'
end

#local_after_start?(local) ⇒ Boolean

true if the given local DateTime is after the start of the period (inclusive); otherwise false.

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/tzinfo/timezone_period.rb', line 174

def local_after_start?(local)
  !@start_transition || @start_transition.local_start_at <= local
end

#local_before_end?(local) ⇒ Boolean

true if the given local DateTime is before the end of the period (exclusive); otherwise false.

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/tzinfo/timezone_period.rb', line 180

def local_before_end?(local)
  !@end_transition || @end_transition.local_end_at > local
end

#local_end ⇒ Object

The end time of the period in local time as a DateTime. May be nil if unbounded.



135
136
137
 
# File 'lib/tzinfo/timezone_period.rb', line 135

def local_end
  @end_transition ? @end_transition.local_end_at.to_datetime : nil
end

#local_end_time ⇒ Object

The end time of the period in local time as a Time. May be nil if unbounded.



141
142
143
 
# File 'lib/tzinfo/timezone_period.rb', line 141

def local_end_time
  @end_transition ? @end_transition.local_end_at.to_time : nil
end

#local_start ⇒ Object

The start time of the period in local time as a DateTime. May be nil if unbounded.



123
124
125
 
# File 'lib/tzinfo/timezone_period.rb', line 123

def local_start
  @start_transition ? @start_transition.local_start_at.to_datetime : nil
end

#local_start_time ⇒ Object

The start time of the period in local time as a Time. May be nil if unbounded.



129
130
131
 
# File 'lib/tzinfo/timezone_period.rb', line 129

def local_start_time
  @start_transition ? @start_transition.local_start_at.to_time : nil
end

#std_offset ⇒ Object

Offset from the local time where daylight savings is in effect (seconds). E.g.: utc_offset could be -5 hours. Normally, std_offset would be 0. During daylight savings, std_offset would typically become +1 hours.



71
72
73
 
# File 'lib/tzinfo/timezone_period.rb', line 71

def std_offset
  @offset.std_offset
end

#to_local(utc) ⇒ Object

Converts a UTC DateTime to local time based on the offset of this period.



185
186
187
 
# File 'lib/tzinfo/timezone_period.rb', line 185

def to_local(utc)
  @offset.to_local(utc)
end

#to_utc(local) ⇒ Object

Converts a local DateTime to UTC based on the offset of this period.



190
191
192
 
# File 'lib/tzinfo/timezone_period.rb', line 190

def to_utc(local)
  @offset.to_utc(local)
end

#utc_after_start?(utc) ⇒ Boolean

true if the given UTC DateTime is after the start of the period (inclusive); otherwise false.

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/tzinfo/timezone_period.rb', line 157

def utc_after_start?(utc)
  !@start_transition || @start_transition.at <= utc
end

#utc_before_end?(utc) ⇒ Boolean

true if the given UTC DateTime is before the end of the period (exclusive); otherwise false.

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/tzinfo/timezone_period.rb', line 163

def utc_before_end?(utc)
  !@end_transition || @end_transition.at > utc
end

#utc_end ⇒ Object

The end time of the period in UTC as a DateTime. May be nil if unbounded.



112
113
114
 
# File 'lib/tzinfo/timezone_period.rb', line 112

def utc_end
  @end_transition ? @end_transition.at.to_datetime : nil
end

#utc_end_time ⇒ Object

The end time of the period in UTC as a Time. May be nil if unbounded.



117
118
119
 
# File 'lib/tzinfo/timezone_period.rb', line 117

def utc_end_time
  @end_transition ? @end_transition.at.to_time : nil
end

#utc_offset ⇒ Object

Base offset of the timezone from UTC (seconds).



64
65
66
 
# File 'lib/tzinfo/timezone_period.rb', line 64

def utc_offset
  @offset.utc_offset
end

#utc_start ⇒ Object

The start time of the period in UTC as a DateTime. May be nil if unbounded.



102
103
104
 
# File 'lib/tzinfo/timezone_period.rb', line 102

def utc_start
  @start_transition ? @start_transition.at.to_datetime : nil
end

#utc_start_time ⇒ Object

The start time of the period in UTC as a Time. May be nil if unbounded.



107
108
109
 
# File 'lib/tzinfo/timezone_period.rb', line 107

def utc_start_time
  @start_transition ? @start_transition.at.to_time : nil
end

#utc_total_offset ⇒ Object

Total offset from UTC (seconds). Equal to utc_offset + std_offset.



84
85
86
 
# File 'lib/tzinfo/timezone_period.rb', line 84

def utc_total_offset
  @offset.utc_total_offset
end

#utc_total_offset_rational ⇒ Object

Total offset from UTC (days). Result is a Rational.



89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/tzinfo/timezone_period.rb', line 89

def utc_total_offset_rational
  # Thread-safey: It is possible that the value of 
  # @utc_total_offset_rational may be calculated multiple times in 
  # concurrently executing threads. It is not worth the overhead of locking
  # to ensure that @zone_identifiers is only calculated once.

  unless @utc_total_offset_rational
    @utc_total_offset_rational = OffsetRationals.rational_for_offset(utc_total_offset) 
  end
  @utc_total_offset_rational
end

#valid_for_local?(local) ⇒ Boolean

true if this period is valid for the given local DateTime; otherwise false.

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/tzinfo/timezone_period.rb', line 168

def valid_for_local?(local)      
  local_after_start?(local) && local_before_end?(local) 
end

#valid_for_utc?(utc) ⇒ Boolean

true if this period is valid for the given UTC DateTime; otherwise false.

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/tzinfo/timezone_period.rb', line 151

def valid_for_utc?(utc)
  utc_after_start?(utc) && utc_before_end?(utc) 
end