currency 0.3.3 → 0.4.0

data/lib/currency/money.rb

@@ -1,40 +1,39 @@
-# -*- ruby -*-
-#
-# = Currency::Money
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
 #
 # Represents an amount of money in a particular currency.
 #
 # A Money object stores its value using a scaled Integer representation
 # and a Currency object.
 #
-# TODO:
-# * Need to store a time, so we can use historical FX rates.
+# A Money object also has a time, which is used in conversions
+# against historical exchange rates.
 #
-
-module Currency
-
-  # Use this function instead of Money#new:
-  #
-  #    Currency::Money("12.34", :CAD)
-  #
-  # not
-  #
-  #    Currency::Money.new("12.34", :CAD)
-  #
-  # See Money#new.
-  def self.Money(*opts)
-    Money.new(*opts)
-  end
-
-  class Money
+class Currency::Money
     include Comparable
 
+    @@default_time = nil
+    def self.default_time
+      @@default_time
+    end
+    def self.default_time=(x)
+      @@default_time = x
+    end
+
+    @@empty_hash = { }
+    @@empty_hash.freeze
+
+    #
+    # DO NOT CALL THIS DIRECTLY:
+    #
+    # See Currency.Money() function.
     #
     # Construct a Money value object 
     # from a pre-scaled external representation:
     # where x is a Float, Integer, String, etc.
     #
-    # If a currency is not specified, Currency#default is used.
+    # If a currency is not specified, Currency.default is used.
     #
     #    x.Money_rep(currency) 
     #
@@ -47,63 +46,83 @@ module Currency
     # Because the USD Currency object has a #scale of 100
     #
     # See #Money_rep(currency) mixin.
-    # See Currency#Money() function.
     #
-    def initialize(x, currency = nil)
-      # Xform currency
-      currency = Currency.default if currency.nil?
-      currency = Currency.get(currency) unless currency.kind_of?(Currency)
-
-      # Set ivars
-      @currency = currency;
-      @rep = x.Money_rep(@currency)
-
-      # Handle conversion of "USD 123.45"
-      if @rep.kind_of?(Money)
-        @currency = @rep.currency
-        @rep = @rep.rep
+    def initialize(x, currency = nil, time = nil)
+      opts ||= @@empty_hash
+
+      # Set ivars.
+      currency = ::Currency::Currency.get(currency)
+      @currency = currency
+      @time = time || ::Currency::Money.default_time
+      @time = ::Currency::Money.now if @time == :now
+      if x.kind_of?(String)
+        if currency
+          m = currency.parser_or_default.parse(x, :currency => currency)
+        else
+          m = ::Currency::Parser.default.parse(x)
+        end
+        @currency = m.currency unless @currency
+        @time = m.time if m.time
+        @rep = m.rep
+      else
+        @currency = ::Currency::Currency.default unless @currency
+        @rep = x.Money_rep(@currency)
       end
+
+    end
+
+    # Returns a Time.new
+    # Can be modifed for special purposes.
+    def self.now
+      Time.new
     end
 
     # Compatibility with Money package.
     def self.us_dollar(x)
       self.new(x, :USD)
     end
+
+
     # Compatibility with Money package.
     def cents
       @rep
     end
 
 
-    # Construct from post-scaled internal representation
-    def self.new_rep(r, currency = nil)
-      x = self.new(0, currency)
+    # Construct from post-scaled internal representation.
+    def self.new_rep(r, currency = nil, time = nil)
+      x = self.new(0, currency, time)
       x.set_rep(r)
       x
     end
-    # Construct from post-scaled internal representation
-    # using the same currency.
-    #    x = Currency::Money.new("1.98", :USD)
+
+
+    # Construct from post-scaled internal representation.
+    # using the same currency:
+    #
+    #    x = Currency.Money("1.98", :USD)
     #    x.new_rep(100) => "$1.00 USD"
     #
-    def new_rep(r)
-      x = self.class.new(0, @currency)
+    def new_rep(r, time = nil)
+      time ||= @time
+      x = self.class.new(0, @currency, time)
       x.set_rep(r)
       x
     end
 
-    # Do not call this method directly
+    # Do not call this method directly.
     # CLIENTS SHOULD NEVER CALL set_rep DIRECTLY.
     # You have been warned in ALL CAPS.
-    def set_rep(r)
+    def set_rep(r) # :nodoc:
       r = r.to_i unless r.kind_of?(Integer)
       @rep = r
     end
 
-    # Returns the money representation for the requested currency.
-    def Money_rep(currency)
-      $stderr.puts "@currency != currency (#{@currency.inspect} != #{currency.inspect}" unless @currency == currency
-      @rep
+    # Do not call this method directly.
+    # CLIENTS SHOULD NEVER CALL set_time DIRECTLY.
+    # You have been warned in ALL CAPS.
+    def set_time(time) # :nodoc:
+      @time = time
     end
 
     # Returns the Money representation (usually an Integer).
@@ -116,25 +135,33 @@ module Currency
       @currency
     end
 
+    # Get the Money's time.
+    def time
+      @time
+    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)
+    def convert(currency, time = nil)
+      currency = ::Currency::Currency.default if currency.nil?
+      currency = ::Currency::Currency.get(currency) unless currency.kind_of?(Currency)
       if @currency == currency
         self
       else
-        Exchange.current.convert(self, currency)
+        time = self.time if time == :money
+        Exchange::Rate::Source.current.convert(self, currency, time)
       end
     end
 
+
     # Hash for hash table: both value and currency.
     # See #eql? below.
     def hash
       @rep.hash ^ @currency.hash
     end
 
+
     # True if money values have the same value and currency.
     def eql?(x)
       self.class == x.class && 
@@ -155,7 +182,7 @@ module Currency
       if @currency == x.currency
         @rep <=> x.rep
       else
-        @rep <=> convert(@currency).rep
+        @rep <=> convert(@currency, @time).rep
       end
     end
 
@@ -188,7 +215,7 @@ module Currency
        new_rep(@rep * x)
     end
 
-    #    Money / Money => Number (ratio)
+    #    Money / Money => Float (ratio)
     #    Money / Number => Money
     #
     # Right side must be Money or Number.
@@ -202,7 +229,7 @@ module Currency
       end
     end
 
-    # Formats the Money value as a String.
+    # Formats the Money value as a String using the Currency's Formatter.
     def format(*opt)
       @currency.format(self, *opt)
     end
@@ -240,10 +267,10 @@ module Currency
     end
 
     # Returns the Money's value representation in another currency.
-    def Money_rep(currency)
+    def Money_rep(currency, time = nil)
       # Attempt conversion?
-      if @currency != currency
-	self.convert(currency).rep
+      if @currency != currency || (time && @time != time)
+	self.convert(currency, time).rep
         # raise("Incompatible Currency: #{@currency} != #{currency}")
       else
         @rep
@@ -253,7 +280,7 @@ module Currency
     # Basic inspection, with symbol and currency code.
     # The standard #inspect method is available as #inspect_deep.
     def inspect(*opts)
-      self.format(:with_symbol, :with_currency).inspect
+      self.format(:symbol => true, :code => true)
     end
 
     # How to alias a method defined in an object superclass in a different class:
@@ -263,6 +290,5 @@ module Currency
     #      self.class.superclass.instance_method(:inspect).bind(self).call 
     #    end
 
-  end # class
+end # class
 
-end # module

data/lib/currency/money_helper.rb

@@ -1,12 +1,13 @@
-module ActionView
- module Helpers
-   module MoneyHelper
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+module ActionView::Helpers::MoneyHelper
+     # Creates a suitable HTML element for a Money value field.
      def money_field(object, method, options = {})
        InstanceTag.new(object, method, self).to_input_field_tag("text", options)
      end
-   end
- end
 end
 
 
 ActionView::Base.load_helper(File.dirname(__FILE__))
+

data/lib/currency/parser.rb

@@ -0,0 +1,153 @@
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+
+# This class parses a Money value from a String.
+# Each Currency has a default Parser.
+class Currency::Parser
+
+  # The default Currency to use if no Currency is specified.
+  attr_accessor :currency
+
+  # If true and a parsed string contains a ISO currency code
+  # that is not the same as currency,
+  # #parse() will raise IncompatibleCurrency.
+  # Defaults to false.
+  attr_accessor :enforce_currency
+
+  # The default Time to use if no Time is specified in the string.
+  attr_accessor :time
+
+  @@default = nil
+  # Get the default Formatter.
+  def self.default
+    @@default || self.new
+  end
+
+
+  # Set the default Formatter.
+  def self.default=(x)
+    @@default = x
+  end
+  
+
+  def initialize(opt = { })
+    opt.each_pair{ | k, v | self.send("#{k}=", v) }
+  end
+
+
+  def _parse(str) # :nodoc:
+    x = str
+
+    # Get currency.
+    # puts "str = #{str.inspect}, @currency = #{@currency}"
+
+    md = nil # match data
+
+    # $stderr.puts "'#{x}'.Money_rep(#{self})"
+    
+    # $stderr.puts "x = #{x}"
+    convert_currency = nil
+    # Handle currency code at front of string.
+    if (md = /([A-Z][A-Z][A-Z])/.match(x)) 
+      curr = ::Currency::Currency.get(md[1])
+      x = md.pre_match + md.post_match
+      if @currency && @currency != curr
+        if @enforce_currency
+          raise ::Currency::Exception::IncompatibleCurrency.new("#{str.inspect} #{@currency.code}")
+        end
+        convert_currency = @currency
+      end
+      currency = curr
+    else
+      currency = @currency || ::Currency::Currency.default
+      currency = ::Currency::Currency.get(currency)
+    end
+    
+    # Remove placeholders and symbol.
+    x = x.gsub(/[, ]/, '')
+    symbol = currency.symbol # FIXME
+    x = x.gsub(symbol, '') if symbol
+    
+    # $stderr.puts "x = #{x.inspect}"
+    # Match: whole Currency value.
+    if md = /^([-+]?\d+)\.?$/.match(x)
+      # $stderr.puts "'#{self}'.parse(#{str}) => EXACT"
+      x = ::Currency::Money.new_rep(md[1].to_i * currency.scale, currency, @time)
+      
+      # Match: fractional Currency value.
+    elsif md = /^([-+]?)(\d*)\.(\d+)$/.match(x)
+      sign = md[1]
+      whole = md[2]
+      part = md[3]
+      
+      # $stderr.puts "'#{self}'.parse(#{str}) => DECIMAL (#{sign} #{whole} . #{part})"
+      
+      if part.length != currency.scale
+        
+        # Pad decimal places with additional '0'
+        while part.length < currency.scale_exp
+          part << '0'
+        end
+        
+        # Truncate to Currency's decimal size. 
+        part = part[0 ... currency.scale_exp]
+        
+        # $stderr.puts "  => INEXACT DECIMAL '#{whole}'"
+      end
+      
+      # Put the string back together:
+      #   #{sign}#{whole}#{part}
+      whole = sign + whole + part
+      # $stderr.puts "  => REP = #{whole}"
+      
+      x = whole.to_i
+      
+      x = ::Currency::Money.new_rep(x, currency, @time)
+    else
+      # $stderr.puts "'#{self}'.parse(#{str}) => ??? '#{x}'"
+      #x.to_f.Money_rep(self)
+      raise ::Currency::Exception::InvalidMoneyString.new("#{str.inspect} #{currency} #{x.inspect}")
+    end
+
+    # Do conversion.
+    if convert_currency
+      x = x.convert(convert_currency)
+    end
+
+
+    x
+  end
+
+
+  @@empty_hash = { }
+  @@empty_hash.freeze
+
+  # Parse a Money string in this Currency.
+  #
+  #   "123.45".money       # Using default Currency.
+  #   => $123.45 USD
+  #
+  #   "123.45 USD".money   # Explicit Currency.
+  #   => $123.45 USD
+  #
+  #   "123.45 CAD".money
+  #   => $123.45 CAD
+  #  
+  #   "123.45 CAD".money(:USD)  # Incompatible explicit Currency.
+  #     !!! "123.45 CAD" USD (Currency::Exception::IncompatibleCurrency)
+  #
+  def parse(str, opt = @@empty_hash)
+    prs = self
+
+    unless opt.empty? 
+      prs = prs.clone
+      opt.each_pair{ | k, v | prs.send("#{k}=", v) }
+    end
+    
+    prs._parse(str)
+  end
+
+end # class
+
+

data/test/ar_column_test.rb

@@ -1,4 +1,7 @@
-require 'test/ar_test_base'
+# Copyright (C) 2006-2007 Kurt Stephens <ruby-currency(at)umleta.com>
+# See LICENSE.txt for details.
+
+require 'test/ar_test_core'
 require 'currency'
 
 require 'rubygems'
@@ -8,7 +11,7 @@ require 'currency/active_record'
 
 module Currency
 
-class ArFieldTest < ArTestBase
+class ArFieldTest < ArTestCore
 
   ##################################################
   # Basic CurrenyTest AR::B class
@@ -32,7 +35,7 @@ class ArFieldTest < ArTestBase
 
   class CurrencyColumnTest < AR_B
     set_table_name TABLE_NAME
-    money :amount, :currency_column => true
+    attr_money :amount, :currency_column => true
   end 
 
   ##################################################