currency 0.4.0 → 0.4.1

data/Manifest.txt

@@ -10,6 +10,7 @@ examples/ex1.rb
 examples/xe1.rb
 lib/currency.rb
 lib/currency/active_record.rb
+lib/currency/config.rb
 lib/currency/core_extensions.rb
 lib/currency/currency.rb
 lib/currency/currency/factory.rb
@@ -40,6 +41,7 @@ test/ar_column_test.rb
 test/ar_simple_test.rb
 test/ar_test_base.rb
 test/ar_test_core.rb
+test/config_test.rb
 test/formatter_test.rb
 test/historical_writer_test.rb
 test/macro_test.rb

data/Rakefile

@@ -19,15 +19,15 @@ require 'rubygems'
 require 'hoe'
 
 PKG_Name = 'Currency'
-PKG_DESCRIPTION = %{Currency models currencies, monetary values, foreign exchanges and rates.  
-Pulls live rates from http://xe.com/.
-Supports ActiveRecord.
+PKG_DESCRIPTION = %{Currency models currencies, monetary values, foreign exchanges rates.  
+Pulls live and historical rates from http://xe.com/, http://newyorkfed.org/, http://thefinancials.com/.
+Can store/retrieve historical rate data from database using ActiveRecord.
+Can store/retrieve Money values using ActiveRecord.
 
 For more details, see:
 
-http://currency.rubyforge.org/files/lib/currency_rb.html 
-http://currency.rubyforge.org/files/README.txt
 http://currency.rubyforge.org/
+http://currency.rubyforge.org/files/README.txt
 
 }
 

data/Releases.txt

@@ -1,5 +1,17 @@
 = Currency Release History
 
+== Release 0.4.1: 2007/03/10
+
+Some changes are not backwards-compatible
+
+* Fixed Rate::Source::Xe; site format changed, more robust parser.
+* Added Currency::Config.
+* Support for filtering Float values before casting to Money, based on suggestions for rounding by Steffen Rusitschka.
+* Fixed :allow_nil in ActiveRecord money macro based on fix by Steffen Rusitschka.
+* Fixed package scoping issue in Money.
+* Added support for Formatter#template string
+* Money format template default changed to '#{code}#{code && " "}#{symbol}#{sign}#{whole}#{fraction}'.  THIS MAY BREAK EXISTING CLIENTS.  See http://www.jhall.demon.co.uk/currency/ for rationale.
+
 == Release 0.4.0: 2007/02/21
 
 === MAJOR CHANGES IN THIS RELEASE FOR HISTORICAL RATE DATA

data/lib/currency.rb

@@ -123,6 +123,7 @@ end
 $:.unshift(File.expand_path(File.dirname(__FILE__))) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'currency/currency_version'
+require 'currency/config'
 require 'currency/exception'
 require 'currency/money'
 require 'currency/currency'

data/lib/currency/active_record.rb

@@ -199,9 +199,10 @@ end_eval
 
         money_rep ||= "#{attr_name}_money.rep"
 
+        validate_allow_nil = opts[:allow_nil] ? ', :allow_nil => true' : ''
         validate = "# Validation\n"
-        validate << "\nvalidates_numericality_of :#{attr_name}\n" unless opts[:allow_nil]
-        validate << "\nvalidates_format_of :#{currency_column}, :with => /^[A-Z][A-Z][A-Z]$/\n" if currency_column && ! opts[:allow_nil]
+        validate << "\nvalidates_numericality_of :#{attr_name}#{validate_allow_nil}\n"
+        validate << "\nvalidates_format_of :#{currency_column}, :with => /^[A-Z][A-Z][A-Z]$/#{validate_allow_nil}\n" if currency_column
 
  
         alias_accessor ||= ''

data/lib/currency/config.rb

@@ -0,0 +1,68 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+# The Currency::Config class is responsible for
+# maintaining global configuration for the Currency package.
+#
+class Currency::Config
+  @@default = nil
+
+  # Returns the default Currency::Config object.
+  #
+  # If one is not specfied an instance is
+  # created.  This is a global, not thread-local.
+  def self.default 
+    @@default ||= self.new
+  end
+  
+  # Sets the default Currency::Config object.
+  def self.default=(x)
+    @@default = x
+  end
+  
+  # Returns the current Currency::Config object used during
+  # in the current thread.
+  #
+  # If #current= has not been called and #default= has not been called,
+  # then UndefinedExchange is raised.
+  def self.current
+    Thread.current[:currency_config] ||= self.default || (raise ::Currency::Exception::UndefinedConfig.new("Currency::Config.default not defined"))
+  end
+  
+  # Sets the current Currency::Config object used
+  # in the current thread.
+  def self.current=(x)
+    Thread.current[:currency_config] = x
+  end
+
+  # Clones the current configuration and makes it current
+  # during the execution of a block.  After block completes,
+  # the previous configuration is restored.
+  #
+  #   Currency::Config.configure do | c |
+  #     c.float_ref_filter = Proc.new { | x | x.round }
+  #     "123.448".money.rep == 12345
+  #   end
+  def self.configure(&blk)
+    c_prev = current
+    c_new = self.current = current.clone
+    result = nil
+    begin
+      result = yield c_new
+    ensure
+      self.current = c_prev
+    end
+    result
+  end
+
+  
+  
+  def float_ref_filter
+    @float_ref_filter ||= Proc.new { |x| x }
+  end
+  
+  def float_ref_filter=(x)
+    @float_ref_filter = x
+  end
+end # module
+

data/lib/currency/core_extensions.rb

@@ -24,7 +24,7 @@ end
 class Float 
   # Inexact conversion to Money representation value.
   def Money_rep(currency, time = nil)  
-    Integer(self * currency.scale) 
+    Integer(Currency::Config.current.float_ref_filter.call(self * currency.scale))
   end
 end
 

data/lib/currency/currency_version.rb

@@ -1,5 +1,5 @@
 module Currency
-  CurrencyVersion = '0.4.0'
+  CurrencyVersion = '0.4.1'
 end
 # DO NOT EDIT
 # This file is auto-generated by build scripts.

data/lib/currency/exchange/rate/source/xe.rb

@@ -5,6 +5,8 @@ require 'currency/exchange/rate/source/base'
 
 require 'net/http'
 require 'open-uri'
+# Cant use REXML because of missing </form> tags -- 2007/03/11
+# require 'rexml/document'
 
 # Connects to http://xe.com and parses "XE.com Quick Cross Rates"
 # from home page HTML.
@@ -12,6 +14,8 @@ require 'open-uri'
 # This is for demonstration purposes.
 #
 class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source::Provider
+  class ParserError < ::Currency::Exception::Base; end
+
   # Defines the pivot currency for http://xe.com/.
   PIVOT_CURRENCY = :USD
   
@@ -37,7 +41,7 @@ class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source:
 
   # Returns a cached Hash of rates:
   #
-  #    xe.xe_rates[:USD][:CAD] => 1.0134
+  #    xe.raw_rates[:USD][:CAD] => 1.0134
   #
   def raw_rates
     # Force load of rates
@@ -51,96 +55,67 @@ class Currency::Exchange::Rate::Source::Xe < ::Currency::Exchange::Rate::Source:
   def parse_page_rates(data = nil)
     data = get_page_content unless data
 
-    data = data.split(/[\r\n]/)
-    
-    @rate_timestamp = nil
-
-    # Chomp after
-    until data.empty?
-      line = data.pop
-      break if line =~ /Need More currencies\?/
-    end
-    
-    # Chomp before Quick Cross Rates
-    until data.empty?
-      line = data.shift
-      break if line =~ /XE.com Quick Cross Rates/
-    end
+    @lines = data = data.split(/\n/);
 
-    # Look for date.
-    md = nil
-    until data.empty?
-      line = data.shift
-      break if md = /rates as of (\d\d\d\d)\.(\d\d)\.(\d\d)\s+(\d\d):(\d\d).*GMT/.match(line)
-    end
-    if md
-      yyyy, mm, dd, h, m = md[1].to_i, md[2].to_i, md[3].to_i, md[4].to_i, md[5].to_i
-      @rate_timestamp = Time.gm(yyyy, mm, dd, h, m, 0, 0) rescue nil
-      #$stderr.puts "parsed #{md[0].inspect} => #{yyyy}, #{mm}, #{dd}, #{h}, #{m}"
-      #$stderr.puts "  => #{@rate_timestamp && @rate_timestamp.xmlschema}"
-    end
+    @rate_timestamp = nil
 
-    until data.empty?
-      line = data.shift
-      break if line =~ /Confused about how to use the rates/i
-    end
-    
-    until data.empty?
-      line = data.shift
-      break if line =~ /^\s*<\/tr>/i
-    end
-    # $stderr.puts "#{data[0..4].inspect}"
+    eat_lines_until /More currencies\.\.\.<\/a>/i
+    eat_lines_until /^\s*<tr>/i
+    eat_lines_until /^\s*<tr>/i
     
     # Read first table row to get position for each currency
     currency = [ ]
-    until data.empty?
-      line = data.shift
-      break if line =~ /^\s*<\/tr>/i
-      if md = /<td><IMG .+ ALT="([A-Z][A-Z][A-Z])"/i.match(line) #"
+    eat_lines_until /^\s*<\/tr>/i do 
+      if md = /<td[^>]+?>.*?\/> ([A-Z][A-Z][A-Z])<\/td>/.match(@line)
         cur = md[1].intern
         cur_i = currency.size
         currency.push(cur)
-        # $stderr.puts "Found currency header: #{cur.inspect} at #{cur_i}"
+        $stderr.puts "Found currency header: #{cur.inspect} at #{cur_i}" if @verbose
       end
     end
+    raise ParseError, "Currencies header not found" if currency.empty?
     
-    # $stderr.puts "#{data[0..4].inspect}"
-    
-    # Skip blank <tr>
-    until data.empty?
-      line = data.shift
-      break if line =~ /^\s*<td>.+1.+USD.+=/
-    end
-    
-    until data.empty?
-      line = data.shift
-      break if line =~ /^\s*<\/tr>/i
-    end
-    
-    # $stderr.puts "#{data[0..4].inspect}"
-    
+
+    # Skip until "1 USD ="
+    eat_lines_until /^\s*<td[^>]+?> 1&nbsp;+USD&nbsp;=/
+     
     # Read first row of 1 USD = ...
-    
     rate = { }
-    cur_i = -1
-    until data.empty?
-      line = data.shift
-      break if cur_i < 0 && line =~ /^\s*<\/tr>/i  
-      if md = /<td>\s+(\d+\.\d+)\s+<\/td>/.match(line)
+    cur_i = -1 
+    eat_lines_until /^\s*<\/tr>/i do 
+      if md = /<td[^>]+?>\s*?(\d+\.\d+)\s*?<\/td>/i.match(@line)
         usd_to_cur = md[1].to_f
         cur_i = cur_i + 1
         cur = currency[cur_i]
-        next unless cur
+        raise ParseError, "Currency not found at column #{cur_i}" unless cur
         next if cur.to_s == PIVOT_CURRENCY.to_s
         (rate[PIVOT_CURRENCY] ||= {})[cur] = usd_to_cur
         (rate[cur] ||= { })[PIVOT_CURRENCY] ||= 1.0 / usd_to_cur
         $stderr.puts "#{cur.inspect} => #{usd_to_cur}" if @verbose
       end
     end
+    raise ParseError, "Currency rates not found" if rate.keys.empty?
+    raise ParseError, "Not all rates found" if rate.keys.size != currency.size
     
+    @lines = @line = nil
+
     rate
   end
-  
+
+
+  def eat_lines_until(rx)
+    until @lines.empty?
+      @line = @lines.shift
+      if md = rx.match(@line)
+        $stderr.puts "\nMATCHED #{@line.inspect} WITH #{rx.inspect} AT LINES:\n#{@lines[0..4].inspect}" if @verbose
+        return md
+      end
+      yield @line if block_given?
+    end
+    raise ParseError, rx.inspect
+    false
+  end
+
   
   # Return a list of known base rates.
   def load_rates(time = nil)

data/lib/currency/formatter.rb

@@ -5,6 +5,68 @@
 # This class formats a Money value as a String.
 # Each Currency has a default Formatter.
 class Currency::Formatter
+  # The underlying object for Currency::Formatter#format.
+  # This object is cloned and initialized with strings created
+  # from Formatter#format.
+  # It handles the Formatter#format string interpolation.
+  class Template
+    @@empty_hash = { }
+    @@empty_hash.freeze
+
+    # The template string.
+    attr_accessor :template
+
+    # The Currency::Money object being formatted.
+    attr_accessor :money
+    # The Currency::Currency object being formatted.
+    attr_accessor :currency
+
+    # The sign: '-' or nil.
+    attr_accessor :sign
+    # The whole part of the value, with thousands_separator or nil.
+    attr_accessor :whole
+    # The fraction part of the value, with decimal_separator or nil.
+    attr_accessor :fraction
+    # The currency symbol or nil.
+    attr_accessor :symbol
+    # The currency code or nil.
+    attr_accessor :code
+
+    
+    def initialize(opts = @@empty_hash)
+      opts.each_pair{ | k, v | self.send("#{k}=", v) }
+    end
+
+
+    # Sets the template string and uncaches the template_proc.
+    def template=(x)
+      if @template != x
+        @template_proc = nil
+      end
+      @template = x
+    end
+
+
+    # Defines a the self._format template procedure using
+    # the template as a string to be interpolated.
+    def template_proc(template = @template)
+      return @template_proc if @template_proc
+      @template_proc = template || ''
+      # @template_proc = @template_proc.gsub(/[\\"']/) { | x | "\\" + x }
+      @template_proc = "def self._format; \"#{@template_proc}\"; end"
+      self.instance_eval @template_proc
+      @template_proc
+    end
+
+
+    # Formats the current state using the template.
+    def format
+      template_proc
+      _format
+    end
+  end
+
+
   # Defaults to ','
   attr_accessor :thousands_separator
 
@@ -27,9 +89,14 @@ class Currency::Formatter
   #
   #   Currency::Money(12.45, :EUR).to_s(:html => true; :code => true)
   #   => "&#8364;12.45 <span class=\"currency_code\">EUR</span>"
-
   attr_accessor :html
 
+  # A template string used to format a money value.
+  # Defaults to:
+  # 
+  #   '#{code}#{code && " "}#{symbol}#{sign}#{whole}#{fraction}'
+  attr_accessor :template
+
 
   # If passed true, formats for an input field (i.e.: as a number).
   def as_input_value=(x)
@@ -42,6 +109,7 @@ class Currency::Formatter
       self.code = false
       self.html = false
     end
+    x
   end
 
 
@@ -66,6 +134,7 @@ class Currency::Formatter
     @symbol = true
     @code = false
     @html = false
+    @template = '#{code}#{code && " "}#{symbol}#{sign}#{whole}#{fraction}'
 
     opt.each_pair{ | k, v | self.send("#{k}=", v) }
   end
@@ -76,16 +145,45 @@ class Currency::Formatter
   end
 
 
+  # Sets the template and the Template#template.
+  def template=(x)
+    if @template_object
+      @template_object.template = x
+    end
+    @template = x
+  end
+
+
+  # Returns the Template object.
+  def template_object
+    return @template_object if @template_object
+
+    @template_object = Template.new
+    @template_object.template = @template if @template
+    # $stderr.puts "template.template = #{@template_object.template.inspect}"
+    @template_object.template_proc # pre-cache before clone.
+
+    @template_object
+  end
+
+
   def _format(m, currency = nil) # :nodoc:
     # Get currency.
     currency ||= m.currency
 
+    # Setup template
+    tmpl = self.template_object.clone
+    # $stderr.puts "template.template = #{tmpl.template.inspect}"
+    tmpl.money = m
+    tmpl.currency = currency
+
     # Get scaled integer representation for this Currency.
     # $stderr.puts "m.currency = #{m.currency}, currency => #{currency}"
     x = m.Money_rep(currency)
 
     # Remove sign.
     x = - x if ( neg = x < 0 )
+    tmpl.sign = neg ? '-' : nil
     
     # Convert to String.
     x = x.to_s
@@ -97,9 +195,9 @@ class Currency::Formatter
     
     # Insert decimal place.
     whole = x[0 .. currency.format_left] 
-    decimal = x[currency.format_right .. -1]
+    fraction = x[currency.format_right .. -1]
  
-    # Do commas
+    # Do thousands.
     x = whole
     if @thousands && (@thousands_separator && ! @thousands_separator.empty?)
       x.reverse!
@@ -108,20 +206,20 @@ class Currency::Formatter
       x.reverse!
     end
     
-    x << @decimal_separator + decimal if @cents && @decimal_separator
-    
-    # Put sign back.
-    x = '-' + x if neg
-    
+    # Put whole and fractional parts.
+    tmpl.whole = x
+    tmpl.fraction = @cents && @decimal_separator ? @decimal_separator + fraction : nil
+
+ 
     # Add symbol?
-    x = ((@html && currency.symbol_html) || currency.symbol || '') + x if @symbol
+    tmpl.symbol = @symbol ? ((@html && currency.symbol_html) || currency.symbol) : nil
+
     
     # Suffix with currency code.
-    if @code
-      x << (' ' + _format_Currency(currency))
-    end
+    tmpl.code = @code ? _format_Currency(currency) : nil
     
-    x
+    # Ask template to format the components.
+    tmpl.format
   end
 
 

data/lib/currency/money.rb

@@ -150,7 +150,7 @@ class Currency::Money
         self
       else
         time = self.time if time == :money
-        Exchange::Rate::Source.current.convert(self, currency, time)
+        ::Currency::Exchange::Rate::Source.current.convert(self, currency, time)
       end
     end
 

data/test/config_test.rb

@@ -0,0 +1,36 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+
+require 'test/test_base'
+require 'currency'
+
+module Currency
+
+class ConfigTest < TestBase
+  def setup
+    super
+  end
+
+  ############################################
+  # Simple stuff.
+  #
+
+  def test_config
+    assert_kind_of Money, m = Money.new(1.999)
+    assert_equal 199, m.rep
+
+    Config.configure do | c |
+      c.float_ref_filter = Proc.new { | x | x.round }
+
+      assert_kind_of Money, m = Money.new(1.999)
+      assert_equal 200, m.rep
+    end
+
+  end
+
+end # class
+
+end # module
+
+

data/test/formatter_test.rb

@@ -55,22 +55,22 @@ class FormatterTest < TestBase
   def test_code
     m = test_default
     assert_equal "$1,234,567.89", m.to_s(:code => false)
-    assert_equal "$1,234,567.89 USD", m.to_s(:code => true)
+    assert_equal "USD $1,234,567.89", m.to_s(:code => true)
 
     m
   end
 
   def test_misc
     m = ::Currency::Money(12.45, :USD)
-    assert_equal "$12.45 <span class=\"currency_code\">USD</span>", 
+    assert_equal "<span class=\"currency_code\">USD</span> $12.45", 
     m.to_s(:html => true, :code => true)
 
     m = ::Currency::Money(12.45, :EUR)
-    assert_equal "&#8364;12.45 <span class=\"currency_code\">EUR</span>", 
+    assert_equal "<span class=\"currency_code\">EUR</span> &#8364;12.45", 
     m.to_s(:html => true, :code => true)
 
-    m = ::Currency::Money(12.45, :EUR)
-    assert_equal "&#8364;12.45 <span class=\"currency_code\">EUR</span>", 
+    m = ::Currency::Money(12345.45, :EUR)
+    assert_equal "<span class=\"currency_code\">EUR</span> &#8364;12_345.45", 
     m.to_s(:html => true, :code => true, :thousands_separator => '_')
   end
 

data/test/money_test.rb

@@ -1,3 +1,5 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
 
 
 require 'test/test_base'
@@ -293,7 +295,7 @@ class MoneyTest < TestBase
     assert usd.time == usd2.time
   end
 
-end
+end # class
 
 end # module
 

data/test/test_base.rb

@@ -14,6 +14,9 @@ class TestBase < Test::Unit::TestCase
     super
     @rate_source ||= get_rate_source
     Exchange::Rate::Source.default = @rate_source
+
+    # Force non-historical money values.
+    Money.default_time = nil
   end
 
 
@@ -31,8 +34,8 @@ class TestBase < Test::Unit::TestCase
   # Helpers.
   def assert_equal_float(x, y, eps = 1.0e-8)
     d = (x * eps).abs
-    assert (x - d) <= y
-    assert y <= (x + d)
+    assert((x - d) <= y)
+    assert(y <= (x + d))
   end
 
 end # class

data/test/xe_test.rb

@@ -16,7 +16,9 @@ class XeTest < TestBase
 
   def get_rate_source
     source = Exchange::Rate::Source::Xe.new
+    # source.verbose = true
     deriver = Exchange::Rate::Deriver.new(:source => source)
+    deriver
   end
 
 
@@ -45,7 +47,7 @@ class XeTest < TestBase
 
     assert_kind_of Numeric, m = (eur.to_f / cad.to_f)
     # $stderr.puts "m = #{m}"
-    assert_equal_float (1.0 / usd_cad) * usd_eur, m, 0.001
+    assert_equal_float((1.0 / usd_cad) * usd_eur, m, 0.001)
   end
 
 end

metadata

@@ -3,16 +3,16 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: currency
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2007-02-21 00:00:00 -05:00
-summary: "Currency models currencies, monetary values, foreign exchanges and rates.   Pulls live rates from http://xe.com/. Supports ActiveRecord.  For more details, see:  http://currency.rubyforge.org/files/lib/currency_rb.html  http://currency.rubyforge.org/files/README.txt http://currency.rubyforge.org/"
+  version: 0.4.1
+date: 2007-03-11 00:00:00 -06:00
+summary: "Currency models currencies, monetary values, foreign exchanges rates.   Pulls live and historical rates from http://xe.com/, http://newyorkfed.org/, http://thefinancials.com/. Can store/retrieve historical rate data from database using ActiveRecord. Can store/retrieve Money values using ActiveRecord.  For more details, see:  http://currency.rubyforge.org/ http://currency.rubyforge.org/files/README.txt"
 require_paths: 
 - lib
 - test
 email: ruby-currency@umleta.com
 homepage: http://rubyforge.org/projects/currency
 rubyforge_project: currency
-description: "Currency models currencies, monetary values, foreign exchanges and rates.   Pulls live rates from http://xe.com/. Supports ActiveRecord.  For more details, see:  http://currency.rubyforge.org/files/lib/currency_rb.html  http://currency.rubyforge.org/files/README.txt http://currency.rubyforge.org/"
+description: "Currency models currencies, monetary values, foreign exchanges rates.   Pulls live and historical rates from http://xe.com/, http://newyorkfed.org/, http://thefinancials.com/. Can store/retrieve historical rate data from database using ActiveRecord. Can store/retrieve Money values using ActiveRecord.  For more details, see:  http://currency.rubyforge.org/ http://currency.rubyforge.org/files/README.txt"
 autorequire: 
 default_executable: 
 bindir: bin
@@ -42,6 +42,7 @@ files:
 - examples/xe1.rb
 - lib/currency.rb
 - lib/currency/active_record.rb
+- lib/currency/config.rb
 - lib/currency/core_extensions.rb
 - lib/currency/currency.rb
 - lib/currency/currency/factory.rb
@@ -72,6 +73,7 @@ files:
 - test/ar_simple_test.rb
 - test/ar_test_base.rb
 - test/ar_test_core.rb
+- test/config_test.rb
 - test/formatter_test.rb
 - test/historical_writer_test.rb
 - test/macro_test.rb