papercavalier-money 3.7.1

data/lib/money/money/formatting.rb

@@ -0,0 +1,244 @@
+class Money
+  module Formatting
+
+    if Object.const_defined?("I18n")
+      def thousands_separator
+        if self.class.use_i18n
+          I18n.t(
+            :"number.currency.format.delimiter",
+            :default => I18n.t(
+              :"number.format.delimiter",
+              :default => (currency.thousands_separator || ",")
+            )
+          )
+        else
+          currency.thousands_separator || ","
+        end
+      end
+    else
+      def thousands_separator
+        currency.thousands_separator || ","
+      end
+    end
+    alias :delimiter :thousands_separator
+
+
+    if Object.const_defined?("I18n")
+      def decimal_mark
+        if self.class.use_i18n
+          I18n.t(
+            :"number.currency.format.separator",
+            :default => I18n.t(
+              :"number.format.separator",
+              :default => (currency.decimal_mark || ".")
+            )
+          )
+        else
+          currency.decimal_mark || "."
+        end
+      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

data/lib/money/money/parsing.rb

@@ -0,0 +1,350 @@
+class Money
+  module Parsing
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Parses the current string and converts it to a +Money+ object.
+      # Excess characters will be discarded.
+      #
+      # @param [String, #to_s] input The input to parse.
+      # @param [Currency, String, Symbol] currency The currency format.
+      #   The currency to set the resulting +Money+ object to.
+      #
+      # @return [Money]
+      #
+      # @raise [ArgumentError] If any +currency+ is supplied and
+      #   given value doesn't match the one extracted from
+      #   the +input+ string.
+      #
+      # @example
+      #   '100'.to_money                #=> #<Money @cents=10000>
+      #   '100.37'.to_money             #=> #<Money @cents=10037>
+      #   '100 USD'.to_money            #=> #<Money @cents=10000, @currency=#<Money::Currency id: usd>>
+      #   'USD 100'.to_money            #=> #<Money @cents=10000, @currency=#<Money::Currency id: usd>>
+      #   '$100 USD'.to_money           #=> #<Money @cents=10000, @currency=#<Money::Currency id: usd>>
+      #   'hello 2000 world'.to_money   #=> #<Money @cents=200000 @currency=#<Money::Currency id: usd>>
+      #
+      # @example Mismatching currencies
+      #   'USD 2000'.to_money("EUR")    #=> ArgumentError
+      #
+      # @see Money.from_string
+      #
+      def parse(input, currency = nil)
+        i = input.to_s
+
+        # Get the currency.
+        m = i.scan /([A-Z]{2,3})/
+          c = m[0] ? m[0][0] : nil
+
+        # check that currency passed and embedded currency are the same,
+        # and negotiate the final currency
+        if currency.nil? and c.nil?
+          currency = Money.default_currency
+        elsif currency.nil?
+          currency = c
+        elsif c.nil?
+          currency = currency
+        elsif currency != c
+          # TODO: ParseError
+          raise ArgumentError, "Mismatching Currencies"
+        end
+        currency = Money::Currency.wrap(currency)
+
+        cents = extract_cents(i, currency)
+        new(cents, currency)
+      end
+
+      # Converts a String into a Money object treating the +value+
+      # as dollars and converting them to the corresponding cents value,
+      # according to +currency+ subunit property,
+      # before instantiating the Money object.
+      #
+      # Behind the scenes, this method relies on {Money.from_bigdecimal}
+      # to avoid problems with string-to-numeric conversion.
+      #
+      # @param [String, #to_s] value The money amount, in dollars.
+      # @param [Currency, String, Symbol] currency
+      #   The currency to set the resulting +Money+ object to.
+      #
+      # @return [Money]
+      #
+      # @example
+      #   Money.from_string("100")
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_string("100", "USD")
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_string("100", "EUR")
+      #   #=> #<Money @cents=10000 @currency="EUR">
+      #   Money.from_string("100", "BHD")
+      #   #=> #<Money @cents=100 @currency="BHD">
+      #
+      # @see String#to_money
+      # @see Money.parse
+      #
+      def from_string(value, currency = Money.default_currency)
+        from_bigdecimal(BigDecimal.new(value.to_s), currency)
+      end
+
+      # Converts a Fixnum into a Money object treating the +value+
+      # as dollars and converting them to the corresponding cents value,
+      # according to +currency+ subunit property,
+      # before instantiating the Money object.
+      #
+      # @param [Fixnum] value The money amount, in dollars.
+      # @param [Currency, String, Symbol] currency The currency format.
+      #
+      # @return [Money]
+      #
+      # @example
+      #   Money.from_fixnum(100)
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_fixnum(100, "USD")
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_fixnum(100, "EUR")
+      #   #=> #<Money @cents=10000 @currency="EUR">
+      #   Money.from_fixnum(100, "BHD")
+      #   #=> #<Money @cents=100 @currency="BHD">
+      #
+      # @see Fixnum#to_money
+      # @see Money.from_numeric
+      #
+      def from_fixnum(value, currency = Money.default_currency)
+        currency = Money::Currency.wrap(currency)
+        amount   = value * currency.subunit_to_unit
+        new(amount, currency)
+      end
+
+      # Converts a Float into a Money object treating the +value+
+      # as dollars and converting them to the corresponding cents value,
+      # according to +currency+ subunit property,
+      # before instantiating the Money object.
+      #
+      # Behind the scenes, this method relies on Money.from_bigdecimal
+      # to avoid problems with floating point precision.
+      #
+      # @param [Float] value The money amount, in dollars.
+      # @param [Currency, String, Symbol] currency The currency format.
+      #
+      # @return [Money]
+      #
+      # @example
+      #   Money.from_float(100.0)
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_float(100.0, "USD")
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_float(100.0, "EUR")
+      #   #=> #<Money @cents=10000 @currency="EUR">
+      #   Money.from_float(100.0, "BHD")
+      #   #=> #<Money @cents=100 @currency="BHD">
+      #
+      # @see Float#to_money
+      # @see Money.from_numeric
+      #
+      def from_float(value, currency = Money.default_currency)
+        from_bigdecimal(BigDecimal.new(value.to_s), currency)
+      end
+
+      # Converts a BigDecimal into a Money object treating the +value+
+      # as dollars and converting them to the corresponding cents value,
+      # according to +currency+ subunit property,
+      # before instantiating the Money object.
+      #
+      # @param [BigDecimal] value The money amount, in dollars.
+      # @param [Currency, String, Symbol] currency The currency format.
+      #
+      # @return [Money]
+      #
+      # @example
+      #   Money.from_bigdecimal(BigDecimal.new("100")
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_bigdecimal(BigDecimal.new("100", "USD")
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_bigdecimal(BigDecimal.new("100", "EUR")
+      #   #=> #<Money @cents=10000 @currency="EUR">
+      #   Money.from_bigdecimal(BigDecimal.new("100", "BHD")
+      #   #=> #<Money @cents=100 @currency="BHD">
+      #
+      # @see BigDecimal#to_money
+      # @see Money.from_numeric
+      #
+      def from_bigdecimal(value, currency = Money.default_currency)
+        currency = Money::Currency.wrap(currency)
+        amount   = value * currency.subunit_to_unit
+        new(amount.fix, currency)
+      end
+
+      # Converts a Numeric value into a Money object treating the +value+
+      # as dollars and converting them to the corresponding cents value,
+      # according to +currency+ subunit property,
+      # before instantiating the Money object.
+      #
+      # This method relies on various +Money.from_*+ methods
+      # and tries to forwards the call to the most appropriate method
+      # in order to reduce computation effort.
+      # For instance, if +value+ is an Integer, this method calls
+      # {Money.from_fixnum} instead of using the default
+      # {Money.from_bigdecimal} which adds the overload to converts
+      # the value into a slower BigDecimal instance.
+      #
+      # @param [Numeric] value The money amount, in dollars.
+      # @param [Currency, String, Symbol] currency The currency format.
+      #
+      # @return [Money]
+      #
+      # @raise +ArgumentError+ Unless +value+ is a supported type.
+      #
+      # @example
+      #   Money.from_numeric(100)
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_numeric(100.00)
+      #   #=> #<Money @cents=10000 @currency="USD">
+      #   Money.from_numeric("100")
+      #   #=> ArgumentError
+      #
+      # @see Numeric#to_money
+      # @see Money.from_fixnum
+      # @see Money.from_float
+      # @see Money.from_bigdecimal
+      #
+      def from_numeric(value, currency = Money.default_currency)
+        case value
+        when Fixnum
+          from_fixnum(value, currency)
+        when Numeric
+          from_bigdecimal(BigDecimal.new(value.to_s), currency)
+        else
+          raise ArgumentError, "`value' should be a Numeric object"
+        end
+      end
+
+      # Takes a number string and attempts to massage out the number.
+      #
+      # @param [String] input The string containing a potential number.
+      #
+      # @return [Integer]
+      #
+      def extract_cents(input, currency = Money.default_currency)
+        # remove anything that's not a number, potential thousands_separator, or minus sign
+        num = input.gsub(/[^\d|\.|,|\'|\-]/, '').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
+        # if it's not negative, the hyphen makes the value invalid
+        if negative
+          num = num.gsub(/^-/, '')
+        else
+          raise ArgumentError, "Invalid currency amount (hyphen)" if num.include?('-')
+        end
+
+        #if the number ends with punctuation, just throw it out.  If it means decimal,
+        #it won't hurt anything.  If it means a literal period or comma, this will
+        #save it from being mis-interpreted as a decimal.
+        num.chop! if num.match /[\.|,]$/
+
+          # gather all decimal_marks within the result number
+          used_decimal_marks = num.scan /[^\d]/
+
+          # determine the number of unique decimal_marks 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 (decimal_marks are space, comma, and period)
+          case used_decimal_marks.uniq.length
+            # no decimal_mark or thousands_separator; major (dollars) is the number, and minor (cents) is 0
+          when 0 then major, minor = num, 0
+
+            # two decimal_marks, so we know the last item in this array is the
+            # major/minor thousands_separator and the rest are decimal_marks
+          when 2
+            decimal_mark, thousands_separator = used_decimal_marks.uniq
+            # remove all decimal_marks, split on the thousands_separator
+            major, minor = num.gsub(decimal_mark, '').split(thousands_separator)
+            min = 0 unless min
+          when 1
+            # we can't determine if the comma or period is supposed to be a decimal_mark or a thousands_separator
+            # e.g.
+            # 1,00 - comma is a thousands_separator
+            # 1.000 - period is a thousands_separator
+            # 1,000 - comma is a decimal_mark
+            # 1,000,000 - comma is a decimal_mark
+            # 10000,00 - comma is a thousands_separator
+            # 1000,000 - comma is a thousands_separator
+
+            # assign first decimal_mark for reusability
+            decimal_mark = used_decimal_marks.first
+
+            # decimal_mark is used as a decimal_mark when there are multiple instances, always
+            if num.scan(decimal_mark).length > 1 # multiple matches; treat as decimal_mark
+              major, minor = num.gsub(decimal_mark, ''), 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(decimal_mark)
+              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 # thousands_separator
+                major, minor = possible_major, possible_minor
+              else
+                # minor length is three
+                # let's try to figure out intent of the thousands_separator
+
+                # the major length is greater than three, which means
+                # the comma or period is used as a thousands_separator
+                # 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 thousands_separator
+                  if decimal_mark == '.'
+                    major, minor = possible_major, possible_minor
+                  else
+                    major, minor = "#{possible_major}#{possible_minor}", 0
+                  end
+                end
+              end
+            end
+          else
+            # TODO: ParseError
+            raise ArgumentError, "Invalid currency amount"
+          end
+
+        # build the string based on major/minor since decimal_mark/thousands_separator have been removed
+        # avoiding floating point arithmetic here to ensure accuracy
+        cents = (major.to_i * currency.subunit_to_unit)
+        # Because of an bug in JRuby, we can't just call #floor
+        minor = minor.to_s
+        minor = if minor.size < currency.decimal_places
+                  (minor + ("0" * currency.decimal_places))[0,currency.decimal_places].to_i
+                elsif minor.size > currency.decimal_places
+                  if minor[currency.decimal_places,1].to_i >= 5
+                    minor[0,currency.decimal_places].to_i+1
+                  else
+                    minor[0,currency.decimal_places].to_i
+                  end
+                else
+                  minor.to_i
+                end
+        cents += minor
+
+        # if negative, multiply by -1; otherwise, return positive cents
+        negative ? cents * -1 : cents
+      end
+
+    end
+  end
+end