timezone 0.3.5 → 0.3.6

data/CHANGES.markdown

@@ -1,6 +1,10 @@
-# 0.3.5+
+# 0.3.6
 
-* `0.3.5` - Updated with tzdata-2014j-1. (panthomakos)
+* Added `Timezone::Zone#time_with_offset` functionality. (panthomakos)
+
+# 0.3.5
+
+* Updated with tzdata-2014j-1. (panthomakos)
 
 # 0.3.4
 

data/README.markdown

@@ -26,15 +26,22 @@ Getting the current time or any historical time in any timezone, with daylight
 savings time taken into consideration, is easy:
 
     timezone = Timezone::Zone.new :zone => 'America/Los_Angeles'
-    timezone.time Time.now
+
+    timezone.time(Time.now)
     => 2011-02-11 17:29:05 UTC
-    timezone.time Time.utc(2010, 1, 1, 0, 0, 0)
+
+    timezone.time(Time.utc(2010, 1, 1, 0, 0, 0))
     => 2009-12-31 16:00:00 UTC
 
-Time is always returned in the UTC timezone, but it accurately reflects the
-actual time in the specified timezone. The reason for this is that this function
-also takes into account daylight savings time, which can alter the timezone
-offset and hence put Ruby in the wrong timezone.
+    timezone.time_with_offset(Time.utc(2010,1,1,0,0,0))
+    => 2009-12-31 16:00:00 -0800
+
+Time is always returned in the UTC timezone when using the `time` function, but
+it accurately reflects the actual time in the specified timezone. The reason for
+this is that this function also takes into account daylight savings time and
+historical changes in timezone, which can alter the offset. If you want a time
+with the appropriate offset at the given time, then use the `time_with_offset`
+function as shown above.
 
 You can also query a `Timezone::Zone` object to determine if it was in Daylight
 Savings Time:

data/lib/timezone/version.rb

@@ -1,3 +1,3 @@
 module Timezone
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/lib/timezone/zone.rb

@@ -67,8 +67,25 @@ module Timezone
     # The reference is converted to a UTC equivalent. That UTC equivalent is then used to lookup the appropriate
     # offset in the timezone rules. Once the offset has been found that offset is added to the reference UTC time
     # to calculate the reference time in the timezone.
-    def time reference
-      reference.utc + rule_for_reference(reference)[OFFSET_BIT]
+    def time(reference)
+      reference.utc + utc_offset(reference)
+    end
+
+    # Determine the time in the timezone w/ the appropriate offset.
+    #
+    #     timezone.time_with_offset(reference)
+    #
+    # reference - the `Time` you want to convert.
+    #
+    # The reference is converted to a UTC equivalent. That UTC equivalent is
+    # then used to lookup the appropriate offset in the timezone rules. Once the
+    # offset has been found, that offset is added to the reference UTC time
+    # to calculate the reference time in the timezone. The offset is then
+    # appended to put the time object into the proper offset.
+    def time_with_offset(reference)
+      utc = time(reference)
+      offset = utc_offset(reference)
+      Time.new(utc.year, utc.month, utc.day, utc.hour, utc.min, utc.sec, offset)
     end
 
     # Whether or not the time in the timezone is in DST.
@@ -79,11 +96,11 @@ module Timezone
     # Get the current UTC offset in seconds for this timezone.
     #
     #   timezone.utc_offset(reference)
-    def utc_offset reference=Time.now
+    def utc_offset(reference=Time.now)
       rule_for_reference(reference)[OFFSET_BIT]
     end
 
-    def <=> zone #:nodoc:
+    def <=>(zone) #:nodoc:
       utc_offset <=> zone.utc_offset
     end
 

data/test/timezone_test.rb

@@ -147,6 +147,25 @@ class TimezoneTest < Test::Unit::TestCase
     assert_equal local.to_i, timezone.time(utc).to_i
   end
 
+  # Testing is done with strings since two times can be equivalent even if
+  # their offsets do not match, and we want to test that the time and offsets
+  # are equivalent.
+  def test_time_with_offset
+    timezone = Timezone::Zone.new :zone => 'Asia/Kathmandu'
+    utc = Time.utc(2011, 1, 4, 3, 51, 29)
+    local = Time.new(2011, 1, 4, 9, 36, 29, 20700)
+    assert_equal local.to_s, timezone.time_with_offset(utc).to_s
+
+    zone = Timezone::Zone.new(:zone => 'America/Los_Angeles')
+    utc = Time.utc(2014,12,15,22,00,00)
+    local = Time.new(2014,12,15,14,00,00,'-08:00')
+    assert_equal local.to_s, zone.time_with_offset(utc).to_s
+
+    utc = Time.utc(2014,4,5,22,00,00)
+    local = Time.new(2014,4,5,15,00,00,'-07:00')
+    assert_equal local.to_s, zone.time_with_offset(utc).to_s
+  end
+
   class HTTPTestClient
     class << self ; attr_accessor :body ; end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timezone
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -721,7 +721,7 @@ rubyforge_project: timezone
 rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
-summary: timezone-0.3.5
+summary: timezone-0.3.6
 test_files:
 - test/data/Helsinki_rules_without_timestamps.json
 - test/data/asia