ruby-units 0.3.2 → 0.3.3

data/CHANGELOG

@@ -106,17 +106,27 @@ Change Log for Ruby-units
                     * 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
+                    * '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
 
-2006-10-02  0.3.0   * Performance enhanced by caching results of many functions
-                      (Thanks to Kurt Stephens for pushing this.)
+2006-10-02  0.3.0   * Performance enhanced by caching results of many
+                      functions (Thanks to Kurt Stephens for pushing this.)
                     * Throws an exception if the unit is not recognized
-                    * units can now identify what 'kind' they are (:length, :mass, etc..)
+                    * units can now identify what 'kind' they are 
+                      (:length, :mass, etc..)
                     * New constructors:  
                       Unit(1,"mm") 
                       Unit(1,"mm/s")
                       Unit(1,"mm","s")
+                      
 2006-10-02  0.3.1   * minor bug fixes
 
-2006-10-03  0.3.2   * bug fix for compatibility with Rails
+2006-10-03  0.3.2   * More minor bug fixes 
+                      (now fixes a minor name collision with rails)
+
+2006-10-03  0.3.3   * Apparently I can't do math late at night.  
+                      Fixed a bug that would cause problems when adding
+                      or subtracting units to a unit with a zero scalar. 
+                    * Date and DateTime objects can be converted to 'units'

data/lib/ruby-units.rb

@@ -2,7 +2,7 @@ require 'mathn'
 require 'rational'
 require 'date'
 require 'parsedate'
-# = Ruby Units 0.3.1
+# = Ruby Units 0.3.3
 #
 # Copyright 2006 by Kevin C. Olbrich, Ph.D.
 # 
@@ -40,7 +40,7 @@ require 'parsedate'
 class Unit < Numeric
   require 'units'
   # pre-generate hashes from unit definitions for performance.  
-  VERSION = '0.3.0'
+  VERSION = '0.3.3'
   @@USER_DEFINITIONS = {}
   @@PREFIX_VALUES = {}
   @@PREFIX_MAP = {}
@@ -129,8 +129,7 @@ class Unit < Numeric
     end
     @@PREFIX_REGEX = @@PREFIX_MAP.keys.sort_by {|prefix| prefix.length}.reverse.join('|')
     @@UNIT_REGEX = @@UNIT_MAP.keys.sort_by {|unit| unit.length}.reverse.join('|')
-    @@UNIT_MATCH_REGEX = /(#{@@PREFIX_REGEX})*?(#{@@UNIT_REGEX})\b/  
-    
+    @@UNIT_MATCH_REGEX = /(#{@@PREFIX_REGEX})*?(#{@@UNIT_REGEX})\b/    
   end
   
   
@@ -214,6 +213,10 @@ class Unit < Numeric
       @scalar = options[0].to_f
       @numerator = ['<second>']
       @denominator = UNITY_ARRAY
+    when DateTime:
+      @scalar = options[0].ajd
+      @numerator = ['<day>']
+      @denominator = UNITY_ARRAY
     else
       raise ArgumentError, "Invalid Unit Format"
     end
@@ -265,7 +268,8 @@ class Unit < Numeric
     return @is_base = true
   end  
   
-  #convert to base SI units
+  # convert to base SI units
+  # results of the conversion are cached so subsequent calls to this will be fast
   def to_base
     return self if self.is_base?
     cached = @@base_unit_cache[self.units] * self.scalar rescue nil
@@ -302,11 +306,17 @@ class Unit < Numeric
   end
   
   # Generate human readable output.
-  # If the name of a unit is passed, the scalar will first be converted to the target unit before output.
+  # If the name of a unit is passed, the unit will first be converted to the target unit before output.
   # some named conversions are available
   #
   #  :ft - outputs in feet and inches (e.g., 6'4")
   #  :lbs - outputs in pounds and ounces (e.g, 8 lbs, 8 oz)
+  #  
+  # You can also pass a standard format string (i.e., '%0.2f')
+  # or a strftime format string.
+  #
+  # output is cached so subsequent calls for the same format will be fast
+  #
   def to_s(target_units=nil)
     out = @output[target_units] rescue nil
     if out
@@ -334,6 +344,7 @@ class Unit < Numeric
     end    
   end
   
+  # Normally pretty prints the unit, but if you really want to see the guts of it, pass ':dump'
   def inspect(option=nil)
     return super() if option == :dump
     self.to_s
@@ -395,11 +406,12 @@ class Unit < Numeric
   
   # Add two units together.  Result is same units as receiver and scalar and base_scalar are updated appropriately
   # throws an exception if the units are not compatible.
+  # It is possible to add Time objects to units of time
   def +(other)   
     if Unit === other 
       if self =~ other then
-        q = self.zero? ? 1 : (self.scalar / self.base_scalar)
-        Unit.new(:scalar=>(self.base_scalar + other.base_scalar)*q, :numerator=>@numerator, :denominator=>@denominator, :signature => @signature)
+        @q ||= @@cached_units[self.units].scalar / @@cached_units[self.units].base_scalar
+        Unit.new(:scalar=>(self.base_scalar + other.base_scalar)*@q, :numerator=>@numerator, :denominator=>@denominator, :signature => @signature)
       else
          raise ArgumentError,  "Incompatible Units"
       end
@@ -416,8 +428,8 @@ class Unit < Numeric
   def -(other)
     if Unit === other 
       if self =~ other then
-        q = self.zero? ? 1 : (self.scalar / self.base_scalar)
-        Unit.new(:scalar=>(self.base_scalar - other.base_scalar)*q, :numerator=>@numerator, :denominator=>@denominator, :signature=>@signature)
+        @q ||= @@cached_units[self.units].scalar / @@cached_units[self.units].base_scalar
+        Unit.new(:scalar=>(self.base_scalar - other.base_scalar)*@q, :numerator=>@numerator, :denominator=>@denominator, :signature=>@signature)
       else
          raise ArgumentError,  "Incompatible Units"
       end
@@ -699,6 +711,10 @@ class Unit < Numeric
   alias :time :to_time
   alias :to_i :to_int
   alias :truncate :to_int
+
+  def to_datetime
+    DateTime.new(self.to('d').scalar)
+  end
   
   def round
     Unit.new(@scalar.round, @numerator, @denominator)    
@@ -988,7 +1004,7 @@ end
 # Date.today + U"1 week" => gives today+1 week
 class Date
   alias :unit_date_add :+
-  def +unit
+  def +(unit)
     case unit
     when Unit:
       unit = unit.to('d').round if ['y', 'decade', 'century'].include? unit.units 
@@ -1000,7 +1016,7 @@ class Date
   end
 
   alias :unit_date_sub :-    
-  def -unit
+  def -(unit)
     case unit
     when Unit: 
       unit = unit.to('d').round if ['y', 'decade', 'century'].include? unit.units 
@@ -1011,6 +1027,11 @@ class Date
     end
   end
   
+  def to_unit(other = nil)
+    other ? Unit.new(self).to(other) : Unit.new(self)
+  end
+  alias :unit :to_unit
+  
   def to_time
     Time.local(*ParseDate.parsedate(self.to_s))
   end
@@ -1072,7 +1093,6 @@ class String
   
   #needed for compatibility with Rails, which defines a String.from method  
   if self.public_instance_methods.include? 'from'
-    puts 'rails'
     alias :old_from :from
   end 
   
@@ -1162,8 +1182,8 @@ class Time
     end
   end
   
-  def to_unit(other = "s")
-    other ? Unit.new("#{self.to_f} s").to(other) : Unit.new("#{self.to_f} s")
+  def to_unit(other = nil)
+    other ? Unit.new(self).to(other) : Unit.new(self)
   end
   alias :unit :to_unit
   alias :u :to_unit
@@ -1186,6 +1206,7 @@ class Time
     end
   end
   
+  # usage: Time.in '5 min'
   def self.in(duration)
     Time.now + duration.to_unit
   end

data/test/test_ruby-units.rb

@@ -248,6 +248,40 @@ class TestRubyUnits < Test::Unit::TestCase
     }
   end
   
+  def test_add_operator
+    a = '0 mm'.unit
+    b = '10 cm'.unit
+    c = '1 in'.unit
+    d = '1 ml'.unit
+    
+    assert_equal (a+b).scalar, 100
+    assert_equal (a+b).units, 'mm'
+    assert_equal (b+a).scalar, 10
+    assert_equal (b+a).units, 'cm'
+    assert_in_delta 0.01, (b+c).scalar, 12.54
+    assert_equal (b+c).units, 'cm'
+    assert_raises(ArgumentError) {
+      a + d
+    }
+  end
+  
+  def test_subtract_operator
+    a = '0 mm'.unit
+    b = '10 cm'.unit
+    c = '1 in'.unit
+    d = '1 ml'.unit
+    
+    assert_equal (a-b).scalar, -100
+    assert_equal (a-b).units, 'mm'
+    assert_equal (b-a).scalar, 10
+    assert_equal (b-a).units, 'cm'
+    assert_in_delta 0.01, (b-c).scalar, 7.46
+    assert_equal (b-c).units, 'cm'
+    assert_raises(ArgumentError) {
+      a - d
+    }
+  end
+  
   def test_convert_to
     unit1 = Unit.new("1 mm")
     unit2 = Unit.new("1 ft")
@@ -404,6 +438,7 @@ class TestRubyUnits < Test::Unit::TestCase
       unit3 = unit1 * unit2
       assert_equal Unit.new("1 m^2/ms^2"), unit3    
     }
+    assert_equal unit1 * 0, '0 m/ms'.unit
   end
   
   def test_divide
@@ -413,6 +448,12 @@ class TestRubyUnits < Test::Unit::TestCase
       unit3 = unit1 / unit2
       assert_equal Unit.new("1 M"), unit3
       }
+    assert_equal unit2 / 1, unit2
+    unit3 = '0 s'.unit
+    assert_raises(ZeroDivisionError) {
+      unit1 / unit3
+    }
+    
     assert_raises(ZeroDivisionError) {
       unit1 / 0
     }
@@ -422,6 +463,7 @@ class TestRubyUnits < Test::Unit::TestCase
     unit1 = Unit.new("1 m")
     unit2 = Unit.new("1 1/m")
     assert_equal unit2, unit1.inverse
+    assert_raises (ZeroDivisionError) { 0.unit.inverse }
   end
   
   def test_exponentiate_positive

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
-date: 2006-10-03 00:00:00 -04:00
+  version: 0.3.3
+date: 2006-10-05 00:00:00 -04:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
 - lib