ruby-units 0.2.1 → 0.2.2

data/CHANGELOG

@@ -91,6 +91,13 @@ Change Log for Ruby-units
                     * Can pass a strftime format string to to_s to format time
                       output
                     * can use U'1 mm' or '1 mm'.u to specify units now
-                    * 
+                    
+2006-09-19  0.2.2   * tweaked temperature handling a bit.  Now enter
+                      temperatures like this:
+                      '0 tempC'.unit #=> 273.15 degK
+                      They will always be converted to kelvin to avoid
+                      problems when temperatures are used in equations.
+                    * added Time.in("5 min")
+                    * added Unit.to_unit to simplify some calls
                     
                        

data/lib/ruby-units.rb

@@ -2,7 +2,7 @@ require 'mathn'
 require 'rational'
 require 'date'
 require 'parsedate'
-# = Ruby Units 0.2.1
+# = Ruby Units 0.2.2
 #
 # Copyright 2006 by Kevin C. Olbrich, Ph.D.
 # 
@@ -73,7 +73,6 @@ class Unit < Numeric
   include Comparable
   attr_accessor :scalar, :numerator, :denominator, :signature, :base_scalar
 
-
   def to_yaml_properties
     %w{@scalar @numerator @denominator @signature @base_scalar}
   end
@@ -122,14 +121,15 @@ class Unit < Numeric
       raise ArgumentError, "Invalid Unit Format"
     end
     self.update_base_scalar
+    self.replace_temperature
     self.freeze
   end
   
-  def initialize_copy(other)
-    @numerator = other.numerator.clone
-    @denominator = other.denominator.clone
+  def to_unit
+    self
   end
-    
+  alias :unit :to_unit
+  
   # Returns 'true' if the Unit is represented in base units
   def is_base?
     return true if @signature == 400 && @numerator.size == 1 && @numerator[0] =~ /(celcius|kelvin|farenheit|rankine)/
@@ -143,6 +143,7 @@ class Unit < Numeric
   #convert to base SI units
   def to_base
     return self if self.is_base?
+#    return self.to('degK') if self.units =~ /temp(C|K|F|R)/ 
     num = []
     den = []
     q = @scalar
@@ -262,8 +263,9 @@ class Unit < Numeric
   def +(other)   
     if Unit === other 
       if self =~ other then
-        q = @scalar + other.to(self).scalar
-        Unit.new(:scalar=>q, :numerator=>@numerator, :denominator=>@denominator)
+        a = self.to_base
+        b = other.to_base
+        Unit.new(:scalar=>(a.scalar + b.scalar), :numerator=>a.numerator, :denominator=>b.denominator).to(self)
       else
          raise ArgumentError,  "Incompatible Units"
       end
@@ -280,13 +282,14 @@ class Unit < Numeric
   def -(other)
     if Unit === other 
       if self =~ other then
-        q = @scalar - other.to(self).scalar
-        Unit.new(:scalar=>q, :numerator=>@numerator, :denominator=>@denominator)
+        a = self.to_base
+        b = other.to_base
+        Unit.new(:scalar=>(a.scalar - b.scalar), :numerator=>a.numerator, :denominator=>b.denominator).to(self)
       else
          raise ArgumentError,  "Incompatible Units"
       end
     elsif Time === other
-      other + self
+      other - self
     else
         x,y = coerce(other)
         x - y
@@ -411,34 +414,35 @@ class Unit < Numeric
     return self if other.nil? 
     return self if TrueClass === other
     return self if FalseClass === other
-    if String === other && other =~ /temp(K|C|R|F)/
+    if (Unit === other && other.units =~ /temp(K|C|R|F)/) || (String === other && other =~ /temp(K|C|R|F)/) 
       raise ArgumentError, "Receiver is not a temperature unit" unless self.signature==400 
       return self.to_base.to(other) unless self.is_base?
-      #return self.to_base.to("tempF") if @numerator.size > 1 || @denominator != ['<1>']
-      q=case 
-         when @numerator.include?('<celcius>'):
-          case other
+      start_unit = self.units
+      target_unit = other.units rescue other
+      q=case start_unit
+         when 'degC':
+          case target_unit
             when 'tempC'  : @scalar
             when 'tempK'  : @scalar + 273.15
             when 'tempF'  : @scalar * (9.0/5.0) + 32.0
             when 'tempR'  : @scalar * (9.0/5.0) + 491.67
           end
-        when @numerator.include?( '<kelvin>'):
-          case other
+        when 'degK':
+          case target_unit
             when 'tempC'  : @scalar - 273.15
             when 'tempK'  : @scalar 
             when 'tempF'  : @scalar * (9.0/5.0) - 459.67
             when 'tempR'  : @scalar * (9.0/5.0) 
           end
-        when @numerator.include?( '<farenheit>'):
-          case other
+        when 'degF':
+          case target_unit
             when 'tempC'  : (@scalar-32)*(5.0/9.0)
             when 'tempK'  : (@scalar+459.67)*(5.0/9.0)
             when 'tempF'  : @scalar 
             when 'tempR'  : @scalar  + 459.67
           end
-        when @numerator.include?( '<rankine>'):
-          case other
+        when 'degR':
+          case target_unit
             when 'tempC'  : @scalar*(5.0/9.0) -273.15
             when 'tempK'  : @scalar*(5.0/9.0)
             when 'tempF'  : @scalar - 459.67
@@ -447,6 +451,7 @@ class Unit < Numeric
         else
           raise ArgumentError, "Unknown temperature conversion requested #{self.numerator}"
       end
+      target_unit =~ /temp(C|K|F|R)/
       Unit.new("#{q} deg#{$1}")
     else
        case other
@@ -468,84 +473,11 @@ class Unit < Numeric
       Unit.new(:scalar=>q, :numerator=>target.numerator, :denominator=>target.denominator)
     end
   end  
-  
-  alias :>> :to  
-  # calculates the unit signature vector used by unit_signature
-  def unit_signature_vector
-      return self.to_base.unit_signature_vector unless self.is_base?
-      result = self
-      y = [:length, :time, :temperature, :mass, :current, :substance, :luminosity, :currency, :memory, :angle]
-      vector = Array.new(y.size,0)
-      y.each_with_index do |units,index|
-        vector[index] = result.numerator.compact.find_all {|x| @@UNIT_VECTORS[units].include? Regexp.escape(x)}.size
-        vector[index] -= result.denominator.compact.find_all {|x| @@UNIT_VECTORS[units].include? Regexp.escape(x)}.size  
-      end
-      vector
-  end
-  
-  # calculates the unit signature id for use in comparing compatible units and simplification
-  # the signature is based on a simple classification of units and is based on the following publication
-  #  
-  #  Novak, G.S., Jr. "Conversion of units of measurement", IEEE Transactions on Software Engineering,
-  #  21(8), Aug 1995, pp.651-661
-  #  doi://10.1109/32.403789
-  #  http://ieeexplore.ieee.org/Xplore/login.jsp?url=/iel1/32/9079/00403789.pdf?isnumber=9079&prod=JNL&arnumber=403789&arSt=651&ared=661&arAuthor=Novak%2C+G.S.%2C+Jr.
-  #
-  def unit_signature
-    vector = unit_signature_vector
-    vector.each_with_index {|item,index| vector[index] = item * 20**index}
-    @signature=vector.inject(0) {|sum,n| sum+n}
-  end
-  
+  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. 
-  def self.eliminate_terms(q, n, d)
-    num = n.clone
-    den = d.clone
-    
-    num.delete_if {|v| v == '<1>'}
-    den.delete_if {|v| v == '<1>'}
-    combined = Hash.new(0)
- 
-    i = 0
-    loop do 
-      break if i > num.size
-      if @@PREFIX_VALUES.has_key? num[i]
-        k = [num[i],num[i+1]]
-        i += 2
-      else
-        k = num[i]
-        i += 1
-      end
-      combined[k] += 1 unless k.nil? || k == '<1>'
-    end
-    
-    j = 0
-    loop do
-      break if j > den.size
-        if @@PREFIX_VALUES.has_key? den[j]
-          k = [den[j],den[j+1]]
-          j += 2
-        else
-          k = den[j]
-          j += 1
-        end
-      combined[k] -= 1 unless k.nil? || k == '<1>'
-    end
- 
-    num = []
-    den = []
-    combined.each do |key,value| 
-      case 
-      when value > 0 : value.times {num << key}
-      when value < 0 : value.abs.times {den << key}
-      end
-    end
-    num = ["<1>"] if num.empty?
-    den = ["<1>"] if den.empty?
-    {:scalar=>q, :numerator=>num.flatten.compact, :denominator=>den.flatten.compact}
-  end
-      
   # converts the unit back to a float if it is unitless
   def to_f
     return @scalar.to_f if self.unitless?
@@ -644,6 +576,7 @@ class Unit < Numeric
       time_point - self
     end
   end
+  alias :before_now :before
   
   # 'min'.since(time)
   def since(time_point = ::Time.now)
@@ -667,11 +600,6 @@ class Unit < Numeric
     end
   end
   
-  # '5 min'.from_now
-  def from_now
-    self.from
-  end
-
   # '5 min'.from(time)
   def from(time_point = ::Time.now)
     raise ArgumentError, "Must specify a Time" unless time_point
@@ -682,6 +610,7 @@ class Unit < Numeric
     end
   end
   alias :after :from
+  alias :from_now :from
       
   def succ
     raise ArgumentError, "Non Integer Scalar" unless @scalar == @scalar.to_i
@@ -689,6 +618,10 @@ class Unit < Numeric
     Unit.new([q, @numerator, @denominator])
   end
       
+  # Protected and Private Functions that should only be called from this class
+  protected
+  
+  
   def update_base_scalar
     if self.is_base?
       @base_scalar = @scalar
@@ -700,6 +633,7 @@ class Unit < Numeric
     end
   end
   
+  
   def coerce(other)
     case other
     when Unit : [other, self]
@@ -708,8 +642,107 @@ class Unit < Numeric
     end
   end
   
+  
+  # calculates the unit signature vector used by unit_signature
+  def unit_signature_vector
+      return self.to_base.unit_signature_vector unless self.is_base?
+      result = self
+      y = [:length, :time, :temperature, :mass, :current, :substance, :luminosity, :currency, :memory, :angle]
+      vector = Array.new(y.size,0)
+      y.each_with_index do |units,index|
+        vector[index] = result.numerator.compact.find_all {|x| @@UNIT_VECTORS[units].include? Regexp.escape(x)}.size
+        vector[index] -= result.denominator.compact.find_all {|x| @@UNIT_VECTORS[units].include? Regexp.escape(x)}.size  
+      end
+      vector
+  end
+  
+  def replace_temperature
+    return self unless self.signature == 400 && self.units =~ /temp(R|K|F|C)/
+    un = $1
+    puts "self:#{self} #{un}"
+    target = self.units
+    @numerator = case un
+      when 'R' : ['<rankine>']
+      when 'C' : ['<celcius>']
+      when 'F' : ['<farenheit>']
+      when 'K' : ['<kelvin>']
+    end
+    r= self.to("tempK")
+    @numerator = r.numerator
+    @denominator = r.denominator
+    @scalar = r.scalar
+  end
+  
+  
   private
   
+  def initialize_copy(other)
+    @numerator = other.numerator.clone
+    @denominator = other.denominator.clone
+  end
+  
+  # calculates the unit signature id for use in comparing compatible units and simplification
+  # the signature is based on a simple classification of units and is based on the following publication
+  #  
+  #  Novak, G.S., Jr. "Conversion of units of measurement", IEEE Transactions on Software Engineering,
+  #  21(8), Aug 1995, pp.651-661
+  #  doi://10.1109/32.403789
+  #  http://ieeexplore.ieee.org/Xplore/login.jsp?url=/iel1/32/9079/00403789.pdf?isnumber=9079&prod=JNL&arnumber=403789&arSt=651&ared=661&arAuthor=Novak%2C+G.S.%2C+Jr.
+  #
+  def unit_signature
+    vector = unit_signature_vector
+    vector.each_with_index {|item,index| vector[index] = item * 20**index}
+    @signature=vector.inject(0) {|sum,n| sum+n}
+  end
+  
+  def self.eliminate_terms(q, n, d)
+    num = n.clone
+    den = d.clone
+    
+    num.delete_if {|v| v == '<1>'}
+    den.delete_if {|v| v == '<1>'}
+    combined = Hash.new(0)
+ 
+    i = 0
+    loop do 
+      break if i > num.size
+      if @@PREFIX_VALUES.has_key? num[i]
+        k = [num[i],num[i+1]]
+        i += 2
+      else
+        k = num[i]
+        i += 1
+      end
+      combined[k] += 1 unless k.nil? || k == '<1>'
+    end
+    
+    j = 0
+    loop do
+      break if j > den.size
+        if @@PREFIX_VALUES.has_key? den[j]
+          k = [den[j],den[j+1]]
+          j += 2
+        else
+          k = den[j]
+          j += 1
+        end
+      combined[k] -= 1 unless k.nil? || k == '<1>'
+    end
+ 
+    num = []
+    den = []
+    combined.each do |key,value| 
+      case 
+      when value > 0 : value.times {num << key}
+      when value < 0 : value.abs.times {den << key}
+      end
+    end
+    num = ["<1>"] if num.empty?
+    den = ["<1>"] if den.empty?
+    {:scalar=>q, :numerator=>num.flatten.compact, :denominator=>den.flatten.compact}
+  end
+      
+  
   # parse a string into a unit object.
   # Typical formats like : 
   #  "5.6 kg*m/s^2"
@@ -926,6 +959,10 @@ class Time
     end
   end
   
+  def self.in(duration)
+    Time.now + duration.to_unit
+  end
+  
   alias :unit_sub :-
   def -(other)
     if Unit === other

data/lib/units.rb

@@ -93,6 +93,10 @@ UNIT_DEFINITIONS = {
   '<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>}],
+  '<temp-K>'  => [%w{tempK}, 1.0, :temperature, %w{<kelvin>}],
+  '<temp-C>'  => [%w{tempC}, 1.0, :temperature, %w{<kelvin>}],
+  '<temp-F>'  => [%w{tempF}, 1.0, :temperature, %w{<kelvin>}],
+  '<temp-R>'  => [%w{tempR}, 1.0, :temperature, %w{<kelvin>}],
   
   #time
   '<second>'=>  [%w{s sec second seconds}, 1.0, :time, %w{<second>}],

data/test/test_ruby-units.rb

@@ -1,5 +1,8 @@
 require 'test/unit'
+require 'rubygems'
 require 'ruby-units'
+require 'yaml'
+require 'uncertain'
 
 class Unit < Numeric
   @@USER_DEFINITIONS = {'<inchworm>' =>  [%w{inworm inchworm}, 0.0254, :length, %w{<meter>} ],
@@ -10,6 +13,27 @@ end
 
 class TestRubyUnits < Test::Unit::TestCase
   
+  def test_to_yaml
+    unit = "1 mm".u
+    assert_equal "--- !ruby/object:Unit \nscalar: 1.0\nnumerator: \n- <milli>\n- <meter>\ndenominator: \n- <1>\nsignature: 1\nbase_scalar: 0.001\n", unit.to_yaml    
+  end
+
+  def test_time
+    a = Time.now
+    assert_equal "s", a.to_unit.units
+    assert_equal a + 3600, a + "1 h".unit
+    assert_equal a - 3600, a - "1 h".unit
+    b = Unit(a) + "1 h".unit
+    assert_in_delta Time.now - "1 h".unit, "1 h".ago, 1
+    assert_in_delta Time.now + 3600, "1 h".from_now, 1
+    assert_in_delta "1 h".unit + Time.now, "1 h".from_now, 1
+    assert_in_delta Time.now - 3600, "1 h".before_now, 1
+    assert_in_delta (Time.now.unit - Time.now).unit.scalar, 0, 1
+
+    assert_equal "60 min", "min".until(Time.now + 3600).to_s
+    assert_equal "01:00", "min".since(Time.now - 3600).to_s("%H:%M")
+  end
+
   def test_clone
     unit1= "1 mm".unit
     unit2 = unit1.clone

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2006-09-18 00:00:00 -04:00
+  version: 0.2.2
+date: 2006-09-19 00:00:00 -04:00
 summary: A model that performs unit conversions and unit math
 require_paths: 
 - lib