money 3.1.0.pre1 → 3.1.0.pre2

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== Money 3.1.0.pre2
+ * moved @rounding_method from Money::Bank::VariableExchange to
+   Money::Bank::Base (closes #18)
+ * added #setup and call after #initialize in Money::Bank::Base (closes #19)
+ * update/fix documentation (closes #17)
+
 == Money 3.1.0.pre1
  * Implemented Money::Bank::Base (closes #14)
  * Added Bank::Base#exchange_with

data/README.rdoc

@@ -51,9 +51,21 @@ The development version (hosted on Github) can be installed with:
   money.cents     # => 1000
   money.currency  # => Currency.new("USD")
   
+  # Comparisons
   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
+  Money.new(1000, "USD") != Money.new(1000, "EUR")   # => true
+  
+  # Arithmetic
+  Money.new(1000, "USD") + Money.new(500, "USD") == Money.new(1500, "USD")
+  Money.new(1000, "USD") - Money.new(200, "USD") == Money.new(800, "USD")
+  Money.new(1000, "USD") / 5                     == Money.new(200, "USD")
+  Money.new(1000, "USD") * 5                     == Money.new(5000, "USD")
+  
+  # Currency conversions
+  some_code_to_setup_exchange_rates
+  Money.new(1000, "USD").exchange_to("EUR")  == Money.new(some_value, "EUR")
 
 === Currency
 
@@ -66,7 +78,7 @@ The most part of <tt>Money</tt> APIs allows you to supply either a <tt>String</t
 A <tt>Money::Currency</tt> instance holds all the information about the currency, 
 including the currency symbol, name and much more.
 
-  currency = Money.new(1000, "USD")
+  currency = Money.new(1000, "USD").currency
   currency.iso_code
   # => "USD"
   currency.name
@@ -89,14 +101,14 @@ containing all the currency attributes.
 
 The pre-defined set of attributes includes:
 
-  * priority: a numerical value you can use to sort/group the currency list
-  * iso_code: the international 3-letter code as defined by the ISO 4217 standard
-  * name: the currency name
-  * symbol: the currency symbol (UTF-8 encoded)
-  * subunit: the name of the fractional monetary unit
-  * subunit_to_unit: the proportion between the unit and the subunit
-  * separator: character between the whole and fraction amounts
-  * delimiter: character between each thousands place
+- priority: a numerical value you can use to sort/group the currency list
+- iso_code: the international 3-letter code as defined by the ISO 4217 standard
+- name: the currency name
+- symbol: the currency symbol (UTF-8 encoded)
+- subunit: the name of the fractional monetary unit
+- subunit_to_unit: the proportion between the unit and the subunit
+- separator: character between the whole and fraction amounts
+- delimiter: character between each thousands place
 
 All attributes are optional. Some attributes, such as <tt>:symbol</tt>, are used by the Money class
 to print out a representation of the object. Other attributes, such as <tt>:name</tt> or <tt>:priority</tt>,
@@ -133,7 +145,7 @@ and all_currencies as follows:
   major_currencies(Money::Currency::TABLE)
   # => [ :usd, :eur, :bgp, :cad ]
   
-  major_currencies(Money::Currency::TABLE)
+  all_currencies(Money::Currency::TABLE)
   # => [ :aed, :afn, all, ... ]
 
 
@@ -175,7 +187,7 @@ www.xe.com for the current rates or just returns <tt>rand(2)</tt>:
 The following is a list of Money.gem compatible currency exchange rate
 implementations.
 
-* eu_central_bank.gem: http://github.com/liangzan/eu_central_bank
+* eu_central_bank.gem: http://github.com/RubyMoney/eu_central_bank
 
 === Ruby on Rails
 

data/VERSION

@@ -1 +1 @@
-3.1.0.pre1
+3.1.0.pre2

data/lib/money/bank/base.rb

@@ -41,6 +41,19 @@ class Money
         @@singleton ||= self.new
       end
 
+      attr_reader :rounding_method
+
+      # Initializes a new Money::Bank::Base object. An optional block can be
+      # passed to dictate the rounding method that +exchange_with+ can use.
+      def initialize(&block)
+        @rounding_method = block
+        setup
+      end
+
+      # Called after initialize. Subclasses can use this method to setup
+      # variables, etc that they normally would in +#initialize+.
+      def setup
+      end
 
       # @deprecated +#exchange+ will be removed in v3.2.0, use +#exchange_with+
       #

data/lib/money/bank/variable_exchange.rb

@@ -22,10 +22,9 @@ class Money
     #
     class VariableExchange < Base
 
-      def initialize(&block)
+      def setup
         @rates = {}
         @mutex = Mutex.new
-        @rounding_method = block
       end
 
 

data/lib/money/money.rb

@@ -149,6 +149,10 @@ class Money
     end
   end
 
+  # Returns a new Money object containing the sum of the two operands'
+  # monetary values. If +other_money+ has a different currency then its
+  # monetary value is automatically exchanged to this object's currency
+  # using +exchange_to+.
   def +(other_money)
     if currency == other_money.currency
       Money.new(cents + other_money.cents, other_money.currency)
@@ -157,6 +161,10 @@ class Money
     end
   end
 
+  # Returns a new Money object containing the difference between the two
+  # operands' monetary values. If +other_money+ has a different currency
+  # then its monetary value is automatically exchanged to this object's
+  # currency using +exchange_to+.
   def -(other_money)
     if currency == other_money.currency
       Money.new(cents - other_money.cents, other_money.currency)
@@ -165,17 +173,25 @@ class Money
     end
   end
 
-  # get the cents value of the object
+  # Gets the cents value of this money object.
+  #
+  #   Money.new(15_00, "USD").cents   # => 15_00
   def cents
     @cents
   end
 
-  # multiply money by fixnum
+  # Multiplies the monetary value with the given number and returns a
+  # new Money object with this monetary value and the same currency.
+  #
+  # Multiplying with another Money object is currently not supported.
   def *(fixnum)
     Money.new(cents * fixnum, currency)
   end
 
-  # divide money by money or fixnum
+  # Divides the monetary value with the given number and returns a
+  # new Money object with this monetary value and the same currency.
+  #
+  # Dividing with another Money object is currently not supported.
   def /(val)
     if val.is_a?(Money)
       if currency == val.currency
@@ -188,7 +204,7 @@ class Money
     end
   end
 
-  # synonym for #/
+  # Synonym for #/.
   def div(val)
     self / val
   end

data/money.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{money}
-  s.version = "3.1.0.pre1"
+  s.version = "3.1.0.pre2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Luetke", "Hongli Lai", "Jeremy McNevin", "Shane Emmons", "Simone Carletti"]
-  s.date = %q{2010-08-03}
+  s.date = %q{2010-08-10}
   s.description = %q{Money and currency exchange support library.}
   s.email = %q{hongli@phusion.nl}
   s.extra_rdoc_files = [

data/spec/bank/base_spec.rb

@@ -1,11 +1,33 @@
 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' do
     it 'should raise NotImplementedError' do
       lambda { @bank.exchange(100, 'USD', 'EUR') }.should raise_exception(NotImplementedError)
@@ -53,5 +75,4 @@ describe Money::Bank::Base do
       lambda{@bank.send(:same_currency?, 'AAA', 'BBB')}.should raise_exception(Money::Currency::UnknownCurrency)
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: money
 version: !ruby/object:Gem::Version 
-  hash: 33582789
+  hash: 341127967
   prerelease: true
   segments: 
   - 3
   - 1
   - 0
-  - pre1
-  version: 3.1.0.pre1
+  - pre2
+  version: 3.1.0.pre2
 platform: ruby
 authors: 
 - Tobias Luetke
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 -04:00
+date: 2010-08-10 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency