ruby-units 0.2.0 → 0.2.1

data/CHANGELOG

@@ -57,5 +57,40 @@ Change Log for Ruby-units
                         => Sat Sep 23 04:26:40 EDT 2006
                     * Time.now.unit => 1.159e9 s
                     * works well with 'Uncertain' numerics
+                      (www.rubyforge.org/projects/uncertain)
                     * Improved parsing
-                      
+                      
+2006-09-18  0.2.1   * Trig math functions (sin, cos, tan, sinh, cosh, tanh)
+                      accept units that can be converted to radians
+                      Math.sin("90 deg".unit) => 1.0
+                    * Date and DateTime can be offset by a time unit
+                      (Date.today + "1 day".unit) => 2006-09-19
+                      Does not work with months since they aren't a consistent
+                      size
+                    * Tweaked time usage a bit
+                      Time.now + "1 hr".unit => Mon Sep 18 11:51:29 EDT 2006
+                    * can output time in 'hh:mm:ss' format by using
+                     'unit.to_s(:time)'
+                    * added time helper methods 
+                      ago, 
+                      since(Time/DateTime), 
+                      until(Time/DateTime), 
+                      from(Time/DateTime), 
+                      before(Time/DateTime), and
+                      after(Time/DateTime)
+                    * Time helpers also work on strings.  In this case they 
+                      are first converted to units
+                      '5 min'.from_now
+                      '1 week'.ago
+                      'min'.since(time)
+                      'min'.until(time)
+                      '1 day'.from()
+                    * Can pass Strings to time helpers and they will be parsed
+                      with ParseDate
+                    * Fixed most parsing bugs (I think)
+                    * 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
+                    * 
+                    
+                       

data/README

@@ -1,6 +1,6 @@
 =Ruby Units
 
-Version: 0.1.0
+Version: 0.2.1
 
 Kevin C. Olbrich, Ph.D. 
 
@@ -29,6 +29,11 @@ This package may be installed using:
  unit = Unit("1 mm")              # shorthand
  unit = "1 mm".to_unit            # convert string object
  unit = object.to_unit            # convert any object using object.to_s
+ unit = U'1 mm'
+ unit = u'1 mm'
+ unit = '1 mm'.unit
+ unit = '1 mm'.u
+ 
 
 ==Rules:  
 1. only 1 quantity per unit (with 2 exceptions... 6'5" and '8 lbs 8 oz')
@@ -69,8 +74,11 @@ Units can be converted to other units in a couple of ways.
  unit >>= "ft"          # => convert and overwrite original object
  unit3 = unit1 + unit2  # => resulting object will have the units of unit1
  unit3 = unit1 - unit2  # => resulting object will have the units of unit1
- unit1 <=> unit2        # => does comparison on quantities in base units, throws an exception if not compatible
- unit1 === unit2        # => true if units and quantity are the same, even if 'equivalent' by <=>
+ unit1 <=> unit2        # => does comparison on quantities in base units, 
+                          throws an exception if not compatible
+ unit1 === unit2        # => true if units and quantity are the same, even if
+                          'equivalent' by <=>
+ unit.to('ft')          # convert
  
 ==Text Output
 Units will display themselves nicely based on the preferred abbreviation for the units and prefixes.
@@ -78,8 +86,35 @@ Since Unit implements a Unit#to_s, all that is needed in most cases is:
  "#{Unit.new('1 mm')}"  #=> "1 mm"
  
 The to_s also accepts some options.
- Unit.new('1.5 mm').to_s("%0.2f")  # => "1.50 mm".  Enter any valid format string
- Unit.new('1.5 mm').to_s("in")     # => converts to inches before printing
- Unit.new("2 m").to_s(:ft)         #=> returns 6'7"
- Unit.new("100 kg").to_s(:lbs)     #=> returns 220 lbs, 7 oz
- 
+ Unit.new('1.5 mm').to_s("%0.2f")  # => "1.50 mm".  Enter any valid format
+                                      string.  Also accepts strftime format
+ U('1.5 mm').to_s("in")     # => converts to inches before printing
+ U("2 m").to_s(:ft)         #=> returns 6'7"
+ U("100 kg").to_s(:lbs)     #=> returns 220 lbs, 7 oz
+ 
+ 
+==Time Helpers
+
+Time, Date, and DateTime objects can have time units added or subtracted.
+
+Time.now + "10 min".u 
+
+Several helpers have also been defined.
+
+'min'.since('9/18/06 3:00pm')
+'min'.before('9/18/08 3:00pm')
+'days'.until('1/1/07')
+'5 min'.from(Time.now)
+'5 min'.from_now
+'5 min'.before_now
+'5 min'.before(Time.now)
+'10 min'.ago
+
+==Ranges
+
+[U('0 h')..U('10 h')].each {|x| p x}
+works so long as the starting point has an integer scalar
+
+==Math functions
+All Trig math functions (sin, cos, sinh, ...) can take a unit as their parameter.  It will be converted to radians and then used if possible.
+

data/lib/ruby-units.rb

@@ -1,7 +1,8 @@
 require 'mathn'
 require 'rational'
-
-# = Ruby Units 0.2.0
+require 'date'
+require 'parsedate'
+# = Ruby Units 0.2.1
 #
 # Copyright 2006 by Kevin C. Olbrich, Ph.D.
 # 
@@ -185,10 +186,16 @@ class Unit < Numeric
     when :lbs:
       ounces = self.to("oz").scalar
       "#{(ounces / 16).truncate} lbs, #{(ounces % 16).round} oz"
+    when String
+      begin #first try a standard format string
+        target_units =~ /(%[\w\d#+-.]*)*\s*(.+)*/
+        return self.to($2).to_s($1) if $2
+        "#{($1 || '%g') % @scalar || 0} #{self.units}".strip
+      rescue #if that is malformed, try a time string
+        return (Time.gm(0) + self).strftime(target_units)
+      end
     else
-      target_units =~ /(%[\w\d#+-.]*)*\s*(.+)*/
-      return self.to($2).to_s($1) if $2
-      "#{($1 || '%g') % @scalar || 0} #{self.units}".strip
+      "#{'%g' % @scalar} #{self.units}".strip
     end    
   end
   
@@ -260,9 +267,11 @@ class Unit < Numeric
       else
          raise ArgumentError,  "Incompatible Units"
       end
+    elsif Time === other
+      other + self
     else
         x,y = coerce(other)
-        x + y
+        y + x
     end
   end
   
@@ -276,6 +285,8 @@ class Unit < Numeric
       else
          raise ArgumentError,  "Incompatible Units"
       end
+    elsif Time === other
+      other + self
     else
         x,y = coerce(other)
         x - y
@@ -360,7 +371,7 @@ class Unit < Numeric
     raise ArgumentError, "Illegal root" unless vec.max == 0
     num = @numerator.clone
     den = @denominator.clone
-    
+      
     @numerator.uniq.each do |item|
       x = num.find_all {|i| i==item}.size
       r = ((x/n)*(n-1)).to_int
@@ -372,8 +383,8 @@ class Unit < Numeric
       r = ((x/n)*(n-1)).to_int
       r.times {|x| den.delete_at(den.index(item))}
     end
-    q = @scalar**(1/n)
-    Unit.new([q,num,den])    
+    q = @scalar**(1/n)    
+    Unit.new(:scalar=>q,:numerator=>num,:denominator=>den)    
   end
   
   # returns inverse of Unit (1/unit)
@@ -402,8 +413,8 @@ class Unit < Numeric
     return self if FalseClass === other
     if 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>']
+      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
@@ -535,7 +546,7 @@ class Unit < Numeric
     {:scalar=>q, :numerator=>num.flatten.compact, :denominator=>den.flatten.compact}
   end
       
-  # returns the scalar part of the Unit
+  # converts the unit back to a float if it is unitless
   def to_f
     return @scalar.to_f if self.unitless?
     raise RuntimeError, "Can't convert to float unless unitless.  Use Unit#scalar"
@@ -602,6 +613,7 @@ class Unit < Numeric
     Unit.new([@scalar.to_int, @numerator, @denominator])    
   end
   
+  # Tries to make a Time object from current unit
   def to_time
     Time.at(self)
   end
@@ -617,6 +629,59 @@ class Unit < Numeric
   def zero?
     return @scalar.zero?
   end
+  
+  # '5 min'.unit.ago 
+  def ago
+    Time.now - self
+  end
+  
+  # '5 min'.before(time)
+  def before(time_point = ::Time.now)
+    raise ArgumentError, "Must specify a Time" unless time_point
+    if String === time_point
+      Time.local(*ParseDate.parsedate(time_point))-self 
+    else
+      time_point - self
+    end
+  end
+  
+  # 'min'.since(time)
+  def since(time_point = ::Time.now)
+    case time_point
+    when Time:      (Time.now - time_point).unit('s').to(self)
+    when DateTime:  (DateTime.now - time_point).unit('d').to(self)
+    when String:    (Time.now - Time.local(*ParseDate.parsedate(time_point))).unit('s').to(self) 
+    else
+      raise ArgumentError, "Must specify a Time" unless time_point
+    end
+  end
+  
+  # 'min'.until(time)
+  def until(time_point = ::Time.now)
+    case time_point
+    when Time:      (time_point - Time.now).unit('s').to(self)
+    when DateTime:  (time_point - DateTime.now).unit('d').to(self)
+    when String:    (Time.local(*ParseDate.parsedate(time_point)) - Time.now).unit('s').to(self)
+    else
+      raise ArgumentError, "Must specify a Time" unless time_point
+    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
+    if String === time_point
+      Time.local(*ParseDate.parsedate(time_point))+self
+    else
+      time_point + self
+    end
+  end
+  alias :after :from
       
   def succ
     raise ArgumentError, "Non Integer Scalar" unless @scalar == @scalar.to_i
@@ -705,17 +770,17 @@ class Unit < Numeric
       @scalar = @scalar.to_f
     end
             
-    @numerator = top.scan(/((#{@@PREFIX_REGEX})*(#{@@UNIT_REGEX}))/).delete_if {|x| x.empty?}.compact if top
-    @denominator = bottom.scan(/((#{@@PREFIX_REGEX})*(#{@@UNIT_REGEX}))/).delete_if {|x| x.empty?}.compact if bottom
+    @numerator = top.scan(/(#{@@PREFIX_REGEX})*?(#{@@UNIT_REGEX})\b/).delete_if {|x| x.empty?}.compact if top
+    @denominator = bottom.scan(/(#{@@PREFIX_REGEX})*?(#{@@UNIT_REGEX})\b/).delete_if {|x| x.empty?}.compact if bottom
 
     @numerator = @numerator.map do |item|
       item.map {|x| Regexp.escape(x) if x}
-      @@UNIT_MAP[item[0]] ? [@@UNIT_MAP[item[0]]] : [@@PREFIX_MAP[item[1]], @@UNIT_MAP[item[2]]]
+       @@PREFIX_MAP[item[0]] ? [@@PREFIX_MAP[item[0]], @@UNIT_MAP[item[1]]] : [@@UNIT_MAP[item[1]]]
     end.flatten.compact.delete_if {|x| x.empty?}
 
     @denominator = @denominator.map do |item|
        item.map {|x| Regexp.escape(x) if x}
-       @@UNIT_MAP[item[0]] ? [@@UNIT_MAP[item[0]]] : [@@PREFIX_MAP[item[1]], @@UNIT_MAP[item[2]]]
+       @@PREFIX_MAP[item[0]] ? [@@PREFIX_MAP[item[0]], @@UNIT_MAP[item[1]]] : [@@UNIT_MAP[item[1]]]
     end.flatten.compact.delete_if {|x| x.empty?}
 
     @numerator = ['<1>'] if @numerator.empty?    
@@ -724,43 +789,77 @@ class Unit < Numeric
   end 
 end
 
+# Need the 'Uncertain' gem for this to do anything helpful
 if defined? Uncertain
   class Uncertain
     def to_unit(other=nil)
       other ? Unit.new(self).to(other) : Unit.new(self)
     end
+    alias :unit :to_unit
+    alias :u :to_unit
   end
 end
 
 
+# Allow date objects to do offsets by a time unit
+# Date.today + U"1 week" => gives today+1 week
+class Date
+  alias :unit_date_add :+
+  def +(unit)
+    if Unit === unit
+      unit_date_add(unit.to('day').scalar)
+    else
+      unit_date_add(unit)
+    end
+  end
+
+  alias :unit_date_sub :-    
+  def -(unit)
+    if Unit === unit
+      unit_date_sub(unit.to('day').scalar)
+    else
+      unit_date_sub(unit)
+    end
+  end
+end
+
 class Object
   def Unit(other)
     other.to_unit
   end
+  alias :U :Unit
+  alias :u :Unit
 end
 
+# make a unitless unit with a given scalar
 class Numeric
   def to_unit(other = nil)
     other ? Unit.new(self) * Unit.new(other) : Unit.new(self)
   end
   alias :unit :to_unit
+  alias :u :to_unit
 end
 
-
+# make a unit from an array
+# [1, 'mm'].unit => 1 mm
 class Array
   def to_unit(other = nil)
     other ? Unit.new(self).to(other) : Unit.new(self)
   end
   alias :unit :to_unit
+  alias :u :to_unit
 end
 
+# make a string into a unit
 class String
   def to_unit(other = nil)
     other ? Unit.new(self) >> other : Unit.new(self)
   end
   alias :unit :to_unit
+  alias :u :to_unit
   alias :unit_format :%
   
+  # format unit output using formating codes '%0.2f' % '1 mm'.unit => '1.00 mm'
   def %(*args)
     if Unit === args[0]
       args[0].to_s(self)
@@ -768,8 +867,37 @@ class String
       unit_format(*args)
     end
   end
+    
+  def from(time_point = ::Time.now)
+    self.unit.from(time_point)
+  end
+  alias :after :from
+  alias :from_now :from
+  
+  def ago
+    self.unit.ago
+  end
+  
+  def before(time_point = ::Time.now)
+    self.unit.before(time_point)
+  end
+  alias :before_now :before
+  
+  def since(time_point = ::Time.now)
+    self.unit.since(time_point)
+  end
+  
+  def until(time_point = ::Time.now)
+    self.unit.until(time_point)
+  end
+  
+  def to(other)
+    self.unit.to(other)
+  end
 end
 
+
+# Allow time objects to use 
 class Time
   
   class << self
@@ -785,14 +913,14 @@ class Time
   end
   
   def to_unit(other = "s")
-    other ? Unit.new(self.to_f) * Unit.new(other) : Unit.new(self.to_f)
+    other ? Unit.new("#{self.to_f} s").to(other) : Unit.new("#{self.to_f} s")
   end
   alias :unit :to_unit
-  
+  alias :u :to_unit
   alias :unit_add :+
   def +(other)
     if Unit === other
-      self.unit + other
+      unit_add(other.to('s').scalar)
     else
       unit_add(other)
     end
@@ -801,9 +929,78 @@ class Time
   alias :unit_sub :-
   def -(other)
     if Unit === other
-      self.unit - other
+      unit_sub(other.to('s').scalar)
     else
       unit_sub(other)
     end
   end
+end
+
+module Math
+  alias unit_sin sin
+   def sin(n)
+     if Unit === n
+       unit_sin(n.to('radian').scalar)
+     else
+       unit_sin(n)
+     end
+   end
+
+   alias unit_cos cos
+    def cos(n)
+      if Unit === n
+        unit_cos(n.to('radian').scalar)
+      else
+        unit_cos(n)
+      end
+    end
+    
+    alias unit_sinh sinh
+     def sinh(n)
+       if Unit === n
+         unit_sinh(n.to('radian').scalar)
+       else
+         unit_sinh(n)
+       end
+     end
+
+     alias unit_cosh cosh
+      def cosh(n)
+        if Unit === n
+          unit_cosh(n.to('radian').scalar)
+        else
+          unit_cosh(n)
+        end
+      end
+
+      alias unit_tan tan
+       def tan(n)
+         if Unit === n
+           unit_tan(n.to('radian').scalar)
+         else
+           unit_tan(n)
+         end
+       end
+
+       alias unit_tanh tanh
+        def tanh(n)
+          if Unit === n
+            unit_tanh(n.to('radian').scalar)
+          else
+            unit_tanh(n)
+          end
+        end
+
+   module_function :unit_sin
+   module_function :sin
+   module_function :unit_cos
+   module_function :cos
+   module_function :unit_sinh
+   module_function :sinh
+   module_function :unit_cosh
+   module_function :cosh
+   module_function :unit_tan
+   module_function :tan
+   module_function :unit_tanh
+   module_function :tanh
 end

data/test/test_ruby-units.rb

@@ -447,7 +447,6 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_in_delta 558.27, unit1.to("tempR").scalar, 0.01
     unit3 = Unit.new("1 J/degC")
     assert_in_delta 1, (unit3 >> "J/degK").scalar, 0.01
-    assert_raises(ArgumentError) {"10 degH".unit >> "tempF"}
     
     # round trip conversions
     unit1 = Unit "37 degC"
@@ -562,7 +561,7 @@ class TestRubyUnits < Test::Unit::TestCase
   def test_inspect
     unit1 = Unit "1 mm"
     assert_equal "1 mm", unit1.inspect
-    assert_not_equal "1 mm", unit1.inspect(:dump)
+    assert_not_equal "1.0 mm", unit1.inspect(:dump)
   end
   
   def test_to_f

metadata

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