vanunits 1.5.0

data/lib/van/units/currency.rb

@@ -0,0 +1,160 @@
+require 'van/units/base'
+require 'soap/wsdlDriver'
+
+module Van
+module Units
+
+  class CurrencyLoader < Loader
+    THREAD_REFERENCE = 'Units::ce_service'.to_sym
+
+    handles 'ce_service', 'currency_unit'
+
+    def ce_service(converter, name, &blk)
+      old_service = Thread.current[THREAD_REFERENCE]
+      Thread.current[THREAD_REFERENCE] = Units::Converter::ExchangeRate.const_get(name)
+      yield
+    ensure
+      Thread.current[THREAD_REFERENCE] = old_service
+    end
+
+    def currency_unit(converter, name)
+      service = Thread.current[THREAD_REFERENCE] || Units::Config::DEFAULT_CURRENCY_SERVICE
+      converter.send(:register_unit, name, :equals => service.create_conversion(name, converter))
+    end
+  end
+
+  class Converter
+
+    # Encapsulates a service for retrieving exchange rates.
+    # This is used by Converter.register_currency.
+    # An instance of this class behaves like a Numeric when used
+    # in calculations. This class is used to look up exchange rates
+    # lazily.
+    #
+    # This class is not supposed to be instantiated by itself. Instead a
+    # subclass should be created that defines the method +get_rate+.
+    # The only subclasses provided are currently XMethods and CachedXMethods.
+    #
+    # To be found automatically from YAML files, exchange services should
+    # be located under Units::Converter::ExchangeRate.
+    class ExchangeRate
+
+      def self.create_conversion(curr, converter) # :nodoc:
+        {:unit => Units::Unit.new({'--base-currency--'.to_sym => 1}, converter), :multiplier => self.new(curr)}
+      end
+
+      def initialize(curr) # :nodoc:
+        @curr = curr
+      end
+
+      # This method should be overridden in subclasses to return the
+      # exchange rate represented by this object. The unit in question
+      # is available as a String in the instance variable <code>@curr</code>.
+      # The rate should be calculated against an arbitrary but fixed base currency.
+      # The rate should be such that the following would be true
+      #   1 * curr = rate * base_curr
+      # This function should return +nil+ if the currency is not supported by this
+      # retrieval service. It should <em>not</em> raise an exception.
+      def get_rate
+        raise NoMethodError, "undefined method `get_rate' for #{to_s}:#{self.class}"
+      end
+
+      def value # :nodoc:
+        @value ||= get_rate or raise TypeError, "currency not supported by current service: #{@curr.to_s.dump}"
+      end
+
+      def coerce(other) # :nodoc:
+        [value, other]
+      end
+
+      def *(other) # :nodoc:
+        value * other
+      end
+
+      def /(other) # :nodoc:
+        value / other
+      end
+
+      def +(other) # :nodoc:
+        value + other
+      end
+
+      def -(other) # :nodoc:
+        value - other
+      end
+
+      def **(other) # :nodoc:
+        value ** other
+      end
+
+      # Exchange rate retrieval service that uses a service from http://www.xmethods.com.
+      # See http://rubyurl.com/7uq.
+      class XMethods < ExchangeRate
+
+        # This is the only method that a subclass of ExchangeRate
+        # needs to implement. This is a good example to follow.
+        def get_rate
+          driver.getRate(country_mapping[@curr], country_mapping[base])
+        rescue
+          p $!
+          puts $!.backtrace
+          nil
+        end
+
+        private
+
+        def data
+          @@data ||= eval(File.read(File.join(Units::Config::CONFIGDIR, 'xmethods', 'mapping.rb')))
+        end
+
+        def country_mapping
+          @@country_mapping ||= data[:mapping]
+        end
+
+        def base
+          @@base ||= data[:base]
+        end
+
+        def driver
+          @@driver ||= SOAP::WSDLDriverFactory.new("http://www.xmethods.net/sd/2001/CurrencyExchangeService.wsdl").create_rpc_driver
+        end
+
+      end
+
+      # Cached values for the XMethods exchange rate service.
+      class CachedXMethods < ExchangeRate
+
+        # This is the only method that a subclass of ExchangeRate
+        # needs to implement. This is a good example to follow.
+        def get_rate
+          data[@curr]
+        end
+
+        private
+
+        def data
+          @@data ||= eval(File.read(File.join(Units::Config::CONFIGDIR, 'xmethods', 'cached.rb')))
+        end
+
+      end #class CachedXMethods
+    end
+
+  private
+
+    #--
+    # Trans: What is --base-currency-- all about?
+    #++
+    def conversions(unit)
+      @conversions[unit] || (unit == '--base-currency--'.to_sym ? :none : nil)
+    end
+
+  end
+
+  # Contains some configuration related constants
+  module Config
+    # The standard service used for looking up currency exchange rates
+    DEFAULT_CURRENCY_SERVICE = Units::Converter::ExchangeRate::XMethods
+  end
+
+end
+end

data/lib/van/units/data/binary/base.rb

@@ -0,0 +1,4 @@
+converter 'binary_base' do
+  binary_unit('bit',  'b')
+  binary_unit('byte', 'B'){ '8.0 b' }
+end

data/lib/van/units/data/cex.rb

@@ -0,0 +1,5 @@
+converter 'cex' do
+  ce_service 'CachedXMethods' do
+    load 'currency/base.rb'
+  end
+end

data/lib/van/units/data/currency-default.rb

@@ -0,0 +1,5 @@
+require 'cex'
+
+converter "default" do
+  include 'cex'
+end

data/lib/van/units/data/currency-standard.rb

@@ -0,0 +1,2 @@
+require 'currency-default'
+require 'xmethods'

data/lib/van/units/data/currency/base.rb

@@ -0,0 +1,89 @@
+currency_unit "aed"
+currency_unit "afa"
+currency_unit "all"
+currency_unit "ars"
+currency_unit "ats"
+currency_unit "aud"
+currency_unit "bbd"
+currency_unit "bdt"
+currency_unit "bef"
+currency_unit "bgn"
+currency_unit "bhd"
+currency_unit "bmd"
+currency_unit "brl"
+currency_unit "bsd"
+currency_unit "cad"
+currency_unit "chf"
+currency_unit "clp"
+currency_unit "cny"
+currency_unit "cop"
+currency_unit "crc"
+currency_unit "cyp"
+currency_unit "czk"
+currency_unit "dem"
+currency_unit "dkk"
+currency_unit "dop"
+currency_unit "dzd"
+currency_unit "eek"
+currency_unit "egp"
+currency_unit "esp"
+currency_unit "eur"
+currency_unit "fim"
+currency_unit "fjd"
+currency_unit "frf"
+currency_unit "gbp"
+currency_unit "grd"
+currency_unit "hkd"
+currency_unit "hrk"
+currency_unit "huf"
+currency_unit "idr"
+currency_unit "iep"
+currency_unit "ils"
+currency_unit "inr"
+currency_unit "iqd"
+currency_unit "irr"
+currency_unit "isk"
+currency_unit "itl"
+currency_unit "jmd"
+currency_unit "jod"
+currency_unit "jpy"
+currency_unit "kes"
+currency_unit "krw"
+currency_unit "kwd"
+currency_unit "lbp"
+currency_unit "lkr"
+currency_unit "luf"
+currency_unit "mad"
+currency_unit "mtl"
+currency_unit "mur"
+currency_unit "mxn"
+currency_unit "myr"
+currency_unit "nlg"
+currency_unit "nok"
+currency_unit "nzd"
+currency_unit "omr"
+currency_unit "pen"
+currency_unit "php"
+currency_unit "pkr"
+currency_unit "pln"
+currency_unit "pte"
+currency_unit "qar"
+currency_unit "ron"
+currency_unit "rub"
+currency_unit "sar"
+currency_unit "sdd"
+currency_unit "sek"
+currency_unit "sgd"
+currency_unit "sit"
+currency_unit "skk"
+currency_unit "thb"
+currency_unit "tnd"
+currency_unit "try"
+currency_unit "ttd"
+currency_unit "twd"
+currency_unit "usd"
+currency_unit "veb"
+currency_unit "vnd"
+currency_unit "xcd"
+currency_unit "zar"
+currency_unit "zmk"

data/lib/van/units/data/iec.rb

@@ -0,0 +1,5 @@
+require 'iec_binary/base'
+
+converter 'iec' do
+  include 'binary_iec_base'
+end

data/lib/van/units/data/iec_binary/base.rb

@@ -0,0 +1,6 @@
+require 'binary/base'
+
+converter 'binary_iec_base' do
+  binary_iec_unit('bit',  :b){ 'binary_base:b' }
+  binary_iec_unit('byte', :B){ '8.0 b' }
+end

data/lib/van/units/data/si.rb

@@ -0,0 +1,8 @@
+require 'si/constants'
+
+converter 'si' do
+  include 'si_base'
+  include 'si_derived'
+  include 'si_extra'
+  include 'si_constants'
+end

data/lib/van/units/data/si/base.rb

@@ -0,0 +1,11 @@
+# http://physics.nist.gov/cuu/Units/units.html
+
+converter 'si_base' do
+  si_unit :meter  , :m
+  si_unit :gram   , :g
+  si_unit :second , :s
+  si_unit :ampere , :A
+  si_unit :kelvin , :K
+  si_unit :mole   , :mol , :moles
+  si_unit :candela, :cd
+end

data/lib/van/units/data/si/constants.rb

@@ -0,0 +1,88 @@
+require 'si/extra'
+
+# TODO: Some of these arn't natural constants, and should be put in a separate converter.
+
+converter "si_constants" do
+  unit :gravitational_constant, :G  do "6.673e-11 si_base::m**3 / si_base:kg si_base:s**2" end
+
+  # TODO: name? earth_nominal_gravity
+  #unit :gravitational_acceleration               = 9.80665e0.m/s**2                       # m / s^2
+
+  unit(:lightspeed, :c, :speed_of_light){ "2.99792458e8 si_base:m / si_base:s" }
+
+  unit :lightyear                  do "9.46053620707e15 si_base:m" end
+
+  #unit :astronomical_unit, :au    do "1.49597870691e11 si_base:m" end
+  unit :parsec                     do "3.08567758135e16 si_base:m" end
+
+  unit :planks_constant, :h        do "6.62606876e-34 si_base:kg si_base:m**2 / si_base:s"    end
+  unit :planks_constant_bar, :hbar do "1.05457159642e-34 si_base:kg si_base:m**2 / si_base:s" end
+
+  unit :vacuum_permeability        do "1.25663706144e-6 si_base:kg si_base:m / si_base:A**2 * si_base:s**2" end
+  unit :vacuum_permittivity        do "8.854187817e-12 A**2 s**4 / kg m**3" end
+
+  #unit :electronvolt, :eV         do "1.602176462e-19 si_derived:J" end
+  unit :electroncharge             do "1.602176462e-19 A * s" end
+
+  unit "electronmass"              do "9.10938188e-31 kg" end
+  unit "muonmass"                  do "1.88353109e-28 kg" end
+  unit "protonmass"                do "1.67262158e-27 kg" end
+  unit "neutronmass"               do "1.67492716e-27 kg" end
+
+  unit "rydberg"                   do "2.17987190389e-18 kg * m**2 / s**2" end
+  unit "boltzmann"                 do "1.3806503e-23 kg m**2 / K s**2" end
+
+  unit "bohr_magneton"             do "9.27400899e-24  A m**2" end
+  unit "nuclear_magneton"          do "5.05078317e-27  A m**2" end
+  unit :electron_magnetic_moment   do "9.28476362e-24  A m**2" end
+  unit :proton_magnetic_moment     do "1.410606633e-26 A m**2" end
+
+  unit :bohr_radius, [], "bohr_radii" do "5.291772083e-11 m"   end
+
+  #unit :unified_atomic_mass,      "1.66053873e-27 si_base:kg", :abbrev => "u"
+  #unit :atomic_mass               "1.66053873e-27 si_base:kg"
+  #unit :angstrom,                 "100.0 si_derived:kPa"
+
+  unit :molar_gas           do "8.314472e0 kg m**2 / K mol s**2" end
+  unit :standard_gas_volume do "2.2710981e-2 m**3 / mol"         end
+
+  unit :solar_mass   do "1.98892e30 kg"      end
+
+  unit :carat        do "2e-4 si_base:kg"    end
+
+  unit :fathom       do "1.8288e0 m"         end
+  unit :mil          do "2.54e-5 m"          end
+  unit :point        do "3.52777777778e-4 m" end
+  unit :texpoint     do "3.51459803515e-4 m" end
+
+  unit :micron       do "1e-6 m" end
+
+  unit :ton          do "9.0718474e2 kg"     end
+  unit :troy_ounce   do "3.1103475e-2 kg"    end
+
+  unit :gram_force   do "9.80665e-3 kg m / s**2"         end
+  unit :poundal      do "1.38255e-1 kg m / s**2"         end
+  unit :calorie      do "4.1868e0 kg m**2 / s**2"        end
+  unit :btu          do "1.05505585262e3 kg m**2 / s**2" end
+  unit :therm        do "1.05506e8 kg m**2 / s**2"       end
+
+  unit :horsepower           do "7.457e2 kg m**2 / s**3"      end
+  unit :standard_atmosphere  do "1.01325e5 kg / m s**2"       end
+  unit :torr                 do "1.33322368421e2 kg / m s**2" end
+  unit :meter_of_mercury     do "1.33322368421e5 kg / m s**2" end
+
+  unit :poise        do "1e-1 kg m**-1 s**-1"     end
+  unit :stokes       do "1e-4 m**2 / s"            end
+  unit :faraday      do "9.6485341472e4 A s / mol" end
+
+  unit :stilb        do "1e4 cd / m**2"             end                # cd / m^2
+  unit :phot         do "1e4 cd * sr / m**2"        end                # cd sr / m^2
+  #unit :lumen       do "1e0 cd * sr"               end                # cd sr
+  #unit :lux         do "1e0 cd * sr / m**2"        end                # cd sr / m^2
+
+  unit :dyne         do "1e-5 kg m / s**2"    end
+  unit :gauss        do "1e-4 kg / A s**2"    end
+  unit :erg          do "1e-7 kg m**2 / s**2" end
+
+end
+

data/lib/van/units/data/si/derived.rb

@@ -0,0 +1,33 @@
+# http://physics.nist.gov/cuu/Units/units.html
+
+require 'si/base'
+
+converter 'si_derived' do
+  si_unit( :radian,     :rad ){ "" }
+  si_unit( :steradian,  :sr  ){ "" }
+
+  si_unit( :hertz,      :Hz  ){ "1 / si_base:s"           }
+  si_unit( :newton,     :N   ){ "si_base:kg si_base:m / si_base:s**2" }
+  si_unit( :pascal,     :Pa  ){ "N / si_base:m**2"        }
+  si_unit( :joule,      :J   ){ "N * si_base:m"           }
+  si_unit( :watt,       :W   ){ "J / si_base:s"           }
+  si_unit( :coulomb,    :C   ){ "si_base:A * si_base:s"   }
+  si_unit( :volt,       :V   ){ "W / si_base:A"           }
+  si_unit( :farad,      :F   ){ "C / V"                   }
+  si_unit( :ohm              ){ "V / si_base:A"           }
+  si_unit( :siemens,    :S   ){ "si_base:A / V"           }
+  si_unit( :weber,      :Wb  ){ "V * si_base:s"           }
+  si_unit( :tesla,      :T   ){ "Wb / si_base:m**2"       }
+
+  si_unit( :henry,      :H  , :henries  ){ "Wb / si_base:A"    }
+  si_unit( :lumen,      :lm             ){ "si_base:cd sr"     }
+  si_unit( :lux,        :lx , :luxen    ){ "lm / si_base:m**2" }
+
+  si_unit( :becquerel,  :Bq  ){ "1 / si_base:s"           }
+  si_unit( :gray,       :Gy  ){ "J / si_base:kg"          }
+  si_unit( :sievert,    :Sv  ){ "J / si_base:kg"          }
+  si_unit( :katal,      :kat ){ "si_base:mol / si_base:s" }
+
+  si_unit( :bar              ){ "100.0 kPa" }  # TODO: should this be in si_extra ?
+end
+

data/lib/van/units/data/si/extra.rb

@@ -0,0 +1,35 @@
+# http://physics.nist.gov/cuu/Units/outside.html
+
+require 'si/derived'
+
+converter "si_extra" do
+  unit(:minute, :min){ "60.0 si_base:s" }
+  unit(:hour,   :hr ){ "60.0 min" }
+  unit(:day,    :d  ){ "24.0 hr" }
+  unit(:liter,  :L  ){ "si_base:dm**3" }
+
+  unit(:neper,  :Np ){ "" }
+  #unit( :bel, :B { "(1/2) ln 10 Np" }
+  #unit( :decibel, :dB ){ "10 B" }
+
+  unit(:are,      :a    ){ "si_base:dam**2" }
+  unit(:hectare,  :ha   ){ "si_base:hm**2" }
+ #unit(:bar             ){ "100.0 si_derived:kPa" }
+  unit(:barn            ){ "100.0 si_base:fm**2" }
+  unit(:curie,    :Ci   ){ "3.7e10 si_derived:Bq" }
+  unit(:roentgen, :R    ){ "2.58e-4 si_derived:C / si_base:kg" }
+
+  unit(:metric_ton,  :t ){ "1000.0 si_base:kg" }
+  unit(:nautical_mile   ){ "1852.0 si_base:m" }
+  unit(:knot            ){ "nautical_mile / hr" }
+
+  unit(:rad){ "1e-2 si_derived:Gy" }
+  unit(:rem){ "1e-2 si_derived:Sv" }
+
+  unit(:degree){ "0.0174532925199433 si_derived:rad" }
+  unit(:angstrom){ "10e-10 m" }
+  unit(:electronvolt, :eV){ "1.60218e-19 si_derived:J" }
+  unit(:astronomical_unit, :ua){ "1.49598e11 si_base:m" }
+  unit(:unified_atomic_mass_unit, :u){ "1.66054e-27 si_base:kg" }
+end
+