tzinfo 0.2.2 → 0.3.0

data/lib/tzinfo/country_timezone.rb

@@ -0,0 +1,103 @@
+#--
+# 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/timezone'
+
+module TZInfo
+  # A Timezone within a Country. This contains extra information about the
+  # Timezone that is specific to the Country (a Timezone could be used by
+  # multiple countries).
+  class CountryTimezone
+    # The zone identifier.
+    attr_reader :identifier      
+    
+    # A description of this timezone in relation to the country, e.g. 
+    # "Eastern Time". This is usually nil for countries having only a single
+    # Timezone.
+    attr_reader :description
+    
+    # Creates a new CountryTimezone with a timezone identifier, latitude,
+    # longitude and description. The latitude and longitude are specified as
+    # rationals - a numerator and denominator. For performance reasons, the 
+    # numerators and denominators must be specified in their lowest form.
+    #
+    # CountryTimezone instances should not normally be constructed manually.
+    def initialize(identifier, latitude_numerator, latitude_denominator, 
+                   longitude_numerator, longitude_denominator, description = nil) #:nodoc:
+      @identifier = identifier
+      @latitude_numerator = latitude_numerator
+      @latitude_denominator = latitude_denominator
+      @longitude_numerator = longitude_numerator
+      @longitude_denominator = longitude_denominator      
+      @description = description
+    end
+    
+    # The Timezone (actually a TimezoneProxy for performance reasons).
+    def timezone
+      Timezone.get_proxy(@identifier)
+    end
+    
+    # if description is not nil, this method returns description; otherwise it
+    # returns timezone.friendly_identifier(true).
+    def description_or_friendly_identifier
+      description || timezone.friendly_identifier(true)
+    end
+    
+    # The latitude of this timezone in degrees as a Rational.
+    def latitude
+      @latitude ||= Rational.new!(@latitude_numerator, @latitude_denominator)
+    end
+    
+    # The longitude of this timezone in degrees as a Rational.
+    def longitude
+      @longitude ||= Rational.new!(@longitude_numerator, @longitude_denominator)
+    end
+    
+    # Returns true if and only if the given CountryTimezone is equal to the
+    # current CountryTimezone (has the same identifer, latitude, longitude
+    # and description).
+    def ==(ct)
+      ct.respond_to?(:identifier) && ct.respond_to?(:latitude) &&
+      ct.respond_to?(:longitude)  && ct.respond_to?(:description) &&
+      identifier == ct.identifier  && latitude == ct.latitude &&
+      longitude == ct.longitude   && description == ct.description         
+    end
+            
+    # Returns true if and only if the given CountryTimezone is equal to the
+    # current CountryTimezone (has the same identifer, latitude, longitude
+    # and description).
+    def eql?(ct)
+      self == ct
+    end
+    
+    # Returns a hash of this CountryTimezone. 
+    def hash
+      @identifier.hash ^ @latitude_numerator.hash ^ @latitude_denominator.hash ^ 
+        @longitude_numerator.hash ^ @longitude_denominator.hash ^ @description.hash
+    end
+    
+    # Returns internal object state as a programmer-readable string.
+    def inspect
+      "#<#{self.class}: #@identifier>"
+    end
+  end
+end

data/lib/tzinfo/data_timezone.rb

@@ -0,0 +1,47 @@
+#--
+# 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/info_timezone'
+
+module TZInfo
+
+  # A Timezone based on a DataTimezoneInfo.
+  class DataTimezone < InfoTimezone #:nodoc:
+    
+    # Returns the TimezonePeriod for the given UTC time. utc can either be
+    # a DateTime, Time or integer timestamp (Time.to_i). Any timezone 
+    # information in utc is ignored (it is treated as a UTC time).        
+    #
+    # If no TimezonePeriod could be found, PeriodNotFound is raised.
+    def period_for_utc(utc)
+      info.period_for_utc(utc)
+    end
+    
+    # Returns the set of TimezonePeriod instances that are valid for the given
+    # local time as an array. If you just want a single period, use 
+    # period_for_local instead and specify how abiguities should be resolved.
+    # Raises PeriodNotFound if no periods are found for the given time.
+    def periods_for_local(local)
+      info.periods_for_local(local)
+    end    
+  end
+end

data/lib/tzinfo/data_timezone_info.rb

@@ -0,0 +1,226 @@
+#--
+# 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/time_or_datetime'
+require 'tzinfo/timezone_info'
+require 'tzinfo/timezone_offset_info'
+require 'tzinfo/timezone_period'
+require 'tzinfo/timezone_transition_info'
+
+module TZInfo
+  # Thrown if no offsets have been defined when calling period_for_utc or
+  # periods_for_local. Indicates an error in the timezone data.
+  class NoOffsetsDefined < StandardError
+  end
+    
+  # Represents a (non-linked) timezone defined in a data module.
+  class DataTimezoneInfo < TimezoneInfo #:nodoc:
+            
+    # Constructs a new TimezoneInfo with its identifier.
+    def initialize(identifier)   
+      super(identifier)
+      @offsets = {}
+      @transitions = []
+    end
+ 
+    # Defines a offset. The id uniquely identifies this offset within the
+    # timezone. utc_offset and std_offset define the offset in seconds of 
+    # standard time from UTC and daylight savings from standard time 
+    # respectively. abbreviation describes the timezone offset (e.g. GMT, BST,
+    # EST or EDT).
+    #
+    # The first offset to be defined is treated as the offset that applies
+    # until the first transition. This will usually be in Local Mean Time (LMT).
+    #
+    # ArgumentError will be raised if the id is already defined.
+    def offset(id, utc_offset, std_offset, abbreviation)
+      raise ArgumentError, 'Offset already defined' if @offsets.has_key?(id)
+      
+      offset = TimezoneOffsetInfo.new(utc_offset, std_offset, abbreviation)
+      @offsets[id] = offset
+      @previous_offset = offset unless @previous_offset
+    end
+    
+    # Defines a transition. Transitions must be defined in chronological order.
+    # ArgumentError will be raised if a transition is added out of order.
+    # offset_id refers to an id defined with offset. ArgumentError will be 
+    # raised if the offset_id cannot be found. numerator_or_time and
+    # denomiator specify the time the transition occurs as. See 
+    # TimezoneTransitionInfo for more detail about specifying times.
+    def transition(year, month, offset_id, numerator_or_time, denominator = nil)
+      offset = @offsets[offset_id]      
+      raise ArgumentError, 'Offset not found' unless offset
+            
+      if @transitions_index
+        if year < @last_year || (year == @last_year && month < @last_month)
+          raise ArgumentError, 'Transitions must be increasing date order'
+        end
+        
+        # Record the position of the first transition with this index.
+        index = transition_index(year, month)
+        @transitions_index[index] ||= @transitions.length
+                
+        # Fill in any gaps       
+        (index - 1).downto(0) do |i|
+          break if @transitions_index[i]
+          @transitions_index[i] = @transitions.length
+        end
+      else
+        @transitions_index = [@transitions.length]
+        @start_year = year
+        @start_month = month        
+      end
+      
+      @transitions << TimezoneTransitionInfo.new(offset, @previous_offset, 
+        numerator_or_time, denominator)
+      @last_year = year
+      @last_month = month             
+      @previous_offset = offset
+    end           
+    
+    # Returns the TimezonePeriod for the given UTC time.
+    # Raises NoOffsetsDefined if no offsets have been defined.
+    def period_for_utc(utc)
+      unless @transitions.empty?
+        utc = TimeOrDateTime.wrap(utc)               
+        index = transition_index(utc.year, utc.mon)
+        
+        start_transition = nil
+        start = transition_before_end(index)
+        if start
+          start.downto(0) do |i|
+            if @transitions[i].at <= utc
+              start_transition = @transitions[i]
+              break
+            end
+          end
+        end
+        
+        end_transition = nil
+        start = transition_after_start(index)      
+        if start
+          start.upto(@transitions.length - 1) do |i|
+            if @transitions[i].at > utc
+              end_transition = @transitions[i]
+              break
+            end
+          end
+        end
+               
+        if start_transition || end_transition
+          TimezonePeriod.new(start_transition, end_transition)
+        else
+          # Won't happen since there are transitions. Must always find one
+          # transition that is either >= or < the specified time.
+          raise 'No transitions found in search'
+        end        
+      else
+        raise NoOffsetsDefined, 'No offsets have been defined' unless @previous_offset        
+        TimezonePeriod.new(nil, nil, @previous_offset)
+      end
+    end
+    
+    # Returns the set of TimezonePeriods for the given local time as an array.    
+    # Results returned are ordered by increasing UTC start date.
+    # Returns an empty array if no periods are found for the given time.
+    # Raises NoOffsetsDefined if no offsets have been defined.    
+    def periods_for_local(local)
+      unless @transitions.empty?
+        local = TimeOrDateTime.wrap(local)
+        index = transition_index(local.year, local.mon)
+        
+        result = []
+       
+        start_index = transition_after_start(index - 1)       
+        if start_index && @transitions[start_index].local_end > local           
+          if start_index > 0
+            if @transitions[start_index - 1].local_start <= local 
+              result << TimezonePeriod.new(@transitions[start_index - 1], @transitions[start_index])
+            end
+          else
+            result << TimezonePeriod.new(nil, @transitions[start_index])
+          end
+        end
+        
+        end_index = transition_before_end(index + 1)
+        
+        if end_index        
+          start_index = end_index unless start_index
+          
+          start_index.upto(transition_before_end(index + 1)) do |i|
+            if @transitions[i].local_start <= local
+              if i + 1 < @transitions.length
+                if @transitions[i + 1].local_end > local
+                  result << TimezonePeriod.new(@transitions[i], @transitions[i + 1])
+                end
+              else
+                result << TimezonePeriod.new(@transitions[i], nil)
+              end
+            end
+          end
+        end
+        
+        result
+      else
+        raise NoOffsetsDefined, 'No offsets have been defined' unless @previous_offset
+        [TimezonePeriod.new(nil, nil, @previous_offset)]
+      end
+    end
+    
+    private
+      # Returns the index into the @transitions_index array for a given year 
+      # and month.
+      def transition_index(year, month)
+        index = (year - @start_year) * 2
+        index += 1 if month > 6
+        index -= 1 if @start_month > 6
+        index
+      end
+      
+      # Returns the index into @transitions of the first transition that occurs
+      # on or after the start of the given index into @transitions_index.
+      # Returns nil if there are no such transitions.
+      def transition_after_start(index)
+        if index >= @transitions_index.length
+          nil
+        else
+          index = 0 if index < 0
+          @transitions_index[index]
+        end
+      end
+      
+      # Returns the index into @transitions of the first transition that occurs
+      # before the end of the given index into @transitions_index.
+      # Returns nil if there are no such transitions.
+      def transition_before_end(index)
+        index = index + 1
+        
+        if index <= 0
+          nil
+        elsif index >= @transitions_index.length          
+          @transitions.length - 1
+        else      
+          @transitions_index[index] - 1          
+        end
+      end            
+  end
+end

data/lib/tzinfo/definitions/Africa/Abidjan.rb

@@ -1,13 +1,18 @@
-require 'tzinfo/timezone'
+require 'tzinfo/timezone_definition'
+
 module TZInfo
-module Definitions #:nodoc:
-module Africa #:nodoc:
-class Abidjan < Timezone #:nodoc:
-setup
-set_identifier('Africa/Abidjan')
-add_unbounded_start_period {TimezonePeriod.new(nil,DateTime.new0(Rational.new!(26129547121,10800),0,Date::ITALY),-968,0,:LMT)}
-add_period(1912,1) {TimezonePeriod.new(DateTime.new0(Rational.new!(26129547121,10800),0,Date::ITALY),nil,0,0,:GMT)}
-end
-end
-end
+  module Definitions
+    module Africa
+      module Abidjan
+        include TimezoneDefinition
+        
+        timezone 'Africa/Abidjan' do |tz|
+          tz.offset :o0, -968, 0, :LMT
+          tz.offset :o1, 0, 0, :GMT
+          
+          tz.transition 1912, 1, :o1, 26129547121, 10800
+        end
+      end
+    end
+  end
 end

data/lib/tzinfo/definitions/Africa/Accra.rb

@@ -1,27 +1,33 @@
-require 'tzinfo/timezone'
+require 'tzinfo/timezone_definition'
+
 module TZInfo
-module Definitions #:nodoc:
-module Africa #:nodoc:
-class Accra < Timezone #:nodoc:
-setup
-set_identifier('Africa/Accra')
-add_unbounded_start_period {TimezonePeriod.new(nil,DateTime.new0(Rational.new!(52306441213,21600),0,Date::ITALY),-52,0,:LMT)}
-add_period(1918,1) {TimezonePeriod.new(DateTime.new0(Rational.new!(52306441213,21600),0,Date::ITALY),DateTime.new0(Rational.new!(4856825,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1936,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4856825,2),0,Date::ITALY),DateTime.new0(Rational.new!(174854411,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1936,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(174854411,72),0,Date::ITALY),DateTime.new0(Rational.new!(4857555,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1937,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4857555,2),0,Date::ITALY),DateTime.new0(Rational.new!(174880691,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1937,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(174880691,72),0,Date::ITALY),DateTime.new0(Rational.new!(4858285,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1938,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4858285,2),0,Date::ITALY),DateTime.new0(Rational.new!(174906971,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1938,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(174906971,72),0,Date::ITALY),DateTime.new0(Rational.new!(4859015,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1939,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4859015,2),0,Date::ITALY),DateTime.new0(Rational.new!(174933251,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1939,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(174933251,72),0,Date::ITALY),DateTime.new0(Rational.new!(4859747,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1940,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4859747,2),0,Date::ITALY),DateTime.new0(Rational.new!(174959603,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1940,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(174959603,72),0,Date::ITALY),DateTime.new0(Rational.new!(4860477,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1941,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4860477,2),0,Date::ITALY),DateTime.new0(Rational.new!(174985883,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1941,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(174985883,72),0,Date::ITALY),DateTime.new0(Rational.new!(4861207,2),0,Date::ITALY),0,0,:GMT)}
-add_period(1942,9) {TimezonePeriod.new(DateTime.new0(Rational.new!(4861207,2),0,Date::ITALY),DateTime.new0(Rational.new!(175012163,72),0,Date::ITALY),0,1200,:GHST)}
-add_period(1942,12) {TimezonePeriod.new(DateTime.new0(Rational.new!(175012163,72),0,Date::ITALY),nil,0,0,:GMT)}
-end
-end
-end
+  module Definitions
+    module Africa
+      module Accra
+        include TimezoneDefinition
+        
+        timezone 'Africa/Accra' do |tz|
+          tz.offset :o0, -52, 0, :LMT
+          tz.offset :o1, 0, 0, :GMT
+          tz.offset :o2, 0, 1200, :GHST
+          
+          tz.transition 1918, 1, :o1, 52306441213, 21600
+          tz.transition 1936, 9, :o2, 4856825, 2
+          tz.transition 1936, 12, :o1, 174854411, 72
+          tz.transition 1937, 9, :o2, 4857555, 2
+          tz.transition 1937, 12, :o1, 174880691, 72
+          tz.transition 1938, 9, :o2, 4858285, 2
+          tz.transition 1938, 12, :o1, 174906971, 72
+          tz.transition 1939, 9, :o2, 4859015, 2
+          tz.transition 1939, 12, :o1, 174933251, 72
+          tz.transition 1940, 9, :o2, 4859747, 2
+          tz.transition 1940, 12, :o1, 174959603, 72
+          tz.transition 1941, 9, :o2, 4860477, 2
+          tz.transition 1941, 12, :o1, 174985883, 72
+          tz.transition 1942, 9, :o2, 4861207, 2
+          tz.transition 1942, 12, :o1, 175012163, 72
+        end
+      end
+    end
+  end
 end