ruby-units 0.2.2 → 0.2.3

data/CHANGELOG

@@ -100,4 +100,13 @@ Change Log for Ruby-units
                     * added Time.in("5 min")
                     * added Unit.to_unit to simplify some calls
                     
+2006-09-22  0.2.3   * added support for date/time parsing with the Chronic gem
+                      parsing will use Chronic if it is loaded
+                    * allows Date / Time / DateTime conversions
+                    * better test coverage
+                    * The 'string'.to_time returns a Time object
+                    * 'string'.to_datetime returns a DateTime object
+                    * 'string'.time returns a Time object or a DateTime if the Time object fails
+                    * 'string'.datetime returns a DateTime or a Time if the DateTime fails
+                    
                        

data/README

@@ -1,6 +1,6 @@
 =Ruby Units
 
-Version: 0.2.1
+Version: 0.2.3
 
 Kevin C. Olbrich, Ph.D. 
 

data/lib/ruby-units.rb

@@ -2,7 +2,7 @@ require 'mathn'
 require 'rational'
 require 'date'
 require 'parsedate'
-# = Ruby Units 0.2.2
+# = Ruby Units 0.2.3
 #
 # Copyright 2006 by Kevin C. Olbrich, Ph.D.
 # 
@@ -135,7 +135,10 @@ class Unit < Numeric
     return true if @signature == 400 && @numerator.size == 1 && @numerator[0] =~ /(celcius|kelvin|farenheit|rankine)/
     n = @numerator + @denominator
     n.compact.each do |x|
-      return false unless x == '<1>' || (@@UNIT_VALUES[Regexp.escape(x)] &&  @@UNIT_VALUES[Regexp.escape(x)][:denominator].nil? && @@UNIT_VALUES[Regexp.escape(x)][:numerator].include?(Regexp.escape(x)))
+      return false unless x == '<1>' || 
+        (@@UNIT_VALUES[Regexp.escape(x)] &&  
+          @@UNIT_VALUES[Regexp.escape(x)][:denominator].nil? && 
+            @@UNIT_VALUES[Regexp.escape(x)][:numerator].include?(Regexp.escape(x)))
     end
     return true
   end  
@@ -564,14 +567,14 @@ class Unit < Numeric
   
   # '5 min'.unit.ago 
   def ago
-    Time.now - self
+    Time.now - self rescue DateTime.now - self
   end
   
   # '5 min'.before(time)
   def before(time_point = ::Time.now)
     raise ArgumentError, "Must specify a Time" unless time_point
     if String === time_point
-      Time.local(*ParseDate.parsedate(time_point))-self 
+      time_point.time - self
     else
       time_point - self
     end
@@ -583,9 +586,10 @@ class Unit < Numeric
     case time_point
     when Time:      (Time.now - time_point).unit('s').to(self)
     when DateTime:  (DateTime.now - time_point).unit('d').to(self)
-    when String:    (Time.now - Time.local(*ParseDate.parsedate(time_point))).unit('s').to(self) 
+    when String:    
+      (DateTime.now - time_point.time(:context=>:past)).unit('d').to(self)
     else
-      raise ArgumentError, "Must specify a Time" unless time_point
+      raise ArgumentError, "Must specify a Time, DateTime, or String" 
     end
   end
   
@@ -594,9 +598,11 @@ class Unit < Numeric
     case time_point
     when Time:      (time_point - Time.now).unit('s').to(self)
     when DateTime:  (time_point - DateTime.now).unit('d').to(self)
-    when String:    (Time.local(*ParseDate.parsedate(time_point)) - Time.now).unit('s').to(self)
+    when String:
+      r = (time_point.time(:context=>:future) - DateTime.now)
+      Time === time_point.time ? r.unit('s').to(self) : r.unit('d').to(self)
     else
-      raise ArgumentError, "Must specify a Time" unless time_point
+      raise ArgumentError, "Must specify a Time, DateTime, or String" 
     end
   end
   
@@ -604,7 +610,7 @@ class Unit < Numeric
   def from(time_point = ::Time.now)
     raise ArgumentError, "Must specify a Time" unless time_point
     if String === time_point
-      Time.local(*ParseDate.parsedate(time_point))+self
+      time_point.time + self
     else
       time_point + self
     end
@@ -659,7 +665,6 @@ class Unit < Numeric
   def replace_temperature
     return self unless self.signature == 400 && self.units =~ /temp(R|K|F|C)/
     un = $1
-    puts "self:#{self} #{un}"
     target = self.units
     @numerator = case un
       when 'R' : ['<rankine>']
@@ -822,25 +827,15 @@ class Unit < Numeric
   end 
 end
 
-# Need the 'Uncertain' gem for this to do anything helpful
-if defined? Uncertain
-  class Uncertain
-    def to_unit(other=nil)
-      other ? Unit.new(self).to(other) : Unit.new(self)
-    end
-    alias :unit :to_unit
-    alias :u :to_unit
-  end
-end
-
 
 # Allow date objects to do offsets by a time unit
 # Date.today + U"1 week" => gives today+1 week
 class Date
   alias :unit_date_add :+
   def +(unit)
-    if Unit === unit
-      unit_date_add(unit.to('day').scalar)
+    case unit
+    when Unit: unit_date_add(unit.to('day').scalar)
+    when Time: unit_date_add(unit.to_datetime)
     else
       unit_date_add(unit)
     end
@@ -848,12 +843,24 @@ class Date
 
   alias :unit_date_sub :-    
   def -(unit)
-    if Unit === unit
-      unit_date_sub(unit.to('day').scalar)
+    case unit
+    when Unit: unit_date_sub(unit.to('day').scalar)
+    when Time: unit_date_sub(unit.to_datetime)
     else
       unit_date_sub(unit)
     end
   end
+  
+  def to_time
+    Time.local(*ParseDate.parsedate(self.to_s))
+  end
+  
+  alias :units_datetime_inspect :inspect
+  def inspect(raw = false)
+    return self.units_datetime_inspect if raw
+    self.to_s
+  end
+  
 end
 
 class Object
@@ -894,8 +901,9 @@ class String
   
   # format unit output using formating codes '%0.2f' % '1 mm'.unit => '1.00 mm'
   def %(*args)
-    if Unit === args[0]
-      args[0].to_s(self)
+    case args[0]
+    when Unit: args[0].to_s(self)
+    when Complex: args[0].to_s
     else
       unit_format(*args)
     end
@@ -927,6 +935,36 @@ class String
   def to(other)
     self.unit.to(other)
   end
+  
+  def time(options = {})
+    self.to_time(options) rescue self.to_datetime(options)
+  end
+  
+  def to_time(options = {})
+    begin
+      #raises exception when Chronic not defined or when it returns a nil (i.e., can't parse the input)
+      r = Chronic.parse(self,options)
+      raise(ArgumentError, 'Invalid Time String') unless r
+      return r
+    rescue
+      Time.local(*ParseDate.parsedate(self))
+    end
+  end
+  
+  def to_datetime(options = {})
+    begin
+      # raises an exception if Chronic.parse = nil or if Chronic not defined
+      r = Chronic.parse(self,options).to_datetime
+    rescue
+      r=DateTime.civil(*ParseDate.parsedate(self)[0..5].compact)
+    end
+    raise RuntimeError, "Invalid Time String" if r == DateTime.new      
+    return r
+  end
+
+  def datetime(options = {})
+    self.to_datetime(options) rescue self.to_time(options)
+  end
 end
 
 
@@ -951,9 +989,15 @@ class Time
   alias :unit :to_unit
   alias :u :to_unit
   alias :unit_add :+
+  
+  def to_datetime
+    DateTime.civil(1970,1,1)+(self.to_f+self.gmt_offset)/86400
+  end
+  
   def +(other)
-    if Unit === other
-      unit_add(other.to('s').scalar)
+    case other
+    when Unit: unit_add(other.to('s').scalar)
+    when DateTime: unit_add(other.to_time)
     else
       unit_add(other)
     end
@@ -965,8 +1009,9 @@ class Time
   
   alias :unit_sub :-
   def -(other)
-    if Unit === other
-      unit_sub(other.to('s').scalar)
+    case other
+    when Unit: unit_sub(other.to('s').scalar)
+    when DateTime: unit_sub(other.to_time)
     else
       unit_sub(other)
     end

data/lib/units.rb

@@ -101,10 +101,10 @@ UNIT_DEFINITIONS = {
   #time
   '<second>'=>  [%w{s sec second seconds}, 1.0, :time, %w{<second>}],
   '<minute>'=>  [%w{min minute minutes}, 60.0, :time, %w{<second>}],  
-  '<hour>'=>  [%w{h hour hours}, 3600.0, :time, %w{<second>}],  
+  '<hour>'=>  [%w{h hr hrs hour hours}, 3600.0, :time, %w{<second>}],  
   '<day>'=>  [%w{d day days}, 3600*24, :time, %w{<second>}],
   '<week>'=>  [%w{wk week weeks}, 7*3600*24, :time, %w{<second>}],
-  '<fortnight>'=> [%w{fortnight}, 1209600, :time, %W{<second>}],
+  '<fortnight>'=> [%w{fortnight fortnights}, 1209600, :time, %W{<second>}],
   '<year>'=>  [%w{y yr year years annum}, 31556926, :time, %w{<second>}],
   '<decade>'=>[%w{decade decades}, 315569260, :time, %w{<second>}],
   '<century>'=>[%w{century centuries}, 3155692600, :time, %w{<second>}],

data/test/test_ruby-units.rb

@@ -3,6 +3,7 @@ require 'rubygems'
 require 'ruby-units'
 require 'yaml'
 require 'uncertain'
+require 'chronic'
 
 class Unit < Numeric
   @@USER_DEFINITIONS = {'<inchworm>' =>  [%w{inworm inchworm}, 0.0254, :length, %w{<meter>} ],
@@ -11,7 +12,51 @@ class Unit < Numeric
   Unit.setup
 end
 
+class Time
+  @@forced_now = nil
+  class << self
+    alias :unforced_now :now
+    def forced_now
+      return @@forced_now ? @@forced_now : unforced_now
+    end
+    alias :now :forced_now
+    
+    def forced_now=(now)
+      @@forced_now = now
+    end
+    
+  end
+end
+
+class DateTime
+  @@forced_now = nil
+  class << self
+    alias :unforced_now :now
+    def forced_now
+      return @@forced_now ? @@forced_now : unforced_now
+    end
+    alias :now :forced_now
+    
+    def forced_now=(now)
+      @@forced_now = now
+    end
+    
+  end
+end
+
 class TestRubyUnits < Test::Unit::TestCase
+ 
+  def setup
+    @april_fools = Time.at 1143910800
+    @april_fools_datetime = DateTime.parse('2006-4-1 12:00')
+    Time.forced_now = @april_fools
+    DateTime.forced_now = @april_fools_datetime 
+  end
+  
+  def teardown
+    Time.forced_now = nil
+    DateTime.forced_now = nil
+  end
   
   def test_to_yaml
     unit = "1 mm".u
@@ -29,9 +74,44 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_in_delta "1 h".unit + Time.now, "1 h".from_now, 1
     assert_in_delta Time.now - 3600, "1 h".before_now, 1
     assert_in_delta (Time.now.unit - Time.now).unit.scalar, 0, 1
-
     assert_equal "60 min", "min".until(Time.now + 3600).to_s
     assert_equal "01:00", "min".since(Time.now - 3600).to_s("%H:%M")
+    assert_in_delta Time.now, "now".time, 1
+  end
+  
+  def test_time_helpers
+    assert_equal @april_fools, Time.now
+    assert_equal "1 day".from_now, @april_fools + 86400
+    assert_equal "1 day".from("now"), @april_fools + 86400
+    assert_equal "1 day".ago, @april_fools - 86400
+    assert_equal "1 day".before_now, @april_fools - 86400
+    assert_equal '1 days'.before('now'), @april_fools - 86400
+    assert_equal 'days'.since(@april_fools - 86400), "1 day".unit
+    assert_equal 'days'.since('3/31/06 12:00'), "1 day".unit
+    assert_equal 'days'.since(DateTime.parse('2006-3-31 12:00')), "1 day".unit
+    assert_equal 'days'.until('4/2/2006'), '1 day'.unit
+    assert_equal 'now'.time, Time.now
+    assert_equal 'now'.datetime, DateTime.now
+    assert_raises(ArgumentError) { 'days'.until(1) }
+    assert_raises(ArgumentError) { 'days'.since(1) }
+    assert_equal Unit.new(Time.now).scalar,  1143910800
+    assert_equal @april_fools.unit.to_time, @april_fools
+    assert_equal Time.in('1 day'), @april_fools + 86400
+    assert_equal @april_fools_datetime.inspect, "2006-04-01T12:00:00Z"
+  end
+  
+  def test_string_helpers
+    assert_equal '1 mm'.to('in'), Unit('1 mm').to('in')
+  end
+  
+  def test_math
+    pi = Math::PI
+    assert_equal Math.sin(pi), Math.sin("180 deg".unit)
+    assert_equal Math.cos(pi), Math.cos("180 deg".unit)
+    assert_equal Math.tan(pi), Math.tan("180 deg".unit)
+    assert_equal Math.sinh(pi), Math.sinh("180 deg".unit)
+    assert_equal Math.cosh(pi), Math.cosh("180 deg".unit)
+    assert_equal Math.tanh(pi), Math.tanh("180 deg".unit)
   end
 
   def test_clone
@@ -68,6 +148,7 @@ class TestRubyUnits < Test::Unit::TestCase
   
   def test_to_unit
     unit1 = "1 mm".to_unit
+    assert_equal unit1, unit1.to_unit
     assert Unit === unit1
     unit2 = Unit("1 mm")
     assert Unit === unit1
@@ -431,6 +512,11 @@ class TestRubyUnits < Test::Unit::TestCase
   end
   
   def test_temperature_conversions
+    assert_in_delta '0 tempC'.unit.scalar, '273.15 degK'.unit.scalar, 0.01
+    assert_in_delta '0 tempF'.unit.scalar, '255.37 degK'.unit.scalar, 0.01
+    assert_in_delta '0 tempK'.unit.scalar, '0 degK'.unit.scalar, 0.01
+    assert_in_delta '0 tempR'.unit.scalar, '0 degK'.unit.scalar, 0.01
+
     unit1 = Unit.new("37 degC")
     unit2 = unit1 >> "tempF"
     assert_in_delta 98.6, unit2.scalar, 0.1
@@ -615,4 +701,19 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_equal "cells", a.units
   end
   
+  def test_uncertain
+    if defined? Uncertain
+      a = Uncertain.new(1,1)
+      b = a.unit('mm')
+      assert_equal b.to_s, '1 +/- 1 mm' 
+    else
+      fail "Can't test Uncertain Units unless 'Uncertain' gem is installed"
+    end  
+  end
+  
+  def test_format
+    assert_equal "%0.2f" % "1 mm".unit, "1.00 mm"
+    
+  end
+  
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
-date: 2006-09-19 00:00:00 -04:00
+  version: 0.2.3
+date: 2006-09-22 00:00:00 -04:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
 - lib