uom 1.2.1 → 1.2.2

data/History.md

@@ -0,0 +1,10 @@
+This history lists major release themes. See the GitHub Commits (https://github.com/caruby/uom)
+for change details.
+
+=== 1.2.2 / 2011-12-13
+
+* Fix comma-separated number inifinite loop.
+
+=== 1.2.1 / 2010-09-30
+
+* Initial public release.

data/README.md

@@ -3,24 +3,23 @@ UOM: Unit of Measure library
 
 **Git**:          [http://github.com/caruby/uom](http://github.com/caruby/uom)    
 **Author**:       OHSU Knight Cancer Institute    
-**Copyright**:    2010    
+**Copyright**:    2010, 2011   
 **License**:      MIT License    
-**Latest Version**: 1.2.1    
-**Release Date**: September 30th 2010    
 
 Synopsis
 --------
 
 UOM implements Units of Measurement based on the
-[http://physics.nist.gov/Pubs/SP330/sp330.pdf](International System of Units) (SI).
+[International System of Units](http://physics.nist.gov/Pubs/SP330/sp330.pdf) (SI).
 The base SI units, metric scalar factors and all possible combinations of these units
-are supported out of the box.
+are supported out of the box. Common alternative non-metric measurement systems, e.g.
+US Customary units, are supported with conversions between these units and the SI units.
+Supported units are listed in +doc/units.txt+.
 
-Common alternative non-metric measurement systems, e.g. US Customary units, are
-supported with conversions between these units and the SI units.
 Additional units can be defined with conversion to an existing unit.
 UOM infers full conversion capability between units of the same dimension from
-the minimal number of conversion definitions.
+the minimal number of conversion definitions. See the __Usage__ section
+for an example of combining pre-defined units into a novel unit.
 
 Arithmetic operations between UOM Measurement objects converts the measurement units
 and scalar factors as necessary, including unit products, quotients and powers of
@@ -88,12 +87,6 @@ Usage
     end
     UOM::Measurement.new(:jpeg, 1) #=> 1 jpeg
 
-Changelog
----------
-
-- **September.30.10**: 2010.1 release
-    - Initial public release
-
 Copyright
 ---------
 

data/lib/uom.rb

@@ -1,7 +1 @@
 require 'uom/measurement'
-
-# UOM implements Units of Measurement based on the International System of Units.
-# See [http://github.com/caruby/uom] for details.
-module UOM
-  VERSION = "1.2.1"
-end

data/lib/uom/composite_unit.rb

@@ -1,12 +1,15 @@
 require 'singleton'
-require 'generator'
+
+# JRuby SyncEnumerator moved from generator to REXML in JRuby 1.5.
+require 'rexml/document'
+
 require 'extensional'
 require 'active_support/inflector'
 require 'uom/unit'
 require 'uom/composite_unit_key_canonicalizer'
 
 module UOM
-   # A CompositeUnit represents a measurement unit across more than one dimension, e.g. +:gram_per_liter+.
+   # A CompositeUnit represents a measurement unit across more than one dimension, e.g. :gram_per_liter.
   class CompositeUnit < Unit
     SUPPORTED_OPERATORS = [:/, :*]
 
@@ -48,7 +51,7 @@ module UOM
       # convert the the first axis quantity to the first unit axis
       first = axes[0].as(quantity, unit.axes[0])
       # convert the remaining units
-      vector = SyncEnumerator.new(axes[1..-1], unit.axes[1..-1]).map { |from, to| from.as(1, to).to_f }
+      vector = REXML::SyncEnumerator.new(axes[1..-1], unit.axes[1..-1]).map { |from, to| from.as(1, to).to_f }
       # apply the operator
       vector.inject(first) { |q, item| q.send(@operator, item) }
     end
@@ -71,8 +74,8 @@ module UOM
 
     def create_label
       case @operator
-      when :/ then create_division_label
-      when :* then create_product_label
+        when :/ then create_division_label
+        when :* then create_product_label
       end
     end
 

data/lib/uom/factors.rb

@@ -27,6 +27,9 @@ module UOM
   # All metric factors.
   METRIC_FACTORS = [YOTTA, ZETTA, EXA, TERA, GIGA, MEGA, KILO, HECTO, DECA, DECI, CENTI, MILLI, MICRO, NANO, PICO, FEMTO, ATTO, ZEPTO, YOCTO]
 
-  # Factors commonly used in electronics
+  # Factors commonly used in electronics.
   ELECTRONIC_FACTORS = [MILLI, MICRO, NANO, PICO, TERA, GIGA, MEGA, KILO]
+
+  # Factors commonly used for measures in a moderate range about 1.
+  SIMPLE_FACTORS = [CENTI, MILLI, MEGA, KILO]
 end

data/lib/uom/measurement.rb

@@ -2,6 +2,8 @@ require 'forwardable'
 require 'uom/error'
 require 'uom/units'
 
+# UOM implements Units of Measurement based on the International System of Units.
+# See [http://github.com/caruby/uom] for details.
 module UOM
   # Measurement qualifies a quantity with a unit.
   class Measurement
@@ -110,7 +112,7 @@ class String
   # If unit is given, then this method converts the measurement to the given unit.
   def to_measurement_quantity(unit=nil)
     # remove commas
-    return to_measurement_quantity(delete(',')) if self[',']
+    return delete(',').to_measurement_quantity(unit) if self[',']
     # extract the quantity portion
     quantity_s = self[/\d*\.?\d*/]
     return if quantity_s.nil? or quantity_s == '.'

data/lib/uom/unit.rb

@@ -39,6 +39,15 @@ module UOM
       # the first symbol is the label
       labels = params.select { |param| Symbol === param }
       @label = labels.first
+      # the optional Factor parameters are the permissible scaling factors
+      factors = params.select { |param| Factor === param }.to_set
+      # a convertable unit must have a unique factor
+      if converter and factors.size > 1 then
+        raise MeasurementError.new("Derived unit #{label} can have at most one scalar: #{factors.to_a.join(', ')}")
+        @permissible_factors = []
+      else
+        @permissible_factors = factors
+      end
       # a Numeric parameter indicates a conversion multiplier instead of a converter block
       multiplier = params.detect { |param| Numeric === param }
       if multiplier then
@@ -49,15 +58,6 @@ module UOM
         # make the converter block from the multiplier
         converter = lambda { |n| n * multiplier }
       end
-      # the optional Factor parameters are the permissible scaling factors
-      factors = params.select { |param| Factor === param }.to_set
-      # a convertable unit must have a unique factor
-      if converter and factors.size > 1 then
-        raise MeasurementError.new("Derived unit #{label} can have at most one scalar: #{axes.join(', ')}")
-        @permissible_factors = []
-      else
-        @permissible_factors = factors
-      end
       # the optional single Unit parameter is the axis for a derived unit
       axes = params.select { |param| Unit === param }
       raise MeasurementError.new("Unit #{label} can have at most one axis: #{axes.join(', ')}") if axes.size > 1
@@ -184,7 +184,9 @@ module UOM
       converter = @converters[unit]
       return converter.call(quantity) if converter
       # validate the target unit dimension
-      raise MeasurementError.new("Cannot convert #{unit} dimension #{unit.dimension} to #{self} dimension #{@dimension}") unless @dimension == unit.dimension
+      unless @dimension == unit.dimension then
+        raise MeasurementError.new("Cannot convert #{unit} dimension #{unit.dimension} to #{self} dimension #{@dimension}")
+      end
       # convert via an axis pivot intermediary
       pivot = conversion_pivot(unit)
       pivot.as(self.as(quantity, pivot), unit)

data/lib/uom/units.rb

@@ -53,7 +53,7 @@ module UOM
   MINUTE = Unit.new(:minute, :min, SECOND, 60)
   HOUR = Unit.new(:hour, :hr, MINUTE, 60)
   DAY = Unit.new(:day, HOUR, 24)
-
+  
   # information
   BIT = Unit.new(:bit, BYTE, 1.0 / 8)
 
@@ -76,6 +76,11 @@ module UOM
   JOULE = Unit.new(:joule, :J, (KILOGRAM * (METER * METER)) / (SECOND * SECOND), *ELECTRONIC_FACTORS)
   ERG = Unit.new(:erg, (GRAM * (CENTIMETER * CENTIMETER)) / (SECOND * SECOND), *ELECTRONIC_FACTORS)
   DYNE = Unit.new(:dyne, :dyn, (GRAM * CENTIMETER) / (SECOND * SECOND), *ELECTRONIC_FACTORS)
+  NEWTON = Unit.new(:newton, :N, (KILOGRAM * METER) / (SECOND * SECOND), *SIMPLE_FACTORS)
+  BAR = Unit.new(:bar, NEWTON, 0.00001, *SIMPLE_FACTORS)
+  PASCAL = Unit.new(:pascal, :Pa, NEWTON / (METER * METER), *SIMPLE_FACTORS)
+  ATMOSPHERE = Unit.new(:atmosphere, :atm, PASCAL, 0.101325, *SIMPLE_FACTORS)
+  TORR = Unit.new(:torr, ATMOSPHERE, 1.0 / 760, *SIMPLE_FACTORS)
   BARYE = Unit.new(:barye, :Ba, GRAM / (CENTIMETER * (SECOND * SECOND)), *ELECTRONIC_FACTORS)
   POISE = Unit.new(:poise, :P, GRAM / (CENTIMETER * SECOND), KILO, MILLI, MICRO, NANO, PICO)
   COULOMB = Unit.new(:coulomb, AMPERE / SECOND, *ELECTRONIC_FACTORS) # C abbreviation is taken by CENTIGRADE
@@ -109,7 +114,7 @@ module UOM
   DRY_GALLON = Unit.new(:dry_gallon, :dry_gal, DRY_QUART, 4)
   PECK = Unit.new(:peck, :pk, DRY_GALLON, 2)
   BUSHEL = Unit.new(:bushel, :bu, PECK, 4)
-
-  # Pressure
+  
+  # Pressure alias
   PSI = Unit.for(:pounds_per_square_inch).add_abbreviation(:psi)
 end

data/lib/uom/version.rb

@@ -0,0 +1,3 @@
+module UOM
+  VERSION = "1.2.2"
+end

data/test/lib/helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:test, :development)

data/test/lib/uom/composite_unit_key_canonicalizer_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../helper'
+require "test/unit"
+require 'uom/units'
+require 'uom/composite_unit_key_canonicalizer'
+
+class CompositeUnitKeyCanonicalizerTest < Test::Unit::TestCase
+  def setup
+    @canonicalizer = UOM::CompositeUnitKeyCanonicalizer.new
+  end
+
+  def test_product_product
+    standard = [UOM::GRAM * UOM::METER, UOM::SECOND, :*]
+    variant =  @canonicalizer.canonicalize(UOM::GRAM, UOM::METER * UOM::SECOND, :*)
+    assert_equal(standard, variant, "Canonicalization of x * (y * z) incorrect")
+  end
+
+  def test_product_quotient
+    standard = [UOM::GRAM * UOM::METER, UOM::SECOND, :/]
+    variant =  @canonicalizer.canonicalize(UOM::GRAM, UOM::METER / UOM::SECOND, :*)
+    assert_equal(standard, variant, "Canonicalization of x * (y / z) incorrect")
+  end
+
+  def test_quotient_product
+    standard = [UOM::GRAM / UOM::METER, UOM::SECOND, :/]
+    variant =  @canonicalizer.canonicalize(UOM::GRAM, UOM::METER * UOM::SECOND, :/)
+    assert_equal(standard, variant, "Canonicalization of x / (y * z) incorrect")
+  end
+
+  def test_quotient_quotient
+    standard = [UOM::GRAM / UOM::METER, UOM::SECOND, :*]
+    variant =  @canonicalizer.canonicalize(UOM::GRAM, UOM::METER / UOM::SECOND, :/)
+    assert_equal(standard, variant, "Canonicalization of x / (y / z) incorrect")
+  end
+
+  def test_joule
+    joule = UOM::JOULE.axis
+    assert_equal(((UOM::KILOGRAM * UOM::METER) * UOM::METER) / UOM::SECOND, joule.axes.first, "Joule canonicalization first axis incorrect")
+    assert_equal(UOM::SECOND, joule.axes.last, "Joule canonicalization second axis incorrect")
+    assert_equal(:/, joule.operator, "Joule canonicalization operator incorrect")
+  end
+end

data/test/lib/uom/composite_unit_test.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../helper'
+require "test/unit"
+require 'uom/units'
+
+class CompositeUnitTest < Test::Unit::TestCase
+  def test_square
+    square_meter = UOM::METER * UOM::METER
+    assert_equal(:square_meter, square_meter.label, "Square meter label incorrect")
+    assert_equal([UOM::METER, UOM::METER], square_meter.axes, "Square meter axes incorrect: #{square_meter.axes.join(', ')}")
+    assert_same(square_meter, UOM::Unit.for(:square_meter), "Square meter lookup by label incorrect")
+    assert_same(square_meter, UOM::METER * UOM::METER, "Square meter product inconsistent")
+  end
+
+  def test_cube
+    cubic_meter = UOM::METER * UOM::METER * UOM::METER
+    assert_equal(:cubic_meter, cubic_meter.label, "Cubic meter label incorrect")
+    assert_equal([UOM::METER * UOM::METER, UOM::METER], cubic_meter.axes, "Cubic meter axes incorrect: #{cubic_meter.axes.join(', ')}")
+    assert_same(cubic_meter, UOM::Unit.for(:cubic_meter), "Cubic meter lookup by label incorrect")
+    assert_same(cubic_meter, UOM::METER * UOM::METER * UOM::METER, "Cubic meter product inconsistent")
+  end
+
+  def test_basic_scale_low_to_high
+    roundtrip = UOM::MILLIMETER.as(UOM::METER.as(4, UOM::MILLIMETER), UOM::METER)
+    assert_in_delta(4.0, roundtrip, 0.0000000001, "Scale conversion incorrect")
+  end
+
+  def test_idempotent_product_conversion
+    product = UOM::MILLIGRAM * UOM::LITER
+    assert_equal(:milligram_liter, product.label, "Composite product label incorrect")
+    other = UOM::GRAM * UOM::MILLILITER
+    roundtrip = other.as(product.as(4, other), product)
+    assert_in_delta(4.0, roundtrip, 0.0000000001, "Idempotent roduct conversion milligram_liter => gram_milliter incorrect: #{roundtrip}")
+  end
+
+  def test_idempotent_quotient_conversion
+    quotient = UOM::GRAM / UOM::LITER
+    assert_equal(:grams_per_liter, quotient.label, "Composite divide label incorrect")
+    other = UOM::MILLIGRAM / UOM::MILLILITER
+    roundtrip = other.as(quotient.as(4, other), quotient)
+    assert_in_delta(4.0, roundtrip, 0.0000000001, "Idempotent quotient conversion grams_per_liter => milligrams_per_milliliter incorrect: #{roundtrip}")
+  end
+
+  def test_basic_volume_conversion
+    roundtrip = UOM::QUART.as(UOM::LITER.as(4, UOM::QUART), UOM::LITER)
+    assert_in_delta(4.0, roundtrip, 0.000000001, "Quotient volume liter => quart => liter incorrect: #{roundtrip}")
+  end
+
+  def test_volume_scale_conversion
+    roundtrip = UOM::LITER.as(UOM::MILLILITER.as(4, UOM::LITER), UOM::MILLILITER)
+    assert_in_delta(4.0, roundtrip, 0.0000000001, "Quotient volume millliter => liter => liter incorrect: #{roundtrip}")
+  end
+
+  def test_scaled_axis_concentration_conversion
+    roundtrip = UOM::CUP.as(UOM::MILLILITER.as(4, UOM::CUP), UOM::MILLILITER)
+    assert_in_delta(4.0, roundtrip, 0.0000000001, "Quotient conversion milligrams_per_milliliter => dram_per_cup incorrect: #{roundtrip}")
+  end
+
+  def test_measurement_system_quotient_conversion
+    quotient = UOM::MILLIGRAM / UOM::MILLILITER
+    other = UOM::DRAM / UOM::CUP
+    roundtrip = other.as(quotient.as(4, other), quotient)
+    assert_in_delta(4.0, roundtrip, 0.0000000001, "Quotient conversion milligrams_per_milliliter => dram_per_cup incorrect: #{roundtrip}")
+  end
+
+  def test_psi
+    assert_not_nil(UOM::Unit.for(:psi), "PSI abbreviation missing")
+  end
+end

data/test/lib/uom/factor_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../helper'
+require "test/unit"
+require 'uom'
+
+class FactorTest < Test::Unit::TestCase
+  def test_small_to_unit
+    assert_equal(0.001, UOM::MILLI.as(UOM::UNIT), "milli => unit incorrect")
+  end
+
+  def test_unit_to_large
+    assert_equal(0.1, UOM::UNIT.as(UOM::DECA), "unit => deca incorrect")
+  end
+
+  def test_large_to_small
+    assert_equal(1000000000, UOM::KILO.as(UOM::MICRO), "kilo => micro incorrect")
+  end
+
+  def test_small_to_large
+    assert_equal(0.000001, UOM::MILLI.as(UOM::KILO), "milli => kilo incorrect")
+  end
+end

data/test/lib/uom/measurement_test.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/../helper'
+require "test/unit"
+require 'uom'
+
+class UOMTest < Test::Unit::TestCase
+  include UOM
+
+  def test_alias
+    assert_equal(:gram, Measurement.new(:g, 1).unit.label, "Gram alias not recognized")
+  end
+
+  def test_scale
+    assert_equal(:milligram, Measurement.new(:mg, 1).unit.label, "Milligram not recognized")
+  end
+
+  def test_conversion
+    round_trip = Measurement.new(MILLIMETER, 4).as(INCH).as(MILLIMETER)
+    assert_in_delta(4.0, round_trip.to_f, 0.0000001, "Unit conversion incorrect")
+  end
+
+  def test_product
+    assert_equal(4, Measurement.new(:meter, 2) * 2, "Numeric product incorrect")
+    actual =  Measurement.new(:meter, 2) * Measurement.new(:millimeter, 2000)
+    assert_equal(Measurement.new(:square_meter, 4), actual, "Measurement product incorrect: #{actual}")
+  end
+
+  def test_quotient
+    assert_equal(2, Measurement.new(:gram, 4) / 2, "Numeric quotient incorrect")
+    actual =  Measurement.new(:milligram, 4) / Measurement.new(:milliliter, 2)
+    assert_equal(Measurement.new(:milligram_per_milliliter, 2), actual, "Measurement quotient incorrect: #{actual}")
+  end
+
+  def test_equal
+    assert_equal(1, Measurement.new(:gram, 1), "Numeric equality not supported")
+    assert_equal(Measurement.new(:gram, 1), Measurement.new(:gram, 1), "Equality not reflexive")
+    assert_equal(Measurement.new(:g, 1), Measurement.new(:mg, 1000), "Equality does not account for factor conversion")
+  end
+
+  def test_concentration_alias
+    assert_equal(:grams_per_liter, Measurement.new(:g_per_l, 1).unit.label,"Concentration alias not recognized")
+  end
+
+  def test_concentration_conversion
+    assert_equal(0.004, Measurement.new(:mg_per_l, 4).as(:ug_per_ul).quantity, "Concentration conversion incorrect")
+  end
+
+  def test_idempotent_quotient_conversion
+    quotient = GRAM / LITER
+    assert_equal(:grams_per_liter, quotient.label, "Composite divide label incorrect")
+    other = MILLIGRAM / MILLILITER
+    roundtrip = Measurement.new(quotient, 4).as(other).as(quotient)
+    assert_equal(Measurement.new(other, 4.0), roundtrip, "Idempotent quotient conversion 4 grams_per_liter => milligrams_per_milliliter incorrect: #{roundtrip}")
+  end
+  
+  def test_parse_unknown_factor
+    assert_raises(UOM::MeasurementError, "'1 unknown' didn't raise a measurement error") { "1 unknown".to_measurement }
+  end
+
+  def test_parse_known_factors
+    assert_equal(Measurement.new(:gram, 1), "1g".to_measurement, "'1g' not parsed")
+    assert_equal(Measurement.new(:gram, 1), "1 g".to_measurement, "'1 g' not parsed")
+    assert_equal(Measurement.new(:gram, 1), "1 gm".to_measurement, "'1 gm' not parsed")
+    assert_equal(Measurement.new(:gram, 1), "1 gram".to_measurement, "gram not parsed")
+    assert_equal(Measurement.new(:gram, 4), "4 grams".to_measurement, "grams not parsed")
+    assert_equal(:micrograms_per_microliter, ".2 ug_per_ul".to_measurement.unit.label, "ug_per_ul not parsed")
+    assert_equal(:milligrams_per_liter, ".2 mg/l".to_measurement.unit.label, "ug/ul not parsed")
+    assert_equal(:milligram, "2".to_measurement(:milligram).unit.label, "Default not used")
+  end
+
+  def test_print
+    assert_equal("1 gram", Measurement.new(:gram, 1).to_s, "Measurement String incorrect")
+    assert_equal("2 grams", Measurement.new(:gram, 2).to_s, "Measurement String incorrect")
+  end
+end

data/test/lib/uom/unit_factory_test.rb

@@ -0,0 +1,134 @@
+require File.dirname(__FILE__) + '/../helper'
+require "test/unit"
+
+# JRuby SyncEnumerator moved from generator to REXML in JRuby 1.5
+require 'rexml/document'
+
+require 'uom/units'
+
+class UnitFactoryTest < Test::Unit::TestCase
+  def setup
+    @factory = UOM::UnitFactory.new
+  end
+
+  def test_gram
+    assert_equal(:gram, @factory.create('gram').label, "gram not recognized")
+    assert_equal(:gram, @factory.create('gm').label, "gm not recognized")
+    assert_equal(:gram, @factory.create('g').label, "g not recognized")
+  end
+
+  def test_milligram
+    assert_equal(:milligram, @factory.create('milligram').label, "milligram not recognized")
+    assert_equal(:milligram, @factory.create('mg').label, "mg not recognized")
+  end
+
+  def test_kiloliter
+    assert_equal(:kiloliter, @factory.create('kiloliter').label, "kiloliter not recognized")
+    assert_equal(:kiloliter, @factory.create('kl').label, "kl not recognized")
+  end
+
+  def test_product
+    assert_equal(:foot_pound, @factory.create('foot_pound').label, "foot_pound not recognized")
+    assert_equal(:foot_pound, @factory.create('ft_lb').label, "ft_lb not recognized")
+  end
+
+  def test_quotient
+    assert_equal(:milligrams_per_milliliter, @factory.create('milligrams_per_milliliter').label, "milligrams_per_milliliter not recognized")
+    assert_equal(:milligrams_per_milliliter, @factory.create('mg_per_ml').label, "mg_per_ml not recognized")
+  end
+
+  def test_square
+    assert_equal(:square_inch, @factory.create('square_inch').label, "square_inch not recognized")
+    assert_equal(:square_inch, @factory.create('sq_in').label, "sq_in not recognized")
+  end
+
+  def test_cubic
+    assert_equal(:cubic_inch, @factory.create('cubic_inch').label, "cubic_inch not recognized")
+    assert_equal(:cubic_inch, @factory.create('cu_in').label, "cu_in not recognized")
+  end
+
+  def test_psi
+    assert_equal(:pounds_per_inches_per_inch, @factory.create('pounds_per_square_inch').label, "pounds_per_square_inch not recognized")
+    assert_equal(:pounds_per_inches_per_inch, @factory.create('lb_per_sq_in').label, "lb_per_sq_in not recognized")
+  end
+
+  def test_energy
+    assert_equal(:kilojoule, @factory.create('kilojoule').label, "joule not recognized")
+    assert_equal(:kilojoule, @factory.create('kJ').label, "kJ not recognized")
+  end
+
+  def test_time
+    assert_equal(:nanosecond, @factory.create('nanosecond').label, "nanosecond not recognized")
+    assert_equal(:nanosecond, @factory.create('nsec').label, "nsec not recognized")
+  end
+
+  def test_temperature
+    assert_equal(:celsius, @factory.create('celsius').label, "celsius not recognized")
+    assert_equal(:celsius, @factory.create('C').label, "C not recognized")
+    assert_equal(:farenheit, @factory.create('farenheit').label, "farenheit not recognized")
+    assert_equal(:farenheit, @factory.create('F').label, "F not recognized")
+  end
+
+  def test_kilobyte
+    assert_equal(:kilobyte, @factory.create('kilobyte').label, "kilobyte not recognized")
+    assert_equal(:kilobyte, @factory.create('kByte').label, "KByte not recognized")
+    assert_equal(:kilobyte, @factory.create('kb').label, "KB not recognized")
+  end
+
+  # Tests parsing all possible combinations of labels, abbrevs and factors.
+  def test_all
+    units = File.open(ALL_UNITS, 'r').map { |line| line.chomp }
+    REXML::SyncEnumerator.new(units, generate_all_units).each do |expected, actual|
+      assert_equal(expected, actual, "Generated units differs from documented units")
+    end
+  end
+
+  def verify_create(label, axis, scalar=nil)
+    actual = @factory.create(label)
+    assert_same(axis.basis, actual.basis, "Unit with label '#{label}' basis is incorrect")
+    unless actual.scalar == UOM::UNIT and scalar.nil? then
+      assert_same(scalar, actual.scalar, "Unit '#{label}' scalar factor incorrect")
+    end
+  end
+  
+  private
+  
+  ALL_UNITS = File.expand_path('units.txt', File.dirname(__FILE__) + '/../../../doc')
+
+  def generate_all_units
+    basic = UOM::Unit.select do |unit|
+      unit.scalar == UOM::UNIT and not UOM::CompositeUnit === unit
+    end
+    all = basic.map do |unit|
+      labels = []
+      [UOM::UNIT].concat(unit.permissible_factors.to_a).each do |factor|
+        labels << label = "#{factor}#{unit}"
+        verify_create(label, unit, factor)
+        unless label == label.pluralize then
+          verify_create(label.pluralize, unit, factor)
+          labels << label.pluralize
+        end
+        unit.abbreviations.each do |abbrev|
+          labels << label = "#{factor.abbreviation}#{abbrev}"
+          verify_create(label, unit, factor)
+          abbrev_s = abbrev.to_s
+          unless abbrev_s.length < 2 then
+            plural = label + 's'
+            verify_create(plural, unit, factor)
+            labels << plural
+          end
+        end
+      end
+      labels.join(', ')
+    end
+    # combine byte measures
+    byte, std = all.partition { |line| line =~ /byte/ }
+    bh = {}
+    byte.each do |line|
+      key = /^(.*byte),.*/.match(line).captures.first.to_sym
+     bh[key] = line.chomp
+    end
+    std << [:byte, :kilobyte, :megabyte, :gigabyte, :terabyte, :petabyte].map { |k| bh[k] }.join(', ')
+    std.sort
+  end
+end

data/test/lib/uom/unit_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../helper'
+require "test/unit"
+require 'uom'
+
+# Not to be confused with Test::Unit, UnitTest tests Unit.
+class UnitTest < Test::Unit::TestCase
+  include UOM
+
+  def test_scale_high_to_low
+    assert_equal(4000, METER.as(4, MILLIMETER).to_f, "Scale conversion incorrect")
+  end
+
+  def test_scale_low_to_high
+    assert_equal(0.04, CENTIMETER.as(4, METER).to_f, "Scale conversion incorrect")
+  end
+
+  def test_byte
+    assert_equal(4 * 1024 * 1024, GIGABYTE.as(4, KILOBYTE).to_f, "Scale conversion incorrect")
+  end
+
+  def test_axis_conversion
+    round_trip = INCH.as(MILLIMETER.as(4, INCH), MILLIMETER)
+    assert_in_delta(4.0, round_trip.to_f, 0.000000001, "Unit conversion incorrect")
+  end
+
+  def test_basic_to_derived
+    round_trip = DRAM.as(GRAM.as(4, DRAM), GRAM)
+    assert_in_delta(4.0, round_trip.to_f, 0.000000001, "Unit conversion incorrect")
+  end
+
+  def test_new_unit
+    jpeg = Measurement.new(:jpeg, 4)
+    expected = Measurement.new(:joule_peck, 4) / Measurement.new(:erg_gauss, 1)
+    assert_equal(expected, jpeg, "New unit incorrect")
+  end
+
+  private
+
+  # joule-pecks per erg-gauss
+  JPEG = Unit.for((JOULE * PECK) / (ERG * GAUSS)).add_abbreviation(:jpeg)
+end

metadata

@@ -1,37 +1,62 @@
 --- !ruby/object:Gem::Specification 
 name: uom
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 1
-  version: 1.2.1
+  prerelease: 
+  version: 1.2.2
 platform: ruby
 authors: 
-- OHSU
+  - OHSU
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-04 00:00:00 -07:00
+date: 2011-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: extensional
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: extensional
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
 description: "    UOM implements Units of Measurement based on the International System of Units (SI).\n    The base SI units, metric scalar factors and all possible combinations of these units\n    are supported out of the box.\n"
 email: caruby.org@gmail.com
 executables: []
@@ -41,61 +66,67 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- doc/units.txt
-- lib/active_support/core_ext/string/inflections.rb
-- lib/active_support/core_ext/string.rb
-- lib/active_support/inflections.rb
-- lib/active_support/inflector.rb
-- lib/active_support/README.txt
-- lib/uom/composite_unit.rb
-- lib/uom/composite_unit_key_canonicalizer.rb
-- lib/uom/dimension.rb
-- lib/uom/dimensions.rb
-- lib/uom/error.rb
-- lib/uom/factor.rb
-- lib/uom/factors.rb
-- lib/uom/measurement.rb
-- lib/uom/unit.rb
-- lib/uom/unit_factory.rb
-- lib/uom/units.rb
-- lib/uom.rb
-- History.txt
-- LEGAL
-- LICENSE
-- README.md
-has_rdoc: uom
+  - lib/uom.rb
+  - lib/active_support/inflections.rb
+  - lib/active_support/inflector.rb
+  - lib/active_support/README.txt
+  - lib/active_support/core_ext/string.rb
+  - lib/active_support/core_ext/string/inflections.rb
+  - lib/uom/composite_unit.rb
+  - lib/uom/composite_unit_key_canonicalizer.rb
+  - lib/uom/dimension.rb
+  - lib/uom/dimensions.rb
+  - lib/uom/error.rb
+  - lib/uom/factor.rb
+  - lib/uom/factors.rb
+  - lib/uom/measurement.rb
+  - lib/uom/unit.rb
+  - lib/uom/unit_factory.rb
+  - lib/uom/units.rb
+  - lib/uom/version.rb
+  - test/lib/helper.rb
+  - test/lib/uom/composite_unit_key_canonicalizer_test.rb
+  - test/lib/uom/composite_unit_test.rb
+  - test/lib/uom/factor_test.rb
+  - test/lib/uom/measurement_test.rb
+  - test/lib/uom/unit_factory_test.rb
+  - test/lib/uom/unit_test.rb
+  - History.md
+  - LEGAL
+  - LICENSE
+  - README.md
+has_rdoc: yard
 homepage: http://github.com/caruby/uom/
-licenses: []
-
+licenses: 
+  - MIT
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: caruby
-rubygems_version: 1.3.7
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: Ruby Unit of Measurement library.
-test_files: []
-
+test_files: 
+  - test/lib/uom/composite_unit_key_canonicalizer_test.rb
+  - test/lib/uom/composite_unit_test.rb
+  - test/lib/uom/factor_test.rb
+  - test/lib/uom/measurement_test.rb
+  - test/lib/uom/unit_factory_test.rb
+  - test/lib/uom/unit_test.rb

data/History.txt

@@ -1,4 +0,0 @@
-=== 1.2.1 / 2010-09-30
-
-* Initial public release
-

data/doc/units.txt

@@ -1,53 +0,0 @@
-ampere, amperes, A, milliampere, milliamperes, mA, microampere, microamperes, uA, nanoampere, nanoamperes, nA, picoampere, picoamperes, pA, teraampere, teraamperes, TA, gigaampere, gigaamperes, GA, megaampere, megaamperes, MA, kiloampere, kiloamperes, kA
-angstrom, angstroms, a
-astronomical_unit, astronomical_units, AU, AUs
-barye, baryes, Ba, Bas, millibarye, millibaryes, mBa, mBas, microbarye, microbaryes, uBa, uBas, nanobarye, nanobaryes, nBa, nBas, picobarye, picobaryes, pBa, pBas, terabarye, terabaryes, TBa, TBas, gigabarye, gigabaryes, GBa, GBas, megabarye, megabaryes, MBa, MBas, kilobarye, kilobaryes, kBa, kBas
-bit, bits
-bushel, bushels, bu, bus
-byte, bytes, Byte, Bytes, B, b, kilobyte, kilobytes, KByte, KBytes, KB, KBs, megabyte, megabytes, MByte, MBytes, MB, MBs, gigabyte, gigabytes, GByte, GBytes, GB, GBs, terabyte, terabytes, TByte, TBytes, TB, TBs, petabyte, petabytes, PByte, PBytes, PB, PBs
-candela, candelas, cd, cds
-celsius, C
-coulomb, coulombs, millicoulomb, millicoulombs, microcoulomb, microcoulombs, nanocoulomb, nanocoulombs, picocoulomb, picocoulombs, teracoulomb, teracoulombs, gigacoulomb, gigacoulombs, megacoulomb, megacoulombs, kilocoulomb, kilocoulombs
-cup, cups, cp, cps
-day, days
-dram, drams, dr, drs
-dry_gallon, dry_gallons, dry_gal, dry_gals
-dry_pint, dry_pints, dry_pt, dry_pts
-dry_quart, dry_quarts, dry_qt, dry_qts
-dyne, dynes, dyn, dyns, millidyne, millidynes, mdyn, mdyns, microdyne, microdynes, udyn, udyns, nanodyne, nanodynes, ndyn, ndyns, picodyne, picodynes, pdyn, pdyns, teradyne, teradynes, Tdyn, Tdyns, gigadyne, gigadynes, Gdyn, Gdyns, megadyne, megadynes, Mdyn, Mdyns, kilodyne, kilodynes, kdyn, kdyns
-erg, ergs, millierg, milliergs, microerg, microergs, nanoerg, nanoergs, picoerg, picoergs, teraerg, teraergs, gigaerg, gigaergs, megaerg, megaergs, kiloerg, kiloergs
-farad, farads, millifarad, millifarads, microfarad, microfarads, nanofarad, nanofarads, picofarad, picofarads, terafarad, terafarads, gigafarad, gigafarads, megafarad, megafarads, kilofarad, kilofarads
-farenheit, F
-fluid_ounce, fluid_ounces, fl_oz, fl_ozs
-foot, foots, ft, fts
-gallon, gallons, gal, gals
-gauss, gausses, G
-grain, grains, gr, grs
-gram, grams, gm, gms, g, yottagram, yottagrams, Ygm, Ygms, Yg, zettagram, zettagrams, Zgm, Zgms, Zg, exagram, exagrams, Egm, Egms, Eg, teragram, teragrams, Tgm, Tgms, Tg, gigagram, gigagrams, Ggm, Ggms, Gg, megagram, megagrams, Mgm, Mgms, Mg, kilogram, kilograms, kgm, kgms, kg, hectogram, hectograms, hgm, hgms, hg, decagram, decagrams, dagm, dagms, dag, decigram, decigrams, dgm, dgms, dg, centigram, centigrams, cgm, cgms, cg, milligram, milligrams, mgm, mgms, mg, microgram, micrograms, ugm, ugms, ug, nanogram, nanograms, ngm, ngms, ng, picogram, picograms, pgm, pgms, pg, femtogram, femtograms, fgm, fgms, fg, attogram, attograms, agm, agms, ag, zeptogram, zeptograms, zgm, zgms, zg, yoctogram, yoctograms, ygm, ygms, yg
-henry, henries, H
-hour, hours, hr, hrs
-inch, inches, in, ins
-joule, joules, J, millijoule, millijoules, mJ, microjoule, microjoules, uJ, nanojoule, nanojoules, nJ, picojoule, picojoules, pJ, terajoule, terajoules, TJ, gigajoule, gigajoules, GJ, megajoule, megajoules, MJ, kilojoule, kilojoules, kJ
-kelvin, K
-light_year, light_years, ly, lys
-liter, liters, l, L, yottaliter, yottaliters, Yl, YL, zettaliter, zettaliters, Zl, ZL, exaliter, exaliters, El, EL, teraliter, teraliters, Tl, TL, gigaliter, gigaliters, Gl, GL, megaliter, megaliters, Ml, ML, kiloliter, kiloliters, kl, kL, hectoliter, hectoliters, hl, hL, decaliter, decaliters, dal, daL, deciliter, deciliters, dl, dL, centiliter, centiliters, cl, cL, milliliter, milliliters, ml, mL, microliter, microliters, ul, uL, nanoliter, nanoliters, nl, nL, picoliter, picoliters, pl, pL, femtoliter, femtoliters, fl, fL, attoliter, attoliters, al, aL, zeptoliter, zeptoliters, zl, zL, yoctoliter, yoctoliters, yl, yL
-maxwell, maxwells, Mx, Mxs
-meter, meters, m, yottameter, yottameters, Ym, zettameter, zettameters, Zm, exameter, exameters, Em, terameter, terameters, Tm, gigameter, gigameters, Gm, megameter, megameters, Mm, kilometer, kilometers, km, hectometer, hectometers, hm, decameter, decameters, dam, decimeter, decimeters, dm, centimeter, centimeters, cm, millimeter, millimeters, mm, micrometer, micrometers, um, nanometer, nanometers, nm, picometer, picometers, pm, femtometer, femtometers, fm, attometer, attometers, am, zeptometer, zeptometers, zm, yoctometer, yoctometers, ym
-mile, miles, mi, mis
-minute, minutes, min, mins
-mole, moles, mol, mols
-ohm, ohms
-ounce, ounces, oz, ozs
-peck, pecks, pk, pks
-pint, pints, pt, pts
-poise, poises, P, kilopoise, kilopoises, kP, millipoise, millipoises, mP, micropoise, micropoises, uP, nanopoise, nanopoises, nP, picopoise, picopoises, pP
-pound, pounds, lb, lbs
-quart, quarts, qt, qts
-second, seconds, sec, secs, s, millisecond, milliseconds, msec, msecs, ms, microsecond, microseconds, usec, usecs, us, nanosecond, nanoseconds, nsec, nsecs, ns, picosecond, picoseconds, psec, psecs, ps, femtosecond, femtoseconds, fsec, fsecs, fs
-tablespoon, tablespoons, tbsp, tbsps
-teaspoon, teaspoons, tsp, tsps
-tesla, teslas, T, decitesla, deciteslas, dT, centitesla, centiteslas, cT, millitesla, milliteslas, mT, microtesla, microteslas, uT, nanotesla, nanoteslas, nT, picotesla, picoteslas, pT
-ton, tons
-volt, volts, V, millivolt, millivolts, mV, microvolt, microvolts, uV, nanovolt, nanovolts, nV, picovolt, picovolts, pV, teravolt, teravolts, TV, gigavolt, gigavolts, GV, megavolt, megavolts, MV, kilovolt, kilovolts, kV
-weber, webers, Wb, Wbs, milliweber, milliwebers, mWb, mWbs, microweber, microwebers, uWb, uWbs, nanoweber, nanowebers, nWb, nWbs, picoweber, picowebers, pWb, pWbs, teraweber, terawebers, TWb, TWbs, gigaweber, gigawebers, GWb, GWbs, megaweber, megawebers, MWb, MWbs, kiloweber, kilowebers, kWb, kWbs
-yard, yards, yd, yds