tzinfo 0.3.62 → 1.0.0

data/lib/tzinfo/time_or_datetime.rb

@@ -21,27 +21,34 @@
 #++
 
 require 'date'
+require 'rational'
 require 'time'
 
 module TZInfo
-  # Used by TZInfo internally to represent either a Time, DateTime or integer
-  # timestamp (seconds since 1970-01-01 00:00:00).
-  #
-  # @private
+  # Used by TZInfo internally to represent either a Time, DateTime or
+  # an Integer timestamp (seconds since 1970-01-01 00:00:00).
   class TimeOrDateTime #:nodoc:
     include Comparable
     
     # Constructs a new TimeOrDateTime. timeOrDateTime can be a Time, DateTime
-    # or an integer. If using a Time or DateTime, any time zone information is 
-    # ignored.
+    # or Integer. If using a Time or DateTime, any time zone information 
+    # is ignored.
+    #
+    # Integer timestamps must be within the range supported by Time on the
+    # platform being used.    
     def initialize(timeOrDateTime)
       @time = nil
       @datetime = nil
       @timestamp = nil
       
       if timeOrDateTime.is_a?(Time)
-        @time = timeOrDateTime        
-        @time = Time.utc(@time.year, @time.mon, @time.mday, @time.hour, @time.min, @time.sec) unless @time.zone == 'UTC'        
+        @time = timeOrDateTime
+        
+        # Avoid using the slower Rational class unless necessary.
+        nsec = RubyCoreSupport.time_nsec(@time)
+        usec = nsec % 1000 == 0 ? nsec / 1000 : Rational(nsec, 1000)
+        
+        @time = Time.utc(@time.year, @time.mon, @time.mday, @time.hour, @time.min, @time.sec, usec) unless @time.zone == 'UTC'        
         @orig = @time
       elsif timeOrDateTime.is_a?(DateTime)
         @datetime = timeOrDateTime
@@ -49,17 +56,25 @@ module TZInfo
         @orig = @datetime
       else
         @timestamp = timeOrDateTime.to_i
+        
+        if !RubyCoreSupport.time_supports_64bit && (@timestamp > 2147483647 || @timestamp < -2147483648 || (@timestamp < 0 && !RubyCoreSupport.time_supports_negative))
+          raise RangeError, 'Timestamp is outside the supported range of Time on this platform'
+        end
+        
         @orig = @timestamp
       end
     end
     
     # Returns the time as a Time.
+    #
+    # When converting from a DateTime, the result is truncated to microsecond
+    # precision.
     def to_time
-      unless @time        
-        if @timestamp 
+      unless @time
+        if @timestamp
           @time = Time.at(@timestamp).utc
         else
-          @time = Time.utc(year, mon, mday, hour, min, sec)
+          @time = Time.utc(year, mon, mday, hour, min, sec, usec)
         end
       end
       
@@ -67,9 +82,15 @@ module TZInfo
     end
     
     # Returns the time as a DateTime.
+    #
+    # When converting from a Time, the result is truncated to microsecond
+    # precision.
     def to_datetime
       unless @datetime
-        @datetime = DateTime.new(year, mon, mday, hour, min, sec)
+        # Avoid using Rational unless necessary.
+        u = usec
+        s = u == 0 ? sec : Rational(sec * 1000000 + u, 1000000)
+        @datetime = RubyCoreSupport.datetime_new(year, mon, mday, hour, min, s)
       end
       
       @datetime
@@ -173,38 +194,44 @@ module TZInfo
       end
     end
     
-    # Compares this TimeOrDateTime with another Time, DateTime, integer
-    # timestamp or TimeOrDateTime. Returns -1, 0 or +1 depending whether the 
-    # receiver is less than, equal to, or greater than timeOrDateTime.
-    #
-    # Milliseconds and smaller units are ignored in the comparison.
+    # Returns the number of microseconds for the time.
+    def usec      
+      if @time
+        @time.usec
+      elsif @datetime
+        # Ruby 1.8 has sec_fraction (of which the documentation says
+        # 'I do NOT recommend you to use this method'). sec_fraction no longer
+        # exists in Ruby 1.9.
+        
+        # Calculate the sec_fraction from the day_fraction.
+        ((@datetime.day_fraction - OffsetRationals.rational_for_offset(@datetime.hour * 3600 + @datetime.min * 60 + @datetime.sec)) * 86400000000).to_i
+      else 
+        0
+      end
+    end
+    
+    # Compares this TimeOrDateTime with another Time, DateTime, timestamp 
+    # (Integer) or TimeOrDateTime. Returns -1, 0 or +1 depending 
+    # whether the receiver is less than, equal to, or greater than 
+    # timeOrDateTime.
     #
-    # Returns nil if the passed in timeOrDateTime is not comparable with
-    # TimeOrDateTime instances.
+    # Comparisons involving a DateTime will be performed using DateTime#<=>.
+    # Comparisons that don't involve a DateTime, but include a Time will be
+    # performed with Time#<=>. Otherwise comparisons will be performed with
+    # Integer#<=>.    
     def <=>(timeOrDateTime)
-      return nil unless timeOrDateTime.is_a?(TimeOrDateTime) ||
-                        timeOrDateTime.is_a?(Time) ||
-                        timeOrDateTime.is_a?(DateTime) ||
-                        timeOrDateTime.respond_to?(:to_i)
-
-      if timeOrDateTime.is_a?(TimeOrDateTime)            
-        orig = timeOrDateTime.to_orig
-        
-        if @orig.is_a?(DateTime) || orig.is_a?(DateTime)
-          # If either is a DateTime, assume it is there for a reason 
-          # (i.e. for range).
-          to_datetime <=> timeOrDateTime.to_datetime
-        elsif orig.is_a?(Time)
-          to_time <=> timeOrDateTime.to_time
-        else
-          to_i <=> timeOrDateTime.to_i
-        end        
-      elsif @orig.is_a?(DateTime) || timeOrDateTime.is_a?(DateTime)
+      unless timeOrDateTime.is_a?(TimeOrDateTime)
+        timeOrDateTime = TimeOrDateTime.wrap(timeOrDateTime)
+      end
+          
+      orig = timeOrDateTime.to_orig
+      
+      if @orig.is_a?(DateTime) || orig.is_a?(DateTime)
         # If either is a DateTime, assume it is there for a reason 
-        # (i.e. for range).        
-        to_datetime <=> TimeOrDateTime.wrap(timeOrDateTime).to_datetime
-      elsif timeOrDateTime.is_a?(Time)
-        to_time <=> timeOrDateTime
+        # (i.e. for its larger range of acceptable values on 32-bit systems).
+        to_datetime <=> timeOrDateTime.to_datetime
+      elsif @orig.is_a?(Time) || orig.is_a?(Time)
+        to_time <=> timeOrDateTime.to_time
       else
         to_i <=> timeOrDateTime.to_i
       end
@@ -221,7 +248,7 @@ module TZInfo
         if @orig.is_a?(DateTime)
           TimeOrDateTime.new(@orig + OffsetRationals.rational_for_offset(seconds))
         else
-          # + defined for Time and integer timestamps
+          # + defined for Time and Integer
           TimeOrDateTime.new(@orig + seconds)
         end
       end
@@ -235,9 +262,11 @@ module TZInfo
       self + (-seconds)
     end
    
-    # Similar to the + operator, but for cases where adding would cause a 
-    # timestamp or time to go out of the allowed range, converts to a DateTime
-    # based TimeOrDateTime.
+    # Similar to the + operator, but converts to a DateTime based TimeOrDateTime
+    # where the  Time or Integer timestamp to go out of the allowed range for a 
+    # Time, converts to a DateTime based TimeOrDateTime.
+    #
+    # Note that the range of Time varies based on the platform.
     def add_with_convert(seconds)
       if seconds == 0
         self
@@ -248,7 +277,7 @@ module TZInfo
           # A Time or timestamp.
           result = to_i + seconds
           
-          if result < 0 || result > 2147483647
+          if ((result > 2147483647 || result < -2147483648) && !RubyCoreSupport.time_supports_64bit) || (result < 0 && !RubyCoreSupport.time_supports_negative)
             result = TimeOrDateTime.new(to_datetime + OffsetRationals.rational_for_offset(seconds))
           else
             result = TimeOrDateTime.new(@orig + seconds)
@@ -272,12 +301,14 @@ module TZInfo
     # If no block is given, returns a TimeOrDateTime wrapping the given 
     # timeOrDateTime. If a block is specified, a TimeOrDateTime is constructed
     # and passed to the block. The result of the block must be a TimeOrDateTime.
-    # to_orig will be called on the result and the result of to_orig will be
-    # returned.
     #
-    # timeOrDateTime can be a Time, DateTime, integer timestamp or TimeOrDateTime.
-    # If a TimeOrDateTime is passed in, no new TimeOrDateTime will be constructed,
-    # the passed in value will be used.
+    # The result of the block will be converted to the type of the originally 
+    # passed in timeOrDateTime and then returned as the result of wrap.
+    #
+    # timeOrDateTime can be a Time, DateTime, timestamp (Integer) or 
+    # TimeOrDateTime. If a TimeOrDateTime is passed in, no new TimeOrDateTime 
+    # will be constructed and the value passed to wrap will be used when 
+    # calling the block.
     def self.wrap(timeOrDateTime)      
       t = timeOrDateTime.is_a?(TimeOrDateTime) ? timeOrDateTime : TimeOrDateTime.new(timeOrDateTime)        
       
@@ -285,7 +316,7 @@ module TZInfo
         t = yield t
         
         if timeOrDateTime.is_a?(TimeOrDateTime)
-          t          
+          t
         elsif timeOrDateTime.is_a?(Time)
           t.to_time
         elsif timeOrDateTime.is_a?(DateTime)

data/lib/tzinfo/timezone.rb

@@ -23,23 +23,27 @@
 require 'date'
 
 module TZInfo
-  # Indicate a specified time in a local timezone has more than one
-  # possible time in UTC. This happens when switching from daylight savings time 
-  # to normal time where the clocks are rolled back. Thrown by period_for_local
-  # and local_to_utc when using an ambiguous time and not specifying any 
-  # means to resolve the ambiguity.
+  # AmbiguousTime is raised to indicates that a specified time in a local 
+  # timezone has more than one possible equivalent UTC time. This happens when 
+  # transitioning from daylight savings time to standard time where the clocks 
+  # are rolled back.
+  #
+  # AmbiguousTime is raised by period_for_local and local_to_utc when using an 
+  # ambiguous time and not specifying any means to resolve the ambiguity.
   class AmbiguousTime < StandardError
   end
   
-  # Thrown to indicate that no TimezonePeriod matching a given time could be found.
+  # PeriodNotFound is raised to indicate that no TimezonePeriod matching a given
+  # time could be found.
   class PeriodNotFound < StandardError
   end
   
-  # Thrown by Timezone#get if the identifier given is not valid.
+  # Raised by Timezone#get if the identifier given is not valid.
   class InvalidTimezoneIdentifier < StandardError
   end
   
-  # Thrown if an attempt is made to use a timezone created with Timezone.new(nil).
+  # Raised if an attempt is made to use a timezone created with
+  # Timezone.new(nil).
   class UnknownTimezone < StandardError
   end
   
@@ -55,27 +59,15 @@ module TZInfo
   #
   # Each time conversion method returns an object of the same type it was 
   # passed.
-  #
-  # The timezone information all comes from the tz database
-  # (see http://www.twinsun.com/tz/tz-link.htm)
   class Timezone
     include Comparable
     
     # Cache of loaded zones by identifier to avoid using require if a zone
     # has already been loaded.
-    #
-    # @!visibility private
     @@loaded_zones = {}
-    
-    # Whether the timezones index has been loaded yet.
-    #
-    # @!visibility private
-    @@index_loaded = false
-    
+        
     # Default value of the dst parameter of the local_to_utc and 
     # period_for_local methods.
-    #
-    # @!visibility private
     @@default_dst = nil
     
     # Sets the default value of the optional dst parameter of the 
@@ -100,36 +92,11 @@ module TZInfo
     # Raises InvalidTimezoneIdentifier if the timezone couldn't be found.
     def self.get(identifier)
       instance = @@loaded_zones[identifier]
+      
       unless instance  
-        raise InvalidTimezoneIdentifier, 'Invalid identifier' if identifier !~ /\A[A-Za-z0-9+\-_]+(\/[A-Za-z0-9+\-_]+)*\z/
-        identifier = identifier.gsub(/-/, '__m__').gsub(/\+/, '__p__')
-        begin
-          # Use a temporary variable to avoid an rdoc warning
-          file = "tzinfo/definitions/#{identifier}".untaint
-          require file
-          
-          m = Definitions
-          identifier.split(/\//).each {|part|
-            m = m.const_get(part)
-          }
-          
-          info = m.get
-          
-          # Could make Timezone subclasses register an interest in an info
-          # type. Since there are currently only two however, there isn't
-          # much point.
-          if info.kind_of?(DataTimezoneInfo)
-            instance = DataTimezone.new(info)
-          elsif info.kind_of?(LinkedTimezoneInfo)
-            instance = LinkedTimezone.new(info)
-          else
-            raise InvalidTimezoneIdentifier, "No handler for info type #{info.class}"
-          end
-          
-          @@loaded_zones[instance.identifier] = instance         
-        rescue LoadError, NameError => e
-          raise InvalidTimezoneIdentifier, e.message
-        end
+        info = data_source.load_timezone_info(identifier)
+        instance = info.create_timezone
+        @@loaded_zones[instance.identifier] = instance         
       end
       
       instance
@@ -165,8 +132,7 @@ module TZInfo
     # Returns an array containing the identifiers of all the available 
     # Timezones.
     def self.all_identifiers
-      load_index
-      Indexes::Timezones.timezones
+      data_source.timezone_identifiers
     end
     
     # Returns an array containing all the available Timezones that are based
@@ -181,8 +147,7 @@ module TZInfo
     # Returns an array containing the identifiers of all the available 
     # Timezones that are based on data (are not links to other Timezones)..
     def self.all_data_zone_identifiers
-      load_index
-      Indexes::Timezones.data_timezones
+      data_source.data_timezone_identifiers
     end
     
     # Returns an array containing all the available Timezones that are links
@@ -197,8 +162,7 @@ module TZInfo
     # Returns an array containing the identifiers of all the available 
     # Timezones that are links to other Timezones.
     def self.all_linked_zone_identifiers
-      load_index
-      Indexes::Timezones.linked_timezones
+      data_source.linked_timezone_identifiers
     end
     
     # Returns all the Timezones defined for all Countries. This is not the
@@ -498,13 +462,10 @@ module TZInfo
     
     # Compares two Timezones based on their identifier. Returns -1 if tz is less
     # than self, 0 if tz is equal to self and +1 if tz is greater than self.
-    #
-    # Returns nil if tz is not comparable with Timezone instances.
     def <=>(tz)
-      return nil unless tz.is_a?(Timezone)
       identifier <=> tz.identifier
     end
-
+    
     # Returns true if and only if the identifier of tz is equal to the 
     # identifier of this Timezone.
     def eql?(tz)
@@ -526,19 +487,16 @@ module TZInfo
       Timezone.get(data)
     end
     
-    private
-      # Loads in the index of timezones if it hasn't already been loaded.
-      def self.load_index
-        unless @@index_loaded
-          require 'tzinfo/indexes/timezones'
-          @@index_loaded = true
-        end        
-      end
-      
+    private      
       # Returns an array of proxies corresponding to the given array of 
       # identifiers.
       def self.get_proxies(identifiers)
         identifiers.collect {|identifier| get_proxy(identifier)}
       end
+      
+      # Returns the current DataSource
+      def self.data_source
+        DataSource.get
+      end
   end        
 end

data/lib/tzinfo/timezone_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
@@ -24,8 +24,6 @@ module TZInfo
   
   # TimezoneDefinition is included into Timezone definition modules.
   # TimezoneDefinition provides the methods for defining timezones.
-  #
-  # @private
   module TimezoneDefinition #:nodoc:
     # Add class methods to the includee.
     def self.append_features(base)
@@ -34,12 +32,11 @@ module TZInfo
     end
     
     # Class methods for inclusion.
-    #
-    # @private
     module ClassMethods #:nodoc:
-      # Returns and yields a DataTimezoneInfo object to define a timezone.
+      # Returns and yields a TransitionDataTimezoneInfo object to define a 
+      # timezone.
       def timezone(identifier)
-        yield @timezone = DataTimezoneInfo.new(identifier)
+        yield @timezone = TransitionDataTimezoneInfo.new(identifier)
       end
       
       # Defines a linked timezone.

data/lib/tzinfo/timezone_index_definition.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2006-2013 Philip Ross
+# 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
@@ -23,8 +23,6 @@
 module TZInfo
   # The timezone index file includes TimezoneIndexDefinition which provides
   # methods used to define timezones in the index.
-  #
-  # @private
   module TimezoneIndexDefinition #:nodoc:
     def self.append_features(base)
       super
@@ -36,9 +34,6 @@ module TZInfo
       end
     end
     
-    # Class methods for inclusion.
-    #
-    # @private
     module ClassMethods #:nodoc:
       # Defines a timezone based on data.
       def timezone(identifier)

data/lib/tzinfo/timezone_info.rb

@@ -21,10 +21,8 @@
 #++
 
 module TZInfo
-  # Represents a timezone defined in a data module.
-  #
-  # @private
-  class TimezoneInfo #:nodoc:
+  # Represents a timezone defined by a data source.
+  class TimezoneInfo
     
     # The timezone identifier.
     attr_reader :identifier
@@ -38,5 +36,11 @@ module TZInfo
     def inspect
       "#<#{self.class}: #@identifier>"
     end
+    
+    # Constructs a Timezone instance for the timezone represented by this
+    # TimezoneInfo.
+    def create_timezone
+      raise NotImplementedError, 'Subclasses must override create_timezone'
+    end
   end
 end

data/lib/tzinfo/timezone_offset_info.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
@@ -22,8 +22,6 @@
 
 module TZInfo
   # Represents an offset defined in a Timezone data file.
-  #
-  # @private
   class TimezoneOffsetInfo #:nodoc:
     # The base offset of the timezone from UTC in seconds.
     attr_reader :utc_offset

data/lib/tzinfo/timezone_period.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2012 Philip Ross
+# Copyright (c) 2005-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
@@ -23,19 +23,22 @@
 module TZInfo
   # A period of time in a timezone where the same offset from UTC applies.
   #
-  # All the methods that take times accept instances of Time, DateTime or
-  # integer timestamps.
+  # All the methods that take times accept instances of Time or DateTime as well
+  # as Integer timestamps.
   class TimezonePeriod
     # The TimezoneTransitionInfo that defines the start of this TimezonePeriod 
     # (may be nil if unbounded).
-    attr_reader :start_transition
+    attr_reader :start_transition #:nodoc:
+    protected :start_transition
     
     # The TimezoneTransitionInfo that defines the end of this TimezonePeriod
     # (may be nil if unbounded).
-    attr_reader :end_transition
+    attr_reader :end_transition #:nodoc:
+    protected :end_transition
     
     # The TimezoneOffsetInfo for this period.
-    attr_reader :offset    
+    attr_reader :offset #:nodoc:
+    protected :offset
     
     # Initializes a new TimezonePeriod.
     def initialize(start_transition, end_transition, offset = nil)
@@ -96,23 +99,45 @@ module TZInfo
       @start_transition ? @start_transition.at.to_datetime : nil
     end
     
+    # The start time of the period in UTC as a Time. May be nil if unbounded.
+    def utc_start_time
+      @start_transition ? @start_transition.at.to_time : nil
+    end
+    
     # The end time of the period in UTC as a DateTime. May be nil if unbounded.
     def utc_end
       @end_transition ? @end_transition.at.to_datetime : nil
     end
     
+    # The end time of the period in UTC as a Time. May be nil if unbounded.
+    def utc_end_time
+      @end_transition ? @end_transition.at.to_time : nil
+    end
+    
     # The start time of the period in local time as a DateTime. May be nil if 
     # unbounded.
     def local_start
       @start_transition ? @start_transition.local_start.to_datetime : nil
     end
     
+    # The start time of the period in local time as a Time. May be nil if 
+    # unbounded.
+    def local_start_time
+      @start_transition ? @start_transition.local_start.to_time : nil
+    end
+    
     # The end time of the period in local time as a DateTime. May be nil if 
     # unbounded.
     def local_end
       @end_transition ? @end_transition.local_end.to_datetime : nil
     end
     
+    # The end time of the period in local time as a Time. May be nil if 
+    # unbounded.
+    def local_end_time
+      @end_transition ? @end_transition.local_end.to_time : nil
+    end
+    
     # true if daylight savings is in effect for this period; otherwise false.
     def dst?
       @offset.dst?

data/lib/tzinfo/timezone_transition_info.rb

@@ -23,9 +23,8 @@
 require 'date'
 
 module TZInfo
-  # Represents an offset defined in a Timezone data file.
-  #
-  # @private
+  # Represents an transition from one timezone offset to another at a particular
+  # date and time.
   class TimezoneTransitionInfo #:nodoc:
     # The offset this transition changes to (a TimezoneOffsetInfo instance).
     attr_reader :offset
@@ -38,26 +37,57 @@ module TZInfo
     attr_reader :numerator_or_time
     protected :numerator_or_time
     
-    # Either the denominotor of the DateTime if the transition time is defined
+    # Either the denominator of the DateTime if the transition time is defined
     # as a DateTime, otherwise nil. 
     attr_reader :denominator
     protected :denominator
     
     # Creates a new TimezoneTransitionInfo with the given offset, 
-    # previous_offset (both TimezoneOffsetInfo instances) and UTC time. 
-    # if denominator is nil, numerator_or_time is treated as a number of 
-    # seconds since the epoch. If denominator is specified numerator_or_time
-    # and denominator are used to create a DateTime as follows:
+    # previous_offset (both TimezoneOffsetInfo instances) and UTC time.
+    #
+    # The time can be specified as a timestamp, as a rational to create a
+    # DateTime or as both.
+    #
+    # If both a timestamp and rational are given, then the rational will only
+    # be used if the timestamp falls outside of the range of Time on the
+    # platform being used at runtime.
+    #
+    # DateTimes are created from the rational as follows:
     # 
-    #  DateTime.new!(Rational.send(:new!, numerator_or_time, denominator), 0, Date::ITALY)
+    #  RubyCoreSupport.datetime_new!(RubyCoreSupport.rational_new!(numerator_or_time, denominator), 0, Date::ITALY)
     #
     # For performance reasons, the numerator and denominator must be specified
     # in their lowest form.
-    def initialize(offset, previous_offset, numerator_or_time, denominator = nil)
+    def initialize(offset, previous_offset, numerator_or_timestamp, denominator_or_numerator = nil, denominator = nil)
       @offset = offset
       @previous_offset = previous_offset
-      @numerator_or_time = numerator_or_time
-      @denominator = denominator
+      
+      if denominator
+        numerator = denominator_or_numerator
+        timestamp = numerator_or_timestamp
+      elsif denominator_or_numerator
+        numerator = numerator_or_timestamp
+        denominator = denominator_or_numerator
+        timestamp = nil
+      else
+        numerator = nil
+        denominator = nil
+        timestamp = numerator_or_timestamp
+      end
+      
+      # Determine whether to use the timestamp or the numerator and denominator.
+      if numerator && (
+        !timestamp || 
+        (timestamp < 0 && !RubyCoreSupport.time_supports_negative) || 
+        ((timestamp < -2147483648 || timestamp > 2147483647) && !RubyCoreSupport.time_supports_64bit)
+        )
+        
+        @numerator_or_time = numerator
+        @denominator = denominator
+      else
+        @numerator_or_time = timestamp
+        @denominator = nil
+      end
       
       @at = nil
       @local_end = nil