tzinfo 0.3.61 → 1.0.0

data/Rakefile

@@ -1,282 +1,87 @@
-# Available options:
-#
-# rake test - Runs all test cases.
-# rake package - Runs test cases and builds packages for distribution.
-# rake rdoc - Builds API documentation in doc dir.
-# rake build_tz_modules - Builds Timezone modules and the Country index. 
-#   Expects to find source data in ../data.
-# rake build_tz_module zone=Zone/Name - Builds a single Timezone module. 
-#   Expects to find source data in ../data.
-# rake build_countries - Builds the Country index.
-#   Expects to find source data in ../data.
-
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'fileutils'
-
-Rake::TaskManager.class_eval do
-  def remove_task(task_name)
-    @tasks.delete(task_name.to_s)
-  end
-end
-
-def remove_task(task_name)
-  Rake.application.remove_task(task_name)
-end
-
-self.class.class_eval { alias_method :orig_sh, :sh }
-private :orig_sh
-
-def sh(*cmd, &block)
-  if cmd.first =~ /\A__tar_with_owner__ -?([zjcvf]+)(.*)\z/
-    opts = $1
-    args = $2
-    cmd[0] = "tar c --owner 0 --group 0 -#{opts.gsub('c', '')}#{args}"    
-  end
-  
-  orig_sh(*cmd, &block)
-end
-
-
-BUILD_TZ_CLASSES_DIR = 'lib/tzinfo.build_tz_classes'
-
-SPEC = eval(File.read('tzinfo.gemspec'))
-
-package_task = Rake::GemPackageTask.new(SPEC) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar_gz = true
-  pkg.tar_command = '__tar_with_owner__'
-end
-
-# Replace the Rake::PackageTask task that prepares the files to package with
-# a version that ensures the permissions are correct for the package.
-# Also just copy rather than link the files so that old versions are maintained.
-remove_task package_task.package_dir_path
-file package_task.package_dir_path => [package_task.package_dir] + package_task.package_files do
-  mkdir_p package_task.package_dir_path rescue nil
-  chmod(0755, package_task.package_dir_path)
-  package_task.package_files.each do |fn|
-    f = File.join(package_task.package_dir_path, fn)
-    fdir = File.dirname(f)
-    mkdir_p(fdir) if !File.exist?(fdir)
-    if File.directory?(fn)
-      mkdir_p(f)
-      chmod(0755, f)
-    else
-      rm_f f
-      cp(fn, f)
-      chmod(0644, f)
-    end
-  end
-end
-
-
-# Replace the Rake::GemPackageTask task that builds the gem with a version that
-# changes to the copied package directory first. This allows the gem builder
-# to pick up the correct file permissions.
-remove_task "#{package_task.package_dir}/#{package_task.gem_file}"
-file "#{package_task.package_dir}/#{package_task.gem_file}" => [package_task.package_dir] + package_task.gem_spec.files do
-  when_writing("Creating GEM") do
-    chdir(package_task.package_dir_path) do
-      Gem::Builder.new(package_task.gem_spec).build
-    end
-    
-    verbose(true) do
-      mv File.join(package_task.package_dir_path, package_task.gem_file), "#{package_task.package_dir}/#{package_task.gem_file}"
-    end
-  end
-end
-
-
-Rake::TestTask.new('test') do |t|
-  # Force a particular timezone to be local (helps find issues when local
-  # timezone isn't GMT). This won't work on Windows.
-  ENV['TZ'] = 'America/Los_Angeles'
-
-  t.libs << '.'
-  t.pattern = 'test/tc_*.rb'
-  t.verbose = true
-end
-
-
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title = "TZInfo"
-  rdoc.options << '--inline-source'
-  rdoc.options.concat SPEC.rdoc_options
-  rdoc.rdoc_files.include(*SPEC.extra_rdoc_files) 
-  rdoc.rdoc_files.include('lib')  
-end
-
-task :build_tz_modules do
-  require 'lib/tzinfo/tzdataparser'
-  
-  FileUtils.mkdir_p(BUILD_TZ_CLASSES_DIR)
-  begin  
-    p = TZInfo::TZDataParser.new('data', BUILD_TZ_CLASSES_DIR)
-    p.execute
-    
-    scm = Scm.create(File.dirname(__FILE__))
-    
-    ['indexes', 'definitions'].each do |dir|
-      scm.sync("#{BUILD_TZ_CLASSES_DIR}/#{dir}", "lib/tzinfo/#{dir}")
-    end
-  ensure
-    FileUtils.rm_rf(BUILD_TZ_CLASSES_DIR)
-  end
-end
-
-class Scm
-  def self.create(dir)
-    if File.directory?(File.join(dir, '.git'))
-      GitScm.new(dir)
-    elsif File.directory?(File.join(dir, '.svn'))
-      SvnScm.new(dir)
-    else
-      NullScm.new(dir)
-    end
-  end
-
-  def initialize(dir)
-  end
-
-  def sync(source_dir, target_dir)
-    puts "Sync from #{source_dir} to #{target_dir}#{command ? " using #{command}" : ''}"
-    sync_dirs(source_dir, target_dir)
-  end
-
-  protected
-
-  def exec_scm(params)
-    puts "#{command} #{params}"
-    `#{command} #{params}`
-    raise "#{command} exited with status #$?" if $? != 0  
-  end
-
-  private
-  
-  def sync_dirs(source_dir, target_dir)
-    # Assumes a directory will never turn into a file and vice-versa
-    # (files will all end in .rb, directories won't).
-
-    source_entries, target_entries = [source_dir, target_dir].collect do |dir|
-      Dir.entries(dir).delete_if {|entry| entry =~ /\A\./}.sort
-    end
-    
-    until source_entries.empty? || target_entries.empty?          
-      last_source = source_entries.last
-      last_target = target_entries.last
-    
-      if last_source == last_target
-        source_file = File.join(source_dir, last_source)
-        target_file = File.join(target_dir, last_target)
-      
-        if File.directory?(source_file)
-          sync_dirs(source_file, target_file)
-        else
-          FileUtils.cp(source_file, target_file)
-        end     
-      
-        source_entries.pop
-        target_entries.pop
-      elsif source_entries.last < target_entries.last
-        sync_only_in_target(target_dir, target_entries)
-      else      
-        sync_only_in_source(source_dir, target_dir, source_entries)
-      end    
-    end
-    
-    until target_entries.empty?
-      sync_only_in_target(target_dir, target_entries)
-    end
-    
-    until source_entries.empty?
-      sync_only_in_source(source_dir, target_dir, source_entries)
-    end
-  end
-
-  def sync_only_in_target(target_dir, target_entries)
-    target_file = File.join(target_dir, target_entries.last)
-    delete(target_file)
-    target_entries.pop
-  end
-
-  def sync_only_in_source(source_dir, target_dir, source_entries)
-    source_file = File.join(source_dir, source_entries.last)
-    target_file = File.join(target_dir, source_entries.last)
-        
-    if File.directory?(source_file)
-      Dir.mkdir(target_file)
-      add(target_file)
-      sync_dirs(source_file, target_file)
-    else
-      FileUtils.cp(source_file, target_file)
-      add(target_file)
-    end
-    
-    source_entries.pop
-  end
-end
-
-class NullScm < Scm
-  def command
-    nil
-  end
-  
-  def add(file)
-  end
-  
-  def delete(file)
-    puts "rm -rf \"#{file}\""
-    FileUtils.rm_rf(file)
-  end
-end
-
-class GitScm < Scm
-  def command
-    'git'
-  end
-  
-  def add(file)
-    unless File.directory?(file)
-      exec_scm "add \"#{file}\""
-    end
-  end
-  
-  def delete(file)
-    exec_scm "rm -rf \"#{file}\""
-  end
-end
-
-class SvnScm < Scm
-  def command
-    'svn'
-  end
-  
-  def add(file)
-    exec_scm "add \"#{file}\""
-  end
-  
-  def delete(file)
-    exec_scm "delete --force \"#{file}\""
-  end
-end
-
-
-task :build_tz_module do
-  require 'lib/tzinfo/tzdataparser'
-  p = TZInfo::TZDataParser.new('data', 'lib/tzinfo')
-  p.generate_countries = false
-  p.only_zones = [ENV['zone']]
-  p.execute
-end
-
-task :build_countries do
-  require 'lib/tzinfo/tzdataparser'
-  p = TZInfo::TZDataParser.new('data', 'lib/tzinfo')
-  p.generate_countries = true
-  p.generate_zones = false
-  p.execute
-end
+# Available options:
+#
+# rake test - Runs all test cases.
+# rake package - Runs test cases and builds packages for distribution.
+# rake rdoc - Builds API documentation in doc dir.
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'fileutils'
+
+spec = eval(File.read('tzinfo.gemspec'))
+
+class TZInfoPackageTask < Gem::PackageTask
+  alias_method :orig_sh, :sh
+  private :orig_sh
+
+  def sh(*cmd, &block)
+    if cmd.first =~ /\A__tar_with_owner__ -?([zjcvf]+)(.*)\z/
+      opts = $1
+      args = $2
+      cmd[0] = "tar c --owner 0 --group 0 -#{opts.gsub('c', '')}#{args}"    
+    end
+  
+    orig_sh(*cmd, &block)
+  end
+end
+
+package_task = TZInfoPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_gz = true
+  pkg.tar_command = '__tar_with_owner__'
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = 'TZInfo'
+  rdoc.main = 'README'
+  rdoc.options.concat spec.rdoc_options
+  rdoc.rdoc_files.include(spec.extra_rdoc_files) 
+  rdoc.rdoc_files.include('lib')  
+end
+
+Rake::Task[package_task.package_dir_path].enhance do
+  File.chmod(0755, package_task.package_dir_path)
+  recurse_chmod(package_task.package_dir_path)
+end
+
+Rake::Task[:package].enhance do
+  FileUtils.rm_rf(package_task.package_dir_path)
+end
+
+def recurse_chmod(dir)
+  File.chmod(0755, dir)
+  
+  Dir.entries(dir).each do |entry|
+    if entry != '.' && entry != '..'    
+      path = File.join(dir, entry)
+      if File.directory?(path)
+        recurse_chmod(path)
+      else
+        File.chmod(0644, path)
+      end
+    end
+  end
+end
+
+task :test => [:test_ruby, :test_zoneinfo] do
+end
+
+def setup_tests(test_task, type)
+  # Force a particular timezone to be local (helps find issues when local
+  # timezone isn't GMT). This won't work on Windows.
+  ENV['TZ'] = 'America/Los_Angeles'
+  
+  test_task.pattern = File.join(File.expand_path(File.dirname(__FILE__)), 'test', "ts_all_#{type}.rb")
+end
+
+Rake::TestTask.new('test_ruby') do |t|
+  setup_tests(t, :ruby)
+end
+
+Rake::TestTask.new('test_zoneinfo') do |t|
+  setup_tests(t, :zoneinfo)
+end

data/lib/tzinfo/country.rb

@@ -21,39 +21,38 @@
 #++
 
 module TZInfo
-  # Thrown by Country#get if the code given is not valid.
+  # Raised by Country#get if the code given is not valid.
   class InvalidCountryCode < StandardError
   end
   
-  # An ISO 3166 country. Can be used to get a list of Timezones for a country.
-  # For example:
+  # The Country class represents an ISO 3166-1 country. It can be used to 
+  # obtain a list of Timezones for a country. For example:
   #
   #  us = Country.get('US')
   #  us.zone_identifiers
   #  us.zones
   #  us.zone_info
+  #
+  # Country information available through TZInfo is intended as an aid for 
+  # users, to help them select time zone data appropriate for their practical 
+  # needs. It is not intended to take or endorse any position on legal or 
+  # territorial claims.
   class Country
     include Comparable
     
     # Defined countries.
-    #
-    # @!visibility private
     @@countries = {}
     
     # Whether the countries index has been loaded yet.
-    #
-    # @!visibility private
     @@index_loaded = false
     
-    # Gets a Country by its ISO 3166 code. Raises an InvalidCountryCode 
-    # exception if it couldn't be found.
+    # Gets a Country by its ISO 3166-1 alpha-2 code. Raises an 
+    # InvalidCountryCode exception if it couldn't be found.
     def self.get(identifier)
       instance = @@countries[identifier]
       
       unless instance
-        load_index
-        info = Indexes::Countries.countries[identifier]        
-        raise InvalidCountryCode.new, 'Invalid identifier' unless info
+        info = data_source.load_country_info(identifier)  
         instance = Country.new(info)
         @@countries[identifier] = instance
       end      
@@ -75,17 +74,15 @@ module TZInfo
     
     # Returns an Array of all the valid country codes.
     def self.all_codes
-      load_index
-      Indexes::Countries.countries.keys
+      data_source.country_codes
     end
     
     # Returns an Array of all the defined Countries.
     def self.all
-      load_index
-      Indexes::Countries.countries.keys.collect {|code| get(code)}
+      data_source.country_codes.collect {|code| get(code)}
     end       
     
-    # The ISO 3166 country code.
+    # The ISO 3166-1 alpha-2 country code.
     def code
       @info.code
     end
@@ -107,8 +104,9 @@ module TZInfo
     
     # Returns a frozen array of all the zone identifiers for the country. These
     # are in an order that
-    #   (1) makes some geographical sense, and
-    #   (2) puts the most populous zones first, where that does not contradict (1).
+    #
+    # 1. makes some geographical sense, and
+    # 2. puts the most populous zones first, where that does not contradict 1.
     def zone_identifiers
       @info.zone_identifiers
     end
@@ -118,8 +116,9 @@ module TZInfo
     # objects to avoid the overhead of loading Timezone definitions until
     # a conversion is actually required. The Timezones are returned in an order
     # that
-    #   (1) makes some geographical sense, and
-    #   (2) puts the most populous zones first, where that does not contradict (1).
+    #
+    # 1. makes some geographical sense, and
+    # 2. puts the most populous zones first, where that does not contradict 1.
     def zones
       zone_identifiers.collect {|id|
         Timezone.get_proxy(id)        
@@ -129,18 +128,16 @@ module TZInfo
     # Returns a frozen array of all the timezones for the for the country as
     # CountryTimezone instances (containing extra information about each zone). 
     # These are in an order that
-    #   (1) makes some geographical sense, and
-    #   (2) puts the most populous zones first, where that does not contradict (1).
+    #
+    # 1. makes some geographical sense, and
+    # 2. puts the most populous zones first, where that does not contradict 1.
     def zone_info
       @info.zones
     end
         
     # Compare two Countries based on their code. Returns -1 if c is less
     # than self, 0 if c is equal to self and +1 if c is greater than self.
-    #
-    # Returns nil if c is not comparable with Country instances.
     def <=>(c)
-      return nil unless c.is_a?(Country)
       code <=> c.code
     end
     
@@ -166,18 +163,15 @@ module TZInfo
     end
     
     private
-      # Loads in the index of countries if it hasn't already been loaded.
-      def self.load_index
-        unless @@index_loaded
-          require 'tzinfo/indexes/countries'
-          @@index_loaded = true
-        end        
-      end     
-      
       # Called by Country.new to initialize a new Country instance. The info
       # parameter is a CountryInfo that defines the country.
       def setup(info)
         @info = info        
       end
+      
+      # Returns the current DataSource
+      def self.data_source
+        DataSource.get
+      end
   end 
 end

data/lib/tzinfo/country_index_definition.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2013 Philip Ross
+# Copyright (c) 2006-2010 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
@@ -23,8 +23,6 @@
 module TZInfo
   # The country index file includes CountryIndexDefinition which provides
   # a country method used to define each country in the index.
-  #
-  # @private
   module CountryIndexDefinition #:nodoc:
     def self.append_features(base)
       super
@@ -32,15 +30,12 @@ module TZInfo
       base.instance_eval { @countries = {} }
     end
     
-    # Class methods for inclusion.
-    #
-    # @private
     module ClassMethods #:nodoc:
       # Defines a country with an ISO 3166 country code, name and block. The
       # block will be evaluated to obtain all the timezones for the country.
       # Calls Country.country_defined with the definition of each country.
       def country(code, name, &block)
-        @countries[code] = CountryInfo.new(code, name, &block)      
+        @countries[code] = RubyCountryInfo.new(code, name, &block)      
       end
       
       # Returns a frozen hash of all the countries that have been defined in

data/lib/tzinfo/country_info.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2013 Philip Ross
+# 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
@@ -21,43 +21,19 @@
 #++
 
 module TZInfo  
-  # Class to store the data loaded from the country index. Instances of this
-  # class are passed to the blocks in the index that define timezones.
-  #
-  # @private
-  class CountryInfo #:nodoc:
+  # Represents a country and references to its timezones as returned by a
+  # DataSource.
+  class CountryInfo
+    # The ISO 3166 country code.
     attr_reader :code
+    
+    # The name of the country.
     attr_reader :name
     
-    # Constructs a new CountryInfo with an ISO 3166 country code, name and 
-    # block. The block will be evaluated to obtain the timezones for the country
-    # (when they are first needed).
-    def initialize(code, name, &block)
+    # Constructs a new CountryInfo with an ISO 3166 country code and name
+    def initialize(code, name)
       @code = code
       @name = name
-      @block = block
-      @zones = nil
-      @zone_identifiers = nil
-    end
-    
-    # Called by the index data to define a timezone for the country.
-    def timezone(identifier, latitude_numerator, latitude_denominator, 
-                 longitude_numerator, longitude_denominator, description = nil)
-      # Currently only store the identifiers.
-      @zones << CountryTimezone.new(identifier, latitude_numerator, 
-        latitude_denominator, longitude_numerator, longitude_denominator,
-        description)     
-    end
-    
-    # Returns a frozen array of all the zone identifiers for the country. These
-    # are in the order they were added using the timezone method.
-    def zone_identifiers
-      unless @zone_identifiers
-        @zone_identifiers = zones.collect {|zone| zone.identifier}
-        @zone_identifiers.freeze
-      end
-      
-      @zone_identifiers
     end
     
     # Returns internal object state as a programmer-readable string.
@@ -65,18 +41,18 @@ module TZInfo
       "#<#{self.class}: #@code>"
     end
     
+    # Returns a frozen array of all the zone identifiers for the country.
+    # The identifiers are ordered by importance according to the DataSource.
+    def zone_identifiers
+      raise NotImplementedError, 'Subclasses must override zone_identifiers'
+    end
+    
     # Returns a frozen array of all the timezones for the for the country as
-    # CountryTimezone instances. These are in the order they were added using 
-    # the timezone method.
+    # CountryTimezone instances.
+    #
+    # The timezones are ordered by importance according to the DataSource.
     def zones
-      unless @zones
-        @zones = []
-        @block.call(self) if @block
-        @block = nil
-        @zones.freeze
-      end
-      
-      @zones
-    end    
+      raise NotImplementedError, 'Subclasses must override zone_identifiers'
+    end
   end
 end

data/lib/tzinfo/country_timezone.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2013 Philip Ross
+# Copyright (c) 2006-2012 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