tzinfo 0.3.61 → 1.0.0

data/lib/tzinfo/transition_data_timezone_info.rb

@@ -0,0 +1,223 @@
+#--
+# Copyright (c) 2006-2013 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
+  # Raised 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 data timezone defined by a set of offsets and a set 
+  # of transitions
+  class TransitionDataTimezoneInfo < DataTimezoneInfo #:nodoc:
+            
+    # Constructs a new TransitionDataTimezoneInfo with its identifier.
+    def initialize(identifier)   
+      super(identifier)
+      @offsets = {}
+      @transitions = []
+      @previous_offset = nil
+      @transitions_index = nil
+    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_timestamp, denominator_or_numerator = nil, 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_timestamp, denominator_or_numerator, 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/zoneinfo_country_info.rb

@@ -0,0 +1,50 @@
+#--
+# Copyright (c) 2013 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 information about a country returned by ZoneinfoDataSource.
+  class ZoneinfoCountryInfo < CountryInfo #:nodoc:
+    # Constructs a new CountryInfo with an ISO 3166 country code, name and 
+    # an array of CountryTimezones.
+    def initialize(code, name, zones)
+      super(code, name)
+      @zones = zones.dup.freeze
+      @zone_identifiers = nil
+    end
+    
+    # Returns a frozen array of all the zone identifiers for the country ordered
+    # geographically, most populous first.
+    def zone_identifiers
+      unless @zone_identifiers
+        @zone_identifiers = zones.collect {|zone| zone.identifier}.freeze
+      end
+      
+      @zone_identifiers
+    end
+    
+    # Returns a frozen array of all the timezones for the for the country 
+    # ordered geographically, most populous first.
+    def zones
+      @zones
+    end
+  end
+end

data/lib/tzinfo/zoneinfo_data_source.rb

@@ -0,0 +1,297 @@
+#--
+# Copyright (c) 2012-2013 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
+  # An InvalidZoneinfoDirectory exception is raised if the DataSource is
+  # set to a specific zoneinfo path, which is not a valid zoneinfo directory
+  # (i.e. a directory containing index files named iso3166.tab and zone.tab
+  # as well as other timezone files).
+  class InvalidZoneinfoDirectory < StandardError
+  end
+  
+  # A ZoneinfoDirectoryNotFound exception is raised if no valid zoneinfo 
+  # directory could be found when checking the paths listed in
+  # ZoneinfoDataSource.search_path. A valid zoneinfo directory is one that
+  # contains index files named iso3166.tab and zone.tab as well as other 
+  # timezone files.
+  class ZoneinfoDirectoryNotFound < StandardError
+  end
+  
+  # A DataSource that loads data from a 'zoneinfo' directory containing
+  # compiled "TZif" version 2 (or earlier) files in addition to zones.tab 
+  # and iso3166.tab index files.
+  #
+  # To have TZInfo load the system zoneinfo files, call TZInfo::DataSource.set 
+  # as follows:
+  #
+  #   TZInfo::DataSource.set(:zoneinfo)
+  #
+  # To load zoneinfo files from a particular directory, pass the directory to 
+  # TZInfo::DataSource.set:
+  #
+  #   TZInfo::DataSource.set(:zoneinfo, directory)  
+  class ZoneinfoDataSource < DataSource
+    # The default value of ZoneInfoDataSource.search_path.
+    DEFAULT_SEARCH_PATH = ['/usr/share/zoneinfo', '/usr/share/lib/zoneinfo', '/etc/zoneinfo'].freeze
+    
+    # Paths to be checked to find the system zoneinfo directory.
+    @@search_path = DEFAULT_SEARCH_PATH.dup
+    
+    # An Array of directories that will be checked to find the system zoneinfo
+    # directory.
+    #
+    # Directories are checked in the order they appear in the Array.
+    #
+    # The default value is ['/usr/share/zoneinfo', '/usr/share/lib/zoneinfo', '/etc/zoneinfo'].
+    def self.search_path
+      @@search_path
+    end
+    
+    # Sets the directories to be checked when locating the system zoneinfo 
+    # directory.
+    #
+    # Can be set to an Array of directories or a String containing directories
+    # separated with File::PATH_SEPARATOR.
+    #
+    # Directories are checked in the order they appear in the Array or String.
+    #
+    # Set to nil to revert to the default paths.
+    def self.search_path=(search_path)
+      if search_path
+        if search_path.kind_of?(String)
+          @@search_path = search_path.split(File::PATH_SEPARATOR)
+        else
+          @@search_path = search_path.collect {|p| p.to_s}
+        end
+      else
+        @@search_path = DEFAULT_SEARCH_PATH.dup
+      end
+    end
+    
+    # The zoneinfo directory being used.
+    attr_reader :zoneinfo_dir
+    
+    # Creates a new ZoneinfoDataSource.
+    #
+    # If zoneinfo_dir is specified, it will be checked and used as the source
+    # of zoneinfo files. If the directory does not contain zone.tab and 
+    # iso3166.tab files, InvalidZoneinfoDirectory will be raised.
+    # 
+    # If zoneinfo_dir is not specified or nil, the paths referenced in
+    # search_path are searched in order to find a valid zoneinfo directory 
+    # (one that contains files named zone.tab and iso3166.tab). If no valid 
+    # zoneinfo directory is found ZoneinfoDirectoryNotFound will be raised.
+    def initialize(zoneinfo_dir = nil)
+      if zoneinfo_dir
+        unless valid_zoneinfo_dir?(zoneinfo_dir)
+          raise InvalidZoneinfoDirectory, "#{zoneinfo_dir} is not a directory or doesn't contain iso3166.tab and zone.tab files." 
+        end
+        @zoneinfo_dir = zoneinfo_dir
+      else
+        @zoneinfo_dir = self.class.search_path.detect do |path|
+          valid_zoneinfo_dir?(path)
+        end
+        
+        unless @zoneinfo_dir
+          raise ZoneinfoDirectoryNotFound, "None of the paths included in TZInfo::ZoneinfoDataSource.search_path are valid zoneinfo directories."
+        end
+      end
+      
+      @zoneinfo_dir = File.expand_path(@zoneinfo_dir).freeze
+      @zoneinfo_prefix = (@zoneinfo_dir + File::SEPARATOR).freeze
+    end
+    
+    # Returns a TimezoneInfo instance for a given identifier. 
+    # Raises InvalidTimezoneIdentifier if the timezone is not found or the 
+    # identifier is invalid.
+    def load_timezone_info(identifier)
+      load_timezone_index
+      
+      begin
+        if @timezone_index.include?(identifier)
+          identifier.untaint
+          path = File.join(@zoneinfo_dir, identifier)
+          
+          begin
+            ZoneinfoTimezoneInfo.new(identifier, path)
+          rescue InvalidZoneinfoFile => e
+            raise InvalidTimezoneIdentifier, e.message
+          end
+        else
+          raise InvalidTimezoneIdentifier, 'Invalid identifier'
+        end
+      rescue Errno::ENOENT, Errno::ENAMETOOLONG, Errno::ENOTDIR
+        raise InvalidTimezoneIdentifier, 'Invalid identifier'
+      rescue Errno::EACCES => e
+        raise InvalidTimezoneIdentifier, e.message
+      end
+    end    
+    
+    # Returns an array of all the available timezone identifiers.
+    def timezone_identifiers
+      load_timezone_index
+      @timezone_index
+    end
+    
+    # Returns an array of all the available timezone identifiers for
+    # data timezones (i.e. those that actually contain definitions).
+    #
+    # For ZoneinfoDataSource, this will always be identical to 
+    # timezone_identifers.
+    def data_timezone_identifiers
+      load_timezone_index
+      @timezone_index
+    end
+    
+    # Returns an array of all the available timezone identifiers that
+    # are links to other timezones.
+    #
+    # For ZoneinfoDataSource, this will always be an empty array.
+    def linked_timezone_identifiers
+      [].freeze
+    end
+    
+    # Returns a CountryInfo instance for the given ISO 3166-1 alpha-2
+    # country code. Raises InvalidCountryCode if the country could not be found
+    # or the code is invalid.
+    def load_country_info(code)
+      load_country_index
+      info = @country_index[code]
+      raise InvalidCountryCode.new, 'Invalid country code' unless info
+      info
+    end
+    
+    # Returns an array of all the available ISO 3166-1 alpha-2
+    # country codes.
+    def country_codes
+      load_country_index
+      @country_index.keys.freeze
+    end
+    
+    # Returns the name and information about this DataSource.
+    def to_s
+      "Zoneinfo DataSource: #{@zoneinfo_dir}"
+    end
+    
+    # Returns internal object state as a programmer-readable string.
+    def inspect
+      "#<#{self.class}: #{@zoneinfo_dir}>"
+    end    
+    
+    private
+    
+    # Tests whether a path represents a valid zoneinfo directory (i.e.
+    # is a directory and contains zone.tab and iso3166.tab files).
+    def valid_zoneinfo_dir?(path)
+      File.directory?(path) && File.file?(File.join(path, 'zone.tab')) && File.file?(File.join(path, 'iso3166.tab'))
+    end
+       
+    # Unless called before, scans @zoneinfo_dir looking for all the data
+    # and linked zones.
+    def load_timezone_index
+      unless @timezone_index
+        index = []
+        
+        enum_timezones(nil, ['localtime', 'posix', 'posixrules', 'right', 'Factory']) do |identifier|
+          index << identifier
+        end
+        
+        @timezone_index = index.sort.freeze
+      end
+    end
+    
+    # Recursively scans a directory of timezones, populating data_identifiers
+    # and linked_timezones.
+    def enum_timezones(dir, exclude = [], &block)
+      Dir.foreach(dir ? File.join(@zoneinfo_dir, dir) : @zoneinfo_dir) do |entry|
+        unless entry =~ /\./ || exclude.include?(entry)
+          entry.untaint
+          path = dir ? File.join(dir, entry) : entry
+          full_path = File.join(@zoneinfo_dir, path)
+ 
+          if File.directory?(full_path)
+            enum_timezones(path, [], &block)
+          elsif File.file?(full_path)
+            yield path
+          end
+        end
+      end
+    end
+    
+    # Unless called before, uses the iso3166.tab and zone.tab files to build
+    # an index of the available countries and their timezones.
+    def load_country_index
+      unless @country_index
+        zones = {}
+        
+        File.open(File.join(@zoneinfo_dir, 'zone.tab')) do |file|
+          file.each_line do |line|
+            line.chomp!
+            
+            if line =~ /\A([A-Z]{2})\t(?:([+\-])(\d{2})(\d{2})([+\-])(\d{3})(\d{2})|([+\-])(\d{2})(\d{2})(\d{2})([+\-])(\d{3})(\d{2})(\d{2}))\t([^\t]+)(?:\t([^\t]+))?\z/
+              code = $1
+              
+              if $2
+                latitude = dms_to_rational($2, $3, $4)
+                longitude = dms_to_rational($5, $6, $7)
+              else
+                latitude = dms_to_rational($8, $9, $10, $11)
+                longitude = dms_to_rational($12, $13, $14, $15)
+              end
+              
+              zone_identifier = $16
+              description = $17
+              
+              (zones[code] ||= []) << 
+                CountryTimezone.new(zone_identifier, latitude.numerator, latitude.denominator, 
+                                    longitude.numerator, longitude.denominator, description)
+            end
+          end
+        end
+        
+        countries = {}
+        
+        File.open(File.join(@zoneinfo_dir, 'iso3166.tab')) do |file|
+          file.each_line do |line|
+            line.chomp!
+            
+            if line =~ /\A([A-Z]{2})\t(.+)\z/
+              code = $1
+              name = $2
+              countries[code] = ZoneinfoCountryInfo.new(code, name, zones[code] || [])
+            end
+          end
+        end
+        
+        @country_index = countries
+      end
+    end
+    
+    # Converts degrees, miunutes and seconds to a Rational
+    def dms_to_rational(sign, degrees, minutes, seconds = nil)
+      result = degrees.to_i + Rational(minutes.to_i, 60)
+      result += Rational(seconds.to_i, 3600) if seconds
+      result = -result if sign == '-'
+      result
+    end
+  end
+end