@@ -1 +1,2 @@ *.gem +doc .gitignore @@ -9,8 +9,20 @@ This library aids one in handling money and different currencies. Features: - Provides APIs for exchanging money from one currency to another. - Has the ability to parse a money string into a Money object. +Resources: + +- Website: http://money.rubyforge.org +- RDoc API: http://money.rubyforge.org +- Git repository: http://github.com/FooBarWidget/money/tree/master + == Download +Install stable releases with the following command: + + gem install money + +The development version (hosted on Github) can be installed with: + gem sources -a http://gems.github.com gem install FooBarWidget-money @@ -18,6 +30,8 @@ This library aids one in handling money and different currencies. Features: === Synopsis + require 'money' + # 10.00 USD money = Money.new(1000, "USD") money.cents # => 1000 @@ -79,5 +93,5 @@ By default Money defaults to USD as its currency. This can be overwritten using Money.default_currency = "CAD" -If you use Rails, the environment.rb is a very good place to put this. +If you use Rails, then environment.rb is a very good place to put this. README.rdoc @@ -3,6 +3,15 @@ task :gem do sh "gem build money.gemspec" end +task "Generate RDoc documentation" +task :rdoc do + sh "hanna README.rdoc lib -U" +end + +task :upload => :rdoc do + sh "scp -r doc/* rubyforge.org:/var/www/gforge-projects/money/" +end + desc "Run unit tests" task :test do sh "spec -f s -c test/*_spec.rb" Rakefile @@ -1,23 +1,23 @@ -# 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> 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 -# 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"> 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"> def to_money # Get the currency. matches = scan /([A-Z]{2,3})/ lib/money/core_extensions.rb @@ -1,7 +1,13 @@ require 'thread' require 'money/errors' -# Example useage: +# 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) @@ -13,6 +19,9 @@ require 'money/errors' # 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 @@ -22,22 +31,34 @@ class Money @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 lib/money/variable_exchange_bank.rb @@ -6,6 +6,7 @@ Gem::Specification.new do |s| s.homepage = "http://github.com/FooBarWidget/money/tree/master" s.description = "Money and currency exchange support library." s.has_rdoc = false + s.rubyforge_project = "money" s.authors = ["Tobias Luetke", "Hongli Lai"] s.files = [ money.gemspec ccf2496f7a154ec9341b0a82e48e8251d3b1bd31 Hongli Lai (Phusion) hongli@phusion.nl http://github.com/FooBarWidget/money/commit/a1ad4a7ad5c64709134e35890a2467287fe1fdbf a1ad4a7ad5c64709134e35890a2467287fe1fdbf 2008-10-31T11:17:38-07:00 2008-10-31T11:17:38-07:00 Update documentation and URLs. 268e8b93eff416435bdffe63592dd36feb6def86 Hongli Lai (Phusion) hongli@phusion.nl