ruby-units 0.1.0 → 0.1.1

data/CHANGELOG

@@ -0,0 +1,15 @@
+Change Log for Ruby-units
+=========================
+2006-08-22  0.1.0   * Initial Release
+2006-08-22  0.1.1   * Added new format option "1 mm".to_unit("in") now converts the result to the indicated units
+                    * Fixed some naming issues so that the gem name matches the require name.
+                    * Added CHANGELOG
+                    * Improved test coverage (100% code coverage via RCov)
+                    * fixed a bug that prevented units with a prefix in the denominator from converting properly
+                    * can use .unit method on a string to create a new unit object
+                    * can now coerce or define units from arrays, strings, numerics.
+                        "1 mm".unit + [1, 'mm'] === "2 mm".unit
+                        [1,'mm','s'].unit === "1 mm/s".unit
+                        2.5.unit === "2.5".unit
+                    * Added instructions on how to add custom units
+                        

data/lib/{ruby_units.rb → ruby-units.rb}

@@ -1,5 +1,4 @@
-
-# = Ruby Units
+# = Ruby Units 0.1.1
 #
 # Copyright 2006 by Kevin C. Olbrich, Ph.D.
 # 
@@ -11,7 +10,7 @@
 #
 # See README for detailed usage instructions and examples
 #
-# =Unit Definition Format
+# ==Unit Definition Format
 #
 #  '<name>'  => [%w{prefered_name synonyms}, conversion_to_base, :classification, %w{<base> <units> <in> <numerator>} , %w{<base> <units> <in> <denominator>} ],
 #
@@ -26,8 +25,14 @@
 # This package covers nearly all SI, Imperial, and units commonly used
 # in the United States. If your favorite units are not listed here, send me an email
 #
-# Future versions will provide a simple interface for the end-user to specify
-# custom units.
+# To add / override a unit definition, add a code block like this..
+#
+#  class Unit < Numeric
+#   UNIT_DEFINITIONS = {
+#    <name>'  => [%w{prefered_name synonyms}, conversion_to_base, :classification, %w{<base> <units> <in> <numerator>} , %w{<base> <units> <in> <denominator>} ]
+#    }
+#  end
+#  Unit.setup
 class Unit < Numeric
   require 'units'
   # pre-generate hashes from unit definitions for performance.  
@@ -77,14 +82,16 @@ class Unit < Numeric
   #  8 lbs 8 oz -- recognized as 8 lbs + 8 ounces
   #
   def initialize(options)
-    if options.kind_of? String
-      parse(options)
-    elsif options.kind_of? Hash
+    case options
+    when String: parse(options)
+    when Hash:
       @quantity = options[:quantity] || 1
       @numerator = options[:numerator] || ["<1>"]
       @denominator = options[:denominator] || []
+    when Array: parse("#{options[0]} #{options[1]}/#{options[2]}")
+    when Numeric: parse(options.to_s)
     else
-      raise ArgumentError, "Unknown Unit Specification"
+      raise ArgumentError, "Invalid Unit Format"
     end
     self.update_base_quantity
     self.unit_signature
@@ -120,16 +127,16 @@ class Unit < Numeric
           den << @@UNIT_VALUES[Regexp.escape(unit)][:denominator] if @@UNIT_VALUES[Regexp.escape(unit)] && @@UNIT_VALUES[Regexp.escape(unit)][:denominator]
         end
     end
-
     @denominator.each do |unit|
-        if @@PREFIX_MAP[Regexp.escape(unit)]
-          q /= @@PREFIX_MAP[Regexp.escape(unit)]
+        if @@PREFIX_VALUES[Regexp.escape(unit)]
+          q /= @@PREFIX_VALUES[Regexp.escape(unit)]
         else
           q /= @@UNIT_VALUES[Regexp.escape(unit)][:quantity] if @@UNIT_VALUES[Regexp.escape(unit)]
           den << @@UNIT_VALUES[Regexp.escape(unit)][:numerator] if @@UNIT_VALUES[Regexp.escape(unit)] && @@UNIT_VALUES[Regexp.escape(unit)][:numerator]
           num << @@UNIT_VALUES[Regexp.escape(unit)][:denominator] if @@UNIT_VALUES[Regexp.escape(unit)] && @@UNIT_VALUES[Regexp.escape(unit)][:denominator]
         end
     end
+    
     num = num.flatten.compact
     den = den.flatten.compact
     num = ['<1>'] if num.empty?
@@ -497,8 +504,10 @@ class Unit < Numeric
     case other
     when Unit : [other, self]
     when String : [Unit.new(other), self]
+    when Array: [Unit.new(other.join('*')), self]
+    when Numeric : [Unit.new(other.to_s), self]
     else 
-      [Unit.new(other.to_s), self]
+      raise ArgumentError, "Invalid Unit Definition"
     end
   end
   
@@ -587,10 +596,27 @@ end
 
 class Object
   def Unit(other)
-    Unit.new(other.to_s)
+    other.to_unit
   end
-  
-  def to_unit
-     Unit.new(self.to_s) unless Unit === self
+end
+
+class Numeric
+  def to_unit(other = nil)
+    other ? Unit.new(self.to_s) >> other : Unit.new(self.to_s)
+  end
+  alias :unit :to_unit
+end
+
+class Array
+  def to_unit(other = nil)
+    other ? Unit.new("#{self[0]} #{self[1]}/#{self[2]}") >> other : Unit.new("#{self[0]} #{self[1]}/#{self[2]}")
+  end
+  alias :unit :to_unit
+end
+
+class String
+  def to_unit(other = nil)
+    other ? Unit.new(self) >> other : Unit.new(self)
   end
+  alias :unit :to_unit
 end

data/test/{test_ruby_units.rb → test_ruby-units.rb}

@@ -1,13 +1,22 @@
 require 'test/unit'
-require 'ruby_units'
+require 'ruby-units'
 
 class Unit < Numeric
-  @@USER_DEFINITIONS = {'<inchworm>' =>  [%w{inworm inchworm}, 0.0254, :length, %w{<meter>} ]}
+  @@USER_DEFINITIONS = {'<inchworm>' =>  [%w{inworm inchworm}, 0.0254, :length, %w{<meter>} ],
+                        '<habenero>'   => [%{degH}, 100, :temperature, %w{<celcius>}]}
   Unit.setup
 end
 
 class TestRubyUnit < Test::Unit::TestCase
   
+  def test_clone
+    unit1= "1 mm".unit
+    unit2 = unit1.clone
+    assert_not_equal unit1.numerator.object_id, unit2.numerator.object_id
+    assert_not_equal unit1.denominator.object_id, unit2.denominator.object_id
+    assert unit1 === unit2
+  end 
+  
   def test_unary_minus
     unit1 = Unit.new("1 mm")
     unit2 = Unit.new("-1 mm")
@@ -27,7 +36,9 @@ class TestRubyUnit < Test::Unit::TestCase
   
   def test_to_base
     unit1 = Unit.new("100 cm")
-    assert_equal 1.0, unit1.to_base.quantity
+    assert_in_delta 1, 0.001, unit1.to_base.quantity
+    unit2 = Unit("1 mm^2 ms^-2")
+    assert_in_delta 1, 0.001, unit2.to_base.quantity
   end
   
   def test_to_unit
@@ -36,6 +47,18 @@ class TestRubyUnit < Test::Unit::TestCase
     unit2 = Unit("1 mm")
     assert Unit === unit1
     assert unit1 == unit2
+    unit1 = "2.54 cm".to_unit("in")
+    assert_in_delta 1, 0.001, unit1.quantity
+    assert_equal ['<inch>'], unit1.numerator
+    unit1 = "2.54 cm".unit("in")
+    assert_in_delta 1, 0.001, unit1.quantity
+    assert_equal ['<inch>'], unit1.numerator
+    unit1 = 1.unit
+    assert_in_delta 1, 0.001, unit1.quantity
+    assert_equal ['<1>'], unit1.numerator
+    unit1 = [1,'mm'].unit
+    assert_in_delta 1, 0.001, unit1.quantity
+    assert_equal ['<milli>','<meter>'], unit1.numerator
   end
   
   def test_create_unitless
@@ -91,6 +114,20 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_equal ['<second>','<second>'],unit1.denominator
   end
   
+  def test_create_from_array
+    unit1 = Unit.new([1, "mm^2", "ul^2"])
+    assert_equal 1, unit1.to_f
+    assert_equal ['<milli>','<meter>','<milli>','<meter>'], unit1.numerator
+    assert_equal ['<micro>','<liter>','<micro>','<liter>'], unit1.denominator
+  end
+  
+  def test_bad_create
+    assert_raises(ArgumentError) { Unit.new(nil)}
+    assert_raises(ArgumentError) { Unit.new(true)}
+    assert_raises(ArgumentError) { Unit.new(false)}
+    assert_raises(ArgumentError) { Unit.new(/(.+)/)}
+  end
+  
   def test_convert
     unit1 = Unit.new("1 attoparsec/microfortnight")
     assert_nothing_raised {
@@ -115,6 +152,15 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_raises(ArgumentError) { unit3= unit1 >> 5.0}
   end
   
+  def test_compare 
+    unit1 = "1 mm".unit
+    unit2 = "1 mm".unit
+    unit3 = unit2 >> "in"
+    assert unit1 === unit2
+    assert !(unit1 === unit3)
+    assert unit1 === "1 mm"
+  end
+  
   def test_matched_units
     unit1 = Unit.new("1 m*kg/s")
     unit2 = Unit.new("1 in*pound/min")
@@ -178,6 +224,47 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_raise(ArgumentError) {(unit1+unit2).to_f}
   end
   
+  def test_add_coerce
+    unit1 = "1 mm".unit
+    assert_nothing_raised {
+      unit2 = unit1 + "1 mm"
+      assert_equal "2 mm".unit, unit2
+    }
+    assert_nothing_raised {
+      unit2 = unit1 + [1,"mm"]
+      assert_equal "2 mm".unit, unit2
+    }
+    assert_nothing_raised {
+      unit2 = "1".unit + 1
+      assert_equal "2".unit, unit2
+    }
+    assert_raises(ArgumentError) {
+      unit2 = "1".unit + nil
+    }
+  end
+
+  def test_subtract_coerce
+    unit1 = "1 mm".unit
+    assert_nothing_raised {
+      unit2 = unit1 - "1 mm"
+      assert_equal "0 mm".unit, unit2
+    }
+  end
+  def test_multiply_coerce
+    unit1 = "1 mm".unit
+    assert_nothing_raised {
+      unit2 = unit1 * "1 mm"
+      assert_equal "1 mm^2".unit, unit2
+    }
+  end
+  def test_divide_coerce
+    unit1 = "1 mm".unit
+    assert_nothing_raised {
+      unit2 = unit1 / "1 mm"
+      assert_equal "1".unit, unit2
+    }
+  end
+  
   def test_signature #"1 m s deg K kg A mol cd byte rad
     unit1 = Unit.new("1 m*s*degK*kg*A*mol*cd*byte*rad*dollar")
     assert_equal unit1.signature, (0..9).inject(0) {|product, n| product + 20**n}
@@ -198,11 +285,11 @@ class TestRubyUnit < Test::Unit::TestCase
   end
   
   def test_multiply
-    unit1 = Unit.new("1 M")
-    unit2 = Unit.new("200 g/mole")
+    unit1 = Unit.new("1 m/ms")
+    unit2 = Unit.new("1 m/ms")
     assert_nothing_raised {
       unit3 = unit1 * unit2
-      assert_equal Unit.new("200 M*g/mol"), unit3    
+      assert_equal Unit.new("1 m^2/ms^2"), unit3    
     }
   end
   
@@ -313,6 +400,41 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_in_delta 558.27, unit2.to_f, 0.01
     unit3 = Unit.new("1 J/degC")
     assert_in_delta 1, (unit3 >> "J/degK").to_f, 0.01
+    assert_raises(ArgumentError) {unit1 >> "degH"}
+    
+    unit1 = Unit.new("98.6 degF")
+    unit2 = unit1 >> "degC"
+    assert_in_delta 37, unit2.to_f, 0.1
+    unit2 = unit1 >> "degK"
+    assert_in_delta 310.15, unit2.to_f, 0.01
+    unit2 = unit1 >> "degR"
+    assert_in_delta 558.27, unit2.to_f, 0.01
+    unit3 = Unit.new("1 J/degC")
+    assert_in_delta 1, (unit3 >> "J/degK").to_f, 0.01
+    assert_raises(ArgumentError) {unit1 >> "degH"}
+    
+    unit1 = Unit.new("310.15 degK")
+    unit2 = unit1 >> "degF"
+    assert_in_delta 98.6, unit2.to_f, 0.1
+    unit2 = unit1 >> "degC"
+    assert_in_delta 37, unit2.to_f, 0.01
+    unit2 = unit1 >> "degR"
+    assert_in_delta 558.27, unit2.to_f, 0.01
+    unit3 = Unit.new("1 J/degC")
+    assert_in_delta 1, (unit3 >> "J/degK").to_f, 0.01
+    assert_raises(ArgumentError) {unit1 >> "degH"}
+    
+    unit1 = Unit.new("558.27 degR")
+    unit2 = unit1 >> "degC"
+    assert_in_delta 37, unit2.to_f, 0.1
+    unit2 = unit1 >> "degK"
+    assert_in_delta 310.15, unit2.to_f, 0.01
+    unit2 = unit1 >> "degF"
+    assert_in_delta 98.6, unit2.to_f, 0.01
+    unit3 = Unit.new("1 J/degC")
+    assert_in_delta 1, (unit3 >> "J/degK").to_f, 0.01
+    assert_raises(ArgumentError) {unit1 >> "degH"}
+    assert_raises(ArgumentError) {"10 degH".unit >> "degH"}
   end
   
   def test_feet

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 date: 2006-08-22 00:00:00 -04:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
@@ -31,11 +31,12 @@ authors:
 files: 
 - LICENSE
 - README
-- lib/ruby_units.rb
+- CHANGELOG
+- lib/ruby-units.rb
 - lib/units.rb
-- test/test_ruby_units.rb
+- test/test_ruby-units.rb
 test_files: 
-- test/test_ruby_units.rb
+- test/test_ruby-units.rb
 rdoc_options: []
 
 extra_rdoc_files: []