bai-money 0.5.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/README.markdown

@@ -0,0 +1,87 @@
+This library aids one in handling money and different currencies. Features:
+
+  * Provides a Money class which encapsulates all information about an certain amount of money, such as its value and its currency.
+  * Represents monetary values as integers, in cents. This avoids floating point rounding errors.
+  * Provides APIs for exchanging money from one currency to another.
+  * Has the ability to parse a money string into a Money object.
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Usage
+
+#### Synopsis
+
+    require 'money'
+
+    # 10.00 USD
+    money = Money.new(1000, "USD")
+    money.cents     # => 1000
+    money.currency  # => "USD"
+
+    Money.new(1000, "USD") == Money.new(1000, "USD")   # => true
+    Money.new(1000, "USD") == Money.new(100, "USD")    # => false
+    Money.new(1000, "USD") == Money.new(1000, "EUR")   # => false
+
+#### Currency Exchange
+
+Exchanging money is performed through an exchange bank object. The default exchange bank object requires one to manually specify the exchange rate. Here’s an example of how it works:
+
+    Money.add_rate("USD", "CAD", 1.24515)
+    Money.add_rate("CAD", "USD", 0.803115)
+
+    Money.new(100, "USD").exchange_to("CAD")  # => Money.new(124, "CAD")
+    Money.new(100, "CAD").exchange_to("USD")  # => Money.new(80, "USD")
+
+Comparison and arithmetic operations work as expected:
+
+    Money.new(1000, "USD") <=> Money.new(900, "USD")   # => 1; 9.00 USD is smaller
+    Money.new(1000, "EUR") + Money.new(10, "EUR") == Money.new(1010, "EUR")
+
+    Money.add_rate("USD", "EUR", 0.5)
+    Money.new(1000, "EUR") + Money.new(1000, "USD") == Money.new(1500, "EUR")
+
+There is nothing stopping you from creating bank objects which scrapes www.xe.com for the current rates or just returns rand(2):
+
+    Money.default_bank = ExchangeBankWhichScrapesXeDotCom.new
+
+#### Ruby on Rails
+
+Use the compose_of helper to let Active Record deal with embedding the money object in your models. The following example requires a cents and a currency field.
+
+    class ProductUnit < ActiveRecord::Base
+      belongs_to :product
+      composed_of :price, :class_name => "Money", :mapping => [%w(cents cents), %w(currency currency)]
+
+      private
+        validate :cents_not_zero
+
+        def cents_not_zero
+          errors.add("cents", "cannot be zero or less") unless cents > 0
+        end
+
+        validates_presence_of :sku, :currency
+        validates_uniqueness_of :sku
+    end
+
+#### Default Currency
+
+By default Money defaults to USD as its currency. This can be overwritten using
+
+    Money.default_currency = "CAD"
+
+If you use Rails, then initializer is a very good place to put this.
+
+### Credits & License
+
+Highly based on:
+
+  * http://github.com/FooBarWidget/money
+  * http://github.com/collectiveidea/money
+
+This library inherits license of FooBarWidget-money.

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/money.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+require 'money/money'
+require 'money/symbols'
+require 'money/core_extensions'

data/lib/money/core_extensions.rb

@@ -0,0 +1,136 @@
+class Numeric
+  # Converts this numeric to a Money object in the default currency. It
+  # multiplies the numeric value by 100 and treats that as cents.
+  #
+  #   100.to_money => #<Money @cents=10000>
+  #   100.37.to_money => #<Money @cents=10037>
+  def to_money
+    Money.new(self * 100)
+  end
+end
+
+class String
+  # Parses the current string and converts it to a Money object.
+  # Excess characters will be discarded.
+  #
+  #   '100'.to_money       # => #<Money @cents=10000>
+  #   '100.37'.to_money    # => #<Money @cents=10037>
+  #   '100 USD'.to_money   # => #<Money @cents=10000, @currency="USD">
+  #   'USD 100'.to_money   # => #<Money @cents=10000, @currency="USD">
+  #   '$100 USD'.to_money  # => #<Money @cents=10000, @currency="USD">
+  #   'hello 2000 world'.to_money   # => #<Money @cents=200000 @currency="USD")>
+  def to_money
+    # Get the currency.
+    matches = scan /([A-Z]{2,3})/
+    currency = matches[0] ? matches[0][0] : Money.default_currency
+    cents = calculate_cents(self)
+    Money.new(cents, currency)
+  end
+
+  private
+    def calculate_cents(number)
+      # remove anything that's not a number, potential delimiter, or minus sign
+      num = number.gsub(/[^\d|\.|,|\'|\s|\-]/, '').strip
+
+      # set a boolean flag for if the number is negative or not
+      negative = num.split(//).first == "-"
+
+      # if negative, remove the minus sign from the number
+      num = num.gsub(/^-/, '') if negative
+
+      # gather all separators within the result number
+      used_separators = num.scan /[^\d]/
+
+      # determine the number of unique separators within the number
+      #
+      # e.g.
+      # $1,234,567.89 would return 2 (, and .)
+      # $125,00 would return 1
+      # $199 would return 0
+      # $1 234,567.89 would raise an error (separators are space, comma, and period)
+      case used_separators.uniq.length
+      # no separator or delimiter; major (dollars) is the number, and minor (cents) is 0
+      when 0 then major, minor = num, 0
+
+      # two separators, so we know the last item in this array is the
+      # major/minor delimiter and the rest are separators
+      when 2
+        separator, delimiter = used_separators.uniq
+        # remove all separators, split on the delimiter
+        major, minor = num.gsub(separator, '').split(delimiter)
+        min = 0 unless min
+      when 1
+        # we can't determine if the comma or period is supposed to be a separator or a delimiter
+        # e.g.
+        # 1,00 - comma is a delimiter
+        # 1.000 - period is a delimiter
+        # 1,000 - comma is a separator
+        # 1,000,000 - comma is a separator
+        # 10000,00 - comma is a delimiter
+        # 1000,000 - comma is a delimiter
+
+        # assign first separator for reusability
+        separator = used_separators.first
+
+        # separator is used as a separator when there are multiple instances, always
+        if num.scan(separator).length > 1 # multiple matches; treat as separator
+          major, minor = num.gsub(separator, ''), 0
+        else
+          # ex: 1,000 - 1.0000 - 10001.000
+          # split number into possible major (dollars) and minor (cents) values
+          possible_major, possible_minor = num.split(separator)
+          possible_major ||= "0"
+          possible_minor ||= "00"
+
+          # if the minor (cents) length isn't 3, assign major/minor from the possibles
+          # e.g.
+          #   1,00 => 1.00
+          #   1.0000 => 1.00
+          #   1.2 => 1.20
+          if possible_minor.length != 3 # delimiter
+            major, minor = possible_major, possible_minor
+          else
+            # minor length is three
+            # let's try to figure out intent of the delimiter
+
+            # the major length is greater than three, which means
+            # the comma or period is used as a delimiter
+            # e.g.
+            #   1000,000
+            #   100000,000
+            if possible_major.length > 3
+              major, minor = possible_major, possible_minor
+            else
+              # number is in format ###{sep}### or ##{sep}### or #{sep}###
+              # handle as , is sep, . is delimiter
+              if separator == '.'
+                major, minor = possible_major, possible_minor
+              else
+                major, minor = "#{possible_major}#{possible_minor}", 0
+              end
+            end
+          end
+        end
+      else
+        raise ArgumentError, "Invalid currency amount"
+      end
+
+      # build the string based on major/minor since separator/delimiters have been removed
+      # avoiding floating point arithmetic here to ensure accuracy
+      cents = (major.to_i * 100)
+      # add the minor number as well. this may have any number of digits,
+      # so we treat minor as a string and truncate or right-fill it with zeroes
+      # until it becomes a two-digit number string, which we add to cents.
+      minor = minor.to_s
+      truncated_minor = minor[0..1]
+      truncated_minor << "0" * (2 - truncated_minor.size) if truncated_minor.size < 2
+      cents += truncated_minor.to_i
+      # respect rounding rules
+      if minor.size >= 3 && minor[2..2].to_i >= 5
+        cents += 1
+      end
+
+      # if negative, multiply by -1; otherwise, return positive cents
+      negative ? cents * -1 : cents
+    end
+end

data/lib/money/errors.rb

@@ -0,0 +1,4 @@
+class Money
+  class UnknownRate < StandardError # :nodoc:
+  end
+end

data/lib/money/money.rb

@@ -0,0 +1,252 @@
+require 'money/variable_exchange_bank'
+
+# Represents an amount of money in a certain currency.
+class Money
+  include Comparable
+
+  attr_reader :cents, :currency, :bank
+
+  class << self
+    # Each Money object is associated to a bank object, which is responsible
+    # for currency exchange. This property allows one to specify the default
+    # bank object.
+    #
+    #   bank1 = MyBank.new
+    #   bank2 = MyOtherBank.new
+    #
+    #   Money.default_bank = bank1
+    #   money1 = Money.new(10)
+    #   money1.bank  # => bank1
+    #
+    #   Money.default_bank = bank2
+    #   money2 = Money.new(10)
+    #   money2.bank  # => bank2
+    #   money1.bank  # => bank1
+    #
+    # The default value for this property is an instance if VariableExchangeBank.
+    # It allows one to specify custom exchange rates:
+    #
+    #   Money.default_bank.add_rate("USD", "CAD", 1.24515)
+    #   Money.default_bank.add_rate("CAD", "USD", 0.803115)
+    #   Money.new(100, "USD").exchange_to("CAD")  # => Money.new(124, "CAD")
+    #   Money.new(100, "CAD").exchange_to("USD")  # => Money.new(80, "USD")
+    attr_accessor :default_bank
+
+    # The default currency, which is used when <tt>Money.new</tt> is called
+    # without an explicit currency argument. The default value is "USD".
+    attr_accessor :default_currency
+  end
+
+  self.default_bank = VariableExchangeBank.instance
+  self.default_currency = "USD"
+
+  # Create a new money object with value 0.
+  def self.empty(currency = default_currency)
+    Money.new(0, currency)
+  end
+
+  def self.add_rate(from_currency, to_currency, rate)
+    Money.default_bank.add_rate(from_currency, to_currency, rate)
+  end
+
+  # Creates a new money object.
+  #  Money.new(100)
+  #
+  # Alternativly you can use the convinience methods like
+  # Money.ca_dollar and Money.us_dollar
+  def initialize(cents, currency = Money.default_currency, bank = Money.default_bank)
+    @cents = cents.round
+    @currency = currency
+    @bank = bank
+  end
+
+  # Do two money objects equal? Only works if both objects are of the same currency
+  def ==(other_money)
+    cents == other_money.cents && bank.same_currency?(currency, other_money.currency)
+  end
+
+  def <=>(other_money)
+    if bank.same_currency?(currency, other_money.currency)
+      cents <=> other_money.cents
+    else
+      cents <=> other_money.exchange_to(currency).cents
+    end
+  end
+
+  def +(other_money)
+    if currency == other_money.currency
+      Money.new(cents + other_money.cents, other_money.currency)
+    else
+      Money.new(cents + other_money.exchange_to(currency).cents,currency)
+    end
+  end
+
+  def -(other_money)
+    if currency == other_money.currency
+      Money.new(cents - other_money.cents, other_money.currency)
+    else
+      Money.new(cents - other_money.exchange_to(currency).cents, currency)
+    end
+  end
+
+  # Get the cents value of the object
+  def cents
+    @cents
+  end
+
+  # Multiply money by fixnum
+  def *(fixnum)
+    Money.new(cents * fixnum, currency)
+  end
+
+  # Divide money by fixnum
+  def /(fixnum)
+    Money.new(cents / fixnum, currency)
+  end
+
+  # Test if the money amount is zero
+  def zero?
+    cents == 0
+  end
+
+  # Creates a formatted price string according to several rules. The following
+  # options are supported: :display_free, :with_currency, :no_cents, :symbol
+  # and :html.
+  #
+  # === +:display_free+
+  #
+  # Whether a zero amount of money should be formatted of "free" or as the
+  # supplied string.
+  #
+  #  Money.us_dollar(0).format(:display_free => true)      => "free"
+  #  Money.us_dollar(0).format(:display_free => "gratis")  => "gratis"
+  #  Money.us_dollar(0).format => "$0.00"
+  #
+  # === +:with_currency+
+  #
+  # Whether the currency name should be appended to the result string.
+  #
+  #  Money.ca_dollar(100).format => "$1.00"
+  #  Money.ca_dollar(100).format(:with_currency => true) => "$1.00 CAD"
+  #  Money.us_dollar(85).format(:with_currency => true)  => "$0.85 USD"
+  #
+  # === +:no_cents+
+  #
+  # Whether cents should be omitted.
+  #
+  #  Money.ca_dollar(100).format(:no_cents => true) => "$1"
+  #  Money.ca_dollar(599).format(:no_cents => true) => "$5"
+  #
+  #  Money.ca_dollar(570).format(:no_cents => true, :with_currency => true) => "$5 CAD"
+  #  Money.ca_dollar(39000).format(:no_cents => true) => "$390"
+  #
+  # === +:symbol+
+  #
+  # Whether a money symbol should be prepended to the result string. The default is true.
+  # This method attempts to pick a symbol that's suitable for the given currency.
+  #
+  #  Money.new(100, :currency => "USD")  => "$1.00"
+  #  Money.new(100, :currency => "GBP")  => "£1.00"
+  #  Money.new(100, :currency => "EUR")  => "€1.00"
+  #
+  #  # Same thing.
+  #  Money.new(100, :currency => "USD").format(:symbol => true)  => "$1.00"
+  #  Money.new(100, :currency => "GBP").format(:symbol => true)  => "£1.00"
+  #  Money.new(100, :currency => "EUR").format(:symbol => true)  => "€1.00"
+  #
+  # You can specify a false expression or an empty string to disable prepending
+  # a money symbol:
+  #
+  #  Money.new(100, :currency => "USD").format(:symbol => false)  => "1.00"
+  #  Money.new(100, :currency => "GBP").format(:symbol => nil)    => "1.00"
+  #  Money.new(100, :currency => "EUR").format(:symbol => "")     => "1.00"
+  #
+  #
+  # If the symbol for the given currency isn't known, then it will default
+  # to "$" as symbol:
+  #
+  #  Money.new(100, :currency => "AWG").format(:symbol => true)  => "$1.00"
+  #
+  # You can specify a string as value to enforce using a particular symbol:
+  #
+  #  Money.new(100, :currency => "AWG").format(:symbol => "ƒ")   => "ƒ1.00"
+  #
+  # === +:html+
+  #
+  # Whether the currency should be HTML-formatted. Only useful in combination with +:with_currency+.
+  #
+  #  Money.ca_dollar(570).format(:html => true, :with_currency => true)
+  #    =>  "$5.70 <span class=\"currency\">CAD</span>"
+  def format(*rules)
+    # support for old format parameters
+    rules = normalize_formatting_rules(rules)
+
+    if cents == 0
+      if rules[:display_free].respond_to?(:to_str)
+        return rules[:display_free]
+      elsif rules[:display_free]
+        return "free"
+      end
+    end
+
+    if rules.has_key?(:symbol)
+      if rules[:symbol] === true
+        symbol = SYMBOLS[currency[:currency]] || "$"
+      elsif rules[:symbol]
+        symbol = rules[:symbol]
+      else
+        symbol = ""
+      end
+    else
+      symbol = "$"
+    end
+
+    if rules[:no_cents]
+      formatted = sprintf("#{symbol}%d", cents.to_f / 100)
+    else
+      formatted = sprintf("#{symbol}%.2f", cents.to_f / 100)
+    end
+
+    # Commify ("10000" => "10,000")
+    formatted.gsub!(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/,'\1,\2')
+
+    if rules[:with_currency]
+      formatted << " "
+      formatted << '<span class="currency">' if rules[:html]
+      formatted << currency
+      formatted << '</span>' if rules[:html]
+    end
+    formatted
+  end
+
+  # Returns the amount of money as a string.
+  #
+  #  Money.ca_dollar(100).to_s => "1.00"
+  def to_s
+    sprintf("%.2f", cents / 100.00)
+  end
+
+  # Recieve the amount of this money object in another currency.
+  def exchange_to(other_currency)
+    Money.new(@bank.exchange(self.cents, currency, other_currency), other_currency)
+  end
+
+  # Conversation to self
+  def to_money
+    self
+  end
+
+  private
+    def normalize_formatting_rules(rules)
+      if rules.size == 1
+        rules = rules.pop
+        rules = { rules => true } if rules.is_a?(Symbol)
+      else
+        rules = rules.inject({}) do |h,s|
+          h[s] = true
+          h
+        end
+      end
+      rules
+    end
+end

data/lib/money/symbols.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+# Add more from http://www.xe.com/symbols.php
+Money::SYMBOLS = {
+  "GBP" => "£",
+  "JPY" => "¥",
+  "EUR" => "€",
+  "ZWD" => "Z$",
+  "CNY" => "¥",
+  "INR" => "₨",
+  "NPR" => "₨",
+  "SCR" => "₨",
+  "LKR" => "₨",
+  "SEK" => "kr",
+  "GHC" => "¢"
+
+  # Everything else defaults to $
+}

data/lib/money/variable_exchange_bank.rb

@@ -0,0 +1,72 @@
+require 'thread'
+require 'money/errors'
+
+# Class for aiding in exchanging money between different currencies.
+# By default, the Money class uses an object of this class (accessible through
+# Money#bank) for performing currency exchanges.
+#
+# By default, VariableExchangeBank has no knowledge about conversion rates.
+# One must manually specify them with +add_rate+, after which one can perform
+# exchanges with +exchange+. For example:
+#
+#  bank = Money::VariableExchangeBank.new
+#  bank.add_rate("USD", "CAD", 1.24515)
+#  bank.add_rate("CAD", "USD", 0.803115)
+#
+#  # Exchange 100 CAD to USD:
+#  bank.exchange(100_00, "CAD", "USD")  # => 124
+#  # Exchange 100 USD to CAD:
+#  bank.exchange(100_00, "USD", "CAD")  # => 80
+class Money
+  class VariableExchangeBank
+    # Returns the singleton instance of VariableExchangeBank.
+    #
+    # By default, <tt>Money.default_bank</tt> returns the same object.
+    def self.instance
+      @@singleton
+    end
+
+    def initialize
+      @rates = {}
+      @mutex = Mutex.new
+    end
+
+    # Registers a conversion rate. +from+ and +to+ are both currency names.
+    def add_rate(from, to, rate)
+      @mutex.synchronize do
+        @rates["#{from}_TO_#{to}".upcase] = rate
+      end
+    end
+
+    # Gets the rate for exchanging the currency named +from+ to the currency
+    # named +to+. Returns nil if the rate is unknown.
+    def get_rate(from, to)
+      @mutex.synchronize do
+        @rates["#{from}_TO_#{to}".upcase]
+      end
+    end
+
+    # Given two currency names, checks whether they're both the same currency.
+    #
+    #   bank = VariableExchangeBank.new
+    #   bank.same_currency?("usd", "USD")   # => true
+    #   bank.same_currency?("usd", "EUR")   # => false
+    def same_currency?(currency1, currency2)
+      currency1.upcase == currency2.upcase
+    end
+
+    # Exchange the given amount of cents in +from_currency+ to +to_currency+.
+    # Returns the amount of cents in +to_currency+ as an integer, rounded down.
+    #
+    # If the conversion rate is unknown, then Money::UnknownRate will be raised.
+    def exchange(cents, from_currency, to_currency)
+      rate = get_rate(from_currency, to_currency)
+      if !rate
+        raise Money::UnknownRate, "No conversion rate known for '#{from_currency}' -> '#{to_currency}'"
+      end
+      (cents * rate).floor
+    end
+
+    @@singleton = VariableExchangeBank.new
+  end
+end

data/money.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{money}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["beawesomeinstead"]
+  s.date = %q{2009-08-04}
+  s.description = %q{Library for dealing with money and currency conversion.}
+  s.email = %q{beawesomeinstead@yahoo.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "VERSION",
+     "lib/money.rb",
+     "lib/money/core_extensions.rb",
+     "lib/money/errors.rb",
+     "lib/money/money.rb",
+     "lib/money/symbols.rb",
+     "lib/money/variable_exchange_bank.rb",
+     "money.gemspec",
+     "rakefile",
+     "test/core_extensions_test.rb",
+     "test/money_test.rb",
+     "test/test_helper.rb",
+     "test/variable_exchange_bank_test.rb"
+  ]
+  s.homepage = %q{http://github.com/bai/money}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Library for dealing with money and currency conversion.}
+  s.test_files = [
+    "test/variable_exchange_bank_test.rb",
+     "test/money_test.rb",
+     "test/test_helper.rb",
+     "test/core_extensions_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "money"
+    gem.summary = %Q{Library for dealing with money and currency conversion.}
+    gem.description = %Q{Library for dealing with money and currency conversion.}
+    gem.email = "beawesomeinstead@yahoo.com"
+    gem.homepage = "http://github.com/bai/money"
+    gem.authors = ["beawesomeinstead"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  elsif File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "money #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/test/core_extensions_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+class CoreExtensionsTest < Test::Unit::TestCase
+  context "Money core extensions" do
+    should "transform Numberic to Money with Numberic#to_money" do
+      money = 1234.to_money
+      assert_equal 1234_00, money.cents
+      assert_equal Money.default_currency, money.currency
+
+      money = 100.37.to_money
+      assert_equal 100_37, money.cents
+      assert_equal Money.default_currency, money.currency
+    end
+
+    should "transform String to Money with String#to_money" do
+      assert_equal Money.new(20_15), "20.15".to_money
+      assert_equal Money.new(100_00), "100".to_money
+      assert_equal Money.new(100_37), "100.37".to_money
+      assert_equal Money.new(100_37), "100,37".to_money
+      assert_equal Money.new(100_000_00), "100 000".to_money
+      assert_equal Money.new(100_000_00), "100,000.00".to_money
+      assert_equal Money.new(1_000_00), "1,000".to_money
+      assert_equal Money.new(-1_000_00), "-1,000".to_money
+      assert_equal Money.new(1_000_50), "1,000.5".to_money
+      assert_equal Money.new(1_000_51), "1,000.51".to_money
+      assert_equal Money.new(1_000_51), "1,000.505".to_money
+      assert_equal Money.new(1_000_50), "1,000.504".to_money
+      assert_equal Money.new(1_000_00), "1,000.0000".to_money
+      assert_equal Money.new(1_000_50), "1,000.5000".to_money
+      assert_equal Money.new(1_000_51), "1,000.5099".to_money
+      assert_equal Money.new(1_55), "1.550".to_money
+      assert_equal Money.new(25_00), "25.".to_money
+      assert_equal Money.new(75), ".75".to_money
+      
+      assert_equal Money.new(100_00, "USD"), "100 USD".to_money
+      assert_equal Money.new(-100_00, "USD"), "-100 USD".to_money
+      assert_equal Money.new(100_00, "EUR"), "100 EUR".to_money
+      assert_equal Money.new(100_37, "EUR"), "100.37 EUR".to_money
+      assert_equal Money.new(100_37, "EUR"), "100,37 EUR".to_money
+      assert_equal Money.new(100_000_00, "USD"), "100,000.00 USD".to_money
+      assert_equal Money.new(100_000_00, "EUR"), "100.000,00 EUR".to_money
+      assert_equal Money.new(1_000_00, "USD"), "1,000 USD".to_money
+      assert_equal Money.new(-1_000_00, "USD"), "-1,000 USD".to_money
+      assert_equal Money.new(1_000_55, "USD"), "1,000.5500 USD".to_money
+      assert_equal Money.new(-1_000_65, "USD"), "-1,000.6500 USD".to_money
+      assert_equal Money.new(1_55, "USD"), "1.550 USD".to_money
+
+      assert_equal Money.new(100_00, "USD"), "USD 100".to_money
+      assert_equal Money.new(100_00, "EUR"), "EUR 100".to_money
+      assert_equal Money.new(100_37, "EUR"), "EUR 100.37".to_money
+      assert_equal Money.new(-100_37, "CAD"), "CAD -100.37".to_money
+      assert_equal Money.new(100_37, "EUR"), "EUR 100,37".to_money
+      assert_equal Money.new(-100_37, "EUR"), "EUR -100,37".to_money
+      assert_equal Money.new(100_000_00, "USD"), "USD 100,000.00".to_money
+      assert_equal Money.new(100_000_00, "EUR"), "EUR 100.000,00".to_money
+      assert_equal Money.new(1_000_00, "USD"), "USD 1,000".to_money
+      assert_equal Money.new(-1_000_00, "USD"), "USD -1,000".to_money
+      assert_equal Money.new(1_000_90, "USD"), "USD 1,000.9000".to_money
+      assert_equal Money.new(-1_000_09, "USD"), "USD -1,000.090".to_money
+      assert_equal Money.new(1_55, "USD"), "USD 1.5500".to_money
+
+      assert_equal Money.new(100_00, "USD"), "$100 USD".to_money
+      assert_equal Money.new(1_194_59, "USD"), "$1,194.59 USD".to_money
+      assert_equal Money.new(-1_955_00, "USD"), "$-1,955 USD".to_money
+      assert_equal Money.new(1_194_59, "USD"), "$1,194.5900 USD".to_money
+      assert_equal Money.new(-1_955_00, "USD"), "$-1,955.000 USD".to_money
+      assert_equal Money.new(1_99, "USD"), "$1.99000 USD".to_money
+    end
+
+    should "ignore unrecognized data" do
+      assert_equal Money.new(2000_00), "hello 2000 world".to_money
+    end
+  end
+end

data/test/money_test.rb

@@ -0,0 +1,215 @@
+require 'test_helper'
+
+class MoneyTest < Test::Unit::TestCase
+  context "Money" do
+    should "be associated to the singleton instance of VariableExchangeBank by default" do
+      money_bank_object_id    = Money.new(0).bank.object_id
+      bank_instance_object_id = Money::VariableExchangeBank.instance.object_id
+      assert_equal bank_instance_object_id, money_bank_object_id
+    end
+
+    should "round the given cents to an integer" do
+      assert_equal 1, Money.new(1.00, "USD").cents
+      assert_equal 1, Money.new(1.01, "USD").cents
+      assert_equal 2, Money.new(1.50, "USD").cents
+    end
+
+    should "have 0 cents of default currency when created with Money.empty" do
+      assert_equal Money.new(0), Money.empty
+    end
+
+    should "add new currency rates" do
+      Money.add_rate("EUR", "USD", 10)
+
+      assert_equal Money.new(100_00, "USD"), Money.new(10_00, "EUR").exchange_to("USD")
+    end
+
+    should "return the amount of cents passed to the constructor with #cents" do
+      assert_equal 200_00, Money.new(200_00, "USD").cents
+    end
+
+    should "return the currency passed to the constructor with #currency" do
+      assert_equal "USD", Money.new(200_00, "USD").currency
+    end
+
+    should "return whether the amount is 0 with #zero?" do
+      assert_equal true, Money.new(0, "USD").zero?
+      assert_equal true, Money.new(0, "EUR").zero?
+      assert_equal false, Money.new(1, "USD").zero?
+      assert_equal false, Money.new(10, "YEN").zero?
+      assert_equal false, Money.new(-1, "EUR").zero?
+    end
+
+    should "exchange the amount via its exchange bank and do it properly with #exchange_to" do
+      Money.add_rate("USD", "EUR", 10)
+
+      money = Money.new(100_00, "USD")
+      assert_equal Money.new(1000_00, "EUR"), money.exchange_to("EUR")
+    end
+
+    should "return true if and only if their amount and currency are equal with #==" do
+      assert_equal Money.new(1_00, "USD"), Money.new(1_00, "USD")
+      assert_not_equal Money.new(1_00, "USD"), Money.new(1_00, "EUR")
+      assert_not_equal Money.new(1_00, "USD"), Money.new(2_00, "USD")
+      assert_not_equal Money.new(1_00, "USD"), Money.new(99_00, "EUR")
+    end
+
+    should "multiply the money's amount by the multiplier while retaining the currency with #*" do
+      assert_equal Money.new(10_00, "USD"), Money.new(1_00, "USD") * 10
+    end
+
+    should "divide the money's amount by the divisor while retaining the currency with #/" do
+      assert_equal Money.new(1_00, "USD"), Money.new(10_00, "USD") / 10
+    end
+
+    context "#format" do
+      should "return the monetary value as a string" do
+        assert_equal "$1.00", Money.new(100, "CAD").format
+      end
+
+      context "if the monetary value is 0" do
+        setup do
+          @money = Money.new(0, "USD")
+        end
+
+        should "return 'free' when :display_free is true" do
+          assert_equal 'free', @money.format(:display_free => true)
+        end
+
+        should "return '$0.00' when :display_free is false or not given" do
+          assert_equal '$0.00', @money.format
+          assert_equal '$0.00', @money.format(:display_free => false)
+          assert_equal '$0.00', @money.format(:display_free => nil)
+        end
+
+        should "return the value specified by :display_free if it's a string-like object" do
+          assert_equal 'gratis', @money.format(:display_free => 'gratis')
+        end
+      end
+
+      should "work as documented when :with_currency option is true" do
+        assert_equal "$1.00 CAD", Money.new(100, "CAD").format(:with_currency => true)
+        assert_equal "$0.85 USD", Money.new(85, "USD").format(:with_currency => true)
+      end
+
+      should "work as documented when :with_currency option is present" do
+        assert_equal "$1.00 CAD", Money.new(100, "CAD").format(:with_currency)
+        assert_equal "$0.85 USD", Money.new(85, "USD").format(:with_currency)
+      end
+
+      should "work as documented when :no_cents option is true" do
+        assert_equal "$1", Money.new(100, "CAD").format(:no_cents => true)
+        assert_equal "$5", Money.new(599, "CAD").format(:no_cents => true)
+        assert_equal "$5 CAD", Money.new(570, "CAD").format(:no_cents => true, :with_currency => true)
+        assert_equal "$390", Money.new(39000, "CAD").format(:no_cents => true)
+      end
+
+      should "work as documented when :no_cents option is present" do
+        assert_equal "$1", Money.new(100, "CAD").format(:no_cents)
+        assert_equal "$5", Money.new(599, "CAD").format(:no_cents)
+        assert_equal "$5 CAD", Money.new(570, "CAD").format(:no_cents, :with_currency)
+        assert_equal "$390", Money.new(39000, "CAD").format(:no_cents)
+      end
+
+      should "use a given :symbol value as the money symbol" do
+        assert_equal "£1.00", Money.new(100, :currency => "GBP").format(:symbol => "£")
+      end
+
+      should "return symbol based on the given currency code when :symbol option is true" do #!!!!!
+        one = Proc.new { |currency| Money.new(100, :currency => currency).format(:symbol => true) }
+
+        # Pounds
+        assert_equal "£1.00", one["GBP"]
+
+        # Dollars
+        assert_equal "$1.00", one["USD"]
+        assert_equal "$1.00", one["CAD"]
+        assert_equal "$1.00", one["AUD"]
+        assert_equal "$1.00", one["NZD"]
+        assert_equal "Z$1.00", one["ZWD"]
+
+        # Yen
+        assert_equal "¥1.00", one["JPY"]
+        assert_equal "¥1.00", one["CNY"]
+
+        # Euro
+        assert_equal "€1.00", one["EUR"]
+
+        # Rupees
+        assert_equal "₨1.00", one["INR"]
+        assert_equal "₨1.00", one["NPR"]
+        assert_equal "₨1.00", one["SCR"]
+        assert_equal "₨1.00", one["LKR"]
+
+        # Other
+        assert_equal "kr1.00", one["SEK"]
+        assert_equal "¢1.00", one["GHC"]
+      end
+
+      should "return $ when currency code is not recognized and :symbol option is true" do
+        assert_equal "$1.00", Money.new(100, :currency => "XYZ").format(:symbol => true)
+      end
+
+      should "return symbol based on the given currency code when :symbol option is some non-Boolean value that evaluates to true" do
+        assert_equal "£1.00", Money.new(100, :currency => "GBP").format(:symbol => true) #!!!!
+        assert_equal "€1.00", Money.new(100, :currency => "EUR").format(:symbol => true)
+        assert_equal "kr1.00", Money.new(100, :currency => "SEK").format(:symbol => true)
+      end
+
+      should "return the amount without a symbol when :symbol option is "", nil or false" do
+        money = Money.new(100, :currency => "GBP")
+        assert_equal "1.00", money.format(:symbol => "")
+        assert_equal "1.00", money.format(:symbol => nil)
+        assert_equal "1.00", money.format(:symbol => false)
+      end
+
+      should "work as documented when :html option is true" do
+        string = Money.new(570, "CAD").format(:html => true, :with_currency => true)
+        assert_equal "$5.70 <span class=\"currency\">CAD</span>", string
+      end
+
+      should "insert commas into the result if the amount is sufficiently large" do
+        assert_equal "$1,000,000,000.12", Money.new(1_000_000_000_12, "USD").format
+        assert_equal "$1,000,000,000", Money.new(1_000_000_000_12, "USD").format(:no_cents => true)
+      end
+    end
+  end
+
+  context "Actions involving two Money objects" do
+    context "if the other Money object has the same currency" do
+      should "compare the two objects' amounts with #<=>" do
+        assert_operator 0, :>, Money.new(1_00, "USD") <=> Money.new(2_00, "USD")
+        assert_operator 0, :==, Money.new(1_00, "USD") <=> Money.new(1_00, "USD")
+        assert_operator 0, :<, Money.new(1_00, "USD") <=> Money.new(99, "USD")
+      end
+
+      should "add the other object's amount to the current object's amount while retaining the currency with #+" do
+        assert_equal Money.new(10_90, "USD"), Money.new(10_00, "USD") + Money.new(90, "USD")
+      end
+
+      should "substract the other object's amount from the current object's amount while retaining the currency with #-" do
+        assert_equal Money.new(9_10, "USD"), Money.new(10_00, "USD") - Money.new(90, "USD")
+      end
+    end
+
+    context "if the other Money object has a different currency" do
+      setup do
+        Money.add_rate("EUR", "USD", 10)
+      end
+
+      should "compare the two objects' amount after converting the other object's amount to its own currency with #<=>" do
+        assert_operator 0, :>, Money.new(100_00, "USD") <=> Money.new(11_00, "EUR")
+        assert_operator 0, :==, Money.new(100_00, "USD") <=> Money.new(10_00, "EUR")
+        assert_operator 0, :<, Money.new(100_00, "USD") <=> Money.new(5_00, "EUR")
+      end
+
+      should "add the other object's amount, converted to this object's currency, to this object's amount while retaining its currency with #+" do
+        assert_equal Money.new(150_00, "USD"), Money.new(100_00, "USD") + Money.new(5_00, "EUR")
+      end
+
+      should "substract the other object's amount, converted to this object's currency, to this object's amount while retaining its currency with #-" do
+        assert_equal Money.new(50_00, "USD"), Money.new(100_00, "USD") - Money.new(5_00, "EUR")
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'money'
+
+class Test::Unit::TestCase
+end

data/test/variable_exchange_bank_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class VariableExchangeBankTest < Test::Unit::TestCase
+  context "Money::VariableExchangeBank" do
+    setup do
+      @bank = Money::VariableExchangeBank.new
+    end
+
+    should "return the previously specified conversion rate" do
+      @bank.add_rate("USD", "EUR", 0.788332676)
+      @bank.add_rate("EUR", "YEN", 122.631477)
+      assert_equal 0.788332676, @bank.get_rate("USD", "EUR")
+      assert_equal 122.631477, @bank.get_rate("EUR", "YEN")
+    end
+
+    should "treat currency names case-insensitively" do
+      @bank.add_rate("usd", "eur", 1)
+      assert_equal 1, @bank.get_rate("USD", "EUR")
+      assert @bank.same_currency?("USD", "usd")
+      assert !@bank.same_currency?("EUR", "usd")
+    end
+
+    should "return nil if the conversion rate is unknown" do
+      assert_nil @bank.get_rate("American Pesos", "EUR")
+    end
+
+    should "exchange money from one currency to another according to the specified conversion rates" do
+      @bank.add_rate("USD", "EUR", 0.5)
+      @bank.add_rate("EUR", "YEN", 10)
+      assert_equal 5_00, @bank.exchange(10_00, "USD", "EUR")
+      assert_equal 5000_00, @bank.exchange(500_00, "EUR", "YEN")
+    end
+
+    should "round the exchanged result down" do
+      @bank.add_rate("USD", "EUR", 0.788332676)
+      @bank.add_rate("EUR", "YEN", 122.631477)
+      assert_equal 788, @bank.exchange(10_00, "USD", "EUR")
+      assert_equal 6131573, @bank.exchange(500_00, "EUR", "YEN")
+    end
+
+    should "raise Money::UnknownRate upon conversion if the conversion rate is unknown" do
+      assert_raise Money::UnknownRate do
+        @bank.exchange(10, "USD", "EUR")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: bai-money
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- beawesomeinstead
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Library for dealing with money and currency conversion.
+email: beawesomeinstead@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- VERSION
+- lib/money.rb
+- lib/money/core_extensions.rb
+- lib/money/errors.rb
+- lib/money/money.rb
+- lib/money/symbols.rb
+- lib/money/variable_exchange_bank.rb
+- money.gemspec
+- rakefile
+- test/core_extensions_test.rb
+- test/money_test.rb
+- test/test_helper.rb
+- test/variable_exchange_bank_test.rb
+has_rdoc: false
+homepage: http://github.com/bai/money
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library for dealing with money and currency conversion.
+test_files: 
+- test/variable_exchange_bank_test.rb
+- test/money_test.rb
+- test/test_helper.rb
+- test/core_extensions_test.rb