tzinfo 0.1.2 → 0.2.0

data/lib/tzinfo/definitions/W__m__SU.rb

@@ -1,9 +1,9 @@
-require 'tzinfo/timezone'
-require 'tzinfo/definitions/Europe/Moscow'
-module TZInfo
-module Definitions #:nodoc:
-class W__m__SU < Definitions::Europe::Moscow #:nodoc:
-set_identifier('W-SU')
-end
-end
-end
+require 'tzinfo/timezone'
+require 'tzinfo/definitions/Europe/Moscow'
+module TZInfo
+module Definitions #:nodoc:
+class W__m__SU < Definitions::Europe::Moscow #:nodoc:
+set_identifier('W-SU')
+end
+end
+end

data/lib/tzinfo/definitions/Zulu.rb

@@ -1,9 +1,9 @@
-require 'tzinfo/timezone'
-require 'tzinfo/definitions/Etc/UTC'
-module TZInfo
-module Definitions #:nodoc:
-class Zulu < Definitions::Etc::UTC #:nodoc:
-set_identifier('Zulu')
-end
-end
-end
+require 'tzinfo/timezone'
+require 'tzinfo/definitions/Etc/UTC'
+module TZInfo
+module Definitions #:nodoc:
+class Zulu < Definitions::Etc::UTC #:nodoc:
+set_identifier('Zulu')
+end
+end
+end

data/lib/tzinfo/offset_rationals.rb

@@ -0,0 +1,95 @@
+#--
+# 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
+  
+  # Provides a method for getting Rationals for a timezone offset in seconds.
+  # Pre-reduced rationals are returned for all the half-hour intervals between
+  # -14 and +14 hours to avoid having to call gcd at runtime.  
+  module OffsetRationals #:nodoc:
+    @@rational_cache = {
+      -50400 => Rational.new!(-7,12), 
+      -48600 => Rational.new!(-9,16),
+      -46800 => Rational.new!(-13,24),
+      -45000 => Rational.new!(-25,48),
+      -43200 => Rational.new!(-1,2),
+      -41400 => Rational.new!(-23,48),
+      -39600 => Rational.new!(-11,24),
+      -37800 => Rational.new!(-7,16),
+      -36000 => Rational.new!(-5,12),
+      -34200 => Rational.new!(-19,48),
+      -32400 => Rational.new!(-3,8),
+      -30600 => Rational.new!(-17,48),
+      -28800 => Rational.new!(-1,3),
+      -27000 => Rational.new!(-5,16),
+      -25200 => Rational.new!(-7,24),
+      -23400 => Rational.new!(-13,48),
+      -21600 => Rational.new!(-1,4),
+      -19800 => Rational.new!(-11,48),
+      -18000 => Rational.new!(-5,24),
+      -16200 => Rational.new!(-3,16),
+      -14400 => Rational.new!(-1,6),
+      -12600 => Rational.new!(-7,48),
+      -10800 => Rational.new!(-1,8),
+       -9000 => Rational.new!(-5,48),
+       -7200 => Rational.new!(-1,12),
+       -5400 => Rational.new!(-1,16),
+       -3600 => Rational.new!(-1,24),
+       -1800 => Rational.new!(-1,48),
+           0 => Rational.new!(0,1),
+        1800 => Rational.new!(1,48),
+        3600 => Rational.new!(1,24),
+        5400 => Rational.new!(1,16),
+        7200 => Rational.new!(1,12),
+        9000 => Rational.new!(5,48),
+       10800 => Rational.new!(1,8),
+       12600 => Rational.new!(7,48),
+       14400 => Rational.new!(1,6),
+       16200 => Rational.new!(3,16),
+       18000 => Rational.new!(5,24),
+       19800 => Rational.new!(11,48),
+       21600 => Rational.new!(1,4),
+       23400 => Rational.new!(13,48),
+       25200 => Rational.new!(7,24),
+       27000 => Rational.new!(5,16),
+       28800 => Rational.new!(1,3),
+       30600 => Rational.new!(17,48),
+       32400 => Rational.new!(3,8),
+       34200 => Rational.new!(19,48),
+       36000 => Rational.new!(5,12),
+       37800 => Rational.new!(7,16),
+       39600 => Rational.new!(11,24),
+       41400 => Rational.new!(23,48),
+       43200 => Rational.new!(1,2),
+       45000 => Rational.new!(25,48),
+       46800 => Rational.new!(13,24),  
+       48600 => Rational.new!(9,16),            
+       50400 => Rational.new!(7,12)}
+    
+    # Returns a Rational expressing the fraction of a day that offset in 
+    # seconds represents (i.e. equivalent to Rational(offset, 86400)). 
+    def rational_for_offset(offset)
+      @@rational_cache[offset] || Rational(offset, 86400)      
+    end
+    module_function :rational_for_offset
+  end
+end

data/lib/tzinfo/time_or_datetime.rb

@@ -0,0 +1,269 @@
+#--
+# 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 'date'
+require 'time'
+require 'tzinfo/offset_rationals'
+
+module TZInfo
+  # Used by TZInfo internally to represent either a Time, DateTime or 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, any time zone information is ignored.
+    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'        
+        @orig = @time
+      elsif timeOrDateTime.is_a?(DateTime)
+        @datetime = timeOrDateTime
+        @orig = @datetime
+      else
+        @timestamp = timeOrDateTime.to_i
+        @orig = @timestamp
+      end
+    end
+    
+    # Returns the time as a Time.
+    def to_time
+      if @time.nil?        
+        if !@timestamp.nil? 
+          @time = Time.at(@timestamp).utc
+        else
+          @time = Time.utc(year, mon, mday, hour, min, sec)
+        end
+      end
+      
+      @time      
+    end
+    
+    # Returns the time as a DateTime.
+    def to_datetime
+      if @datetime.nil?
+        @datetime = DateTime.new(year, mon, mday, hour, min, sec)
+      end
+      
+      @datetime
+    end
+    
+    # Returns the time as an integer timestamp.
+    def to_i
+      if @timestamp.nil?
+        @timestamp = to_time.to_i
+      end
+      
+      @timestamp
+    end
+    
+    # Returns the time as the original time passed to new.
+    def to_orig
+      @orig
+    end
+    
+    # Returns a string representation of the TimeOrDateTime.
+    def to_s
+      if @orig.is_a?(Time)
+        "Time: #{@orig.to_s}"
+      elsif @orig.is_a?(DateTime)
+        "DateTime: #{@orig.to_s}"
+      else
+        "Timestamp: #{@orig.to_s}"
+      end
+    end
+    
+    # Returns the year.
+    def year
+      if !@time.nil?
+        @time.year
+      elsif !@datetime.nil?
+        @datetime.year
+      else
+        to_time.year
+      end
+    end
+    
+    # Returns the month of the year (1..12).
+    def mon
+      if !@time.nil?
+        @time.mon
+      elsif !@datetime.nil?
+        @datetime.mon
+      else
+        to_time.mon
+      end
+    end
+    alias :month :mon
+    
+    # Returns the day of the month (1..n).
+    def mday
+      if !@time.nil?
+        @time.mday
+      elsif !@datetime.nil?
+        @datetime.mday
+      else
+        to_time.mday
+      end
+    end
+    alias :day :mday
+    
+    # Returns the hour of the day (0..23).
+    def hour
+      if !@time.nil?
+        @time.hour
+      elsif !@datetime.nil?
+        @datetime.hour
+      else
+        to_time.hour
+      end
+    end
+    
+    # Returns the minute of the hour (0..59).
+    def min
+      if !@time.nil?
+        @time.min
+      elsif !@datetime.nil?
+        @datetime.min
+      else
+        to_time.min
+      end
+    end
+    
+    # Returns the second of the minute (0..60). (60 for a leap second).
+    def sec
+      if !@time.nil?
+        @time.sec
+      elsif !@datetime.nil?
+        @datetime.sec
+      else
+        to_time.sec
+      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.
+    def <=>(timeOrDateTime)
+      if timeOrDateTime.is_a?(TimeOrDateTime)        
+        self <=> timeOrDateTime.orig      
+      elsif @orig.is_a?(DateTime) || timeOrDateTime.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
+      else
+        to_i <=> timeOrDateTime.to_i
+      end
+    end
+    
+    # Adds a number of seconds to the TimeOrDateTime. Returns a new 
+    # TimeOrDateTime, preserving what the original constructed type was.
+    # If the original type is a Time and the resulting calculation goes out of
+    # range for Times, then an exception will be raised by the Time class.
+    def +(seconds)
+      if seconds == 0
+        self
+      else
+        if @orig.is_a?(DateTime)
+          TimeOrDateTime.new(@orig + OffsetRationals.rational_for_offset(seconds))
+        else
+          # + defined for Time and integer timestamps
+          TimeOrDateTime.new(@orig + seconds)
+        end
+      end
+    end
+    
+    # Subtracts a number of seconds from the TimeOrDateTime. Returns a new 
+    # TimeOrDateTime, preserving what the original constructed type was.
+    # If the original type is a Time and the resulting calculation goes out of
+    # range for Times, then an exception will be raised by the Time class.
+    def -(seconds)
+      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.
+    def add_with_convert(seconds)
+      if seconds == 0
+        self
+      else
+        if @orig.is_a?(DateTime)
+          TimeOrDateTime.new(@orig + OffsetRationals.rational_for_offset(seconds))
+        else
+          # A Time or timestamp.
+          result = to_i + seconds
+          
+          if result < 0 || result > 2147483647
+            result = TimeOrDateTime.new(to_datetime + OffsetRationals.rational_for_offset(seconds))
+          else
+            result = TimeOrDateTime.new(@orig + seconds)
+          end
+        end
+      end
+    end
+    
+    # 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.
+    def self.wrap(timeOrDateTime)      
+      t = timeOrDateTime.is_a?(TimeOrDateTime) ? timeOrDateTime : TimeOrDateTime.new(timeOrDateTime)        
+      
+      if block_given?
+        t = yield t
+        
+        if timeOrDateTime.is_a?(TimeOrDateTime)
+          t          
+        elsif timeOrDateTime.is_a?(Time)
+          t.to_time
+        elsif timeOrDateTime.is_a?(DateTime)
+          t.to_datetime
+        else
+          t.to_i
+        end        
+      else
+        t
+      end
+    end
+
+    protected
+      # The time in the format it was originally constructed.
+      def orig
+        @orig
+      end
+  end
+end

data/lib/tzinfo/timezone.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005 Philip Ross
+# Copyright (c) 2005-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
@@ -22,6 +22,7 @@
 
 require 'date'
 require 'tzinfo/country'
+require 'tzinfo/time_or_datetime'
 require 'tzinfo/timezone_period'
 require 'tzinfo/timezone_period_list'
 
@@ -45,12 +46,16 @@ module TZInfo
   
   # Timezone is the base class of all timezones. It provides a factory method
   # get to access timezones by identifier. Once a specific Timezone has been
-  # retrieved, DateTimes and Times can be converted between the UTC and the
-  # local time for the zone. For example:
+  # retrieved, DateTimes, Times and timestamps can be converted between the UTC 
+  # and the local time for the zone. For example:
   #
   #   tz = TZInfo::Timezone.get('America/New_York')
   #   puts tz.utc_to_local(DateTime.new(2005,8,29,15,35,0)).to_s
   #   puts tz.local_to_utc(Time.utc(2005,8,29,11,35,0)).to_s
+  #   puts tz.utc_to_local(1125315300).to_s
+  #
+  # 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)
@@ -204,18 +209,18 @@ module TZInfo
     end
     
     # Returns the TimezonePeriod for the given UTC time. utc can either be
-    # a DateTime or a Time. Any timezone information in utc is ignored (it is
-    # treated as a UTC time).    
+    # 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)
-      utc = as_datetime(utc)      
+    def period_for_utc(utc)            
       periods.period_for_utc(utc)      
     end
     
     # Returns the TimezonePeriod for the given local time. local can either be
-    # a DateTime or a Time. Any timezone information in local is ignored (it is
-    # treated as a time in the current timezone).
+    # a DateTime, Time or integer timestamp (Time.to_i). Any timezone 
+    # information in local is ignored (it is treated as a time in the current 
+    # timezone).
     #
     # Warning: There are local times that have no equivalent UTC times (e.g.
     # in the transition from standard time to daylight savings time). There are
@@ -246,8 +251,7 @@ module TZInfo
     # array of the periods that need to be resolved. The block can select and
     # return a single period or return nil or an empty array
     # to cause an AmbiguousTime exception to be raised.
-    def period_for_local(local, dst = nil)
-      local = as_datetime(local)      
+    def period_for_local(local, dst = nil)            
       results = periods.periods_for_local(local)
       
       # by this point, results must contain at least one period
@@ -282,17 +286,19 @@ module TZInfo
     end
     
     # Converts a time in UTC to the local timezone. utc can either be
-    # a DateTime or a Time. The returned time has the same type as utc.
-    # Any timezone information in utc is ignored (it is treated as a UTC time).
+    # a DateTime, Time or timestamp (Time.to_i). The returned time has the same
+    # type as utc. Any timezone information in utc is ignored (it is treated as 
+    # a UTC time).
     def utc_to_local(utc)
-      run_on_datetime(utc) {|utc|
+      TimeOrDateTime.wrap(utc) {|utc|
         period_for_utc(utc).to_local(utc)
       }
     end
     
     # Converts a time in the local timezone to UTC. local can either be
-    # a DateTime or a Time. The returned time has the same type as local.
-    # Any timezone information in local is ignored (it is treated as a local time).
+    # a DateTime, Time or timestamp (Time.to_i). The returned time has the same
+    # type as local. Any timezone information in local is ignored (it is treated
+    # as a local time).
     #
     # Warning: There are local times that have no equivalent UTC times (e.g.
     # in the transition from standard time to daylight savings time). There are
@@ -323,7 +329,7 @@ module TZInfo
     # single period to use to convert the time or return nil or an empty array
     # to cause an AmbiguousTime exception to be raised.
     def local_to_utc(local, dst = nil)
-      run_on_datetime(local) {|local|
+      TimeOrDateTime.wrap(local) {|local|
         if block_given?
           period = period_for_local(local, dst) {|periods| yield periods }
         else
@@ -348,7 +354,8 @@ module TZInfo
     # is the time, the second element is the period.
     def current_period_and_time
       utc = Time.now.utc
-      [utc_to_local(utc), period_for_utc(utc)]
+      period = period_for_utc(utc)
+      [period.to_local(utc), period]
     end
     
     alias :current_time_and_period :current_period_and_time
@@ -401,32 +408,6 @@ module TZInfo
               end              
 CODE
       end
-    
-    private
-      # If called with a Time, returns an equivalent DateTime; otherwise returns
-      # the datetime paramter.
-      def as_datetime(datetime)
-        if datetime.instance_of?(Time)
-          DateTime.new(datetime.year, datetime.mon, datetime.mday, datetime.hour, datetime.min, datetime.sec)
-        else
-          datetime
-        end
-      end
-    
-      # Executes a block with a DateTime. If datetime is a Time it will be
-      # converted to a DateTime before yielding to the block and the result of
-      # the block will be converted back to a Time.
-      def run_on_datetime(datetime)
-        if datetime.instance_of?(Time)
-          datetime = DateTime.new(datetime.year, datetime.mon, datetime.mday, datetime.hour, datetime.min, datetime.sec)
-          result = yield datetime
-          
-          # not necessarily utc, but pretend it is
-          Time.utc(result.year, result.mon, result.mday, result.hour, result.min, result.sec)
-        else
-          yield datetime
-        end
-      end            
   end 
   
   # A proxy class representing a timezone with a given identifier. It can be