ruby-units 0.3.7 → 0.3.8

data/CHANGELOG.txt

@@ -151,4 +151,7 @@ Change Log for Ruby-units
                     * Improved handling for units with non-alphanumeric names
                       (like ' for feet, # for pound)
                     * Now you can enter durations as "HH:MM:SS, usec" or
-                      "HH:MM:SS:usec"
+                      "HH:MM:SS:usec"
+                      
+2006-12-15  0.3.8   * Any object that supports a 'to_unit' method will now be 
+                      automatically coerced to a unit during math operations.

data/lib/ruby-units.rb

@@ -2,7 +2,7 @@ require 'mathn'
 require 'rational'
 require 'date'
 require 'parsedate'
-# = Ruby Units 0.3.7
+# = Ruby Units 0.3.8
 #
 # 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.7'
+  VERSION = '0.3.8'
   @@USER_DEFINITIONS = {}
   @@PREFIX_VALUES = {}
   @@PREFIX_MAP = {}
@@ -640,9 +640,7 @@ class Unit < Numeric
   alias :>> :to
   alias :convert_to :to
     
-  # Eliminates terms in the passed numerator and denominator.  Expands out prefixes and applies them to the 
-  # scalar.  Returns a hash that can be used to initialize a new Unit object. 
-  # converts the unit back to a float if it is unitless
+  # converts the unit back to a float if it is unitless.  Otherwise raises an exception
   def to_f
     return @scalar.to_f if self.unitless?
     raise RuntimeError, "Can't convert to float unless unitless.  Use Unit#scalar"
@@ -708,13 +706,13 @@ class Unit < Numeric
     Unit.new(@scalar.floor, @numerator, @denominator)    
   end
 
-  # if unitless, returns an int
+  # if unitless, returns an int, otherwise raises an error
   def to_int
     return @scalar.to_int if self.unitless?
     raise RuntimeError, 'Cannot convert to Integer, use Unit#scalar'
   end
   
-  # Tries to make a Time object from current unit
+  # Tries to make a Time object from current unit.  Assumes the current unit hold the duration in seconds from the epoch.
   def to_time
     Time.at(self)
   end
@@ -726,6 +724,8 @@ class Unit < Numeric
     Unit.new(@scalar.truncate, @numerator, @denominator)    
   end
 
+  # convert a duration to a DateTime.  This will work so long as the duration is the duration from the zero date
+  # defined by DateTime
   def to_datetime
     DateTime.new(self.to('d').scalar)
   end
@@ -792,14 +792,21 @@ class Unit < Numeric
   end
   alias :after :from
   alias :from_now :from
-      
+  
+  # returns next unit in a range.  '1 mm'.unit.succ #=> '2 mm'.unit
+  # only works when the scalar is an integer    
   def succ
     raise ArgumentError, "Non Integer Scalar" unless @scalar == @scalar.to_i
     q = @scalar.to_i.succ
     Unit.new(q, @numerator, @denominator)
   end
 
+  # automatically coerce objects to units when possible
+  # if an object defines a 'to_unit' method, it will be coerced using that method
   def coerce(other)
+    if other.respond_to? :to_unit
+      return [other.to_unit, self]
+    end
     case other
     when Unit : [other, self]
     else 
@@ -1017,7 +1024,7 @@ class Unit < Numeric
     @denominator = bottom.scan(@@UNIT_MATCH_REGEX).delete_if {|x| x.empty?}.compact if bottom
     us = "#{(top || '' + bottom || '')}".to_s.gsub(@@UNIT_MATCH_REGEX,'').gsub(/[\d\*, "'_^\/\$]/,'')
     
-    raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized ('#{us}' left '#{top =~ @@UNIT_MATCH_REGEX}')") unless us.empty?
+    raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") unless us.empty?
 
     @numerator = @numerator.map do |item|
        @@PREFIX_MAP[item[0]] ? [@@PREFIX_MAP[item[0]], @@UNIT_MAP[item[1]]] : [@@UNIT_MAP[item[1]]]

data/test/test_ruby-units.rb

@@ -43,6 +43,12 @@ class DateTime
   end
 end
 
+class Dummy
+  def to_unit
+    '1 mm'.unit
+  end
+end
+
 class TestRubyUnits < Test::Unit::TestCase
  
   def setup
@@ -835,4 +841,10 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_equal "1:30:30".unit, "1.5 hour".unit + '30 sec'.unit
     assert_equal "1:30:30,200".unit, "1.5 hour".unit + '30 sec'.unit + '200 usec'.unit
   end
+  
+  def test_coercion
+    a = Dummy.new
+    b = '1 mm'.unit
+    assert_equal '2 mm'.unit, b + a
+  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.3.7
-date: 2006-12-14 00:00:00 -05:00
+  version: 0.3.8
+date: 2006-12-15 00:00:00 -05:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
 - lib