papercavalier-money 3.7.1

data/lib/money/money.rb

@@ -0,0 +1,405 @@
+# encoding: utf-8
+require 'money/bank/variable_exchange'
+require 'money/money/arithmetic'
+require 'money/money/parsing'
+require 'money/money/formatting'
+
+# Represents an amount of money in a given currency.
+class Money
+  include Comparable
+  include Arithmetic
+  include Formatting
+  include Parsing
+
+  # The value of the money in cents.
+  #
+  # @return [Integer]
+  attr_reader :cents
+
+  # The currency the money is in.
+  #
+  # @return [Currency]
+  attr_reader :currency
+
+  # The +Money::Bank+ based object used to perform currency exchanges with.
+  #
+  # @return [Money::Bank::*]
+  attr_reader :bank
+
+  # Class Methods
+  class << self
+    # Each Money object is associated to a bank object, which is responsible
+    # for currency exchange. This property allows you to specify the default
+    # bank object. The default value for this property is an instance if
+    # +Bank::VariableExchange.+ It allows one to specify custom exchange rates.
+    #
+    # @return [Money::Bank::*]
+    attr_accessor :default_bank
+
+    # The default currency, which is used when +Money.new+ is called without an
+    # explicit currency argument. The default value is Currency.new("USD"). The
+    # value must be a valid +Money::Currency+ instance.
+    #
+    # @return [Money::Currency]
+    attr_accessor :default_currency
+
+    # Use this to disable i18n even if it's used by other objects in your app.
+    #
+    # @return [true,false]
+    attr_accessor :use_i18n
+  end
+
+  # Set the default bank for creating new +Money+ objects.
+  self.default_bank = Bank::VariableExchange.instance
+
+  # Set the default currency for creating new +Money+ object.
+  self.default_currency = Currency.new("USD")
+
+  # Default to using i18n
+  self.use_i18n = true
+
+  # Create a new money object with value 0.
+  #
+  # @param [Currency, String, Symbol] currency The currency to use.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   Money.empty #=> #<Money @cents=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.
+  #
+  # @param [Integer] cents The cents value.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   n = Money.ca_dollar(100)
+  #   n.cents    #=> 100
+  #   n.currency #=> #<Money::Currency id: cad>
+  def self.ca_dollar(cents)
+    Money.new(cents, "CAD")
+  end
+
+  # Creates a new Money object of the given value, using the American dollar
+  # currency.
+  #
+  # @param [Integer] cents The cents value.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   n = Money.us_dollar(100)
+  #   n.cents    #=> 100
+  #   n.currency #=> #<Money::Currency id: usd>
+  def self.us_dollar(cents)
+    Money.new(cents, "USD")
+  end
+
+  # Creates a new Money object of the given value, using the Euro currency.
+  #
+  # @param [Integer] cents The cents value.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   n = Money.euro(100)
+  #   n.cents    #=> 100
+  #   n.currency #=> #<Money::Currency id: eur>
+  def self.euro(cents)
+    Money.new(cents, "EUR")
+  end
+
+
+  # Creates a new Money object of +amount+ value in dollars,
+  # with given +currency+.
+  #
+  # The amount value is expressed in +dollars+
+  # where the +dollar+ is the main monetary unit,
+  # opposite to the subunit-based representation
+  # used internally by this library called +cents+.
+  #
+  # @param [Numeric] amount The money amount, in dollars.
+  # @param [Currency, String, Symbol] currency The currency format.
+  # @param [Money::Bank::*] bank The exchange bank to use.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   Money.new_with_dollars(100)
+  #   #=> #<Money @cents=10000 @currency="USD">
+  #   Money.new_with_dollars(100, "USD")
+  #   #=> #<Money @cents=10000 @currency="USD">
+  #   Money.new_with_dollars(100, "EUR")
+  #   #=> #<Money @cents=10000 @currency="EUR">
+  #
+  # @see Money.new
+  #
+  def self.new_with_dollars(amount, currency = Money.default_currency, bank = Money.default_bank)
+    money = from_numeric(amount, currency)
+    # Hack! You can't change a bank
+    money.instance_variable_set("@bank", bank)
+    money
+  end
+  # Adds a new exchange rate to the default bank and return the rate.
+  #
+  # @param [Currency, String, Symbol] from_currency Currency to exchange from.
+  # @param [Currency, String, Symbol] to_currency Currency to exchange to.
+  # @param [Numeric] rate Rate to exchange with.
+  #
+  # @return [Numeric]
+  #
+  # @example
+  #   Money.add_rate("USD", "CAD", 1.25) #=> 1.25
+  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 of +cents+ value in cents,
+  # with given +currency+.
+  #
+  # Alternatively you can use the convenience
+  # methods like {Money.ca_dollar} and {Money.us_dollar}.
+  #
+  # @param [Integer] cents The money amount, in cents.
+  # @param [Currency, String, Symbol] currency The currency format.
+  # @param [Money::Bank::*] bank The exchange bank to use.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   Money.new(100)
+  #   #=> #<Money @cents=100 @currency="USD">
+  #   Money.new(100, "USD")
+  #   #=> #<Money @cents=100 @currency="USD">
+  #   Money.new(100, "EUR")
+  #   #=> #<Money @cents=100 @currency="EUR">
+  #
+  # @see Money.new_with_dollars
+  #
+  def initialize(cents, currency = Money.default_currency, bank = Money.default_bank)
+    @cents = cents.round.to_i
+    @currency = Currency.wrap(currency)
+    @bank = bank
+  end
+
+  # Returns the value of the money in dollars,
+  # instead of in cents.
+  #
+  # @return [Float]
+  #
+  # @example
+  #   Money.new(100).dollars           # => 1.0
+  #   Money.new_with_dollars(1).dollar # => 1.0
+  #
+  # @see #to_f
+  # @see #cents
+  #
+  def dollars
+    to_f
+  end
+
+  # Return string representation of currency object
+  #
+  # @return [String]
+  #
+  # @example
+  #   Money.new(100, :USD).currency_as_string #=> "USD"
+  def currency_as_string
+    self.currency.to_s
+  end
+
+  # Set currency object using a string
+  #
+  # @param [String] val The currency string.
+  #
+  # @return [Money::Currency]
+  #
+  # @example
+  #   Money.new(100).currency_as_string("CAD") #=> #<Money::Currency id: cad>
+  def currency_as_string=(val)
+    @currency = Currency.wrap(val)
+  end
+
+  # Returns a Fixnum hash value based on the +cents+ and +currency+ attributes
+  # in order to use functions like & (intersection), group_by, etc.
+  #
+  # @return [Fixnum]
+  #
+  # @example
+  #   Money.new(100).hash #=> 908351
+  def hash
+    [cents.hash, currency.hash].hash
+  end
+
+  # Uses +Currency#symbol+. If +nil+ is returned, defaults to "¤".
+  #
+  # @return [String]
+  #
+  # @example
+  #   Money.new(100, "USD").symbol #=> "$"
+  def symbol
+    currency.symbol || "¤"
+  end
+
+  # Returns the amount of money as a string.
+  #
+  # @return [String]
+  #
+  # @example
+  #   Money.ca_dollar(100).to_s #=> "1.00"
+  def to_s
+    unit, subunit  = cents.abs.divmod(currency.subunit_to_unit).map{|o| o.to_s}
+    if currency.decimal_places == 0
+      return "-#{unit}" if cents < 0
+      return unit
+    end
+    subunit = (("0" * currency.decimal_places) + subunit)[(-1*currency.decimal_places)..-1]
+    return "-#{unit}#{decimal_mark}#{subunit}" if cents < 0
+    "#{unit}#{decimal_mark}#{subunit}"
+  end
+
+  # Return the amount of money as a BigDecimal.
+  #
+  # @return [BigDecimal]
+  #
+  # @example
+  #   Money.us_dollar(100).to_d => BigDecimal.new("1.0")
+  def to_d
+    BigDecimal.new(cents.to_s) / BigDecimal.new(currency.subunit_to_unit.to_s)
+  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.
+  #
+  # @return [Float]
+  #
+  # @example
+  #   Money.us_dollar(100).to_f => 1.0
+  def to_f
+    to_d.to_f
+  end
+
+  # Receive the amount of this money object in another Currency.
+  #
+  # @param [Currency, String, Symbol] other_currency Currency to exchange to.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   Money.new(2000, "USD").exchange_to("EUR")
+  #   Money.new(2000, "USD").exchange_to(Currency.new("EUR"))
+  def exchange_to(other_currency)
+    other_currency = Currency.wrap(other_currency)
+    @bank.exchange_with(self, other_currency)
+  end
+
+  # Receive a money object with the same amount as the current Money object
+  # in american dollars.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   n = Money.new(100, "CAD").as_us_dollar
+  #   n.currency #=> #<Money::Currency id: usd>
+  def as_us_dollar
+    exchange_to("USD")
+  end
+
+  # Receive a money object with the same amount as the current Money object
+  # in canadian dollar.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   n = Money.new(100, "USD").as_ca_dollar
+  #   n.currency #=> #<Money::Currency id: cad>
+  def as_ca_dollar
+    exchange_to("CAD")
+  end
+
+  # Receive a money object with the same amount as the current Money object
+  # in euro.
+  #
+  # @return [Money]
+  #
+  # @example
+  #   n = Money.new(100, "USD").as_euro
+  #   n.currency #=> #<Money::Currency id: eur>
+  def as_euro
+    exchange_to("EUR")
+  end
+
+  # Conversation to +self+.
+  #
+  # @return [self]
+  def to_money
+    self
+  end
+
+  # Common inspect function
+  #
+  # @return [String]
+  def inspect
+    "#<Money cents:#{cents} currency:#{currency}>"
+  end
+
+  # 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
+  #
+  # @param [0.50, 0.25, 0.25] to give 50% of the cash to party1, 25% ot party2, and 25% to party3.
+  #
+  # @return [Array<Money, Money, Money>]
+  #
+  # @example
+  #   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 }
+    raise ArgumentError, "splits add to more then 100%" if (allocations - 1.0) > Float::EPSILON
+
+    left_over = cents
+
+    amounts = splits.collect do |ratio|
+      fraction = (cents * ratio / allocations).floor
+      left_over -= fraction
+      fraction
+    end
+
+    left_over.times { |i| amounts[i % amounts.length] += 1 }
+
+    return amounts.collect { |cents| Money.new(cents, currency) }
+  end
+
+  # Split money amongst parties evenly without loosing pennies.
+  #
+  # @param [2] number of parties.
+  #
+  # @return [Array<Money, Money, Money>]
+  #
+  # @example
+  #   Money.new(100, "USD").split(3) #=> [Money.new(34), Money.new(33), Money.new(33)]
+  def split(num)
+    raise ArgumentError, "need at least one party" if num < 1
+    low = Money.new(cents / num)
+    high = Money.new(low.cents + 1)
+
+    remainder = cents % num
+    result = []
+
+    num.times do |index|
+      result[index] = index < remainder ? high : low
+    end
+
+    return result
+  end
+end

data/lib/money/money/arithmetic.rb

@@ -0,0 +1,246 @@
+class Money
+  module Arithmetic
+
+    # 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.
+    #
+    # @param [Money] other_money Value to compare with.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   Money.new(100) == Money.new(101) #=> false
+    #   Money.new(100) == Money.new(100) #=> true
+    def ==(other_money)
+      if other_money.respond_to?(:to_money)
+        other_money = other_money.to_money
+        cents == other_money.cents && self.currency == other_money.currency
+      else
+        false
+      end
+    end
+
+    # Synonymous with +#==+.
+    #
+    # @param [Money] other_money Value to compare with.
+    #
+    # @return [Money]
+    #
+    # @see #==
+    def eql?(other_money)
+      self == other_money
+    end
+
+    def <=>(other_money)
+      if other_money.respond_to?(:to_money)
+        other_money = other_money.to_money
+        if self.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
+
+    # 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+.
+    #
+    # @param [Money] other_money Other +Money+ object to add.
+    #
+    # @return [Money]
+    #
+    # @example
+    #   Money.new(100) + Money.new(100) #=> #<Money @cents=200>
+    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
+
+    # 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+.
+    #
+    # @param [Money] other_money Other +Money+ object to subtract.
+    #
+    # @return [Money]
+    #
+    # @example
+    #   Money.new(100) - Money.new(99) #=> #<Money @cents=1>
+    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
+
+    # Multiplies the monetary value with the given number and returns a new
+    # +Money+ object with this monetary value and the same currency.
+    #
+    # Note that you can't multiply a Money object by an other +Money+ object.
+    #
+    # @param [Numeric] value Number to multiply by.
+    #
+    # @return [Money] The resulting money.
+    #
+    # @raise [ArgumentError] If +value+ is a Money instance.
+    #
+    # @example
+    #   Money.new(100) * 2 #=> #<Money @cents=200>
+    #
+    def *(value)
+      if value.is_a?(Money)
+        raise ArgumentError, "Can't multiply a Money by a Money"
+      else
+        Money.new(cents * value, currency)
+      end
+    end
+
+    # Divides the monetary value with the given number and returns a new +Money+
+    # object with this monetary value and the same currency.
+    # Can also divide by another +Money+ object to get a ratio.
+    #
+    # +Money/Numeric+ returns +Money+. +Money/Money+ returns +Float+.
+    #
+    # @param [Money, Numeric] value Number to divide by.
+    #
+    # @return [Money] The resulting money if you divide Money by a number.
+    # @return [Float] The resulting number if you divide Money by a Money.
+    #
+    # @example
+    #   Money.new(100) / 10            #=> #<Money @cents=10>
+    #   Money.new(100) / Money.new(10) #=> 10.0
+    #
+    def /(value)
+      if value.is_a?(Money)
+        if currency == value.currency
+          (cents / BigDecimal.new(value.cents.to_s)).to_f
+        else
+          (cents / BigDecimal(value.exchange_to(currency).cents.to_s)).to_f
+        end
+      else
+        Money.new(cents / value, currency)
+      end
+    end
+
+    # Synonym for +#/+.
+    #
+    # @param [Money, Numeric] value Number to divide by.
+    #
+    # @return [Money] The resulting money if you divide Money by a number.
+    # @return [Float] The resulting number if you divide Money by a Money.
+    #
+    # @see #/
+    #
+    def div(value)
+      self / value
+    end
+
+    # Divide money by money or fixnum and return array containing quotient and
+    # modulus.
+    #
+    # @param [Money, Fixnum] val Number to divmod by.
+    #
+    # @return [Array<Money,Money>,Array<Fixnum,Money>]
+    #
+    # @example
+    #   Money.new(100).divmod(9)            #=> [#<Money @cents=11>, #<Money @cents=1>]
+    #   Money.new(100).divmod(Money.new(9)) #=> [11, #<Money @cents=1>]
+    def divmod(val)
+      if val.is_a?(Money)
+        a = self.cents
+        b = self.currency == val.currency ? val.cents : val.exchange_to(self.currency).cents
+        q, m = a.divmod(b)
+        return [q, Money.new(m, self.currency)]
+      else
+        return [self.div(val), Money.new(self.cents.modulo(val), self.currency)]
+      end
+    end
+
+    # Equivalent to +self.divmod(val)[1]+
+    #
+    # @param [Money, Fixnum] val Number take modulo with.
+    #
+    # @return [Money]
+    #
+    # @example
+    #   Money.new(100).modulo(9)            #=> #<Money @cents=1>
+    #   Money.new(100).modulo(Money.new(9)) #=> #<Money @cents=1>
+    def modulo(val)
+      self.divmod(val)[1]
+    end
+
+    # Synonym for +#modulo+.
+    #
+    # @param [Money, Fixnum] val Number take modulo with.
+    #
+    # @return [Money]
+    #
+    # @see #modulo
+    def %(val)
+      self.modulo(val)
+    end
+
+    # If different signs +self.modulo(val) - val+ otherwise +self.modulo(val)+
+    #
+    # @param [Money, Fixnum] val Number to rake remainder with.
+    #
+    # @return [Money]
+    #
+    # @example
+    #   Money.new(100).remainder(9) #=> #<Money @cents=1>
+    def remainder(val)
+      a, b = self, val
+      b = b.exchange_to(a.currency) if b.is_a?(Money) and a.currency != b.currency
+
+      a_sign, b_sign = :pos, :pos
+      a_sign = :neg if a.cents < 0
+      b_sign = :neg if (b.is_a?(Money) and b.cents < 0) or (b < 0)
+
+      return a.modulo(b) if a_sign == b_sign
+      a.modulo(b) - (b.is_a?(Money) ? b : Money.new(b, a.currency))
+    end
+
+    # Return absolute value of self as a new Money object.
+    #
+    # @return [Money]
+    #
+    # @example
+    #   Money.new(-100).abs #=> #<Money @cents=100>
+    def abs
+      Money.new(self.cents.abs, self.currency)
+    end
+
+    # Test if the money amount is zero.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   Money.new(100).zero? #=> false
+    #   Money.new(0).zero?   #=> true
+    def zero?
+      cents == 0
+    end
+
+    # Test if the money amount is non-zero. Returns this money object if it is
+    # non-zero, or nil otherwise, like +Numeric#nonzero?+.
+    #
+    # @return [Money, nil]
+    #
+    # @example
+    #   Money.new(100).nonzero? #=> #<Money @cents=100>
+    #   Money.new(0).nonzero?   #=> nil
+    def nonzero?
+      cents != 0 ? self : nil
+    end
+
+  end
+end