ruby-units 1.3.1 → 1.3.2.a

data/lib/ruby_units/time.rb

@@ -14,14 +14,14 @@ class Time
   def self.at(arg)
     case arg
     when Unit
-      unit_time_at(arg.to("s").scalar)
+      unit_time_at(arg.convert_to("s").scalar)
     else
       unit_time_at(arg)
     end
   end
   
   def to_unit(other = nil)
-    other ? Unit.new(self).to(other) : Unit.new(self)
+    other ? Unit.new(self).convert_to(other) : Unit.new(self)
   end
   alias :unit :to_unit
   alias :u :to_unit
@@ -37,9 +37,9 @@ class Time
   def +(other)
     case other
     when Unit
-      other = other.to('d').round.to('s') if ['y', 'decade', 'century'].include? other.units  
+      other = other.convert_to('d').round.convert_to('s') if ['y', 'decade', 'century'].include? other.units  
       begin
-        unit_add(other.to('s').scalar)
+        unit_add(other.convert_to('s').scalar)
       rescue RangeError
         self.to_datetime + other
       end
@@ -58,9 +58,9 @@ class Time
   def -(other)
     case other
     when Unit
-      other = other.to('d').round.to('s') if ['y', 'decade', 'century'].include? other.units  
+      other = other.convert_to('d').round.convert_to('s') if ['y', 'decade', 'century'].include? other.units  
       begin
-        unit_sub(other.to('s').scalar)
+        unit_sub(other.convert_to('s').scalar)
       rescue RangeError
         self.send(:to_datetime) - other
       end

data/lib/ruby_units/unit.rb

@@ -47,7 +47,7 @@ class Unit < Numeric
   @@UNIT_MAP = {}
   @@UNIT_VALUES = {}
   @@OUTPUT_MAP = {}
-  @@BASE_UNITS = ['<meter>','<kilogram>','<second>','<mole>', '<farad>', '<ampere>','<radian>','<kelvin>','<temp-K>','<byte>','<dollar>','<candela>','<each>','<steradian>','<decibel>']
+  @@BASE_UNITS = ['<meter>','<kilogram>','<second>','<mole>', '<ampere>','<radian>','<kelvin>','<tempK>','<byte>','<dollar>','<candela>','<each>','<steradian>','<decibel>']
   UNITY = '<1>'
   UNITY_ARRAY= [UNITY]
   FEET_INCH_REGEX = /(\d+)\s*(?:'|ft|feet)\s*(\d+)\s*(?:"|in|inches)/
@@ -69,35 +69,46 @@ class Unit < Numeric
   CELSIUS = ['<celsius>']
   TEMP_REGEX = /(?:temp|deg)[CFRK]/
 
-  SIGNATURE_VECTOR = [:length, :time, :temperature, :mass, :current, :substance, :luminosity, :currency, :memory, :angle, :capacitance]
+  SIGNATURE_VECTOR = [:length, :time, :temperature, :mass, :current, :substance, :luminosity, :currency, :memory, :angle]
   @@KINDS = {
-    -312058=>:resistance, 
+    -312078 => :elastance,
+    -312058=>:resistance,
     -312038=>:inductance, 
     -152040=>:magnetism, 
     -152038=>:magnetism, 
-    -152058=>:potential, 
+    -152058=>:potential,
+    -7997 => :specific_volume,
+    -79 => :snap,
+    -59 => :jolt, 
     -39=>:acceleration,
     -38=>:radiation, 
     -20=>:frequency, 
     -19=>:speed, 
     -18=>:viscosity, 
+    -17 => :volumetric_flow,
+    -1 => :wavenumber,
     0=>:unitless, 
     1=>:length, 
     2=>:area, 
     3=>:volume, 
     20=>:time, 
     400=>:temperature, 
+    7941 => :yank,
     7942=>:power, 
     7959=>:pressure, 
     7962=>:energy, 
     7979=>:viscosity, 
     7961=>:force, 
-    7997=>:mass_concentration,
+    7981 => :momentum,
+    7982 => :angular_momentum,
+    7997 => :density,
+    7998 => :area_density,
     8000=>:mass, 
     159999=>:magnetism, 
     160000=>:current, 
     160020=>:charge, 
-    312058=>:resistance, 
+    312058=>:resistance,
+    312078=>:capacitance,
     3199980=>:activity, 
     3199997=>:molar_concentration, 
     3200000=>:substance, 
@@ -106,8 +117,7 @@ class Unit < Numeric
     1280000000=>:currency, 
     25600000000=>:memory,
     511999999980=>:angular_velocity, 
-    512000000000=>:angle, 
-    10240000000000=>:capacitance, 
+    512000000000=>:angle
     }
   
   @@cached_units = {}
@@ -286,7 +296,7 @@ class Unit < Numeric
   #
   def self.parse(input)
     first, second = input.scan(/(.+)\s(?:in|to|as)\s(.+)/i).first
-    second.nil? ? first.unit : first.unit.to(second)
+    second.nil? ? first.unit : first.unit.convert_to(second)
   end
   
   def to_unit
@@ -320,9 +330,9 @@ class Unit < Numeric
       end
       base = case 
       when self.is_temperature?
-        self.to('tempK')
+        self.convert_to('tempK')
       when self.is_degree?
-        self.to('degK')
+        self.convert_to('degK')
       end
       return base
     end
@@ -380,17 +390,17 @@ class Unit < Numeric
     else
       case target_units
       when :ft
-        inches = self.to("in").scalar.to_int
+        inches = self.convert_to("in").scalar.to_int
         out = "#{(inches / 12).truncate}\'#{(inches % 12).round}\""
       when :lbs
-        ounces = self.to("oz").scalar.to_int
+        ounces = self.convert_to("oz").scalar.to_int
         out = "#{(ounces / 16).truncate} lbs, #{(ounces % 16).round} oz"
       when String
         out = case target_units
         when /(%[\-+\.\w#]+)\s*(.+)*/       #format string like '%0.2f in'
           begin
             if $2 #unit specified, need to convert
-              self.to($2).to_s($1)
+              self.convert_to($2).to_s($1)
             else 
               "#{$1 % @scalar} #{$2 || self.units}".strip
             end
@@ -398,7 +408,7 @@ class Unit < Numeric
             (DateTime.new(0) + self).strftime(target_units)  
           end
         when /(\S+)/ #unit only 'mm' or '1/mm'
-          "#{self.to($1).to_s}"
+          "#{self.convert_to($1).to_s}"
         else
           raise "unhandled case"
         end
@@ -533,9 +543,9 @@ class Unit < Numeric
         raise ArgumentError, "Cannot add two temperatures" if ([self, other].all? {|x| x.is_temperature?})
         if [self, other].any? {|x| x.is_temperature?}
           if self.is_temperature?
-            Unit.new(:scalar => (self.scalar + other.to(self.temperature_scale).scalar), :numerator => @numerator, :denominator=>@denominator, :signature => @signature)
+            Unit.new(:scalar => (self.scalar + other.convert_to(self.temperature_scale).scalar), :numerator => @numerator, :denominator=>@denominator, :signature => @signature)
           else
-            Unit.new(:scalar => (other.scalar + self.to(other.temperature_scale).scalar), :numerator => other.numerator, :denominator=>other.denominator, :signature => other.signature)
+            Unit.new(:scalar => (other.scalar + self.convert_to(other.temperature_scale).scalar), :numerator => other.numerator, :denominator=>other.denominator, :signature => other.signature)
           end
         else
           @q ||= ((@@cached_units[self.units].scalar / @@cached_units[self.units].base_scalar) rescue (self.units.unit.to_base.scalar))
@@ -563,9 +573,9 @@ class Unit < Numeric
         when self =~ other
           case
             when [self, other].all? {|x| x.is_temperature?}
-              Unit.new(:scalar => (self.base_scalar - other.base_scalar), :numerator  => KELVIN, :denominator => UNITY_ARRAY, :signature => @signature).to(self.temperature_scale) 
+              Unit.new(:scalar => (self.base_scalar - other.base_scalar), :numerator  => KELVIN, :denominator => UNITY_ARRAY, :signature => @signature).convert_to(self.temperature_scale) 
             when self.is_temperature?
-              Unit.new(:scalar => (self.base_scalar - other.base_scalar), :numerator  => ['<temp-K>'], :denominator => UNITY_ARRAY, :signature => @signature).to(self) 
+              Unit.new(:scalar => (self.base_scalar - other.base_scalar), :numerator  => ['<tempK>'], :denominator => UNITY_ARRAY, :signature => @signature).convert_to(self) 
             when other.is_temperature?
               raise ArgumentError, "Cannot subtract a temperature from a differential degree unit"
             else
@@ -731,7 +741,7 @@ class Unit < Numeric
   #
   # Note that if temperature is part of a compound unit, the temperature will be treated as a differential
   # and the units will be scaled appropriately.
-  def to(other)
+  def convert_to(other)
     return self if other.nil? 
     return self if TrueClass === other
     return self if FalseClass === other
@@ -778,18 +788,6 @@ class Unit < Numeric
       _numerator2 = target.numerator.map {|x| @@PREFIX_VALUES[x] ? @@PREFIX_VALUES[x] : x}.map {|x| x.kind_of?(Numeric) ? x : @@UNIT_VALUES[x][:scalar] }.compact
       _denominator2 = target.denominator.map {|x| @@PREFIX_VALUES[x] ? @@PREFIX_VALUES[x] : x}.map {|x| x.kind_of?(Numeric) ? x : @@UNIT_VALUES[x][:scalar] }.compact
       
-      # eliminate common terms
-      
-      (_numerator1 & _denominator2).each do |common|
-        _numerator1.delete(common)
-        _denominator2.delete(common)
-      end
-      
-      (_numerator2 & _denominator1).each do |common|
-        _numerator1.delete(common)
-        _denominator2.delete(common)
-      end
-            
       q = @scalar * ( (_numerator1 + _denominator2).inject(1) {|product,n| product*n} ) / 
           ( (_numerator2 + _denominator1).inject(1) {|product,n| product*n} ) 
       
@@ -797,8 +795,8 @@ class Unit < Numeric
       Unit.new(:scalar=>q, :numerator=>target.numerator, :denominator=>target.denominator, :signature => target.signature)
     end
   end  
-  alias :>> :to
-  alias :convert_to :to
+  alias :>> :convert_to
+  alias :to :convert_to
     
   # converts the unit back to a float if it is unitless.  Otherwise raises an exception
   def to_f
@@ -921,11 +919,11 @@ class Unit < Numeric
   # convert a duration to a DateTime.  This will work so long as the duration is the duration from the zero date
   # defined by DateTime
   def to_datetime
-    DateTime.new!(self.to('d').scalar)
+    DateTime.new!(self.convert_to('d').scalar)
   end
   
   def to_date
-    Date.new0(self.to('d').scalar)
+    Date.new0(self.convert_to('d').scalar)
   end
   
    
@@ -941,50 +939,46 @@ class Unit < Numeric
   
   # '5 min'.before(time)
   def before(time_point = ::Time.now)
-    raise ArgumentError, "Must specify a Time" unless time_point
-    if String === time_point
-      time_point.time - self rescue time_point.datetime - self
-    else
+    case time_point
+    when Time, Date, DateTime
       time_point - self rescue time_point.to_datetime - self
+    else
+      raise ArgumentError, "Must specify a Time, Date, or DateTime"
     end
   end
   alias :before_now :before
   
   # 'min'.since(time)
-  def since(time_point = ::Time.now)
+  def since(time_point)
     case time_point
     when Time
-      (Time.now - time_point).unit('s').to(self)
+      (Time.now - time_point).unit('s').convert_to(self)
     when DateTime, Date
-      (DateTime.now - time_point).unit('d').to(self)
-    when String    
-      (DateTime.now - time_point.to_datetime(:context=>:past)).unit('d').to(self)
+      (DateTime.now - time_point).unit('d').convert_to(self)
     else
-      raise ArgumentError, "Must specify a Time, DateTime, or String" 
+      raise ArgumentError, "Must specify a Time, Date, or DateTime" 
     end
   end
   
   # 'min'.until(time)
-  def until(time_point = ::Time.now)
+  def until(time_point)
     case time_point
     when Time
-      (time_point - Time.now).unit('s').to(self)
+      (time_point - Time.now).unit('s').convert_to(self)
     when DateTime, Date
-      (time_point - DateTime.now).unit('d').to(self)
-    when String
-      (time_point.to_datetime(:context=>:future) - DateTime.now).unit('d').to(self)
+      (time_point - DateTime.now).unit('d').convert_to(self)
     else
-      raise ArgumentError, "Must specify a Time, DateTime, or String" 
+      raise ArgumentError, "Must specify a Time, Date, or DateTime" 
     end
   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_point.time + self rescue time_point.datetime + self
-    else
+  def from(time_point)
+    case time_point
+    when Time, DateTime, Date
       time_point + self rescue time_point.to_datetime + self
+    else
+      raise ArgumentError, "Must specify a Time, Date, or DateTime"       
     end
   end
   alias :after :from
@@ -1240,6 +1234,10 @@ class Unit < Numeric
     self
   end 
   
+  def self.base_units
+    @@BASE_UNITS.map {|u| Unit.new(u)}
+  end
+  
   private
 
   # parse a string consisting of a number and a unit string

data/lib/ruby_units/unit_definitions.rb

@@ -81,6 +81,9 @@ UNIT_DEFINITIONS = {
   '<tablespoon>'=>  [%w{tbs tablespoon tablespoons}, 1.47867648e-5, :volume, %w{<meter> <meter> <meter>}],
   '<teaspoon>'=>  [%w{tsp teaspoon teaspoons}, 4.92892161e-6, :volume, %w{<meter> <meter> <meter>}],
 
+  #volumetric flow
+  '<cfm>' => [%w{cfm CFM CFPM}, (18435447/39062500000), :volumetric_flow, %w{<meter> <meter> <meter>}, %w{<second>}],
+
   #speed
   '<kph>' => [%w{kph}, 0.277777778, :speed, %w{<meter>}, %w{<second>}],
   '<mph>' => [%w{mph}, 0.44704, :speed, %w{<meter>}, %w{<second>}],
@@ -89,16 +92,17 @@ UNIT_DEFINITIONS = {
   
   #acceleration
   '<gee>' => [%w{gee}, 9.80655, :acceleration, %w{<meter>}, %w{<second> <second>}],
+  
 
   #temperature_difference
   '<kelvin>' => [%w{degK kelvin}, 1, :temperature, %w{<kelvin>}],
   '<celsius>' => [%w{degC celsius celsius centigrade}, 1, :temperature, %w{<kelvin>}],
   '<fahrenheit>' => [%w{degF fahrenheit}, Rational(1,1.8), :temperature, %w{<kelvin>}],
   '<rankine>' => [%w{degR rankine}, Rational(1,1.8), :temperature, %w{<kelvin>}],
-  '<temp-K>'  => [%w{tempK}, 1, :temperature, %w{<temp-K>}],
-  '<temp-C>'  => [%w{tempC}, 1, :temperature, %w{<temp-K>}],
-  '<temp-F>'  => [%w{tempF}, Rational(1,1.8), :temperature, %w{<temp-K>}],
-  '<temp-R>'  => [%w{tempR}, Rational(1,1.8), :temperature, %w{<temp-K>}],
+  '<tempK>'  => [%w{tempK}, 1, :temperature, %w{<tempK>}],
+  '<tempC>'  => [%w{tempC}, 1, :temperature, %w{<tempK>}],
+  '<tempF>'  => [%w{tempF}, Rational(1,1.8), :temperature, %w{<tempK>}],
+  '<tempR>'  => [%w{tempR}, Rational(1,1.8), :temperature, %w{<tempK>}],
   
   #time
   '<second>'=>  [%w{s sec second seconds}, 1, :time, %w{<second>}],
@@ -139,7 +143,7 @@ UNIT_DEFINITIONS = {
   '<unit>'  =>  [%w{U enzUnit}, 16.667e-16, :activity, %w{<mole>}, %w{<second>}],
 
   #capacitance
-  '<farad>' =>  [%w{F farad Farad}, 1, :capacitance, %w{<farad>}],
+  '<farad>' =>  [%w{F farad Farad}, 1, :capacitance, %w{<second> <second> <second> <second> <ampere> <ampere>}, %w{<kilogram> <meter> <meter>}],
 
   #charge
   '<coulomb>' =>  [%w{C coulomb Coulomb}, 1, :charge, %w{<ampere> <second>}],

data/ruby-units.gemspec

@@ -4,13 +4,13 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{ruby-units}
-  s.version = "1.3.1"
+  s.name = "ruby-units"
+  s.version = "1.3.2.a"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Olbrich, Ph.D."]
-  s.date = %q{2011-06-23}
-  s.description = %q{Provides classes and methods to perform unit math and conversions}
+  s.date = "2011-10-17"
+  s.description = "Provides classes and methods to perform unit math and conversions"
   s.email = ["kevin.olbrich+ruby_units@gmail.com"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "RakeFile",
     "TODO",
     "VERSION",
+    "autotest/discover.rb",
     "lib/ruby-units.rb",
     "lib/ruby_units.rb",
     "lib/ruby_units/array.rb",
@@ -36,6 +37,7 @@ Gem::Specification.new do |s|
     "lib/ruby_units/numeric.rb",
     "lib/ruby_units/object.rb",
     "lib/ruby_units/string.rb",
+    "lib/ruby_units/string/extra.rb",
     "lib/ruby_units/time.rb",
     "lib/ruby_units/unit.rb",
     "lib/ruby_units/unit_definitions.rb",
@@ -47,6 +49,7 @@ Gem::Specification.new do |s|
     "spec/ruby-units/math_spec.rb",
     "spec/ruby-units/numeric_spec.rb",
     "spec/ruby-units/object_spec.rb",
+    "spec/ruby-units/string/extra_spec.rb",
     "spec/ruby-units/string_spec.rb",
     "spec/ruby-units/time_spec.rb",
     "spec/ruby-units/unit_spec.rb",
@@ -54,10 +57,11 @@ Gem::Specification.new do |s|
     "test/test_cache.rb",
     "test/test_ruby-units.rb"
   ]
-  s.homepage = %q{https://github.com/olbrich/ruby-units}
+  s.homepage = "https://github.com/olbrich/ruby-units"
+  s.post_install_message = "====================\nDeprecation Warning\n====================\n\nSeveral convenience methods that ruby-units added to the string class have\nbeen deprecated in this release.  These methods include String#to, String#from, String#ago, String#before and others.\nIf your code relies on these functions, they can be added back by adding this line to your code.\n\nrequire 'ruby-units/string/extras'\n# note that these methods do not play well with Rails, which is one of the reasons they are being removed.\n\nThe extra functions mostly work the same, but will no longer properly handle cases when they are called with strings..\n\n'min'.from(\"4-1-2011\") # => Exception\n\nPass in a Date, Time, or DateTime object to get the expected result.\n\nThey will probably go away completely in an upcoming release, so it would be a good idea to refactor your code\nto avoid using them.  They will also throw deprecation warnings when they are used.\n"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
-  s.summary = %q{A class that performs unit conversions and unit math}
+  s.rubygems_version = "1.8.10"
+  s.summary = "A class that performs unit conversions and unit math"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -67,17 +71,26 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_development_dependency(%q<autotest>, [">= 0"])
+      s.add_development_dependency(%q<autotest-growl>, [">= 0"])
+      s.add_development_dependency(%q<autotest-fsevent>, [">= 0"])
     else
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.5"])
+      s.add_dependency(%q<autotest>, [">= 0"])
+      s.add_dependency(%q<autotest-growl>, [">= 0"])
+      s.add_dependency(%q<autotest-fsevent>, [">= 0"])
     end
   else
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.5"])
+    s.add_dependency(%q<autotest>, [">= 0"])
+    s.add_dependency(%q<autotest-growl>, [">= 0"])
+    s.add_dependency(%q<autotest-fsevent>, [">= 0"])
   end
 end
 

data/spec/ruby-units/string/extra_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../../../lib/ruby_units/string/extra'
+describe String do
+  context "Time syntax sugar" do
+    before(:each) do
+      Time.stub(:now).and_return(Time.at(1303656390))
+      Date.stub(:today).and_return(Date.new(2011,4,1))
+      DateTime.stub(:now).and_return(DateTime.new(2011,4,1,0,0,0))
+    end
+
+    specify { "5 min".ago.should be_instance_of Time }
+  
+    specify { "5 min".from(Time.now).should be_instance_of Time }
+    specify { "5 min".from_now.should be_instance_of Time }
+  
+    specify { "5 min".after(Time.parse('12:00')).should be_instance_of Time }
+  
+    specify { "5 min".before.should be_instance_of Time}
+    specify { "5 min".before(Time.now).should be_instance_of Time}
+    specify { "5 min".before_now.should be_instance_of Time}
+    specify { "5 min".before(Time.parse('12:00')).should be_instance_of Time}
+  
+    specify { "min".since.should be_instance_of Unit}
+    specify { "min".since(Time.parse("12:00")).should be_instance_of Unit}
+    specify { "min".since(Time.now - 60).should == Unit("1 min")}
+    specify { "days".since(Date.today - 3).should == Unit("3 d")}
+    specify { expect {"days".since(1000) }.to raise_error(ArgumentError, "Must specify a Time, Date, or DateTime")}
+          
+    specify { "min".until.should be_instance_of Unit}
+    specify { "min".until(Time.parse("12:00")).should be_instance_of Unit}
+    specify { "min".until(Time.now + 60).should == Unit("1 min")}
+    specify { "days".until(Date.today + 3).should == Unit("3 d")}
+    specify { expect {"days".until(1000) }.to raise_error(ArgumentError, "Must specify a Time, Date, or DateTime")}
+  
+    specify { "today".to_date.should be_instance_of Date }
+    specify { "2011-4-1".to_date.should be_instance_of Date }
+  
+    specify { "now".to_datetime.should be_instance_of DateTime }
+    specify { "now".to_time.should be_instance_of Time }
+  
+    specify { "10001-01-01 12:00".to_time.should be_instance_of Time }
+    specify { "2001-01-01 12:00".to_time.should be_instance_of Time }
+  
+  end
+end