tzinfo 0.2.2 → 0.3.0

data/lib/tzinfo/timezone_definition.rb

@@ -0,0 +1,56 @@
+#--
+# Copyright (c) 2006 Philip Ross
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++
+
+require 'tzinfo/data_timezone_info'
+require 'tzinfo/linked_timezone_info'
+
+module TZInfo
+  
+  # TimezoneDefinition is included into Timezone definition modules.
+  # TimezoneDefinition provides the methods for defining timezones.
+  module TimezoneDefinition #:nodoc:
+    # Add class methods to the includee.
+    def self.append_features(base)
+      super
+      base.extend(ClassMethods)
+    end
+    
+    # Class methods for inclusion.
+    module ClassMethods #:nodoc:
+      # Returns and yields a DataTimezoneInfo object to define a timezone.
+      def timezone(identifier)
+        yield @timezone = DataTimezoneInfo.new(identifier)
+      end
+      
+      # Defines a linked timezone.
+      def linked_timezone(identifier, link_to_identifier)
+        @timezone = LinkedTimezoneInfo.new(identifier, link_to_identifier)
+      end
+      
+      # Returns the last TimezoneInfo to be defined with timezone or 
+      # linked_timezone.
+      def get
+        @timezone
+      end
+    end
+  end
+end

data/lib/tzinfo/timezone_index_definition.rb

@@ -0,0 +1,72 @@
+#--
+# Copyright (c) 2006 Philip Ross
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++
+
+module TZInfo
+  # The timezone index file includes TimezoneIndexDefinition which provides
+  # methods used to define timezones in the index.
+  module TimezoneIndexDefinition #:nodoc:
+    def self.append_features(base)
+      super
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods #:nodoc:
+      # Defines a timezone based on data.
+      def timezone(identifier)
+        @timezones = [] unless @timezones
+        @data_timezones = [] unless @data_timezones
+        @timezones << identifier
+        @data_timezones << identifier
+      end
+      
+      # Defines a timezone which is a link to another timezone.
+      def linked_timezone(identifier)
+        @timezones = [] unless @timezones
+        @linked_timezones = [] unless @linked_timezones
+        @timezones << identifier
+        @linked_timezones << identifier
+      end
+      
+      # Returns a frozen array containing the identifiers of all the timezones.
+      # Identifiers appear in the order they were defined in the index.
+      def timezones
+        @timezones = [] unless @timezones
+        @timezones.freeze
+      end
+      
+      # Returns a frozen array containing the identifiers of all data timezones.
+      # Identifiers appear in the order they were defined in the index.
+      def data_timezones
+        @data_timezones = [] unless @data_timezones
+        @data_timezones.freeze
+      end
+      
+      # Returns a frozen array containing the identifiers of all linked
+      # timezones. Identifiers appear in the order they were defined in 
+      # the index.
+      def linked_timezones
+        @linked_timezones = [] unless @linked_timezones
+        @linked_timezones.freeze
+      end      
+    end
+  end
+end

data/lib/tzinfo/timezone_info.rb

@@ -0,0 +1,40 @@
+#--
+# Copyright (c) 2006 Philip Ross
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++
+
+module TZInfo
+  # Represents a timezone defined in a data module.
+  class TimezoneInfo #:nodoc:
+    
+    # The timezone identifier.
+    attr_reader :identifier
+    
+    # Constructs a new TimezoneInfo with an identifier.
+    def initialize(identifier)
+      @identifier = identifier
+    end
+    
+    # Returns internal object state as a programmer-readable string.
+    def inspect
+      "#<#{self.class}: #@identifier>"
+    end
+  end
+end

data/lib/tzinfo/timezone_offset_info.rb

@@ -0,0 +1,94 @@
+#--
+# Copyright (c) 2006 Philip Ross
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++
+
+module TZInfo
+  # Represents an offset defined in a Timezone data file.
+  class TimezoneOffsetInfo #:nodoc:
+    # The base offset of the timezone from UTC in seconds.
+    attr_reader :utc_offset
+    
+    # The offset from standard time for the zone in seconds (i.e. non-zero if 
+    # daylight savings is being observed).
+    attr_reader :std_offset
+    
+    # The total offset of this observance from UTC in seconds 
+    # (utc_offset + std_offset).
+    attr_reader :utc_total_offset
+    
+    # The abbreviation that identifies this observance, e.g. "GMT" 
+    # (Greenwich Mean Time) or "BST" (British Summer Time) for "Europe/London". The returned identifier is a 
+    # symbol.
+    attr_reader :abbreviation
+    
+    # Constructs a new TimezoneOffsetInfo. utc_offset and std_offset are
+    # specified in seconds.
+    def initialize(utc_offset, std_offset, abbreviation)
+      @utc_offset = utc_offset
+      @std_offset = std_offset      
+      @abbreviation = abbreviation
+      
+      @utc_total_offset = @utc_offset + @std_offset
+    end
+    
+    # True if std_offset is non-zero.
+    def dst?
+      @std_offset != 0
+    end
+    
+    # Converts a UTC DateTime to local time based on the offset of this period.
+    def to_local(utc)
+      TimeOrDateTime.wrap(utc) {|utc|
+        utc + @utc_total_offset
+      }
+    end
+    
+    # Converts a local DateTime to UTC based on the offset of this period.
+    def to_utc(local)
+      TimeOrDateTime.wrap(local) {|local|
+        local - @utc_total_offset
+      }
+    end
+    
+    # Returns true if and only if toi has the same utc_offset, std_offset
+    # and abbreviation as this TimezoneOffsetInfo.
+    def ==(toi)
+      toi.respond_to?(:utc_offset) && toi.respond_to?(:std_offset) && toi.respond_to?(:abbreviation) &&
+        utc_offset == toi.utc_offset && std_offset == toi.std_offset && abbreviation == toi.abbreviation
+    end
+    
+    # Returns true if and only if toi has the same utc_offset, std_offset
+    # and abbreviation as this TimezoneOffsetInfo.
+    def eql?(toi)
+      self == toi
+    end
+    
+    # Returns a hash of this TimezoneOffsetInfo.
+    def hash
+      utc_offset.hash ^ std_offset.hash ^ abbreviation.hash
+    end
+    
+    # Returns internal object state as a programmer-readable string.
+    def inspect
+      "#<#{self.class}: #@utc_offset,#@std_offset,#@abbreviation>"
+    end
+  end
+end

data/lib/tzinfo/timezone_period.rb

@@ -20,6 +20,8 @@
 # THE SOFTWARE.
 #++
 
+# TODO: Turn this into the real TimezonePeriod.
+
 require 'tzinfo/offset_rationals'
 require 'tzinfo/time_or_datetime'
 
@@ -29,86 +31,113 @@ module TZInfo
   # All the methods that take times accept instances of Time, DateTime or
   # integer timestamps.
   class TimezonePeriod
-
+    # The TimezoneTransitionInfo that defines the start of this TimezonePeriod 
+    # (may be nil if unbounded).
+    attr_reader :start_transition
+    
+    # The TimezoneTransitionInfo that defines the end of this TimezonePeriod
+    # (may be nil if unbounded).
+    attr_reader :end_transition
+    
+    # The TimezoneOffsetInfo for this period.
+    attr_reader :offset    
+    
+    # Initializes a new TimezonePeriod.
+    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
+            
     # Base offset of the timezone from UTC (seconds).
-    attr_reader :utc_offset
+    def utc_offset
+      @offset.utc_offset
+    end
     
     # 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 become +1 hours.
-    attr_reader :std_offset
+    # During daylight savings, std_offset would typically become +1 hours.
+    def std_offset
+      @offset.std_offset
+    end
     
     # 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.
-    attr_reader :zone_identifier 
-    alias :abbreviation :zone_identifier
+    def abbreviation
+      @offset.abbreviation
+    end
+    alias :zone_identifier :abbreviation
     
     # Total offset from UTC (seconds). Equal to utc_offset + std_offset.
-    attr_reader :utc_total_offset
-    
-    # Initializes a new TimezonePeriod.
-    def initialize(utc_start, utc_end, utc_offset, std_offset, zone_identifier)
-      @utc_start = utc_start.nil? ? nil : TimeOrDateTime.wrap(utc_start)
-      @utc_end = utc_end.nil? ? nil : TimeOrDateTime.wrap(utc_end)
-      @utc_offset = utc_offset
-      @std_offset = std_offset
-      @zone_identifier = zone_identifier
-      @utc_total_offset = utc_offset + std_offset
-      @utc_total_offset_rational = nil
-              
-      # Use add_with_convert to use DateTime based TimeOrDateTimes if we run
-      # off the range of Time.
-      @local_start = @utc_start.nil? ? nil : @utc_start.add_with_convert(@utc_total_offset)
-      @local_end = @utc_end.nil? ? nil : @utc_end.add_with_convert(@utc_total_offset)             
+    def utc_total_offset
+      @offset.utc_total_offset
     end
-            
+    
     # Total offset from UTC (days). Result is a Rational.
     def utc_total_offset_rational
-      if @utc_total_offset_rational.nil?
-        @utc_total_offset_rational = OffsetRationals.rational_for_offset(@utc_total_offset) 
+      unless @utc_total_offset_rational
+        @utc_total_offset_rational = OffsetRationals.rational_for_offset(utc_total_offset) 
       end
       @utc_total_offset_rational
     end
     
-    # Start time of the period (UTC). May be nil if unbounded.
+    # The start time of the period in UTC as a DateTime. May be nil if unbounded.
     def utc_start
-      @utc_start.nil? ? nil : @utc_start.to_datetime
+      @start_transition ? @start_transition.at.to_datetime : nil
     end
     
-    # End time of the period (UTC). May be nil if unbounded.
+    # The end time of the period in UTC as a DateTime. May be nil if unbounded.
     def utc_end
-      @utc_end.nil? ? nil : @utc_end.to_datetime
+      @end_transition ? @end_transition.at.to_datetime : nil
     end
     
-    # Start time of the period (local time). May be nil if unbounded.
+    # The start time of the period in local time as a DateTime. May be nil if 
+    # unbounded.
     def local_start
-      @local_start.nil? ? nil : @local_start.to_datetime
+      @start_transition ? @start_transition.local_start.to_datetime : nil
     end
     
-    # End time of the period (local time). May be nil if unbounded.
+    # The end time of the period in local time as a DateTime. May be nil if 
+    # unbounded.
     def local_end
-      @local_end.nil? ? nil : @local_end.to_datetime
+      @end_transition ? @end_transition.local_end.to_datetime : nil
     end
     
     # true if daylight savings is in effect for this period; otherwise false.
     def dst?
-      std_offset != 0
+      @offset.dst?
     end
     
-    # true if this period is valid for the given utc DateTime; otherwise false.
+    # true if this period is valid for the given UTC DateTime; otherwise false.
     def valid_for_utc?(utc)
       utc_after_start?(utc) && utc_before_end?(utc) 
     end
     
-    # true if the given utc DateTime is after the start of the period (inclusive); otherwise false.
-    def utc_after_start?(utc)                
-      @utc_start.nil? || @utc_start <= utc
+    # true if the given UTC DateTime is after the start of the period 
+    # (inclusive); otherwise false.
+    def utc_after_start?(utc)
+      !@start_transition || @start_transition.at <= utc
     end
     
-    # true if the given utc DateTime is before the end of the period (exclusive); otherwise false.
-    def utc_before_end?(utc)           
-      @utc_end.nil? || @utc_end > utc
+    # true if the given UTC DateTime is before the end of the period 
+    # (exclusive); otherwise false.
+    def utc_before_end?(utc)
+      !@end_transition || @end_transition.at > utc
     end
     
     # true if this period is valid for the given local DateTime; otherwise false.
@@ -116,28 +145,56 @@ module TZInfo
       local_after_start?(local) && local_before_end?(local) 
     end
     
-    # true if the given local DateTime is after the start of the period (inclusive); otherwise false.
-    def local_after_start?(local)                
-      @local_start.nil? || @local_start <= local
+    # true if the given local DateTime is after the start of the period 
+    # (inclusive); otherwise false.
+    def local_after_start?(local)
+      !@start_transition || @start_transition.local_start <= local
     end
     
-    # true if the given local DateTime is before the end of the period (exclusive); otherwise false.
-    def local_before_end?(local)               
-      @local_end.nil? || @local_end > local
+    # true if the given local DateTime is before the end of the period 
+    # (exclusive); otherwise false.
+    def local_before_end?(local)
+      !@end_transition || @end_transition.local_end > local
     end
     
     # Converts a UTC DateTime to local time based on the offset of this period.
     def to_local(utc)
-      TimeOrDateTime.wrap(utc) {|utc|
-        utc + utc_total_offset
-      }
+      @offset.to_local(utc)
     end
     
     # Converts a local DateTime to UTC based on the offset of this period.
     def to_utc(local)
-      TimeOrDateTime.wrap(local) {|local|
-        local - utc_total_offset
-      }
+      @offset.to_utc(local)
+    end
+    
+    # Returns true if this TimezonePeriod is equal to p. This compares the 
+    # start_transition, end_transition and offset using ==.
+    def ==(p)
+      p.respond_to?(:start_transition) && p.respond_to?(:end_transition) &&
+        p.respond_to?(:offset) && start_transition == p.start_transition &&
+        end_transition == p.end_transition && offset == p.offset
+    end
+    
+    # Returns true if this TimezonePeriods is equal to p. This compares the
+    # start_transition, end_transition and offset using eql?
+    def eql?(p)
+      p.respond_to?(:start_transition) && p.respond_to?(:end_transition) &&
+        p.respond_to?(:offset) && start_transition.eql?(p.start_transition) &&
+        end_transition.eql?(p.end_transition) && offset.eql?(p.offset)
+    end
+    
+    # Returns a hash of this TimezonePeriod.
+    def hash
+      result = @start_transition.hash ^ @end_transition.hash
+      result ^= @offset.hash unless @start_transition || @end_transition
+      result       
+    end
+    
+    # Returns internal object state as a programmer-readable string.
+    def inspect
+      result = "#<#{self.class}: #{@start_transition.inspect},#{@end_transition.inspect}"
+      result << ",#{@offset.inspect}>" unless @start_transition || @end_transition
+      result + '>'
     end
   end
 end