stick 1.2.0

data/lib/stick/units/currency.rb

@@ -0,0 +1,159 @@
+require 'stick/units/base'
+
+require 'soap/wsdlDriver'
+
+module Stick
+
+  class CurrencyLoader < Loader
+
+    handles 'ce_service', 'currency_unit'
+
+    def ce_service(converter, name, &blk)
+      old_service = Thread.current[:'Stick::ce_service']
+      Thread.current[:'Stick::ce_service'] = ::Stick::Converter::ExchangeRate.const_get(name)
+      yield
+    ensure
+      Thread.current[:'Stick::ce_service'] = old_service
+    end
+
+    def currency_unit(converter, name)
+      service = Thread.current[:'Stick::ce_service'] || ::Stick::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 Stick::Converter::ExchangeRate.
+    class ExchangeRate
+
+      def self.create_conversion(curr, converter) # :nodoc:
+        {:unit => ::Stick::Unit.new({:'--base-currency--' => 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(::Stick::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(::Stick::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--' ? :none : nil)
+    end
+
+  end
+
+  # Contains some configuration related constants
+  module Config
+    # The standard service used for looking up currency exchange rates
+    DEFAULT_CURRENCY_SERVICE = ::Stick::Converter::ExchangeRate::XMethods
+  end
+
+end

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

@@ -0,0 +1,4 @@
+converter 'binary_base' do
+  binary_unit 'bit',  :abbrev => 'b', :alias => 'bits'
+  binary_unit 'byte', :abbrev => 'B', :alias => 'bytes', :equals => '8.0 b'
+end

data/lib/stick/units/data/cex.rb

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

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

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

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

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

data/lib/stick/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/stick/units/data/iec.rb

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

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

@@ -0,0 +1,6 @@
+require 'binary/base'
+
+converter 'binary_iec_base' do
+  binary_iec_unit 'bit',  :abbrev => 'b', :alias => 'bits',  :equals => 'binary_base:b'
+  binary_iec_unit 'byte', :abbrev => 'B', :alias => 'bytes', :equals => '8.0 b'
+end

data/lib/stick/units/data/si.rb

@@ -0,0 +1,7 @@
+require 'si/extra'
+
+converter 'si' do
+  include 'si_base'
+  include 'si_derived'
+  include 'si_extra'
+end

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

@@ -0,0 +1,9 @@
+converter 'si_base' do
+  si_unit 'meter',   :abbrev => 'm',   :alias => 'meters'
+  si_unit 'gram',    :abbrev => 'g',   :alias => 'grams'
+  si_unit 'second',  :abbrev => 's',   :alias => 'seconds'
+  si_unit 'ampere',  :abbrev => 'A',   :alias => 'amperes'
+  si_unit 'kelvin',  :abbrev => 'K',   :alias => 'kelvins'
+  si_unit 'mole',    :abbrev => 'mol', :alias => 'moles'
+  si_unit 'candela', :abbrev => 'cd',  :alias => 'candelas'
+end

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

@@ -0,0 +1,26 @@
+require 'si/base'
+
+converter 'si_derived' do
+  si_unit "radian",    :abbrev => "rad", :equals => "",                                    :alias => "radians"
+  si_unit "steradian", :abbrev => "sr",  :equals => "",                                    :alias => "steradians"
+  si_unit "hertz",     :abbrev => "Hz",  :equals => "1 / si_base:s"
+  si_unit "newton",    :abbrev => "N",   :equals => "si_base:kg si_base:m / si_base:s**2", :alias => "newtons"
+  si_unit "pascal",    :abbrev => "Pa",  :equals => "N / si_base:m**2",                    :alias => "pascals"
+  si_unit "joule",     :abbrev => "J",   :equals => "N * si_base:m",                       :alias => "joules"
+  si_unit "watt",      :abbrev => "W",   :equals => "J / si_base:s",                       :alias => "watts"
+  si_unit "coulomb",   :abbrev => "C",   :equals => "si_base:A * si_base:s",               :alias => "coulombs"
+  si_unit "volt",      :abbrev => "V",   :equals => "W / si_base:A",                       :alias => "volts"
+  si_unit "farad",     :abbrev => "F",   :equals => "C / V",                               :alias => "farads"
+  si_unit "ohm",                         :equals => "V / si_base:A",                       :alias => "ohms"
+  si_unit "siemens",   :abbrev => "S",   :equals => "si_base:A / V"
+  si_unit "weber",     :abbrev => "Wb",  :equals => "V * si_base:s",                       :alias => "webers"
+  si_unit "tesla",     :abbrev => "T",   :equals => "Wb / si_base:m**2",                   :alias => "teslas"
+  si_unit "henry",     :abbrev => "H",   :equals => "Wb / si_base:A",                      :alias => "henries"
+  si_unit "lumen",     :abbrev => "lm",  :equals => "si_base:cd sr",                       :alias => "lumens"
+  si_unit "lux",       :abbrev => "lx",  :equals => "lm / si_base:m**2",                   :alias => "luxen"
+  si_unit "becquerel", :abbrev => "Bq",  :equals => "1 / si_base:s",                       :alias => "becquerels"
+  si_unit "gray",      :abbrev => "Gy",  :equals => "J / si_base:kg",                      :alias => "grays"
+  si_unit "sievert",   :abbrev => "Sv",  :equals => "J / si_base:kg",                      :alias => "sieverts"
+  si_unit "katal",     :abbrev => "kat", :equals => "si_base:mol / si_base:s",             :alias => "katals"
+  si_unit "bar",       :abbrev => "bar", :equals => "100.0 kPa",                           :alias => "bars"
+end

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

@@ -0,0 +1,22 @@
+require 'si/derived'
+
+converter "si_extra" do
+  unit "minute",                   :abbrev => "min", :equals => "60.0 si_base:s",                    :alias => "minutes"
+  unit "hour",                     :abbrev => "h",   :equals => "60.0 min",                          :alias => "hours"
+  unit "day",                      :abbrev => "d",   :equals => "24.0 h",                            :alias => "days"
+  unit "liter",                    :abbrev => "L",   :equals => "si_base:dm**3",                     :alias => "liters"
+  unit "neper",                    :abbrev => "Np",  :equals => "",                                  :alias => "nepers"
+  unit "electronvolt",             :abbrev => "eV",  :equals => "1.60218e-19 si_derived:J",          :alias => "electronvolts"
+  unit "are",                      :abbrev => "a",   :equals => "si_base:dam**2",                    :alias => "ares"
+  unit "hectare",                  :abbrev => "ha",  :equals => "si_base:hm**2",                     :alias => "hectares"
+  unit "barn",                                       :equals => "100.0 si_base:fm**2",               :alias => "barns"
+  unit "curie",                    :abbrev => "Ci",  :equals => "3.7e10 si_derived:Bq",              :alias => "curies"
+  unit "roentgen",                 :abbrev => "R",   :equals => "2.58e-4 si_base:kg",                :alias => "roentgens"
+  unit "metric_ton",               :abbrev => "t",   :equals => "1000.0 si_base:kg",                 :alias => "metric_tons"
+  unit "degree",                                     :equals => "0.0174532925199433 si_derived:rad", :alias => "degrees"
+  unit "nautical_mile",                              :equals => "1852.0 si_base:m",                  :alias => "nautical_miles"
+  unit "knot",                                       :equals => "nautical_mile / h",                 :alias => "knots"
+  unit "angstrom",                                   :equals => "100.0 si_derived:kPa",              :alias => "angstroms"
+  unit "unified_atomic_mass_unit", :abbrev => "u",   :equals => "1.66054e-27 si_base:kg",            :alias => "unified_atomic_mass_units"
+  unit "astronomical_unit",        :abbrev => "ua",  :equals => "1.49598e11 si_base:m",              :alias => "astronomical_units"
+end

data/lib/stick/units/data/uk.rb

@@ -0,0 +1,10 @@
+require 'si/extra'
+require 'uk/base'
+# require 'binary/base'
+converter 'uk' do
+  include 'si_base'
+  include 'si_derived'
+  include 'si_extra'
+  include 'uk_base'
+  # include 'binary_base'
+end

data/lib/stick/units/data/uk/base.rb

@@ -0,0 +1,22 @@
+require 'si/base'
+
+converter 'uk_base' do
+  length_unit "inch", :abbrev => "in", :equals => "2.54 si_base:cm", :alias => "inches"
+  length_unit "foot", :abbrev => "ft", :equals => "12.0 in", :alias => "feet"
+  length_unit "yard", :abbrev => "yd", :equals => "3.0 ft", :alias => "yards"
+  length_unit "chain", :abbrev => nil, :equals => "22.0 yd", :alias => "chains"
+  length_unit "furlong", :abbrev => nil, :equals => "10.0 chains", :alias => "furlongs"
+  length_unit "mile", :abbrev => "mi", :equals => "8.0 furlongs", :alias => "miles"
+  unit        "acre", :abbrev => nil, :equals => "10 square_chain", :alias => "acres"
+  unit        "fluid_ounce", :abbrev => "fl_oz", :equals => "2.8413062e-2 si_base:dm**3", :alias => "fluid_ounces"
+  unit        "gill", :abbrev => nil, :equals => "5.0 fl_oz", :alias => "gills"
+  unit        "pint", :abbrev => "pt", :equals => "4.0 gills", :alias => "pints"
+  unit        "quart", :abbrev => "qt", :equals => "2.0 pt", :alias => "quarts"
+  unit        "gallon", :abbrev => "gal", :equals => "4.0 qt", :alias => "gallons"
+  unit        "grain", :abbrev => "gr", :equals => "6.479891e-5 si_base:kg", :alias => "grains"
+  unit        "ounce", :abbrev => "oz", :equals => "437.5 gr", :alias => "ounces"
+  unit        "pound", :abbrev => "lb", :equals => "16.0 oz", :alias => "pounds"
+  unit        "stone", :abbrev => nil, :equals => "14.0 lb", :alias => "stones"
+  unit        "hundredweight", :abbrev => "cwt", :equals => "8.0 stone", :alias => "hundredweights"
+  unit        "long_ton", :abbrev => "lt", :equals => "20.0 cwt", :alias => "long_tons"
+end

data/lib/stick/units/data/units-default.rb

@@ -0,0 +1,11 @@
+require 'si/extra'
+require 'us/base'
+require 'binary/base'
+
+converter "default" do
+  include 'si_base'
+  include 'si_derived'
+  include 'si_extra'
+  include 'us_base'
+  include 'binary_base'
+end

data/lib/stick/units/data/units-standard.rb

@@ -0,0 +1,5 @@
+require 'units-default'
+require 'uk'
+require 'us'
+require 'si'
+require 'iec'

data/lib/stick/units/data/us.rb

@@ -0,0 +1,10 @@
+require 'si/extra'
+require 'us/base'
+
+converter 'us' do
+  include 'si_base'
+  include 'si_derived'
+  include 'si_extra'
+  include 'us_base'
+  include 'binary_base'
+end

data/lib/stick/units/data/us/base.rb

@@ -0,0 +1,23 @@
+require 'si/base'
+
+converter 'us_base' do
+  length_unit "inch",          :abbrev => "in",    :equals => "2.54 si_base:cm",                :alias => "inches"
+  length_unit "foot",          :abbrev => "ft",    :equals => "12.0 in",                        :alias => "feet"
+  length_unit "yard",          :abbrev => "yd",    :equals => "3.0 ft",                         :alias => "yards"
+  length_unit "furlong",                           :equals => "220.0 yd",                       :alias => "furlongs"
+  length_unit "mile",          :abbrev => "mi",    :equals => "8.0 furlongs",                   :alias => "miles"
+  length_unit "acre",                              :equals => "4840.0 sq_yd",                   :alias => "acres"
+  unit        "section",                           :equals => "1.0 sq_mi",                      :alias => "sections"
+  unit        "township",                          :equals => "36.0 sections",                  :alias => "townships"
+  unit        "fluid_ounce",   :abbrev => "fl_oz", :equals => "2.95735295625e-2 si_base:dm**3", :alias => "fluid_ounces"
+  unit        "gill",                              :equals => "4.0 fl_oz",                      :alias => "gills"
+  unit        "pint",          :abbrev => "pt",    :equals => "4.0 gills",                      :alias => "pints"
+  unit        "quart",         :abbrev => "qt",    :equals => "2.0 pt",                         :alias => "quarts"
+  unit        "gallon",        :abbrev => "gal",   :equals => "4.0 qt",                         :alias => "gallons"
+  unit        "grain",         :abbrev => "gr",    :equals => "6.479891e-5 si_base:kg",         :alias => "grains"
+  unit        "ounce",         :abbrev => "oz",    :equals => "437.5 gr",                       :alias => "ounces"
+  unit        "pound",         :abbrev => "lb",    :equals => "16.0 oz",                        :alias => "pounds"
+  unit        "stone",                             :equals => "14.0 lb",                        :alias => "stones"
+  unit        "hundredweight", :abbrev => "cwt",   :equals => "100.0 lb",                       :alias => "hundredweights"
+  unit        "short_ton",     :abbrev => "st",    :equals => "20.0 cwt",                       :alias => "short_tons"
+end