carlosbrando-money 2.2.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2005 Tobias Lutke
+Copyright (c) 2008 Phusion
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,97 @@
+= Introduction
+
+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.
+
+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
+
+== 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.us_dollar(100).exchange_to("CAD")  # => Money.new(124, "CAD")
+  Money.ca_dollar(100).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 <tt>rand(2)</tt>:
+
+  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 environment.rb is a very good place to put this. 
+

data/Rakefile

@@ -0,0 +1,18 @@
+desc "Build a gem"
+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
+	ruby "-S spec -f s -c test/*_spec.rb"
+end

data/lib/money.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2005 Tobias Luetke
+# Copyright (c) 2008 Phusion
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+$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,138 @@
+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
+  end
+end

data/lib/money/money.rb

@@ -0,0 +1,345 @@
+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.us_dollar(100).exchange_to("CAD")  # => Money.ca_dollar(124)
+    #   Money.ca_dollar(100).exchange_to("USD")  # => Money.us_dollar(80)
+    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
+
+  # Creates a new Money object of the given value, using the Canadian dollar currency.
+  def self.ca_dollar(cents)
+    Money.new(cents, "CAD")
+  end
+
+  # Creates a new Money object of the given value, using the American dollar currency.
+  def self.us_dollar(cents)
+    Money.new(cents, "USD")
+  end
+  
+  # Creates a new Money object of the given value, using the Euro currency.
+  def self.euro(cents)
+    Money.new(cents, "EUR")
+  end
+  
+  # Creates a new Money object of the given value, using the Brazilian real currency.
+  def self.brazilian_real(cents)
+    Money.new(cents, "BRL")
+  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
+    if currency.is_a?(Hash)
+      # Earlier versions of Money wrongly documented the constructor as being able
+      # to accept something like this:
+      #
+      #   Money.new(50, :currency => "USD")
+      #
+      # We retain compatibility here.
+      @currency = currency[:currency] || Money.default_currency
+    else
+      @currency = currency
+    end
+    @bank = bank
+  end
+
+  # Checks whether two money objects have the same currency and the same amount.
+  # Checks against money objects with a different currency and checks against
+  # objects that do not respond to #to_money will always return false.
+  def ==(other_money)
+    if other_money.respond_to?(:to_money)
+      other_money = other_money.to_money
+      cents == other_money.cents && bank.same_currency?(currency, other_money.currency)
+    else
+      false
+    end
+  end
+  
+  # Compares this money object against another object. +other_money+ must respond
+  # to #to_money.
+  #
+  # If +other_money+ is of a different currency, then +other_money+ will first be
+  # converted into this money object's currency by calling +other_money.exchange+.
+  #
+  # Comparisons against objects that do not respond to #to_money will cause an
+  # ArgumentError to be raised.
+  def <=>(other_money)
+    if other_money.respond_to?(:to_money)
+      other_money = other_money.to_money
+      if bank.same_currency?(currency, other_money.currency)
+        cents <=> other_money.cents
+      else
+        cents <=> other_money.exchange_to(currency).cents
+      end
+    else
+      raise ArgumentError, "comparison of #{self.class} with #{other_money.inspect} failed"
+    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 money or fixnum
+  def /(val)
+    if val.is_a?(Money)
+      if currency == val.currency
+        cents / val.cents.to_f
+      else
+        cents / val.exchange_to(currency).cents.to_f
+      end
+    else
+      Money.new(cents / val, currency)
+    end
+  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, "USD")  => "$1.00"
+  #  Money.new(100, "GBP")  => "£1.00"
+  #  Money.new(100, "EUR")  => "€1.00"
+  #  
+  #  # Same thing.
+  #  Money.new(100, "USD").format(:symbol => true)  => "$1.00"
+  #  Money.new(100, "GBP").format(:symbol => true)  => "£1.00"
+  #  Money.new(100, "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, "USD").format(:symbol => false)  => "1.00"
+  #  Money.new(100, "GBP").format(:symbol => nil)    => "1.00"
+  #  Money.new(100, "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, "AWG").format(:symbol => true)  => "$1.00"
+  #
+  # You can specify a string as value to enforce using a particular symbol:
+  #
+  #  Money.new(100, "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 = currency_unit
+      elsif rules[:symbol]
+        symbol = rules[:symbol]
+      else
+        symbol = ""
+      end
+    else
+      symbol = currency_unit
+    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") or ("10000" => "10.000")
+    formatted.gsub! /(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/, "\\1#{currency_delimiter}\\2"
+
+    # Corrects the decimal separator if necessary.
+    formatted.sub!(/\.(\d{2})$/, "#{currency_separator}\\1") unless rules[:no_cents] || currency_separator == '.'
+    
+    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
+
+  # Return the amount of money as a float. Floating points cannot guarantee
+  # precision. Therefore, this function should only be used when you no longer
+  # need to represent currency or working with another system that requires
+  # decimals.
+  #
+  # Money.us_dollar(100).to_f => 1.0
+  def to_f
+    cents / 100.0
+  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  
+  
+  # Recieve a money object with the same amount as the current Money object
+  # in american dollar 
+  def as_us_dollar
+    exchange_to("USD")
+  end
+  
+  # Recieve a money object with the same amount as the current Money object
+  # in canadian dollar 
+  def as_ca_dollar
+    exchange_to("CAD")
+  end
+  
+  # Recieve a money object with the same amount as the current Money object
+  # in euro
+  def as_euro
+    exchange_to("EUR")
+  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