unix_epoch 0.1.0 → 0.2.0

data/README.rdoc

@@ -28,6 +28,18 @@ Documentation is available online at at rdoc.info[http://rdoc.info/projects/chet
 
   sudo gem install unix_epoch
 
+== FURTHER READING:
+
+Here's some good information on various Calendar systems:
+
+* http://mysite.verizon.net/aesir_research/date/back.htm
+* https://secure.wikimedia.org/wikipedia/en/wiki/Julian_day
+* http://www.fourmilab.ch/solar/help/timedate.html
+
+And the Perl library from which I borrowed some ideas:
+
+* http://search.cpan.org/~chorny/DateTime-Format-Epoch-0.13/
+
 == LICENSE:
 
 (The MIT License)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/unix_epoch.rb

@@ -4,6 +4,7 @@
 # better understood by Ruby's DateTime library
 
 require 'date'
+require 'tzinfo'
 
 module UnixEpoch
 
@@ -12,10 +13,14 @@ module UnixEpoch
         # Create a new DateTime object from a given Unix Timestamp
         #
         # @param [Fixnum, Bignum] unix_ts       seconds since unix epoch (1970-01-01 00:00:00 UTC)
-        # @param [Fixnum] offset        offset in seconds from UTC time
+        # @param [Fixnum, TZInfo::Timezone] offset        offset in seconds from UTC time or an instance of TZInfo::TimeZone
         # @return [DateTime]            DateTime object representation of the given Unix TS
         def from_unix_ts(unix_ts, offset = 0)
 
+            if not (offset.respond_to? :to_i or offset.kind_of? TZInfo::Timezone) then
+                raise "Invalid value passed for offset: must be an integer or TZInfo::Timezone"
+            end
+
             # step 1) get the delta in days, seconds and nano seconds represented by unix_ts
 
             delta_days = UnixEpoch._floor(unix_ts / 86_400)
@@ -36,10 +41,19 @@ module UnixEpoch
 
             jd_days = epoch_jd_days + delta_days
 
-            secs = epoch_secs + delta_secs + offset # add tz offset back in also
+            secs = epoch_secs + delta_secs
+            if offset.respond_to? :to_i
+                secs += offset # add tz offset back in also
+            end
             jd_secs = UnixEpoch.secs_to_jd_secs(secs) + Rational(delta_nano.round, 86_400_000_000)
 
-            return DateTime.from_jd(jd_days, jd_secs, offset)
+            if offset.respond_to? :to_i
+                return DateTime.from_jd(jd_days, jd_secs, offset)
+            elsif offset.kind_of? TZInfo::Timezone
+                dt = DateTime.from_jd(jd_days, jd_secs, 0) # first create a new DateTime
+                ldt = offset.utc_to_local(dt) # then convert it to our target TZ
+                return DateTime.from_jd(ldt.jd, ldt.day_fraction, (ldt.to_i - dt.to_i)) # then create a new DateTime with the current offset
+            end
         end
 
     end
@@ -84,17 +98,17 @@ module UnixEpoch
     end
 
     # Retrieve the seconds part of the given Julian Date
-	#
-	# @param [Float]	Julian Date including fractional value (e.g., 2455647.543)
-	# @return [Fixnum]	Number of seconds represented by the fractional value
+    #
+    # @param [Float]    Julian Date including fractional value (e.g., 2455647.543)
+    # @return [Fixnum]  Number of seconds represented by the fractional value
     def self.get_jd_secs(jd)
         jd_fr_to_secs(jd % 1)
     end
 
     # Convert the given Julian Date fractional value into seconds
-	#
-	# @param [Float]	Julian Date fractional value (e.g., 0.543)
-	# @return [Fixnum]	Number of seconds represented by the fractional value
+    #
+    # @param [Float]    Julian Date fractional value (e.g., 0.543)
+    # @return [Fixnum]  Number of seconds represented by the fractional value
     def self.jd_fr_to_secs(fr)
         h, m, s = DateTime.day_fraction_to_time(fr)
         (h * 3600 + m * 60 + s)

data/test/unix_epoch_test.rb

@@ -1,6 +1,8 @@
 
+require 'rubygems'
 require 'test/unit'
 require 'unix_epoch'
+require 'timezone_local'
 
 class UnixEpoch_Test < Test::Unit::TestCase
 
@@ -41,4 +43,10 @@ class UnixEpoch_Test < Test::Unit::TestCase
         assert t.to_i == i
         assert d.to_unix_ts == i
     end
+
+    def test_from_unix_ts_with_tzinfo
+        tz = TZInfo::Timezone.get_local_timezone
+        i = 1301103992
+        assert DateTime.from_unix_ts(i, tz).strftime(@f) == Time.at(i).strftime(@f)
+    end
 end

data/unix_epoch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{unix_epoch}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chetan Sarva"]
-  s.date = %q{2011-03-26}
+  s.date = %q{2011-03-28}
   s.description = %q{Adds from_unix_ts and to_unix_ts methods to the DateTime class}
   s.email = %q{chetan@pixelcop.net}
   s.extra_rdoc_files = [
@@ -25,16 +25,17 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/chetan/unix_epoch}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.0}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Adds methods to DateTime for dealing with Unix Timestamps}
   s.test_files = [
     "test/unix_epoch_test.rb"
   ]
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else
     end
   else

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: unix_epoch
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chetan Sarva
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 00:00:00 -04:00
+date: 2011-03-28 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -44,27 +43,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Adds methods to DateTime for dealing with Unix Timestamps