ruby-units 0.1.1 → 0.2.0

data/lib/ruby_units.rb

@@ -0,0 +1 @@
+require 'ruby-units'

data/lib/units.rb

@@ -61,7 +61,7 @@ UNIT_DEFINITIONS = {
   '<AMU>' => [%w{u AMU amu}, 6.0221415e26, :mass, %w{<kilogram>}],
   '<dalton>' => [%w{Da Dalton Daltons dalton daltons}, 6.0221415e26, :mass, %w{<kilogram>}],
   '<slug>' => [%w{slug slugs}, 14.5939029, :mass, %w{<kilogram>}],
-  '<short-ton>' => [%w{t ton}, 907.18474, :mass, %w{<kilogram>}],
+  '<short-ton>' => [%w{tn ton}, 907.18474, :mass, %w{<kilogram>}],
   '<metric-ton>'=>[%w{tonne}, 1000, :mass, %w{<kilogram>}],
   '<carat>' => [%w{ct carat carats}, 0.0002, :mass, %w{<kilogram>}],
   '<pound-mass>' => [%w{lbs lb pound pounds #}, 0.45359237, :mass, %w{<kilogram>}],
@@ -88,12 +88,12 @@ UNIT_DEFINITIONS = {
   '<knot>' => [%w{kn knot knots}, 0.514444444, :speed, %w{<meter>}, %w{<second>}],
   '<fps>'  => [%w{fps}, 0.3048, :speed, %w{<meter>}, %w{<second>}],
 
-  #temperature
-  '<kelvin>' => [%w{degK kelvin Kelvin}, 1.0, :temperature, %w{<celcius>}],
-  '<celcius>' => [%w{degC celcius Celcius}, 1.0, :temperature, %w{<celcius>}],
-  '<farenheit>' => [%w{degF farenheit Farenheit}, 1.8, :temperature, %w{<celcius>}],
-  '<rankine>' => [%w{degR rankine Rankine}, 1.8, :temperature, %w{<celcius>}],
-
+  #temperature_difference
+  '<kelvin>' => [%w{degK kelvin Kelvin}, 1.0, :temperature, %w{<kelvin>}],
+  '<celcius>' => [%w{degC celcius Celcius}, 1.0, :temperature, %w{<kelvin>}],
+  '<farenheit>' => [%w{degF farenheit Farenheit}, 1.8, :temperature, %w{<kelvin>}],
+  '<rankine>' => [%w{degR rankine Rankine}, 1.8, :temperature, %w{<kelvin>}],
+  
   #time
   '<second>'=>  [%w{s sec second seconds}, 1.0, :time, %w{<second>}],
   '<minute>'=>  [%w{min minute minutes}, 60.0, :time, %w{<second>}],  
@@ -109,9 +109,9 @@ UNIT_DEFINITIONS = {
   '<pascal>' => [%w{Pa pascal Pascal}, 1.0, :pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
   '<bar>' => [%w{bar bars}, 100000, :pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
   '<mmHg>' => [%w{mmHg}, 133.322368,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
-  '<torr>' => [%w{Torr}, 133.322368,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
+  '<torr>' => [%w{torr}, 133.322368,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
   '<bar>' => [%w{bar}, 100000,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
-  '<atm>' => [%w{atm atmosphere atmospheres}, 101325,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
+  '<atm>' => [%w{atm ATM atmosphere atmospheres}, 101325,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
   '<psi>' => [%w{psi}, 6894.76,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
   '<cmh2o>' => [%w{cmH2O}, 98.0638,:pressure, %w{<kilogram>},%w{<meter> <second> <second>}],
 
@@ -174,7 +174,7 @@ UNIT_DEFINITIONS = {
   '<hertz>' => [%w{Hz hertz Hertz}, 1.0, :frequency, %w{<1>}, %{<second>}],
 
   #angle
-  '<radian>' =>[%w{rad radian radians}, 1.0, :angle, %w{<radian>}],
+  '<radian>' =>[%w{rad radian radian}, 1.0, :angle, %w{<radian>}],
   '<degree>' =>[%w{deg degree degrees}, Math::PI / 180.0, :angle, %w{<radian>}],
   '<grad>'   =>[%w{grad gradian grads}, Math::PI / 200.0, :angle, %w{<radian>}],
   '<steradian>'  => [%w{sr steradian steradians}, 1.0, :solid_angle, %w{<steradian>}],
@@ -215,11 +215,12 @@ UNIT_DEFINITIONS = {
   '<base-pair>'  => [%w{bp}, 1.0, :counting, %w{<each>}],
   '<nucleotide>' => [%w{nt}, 1.0, :counting, %w{<each>}],
   '<molecule>' => [%w{molecule molecules}, 1.0, :counting, %w{<each>}],
-  '<dozen>' =>  [%w{dz doz dozen},12.0,:prefix],
+  '<dozen>' =>  [%w{doz dz dozen},12.0,:prefix_only, %w{<each>}],
   '<percent>'=> [%w{% percent}, 0.01, :prefix_only, %w{<centi>}],
   '<ppm>' =>  [%w{ppm},1e-6,:prefix_only, %w{<micro>}],
   '<ppt>' =>  [%w{ppt},1e-9,:prefix_only, %w{<nano>}],
-  '<gross>' =>  [%w{gr gross},144.0, :prefix_only, %w{<dozen> <dozen>}]
+  '<gross>' =>  [%w{gr gross},144.0, :prefix_only, %w{<dozen> <dozen>}],
+  '<decibel>'  => [%w{dB decibel decibels}, 1.0, :logarithmic, %w{<decibel>}]
 
 
 } # doc

data/test/test_ruby-units.rb

@@ -3,11 +3,12 @@ require 'ruby-units'
 
 class Unit < Numeric
   @@USER_DEFINITIONS = {'<inchworm>' =>  [%w{inworm inchworm}, 0.0254, :length, %w{<meter>} ],
+                        '<cell>' => [%w{cells cell}, 1, :counting, %w{<each>}],
                         '<habenero>'   => [%{degH}, 100, :temperature, %w{<celcius>}]}
   Unit.setup
 end
 
-class TestRubyUnit < Test::Unit::TestCase
+class TestRubyUnits < Test::Unit::TestCase
   
   def test_clone
     unit1= "1 mm".unit
@@ -31,14 +32,14 @@ class TestRubyUnit < Test::Unit::TestCase
   def test_create_unit_only
     unit1 = Unit.new("m")
     assert_equal ['<meter>'], unit1.numerator
-    assert_equal 1.0, unit1.quantity
+    assert_equal 1.0, unit1.scalar
   end
   
   def test_to_base
     unit1 = Unit.new("100 cm")
-    assert_in_delta 1, 0.001, unit1.to_base.quantity
+    assert_in_delta 1, 0.001, unit1.to_base.scalar
     unit2 = Unit("1 mm^2 ms^-2")
-    assert_in_delta 1, 0.001, unit2.to_base.quantity
+    assert_in_delta 1, 0.001, unit2.to_base.scalar
   end
   
   def test_to_unit
@@ -48,22 +49,22 @@ class TestRubyUnit < Test::Unit::TestCase
     assert Unit === unit1
     assert unit1 == unit2
     unit1 = "2.54 cm".to_unit("in")
-    assert_in_delta 1, 0.001, unit1.quantity
+    assert_in_delta 1, 0.001, unit1.scalar
     assert_equal ['<inch>'], unit1.numerator
     unit1 = "2.54 cm".unit("in")
-    assert_in_delta 1, 0.001, unit1.quantity
+    assert_in_delta 1, 0.001, unit1.scalar
     assert_equal ['<inch>'], unit1.numerator
     unit1 = 1.unit
-    assert_in_delta 1, 0.001, unit1.quantity
+    assert_in_delta 1, 0.001, unit1.scalar
     assert_equal ['<1>'], unit1.numerator
     unit1 = [1,'mm'].unit
-    assert_in_delta 1, 0.001, unit1.quantity
+    assert_in_delta 1, 0.001, unit1.scalar
     assert_equal ['<milli>','<meter>'], unit1.numerator
   end
   
   def test_create_unitless
-    unit1 = Unit.new("1")
-    assert_equal 1,unit1.to_f
+    unit1 = Unit("1")
+    assert_equal 1, unit1.to_f
     assert_equal ['<1>'],unit1.numerator
     assert_equal ['<1>'],unit1.denominator
     unit1 = Unit.new("1.5")
@@ -74,49 +75,54 @@ class TestRubyUnit < Test::Unit::TestCase
   
   def test_create_simple
     unit1 = Unit.new("1 m")
-    assert_equal 1,unit1.to_f
+    assert_equal 1,unit1.scalar
     assert_equal ['<meter>'], unit1.numerator
     assert_equal ['<1>'],unit1.denominator
   end
   
   def test_create_compound
     unit1 = Unit.new("1 N*m")
-    assert_equal 1,unit1.to_f 
+    assert_equal 1,unit1.scalar 
     assert_equal ['<newton>','<meter>'],unit1.numerator
     assert_equal ['<1>'],unit1.denominator
   end
   
   def test_create_with_denominator
     unit1 = Unit.new("1 m/s")
-    assert_equal 1, unit1.to_f
+    assert_equal 1, unit1.scalar
     assert_equal ['<meter>'],unit1.numerator
     assert_equal ['<second>'],unit1.denominator
   end
   
   def test_create_with_powers
     unit1 = Unit.new("1 m^2/s^2")
-    assert_equal 1, unit1.to_f
+    assert_equal 1, unit1.scalar
     assert_equal ['<meter>','<meter>'],unit1.numerator
     assert_equal ['<second>','<second>'],unit1.denominator
+    unit1 = Unit.new("1 m^2 kg^2 J^2/s^2")
+    assert_equal 1, unit1.scalar
+    assert_equal ['<meter>','<meter>','<kilogram>','<kilogram>','<joule>','<joule>'],unit1.numerator
+    assert_equal ['<second>','<second>'],unit1.denominator
+    
   end
 
   def test_create_with_zero_power
     unit1 = Unit.new("1 m^0")
-    assert_equal 1,unit1.to_f
+    assert_equal 1,unit1.scalar
     assert_equal ['<1>'],unit1.numerator
     assert_equal ['<1>'],unit1.denominator
   end
 
   def test_create_with_negative_powers
     unit1 = Unit.new("1 m^2 s^-2")
-    assert_equal 1, unit1.to_f
+    assert_equal 1, unit1.scalar
     assert_equal ['<meter>','<meter>'],unit1.numerator
     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 1, unit1.scalar
     assert_equal ['<milli>','<meter>','<milli>','<meter>'], unit1.numerator
     assert_equal ['<micro>','<liter>','<micro>','<liter>'], unit1.denominator
   end
@@ -134,7 +140,7 @@ class TestRubyUnit < Test::Unit::TestCase
       unit2 = unit1 >> "in/s"
       assert_equal ['<inch>'],unit2.numerator
       assert_equal ['<second>'],unit2.denominator
-      assert_in_delta 1.0043269330917,unit2.to_f,0.00001 
+      assert_in_delta 1.0043269330917,unit2.scalar,0.00001 
     }
   end
   
@@ -150,6 +156,9 @@ class TestRubyUnit < Test::Unit::TestCase
       assert_equal ['<1>'],unit3.denominator
     }
     assert_raises(ArgumentError) { unit3= unit1 >> 5.0}
+    assert_equal unit1, unit1.to(true)
+    assert_equal unit1, unit1.to(false)
+    assert_equal unit1, unit1.to(nil)
   end
   
   def test_compare 
@@ -196,7 +205,7 @@ class TestRubyUnit < Test::Unit::TestCase
     unit1 = Unit.new("1 mm")
     unit2 = Unit.new("2 mm")
     assert_nothing_raised {  
-      assert_equal 3.0, (unit1+unit2).to_f
+      assert_equal 3.0, (unit1+unit2).scalar
       }
   end
   
@@ -205,7 +214,7 @@ class TestRubyUnit < Test::Unit::TestCase
     unit2 = Unit.new("1 in")
     assert_nothing_raised {
       unit3 = unit1 + unit2
-      assert_in_delta 3.54, unit3.to_f, 0.01
+      assert_in_delta 3.54, unit3.scalar, 0.01
       }
   end
 
@@ -214,14 +223,14 @@ class TestRubyUnit < Test::Unit::TestCase
     unit2 = Unit.new("1 in")
     assert_nothing_raised {
       unit3 = unit1 - unit2
-      assert_in_delta -1.54, unit3.to_f, 0.01
+      assert_in_delta -1.54, unit3.scalar, 0.01
       }
   end
   
   def test_add_unlike_units
     unit1 = Unit.new("1 mm")
     unit2 = Unit.new("2 ml")
-    assert_raise(ArgumentError) {(unit1+unit2).to_f}
+    assert_raise(ArgumentError) {(unit1+unit2).scalar}
   end
   
   def test_add_coerce
@@ -274,14 +283,14 @@ class TestRubyUnit < Test::Unit::TestCase
     unit1 = Unit.new("1 mm")
     unit2 = Unit.new("2 mm")
     assert_nothing_raised {
-      assert_equal -1, (unit1-unit2).to_f
+      assert_equal -1, (unit1-unit2).scalar
       }
   end
   
   def test_subtract_unlike_units
     unit1 = Unit.new("1 mm")
     unit2 = Unit.new("2 ml")
-    assert_raise(ArgumentError) {(unit1-unit2).to_f}
+    assert_raise(ArgumentError) {(unit1-unit2).scalar}
   end
   
   def test_multiply
@@ -300,6 +309,9 @@ class TestRubyUnit < Test::Unit::TestCase
       unit3 = unit1 / unit2
       assert_equal Unit.new("1 M"), unit3
       }
+    assert_raises(ZeroDivisionError) {
+      unit1 / 0
+    }
   end
   
   def test_inverse
@@ -327,6 +339,9 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_nothing_raised {
       assert_equal unit2, unit1**-2
       }
+    assert_raises(ZeroDivisionError) {
+      unit="0 mm".unit**-1
+    }
   end
 
   def test_exponentiate_zero
@@ -335,6 +350,7 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_nothing_raised {
       assert_equal unit2, unit1**0
     }
+    assert_equal 1, "0 mm".unit**0
   end
   
   def test_abs
@@ -392,59 +408,65 @@ class TestRubyUnit < Test::Unit::TestCase
   
   def test_temperature_conversions
     unit1 = Unit.new("37 degC")
-    unit2 = unit1 >> "degF"
-    assert_in_delta 98.6, 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
+    unit2 = unit1 >> "tempF"
+    assert_in_delta 98.6, unit2.scalar, 0.1
+    unit2 = unit1 >> "tempK"
+    assert_in_delta 310.15, unit2.scalar, 0.01
+    unit2 = unit1 >> "tempR"
+    assert_in_delta 558.27, unit2.scalar, 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_in_delta 1, (unit3 >> "J/degK").scalar, 0.01
     
     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
+    unit2 = unit1 >> "tempC"
+    assert_in_delta 37, unit2.scalar, 0.1
+    unit2 = unit1 >> "tempK"
+    assert_in_delta 310.15, unit2.scalar, 0.01
+    unit2 = unit1 >> "tempR"
+    assert_in_delta 558.27, unit2.scalar, 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_in_delta 1, (unit3 >> "J/degK").scalar, 0.01
     
     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
+    unit2 = unit1 >> "tempF"
+    assert_in_delta 98.6, unit2.scalar, 0.1
+    unit2 = unit1 >> "tempC"
+    assert_in_delta 37, unit2.scalar, 0.01
+    unit2 = unit1 >> "tempR"
+    assert_in_delta 558.27, unit2.scalar, 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_in_delta 1, (unit3 >> "J/degK").scalar, 0.01
     
     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
+    unit2 = unit1 >> "tempC"
+    assert_in_delta 37, unit2.scalar, 0.1
+    unit2 = unit1 >> "tempK"
+    assert_in_delta 310.15, unit2.scalar, 0.01
+    unit2 = unit1 >> "tempF"
+    assert_in_delta 98.6, unit2.scalar, 0.01
+    assert_in_delta 558.27, unit1.to("tempR").scalar, 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"}
+    assert_in_delta 1, (unit3 >> "J/degK").scalar, 0.01
+    assert_raises(ArgumentError) {"10 degH".unit >> "tempF"}
+    
+    # round trip conversions
+    unit1 = Unit "37 degC"
+    unit2 = unit1 >> "degF" >> 'degK' >> 'degR' >> 'degC'
+    assert_equal unit2, unit1
+
+    unit1 = Unit "37 degC"
+    unit2 = unit1 >> "tempF" >> 'tempK' >> 'tempR' >> 'tempC'
+    assert_equal unit2, unit1
   end
   
   def test_feet
     unit1 = Unit.new("6'6\"")
-    assert_in_delta 6.5, unit1.to_f, 0.01
+    assert_in_delta 6.5, unit1.scalar, 0.01
   end
   
   def test_pounds
     unit1 = Unit.new("8 pounds, 8 ounces")
-    assert_in_delta 8.5, unit1.to_f, 0.01
+    assert_in_delta 8.5, unit1.scalar, 0.01
   end
   
   # these units are 'ambiguous' and could be mis-parsed
@@ -457,6 +479,10 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_equal ['<minute>'], unit3.numerator
     unit4 = Unit.new('1 ft')      # could be a 'femto-ton' instead of a foot
     assert_equal ['<foot>'], unit4.numerator  
+    unit5 = "1 atm".unit
+    assert_equal ['<atm>'], unit5.numerator
+    unit6 = "1 doz".unit
+    assert_equal ['<dozen>'], unit6.numerator
   end
    
   def test_to_s
@@ -503,4 +529,67 @@ class TestRubyUnit < Test::Unit::TestCase
     assert_equal "1 inworm", a.to_s
   end
   
+  def test_ideal_gas_law
+    p = Unit "100 kPa"
+    v = Unit "1 m^3"
+    n = Unit "1 mole"
+    r = Unit "8.31451 J/mol*degK"
+    t = ((p*v)/(n*r)).to("tempF")
+    assert_in_delta 21189.2,t.scalar, 0.1
+  end
+  
+  
+  def test_eliminate_terms
+    a = ['<meter>','<meter>','<kelvin>','<second>']
+    b = ['<meter>','<meter>','<second>']
+    h = Unit.eliminate_terms(1,a,b)
+    assert_equal ['<kelvin>'], h[:numerator]
+  end
+  
+  def test_to_base_consistency
+    a = "1 W*m/J*s".unit
+    assert_equal a.signature, a.to_base.signature
+  end
+  
+  def test_unit_roots
+    unit1 = Unit "2 m*J*kg"
+    unit2 = Unit "4 m^2*J^2*kg^2"
+    unit3 = Unit "8 m^3*J^3*kg^3"
+    assert_equal unit2**(1/2), unit1
+    assert_equal unit3**(1/3), unit1
+  end
+  
+  def test_inspect
+    unit1 = Unit "1 mm"
+    assert_equal "1 mm", unit1.inspect
+    assert_not_equal "1 mm", unit1.inspect(:dump)
+  end
+  
+  def test_to_f
+    assert_equal 1, 1.unit.to_f
+    assert_raises(RuntimeError) {
+      assert_equal 1, "1 mm".unit.to_f
+    }
+  end
+  
+  def test_exponentiate_float2
+    assert_equal "2 m".unit, "4 m^2".unit**(0.5) 
+    assert_raises(ArgumentError) { "1 mm".unit**(2/3)}
+    assert_raises(ArgumentError) { "1 mm".unit**("A")}
+    
+  end
+  
+  def test_range
+    a = Unit "1 mm"
+    b = Unit "3 mm"
+    c = (a..b).to_a
+    assert_equal ["1 mm".unit, "2 mm".unit, "3 mm".unit], c
+  end
+  
+  def test_scientific
+    a = Unit "1e6 cells"
+    assert_equal 1e6, a.scalar
+    assert_equal "cells", a.units
+  end
+  
 end

metadata

@@ -3,12 +3,12 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2006-08-22 00:00:00 -04:00
+  version: 0.2.0
+date: 2006-09-18 00:00:00 -04:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
 - lib
-email: kevin.olbrich+ruby_units@gmail.com
+email: kevin.olbrich+ruby-units@gmail.com
 homepage: http://rubyforge.com/projects/ruby-units/
 rubyforge_project: ruby-units
 description: 
@@ -32,6 +32,7 @@ files:
 - LICENSE
 - README
 - CHANGELOG
+- lib/ruby_units.rb
 - lib/ruby-units.rb
 - lib/units.rb
 - test/test_ruby-units.rb