ShadowBelmolve-money 2.3.1

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/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+lib/money.rb
+lib/money/acts_as_money.rb
+lib/money/core_extensions.rb
+lib/money/errors.rb
+lib/money/money.rb
+lib/money/variable_exchange_bank.rb
+money.gemspec
+rails/init.rb
+script/console
+script/destroy
+script/generate
+spec/db/database.yml
+spec/db/schema.rb
+spec/money/acts_as_money_spec.rb
+spec/money/core_extensions_spec.rb
+spec/money/exchange_bank_spec.rb
+spec/money/money_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tmp/acts_as_money.sqlite3

data/README.rdoc

@@ -0,0 +1,122 @@
+= Money $
+
+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.
+- Provides ActiveRecord "has_money" method.
+
+Resources:
+
+- This fork: http://github.com/nofxx/money
+- 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 ShadowBelmolve-money
+
+
+== Usage
+
+=== Synopsis
+
+  require 'money'
+
+  # 10.00 USD
+  money = Money.new(1000, "USD")
+  money.cents     # => 1000
+  money.currency  # => "USD"
+  money.format    # => "$10.00"
+
+  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")
+
+or
+
+  Money.us_dollar(100).to_cad              # => Money.new(124, "CAD")
+  Money.ca_dollar(100).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 +has_many+ helper to embed the money object in your models.
+The following example requires a +price_in_cents+ and a +price_currency+
+fields.
+
+config/enviroment.rb
+
+  require.gem 'ShadowBelmolve-money', :lib => 'money'
+
+app/models/product.rb
+
+  class Product < ActiveRecord::Base
+    belongs_to :product
+    has_money :price
+
+    validates_numericality_of :price_cents, :greater_than => 0
+  end
+
+migration:
+
+  create_table :products do |t|
+    t.integer :price_cents
+    t.string  :price_currency
+  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.
+
+
+== TODO
+
+* Better validation (fix composed_of allow_nil)
+* Interest (almost there..)
+* Remote rate fetching
+

data/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/money'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('money', Money::VERSION) do |p|
+  p.developer('Money Team', 'see@readme')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name
+  p.summary = "This library aids one in handling money and different currencies."
+  p.description = "This library aids one in handling money and different currencies."
+  p.url = "http://github.com/nofxx/money"
+
+
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+

data/lib/money/acts_as_money.rb

@@ -0,0 +1,41 @@
+# Money require 'money'
+# based on github.com/collectiveidea/acts_as_money
+module ActsAsMoney #:nodoc:
+  def self.included(base) #:nodoc:
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    #
+    # class Product
+    #   has_money :value, :tax, :opts => opts
+    # end
+    #
+    # @product.value.class      #=>  "Money"
+    # @product.value_cents      #=>  "1000"
+    # @product.tax_currency     #=>  "USD"
+    #
+    # Opts:
+    # :cents => "pennys"        #=>  @product.pennys
+    # :currency => "currency"   #=>  @product.currency
+    # :allow_nil => true
+    # :with_currency => false
+    # :with_cents => true       #=>  1000.to_money #=> #<Money @cents=1000>
+    #
+    def has_money(*attributes)
+      config = {:with_currency => true, :with_cents => false,
+                :allow_nil => true }.update(attributes.extract_options!)
+
+      for attribute in attributes do
+        mapping = [[config[:cents] || "#{attribute}_cents", 'cents']]
+        mapping << [config[:currency] || "#{attribute}_currency", 'currency'] if config[:with_currency]
+
+        composed_of attribute, :class_name => 'Money', :allow_nil => config[:allow_nil],
+           :mapping => mapping, :converter => lambda { |m| (m||0).to_money(config[:with_cents]) }
+      end
+
+    end
+
+  end
+
+end

data/lib/money/core_extensions.rb

@@ -0,0 +1,139 @@
+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 if receive false.
+  #
+  #   100.to_money => #<Money @cents=100>
+  #   100.37.to_money => #<Money @cents=10037>
+  #   100.to_money(false) => #<Money @cents=10000>
+  def to_money(cents = false)
+    if cents
+      if self.is_a? Integer
+        Money.new(self)
+      else
+        Money.new(self.to_s.gsub(/\./,'').to_i)
+      end
+    else
+      Money.new(self * 100)
+    end
+  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=100>
+  #   '100.37'.to_money    # => #<Money @cents=10037>
+  #   '100 USD'.to_money   # => #<Money @cents=100, @currency="USD">
+  #   'USD 100'.to_money   # => #<Money @cents=100, @currency="USD">
+  #   '$100 USD'.to_money   # => #<Money @cents=100, @currency="USD">
+  #   '$100 USD'.to_money(false) # => #<Money @cents=10000, @currency="USD">
+  def to_money(with_cents = false)
+    # Get the currency.
+    matches = scan /([A-Z]{2,3})/
+    currency = matches[0] ? matches[0][0] : Money.default_currency
+    cents = calculate_cents(self, with_cents)
+    Money.new(cents, currency)
+  end
+
+  private
+
+  def calculate_cents(number, with_cents = true)
+    # 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)
+
+        # 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
+    # transform to a float, multiply by 100 to convert to cents
+    if with_cents and minor == 0
+      cents = "#{major}.#{minor}".to_f
+    else
+      cents = "#{major}.#{minor}".to_f * 100
+    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,302 @@
+# -*- coding: utf-8 -*-
+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
+    #e 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
+
+  CURRENCIES = {
+    "USD" => { :delimiter => ",", :separator => ".", :symbol => "$" },
+    "CAD" => { :delimiter => ",", :separator => ".", :symbol => "$" },
+    "HKD" => { :delimiter => ",", :separator => ".", :symbol => "$" },
+    "SGD" => { :delimiter => ",", :separator => ".", :symbol => "$" },
+    "BRL" => { :delimiter => ".", :separator => ",", :symbol => "R$" },
+    "EUR" => { :delimiter => ",", :separator => ".", :symbol => '€', :html => '&euro;' },
+    "GBP" => { :delimiter => ",", :separator => ".", :symbol => '£', :html => '&pound;' },
+    "JPY" => { :delimiter => ".", :separator => ".", :symbol => '¥', :html => '&yen;' },
+  }
+  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.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
+    @currency = currency
+    @bank = bank
+  end
+
+  # Do two money objects equal? Only works if both objects are of the same currency
+  def ==(other_money)
+    cents == other_money.cents && bank.same_currency?(currency, other_money.currency)
+  end
+
+  def <=>(other_money)
+    if bank.same_currency?(currency, other_money.currency)
+      cents <=> other_money.cents
+    else
+      cents <=> other_money.exchange_to(currency).cents
+    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 fixnum
+  # check out split_in_installments method too
+  def /(fixnum)
+    Money.new(cents / fixnum, currency)
+  end
+
+  def %(fixnum)
+    Money.new(cents % fixnum, currency)
+  end
+
+  # Test if the money amount is zero
+  def zero?
+    cents == 0
+  end
+
+  # Calculates compound interest
+  # Returns a money object with the sum of self + it
+  def compound_interest(rate,count=1)
+    Money.new(cents * ((1 + rate / 100.0 / 12) ** count - 1))
+  end
+
+  # Calculate self + simple interest
+  def simple_interest(rate,count=1)
+    Money.new(rate/100/12*cents*count)
+  end
+
+  # Split money in number of installments
+  #
+  # Money.new(10_00).split_in_installments(3)
+  # => [ 3.34, 3.33, 3.33 ]  (All Money instances)
+  #
+  def split_in_installments(fixnum,extra=nil,*opts)
+    wallet = Wallet.new(fixnum, Money.new(cents/fixnum,currency))
+    to_add = cents % fixnum
+    to_add.times { |m| wallet[m] += Money.new(1) }
+    wallet
+  end
+
+  # Split money in installments based on payment value
+  #
+  # Money.new(1000_00).split_in_installments(Money.new(300_00))
+  # => [ 334_00, 333_00, 333_00 ]  (All Money instances)
+  #
+  def in_installments_of(other_money,first=false)
+    split_in_installments(cents/other_money.cents,first)
+  end
+
+  # Just a helper if you got tax inputs in percentage.
+  # Ie. add_tax(20) =>  cents * 1.20
+  def add_tax(tax)
+    Money.new(cents + cents / 100 * tax)
+  end
+
+  # Format the price according to several rules
+  # Currently supported are :with_currency, :no_cents, :symbol and :html
+  #
+  # with_currency:
+  #
+  #  Money.ca_dollar(0).format => "free"
+  #  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:
+  #
+  #  Money.ca_dollar(100).format(:no_cents) => "$1"
+  #  Money.ca_dollar(599).format(:no_cents) => "$5"
+  #
+  #  Money.ca_dollar(570).format(:no_cents, :with_currency) => "$5 CAD"
+  #  Money.ca_dollar(39000).format(:no_cents) => "$390"
+  #
+  # symbol:
+  #
+  #  Money.new(100, :currency => "GBP").format(:symbol => "£") => "£1.00"
+  #
+  # html:
+  #
+  #  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]
+        symbol = rules[:symbol]
+      else
+        symbol = ""
+      end
+    else
+      symbol = CURRENCIES[currency][:symbol]
+    end
+
+    if rules[:no_cents]
+      formatted = sprintf("#{symbol}%d", cents.to_f / 100)
+      formatted.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{CURRENCIES[currency][:delimiter]}")
+    else
+      formatted = sprintf("#{symbol}%.2f", cents.to_f / 100).split('.')
+      formatted[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{CURRENCIES[currency][:delimiter]}")
+      formatted = formatted.join(CURRENCIES[currency][:separator])
+    end
+
+    # Commify ("10000" => "10,000")
+    formatted.gsub!(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/,'\1,\2')
+
+    if rules[:with_currency]
+      formatted << " "
+      formatted << '<span class="currency">' if rules[:html]
+      formatted << currency
+      formatted << '</span>' if rules[:html]
+    end
+    formatted
+  end
+
+   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
+
+
+  # Money.ca_dollar(100).to_s => "1.00"
+  def to_s
+    sprintf("%.2f", cents / 100.0)
+  end
+
+  # Money.ca_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
+
+  # Conversation to self
+  def to_money
+    self
+  end
+
+  def method_missing(m,*x)
+    if m.to_s =~ /^as/
+      exchange_to(m.to_s.split("_").last.upcase)
+    else
+      super
+    end
+  end
+end
+
+#
+# Represent a financial array.
+# Investment/Time/Installments...
+#
+class Wallet < Array
+
+  def to_s
+    map &:to_s
+  end
+
+  def sum
+    Money.new(inject(0){ |sum,m| sum + m.cents })
+  end
+
+end