ruby-units-brewpoo 1.3.0

data/CHANGELOG.txt

@@ -0,0 +1,204 @@
+Change Log for Ruby-units
+=========================
+2010-03-16  1.1.5   * another bugfix, and update url to point to github
+2010-03-15  1.1.4   * fixed a couple of outstanding bugs
+2007-12-13  1.1.3   * fixed a minor bug with string %
+2007-12-12  1.1.2   * fixed a bug with format strings
+                    * detect if ruby 1.8.6 is installed and use its' to_date function
+                    
+2007-07-14  1.1.1   * fixed bug that would prevent creating '<pound-mass>' units, which
+                      prevented rounding from working
+                    * tests do not fail if Uncertain gem is not installed, you just get an
+                      annoying warning message
+                      
+2007-01-28  1.1.0   * completely revamped the temperature handling system (see README)
+                    * fixed some spelling errors in some units
+                    * fixed to_datetime and to_date to convert durations to datetimes and dates'
+
+2007-01-24  1.0.2   * Minor changes in the way powers are calculated to support Uncertain 
+                      numbers better.
+                    * Fixed parsing bug with Uncertain Numbers
+                    * added resolution / typography units (pixels, points, pica)
+                      Note that 'pt' means 'pints' and not 'points'
+                    * added some pressure units ('inHg' & 'inH2O')
+                    * changed default abbreviation of 'knots' to 'kt'
+                    * Changed directory layout
+                    * fixed a minor bug with Time.to_date so comparisons work properly
+
+2007-01-17  1.0.1   * Force units are now defined correctly.
+
+2007-01-12  1.0.0   * Improved handling of complex numbers.  Now you can specify
+                      '1+1i mm'.unit to get a complex unit.
+                    * Taking the root of a negative unit will give you a complex unit
+                    * fixed unary minus to work again
+                    * Math.hypot now takes units.  Both parameters must be the compatible 
+                      units or it will assert.  Units will be converted to a common base 
+                      before use.
+                    * Can now specify units in rational numbers, i.e., '1/4 cup'.unit  
+                    * Seems like a good time to move to 1.0 status
+                    
+2006-12-15  0.3.9   * forgot to increment the version in the gem file..ooops.
+
+2006-12-15  0.3.8   * Any object that supports a 'to_unit' method will now be 
+                      automatically coerced to a unit during math operations.
+                      
+2006-12-14  0.3.7   * improved handling of percents and added a 'wt%' unit
+                      equivalent to 1 g/dl.
+                    * Improved handling for units with non-alphanumeric names
+                      (like ' for feet, # for pound)
+                    * Now you can enter durations as "HH:MM:SS, usec" or
+                      "HH:MM:SS:usec"
+
+2006-12-05  0.3.6   * Fixed bug where (unit/unit).ceil would fail
+
+2006-11-20  0.3.5   * Minor bug fixes
+                    * to_int now coerces the result to an actual Integer,
+                      but only works properly for unitless Units.
+
+2006-10-27  0.3.4   * Fixed a few more parsing bugs so that it will properly        
+                      complain about malformed units.
+                    * Fixed a bug that prevents proper use of percents
+                    * several minor tweaks 
+                    * some improved Date and DateTime handling
+                    * can convert between Date, DateTime, and Time objects
+                    * Time math will now return a DateTime if it goes out of
+                      range.
+
+2006-10-03  0.3.3   * Apparently I can't do math late at night.  
+                      Fixed a bug that would cause problems when adding
+                      or subtracting units to a unit with a zero scalar. 
+                    * Date and DateTime objects can be converted to 'units'
+
+2006-10-03  0.3.2   * More minor bug fixes 
+                      (now fixes a minor name collision with rails)
+
+2006-10-02  0.3.1   * minor bug fixes
+
+2006-10-02  0.3.0   * Performance enhanced by caching results of many
+                      functions (Thanks to Kurt Stephens for pushing this.)
+                    * Throws an exception if the unit is not recognized
+                    * units can now identify what 'kind' they are 
+                      (:length, :mass, etc..)
+                    * New constructors:  
+                      Unit(1,"mm") 
+                      Unit(1,"mm/s")
+                      Unit(1,"mm","s")
+
+2006-09-22  0.2.3   * added support for date/time parsing with the Chronic gem
+                      parsing will use Chronic if it is loaded
+                    * allows Date / Time / DateTime conversions
+                    * better test coverage
+                    * The 'string'.to_time returns a Time object
+                    * 'string'.to_datetime returns a DateTime object
+                    * 'string'.time returns a Time object or a DateTime if the
+                      Time object fails
+                    * 'string'.datetime returns a DateTime or a Time if the
+                      DateTime fails                    
+                      
+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
+                      
+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
+
+2006-09-17          * can now use the '%' format specifier like 
+                      '%0.2f' % '1 mm'.unit #=> '1.00 mm'
+                    * works nicely with time now.
+                      '1 week'.unit + Time.now => 1.159e+09 s
+                      Time.at('1.159e+09 s'.unit) 
+                        => Sat Sep 23 04:26:40 EDT 2006
+                      "1.159e9 s".unit.time 
+                        => 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-08-28  0.2.0   * Added 'ruby_unit.rb' file so that requires will still
+                      work if the wrong name is used
+                    * Added 'to' as an alias to '>>' so conversions can be
+                      done as '1 m'.unit.to('1 cm')
+                    * Added ability to convert temperatures to absolute values
+                      using the following syntax:
+                        '37 degC'.unit.to('tempF')  #=> '98.6 degF'.unit
+                    * Tweaked abbreviations a bit.  'ton' is now 'tn' instead
+                      of 't'.  It was causing parse collisions with 'atm'.
+                    * fixed a bug in term elimination routine
+                    * fixed a bug in parsing of powers, and added support for
+                      'm**2' format
+                    * Added support for taking roots of units.  Just
+                      exponentiate with a fraction (0.5, 1.0/3, 0.25)
+                    * renamed 'quantity' to 'scalar'
+                    * any type of Numeric can be used to initialize a Unit,
+                      although this can't really be done with a string
+                    * Units can not be forced to a float using to_f unless
+                      they are unitless.  This prevents some math functions
+                      from forcing the conversion.  To get the scalar, just
+                      use 'unit.scalar'
+                    * 'inspect' returns string representation
+                    * better edge-case detection with math functions.  
+                      "0 mm".unit**-1 now throws a ZeroDivisionError exception
+                    * Ranges can make a series of units, so long as the end 
+                      points have integer scalars.
+                    * Fixed a parsing bug with feet/pounds and scientific
+                      numbers
+                    
+2006-08-22  0.1.1   * Added new format option "1 mm".to_unit("in") now
+                      converts the result to the indicated units
+                    * Fixed some naming issues so that the gem name matches
+                      the require name.
+                    * Added CHANGELOG
+                    * Improved test coverage (100% code coverage via RCov)
+                    * fixed a bug that prevented units with a prefix in the
+                      denominator from converting properly
+                    * can use .unit method on a string to create a new unit
+                      object
+                    * can now coerce or define units from arrays, strings,
+                      numerics.
+                        "1 mm".unit + [1, 'mm'] === "2 mm".unit
+                        [1,'mm','s'].unit === "1 mm/s".unit
+                        2.5.unit === "2.5".unit
+                    * Added instructions on how to add custom units
+                      
+2006-08-22  0.1.0   * Initial Release
+
+
+
+
+
+
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2007 Kevin C. Olbrich
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,19 @@
+CHANGELOG.txt
+Manifest.txt
+README.md
+LICENSE.txt
+Rakefile
+lib/ruby-units.rb
+lib/ruby_units.rb
+lib/ruby_units/units.rb
+lib/ruby_units/math.rb
+lib/ruby_units/date.rb
+lib/ruby_units/time.rb
+lib/ruby_units/string.rb
+lib/ruby_units/array.rb
+lib/ruby_units/numeric.rb
+lib/ruby_units/object.rb
+lib/ruby_units/array.rb
+lib/ruby_units/complex.rb
+lib/ruby_units/ruby-units.rb
+test/test_ruby-units.rb

data/README.md

@@ -0,0 +1,160 @@
+# Ruby Units
+
+Kevin C. Olbrich, Ph.D. 
+
+[Sciwerks.com](http://www.sciwerks.com)
+
+Project page: [http://github.com/olbrich/ruby-units](http://github.com/olbrich/ruby-units)
+
+Forked by [brewpoo] to add additional unit support
+
+## 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
+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:
+This package may be installed using:  `gem install ruby-units`
+  
+## 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
+    unit = Unit.new("1 mm/s")        # a compound unit
+    unit = Unit.new("1 mm s^-1")     # in exponent notation
+    unit = Unit.new("1 kg*m^2/s^2")  # complex unit
+    unit = Unit.new("1 kg m^2 s^-2") # complex unit
+    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
+    unit = '1/4 cup'.unit            # Rational number 
+    unit = '1+1i mm'.unit            # Complex Number
+
+## 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:
+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#+()      # Add. only works if units are compatible
+    Unit#-()      # Subtract. only works if units are compatible
+    Unit#*()      # Multiply.  
+    Unit#/()      # Divide.
+    Unit#**()     # Exponentiate.  Exponent must be an integer, can be positive,  negative, or zero                        
+    Unit#inverse  # Returns 1/unit
+    Unit#abs      # Returns absolute value of the unit quantity.  Strips off the  units
+    Unit#ceil     # rounds quantity to next highest integer
+    Unit#floor    # rounds quantity down to next lower integer
+    Unit#round    # rounds quantity to nearest integer
+    Unit#to_int   # returns the quantity as an integer
+ 
+Unit will coerce other objects into a Unit if used in a formula.  This means that ..
+ 
+    Unit("1 mm") + "2 mm"  == Unit("3 mm")
+ 
+This will work as expected so long as you start the formula with a Unit object. 
+
+## Conversions & comparisons
+Units can be converted to other units in a couple of ways.
+
+    unit1 = unit >> "ft"   # convert to 'feet'
+    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 <=>
+    unit.to('ft')          # convert
+    unit1 + unit2 >> "ft"  # converts result of math to 'ft'
+    (unit1 + unit2).to('ft') # converts result to 'ft'
+ 
+Any object that defines a 'to_unit' method will be automatically coerced to a unit during calculations.
+ 
+## 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"
+ 
+The to_s also accepts some options.
+
+    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".unit 
+
+Several helpers have also been defined.
+Note: If you include the 'Chronic' gem, you can specify times in natural
+      language.
+
+      '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
+
+Durations may be entered as 'HH:MM:SS, usec' and will be returned in 'hours'.
+
+    '1:00'.unit #=> 1 h
+    '0:30'.unit #=> 0.5 h
+    '0:30:30'.unit #=> 0.5 h + 30 sec
+
+If only one ":" is present, it is interpreted as the separator between hours and minutes.
+
+## 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, hypot...) can take a unit as their parameter.  It will be converted to radians and then used if possible.
+
+## Temperatures
+Ruby-units makes a distinction between a temperature (which technically is a property) and degrees of temperature (which temperatures are measured in).
+
+Temperature units (i.e., 'tempK') can be converted back and forth, and will take into account the differences in the zero points of the various scales. Differential temperature (e.g., '100 degC'.unit) units behave like most other units.
+
+    '37 tempC'.unit >> 'tempF' #=> 98.6 tempF
+
+Ruby-units will raise an exception if you attempt to create a temperature unit that would fall below absolute zero.
+
+Unit math on temperatures is fairly limited.  
+
+    '100 tempC'.unit + '10 degC'.unit   # '110 tempC'.unit
+    '100 tempC'.unit - '10 degC'.unit   # '90 tempC'.unit
+    '100 tempC'.unit + '50 tempC'.unit  # exception  
+    '100 tempC'.unit - '50 tempC'.unit  # '50 degC'.unit
+    '50 tempC'.unit - '100 tempC'.unit  # '-50 degC'.unit
+    '100 tempC'.unit * [scalar]         # '100*scalar tempC'.unit
+    '100 tempC'.unit / [scalar]         # '100/scalar tempC'.unit
+    '100 tempC'.unit * [unit]           # exception
+    '100 tempC'.unit / [unit]           # exception
+    '100 tempC'.unit ** N               # exception
+
+    '100 tempC'.unit >> 'degC'          #=> '100 degC'.unit   
+This conversion references the 0 point on the scale of the temperature unit 
+
+    '100 degC'.unit >> 'tempC'          #=> '-173 tempC'.unit
+These conversions are always interpreted as being relative to absolute zero.
+Conversions are probably better done like this...
+    
+    '0 tempC'.unit + '100 degC'.unit #=> '100 tempC'.unit
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :yard
+
+require './lib/ruby_units/units'
+require './lib/ruby_units/ruby-units'
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = FileList['test/test*.rb']
+    #t.verbose = true     # uncomment to see the executed command
+  end
+rescue
+end
+
+Hoe.spec('ruby-units') do |p|
+  p.yard_title = "Ruby-Units"
+  p.yard_markup = "markdown"
+  p.version = Unit::VERSION
+  p.rubyforge_name = 'ruby-units'
+  p.summary = %q{A class that performs unit conversions and unit math}
+  p.email = 'kevin.olbrich+ruby_units@gmail.com'
+  p.url = 'http://github.com/olbrich/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

data/lib/ruby-units.rb

@@ -0,0 +1,11 @@
+require 'ruby_units/array'
+require 'ruby_units/date'
+require 'ruby_units/time'
+require 'ruby_units/math'
+require 'ruby_units/complex'
+require 'ruby_units/numeric'
+require 'ruby_units/object'
+require 'ruby_units/string'
+require 'ruby_units/units'
+require 'ruby_units/ruby-units'
+