units-system 0.0.5 → 0.1.0

data/lib/units/system.rb

@@ -0,0 +1,236 @@
+# encoding: utf-8
+
+module Units
+
+  # mathematical functions available to unit blocks are defined here
+  module Math
+  end
+
+  # unit methods and constants are defined here to be injected in units blocks
+  module System
+
+    extend Math
+
+    def self.define(unit)
+      define_var unit
+      PREFIXES.each do |prefix, (factor, name)|
+        define_var "#{prefix}#{unit}".to_sym
+      end
+    end
+
+    class <<self
+      private
+      def define_var(name)
+        name_initial = name.to_s[0,1]
+        if name_initial==name_initial.upcase && name_initial!=name_initial.downcase
+          # we could define a method with the requested name, but it would
+          # no be usable without qualification (System.X) or brackets (X())
+          # so we define a constant. But this requires Ruby 1.9 to be useful;
+          # otherwise the constant is not accesible without qualification in units blocks.
+          System.const_set name, Units.Measure(name)
+        end
+        self.class_eval do
+          define_method name do
+            Units.Measure(name)
+          end
+          module_function name
+        end
+      end
+    end
+
+  end # Units::System
+
+  def units(string=nil, &blk)
+    if string
+      if blk
+        raise ArgumentError, "wrong number of arguments (1 for 0)"
+      else
+        Units::System.class_eval(string)
+      end
+    else
+      Units::System.class_eval(&blk)
+    end
+  end
+  alias :u :units
+  module_function :units, :u
+
+  UnitDefinition = Struct.new(:dim, :factor, :name, :decomposition, :bias)
+
+  UNITS = {} # Hash.new{|h,k| h[k]=UnitDefinition.new()}
+
+  # get unit definition
+  def self.unit(unit_symbol)
+    ud = UNITS[unit_symbol]
+    if ud.nil?
+      factor = 1.0
+      if factor_name = PREFIXES[unit_symbol]
+        ud = UnitDefinition.new(nil, *factor_name)
+      else
+        u = unit_symbol.to_s
+        PREFIXES.each_pair do |prefix, (f,name)|
+          prefix = prefix.to_s
+          if u[0...prefix.length] == prefix
+            factor = f
+            ud = UNITS[u[prefix.length..-1].to_sym]
+            if ud
+              ud = ud.dup
+              ud.name = "#{name}#{ud.name}"
+              break
+            end
+          end
+        end
+      end
+      ud.factor *= factor if ud
+      ud.decomposition *= factor if ud && ud.decomposition
+    end
+    raise ArgumentError,"Invalid Units #{unit_symbol}" unless ud
+    ud
+  end
+
+  # Define new units.
+  # Define a base unit (with a factor for conversion to SI units)
+  #   Units.define :unit_symbol, 'unit-name', :quantity, si_units_per_this_unit
+  # Define a unit in terms or another (valid for base or derived units)
+  #   Units.define :unit_symbol, 'unit-name', value, :in_units
+  # Define a base unit as a measure-expression
+  #   Units.define :unit_symbol, 'unit_name', u{...}
+  # Define a derived unit as a measure-expression
+  #   Units.define :unit_symbol, 'unit_name', :quantity, u{...}
+  # For base dimensions the SI unit for a quantity must also be stablished with Unit.si_units;
+  # for derived units, SI units are automatically taken to be the first define unit of the quantity
+  # with unitary value in SI base units.
+  def self.define(unit_symbol, name, *args)
+    eqhivalence = nil
+    si_unit = false
+    bias = nil
+    if args.first.kind_of?(Symbol)
+      dim = args.shift
+      if args.first.kind_of?(Numeric)
+        # simple units
+        factor = args.shift
+        factor_units = args.shift
+        if factor_units
+          ud = unit(factor_units)
+          if ud.dim != dim
+            raise ArgumentError, "Inconsistent units #{factor_units} in definition of #{unit_symbol}"
+          end
+          # maybe it was not simple after all...
+          equivalence = factor*ud.decomposition if ud.decomposition
+          factor *= ud.factor
+        end
+        # si_unit = (factor==1.0) # to save si_units definitions # TODO: tolerance?
+      else
+        # compound unit
+        equivalence = args.shift
+        factor = equivalence.to_si.magnitude
+        si_unit = (factor==1.0) # TODO: tolerance?
+        if equivalence.units.empty?
+          # dimensionless compound dimension... (special case for angular units)
+          equivalence = nil
+        end
+      end
+    elsif args.first.kind_of?(Numeric)
+      # unit define in terms of other unit
+      factor = args.shift
+      factor_units = args.shift
+      u = unit(factor_units)
+      dim = u.dim
+      equivalence = factor*u.decomposition if u.decomposition
+      factor *= u.factor
+      bias = args.shift
+    else
+      # unit defined from a measure expression; the dimension must be already known or defined
+      # here (as as symbol preceding the expression).
+      definition = args.shift
+      dim = definition.dimension
+      raise ArgumentError,"To define a new compound unit a dimension must be specified" unless dim
+      equivalence = definition
+      factor = definition.to_si.magnitude
+      # si_unit = (factor==1.0) # to save si_units definitions # TODO: tolerance?
+    end
+    unit_def = UnitDefinition.new(dim, factor, name, equivalence, bias)
+    if UNITS.has_key?(unit_symbol)
+      raise "Redefinition of #{unit_symbol} as #{unit_def} (previously defined as #{UNITS[unit_symbol]})"
+    end
+    UNITS[unit_symbol] = unit_def
+    System.define unit_symbol
+    Units.si_units unit_def.dim, unit_symbol if si_unit && !SI_UNITS.has_key?(unit_def.dim)
+  end
+
+  SI_UNITS = {}
+
+  def self.si_units(dim, unit)
+    SI_UNITS[dim] = unit
+  end
+
+  def self.dimension(u)
+    unit(u).dim
+  end
+
+  def self.conversion_factor(from, to)
+    from_u = unit(from)
+    to_u = unit(to)
+    raise ArgumentError,"Inconsistent Units (#{from}, #{to})" if from_u.dim!=to_u.dim
+    from_u.factor/to_u.factor
+  end
+
+  def self.conversion_bias(from, to)
+    from_u = unit(from)
+    to_u = unit(to)
+    raise ArgumentError,"Inconsistent Units (#{from}, #{to})" if from_u.dim!=to_u.dim
+    factor = from_u.factor/to_u.factor
+    (from_u.bias||0)*factor - (to_u.bias||0)
+  end
+
+  # simple unit name
+  def self.unit_name(u)
+    uinfo = Units.unit(u)
+    uinfo && uinfo.name
+  end
+
+  def self.unit_descr(u, long=false, mult=1)
+    if long
+      u = unit_name(u)
+      if mult!=1
+        case mult
+        when 2
+          "squared #{u}"
+        when 3
+          "cubed #{u}"
+        else
+          "#{u} to the #{mult} power"
+        end
+      else
+        u
+      end
+    else
+      if mult!=1
+        "#{u}**#{mult}"
+      else
+        u.to_s
+      end
+    end
+  end
+
+  def self.units_descr(units, long=false)
+    units = units.values.sort_by{|u,m| -m}
+    pos_units = units.select{|u| u.last>0}
+    neg_units = units.select{|u| u.last<0}
+    times = long ? " " : "*"
+    num = pos_units.map{|u,m| unit_descr(u,long,m)}.join(times)
+    num = "(#{num})" if pos_units.size>1 && !neg_units.empty? && !long
+    den = neg_units.map{|u,m| unit_descr(u,long,-m)}.join("*")
+    den = "(#{den})" if neg_units.size>1 && !long
+    if pos_units.empty?
+      u_descr = "1/#{den}"
+    elsif neg_units.empty?
+      u_descr = num
+    else
+      connector = long ? " per " : "/"
+      u_descr = "#{num}#{connector}#{den}"
+    end
+    u_descr
+  end
+
+end # Units
+

data/test/test_units-system.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class TestUnitsSystem < Test::Unit::TestCase
-  
+
   include Units::UseBlocks
 
   should "be possible to define Measures with a units block" do
@@ -71,4 +71,49 @@ class TestUnitsSystem < Test::Unit::TestCase
     assert_raise(RuntimeError){Units.units{(m/s).to(m/s**2)}}
   end
 
+  should "define measures with bracket constructor" do
+    assert_equal Units::Measure, Units::Measure[1.0, :m].class
+    assert_equal 1.0, Units::Measure[1.0, :m].magnitude
+    assert_equal [:m, 1], Units::Measure[1.0, :m].units[:length]
+  end
+
+  should "be flexible with constructor arguments" do
+    assert_equal Units::Measure[1.0, :m], Units::Measure[:m]
+    assert_equal Units::Measure[2.0, {}], Units::Measure[2.0]
+    assert_equal Units::Measure[1.0, {}], Units::Measure[]
+  end
+
+  should "define measures with method constructor" do
+    assert_equal Units::Measure, Units.Measure(1.0, :m).class
+    assert_equal 1.0, Units.Measure(1.0, :m).magnitude
+    assert_equal [:m, 1], Units.Measure(1.0, :m).units[:length]
+  end
+
+  should "compare measure objects" do
+    assert_equal Units::Measure[1.0, :m], Units::Measure[1.0, :m]
+    assert_not_equal Units::Measure[1.0, :m], Units::Measure[2.0, :m]
+    assert_not_equal Units::Measure[1.0, :m], Units::Measure[1.0, :s]
+    assert_equal Units.u{m}, Units::Measure[1.0, :m]
+    assert_not_equal Units.u{m}, Units.u{s}
+    assert_not_equal Units.u{2*m}, Units.u{3*m}
+    assert_equal Units.u{2*m}, Units.u{2*m}
+    assert_equal Units.u{2*m/s}, Units.u{2*m/s}
+    assert_not_equal Units.u{2*m/s}, Units.u{2*m/h}
+    assert_not_equal Units.u{2*m/s}, Units.u{2*m/kg}
+    assert_not_equal Units.u{2*m/s}, Units.u{3*m/s}
+  end
+
+  should "admit units defined as text string" do
+    assert_equal Units::Measure, Units.units('m').class
+    assert_equal 1.0, Units.units('m').magnitude
+    assert_equal [:m, 1], Units.units('m').units[:length]
+    assert_equal :speed, Units.u('m/s').dimension
+    assert_equal Units.u{m}, Units.u("m")
+    assert_equal 5, Units.u("3*m+2*m").magnitude
+    assert_equal Units.u{3*m+2*m}, Units.u("3*m+2*m")
+    assert_equal 5, Units.units("3*m+2*m").magnitude
+    assert_equal Units.u{3*m+2*m}, Units.units("3*m+2*m")
+    assert_raise(ArgumentError){Units.u("m"){m}}
+  end
+
 end

data/units-system.gemspec

@@ -1,54 +1,66 @@
 # 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 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{units-system}
-  s.version = "0.0.5"
+  s.name = "units-system"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javier Goizueta"]
-  s.date = %q{2010-06-01}
-  s.description = %q{Experimental unit conversion & arithmetic for Ruby 1.9}
-  s.email = %q{jgoizueta@gmail.com}
+  s.date = "2012-04-20"
+  s.description = "Experimental unit conversion & arithmetic for Ruby 1.9"
+  s.email = "jgoizueta@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/units-system.rb",
-     "test/helper.rb",
-     "test/test_units-system.rb",
-     "units-system.gemspec"
-  ]
-  s.homepage = %q{http://github.com/jgoizueta/units-system}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Arithmetic with units of measure}
-  s.test_files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/units-system.rb",
+    "lib/units/definitions.rb",
+    "lib/units/math.rb",
+    "lib/units/measure.rb",
+    "lib/units/prefixes.rb",
+    "lib/units/system.rb",
     "test/helper.rb",
-     "test/test_units-system.rb"
+    "test/test_units-system.rb",
+    "units-system.gemspec"
   ]
+  s.homepage = "http://github.com/jgoizueta/units-system"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.21"
+  s.summary = "Arithmetic with units of measure"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<modalsupport>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<modalsupport>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<modalsupport>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
   end
 end
 

metadata

@@ -1,91 +1,145 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: units-system
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Javier Goizueta
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-01 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: modalsupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 description: Experimental unit conversion & arithmetic for Ruby 1.9
 email: jgoizueta@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - .document
-- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/units-system.rb
+- lib/units/definitions.rb
+- lib/units/math.rb
+- lib/units/measure.rb
+- lib/units/prefixes.rb
+- lib/units/system.rb
 - test/helper.rb
 - test/test_units-system.rb
 - units-system.gemspec
-has_rdoc: true
 homepage: http://github.com/jgoizueta/units-system
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 524794383718381749
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Arithmetic with units of measure
-test_files: 
-- test/helper.rb
-- test/test_units-system.rb
+test_files: []