currency 0.3.1 → 0.3.2

data/Rakefile

@@ -7,16 +7,50 @@
 require 'rubygems'
 require 'hoe'
 
+PKG_Name = 'Currency'
+PKG_DESCRIPTION = %{Currency models currencies, monetary values, foreign exchanges.}
+
+#################################################################
+# Release notes
+#
+
+def get_release_notes(relfile = "Releases")
+
+  release = nil
+  notes = [ ]
+
+  File.open(relfile) do |f|
+    while line = f.readline
+      if md = /^== Release ([\d\.]+)/i.match(line)
+        release = md[1]
+        notes << line
+        break
+      end
+    end
+
+    while line = f.readline
+      if md = /^== Release ([\d\.]+)/i.match(line)
+        break
+      end
+      notes << line
+    end
+  end
+
+  [ release, notes.join('') ]
+end
+
 #################################################################
 
-PKG_Name = 'Currency'
 PKG_NAME = PKG_Name.gsub(/[a-z][A-Z]/) {|x| "#{x[0,1]}_#{x[1,1]}"}.downcase
 
-hoe = Hoe.new("currency", '0.3.1') do |p|
+release, release_notes = get_release_notes
+
+hoe = Hoe.new("currency", release) do |p|
   p.author = 'Kurt Stephens'
-  p.description = %{Currency models currencies, monetary values, foreign exchanges.}
+  p.description = PKG_DESCRIPTION
   p.email = "ruby-#{PKG_NAME}@umleta.com"
   p.summary = p.description
+  p.changes = release_notes
   p.url = "http://rubyforge.org/projects/#{PKG_NAME}"
   
   p.test_globs = ['test/**/*.rb']

data/Releases

@@ -1,5 +1,12 @@
 = Currency Release History
 
+== Release 0.3.2: 2006/10/31
+
+* BOO!
+* Fixed Currency.symbol formatting when Currency.symbol.nil?
+* Added expiration of rates in Xe.
+* Added more Money tests.
+
 == Release 0.3.1: 2006/10/31
 
 * Remove debug puts.

data/lib/currency/core_extensions.rb

@@ -1,6 +1,17 @@
+
+
+# External representation mixin
+class Object 
+  # Exact conversion to Money representation value.
+  def money(*opts)
+    Currency::Money(self, *opts)
+  end
+end
+
+
 # External representation mixin
 class Integer 
-  # Exact
+  # Exact conversion to Money representation value.
   def Money_rep(currency)
     Integer(self * currency.scale)
   end
@@ -9,7 +20,7 @@ end
 
 # External representation mixin
 class Float 
-  # Inexact
+  # Inexact conversion to Money representation value.
   def Money_rep(currency)  
     Integer(self * currency.scale) 
   end
@@ -18,7 +29,7 @@ end
 
 # External representation mixin
 class String
-  # Exact
+  # Exact conversion to Money representation value.
   def Money_rep(currency)
     x = currency.parse(self, :currency => currency)
     x.rep if x.kind_of?(Currency::Money)

data/lib/currency/currency.rb

@@ -212,7 +212,7 @@ module Currency
       x = "-" + x if neg
 
       # Add symbol?
-      x = @symbol + x unless opt.include?(:no_symbol)
+      x = (@symbol || '') + x unless opt.include?(:no_symbol)
 
       # Suffix currency code.
       if opt.include?(:with_currency)
@@ -233,6 +233,10 @@ module Currency
     def self.default
       CurrencyFactory.default.currency
     end
+    # Sets the default CurrencyFactory's currency.
+    def self.default=(x)
+      CurrencyFactory.default.currency = x
+    end
 
     # Returns the USD Currency.
     def self.USD

data/lib/currency/currency_factory.rb

@@ -1,12 +1,17 @@
 module Currency
   class CurrencyFactory
-    # Default factory.
     @@default = nil
+
+    # Returns the default CurrencyFactory.
     def self.default
       @@default ||= CurrencyFactory.new
     end
+    # Sets the default CurrencyFactory.
+    def self.default=(x)
+      @@default = x
+    end
 
-    def initialize
+    def initialize(*opts)
       @currency_by_code = { }
       @currency_by_symbol = { }
       @currency = nil
@@ -14,60 +19,82 @@ module Currency
       @CAD = nil
     end
 
-    # Lookup table by code
+    # Lookup Currency by code.
     def get_by_code(x)
-     x = Currency.cast_code(x)
-     # $stderr.puts "get_by_code(#{x})"
-     @currency_by_code[x] ||= load(Currency.new(x))
+      x = Currency.cast_code(x)
+      # $stderr.puts "get_by_code(#{x})"
+      @currency_by_code[x] ||= install(load(Currency.new(x)))
     end
 
-    # Lookup table by symbol
+    # Lookup Currency by symbol.
     def get_by_symbol(symbol)
-      @currency_by_symbol[symbol] ||= load(Currency.new(nil, symbol))
+      @currency_by_symbol[symbol] ||= install(load(Currency.new(nil, symbol)))
     end
 
+    # This method initializes a Currency object as
+    # requested from #get_by_code or #get_by_symbol.
+    #
+    # This method must initialize:
+    #
+    #    currency.code
+    #    currency.symbol
+    #    currency.scale
+    #
+    # Subclasses that provide Currency metadata should override this method.
+    # For example, loading Currency metadata from a database or YAML file.
     def load(currency)
       # $stderr.puts "BEFORE: load(#{currency.code})"
 
-      # SAMPLE CODE
+      # Basic
       if currency.code == :USD || currency.symbol == '$'
 	# $stderr.puts "load('USD')"
-        currency.code= :USD
-        currency.symbol= '$'
-        currency.scale= 100
+        currency.code = :USD
+        currency.symbol = '$'
+        currency.scale = 100
       elsif currency.code == :CAD
         # $stderr.puts "load('CAD')"
-        currency.symbol= '$'
-        currency.scale= 100
+        currency.symbol = '$'
+        currency.scale = 100
       else
-        currency.symbol= nil
-        currency.scale= 100
+        currency.symbol = nil
+        currency.scale = 100
       end
   
       # $stderr.puts "AFTER: load(#{currency.inspect})"
 
-      install(currency)
+      currency
     end
 
+    # Installs a new Currency for #get_by_symbol and #get_by_code.
     def install(currency)
+      raise Exception::UnknownCurrency.new() unless currency
       @currency_by_symbol[currency.symbol] ||= currency unless currency.symbol.nil?
       @currency_by_code[currency.code] = currency
     end
 
-    # Standard Currencys
+    # Standard Currency: US Dollars, :USD.
     def USD
       @USD ||= self.get_by_code(:USD)
     end
 
+    # Standard Currency: Canadian Dollars, :CAD.
     def CAD
       @CAD ||= self.get_by_code(:CAD)
     end
 
-    # Default Currency
+    # Returns the default Currency.
+    # Defaults to self.USD.
     def currency
       @currency ||= self.USD
     end
-  end
-  # END MODULE
-end
+
+    # Sets the default Currency.
+    def currency=(x)
+      @currency = x
+    end
+
+  end # class
+end # module
+
+
 

data/lib/currency/currency_version.rb

@@ -2,5 +2,5 @@
 # This file is auto-generated by build scripts.
 # See:  rake update_version
 module Currency
-  CurrencyVersion = '0.3.1'
+  CurrencyVersion = '0.3.2'
 end

data/lib/currency/exchange/base.rb

@@ -14,11 +14,18 @@ module Exchange
 
   # Represents a method of converting between two currencies
   class Base
+
+    # The name of this Exchange.
     attr_accessor :name
 
+    # If true, this Exchange will log information.
+    attr_accessor :verbose
+    
     def initialize(*opt)
       @name = nil
       @rate = { }
+      opt = Hash[*opt]
+      opt.each{|k,v| self.send(k, v)}
     end 
 
     # Converts Money m in Currency c1 to a new
@@ -34,7 +41,7 @@ module Exchange
 
     # Flush all cached Rate.
     def clear_rates
-      @rate.empty!
+      @rate.clear
     end
 
     # Flush any cached Rate between Currency c1 and c2.
@@ -47,6 +54,10 @@ module Exchange
     #
     # This will call #get_rate(c1, c2) if the
     # Rate has not already been cached.
+    #
+    # Subclasses can override this method to implement
+    # rate expiration rules.
+    #
     def rate(c1, c2)
       (@rate[c1.code.to_s + c2.code.to_s] ||= get_rate(c1, c2)) ||
       (@rate[c2.code.to_s + c1.code.to_s] ||= get_rate(c2, c1))

data/lib/currency/exchange/xe.rb

@@ -9,7 +9,6 @@ module Exchange
 
   class Xe < Base
     @@instance = nil
-
     # Returns a singleton instance.
     def self.instance(*opts)
       @@instance ||= self.new(*opts)
@@ -18,33 +17,118 @@ module Exchange
     # Defaults to "http://xe.com/"
     attr_accessor :uri
 
+    # Defines the number of seconds rates until rates
+    # become invalid, causing a request of new rates.
+    #
+    # Defaults to 600 seconds.
+    attr_accessor :time_to_live
+
+    # Defines the number of random seconds to add before
+    # rates become invalid.
+    #
+    # Defaults to 30 seconds.
+    attr_accessor :time_to_live_fudge
+
     # This Exchange's name is the same as its #uri.
     def name
       uri
     end
 
     def initialize(*opt)
-      super(*opt)
       self.uri = 'http://xe.com/'
-      @rates = nil
+      self.time_to_live = 600
+      self.time_to_live_fudge = 30
+      @xe_rates = nil
+      super(*opt)
+    end
+
+    def clear_rates
+      @xe_rates && @xe_rates.clear
+      super
+    end
+
+    def expired?
+      if @time_to_live &&
+         @xe_rates_renew_time &&
+         (Time.now > @xe_rates_renew_time)
+
+        if @xe_rates 
+          $stderr.puts "#{self}: rates expired on #{@xe_rates_renew_time}" if @verbose
+          
+          @old_rates ||= @xe_rates
+         
+          @xe_rates = nil
+        end
+
+        true
+      else
+        false
+      end
+    end
+
+    # Check expired? before returning a Rate.
+    def rate(c1, c2)
+      if expired?
+        clear_rates
+      end
+      super(c1, c2)
     end
 
     # Returns a cached Hash of rates:
     #
-    #    xe.rates[:USD][:CAD] => 1.01
+    #    xe.xe_rates[:USD][:CAD] => 1.0134
     #
-    def rates
-      return @rates if @rates
+    def xe_rates
+      old_rates = nil
+      # Check expiration.
+      expired?
 
-      @rates = parse_page_rates
-      return @rates unless @rates
+      # Return rates, if cached.
+      return @xe_rates if @xe_rates
 
-      @rates_usd_cur = @rates[:USD]
-      @rate_timestamp = Time.now
+      # Force load of rates
+      @xe_rates = xe_rates_load
+
+      # Flush old rates.
+      @old_rates = nil
+
+      # Update expiration.
+      if time_to_live
+        @xe_rates_renew_time = @rate_timestamp + (time_to_live + (time_to_live_fudge || 0))
+        $stderr.puts "#{self}: rates expire on #{@xe_rates_renew_time}" if @verbose
+      end
+      
+      @xe_rates
+    end
+
+    def xe_rates_load
+      # Do not allow re-entrancy
+      raise "Reentrant!" if @processing_rates
+
+      # Begin processing new rate request.
+      @processing_rates = true
+
+      # Clear cached Rates.
+      clear_rates
+
+      # Parse rates from HTML page.
+      rates = parse_page_rates
       
-      @rates
+      unless rates 
+        # FIXME: raise Exception::???
+        return rates 
+      end
+
+      # Compute new rate timeps
+      @rate_timestamp = Time.now # TODO: Extract this from HTML page!
+
+      # End processsing new rate request.
+      @processing_rates = false
+
+      rates
     end
 
+
     # Returns the URI content.
     def get_page
       data = open(uri) { |data| data.read }
@@ -131,18 +215,22 @@ module Exchange
     # Loads cached rates from xe.com and creates Rate objects
     # for 10 currencies.
     def get_rate(c1, c2)
-      rates # Load rates
+      rates = xe_rates # Load rates
 
       # $stderr.puts "load_exchange_rate(#{c1}, #{c2})"
       rate = 0.0
       r1 = nil
       r2 = nil
 
-      if ( c1.code == :USD && (r2 = @rates_usd_cur[c2.code]) )
+      rates_usd = rates[:USD]
+
+      raise Exception::UnknownRate.new("#{self}: base rate :USD") unless rates_usd
+
+      if ( c1.code == :USD && (r2 = rates_usd[c2.code]) )
         rate = r2
-      elsif ( c2.code == :USD && (r1 = @rates_usd_cur[c2.code]) )
+      elsif ( c2.code == :USD && (r1 = rates_usd[c2.code]) )
         rate = 1.0 / r1
-      elsif ( (r1 = @rates_usd_cur[c1.code]) && (r2 = @rates_usd_cur[c2.code]) )
+      elsif ( (r1 = rates_usd[c1.code]) && (r2 = rates_usd[c2.code]) )
         rate = r2 / r1
       end
 

data/lib/currency/money.rb

@@ -106,17 +106,19 @@ module Currency
       @rep
     end
 
-    # Returns the money representation (usually an Integer).
+    # Returns the Money representation (usually an Integer).
     def rep
       @rep
     end
 
-    # Get the money's Currency.
+    # Get the Money's Currency.
     def currency
       @currency
     end
 
     # Convert Money to another Currency.
+    # currency can be a Symbol or a Currency object.
+    # If currency is nil, the Currency.default is used.
     def convert(currency)
       currency = Currency.default if currency.nil?
       currency = Currency.get(currency) unless currency.kind_of?(Currency)
@@ -147,6 +149,8 @@ module Currency
         @currency == x.currency
     end
 
+    # Compares Money values.
+    # Will convert x currency before comparision.
     def <=>(x)
       if @currency == x.currency
         @rep <=> x.rep
@@ -155,32 +159,31 @@ module Currency
       end
     end
 
-    # Operations on Money values.
-
 
     #   - Money => Money
+    #
     # Negates a Money value.
     def -@
       new_rep(- @rep)
     end
 
-    #    Money + (Number|Money) => Money
+    #    Money + (Money | Number) => Money
     #
-    # Right side maybe coerced to Money.
+    # Right side may be coerced to left side's Currency.
     def +(x)
       new_rep(@rep + x.Money_rep(@currency))
     end
 
-    #    Money - (Number|Money) => Money
+    #    Money - (Money | Number) => Money
     #
-    # Right side maybe coerced to Money.
+    # Right side may be coerced to left side's Currency.
     def -(x)
       new_rep(@rep - x.Money_rep(@currency))
     end
 
     #    Money * Number => Money
     #
-    # Right side must be number.
+    # Right side must be Number.
     def *(x)
        new_rep(@rep * x)
     end
@@ -188,7 +191,7 @@ module Currency
     #    Money / Money => Number (ratio)
     #    Money / Number => Money
     #
-    # Right side must be a number or Money.
+    # Right side must be Money or Number.
     # Right side Integers are not coerced to Float before
     # division.
     def /(x)

data/test/money_test.rb

@@ -16,12 +16,27 @@ class MoneyTest < TestBase
   #
 
   def test_create
-   assert_kind_of Money, m = Money.
-      new(1.99)
+    assert_kind_of Money, m = Money.new(1.99)
+    assert_equal m.currency, Currency.default
+    assert_equal m.currency.code, :USD
 
     m
   end
 
+  def test_object_money_method
+    assert_kind_of Money, m = 1.99.money(:USD)
+    assert_equal m.currency.code, :USD
+    assert_equal m.rep, 199
+
+    assert_kind_of Money, m = 199.money(:CAD)
+    assert_equal m.currency.code, :CAD
+    assert_equal m.rep, 19900
+
+    assert_kind_of Money, m = "13.98".money(:CAD)
+    assert_equal m.currency.code, :CAD
+    assert_equal m.rep, 1398
+  end
+
   def test_zero
     m = Money.new(0)
     assert ! m.negative?
@@ -70,6 +85,20 @@ class MoneyTest < TestBase
     assert   z == test_zero
   end
 
+  def test_compare
+    n = test_negative
+    z = test_zero
+    p = test_positive
+
+    assert (n <=> p) == -1
+    assert (p <=> n) == 1
+    assert (p <=> z) == 1
+
+    assert (n <=> n) == 0
+    assert (z <=> z) == 0
+    assert (p <=> p) == 0    
+  end
+
   def test_rep
     assert_not_nil m = Money.new(123, :USD)
     assert  m.rep == 12300
@@ -91,6 +120,34 @@ class MoneyTest < TestBase
   end
 
   def test_eql
+    assert_not_nil usd1 = Money.new(123, :USD)
+    assert_not_nil usd2 = Money.new("123", :USD)
+
+    assert_equal :USD, usd1.currency.code
+    assert_equal :USD, usd2.currency.code
+    
+    assert_equal usd1.rep, usd2.rep
+
+    assert usd1 == usd2
+
+  end
+
+  def test_not_eql  
+ 
+    assert_not_nil usd1 = Money.new(123, :USD)
+    assert_not_nil usd2 = Money.new("123.01", :USD)
+
+    assert_equal :USD, usd1.currency.code
+    assert_equal :USD, usd2.currency.code
+    
+    assert_not_equal usd1.rep, usd2.rep
+
+    assert usd1 != usd2
+
+    ################
+    # currency !=
+    # rep ==
+
     assert_not_nil usd = Money.new(123, :USD)
     assert_not_nil cad = Money.new(123, :CAD)
 
@@ -101,7 +158,7 @@ class MoneyTest < TestBase
     assert usd.currency != cad.currency
 
     assert usd != cad
-    
+
   end
 
   def test_op

data/test/xe_test.rb

@@ -12,7 +12,7 @@ class XeTest < TestBase
   end
 
   def test_xe_usd_cad
-    assert_not_nil rates = Exchange.default.rates
+    assert_not_nil rates = Exchange.default.xe_rates
     assert_not_nil rates[:USD]
     assert_not_nil usd_cad = rates[:USD][:CAD]
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: currency
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 date: 2006-10-31 00:00:00 -05:00
 summary: Currency models currencies, monetary values, foreign exchanges.
 require_paths: