money 2.2.0 → 2.3.0

data/lib/money/defaults.rb

@@ -1,31 +1,57 @@
 # 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" => "¢",
-  "BRL" => "R$ ",
-  
-  # Everything else defaults to '$'
-}
-
-Money::SEPARATORS = {
-  "BRL" => ",",
-
-  # Everything else defaults to '.'
-}
-
-Money::DELIMITERS = {
-  "BRL" => ".",
-
-  # Everything else defaults to ","
-}
+class Money
+
+  class DeprecatedHash < Hash
+
+    def initialize(hash, message)
+      @message = message
+      replace(hash)
+    end
+
+    def [](key)
+      deprecate
+      super
+    end
+
+    def []=(value)
+      deprecate
+      super
+    end
+
+    private
+
+      def deprecate
+        warn "DEPRECATION MESSAGE: #{@message}"
+      end
+
+  end
+
+  # @deprecated See Money::Currency#symbol
+  SYMBOLS = DeprecatedHash.new({
+    "GBP" => "£",
+    "JPY" => "¥",
+    "EUR" => "€",
+    "ZWD" => "Z$",
+    "CNY" => "¥",
+    "INR" => "₨",
+    "NPR" => "₨",
+    "SCR" => "₨",
+    "LKR" => "₨",
+    "SEK" => "kr",
+    "GHC" => "¢",
+    "BRL" => "R$ ",
+    # Everything else defaults to '$'
+  }, "Money::SYMBOLS has no longer effect. See Money::Currency#symbol.")
+
+  SEPARATORS = {
+    "BRL" => ",",
+    # Everything else defaults to '.'
+  }
+
+  DELIMITERS = {
+    "BRL" => ".",
+    # Everything else defaults to ","
+  }
+
+end

data/lib/money/money.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+require 'money/currency'
 require 'money/variable_exchange_bank'
 
 # Represents an amount of money in a certain currency.
@@ -5,7 +7,7 @@ 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
@@ -33,12 +35,13 @@ class Money
     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".
+    # without an explicit currency argument. The default value is Currency.new("USD").
+    # The value must be a valid <tt>Money::Currency</tt> instance.
     attr_accessor :default_currency
   end
   
   self.default_bank = VariableExchangeBank.instance
-  self.default_currency = "USD"
+  self.default_currency = Currency.new("USD")
   
   
   # Create a new money object with value 0.
@@ -80,9 +83,9 @@ class Money
       #   Money.new(50, :currency => "USD")
       #
       # We retain compatibility here.
-      @currency = currency[:currency] || Money.default_currency
+      @currency = Currency.wrap(currency[:currency] || Money.default_currency)
     else
-      @currency = currency
+      @currency = Currency.wrap(currency)
     end
     @bank = bank
   end
@@ -165,6 +168,30 @@ class Money
   end
 
 
+  # Attempts to pick a symbol that's suitable for the given currency
+  # looking up the Currency::TABLE hashtable.
+  # If the symbol for the given currency isn't known,
+  # then it will default to "$".
+  def symbol
+    currency.symbol || "$"
+  end
+
+  # Attempts to pick a delimiter that's suitable for the given currency
+  # looking up the Money::DELIMITERS hashtable.
+  # If the symbol for the given currency isn't known,
+  # then it will default to ",".
+  def delimiter
+    DELIMITERS[currency.to_s] || ","
+  end
+
+  # Attempts to pick a separator for <tt>cents</tt> that's suitable for the given currency
+  # looking up the Money::DELIMITERS hashtable.
+  # If the separator for the given currency isn't known,
+  # then it will default to ".".
+  def separator
+    SEPARATORS[currency.to_s] || "."
+  end
+
   # Creates a formatted price string according to several rules. The following
   # options are supported: :display_free, :with_currency, :no_cents, :symbol,
   # :separator, :delimiter and :html.
@@ -279,52 +306,52 @@ class Money
 
     if rules.has_key?(:symbol)
       if rules[:symbol] === true
-        symbol = SYMBOLS[currency] || "$"
+        symbol_value = symbol
       elsif rules[:symbol]
-        symbol = rules[:symbol]
+        symbol_value = rules[:symbol]
       else
-        symbol = ""
+        symbol_value = ""
       end
     else
-      symbol = SYMBOLS[currency] || "$"
+      symbol_value = symbol
     end
 
     if rules[:no_cents]
-      formatted = sprintf("#{symbol}%d", cents.to_f / 100)
+      formatted = sprintf("#{symbol_value}%d", cents.to_f / 100)
     else
-      formatted = sprintf("#{symbol}%.2f", cents.to_f / 100)
+      formatted = sprintf("#{symbol_value}%.2f", cents.to_f / 100)
     end
 
-    delimiter = DELIMITERS[currency] || ","
+    delimiter_value = delimiter
     # Determine delimiter
     if rules.has_key?(:delimiter)
       if rules[:delimiter] === false or rules[:delimiter].nil?
-        delimiter = ""
+        delimiter_value = ""
       elsif rules[:delimiter]
-        delimiter = rules[:delimiter]
+        delimiter_value = rules[:delimiter]
       end
     end
 
     # Apply delimiter
-    formatted.gsub!(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/, "\\1#{delimiter}\\2")
+    formatted.gsub!(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/, "\\1#{delimiter_value}\\2")
 
-    separator = SEPARATORS[currency] || "."
+    separator_value = separator
     # Determine separator
     if rules.has_key?(:separator) and rules[:separator]
-      separator = rules[:separator]
+      separator_value = rules[:separator]
     end
 
     # Apply separator
-    formatted.sub!(/\.(\d{2})$/, "#{separator}\\1")
+    formatted.sub!(/\.(\d{2})$/, "#{separator_value}\\1")
 
     if rules[:with_currency]
       formatted << " "
       formatted << '<span class="currency">' if rules[:html]
-      formatted << currency
+      formatted << currency.to_s
       formatted << '</span>' if rules[:html]
     end
     formatted
-  end  
+  end
   
   # Returns the amount of money as a string.
   #
@@ -342,12 +369,19 @@ class Money
   def to_f
     cents / 100.0
   end
-  
-  # Recieve the amount of this money object in another currency.
+
+  # Recieve the amount of this money object in another Currency.
+  # <tt>other_currency</tt> can be either a <tt>String</tt>
+  # or a <tt>Currency</tt> instance.
+  #
+  #   Money.new(2000, "USD").exchange_to("EUR")
+  #   Money.new(2000, "USD").exchange_to(Currency.new("EUR"))
+  #
   def exchange_to(other_currency)
+    other_currency = Currency.wrap(other_currency)
     Money.new(@bank.exchange(self.cents, currency, other_currency), other_currency)
-  end  
-  
+  end
+
   # Recieve a money object with the same amount as the current Money object
   # in american dollar 
   def as_us_dollar

data/lib/money/variable_exchange_bank.rb

@@ -52,7 +52,7 @@ class Money
     #   bank.same_currency?("usd", "USD")   # => true
     #   bank.same_currency?("usd", "EUR")   # => false
     def same_currency?(currency1, currency2)
-      currency1.upcase == currency2.upcase
+      Currency.wrap(currency1) == Currency.wrap(currency2)
     end
     
     # Exchange the given amount of cents in +from_currency+ to +to_currency+.

data/money.gemspec

@@ -5,32 +5,36 @@
 
 Gem::Specification.new do |s|
   s.name = %q{money}
-  s.version = "2.2.0"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Luetke", "Hongli Lai", "Jeremy McNevin", "Shane Emmons"]
-  s.date = %q{2010-02-17}
+  s.date = %q{2010-04-16}
   s.description = %q{Money and currency exchange support library.}
   s.email = %q{hongli@phusion.nl}
   s.extra_rdoc_files = [
-    "LICENSE",
+    "CHANGELOG.rdoc",
+     "LICENSE",
      "README.rdoc"
   ]
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/money.rb",
      "lib/money/core_extensions.rb",
+     "lib/money/currency.rb",
      "lib/money/defaults.rb",
      "lib/money/errors.rb",
      "lib/money/money.rb",
      "lib/money/variable_exchange_bank.rb",
      "money.gemspec",
      "test/core_extensions_spec.rb",
+     "test/currency_spec.rb",
      "test/exchange_bank_spec.rb",
      "test/money_spec.rb"
   ]
@@ -38,10 +42,11 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{money}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Money and currency exchange support library}
   s.test_files = [
     "test/core_extensions_spec.rb",
+     "test/currency_spec.rb",
      "test/exchange_bank_spec.rb",
      "test/money_spec.rb"
   ]

data/test/core_extensions_spec.rb

@@ -1,4 +1,5 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
 require 'money/core_extensions'
 
 describe "Money core extensions" do
@@ -6,12 +7,12 @@ describe "Money core extensions" do
     money = 1234.to_money
     money.cents.should == 1234_00
     money.currency.should == Money.default_currency
-    
+
     money = 100.37.to_money
     money.cents.should == 100_37
     money.currency.should == Money.default_currency
   end
-  
+
   specify "String#to_money works" do
     "20.15".to_money.should == Money.new(20_15)
     "100".to_money.should == Money.new(100_00)
@@ -31,7 +32,7 @@ describe "Money core extensions" do
     "1.550".to_money.should == Money.new(1_55)
     "25.".to_money.should == Money.new(25_00)
     ".75".to_money.should == Money.new(75)
-    
+
     "100 USD".to_money.should == Money.new(100_00, "USD")
     "-100 USD".to_money.should == Money.new(-100_00, "USD")
     "100 EUR".to_money.should == Money.new(100_00, "EUR")
@@ -44,7 +45,7 @@ describe "Money core extensions" do
     "1,000.5500 USD".to_money.should == Money.new(1_000_55, "USD")
     "-1,000.6500 USD".to_money.should == Money.new(-1_000_65, "USD")
     "1.550 USD".to_money.should == Money.new(1_55, "USD")
-    
+
     "USD 100".to_money.should == Money.new(100_00, "USD")
     "EUR 100".to_money.should == Money.new(100_00, "EUR")
     "EUR 100.37".to_money.should == Money.new(100_37, "EUR")
@@ -58,7 +59,7 @@ describe "Money core extensions" do
     "USD 1,000.9000".to_money.should == Money.new(1_000_90, "USD")
     "USD -1,000.090".to_money.should == Money.new(-1_000_09, "USD")
     "USD 1.5500".to_money.should == Money.new(1_55, "USD")
-    
+
     "$100 USD".to_money.should == Money.new(100_00, "USD")
     "$1,194.59 USD".to_money.should == Money.new(1_194_59, "USD")
     "$-1,955 USD".to_money.should == Money.new(-1_955_00, "USD")
@@ -66,8 +67,19 @@ describe "Money core extensions" do
     "$-1,955.000 USD".to_money.should == Money.new(-1_955_00, "USD")
     "$1.99000 USD".to_money.should == Money.new(1_99, "USD")
   end
-  
+
   specify "String#to_money ignores unrecognized data" do
     "hello 2000 world".to_money.should == Money.new(2000_00)
   end
+
+  specify "String#to_currency convert string to Currency" do
+    "USD".to_currency.should == Money::Currency.new(:usd)
+    "EUR".to_currency.should == Money::Currency.new(:eur)
+  end
+
+  specify "String#to_currency should raise Currency::UnknownCurrency with unkwnown Currency" do
+    lambda { "XXX".to_currency }.should raise_error(Money::Currency::UnknownCurrency)
+    lambda { " ".to_currency }.should raise_error(Money::Currency::UnknownCurrency)
+  end
+
 end

data/test/currency_spec.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'money/money'
+require 'money/currency'
+require 'money/defaults'
+
+describe Money::Currency do
+
+  specify "#initialize should lookup data from TABLE" do
+    with_custom_definitions do
+      Money::Currency::TABLE[:usd] = { :priority =>   1, :iso_code => "USD", :name => "United States Dollar",                      :symbol => "$",             :subunit => "Cent",          :subunit_to_unit => "100"   }
+      Money::Currency::TABLE[:eur] = { :priority =>   2, :iso_code => "EUR", :name => "Euro",                                      :symbol => "€",             :subunit => "Cent",          :subunit_to_unit => "100"   }
+
+      currency = Money::Currency.new("USD")
+      currency.id.should        == :usd
+      currency.priority.should  == 1
+      currency.iso_code.should  == "USD"
+      currency.name.should      == "United States Dollar"
+    end
+  end
+
+  specify "#initialize should raise UnknownMoney::Currency with unknown currency" do
+    lambda { Money::Currency.new("xxx") }.should raise_error(Money::Currency::UnknownCurrency, /xxx/)
+  end
+
+  specify "#== should return true if self === other" do
+    currency = Money::Currency.new(:eur)
+    currency.should == currency
+  end
+
+  specify "#== should return true if the id is equal" do
+    Money::Currency.new(:eur).should     == Money::Currency.new(:eur)
+    Money::Currency.new(:eur).should_not == Money::Currency.new(:usd)
+  end
+
+  specify "#<=> should compare objects by priority" do
+    Money::Currency.new(:cad).should > Money::Currency.new(:usd)
+    Money::Currency.new(:usd).should < Money::Currency.new(:eur)
+  end
+
+  specify "#to_s" do
+    Money::Currency.new(:usd).to_s.should == "USD"
+    Money::Currency.new(:eur).to_s.should == "EUR"
+  end
+
+  specify "#inspect" do
+    Money::Currency.new(:usd).inspect.should ==
+    %Q{#<Money::Currency id: usd priority: 1, iso_code: USD, name: United States Dollar, symbol: $, subunit: Cent, subunit_to_unit: 100>}
+  end
+
+
+  specify "#self.find should return currency matching given id" do
+    with_custom_definitions do
+      Money::Currency::TABLE[:usd] = { :priority =>   1, :iso_code => "USD", :name => "United States Dollar",                      :symbol => "$",             :subunit => "Cent",          :subunit_to_unit => "100"   }
+      Money::Currency::TABLE[:eur] = { :priority =>   2, :iso_code => "EUR", :name => "Euro",                                      :symbol => "€",             :subunit => "Cent",          :subunit_to_unit => "100"   }
+  
+      expected = Money::Currency.new(:eur)
+      Money::Currency.find(:eur).should  == expected
+      Money::Currency.find(:EUR).should  == expected
+      Money::Currency.find("eur").should == expected
+      Money::Currency.find("EUR").should == expected
+    end
+  end
+  
+  specify "#self.find should return nil unless currency matching given id" do
+    with_custom_definitions do
+      Money::Currency::TABLE[:usd] = { :position =>   1, :iso_code => "USD", :name => "United States Dollar",                      :symbol => "$",             :subunit => "Cent",          :subunit_to_unit => "100"   }
+      Money::Currency::TABLE[:eur] = { :position =>   2, :iso_code => "EUR", :name => "Euro",                                      :symbol => "€",             :subunit => "Cent",          :subunit_to_unit => "100"   }
+  
+      expected = Money::Currency.new(:eur)
+      Money::Currency.find(:eur).should  == expected
+      Money::Currency.find(:EUR).should  == expected
+      Money::Currency.find("eur").should == expected
+      Money::Currency.find("EUR").should == expected
+    end
+  end
+
+  specify "#self.wrap should return nil if object is nil" do
+    Money::Currency.wrap(nil).should == nil
+    Money::Currency.wrap(Money::Currency.new(:usd)).should == Money::Currency.new(:usd)
+    Money::Currency.wrap(:usd).should == Money::Currency.new(:usd)
+  end
+
+
+  def with_custom_definitions(&block)
+    begin
+      old = Money::Currency::TABLE.dup
+      Money::Currency::TABLE.clear
+      yield
+    ensure
+      silence_warnings do
+        Money::Currency.const_set("TABLE", old)
+      end
+    end
+  end
+
+  # Sets $VERBOSE to nil for the duration of the block and back to its original value afterwards.
+  #
+  #   silence_warnings do
+  #     value = noisy_call # no warning voiced
+  #   end
+  #
+  #   noisy_call # warning voiced
+  def silence_warnings
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+
+end