units-system 0.2.5 → 0.3.0

data/README.rdoc

@@ -148,6 +148,34 @@ 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
 
+=== Constants
+
+Constants could be define practically as units, but to avoid introducing too much
+noise in the units namespace, they can be defined separately with:
+
+  Units.constant :g, 'standard gravity', u{9.80665*m/s**2}
+
+A constant can be used anywhere with the Units::Const prefix:
+
+  puts Units::Const.g                # => 9.80665*m/s**2
+  # gram-force:
+  puts u{g*Const.g}                  # => 9.80665*(g*m)/s**2
+
+To avoid using the prefix, constants to be used unprefixed can be declared with a +with_constants+;
+Note in the first example, that by introducing a constant named +g+ we're hiding the gram units and
+would not be able to use it in the block.
+
+  # kilopond:
+  puts Units.with_constants(:g){kg*g} # => 9.80665*(kg*m)/s**2
+  # 1 GeV mass
+  puts Units.with_constants(:c){1*GeV/c**2}.to(:kg)             # => 1.782661844855044e-27*kg
+  # Planck units
+  Units.with_constants :c, :G, :hbar do
+    puts sqrt(hbar*G/c**3)                                      # => 1.6161992557033346e-35*m
+    puts sqrt(hbar*c/G)                                         # => 2.176509252445312e-08*kg
+    puts sqrt(hbar*G/c**5)                                      # => 5.391060423886096e-44*s
+  end
+
 == Caveat
 
 Note that Ruby variable definition rules imply that this:

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.0

data/lib/units-system.rb

@@ -13,15 +13,36 @@ module Units
   # It is not needed in Ruby 1.9.1 due to they way constant look-up is done in that version,
   # but Ruby 1.9.2 has changed that an requires this again.
   module UseBlocks
+    @@constants = nil # an instance variable would not work here because const_missing is executed on other modules (which include this one)
     def self.append_features(target)
       def target.const_missing(name)
         begin
-          Units.Measure(name)
+          name = name.to_sym
+          if name==:Const
+            Units::Const
+          else
+            result = @@constants[name] if @@constants
+            result || Units.Measure(name)
+          end
         rescue ArgumentError
           super
         end
       end
     end
+
+    def self.with_constants(*consts)
+      prev = @@constants
+      # @@constants = consts.map_hash{|c| Units.constant(c)}
+      @@constants = {}
+      consts.each do |c|
+        c = c.to_sym
+        @@constants[c] = Units.constant(c)
+      end
+      result = yield
+      @@constants = prev
+      result
+    end
+
   end
 
   include UseBlocks

data/lib/units/definitions.rb

@@ -78,17 +78,17 @@ module Units
   define :arcmin, 'arc-minute', 1, :′
   define :arcsec, 'arc-second', 1, :″
 
-  define :g0, 'standard gravity', u{9.80665*m/s**2}
+  constant :g0, 'standard gravity', u{9.806_65*m/s**2}
 
   define :bar,  'bar',                    1E5, :Pa
   define :atm,  'atmosphere',             101325.0, :Pa
-  define :mWC,  'meters of water column', u{1E3*kg*g0/m**2}
+  define :mWC,  'meters of water column', with_constants(:g0){1E3*kg*g0/m**2}
   define :Torr, 'torricelli',             u{atm/760}
-  define :mHg,  'mHg',                    u{13.5951E3*kg*g0/m**2}
+  define :mHg,  'mHg',                    with_constants(:g0){13.5951E3*kg*g0/m**2}
 
   # define :kp, 'kilopond', :force, u{kg*g0} # or define pond?
-  define :gf,  'gram-force',  u{g*g0} # kilopond kp = kgf
-  define :lbf, 'pound-force', u{lb*g0}
+  define :gf,  'gram-force',  with_constants(:g0){g*g0} # kilopond kp = kgf
+  define :lbf, 'pound-force', with_constants(:g0){lb*g0}
 
   define :dyn,   'dyne', 10, :µN # u{1*g*cm/s**2}
   define :galUS, 'U.S. liquid gallon', u{231*self.in**3}
@@ -97,4 +97,27 @@ module Units
 
   define :psi, 'pounds-force per square inch', u{lbf/self.in**2}
 
+  constant :pi, 'Pi', ::Math::PI
+
+  # Constants (CODATA 2010 recommended values)
+  constant :c,    'speed of light',          u{ 299_792_458*m/s }
+  constant :h,    'Planck constant',         u{ 6.626_069_57E-34*J*s }
+  constant :hbar, 'Dirac constant',          u{Const.h/(2*Const.pi)}
+  constant :ħ,    'Dirac constant',          Const.hbar
+  constant :μ0,   'magnetic constant',       u{4*Const.pi*1E-7*N/A**2}
+  constant :ϵ0,   'electric constant',       1/Const.μ0/Const.c**2
+  constant :G,    'gravitational constant',  u{ 6.673_84E-11*m**3/kg/s**2 }
+  constant :e,    'elementary charge',       u{1.602_176_565E-19*C}
+  constant :me,   'electron mass',           u{9.109_382_91E-31*kg}
+  constant :mp,   'proton mass',             u{1.672_621_777E-27*kg}
+  constant :α,    'fine-structure constant', with_constants(:e, :pi, :ϵ0, :ħ, :c){e**2/(4*pi*ϵ0*ħ*c)}
+  constant :R∞,   'Rydberg constant',        with_constants(:α, :me, :c, :h){α**2*me*c/2/h}
+  constant :NA,   'Avogadro constant',       u{6.022_141_29E22*mol}
+  constant :F,    'Faraday constant',        Const.NA*Const.e
+  constant :R,    'molar gas constant',      u{8.314_4621*J/mol/K}
+  constant :k,    'Boltzmann constant',      Const.R/Const.NA
+
+  define :eV,     'electron volt',           u{Const.e*V}
+  define :u,      'atomic mass unit',        u{1.660_538_921E-27*kg}
+
 end # Units

data/lib/units/math.rb

@@ -44,6 +44,32 @@ module Units
       Units.u{::Math.atan2(x,y)*rad}
     end
 
+    def sqrt(x)
+      if x.kind_of?(Measure)
+        if x.units.empty?
+          Measure[::Math.sqrt(x.magnitude)]
+        else
+          y = x
+          all_even = x.units.values.map{|v| v.last % 2}.uniq == [0]
+          unless all_even
+            x = x.base
+            all_even = x.units.values.map{|v| v.last % 2}.uniq == [0]
+          end
+          if all_even
+            units = {}
+            x.units.each do |dim, (unit, exp)|
+              units[dim] = [unit, exp/2]
+            end
+            Measure[::Math.sqrt(x.magnitude), units]
+          else
+            raise ArgumentError, "Invalid dimensiones for sqrt argument #{y}"
+          end
+        end
+      else
+        ::Math.sqrt(x)
+      end
+    end
+
   end
 
 end # Units

data/lib/units/system.rb

@@ -232,5 +232,53 @@ module Units
     u_descr
   end
 
-end # Units
+  ConstantDefinition = Struct.new(:symbol, :description, :value)
+  CONSTANTS = {}
+  module Const
+    def self.define(name, description, value)
+      symbol = name.to_sym
+      cd = ConstantDefinition.new(symbol, description, value)
+      CONSTANTS[symbol] = cd
+      class_eval do
+        # Ruby 1.9.1 allows this nicer definition:
+        #   define_singleton_method name do
+        #     value
+        #   end
+        eigenclass = class<<self; self; end
+        eigenclass.instance_eval{define_method(name){value}}
+      end
+    end
+  end
+
+  def self.constant(symbol, description=nil, value=nil)
+    if description.nil? && value.nil?
+      c = CONSTANTS[symbol]
+      c && c.value
+    else
+      Const.define symbol, description, value
+    end
+  end
 
+  def self.with_constants(*constants, &blk)
+    m = Module.new
+    m.extend Units::System
+    m.extend Units::Math
+    cap_constants = []
+    constants.each do |const|
+      m.instance_eval do
+        # Ruby 1.9.1 allows this nicer definition:
+        #   define_singleton_method(const){Units.constant(const)}
+        eigenclass = class<<self; self; end
+        eigenclass.instance_eval{define_method(const){Units.constant(const)}}
+        name_initial = const.to_s[0,1]
+        if name_initial==name_initial.upcase && name_initial!=name_initial.downcase
+          cap_constants << const
+        end
+      end
+    end
+    UseBlocks.with_constants(*cap_constants) do
+      m.instance_eval &blk
+    end
+  end
+
+end # Units

data/test/test_constants.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+class TestConstants < Test::Unit::TestCase
+
+  include Units::UseBlocks
+
+  should "have qualified constants" do
+    assert_equal 299792458, Units::Const.c.magnitude
+    assert_equal 6.67384E-11, Units::Const.G.magnitude
+    assert_equal [:m, 1], Units::Const.c.units[:length]
+    assert_equal 299792458**2, (Units::Const.c**2).magnitude
+    assert_equal [:m, 2], (Units::Const.c**2).units[:length]
+    assert_nil (Units::Const.c/Units.u{m}).units[:length]
+  end
+
+  should "have qualified constants in units blocks" do
+    assert_equal 299792458, Units.units{Units::Const.c}.magnitude
+    assert_equal 6.67384E-11, Units.units{Units::Const.G}.magnitude
+    assert_equal [:m, 1], Units.units{Units::Const.c}.units[:length]
+    assert_equal 299792458**2, Units.units{Units::Const.c**2}.magnitude
+    assert_equal [:m, 2], Units.units{Units::Const.c**2}.units[:length]
+    assert_nil Units.units{Units::Const.c/m}.units[:length]
+  end
+
+  should "not need qualification for Const inside a units block" do
+    assert_equal 299792458, Units.units{Const.c}.magnitude
+    assert_equal 6.67384E-11, Units.units{Const.G}.magnitude
+    assert_equal [:m, 1], Units.units{Const.c}.units[:length]
+    assert_equal 299792458**2, Units.units{Const.c**2}.magnitude
+    assert_equal [:m, 2], Units.units{Const.c**2}.units[:length]
+    assert_nil Units.units{Const.c/m}.units[:length]
+  end
+
+  should "provide constant values" do
+    c = Units::Const.c
+    assert_equal 299792458, Units.units{c}.magnitude
+    assert_equal [:m, 1], Units.units{c}.units[:length]
+    assert_equal 299792458**2, Units.units{c**2}.magnitude
+    assert_equal [:m, 2], Units.units{c**2}.units[:length]
+    assert_nil Units.units{c/m}.units[:length]
+  end
+
+  should "allow use of local unqualified declared constants" do
+    assert_equal 299792458, Units.with_constants(:c){c}.magnitude
+    assert_equal 299792458*6.67384E-11, Units.with_constants(:c,:G){G*c}.magnitude
+    assert_nil Units.with_constants(:c){c/m}.units[:length]
+    assert_in_delta 1.782661844855044e-27, Units.with_constants(:c){1*GeV/c**2}.to(:kg).magnitude, Float::EPSILON
+  end
+
+  should "not need qualification for Const inside a with_constants block" do
+    assert_equal 299792458, Units.with_constants{Const.c}.magnitude
+    assert_equal 6.67384E-11, Units.with_constants{Const.G}.magnitude
+    assert_equal [:m, 1], Units.with_constants{Const.c}.units[:length]
+    assert_equal 299792458**2, Units.with_constants{Const.c**2}.magnitude
+    assert_equal [:m, 2], Units.with_constants{Const.c**2}.units[:length]
+    assert_nil Units.with_constants{Const.c/m}.units[:length]
+  end
+
+  should "define new constants" do
+    Units.constant :cc, "test constant c", Units::Const.c
+    assert_equal Units::Const.c, Units::Const.cc
+    assert_equal 299792458*6.67384E-11, Units.with_constants(:cc,:G){G*cc}.magnitude
+    Units.constant :GG, "test constant G", Units::Const.G
+    assert_equal Units::Const.G, Units::Const.GG
+    assert_equal 299792458*6.67384E-11, Units.with_constants(:c,:GG){GG*c}.magnitude
+  end
+
+end

data/test/test_units-system.rb

@@ -132,7 +132,8 @@ class TestUnitsSystem < Test::Unit::TestCase
   should "render valid code when inspecting measures" do
     assert_equal Units.u{m}, eval(Units.u{m}.inspect)
     assert_equal Units.u{3*m/s}, eval(Units.u{3*m/s}.inspect)
-    assert_equal Units.u{3*m/s+2*km/h}, eval(Units.u{3*m/s+2*km/h}.inspect)
+    assert_in_delta Units.u{3*m/s+2*km/h}.magnitude, eval(Units.u{3*m/s+2*km/h}.inspect).magnitude, 1E-12
+    assert_equal Units.u{3*m/s+2*km/h}.units, eval(Units.u{3*m/s+2*km/h}.inspect).units
   end
 
   should "allow arithmetic between measures and text" do
@@ -146,7 +147,7 @@ class TestUnitsSystem < Test::Unit::TestCase
     assert_equal "1.0 m", Units.u{m}.abr
     assert_equal "3.0 m", Units.u{3*m}.abr
     assert_equal "3.0 m/s", Units.u{3*m/s}.abr
-    assert_equal "3.5555555555555554 m/s", Units.u{3*m/s + 2*km/h}.abr
+    assert_match /\A3\.555555555555\d+ m\/s\Z/, Units.u{3*m/s + 2*km/h}.abr
     assert_equal "1,5 m/s", Units.units{3*m/(2*s)}.abr{|v| v.to_s.tr('.',',') }
   end
 

data/units-system.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "units-system"
-  s.version = "0.2.5"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javier Goizueta"]
-  s.date = "2012-09-20"
+  s.date = "2012-09-27"
   s.description = "Experimental unit conversion & arithmetic for Ruby 1.9"
   s.email = "jgoizueta@gmail.com"
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/units/prefixes.rb",
     "lib/units/system.rb",
     "test/helper.rb",
+    "test/test_constants.rb",
     "test/test_units-system.rb",
     "units-system.gemspec"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: units-system
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: modalsupport
@@ -113,6 +113,7 @@ files:
 - lib/units/prefixes.rb
 - lib/units/system.rb
 - test/helper.rb
+- test/test_constants.rb
 - test/test_units-system.rb
 - units-system.gemspec
 homepage: http://github.com/jgoizueta/units-system
@@ -129,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2016240404196555066
+      hash: 3591103717823383579
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: