money 3.6.1 → 3.6.2

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

data/lib/money/money/formatting.rb

@@ -0,0 +1,234 @@
+class Money
+  module Formatting
+    if Object.const_defined?("I18n")
+      def thousands_separator
+        I18n.t(
+          :"number.currency.format.delimiter",
+          :default => I18n.t(
+            :"number.format.delimiter",
+            :default => (currency.thousands_separator || ",")
+        )
+        )
+      end
+    else
+      def thousands_separator
+        currency.thousands_separator || ","
+      end
+    end
+    alias :delimiter :thousands_separator
+
+    if Object.const_defined?("I18n")
+      def decimal_mark
+        I18n.t(
+          :"number.currency.format.separator",
+          :default => I18n.t(
+            :"number.format.separator",
+            :default => (currency.decimal_mark || ".")
+        )
+        )
+      end
+    else
+      def decimal_mark
+        currency.decimal_mark || "."
+      end
+    end
+    alias :separator :decimal_mark
+
+    # Creates a formatted price string according to several rules.
+    #
+    # @param [Hash] *rules The options used to format the string.
+    #
+    # @return [String]
+    #
+    # @option *rules [Boolean, String] :display_free (false) Whether a zero
+    #  amount of money should be formatted of "free" or as the supplied string.
+    #
+    # @example
+    #   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"
+    #
+    # @option *rules [Boolean] :with_currency (false) Whether the currency name
+    #  should be appended to the result string.
+    #
+    # @example
+    #   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"
+    #
+    # @option *rules [Boolean] :no_cents (false) Whether cents should be omitted.
+    #
+    # @example
+    #   Money.ca_dollar(100).format(:no_cents => true) #=> "$1"
+    #   Money.ca_dollar(599).format(:no_cents => true) #=> "$5"
+    #
+    # @option *rules [Boolean] :no_cents_if_whole (false) Whether cents should be 
+    #  omitted if the cent value is zero
+    #
+    # @example
+    #   Money.ca_dollar(10000).format(:no_cents_if_whole => true) #=> "$100"
+    #   Money.ca_dollar(10034).format(:no_cents_if_whole => true) #=> "$100.34"
+    #
+    # @option *rules [Boolean, String, nil] :symbol (true) 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.
+    #
+    # @example
+    #   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"
+    #
+    # @option *rules [Boolean, String, nil] :decimal_mark (true) Whether the
+    #  currency should be separated by the specified character or '.'
+    #
+    # @example
+    #   # If a string is specified, it's value is used.
+    #   Money.new(100, "USD").format(:decimal_mark => ",") #=> "$1,00"
+    #
+    #   # If the decimal_mark for a given currency isn't known, then it will default
+    #   # to "." as decimal_mark.
+    #   Money.new(100, "FOO").format #=> "$1.00"
+    #
+    # @option *rules [Boolean, String, nil] :thousands_separator (true) Whether
+    #  the currency should be delimited by the specified character or ','
+    #
+    # @example
+    #   # If false is specified, no thousands_separator is used.
+    #   Money.new(100000, "USD").format(:thousands_separator => false) #=> "1000.00"
+    #   Money.new(100000, "USD").format(:thousands_separator => nil)   #=> "1000.00"
+    #   Money.new(100000, "USD").format(:thousands_separator => "")    #=> "1000.00"
+    #
+    #   # If a string is specified, it's value is used.
+    #   Money.new(100000, "USD").format(:thousands_separator => ".") #=> "$1.000.00"
+    #
+    #   # If the thousands_separator for a given currency isn't known, then it will
+    #   # default to "," as thousands_separator.
+    #   Money.new(100000, "FOO").format #=> "$1,000.00"
+    #
+    # @option *rules [Boolean] :html (false) Whether the currency should be
+    #  HTML-formatted. Only useful in combination with +:with_currency+.
+    #
+    # @example
+    #   s = Money.ca_dollar(570).format(:html => true, :with_currency => true)
+    #   s #=>  "$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
+
+      symbol_value =
+        if rules.has_key?(:symbol)
+          if rules[:symbol] === true
+            symbol
+          elsif rules[:symbol]
+            rules[:symbol]
+          else
+            ""
+          end
+        elsif rules[:html]
+          currency.html_entity
+        else
+          symbol
+        end
+
+      formatted = case rules[:no_cents]
+                  when true
+                    "#{self.to_s.to_i}"
+                  else
+                    "#{self.to_s}"
+                  end
+                  
+      if rules[:no_cents_if_whole] && cents % currency.subunit_to_unit == 0
+        formatted = "#{self.to_s.to_i}"
+      end
+
+      symbol_position =
+        if rules.has_key?(:symbol_position)
+          rules[:symbol_position]
+        elsif currency.symbol_first?
+          :before
+        else
+          :after
+        end
+
+      if symbol_value && !symbol_value.empty?
+        formatted = (symbol_position == :before ? "#{symbol_value}#{formatted}" : "#{formatted} #{symbol_value}")
+      end
+
+      if rules.has_key?(:decimal_mark) and rules[:decimal_mark] and
+        rules[:decimal_mark] != decimal_mark
+        formatted.sub!(decimal_mark, rules[:decimal_mark])
+      end
+
+      thousands_separator_value = thousands_separator
+      # Determine thousands_separator
+      if rules.has_key?(:thousands_separator)
+        if rules[:thousands_separator] === false or rules[:thousands_separator].nil?
+          thousands_separator_value = ""
+        elsif rules[:thousands_separator]
+          thousands_separator_value = rules[:thousands_separator]
+        end
+      end
+
+      # Apply thousands_separator
+      formatted.gsub!(/(\d)(?=(?:\d{3})+(?:[^\d]|$))/, "\\1#{thousands_separator_value}")
+
+      if rules[:with_currency]
+        formatted << " "
+        formatted << '<span class="currency">' if rules[:html]
+        formatted << currency.to_s
+        formatted << '</span>' if rules[:html]
+      end
+      formatted
+    end
+
+
+    private
+
+    # Cleans up formatting rules.
+    #
+    # @param [Hash]
+    #
+    # @return [Hash]
+    def normalize_formatting_rules(rules)
+      if rules.size == 0
+        rules = {}
+      elsif rules.size == 1
+        rules = rules.pop
+        rules = { rules => true } if rules.is_a?(Symbol)
+      end
+      if not rules.include?(:decimal_mark) and rules.include?(:separator)
+        rules[:decimal_mark] = rules[:separator]
+      end
+      if not rules.include?(:thousands_separator) and rules.include?(:delimiter)
+        rules[:thousands_separator] = rules[:delimiter]
+      end
+      rules
+    end
+  end
+end