units-system 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,18 +1,39 @@
 = Ruby Units-System
 
-Units of measure conversions for Ruby 1.9, using Ruby objects and Ruby syntax rather than text strings.
+Units of measure conversions for Ruby, using Ruby objects and Ruby syntax rather than text strings.
 
 There are a number of Ruby units libraries, but I don't think they take this approach (I haven't
 done much research, though.)
 
-Currently Ruby 1.9 is required because we use the feature that
-a +module.clas_eval{...}+ block can reference module's contants without qualification.
-To make this apt for Ruby 1.8 we should replace expressions such as +u{W}+ by either
-+u{W()}+, +u{self.W}+ (method invocation) or +u{self::W}+ (qualified constant).
+There's a couple of caveats for using this module from Ruby 1.8:
+* To use unit names that start with uppercase letters, the UseBlocks module must be included in the scope
+  (either global scope or a module or class definitions) where the expressions are goign to be used.
+  Alternatively, expressions such as <tt>u{W}</tt> could be replaced by either
+  <tt>u{W()}</tt>, <tt>u{self.W}</tt> (method invocation) or <tt>u{self::W}</tt> (qualified constant).
+* UTF-8 characters are liberally used in identifiers, so the code must be executed with the <tt>-Ku</tt> 
+  option (or setting <tt>$KCODE='UTF8'</tt> before requiring this library.)
+  
+= Usage examples
+  
+== Ruby 1.9
+  
+For use with Ruby 1.9, this gem can be used simply by requiring:
+
+  require 'units-system'
+    
+== Ruby 1.8
 
-Also, note that UTF-8 characters are liberally used in identifiers.
+This library has been designed for Ruby 1.9; when using it under older versions of Ruby there's
+a couple of precautions to be taken to use it (which can be used with Ruby 1.9 too):
+  
+    $KCODE = 'UTF8'           # avoid errors when parsing the required library under Ruby 1.8
+    require 'units-system'
+    include Units::UseBlocks  # allow access to capitalized unit names from units/u blocks
 
-= Usage examples
+Depending on you installation you may have to "require 'rubygems' first.
+
+The following examples use UTF-8 code; so they can should be used with a "encoding: utf-8" comment at the
+top of the file for Ruby 1.9, and/or with the ruby command line "-Ku" option for Ruby 1.8.
 
 To work with units a +units+ block can be used. Beware: in it +self+ is changed,
 so outer self methods or instance variables are not accessible, unless usigned to
@@ -104,6 +125,17 @@ For short expressions, the abbreviation +Units.u+ can be used instead of +Units.
   x = u{120*km/h}
   puts x.to(u{mi/h})                 # => 74.5645430684801*mi/h
 
+New units can be defined with +Units.define+
+
+  Units.define :kph, 1, Units.u{km/h}
+  puts Units.u{270*kph.to(m/s)}      # => 75.0*m/s
+
+== Caveat
+
+Note that Ruby variable definition rules imply that this:
+  m = Units.u{m}
+Results is a nil value (the outter m assignment defines a local m variable even before executing the block, so
+the m in the block refers to that, yet-unassigned, variable and not to the meter unit)
 
 == Note on Patches/Pull Requests
 

data/Rakefile

@@ -7,7 +7,6 @@ begin
     gem.name = "units-system"
     gem.summary = %Q{Arithmetic with units of measure}
     gem.description = %Q{Experimental unit conversion & arithmetic for Ruby 1.9}
-    gem.required_ruby_version = '>= 1.9.1'
     gem.email = "jgoizueta@gmail.com"
     gem.homepage = "http://github.com/jgoizueta/units-system"
     gem.authors = ["Javier Goizueta"]

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/units-system.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-# Ruby 1.9 Units-System experiments.
+# Ruby Units-System experiments.
 
 module Units
-
+  
   class Measure
 
     def initialize(mag=1.0, units={})
@@ -349,8 +349,9 @@ module Units
           prefix = prefix.to_s
           if u[0...prefix.length] == prefix
             factor = f
-            ud = UNITS[u[prefix.length..-1].to_sym].dup
-            if ud
+            ud = UNITS[u[prefix.length..-1].to_sym]
+            if ud              
+              ud = ud.dup
               ud.name = "#{name}#{ud.name}"
               break
             end
@@ -395,11 +396,16 @@ module Units
           equivalence = factor*ud.decomposition if ud.decomposition
           factor *= ud.factor
         end
+        # si_unit = (factor==1.0) # to save si_units definitions
       else
         # unidad compuesta
         equivalence = args.shift
         factor = equivalence.to_si.magnitude
         si_unit = (factor==1.0) # TODO: tolerance?
+        if equivalence.units.empty?
+          # adimensional compound dimension... (special case)
+          equivalence = nil
+        end
       end
     elsif args.first.kind_of?(Numeric)
       # unidad definida en función de otra
@@ -407,8 +413,8 @@ module Units
       factor_units = args.shift
       u = unit(factor_units)
       dim = u.dim
-      factor *= u.factor
       equivalence = factor*u.decomposition if u.decomposition
+      factor *= u.factor
       bias = args.shift
     else
       # unidad simple definida en función de una expressión
@@ -546,6 +552,26 @@ module Units
     end
 
   end
+  
+  
+  # Constant look-up was different in Ruby before 1.9.1
+  # In older Ruby versions, this must be included in any module or class from which units expressions
+  # are to be used in units or u blocks.
+  module UseBlocks
+    if RUBY_VERSION<"1.9"
+      def self.append_features(target)
+        def target.const_missing(name)
+          begin
+            Units.Measure(name)
+          rescue ArgumentError
+            super
+          end
+        end
+      end
+    end
+  end
+    
+  include UseBlocks
 
   # Units definitions
 
@@ -575,6 +601,7 @@ module Units
   define :ft, 'foot', 0.3048, :m
   # in is a Ruby keyword; to avoid having to use self.in we'll define:
   define :inch, 'inch', 1, :in
+  define :lb, 'pound', 0.45359237, :kg
 
   # declare derived quantities without named units
   si_units :speed, u{m/s}
@@ -630,5 +657,13 @@ module Units
 
   # define :kp, 'kilopond', :force, u{kg*g0} # or define pond?
   define :gf, 'gram-force', :force, u{g*g0} # kilopond kp = kgf
+  define :lbf, 'pound-force', :force, u{lb*g0}
+
+  define :dyn, 'dyne', 10, :µN # u{1*g*cm/s**2}
+  define :galUS, 'U.S. liquid gallon', :volume, u{231*self.in**3}
+  define :galUK, 'Imperial gallon', 4.546092, :l
+  define :hp, 'horsepower', :power, u{550*ft*lbf/s}
+
+  define :psi, 'pounds-force per square inch', :pressure, u{lbf/self.in**2}
 
 end # Units

data/test/helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 
+$KCODE='UTF8' if RUBY_VERSION<"1.9"
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'units-system'

data/test/test_units-system.rb

@@ -1,6 +1,8 @@
 require 'helper'
 
 class TestUnitsSystem < Test::Unit::TestCase
+  
+  include Units::UseBlocks
 
   should "be possible to define Measures with a units block" do
     assert_equal Units::Measure, Units.units{m}.class
@@ -48,6 +50,7 @@ class TestUnitsSystem < Test::Unit::TestCase
   should "convert compound units correctly" do
     assert_equal 75, Units.u{(270*km/h).in(m/s)}
     assert_equal 270, Units.u{(75*m/s).in(km/h)}
+    assert_in_delta Units.u{g*cm/s**2}.magnitude, Units.u{dyn.to(g*cm/s**2)}.magnitude, Float::EPSILON
   end
 
   should "add units correctly" do

data/units-system.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{units-system}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javier Goizueta"]
-  s.date = %q{2009-12-18}
+  s.date = %q{2010-02-01}
   s.description = %q{Experimental unit conversion & arithmetic for Ruby 1.9}
   s.email = %q{jgoizueta@gmail.com}
   s.extra_rdoc_files = [
@@ -31,7 +31,6 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/jgoizueta/units-system}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Arithmetic with units of measure}
   s.test_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: units-system
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Javier Goizueta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-18 00:00:00 +01:00
+date: 2010-02-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.9.1
+      version: "0"
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: