money 3.5.5 → 3.6.0

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+Money 3.x.x
+===========
+
+Features
+--------
+ - Add a symbol position option for Money#format (thanks Romain, Gil and
+   Julien)
+ - Updated CNY to use "Fen" and subunit_to_unit of 100
+ - Updates to work with gem-testers.org
+
+Bigfixes
+--------
+ - Fixed issue with #format(:no_cents => true) (thanks Romain & Julien)
+
 Money 3.5.5
 ===========
 

data/README.md

@@ -194,7 +194,8 @@ object in your models. The following example requires a `cents` and a
     composed_of :price,
       :class_name => "Money",
       :mapping => [%w(cents cents), %w(currency currency_as_string)],
-      :constructor => Proc.new { |cents, currency| Money.new(cents || 0, currency || Money.default_currency) }
+      :constructor => Proc.new { |cents, currency| Money.new(cents || 0, currency || Money.default_currency) },
+      :converter => Proc.new { |value| value.respond_to?(:to_money) ? value.to_money : raise(ArgumentError, "Can't convert #{value.class} to Money") }
 
 For Money 2.2.x and previous versions, simply use the following `composed_of`
 definition:

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake/clean'
+
+CLOBBER.include('doc', '.yardoc')
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path("../money.gemspec", __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+rescue LoadError
+  task(:spec){abort "`gem install rspec` to run specs"}
+end
+task :default => :spec
+task :test => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options << "--files" << "CHANGELOG.md,LICENSE"
+  end
+rescue LoadError
+  task(:yardoc){abort "`gem install yard` to generate documentation"}
+end
+
+begin
+  require 'rake/gempackagetask'
+  Rake::GemPackageTask.new(gemspec) do |pkg|
+    pkg.gem_spec = gemspec
+  end
+  task :gem => :gemspec
+rescue LoadError
+  task(:gem){abort "`gem install rake` to package gems"}
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh "gem install pkg/#{gemspec.full_name}.gem"
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/lib/money/currency.rb

@@ -51,7 +51,7 @@ class Money
       :cdf => { :priority => 100, :iso_code => "CDF", :name => "Congolese Franc",                           :symbol => "Fr",            :subunit => "Centime",       :subunit_to_unit => 100,  :symbol_first => false, :html_entity => "",         :decimal_mark => ".", :thousands_separator => ","},
       :chf => { :priority => 100, :iso_code => "CHF", :name => "Swiss Franc",                               :symbol => "Fr",            :subunit => "Rappen",        :subunit_to_unit => 100,  :symbol_first => true, :html_entity => "",         :decimal_mark => ".", :thousands_separator => ","},
       :clp => { :priority => 100, :iso_code => "CLP", :name => "Chilean Peso",                              :symbol => "$",             :subunit => "Peso",       :subunit_to_unit => 1,       :symbol_first => true, :html_entity => "₱", :decimal_mark => ",", :thousands_separator => "."},
-      :cny => { :priority => 100, :iso_code => "CNY", :name => "Chinese Renminbi Yuan",                     :symbol => "¥",             :subunit => "Jiao",          :subunit_to_unit => 10,   :symbol_first => true, :html_entity => "圓", :decimal_mark => ".", :thousands_separator => ","},
+      :cny => { :priority => 100, :iso_code => "CNY", :name => "Chinese Renminbi Yuan",                     :symbol => "¥",             :subunit => "Fen",           :subunit_to_unit => 100,  :symbol_first => true, :html_entity => "圓", :decimal_mark => ".", :thousands_separator => ","},
       :cop => { :priority => 100, :iso_code => "COP", :name => "Colombian Peso",                            :symbol => "$",             :subunit => "Centavo",       :subunit_to_unit => 100,  :symbol_first => true, :html_entity => "₱", :decimal_mark => ",", :thousands_separator => "."},
       :crc => { :priority => 100, :iso_code => "CRC", :name => "Costa Rican Colón",                         :symbol => "₡",             :subunit => "Céntimo",       :subunit_to_unit => 100,  :symbol_first => true, :html_entity => "₡", :decimal_mark => ",", :thousands_separator => "."},
       :cuc => { :priority => 100, :iso_code => "CUC", :name => "Cuban Convertible Peso",                    :symbol => "$",             :subunit => "Centavo",       :subunit_to_unit => 100,  :symbol_first => false, :html_entity => "",         :decimal_mark => ".", :thousands_separator => ","},

data/lib/money/money.rb

@@ -871,7 +871,19 @@ class Money
                 else
                   "#{self.to_s}"
                 end
-    formatted = (currency.symbol_first? ? "#{symbol_value}#{formatted}" : "#{formatted} #{symbol_value}") unless symbol_value.nil? or symbol_value.empty?
+
+    symbol_position =
+      if rules.has_key?(:symbol_position)
+        rules[:symbol_position]
+      elsif currency.symbol_first?
+        :before
+      else
+        :after
+      end
+
+    if symbol_value && !symbol_value.empty?
+      formatted = (symbol_position == :before ? "#{symbol_value}#{formatted}" : "#{formatted} #{symbol_value}")
+    end
 
     if rules.has_key?(:decimal_mark) and rules[:decimal_mark] and
       rules[:decimal_mark] != decimal_mark
@@ -889,7 +901,7 @@ class Money
     end
 
     # Apply thousands_separator
-    formatted.gsub!(/(\d)(?=(?:\d{3})+(?:\.|,|$))(\d{3}\..*)?/, "\\1#{thousands_separator_value}\\2")
+    formatted.gsub!(/(\d)(?=(?:\d{3})+(?:[^\d]|$))/, "\\1#{thousands_separator_value}")
 
     if rules[:with_currency]
       formatted << " "
@@ -994,7 +1006,7 @@ class Money
     "#<Money cents:#{cents} currency:#{currency}>"
   end
 
-  # Allocates money between different parties without loosing pennies. 
+  # Allocates money between different parties without loosing pennies.
   # After the mathmatically split has been performed, left over pennies will
   # be distributed round-robin amongst the parties. This means that parties
   # listed first will likely recieve more pennies then ones that are listed later
@@ -1004,7 +1016,7 @@ class Money
   # @return [Array<Money, Money, Money>]
   #
   # @example
-  #   Money.new(5, "USD").allocate([0.3,0.7)) #=> [Money.new(2), Money.new(3)]  
+  #   Money.new(5, "USD").allocate([0.3,0.7)) #=> [Money.new(2), Money.new(3)]
   #   Money.new(100, "USD").allocate([0.33,0.33,0.33]) #=> [Money.new(34), Money.new(33), Money.new(33)]
   def allocate(splits)
     allocations = splits.inject(0.0) {|sum, i| sum += i }
@@ -1061,7 +1073,7 @@ class Money
       rules = { rules => true } if rules.is_a?(Symbol)
     end
     if not rules.include?(:decimal_mark) and rules.include?(:separator)
-      rules[:decimal_mark] = rules[:separator] 
+      rules[:decimal_mark] = rules[:separator]
     end
     if not rules.include?(:thousands_separator) and rules.include?(:delimiter)
       rules[:thousands_separator] = rules[:delimiter]

data/money.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name        = "money"
+  s.version     = "3.6.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tobias Luetke", "Hongli Lai", "Jeremy McNevin", "Shane Emmons", "Simone Carletti"]
+  s.email       = ["hongli@phusion.nl", "semmons99+RubyMoney@gmail.com"]
+  s.homepage    = "http://money.rubyforge.org"
+  s.summary     = "Money and currency exchange support library."
+  s.description = "This library aids one in handling money and different currencies."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "money"
+
+  s.add_dependency "i18n", "~> 0.4"
+
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "json"
+
+  s.requirements << "json if you plan to import/export rates formatted as json"
+
+  s.files =  Dir.glob("{lib,spec}/**/*")
+  s.files += %w(CHANGELOG.md LICENSE README.md)
+  s.files += %w(Rakefile .gemtest money.gemspec)
+
+  s.require_path = "lib"
+end

data/spec/bank/base_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe Money::Bank::Base do
+  before :each do
+    @bank = Money::Bank::Base.new
+  end
+
+  describe '#new with &block' do
+    it 'should store @rounding_method' do
+      proc = Proc.new{|n| n.ceil}
+      bank = Money::Bank::Base.new(&proc)
+      bank.rounding_method.should == proc
+    end
+  end
+
+  describe '#setup' do
+    it 'should call #setup after #initialize' do
+      class MyBank < Money::Bank::Base
+        attr_reader :setup_called
+
+        def setup
+          @setup_called = true
+        end
+      end
+
+      bank = MyBank.new
+      bank.setup_called.should == true
+    end
+  end
+
+  describe '#exchange_with' do
+    it 'should raise NotImplementedError' do
+      lambda { @bank.exchange_with(Money.new(100, 'USD'), 'EUR') }.should raise_exception(NotImplementedError)
+    end
+  end
+
+  describe '#same_currency?' do
+    it 'should accept str/str' do
+      lambda{@bank.send(:same_currency?, 'USD', 'EUR')}.should_not raise_exception
+    end
+
+    it 'should accept currency/str' do
+      lambda{@bank.send(:same_currency?, Money::Currency.wrap('USD'), 'EUR')}.should_not raise_exception
+    end
+
+    it 'should accept str/currency' do
+      lambda{@bank.send(:same_currency?, 'USD', Money::Currency.wrap('EUR'))}.should_not raise_exception
+    end
+
+    it 'should accept currency/currency' do
+      lambda{@bank.send(:same_currency?, Money::Currency.wrap('USD'), Money::Currency.wrap('EUR'))}.should_not raise_exception
+    end
+
+    it 'should return `true` when currencies match' do
+      @bank.send(:same_currency?, 'USD', 'USD').should == true
+      @bank.send(:same_currency?, Money::Currency.wrap('USD'), 'USD').should == true
+      @bank.send(:same_currency?, 'USD', Money::Currency.wrap('USD')).should == true
+      @bank.send(:same_currency?, Money::Currency.wrap('USD'), Money::Currency.wrap('USD')).should == true
+    end
+
+    it 'should return `false` when currencies do not match' do
+      @bank.send(:same_currency?, 'USD', 'EUR').should == false
+      @bank.send(:same_currency?, Money::Currency.wrap('USD'), 'EUR').should == false
+      @bank.send(:same_currency?, 'USD', Money::Currency.wrap('EUR')).should == false
+      @bank.send(:same_currency?, Money::Currency.wrap('USD'), Money::Currency.wrap('EUR')).should == false
+    end
+
+    it 'should raise an UnknownCurrency exception when an unknown currency is passed' do
+      lambda{@bank.send(:same_currency?, 'AAA', 'BBB')}.should raise_exception(Money::Currency::UnknownCurrency)
+    end
+  end
+end

data/spec/bank/variable_exchange_spec.rb

@@ -0,0 +1,222 @@
+require "spec_helper"
+require "json"
+require "yaml"
+
+describe Money::Bank::VariableExchange do
+
+  describe '#new without block' do
+    before :each do
+      @bank = Money::Bank::VariableExchange.new
+    end
+
+    describe '#exchange_with' do
+      before :each do
+        @bank.send(:set_rate, 'USD', 'EUR', 1.33)
+      end
+
+      it 'should accept str' do
+        lambda{@bank.exchange_with(Money.new(100, 'USD'), 'EUR')}.should_not raise_exception
+      end
+
+      it 'should accept currency' do
+        lambda{@bank.exchange_with(Money.new(100, 'USD'), Money::Currency.wrap('EUR'))}.should_not raise_exception
+      end
+
+      it 'should exchange one currency to another' do
+        @bank.exchange_with(Money.new(100, 'USD'), 'EUR').should == Money.new(133, 'EUR')
+      end
+
+      it 'should truncate extra digits' do
+        @bank.exchange_with(Money.new(10, 'USD'), 'EUR').should == Money.new(13, 'EUR')
+      end
+
+      it 'should raise an UnknownCurrency exception when an unknown currency is requested' do
+        lambda{@bank.exchange_with(Money.new(100, 'USD'), 'BBB')}.should raise_exception(Money::Currency::UnknownCurrency)
+      end
+
+      it 'should raise an UnknownRate exception when an unknown rate is requested' do
+        lambda{@bank.exchange_with(Money.new(100, 'USD'), 'JPY')}.should raise_exception(Money::Bank::UnknownRate)
+      end
+
+      #it 'should round the exchanged result down' do
+      #  @bank.add_rate("USD", "EUR", 0.788332676)
+      #  @bank.add_rate("EUR", "YEN", 122.631477)
+      #  @bank.exchange_with(Money.new(10_00,  "USD"), "EUR").should == Money.new(788, "EUR")
+      #  @bank.exchange_with(Money.new(500_00, "EUR"), "YEN").should == Money.new(6131573, "YEN")
+      #end
+
+      it 'should accept a custom truncation method' do
+        proc = Proc.new { |n| n.ceil }
+        @bank.exchange_with(Money.new(10, 'USD'), 'EUR', &proc).should == Money.new(14, 'EUR')
+      end
+    end
+
+    describe "#add_rate" do
+      it "should add rates correctly" do
+        @bank.add_rate("USD", "EUR", 0.788332676)
+        @bank.add_rate("EUR", "YEN", 122.631477)
+
+        @bank.instance_variable_get(:@rates)['USD_TO_EUR'].should == 0.788332676
+        @bank.instance_variable_get(:@rates)['EUR_TO_JPY'].should == 122.631477
+      end
+
+      it "should treat currency names case-insensitively" do
+        @bank.add_rate("usd", "eur", 1)
+        @bank.instance_variable_get(:@rates)['USD_TO_EUR'].should == 1
+      end
+    end
+
+    describe '#set_rate' do
+      it 'should set a rate' do
+        @bank.set_rate('USD', 'EUR', 1.25)
+        @bank.instance_variable_get(:@rates)['USD_TO_EUR'].should == 1.25
+      end
+
+      it 'should raise an UnknownCurrency exception when an unknown currency is passed' do
+        lambda{ @bank.set_rate('AAA', 'BBB', 1.25) }.should raise_exception(Money::Currency::UnknownCurrency)
+      end
+    end
+
+    describe '#get_rate' do
+      it 'should return a rate' do
+        @bank.set_rate('USD', 'EUR', 1.25)
+        @bank.get_rate('USD', 'EUR').should == 1.25
+      end
+
+      it 'should raise an UnknownCurrency exception when an unknown currency is requested' do
+        lambda{ @bank.get_rate('AAA', 'BBB') }.should raise_exception(Money::Currency::UnknownCurrency)
+      end
+    end
+
+    describe '#export_rates' do
+      before :each do
+        @bank.set_rate('USD', 'EUR', 1.25)
+        @bank.set_rate('USD', 'JPY', 2.55)
+
+        @rates = {"USD_TO_EUR"=>1.25,"USD_TO_JPY"=>2.55}
+      end
+
+      describe 'with format == :json' do
+        it 'should return rates formatted as json' do
+          json = @bank.export_rates(:json)
+          JSON.load(json).should == @rates
+        end
+      end
+
+      describe 'with format == :ruby' do
+        it 'should return rates formatted as ruby objects' do
+          Marshal.load(@bank.export_rates(:ruby)).should == @rates
+        end
+      end
+
+      describe 'with format == :yaml' do
+        it 'should return rates formatted as yaml' do
+          yaml = @bank.export_rates(:yaml)
+          YAML.load(yaml).should == @rates
+        end
+      end
+
+      describe 'with unknown format' do
+        it 'should raise `UnknownRateFormat`' do
+          lambda{@bank.export_rates(:foo)}.should raise_error Money::Bank::UnknownRateFormat
+        end
+      end
+
+      describe 'with :file provided' do
+        it 'should write rates to file' do
+          f = mock('IO')
+          File.should_receive(:open).with('null', 'w').and_return(f)
+          f.should_receive(:write).with(@rates.to_json)
+
+          @bank.export_rates(:json, 'null')
+        end
+      end
+    end
+
+    describe '#import_rates' do
+      describe 'with format == :json' do
+        it 'should load the rates provided' do
+          s = '{"USD_TO_EUR":1.25,"USD_TO_JPY":2.55}'
+          @bank.import_rates(:json, s)
+          @bank.get_rate('USD', 'EUR').should == 1.25
+          @bank.get_rate('USD', 'JPY').should == 2.55
+        end
+      end
+
+      describe 'with format == :ruby' do
+        it 'should load the rates provided' do
+          s = Marshal.dump({"USD_TO_EUR"=>1.25,"USD_TO_JPY"=>2.55})
+          @bank.import_rates(:ruby, s)
+          @bank.get_rate('USD', 'EUR').should == 1.25
+          @bank.get_rate('USD', 'JPY').should == 2.55
+        end
+      end
+
+      describe 'with format == :yaml' do
+        it 'should load the rates provided' do
+          s = "--- \nUSD_TO_EUR: 1.25\nUSD_TO_JPY: 2.55\n"
+          @bank.import_rates(:yaml, s)
+          @bank.get_rate('USD', 'EUR').should == 1.25
+          @bank.get_rate('USD', 'JPY').should == 2.55
+        end
+      end
+
+      describe 'with unknown format' do
+        it 'should raise `UnknownRateFormat`' do
+          lambda{@bank.import_rates(:foo, "")}.should raise_error Money::Bank::UnknownRateFormat
+        end
+      end
+    end
+
+    describe '#rate_key_for' do
+      it 'should accept str/str' do
+        lambda{@bank.send(:rate_key_for, 'USD', 'EUR')}.should_not raise_exception
+      end
+
+      it 'should accept currency/str' do
+        lambda{@bank.send(:rate_key_for, Money::Currency.wrap('USD'), 'EUR')}.should_not raise_exception
+      end
+
+      it 'should accept str/currency' do
+        lambda{@bank.send(:rate_key_for, 'USD', Money::Currency.wrap('EUR'))}.should_not raise_exception
+      end
+
+      it 'should accept currency/currency' do
+        lambda{@bank.send(:rate_key_for, Money::Currency.wrap('USD'), Money::Currency.wrap('EUR'))}.should_not raise_exception
+      end
+
+      it 'should return a hashkey based on the passed arguments' do
+        @bank.send(:rate_key_for, 'USD', 'EUR').should == 'USD_TO_EUR'
+        @bank.send(:rate_key_for, Money::Currency.wrap('USD'), 'EUR').should == 'USD_TO_EUR'
+        @bank.send(:rate_key_for, 'USD', Money::Currency.wrap('EUR')).should == 'USD_TO_EUR'
+        @bank.send(:rate_key_for, Money::Currency.wrap('USD'), Money::Currency.wrap('EUR')).should == 'USD_TO_EUR'
+      end
+
+      it 'should raise an UnknownCurrency exception when an unknown currency is passed' do
+        lambda{@bank.send(:rate_key_for, 'AAA', 'BBB')}.should raise_exception(Money::Currency::UnknownCurrency)
+      end
+    end
+
+  end
+
+
+  describe '#new with &block' do
+    before :each do
+      proc = Proc.new { |n| n.ceil }
+      @bank = Money::Bank::VariableExchange.new(&proc)
+      @bank.add_rate('USD', 'EUR', 1.33)
+    end
+
+    describe '#exchange_with' do
+      it 'should use a stored truncation method' do
+        @bank.exchange_with(Money.new(10, 'USD'), 'EUR').should == Money.new(14, 'EUR')
+      end
+
+      it 'should use a custom truncation method over a stored one' do
+        proc = Proc.new { |n| n.ceil + 1 }
+        @bank.exchange_with(Money.new(10, 'USD'), 'EUR', &proc).should == Money.new(15, 'EUR')
+      end
+    end
+  end
+
+end