ruby-units 1.1.3 → 1.1.4

data/README.txt

@@ -1,4 +1,4 @@
-=Ruby Units
+= Ruby Units
 
 Kevin C. Olbrich, Ph.D. 
 
@@ -8,21 +8,21 @@ http://www.sciwerks.com
 
 Project page: http://ruby-units.rubyforge.org/ruby-units
 
-==Introduction
+== Introduction
 Many technical applications make use of specialized calculations at some point.  
 Frequently, these calculations require unit conversions to ensure accurate results.  
 Needless to say, this is a pain to properly keep track of, and is prone to numerous errors.
   
-==Solution
+== Solution
 The 'Ruby units' gem is designed so simplify the handling of units for scientific calculations. 
 The units of each quantity are specified when a Unit object is created and the Unit class will 
 handle all subsequent conversions and manipulations to ensure an accurate result.
   
-==Installation:
+== Installation:
 This package may be installed using:
  gem install ruby-units
   
-==Usage:
+== Usage:
  unit = Unit.new("1")             # constant only
  unit = Unit.new("mm")            # unit only (defaults to a value of 1)
  unit = Unit.new("1 mm")          # create a simple unit
@@ -40,17 +40,17 @@ This package may be installed using:
  unit = '1/4 cup'.unit            # Rational number 
  unit = '1+1i mm'.unit            # Complex Number
 
-==Rules:  
+== Rules:  
 1. only 1 quantity per unit (with 2 exceptions... 6'5" and '8 lbs 8 oz')
 2. use SI notation when possible
 3. avoid using spaces in unit names
 
-==Unit compatability:
+== Unit compatability:
 Many methods require that the units of two operands are compatible.  Compatible units are those that can be easily converted into each other, such as 'meters' and 'feet'.
 
  unit1 =~ unit2   #=> true if units are compatible
 
-==Unit Math:
+== Unit Math:
 
 <b>Method</b>::  <b>Comment</b>
  Unit#+()::       Add. only works if units are compatible
@@ -71,7 +71,7 @@ Unit will coerce other objects into a Unit if used in a formula.  This means tha
  
 This will work as expected so long as you start the formula with a Unit object. 
 
-==Conversions & comparisons
+== Conversions & comparisons
 
 Units can be converted to other units in a couple of ways.
 
@@ -89,7 +89,7 @@ Units can be converted to other units in a couple of ways.
  
 Any object that defines a 'to_unit' method will be automatically coerced to a unit during calculations.
  
-==Text Output
+== Text Output
 Units will display themselves nicely based on the preferred abbreviation for the units and prefixes.
 Since Unit implements a Unit#to_s, all that is needed in most cases is:
  "#{Unit.new('1 mm')}"  #=> "1 mm"
@@ -102,7 +102,7 @@ The to_s also accepts some options.
  U("100 kg").to_s(:lbs)     #=> returns 220 lbs, 7 oz
  
  
-==Time Helpers
+== Time Helpers
 
 Time, Date, and DateTime objects can have time units added or subtracted.
 
@@ -129,16 +129,16 @@ Durations may be entered as 'HH:MM:SS, usec' and will be returned in 'hours'.
 
 If only one ":" is present, it is interpreted as the separator between hours and minutes.
 
-==Ranges
+== Ranges
 
  [U('0 h')..U('10 h')].each {|x| p x}
 works so long as the starting point has an integer scalar
 
-==Math functions
+== Math functions
 All Trig math functions (sin, cos, sinh, hypot...) can take a unit as their parameter.  
 It will be converted to radians and then used if possible.
 
-==Temperatures
+== Temperatures
 Ruby-units makes a distinction between a temperature (which technically is a property) and 
 degrees of temperature (which temperatures are measured in).
 

data/Rakefile

@@ -12,14 +12,13 @@ begin
 rescue
 end
 
-Hoe.new('ruby-units', Unit::VERSION) do |p|
+Hoe.spec('ruby-units') do |p|
+  p.version = Unit::VERSION
   p.rubyforge_name = 'ruby-units'
-  p.summary = %q{A model that performs unit conversions and unit math}
+  p.summary = %q{A class that performs unit conversions and unit math}
   p.email = 'kevin.olbrich+ruby_units@gmail.com'
   p.url = 'http://rubyforge.org/projects/ruby-units'
   p.description = "This library handles unit conversions and unit math"
   p.changes = p.paragraphs_of('CHANGELOG.txt', 0..1).join("\n\n")
   p.author = 'Kevin Olbrich, Ph.D'
-end
-
-# vim: syntax=Ruby
+end

data/lib/ruby_units/ruby-units.rb

@@ -33,14 +33,14 @@ require 'parsedate'
 # To add / override a unit definition, add a code block like this..
 #
 #  class Unit < Numeric
-#   UNIT_DEFINITIONS = {
+#   @@USER_DEFINITIONS = {
 #    <name>'  => [%w{prefered_name synonyms}, conversion_to_base, :classification, %w{<base> <units> <in> <numerator>} , %w{<base> <units> <in> <denominator>} ]
 #    }
 #  end
 #  Unit.setup
 class Unit < Numeric
   # pre-generate hashes from unit definitions for performance.  
-  VERSION = '1.1.3'
+  VERSION = '1.1.4'
   @@USER_DEFINITIONS = {}
   @@PREFIX_VALUES = {}
   @@PREFIX_MAP = {}
@@ -90,7 +90,7 @@ class Unit < Numeric
     7959=>:pressure, 
     7962=>:energy, 
     7979=>:viscosity, 
-    7981=>:force, 
+    7961=>:force, 
     7997=>:mass_concentration,
     8000=>:mass, 
     159999=>:magnetism, 
@@ -159,7 +159,6 @@ class Unit < Numeric
     @is_base = from.is_base?
     @signature = from.signature
     @base_scalar = from.base_scalar
-    @output = from.output rescue nil
     @unit_name = from.unit_name rescue nil
   end
   
@@ -192,7 +191,7 @@ class Unit < Numeric
     @base_scalar = nil
     @unit_name = nil
     @signature = nil
-    @output = nil
+    @output = {}
     if options.size == 2
       begin
         cached = @@cached_units[options[1]] * options[0] 
@@ -232,8 +231,10 @@ class Unit < Numeric
       @scalar = options[0].ajd
       @numerator = ['<day>']
       @denominator = UNITY_ARRAY
-    when "": raise ArgumentError, "No Unit Specified"
-    when String: parse(options[0])   
+    when "": 
+      raise ArgumentError, "No Unit Specified"
+    when String: 
+      parse(options[0])   
     else
       raise ArgumentError, "Invalid Unit Format"
     end
@@ -263,6 +264,7 @@ class Unit < Numeric
   def self.clear_cache
     @@cached_units = {}
     @@base_unit_cache = {}
+    Unit.new(1)
   end
     
   def self.base_unit_cache
@@ -349,23 +351,33 @@ class Unit < Numeric
   # output is cached so subsequent calls for the same format will be fast
   #
   def to_s(target_units=nil)
-    out = @output[target_units] rescue nil
+    out = @output[target_units]
     if out
       return out
     else
       case target_units
-      when :ft:
+      when :ft :
         inches = self.to("in").scalar.to_int
         out = "#{(inches / 12).truncate}\'#{(inches % 12).round}\""
-      when :lbs:
+      when :lbs :
         ounces = self.to("oz").scalar.to_int
         out = "#{(ounces / 16).truncate} lbs, #{(ounces % 16).round} oz"
       when String
-        begin #first try a standard format string
-          target_units =~ /(%[\w\d#+-.]*)*\s*(.+)*/
-          out = $2 ? self.to($2).to_s($1) : "#{($1 || '%g') % @scalar || 0} #{self.units}".strip
-        rescue #if that is malformed, try a time string
-          out = (Time.gm(0) + self).strftime(target_units)
+        out = case target_units
+        when /(%[-+\.\w\d#]+)\s*(.+)*/       #format string like '%0.2f in'
+          begin
+            if $2 #unit specified, need to convert
+              self.to($2).to_s($1)
+            else 
+              "#{$1 % @scalar} #{$2 || self.units}".strip
+            end
+          rescue
+            (Time.gm(0) + self).strftime(target_units)  
+          end
+        when /(\S+)/       #unit only 'mm' or '1/mm'
+          "#{self.to($1).to_s}"
+        else       #strftotime?
+          raise "unhandled case"
         end
       else
         out = case @scalar
@@ -375,7 +387,7 @@ class Unit < Numeric
           "#{'%g' % @scalar} #{self.units}"
         end.strip
       end
-      @output = {target_units => out}
+      @output[target_units] = out
       return out
     end    
   end
@@ -785,7 +797,7 @@ 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.new0(self.to('d').scalar)
+    DateTime.new!(self.to('d').scalar)
   end
   
   def to_date
@@ -1065,8 +1077,7 @@ class Unit < Numeric
     end
     
     raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") if unit_string.count('/') > 1
-    raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") if unit_string.scan(/\s\d+\S*/).size > 0
-    
+    raise( ArgumentError, "'#{passed_unit_string}' Unit not recognized") if unit_string.scan(/\s[02-9]/).size > 0
     @scalar, top, bottom = unit_string.scan(UNIT_STRING_REGEX)[0]  #parse the string into parts
     
     top.scan(TOP_REGEX).each do |item|

data/test/test_ruby-units.rb

@@ -90,7 +90,7 @@ class TestRubyUnits < Test::Unit::TestCase
     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_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")
     assert_in_delta Time.now, "now".time, 1
@@ -114,8 +114,8 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_equal Unit.new(Time.now).scalar,  1143910800
     assert_equal @april_fools.unit.to_time, @april_fools
     assert_equal Time.in('1 day'), @april_fools + 86400
-    assert_equal @april_fools_datetime.inspect, "2006-04-01T12:00:00Z"
-    assert_equal '2453826.5 days'.unit.to_datetime.to_s, "2006-04-01T00:00:00Z"
+    assert_equal "2006-04-01T12:00:00+00:00", @april_fools_datetime.inspect
+    assert_equal "2006-04-01T00:00:00+00:00", '2453826.5 days'.unit.to_datetime.to_s 
   end
   
   def test_string_helpers
@@ -273,12 +273,12 @@ class TestRubyUnits < Test::Unit::TestCase
     c = '1 in'.unit
     d = '1 ml'.unit
     
-    assert_equal (a+b), b
-    assert_equal (a+b).units, b.units
-    assert_equal (b+a), b
-    assert_equal (b+a).units, b.units
-    assert_in_delta (b+c).scalar, 12.54, 0.01
-    assert_equal (b+c).units, 'cm'
+    assert_equal((a+b), b)
+    assert_equal((a+b).units, b.units)
+    assert_equal((b+a), b)
+    assert_equal((b+a).units, b.units)
+    assert_in_delta((b+c).scalar, 12.54, 0.01)
+    assert_equal((b+c).units, 'cm')
     assert_raises(ArgumentError) {
       b + d
     }
@@ -290,12 +290,12 @@ class TestRubyUnits < Test::Unit::TestCase
     c = '1 in'.unit
     d = '1 ml'.unit
     
-    assert_equal (a-b), -b
-    assert_equal (a-b).units, b.units
-    assert_equal (b-a), b
-    assert_equal (b-a).units, b.units
-    assert_in_delta (b-c).scalar, 7.46, 0.01
-    assert_equal (b-c).units, 'cm'
+    assert_equal((a-b), -b)
+    assert_equal((a-b).units, b.units)
+    assert_equal((b-a), b)
+    assert_equal((b-a).units, b.units)
+    assert_in_delta((b-c).scalar, 7.46, 0.01)
+    assert_equal((b-c).units, 'cm')
     assert_raises(ArgumentError) {
       b - d
     }
@@ -482,7 +482,7 @@ class TestRubyUnits < Test::Unit::TestCase
     unit1 = Unit.new("1 m")
     unit2 = Unit.new("1 1/m")
     assert_equal unit2, unit1.inverse
-    assert_raises (ZeroDivisionError) { 0.unit.inverse }
+    assert_raises((ZeroDivisionError)) { 0.unit.inverse }
   end
   
   def test_exponentiate_positive
@@ -527,14 +527,14 @@ class TestRubyUnits < Test::Unit::TestCase
     unit1 = Unit.new("1.1 mm")
     unit2 = Unit.new("2 mm")
     assert_equal unit2, unit1.ceil
-    assert_equal ('1 mm'.unit / '1 mm'.unit).ceil, 1
+    assert_equal(('1 mm'.unit / '1 mm'.unit).ceil, 1)
   end
   
   def test_floor
     unit1 = Unit.new("1.1 mm")
     unit2 = Unit.new("1 mm")
     assert_equal unit2, unit1.floor
-    assert_equal ('1 mm'.unit / '1 mm'.unit).floor, 1
+    assert_equal(('1 mm'.unit / '1 mm'.unit).floor, 1)
   end
   
   def test_to_int
@@ -546,14 +546,14 @@ class TestRubyUnits < Test::Unit::TestCase
     unit1 = Unit.new("1.1 mm")
     unit2 = Unit.new("1 mm")
     assert_equal unit2, unit1.truncate
-    assert_equal (unit1/unit2).truncate, 1
+    assert_equal((unit1/unit2).truncate, 1)
   end
   
   def test_round
     unit1 = Unit.new("1.1 mm")
     unit2 = Unit.new("1 mm")
     assert_equal unit2, unit1.round
-    assert_equal (unit1/unit2).round, 1
+    assert_equal((unit1/unit2).round, 1)
   end
   
   def test_zero?
@@ -601,7 +601,7 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_equal a+b, '118 tempF'.unit
     assert_equal b+a, '118 tempF'.unit
     assert_equal a-b, '82 tempF'.unit
-    assert_in_delta (a-c).scalar, '50 degF'.unit.scalar, 0.01
+    assert_in_delta((a-c).scalar, '50 degF'.unit.scalar, 0.01)
     assert_equal b+d, '20 degC'.unit
     
     assert_raises(ArgumentError) { a * b }
@@ -661,7 +661,8 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_equal "1 kg*m/s", unit6.to_s
     unit7= Unit.new("1 1/m")
     assert_equal "1 1/m", unit7.to_s
-    
+    assert_equal("1.5 mm", Unit.new("1.5 mm").to_s)
+    assert_equal("1.5 mm", "#{Unit.new('1.5 mm')}")
   end
   
   def test_to_feet_inches
@@ -791,6 +792,7 @@ class TestRubyUnits < Test::Unit::TestCase
   end
   
   def test_parse
+    assert_nothing_raised { "1 1/m".unit }
     assert_raises(ArgumentError) { "3 s/s/ft".unit }
     assert_raises(ArgumentError) { "3 s**2|,s**2".unit }
     assert_raises(ArgumentError) { "3 s**2 4s s**2".unit }
@@ -833,7 +835,7 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_equal "1:30:30,200".unit, "1.5 hour".unit + '30 sec'.unit + '200 usec'.unit
   end
   
-  def test_coercion
+  def test_coercion_2
     a = Dummy.new
     b = '1 mm'.unit
     assert_equal '2 mm'.unit, b + a
@@ -861,13 +863,13 @@ class TestRubyUnits < Test::Unit::TestCase
   def test_complex
     assert_equal '1+1i mm'.unit.scalar, Complex(1,1)
     assert_equal '1+1i'.unit.scalar, Complex(1,1)
-    assert_raises (RuntimeError) { '1+1i mm'.unit.to_c}
+    assert_raises(RuntimeError) { '1+1i mm'.unit.to_c}
   end
 
   def test_atan2
     assert_equal Math.atan2('1 mm'.unit,'1 mm'.unit), Math.atan2(1,1)
-    assert_raises (ArgumentError) {Math.atan2('1 mm'.unit, '1 lb'.unit)}
-    assert_raises (ArgumentError) {Math.atan2('1 mm'.unit, 1)}
+    assert_raises(ArgumentError) {Math.atan2('1 mm'.unit, '1 lb'.unit)}
+    assert_raises(ArgumentError) {Math.atan2('1 mm'.unit, 1)}
   end
 
   def test_rational_units
@@ -898,6 +900,19 @@ class TestRubyUnits < Test::Unit::TestCase
     assert_nothing_raised {"" % nil}
     assert_nothing_raised {"" % false}
   end
+  
+  def test_to_s_cache
+    Unit.clear_cache
+    a = Unit.new('1 mm')
+    a.to_s                # cache the conversion to itself
+    b = Unit.new('2 mm')
+    assert_equal('2 mm', b.to_s)
+    assert_equal('0.001 m', a.to_s('m'))
+    assert_equal('0.001 m', a.output['m'])
+  end
     
+  def test_version
+    assert_equal('1.1.4', Unit::VERSION)
+  end
 end
 

metadata

@@ -1,33 +1,75 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: ruby-units
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
-date: 2007-12-13 00:00:00 -05:00
-summary: A model that performs unit conversions and unit math
-require_paths: 
-- lib
-email: kevin.olbrich+ruby_units@gmail.com
-homepage: http://rubyforge.org/projects/ruby-units
-rubyforge_project: ruby-units
-description: This library handles unit conversions and unit math
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 4
+  version: 1.1.4
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Kevin Olbrich, Ph.D
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-13 23:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id003
+description: This library handles unit conversions and unit math
+email: kevin.olbrich+ruby_units@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.txt
+- Manifest.txt
+- README.txt
+- LICENSE.txt
 files: 
 - CHANGELOG.txt
 - Manifest.txt
@@ -47,29 +89,36 @@ files:
 - lib/ruby_units/complex.rb
 - lib/ruby_units/ruby-units.rb
 - test/test_ruby-units.rb
-test_files: 
-- test/test_ruby-units.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/ruby-units
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- CHANGELOG.txt
-- Manifest.txt
-- README.txt
-- LICENSE.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: 
+rubyforge_project: ruby-units
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A class that performs unit conversions and unit math
+test_files: 
+- test/test_ruby-units.rb