currency 0.1.0

data/lib/currency/currency_factory.rb

@@ -0,0 +1,73 @@
+module Currency
+  class CurrencyFactory
+    # Default factory.
+    @@default = nil
+    def self.default
+      @@default ||= CurrencyFactory.new
+    end
+
+    def initialize
+      @currency_by_code = { }
+      @currency_by_symbol = { }
+      @currency = nil
+      @USD = nil    
+      @CAD = nil
+    end
+
+    # Lookup table 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))
+    end
+
+    # Lookup table by symbol
+    def get_by_symbol(symbol)
+      @currency_by_symbol[symbol] ||= load(Currency.new(nil, symbol))
+    end
+
+    def load(currency)
+      # $stderr.puts "BEFORE: load(#{currency.code})"
+
+      # SAMPLE CODE
+      if currency.code == :USD || currency.symbol == '$'
+	# $stderr.puts "load('USD')"
+        currency.code= :USD
+        currency.symbol= '$'
+        currency.scale= 100
+      elsif currency.code == :CAD
+        # $stderr.puts "load('CAD')"
+        currency.symbol= '$'
+        currency.scale= 100
+      else
+        currency.symbol= nil
+        currency.scale= 100
+      end
+  
+      # $stderr.puts "AFTER: load(#{currency.inspect})"
+
+      install(currency)
+    end
+
+    def install(currency)
+      @currency_by_symbol[currency.symbol] ||= currency unless currency.symbol.nil?
+      @currency_by_code[currency.code] = currency
+    end
+
+    # Standard Currencys
+    def USD
+      @USD ||= self.get_by_code(:USD)
+    end
+
+    def CAD
+      @CAD ||= self.get_by_code(:CAD)
+    end
+
+    # Default Currency
+    def currency
+      @currency ||= self.USD
+    end
+  end
+  # END MODULE
+end
+

data/lib/currency/currency_version.rb

@@ -0,0 +1,6 @@
+# DO NOT EDIT
+# This file is auto-generated by build scripts.
+# See:  rake update_version
+module Currency
+  CurrencyVersion = '0.1.0'
+end

data/lib/currency/exception.rb

@@ -0,0 +1,10 @@
+module Currency
+  class InvalidMoneyString < Exception
+  end
+  
+  class InvalidCurrencyCode < Exception
+  end
+  
+  class IncompatibleCurrency < Exception
+  end
+end

data/lib/currency/exchange_rate.rb

@@ -0,0 +1,47 @@
+module Currency
+  # Represents a convertion rate between two currencies
+  class ExchangeRate
+    def initialize(c1, c2, c1_to_c2_rate, source = "UNKNOWN", date = nil, recip = true)
+      @c1 = c1
+      @c2 = c2
+      @rate = c1_to_c2_rate
+      @source = source
+      @date = date || Time.now
+      @reciprocal = recip
+    end
+
+    def c1
+      @c1
+    end
+
+    def c2
+      @c2
+    end
+
+    def rate
+      @rate
+    end
+
+    def source
+      @source
+    end
+
+    def date
+      @date
+    end
+
+    def convert(m, c1)
+      m = m.to_f	
+      if ( @c1 == c1 )
+        # $stderr.puts "Converting #{@c1} #{m} to #{@c2} #{m * @rate} using #{@rate}"
+        m * @rate
+      else
+        # $stderr.puts "Converting #{@c2} #{m} to #{@c1} #{m / @rate} using #{1.0 / @rate}; recip"
+        m / @rate
+      end
+    end
+  end
+
+  # END MODULE
+end
+

data/lib/currency/money.rb

@@ -0,0 +1,190 @@
+module Currency
+
+  # Represents an amount of money in a particular currency.
+  #
+  # NOTE: do we need to store a time, so we can use
+  # historical FX rates to convert?
+  #
+  class Money
+    include Comparable
+
+
+    # Construct from a pre-scaled external representation:
+    # Float, Integer, String, etc.
+    # See #Money_rep(currency) mixin.
+    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
+      end
+    end
+
+    # Compatibility with Money package.
+    def self.us_dollar(x)
+      self.new(x, :USD)
+    end
+    def cents
+      @rep
+    end
+
+
+    # Construct from post-scaled internal representation
+    def self.new_rep(r, currency = nil)
+      x = self.new(0, currency)
+      x.set_rep(r)
+      x
+    end
+    def new_rep(r)
+      x = self.class.new(0, @currency)
+      x.set_rep(r)
+      x
+    end
+
+    # CLIENTS SHOULD NEVER CALL set_rep DIRECTLY!
+    def set_rep(r)
+      r = r.to_i unless r.kind_of?(Integer)
+      @rep = r
+    end
+
+    def Money_rep(currency)
+      $stderr.puts "@currency != currency (#{@currency.inspect} != #{currency.inspect}" unless @currency == currency
+      @rep
+    end
+
+    def rep
+      @rep
+    end
+
+    # Get the money's Currency
+    def currency
+      @currency
+    end
+
+    # Convert Money to another Currency
+    def convert(currency)
+      currency = Currency.default if currency.nil?
+      currency = Currency.get(currency) unless currency.kind_of?(Currency)
+      if @currency == currency
+        self
+      else
+        CurrencyExchange.default.convert(self, currency)
+      end
+    end
+
+    # Relational operations on Money values.
+    def eql?(x)
+      @rep == x.rep && @currency == x.currency
+    end
+
+    def ==(x)
+      @rep == x.rep && @currency == x.currency
+    end
+
+    def <=>(x)
+      if @currency == x.currency
+        @rep <=> x.rep
+      else
+        @rep <=> convert(@currency).rep
+      end
+    end
+
+    # Operations on Money values.
+
+
+    def -@
+      # - Money => Money
+      new_rep(- @rep)
+    end
+
+    # Right side maybe coerced to Money.
+    def +(x)
+      # Money + (Number|Money) => Money
+      new_rep(@rep + x.Money_rep(@currency))
+    end
+
+    # Right side maybe coerced to Money.
+    def -(x)
+      # Money - (Number|Money) => Money
+      new_rep(@rep - x.Money_rep(@currency))
+    end
+
+    # Right side must be number
+    def *(x)
+      # Money * Number => Money
+      new_rep(@rep * x)
+    end
+
+    # Right side must be number or Money
+    def /(x)
+      if x.kind_of?(self.class)
+        # Money / Money => ratio
+        (@rep.to_f) / (x.Money_rep(@currency).to_f)
+      else
+        # Money / Number => Money
+        new_rep(@rep / x)
+      end
+    end
+
+    def format(*opt)
+      @currency.format(self, *opt)
+    end
+
+    # Coercions
+    def to_s(*opt)
+      @currency.format(self, *opt)
+    end
+
+    def to_f
+      Float(@rep) / @currency.scale
+    end
+
+    def to_i
+      @rep / @currency.scale
+    end
+
+    def zero?
+      @rep == 0
+    end
+
+    def positive?
+      @rep > 0
+    end
+    
+    def negative?
+      @rep < 0
+    end
+
+    # Implicit currency conversions?
+    def Money_rep(currency)
+      # Attempt conversion?
+      if @currency != currency
+	self.convert(currency).rep
+        # raise("Incompatible Currency: #{@currency} != #{currency}")
+      else
+        @rep
+      end
+    end
+
+    def inspect(*opts)
+      self.format(:with_symbol, :with_currency).inspect
+    end
+
+    # How to alias a method defined in an object superclass in a different class:
+    define_method(:inspect_deep, Object.instance_method(:inspect))
+    # How call a method defined in a superclass from a method with a different name:
+    #def inspect_deep(*opts)
+    #  self.class.superclass.instance_method(:inspect).bind(self).call 
+    #end
+  end
+
+  # END MODULE
+end

data/lib/currency/money_helper.rb

@@ -0,0 +1,12 @@
+module ActionView
+ module Helpers
+   module MoneyHelper
+     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/scripts/gemdoc.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+Gem.manage_gems
+require 'rubygems/user_interaction'
+
+include Gem::DefaultUserInteraction
+
+$gm = Gem::CommandManager.instance
+
+class CaptureSay
+  attr_reader :string
+  def initialize
+    @string = ''
+  end
+  def say(msg)
+    @string << msg << "\n"
+  end
+end
+
+def pre(cmd, opts)
+  puts "<pre>"
+  cmd.invoke opts
+  puts "</pre>"
+end
+
+def table_of_contents
+  cs = CaptureSay.new
+  use_ui(cs) do
+    $gm['help'].invoke 'commands'
+  end
+    # We're only interested in the lines that actually describe a command.
+  out = cs.string.grep(/^\s+(\w+)\s+(.*)$/).join("\n")
+    # Add a link to the relevant section in the margin.
+  out.gsub(/^\s+(\w+)/) {
+    cmd_name = $1
+    "  [http://currency.rubyforge.org/wiki/wiki.pl?CurrencyReference##{cmd_name} -]  #{cmd_name}"
+  }
+end
+
+while line = gets
+  if line =~ /^!/
+    cmd, arg = line.split
+    case cmd
+    when "!usage"
+      begin
+	cmdobj = $gm[arg]
+	pre(cmdobj, "--help")
+      rescue NoMethodError
+	puts "Usage of command #{arg} failed"
+      end
+    when "!toc"
+      puts table_of_contents()
+    when "!toc-link"
+      puts "\"Table of Contents\":http://currency.rubyforge.org/read/chapter/10#toc"
+    when "!version"
+      puts Gem::RubyGemsPackageVersion
+    end
+  else
+    puts line
+  end
+end

data/test/money_test.rb

@@ -0,0 +1,166 @@
+# REAL
+#require File.dirname(__FILE__) + '/../test_helper'
+
+require 'test/test_base'
+require 'currency' # For :type => :money
+
+module Currency
+
+class MoneyTest < TestBase
+  def setup
+    super
+  end
+
+  ############################################
+  # Simple stuff.
+  #
+
+  def test_create
+   assert_kind_of Money, m = Money.
+      new(1.99)
+
+    m
+  end
+
+  def test_zero
+    m = Money.new(0)
+    assert ! m.negative?
+    assert   m.zero?
+    assert ! m.positive?
+    m
+  end
+
+  def test_negative
+    m = Money.new(-1.00, :USD)
+    assert   m.negative?
+    assert ! m.zero?
+    assert ! m.positive?
+    m
+  end
+
+  def test_positive
+    m = Money.new(2.99, :USD)
+    assert ! m.negative?
+    assert ! m.zero?
+    assert   m.positive?
+    m
+  end
+
+  def test_relational
+    n = test_negative
+    z = test_zero
+    p = test_positive
+
+    assert   (n < p)
+    assert ! (n > p)
+    assert ! (p < n)
+    assert   (p > n)
+    assert   (p != n)
+
+    assert   (z <= z)
+    assert   (z >= z)
+
+    assert   (z <= p)
+    assert   (n <= z)
+    assert   (z >= n)
+
+    assert   n == n
+    assert   p == p
+
+    assert   z == test_zero
+  end
+
+  def test_rep
+    assert_not_nil m = Money.new(123, :USD)
+    assert  m.rep == 12300
+    
+    assert_not_nil m = Money.new(123.45, :USD)
+    assert  m.rep == 12345
+
+    assert_not_nil m = Money.new("123.456", :USD)
+    assert  m.rep == 12345
+  end
+
+  def test_convert
+    assert_not_nil m = Money.new("123.456", :USD)
+    assert  m.rep == 12345
+
+    assert_equal 123, m.to_i
+    assert_equal 123.45, m.to_f
+    assert_equal "$123.45", m.to_s
+  end
+
+  def test_eql
+    assert_not_nil usd = Money.new(123, :USD)
+    assert_not_nil cad = Money.new(123, :CAD)
+
+    assert_equal :USD, usd.currency.code
+    assert_equal :CAD, cad.currency.code
+
+    assert_equal usd.rep, cad.rep
+    assert usd.currency != cad.currency
+
+    assert usd != cad
+    
+  end
+
+  def test_op
+    # Using default load_exchange_rate
+    assert_not_nil usd = Money.new(123.45, :USD)
+    assert_not_nil cad = Money.new(123.45, :CAD)
+
+    # - Money => Money
+    assert_equal -12345, (- usd).rep
+    assert_equal :USD, (- usd).currency.code
+
+    assert_equal -12345, (- cad).rep
+    assert_equal :CAD, (- cad).currency.code
+
+    # Money + Money => Money
+    assert_kind_of Money, m = (usd + usd)
+    assert_equal 24690, m.rep
+    assert_equal :USD, m.currency.code
+
+    assert_kind_of Money, m = (usd + cad)
+    assert_equal 22889, m.rep
+    assert_equal :USD, m.currency.code
+
+    assert_kind_of Money, m = (cad + usd)
+    assert_equal 26798, m.rep
+    assert_equal :CAD, m.currency.code
+
+    # Money - Money => Money
+    assert_kind_of Money, m = (usd - usd)
+    assert_equal 0, m.rep
+    assert_equal :USD, m.currency.code
+
+    assert_kind_of Money, m = (usd - cad)
+    assert_equal 1801, m.rep
+    assert_equal :USD, m.currency.code
+
+    assert_kind_of Money, m = (cad - usd)
+    assert_equal -2108, m.rep
+    assert_equal :CAD, m.currency.code
+
+    # Money * Numeric => Money
+    assert_kind_of Money, m = (usd * 0.5)
+    assert_equal 6172, m.rep
+    assert_equal :USD, m.currency.code
+
+    # Money / Numeric => Money
+    assert_kind_of Money, m = usd / 3
+    assert_equal 4115, m.rep
+    assert_equal :USD, m.currency.code
+
+    # Money / Money => Numeric
+    assert_kind_of Numeric, m = usd / Money.new("41.15", :USD)
+    assert_equal_float 3.0, m
+    
+    assert_kind_of Numeric, m = (usd / cad)
+    assert_equal_float CurrencyExchangeTest.USD_CAD, m, 0.0001
+  end
+
+end
+
+end # module
+