money 6.0.0 → 6.0.1

data/lib/money/money/arithmetic.rb

@@ -11,7 +11,6 @@ class Money
       Money.new(-fractional, currency)
     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.
@@ -25,7 +24,9 @@ class Money
     #   Money.new(100) == Money.new(100) #=> true
     def ==(other_money)
       if other_money.respond_to?(:to_money)
-        Money.deprecate "as of Money 6.1.0 you must `require 'money/core_extension'` to compare Money to core classes." unless other_money.is_a? Money
+        unless other_money.is_a?(Money)
+          Money.deprecate "as of Money 6.1.0 you must `require 'monetize/core_extensions'` to compare Money to core classes. Please start using the Monetize gem from https://github.com/RubyMoney/monetize if you are not already doing so"
+        end
         other_money = other_money.to_money
         fractional == other_money.fractional && currency == other_money.currency
       else
@@ -44,17 +45,21 @@ class Money
       self == other_money
     end
 
-    def <=>(other_money)
-      if other_money.respond_to?(:to_money)
-        Money.deprecate "as of Money 6.1.0 you must `require 'money/core_extension'` to compare Money to core classes." unless other_money.is_a? Money
-        other_money = other_money.to_money
-        if fractional == 0 || other_money.fractional == 0 || currency == other_money.currency
-          fractional <=> other_money.fractional
-        else
-          fractional <=> other_money.exchange_to(currency).fractional
-        end
-      else
-        raise ArgumentError, "Comparison of #{self.class} with #{other_money.inspect} failed"
+    def <=>(val)
+      check_compare_deprecate(val)
+
+      val = val.to_money
+      unless fractional == 0 || val.fractional == 0 || currency == val.currency
+        val = val.exchange_to(currency)
+      end
+      fractional <=> val.fractional
+    rescue NoMethodError
+      raise ArgumentError, "Comparison of #{self.class} with #{val.inspect} failed"
+    end
+
+    def check_compare_deprecate(val)
+      unless val.is_a?(Money)
+        Money.deprecate "as of Money 6.1.0 you must `require 'monetize/core_extensions'` to compare Money to core classes. Please start using the Monetize gem from https://github.com/RubyMoney/monetize if you are not already doing so"
       end
     end
 
@@ -185,20 +190,29 @@ class Money
     #   Money.new(100).divmod(Money.new(9)) #=> [11, #<Money @fractional=1>]
     def divmod(val)
       if val.is_a?(Money)
-        a = fractional
-        b = val.exchange_to(currency).cents
-        q, m = a.divmod(b)
-        return [q, Money.new(m, currency)]
+        divmod_money(val)
       else
-        if self.class.infinite_precision
-          q, m = fractional.divmod(as_d(val))
-          return [Money.new(q, currency), Money.new(m, currency)]
-        else
-          return [div(val), Money.new(fractional.modulo(val), currency)]
-        end
+        divmod_other(val)
       end
     end
 
+    def divmod_money(val)
+      cents = val.exchange_to(currency).cents
+      quotient, remainder = fractional.divmod(cents)
+      [quotient, Money.new(remainder, currency)]
+    end
+    private :divmod_money
+
+    def divmod_other(val)
+      if self.class.infinite_precision
+        quotient, remainder = fractional.divmod(as_d(val))
+        [Money.new(quotient, currency), Money.new(remainder, currency)]
+      else
+        [div(val), Money.new(fractional.modulo(val), currency)]
+      end
+    end
+    private :divmod_other
+
     # Equivalent to +self.divmod(val)[1]+
     #
     # @param [Money, Fixnum] val Number take modulo with.
@@ -232,15 +246,15 @@ class Money
     # @example
     #   Money.new(100).remainder(9) #=> #<Money @fractional=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.fractional < 0
-      b_sign = :neg if (b.is_a?(Money) and b.fractional < 0) or (b < 0)
+      if val.is_a?(Money) && currency != val.currency
+        val = val.exchange_to(currency)
+      end
 
-      return a.modulo(b) if a_sign == b_sign
-      a.modulo(b) - (b.is_a?(Money) ? b : Money.new(b, a.currency))
+      if (fractional < 0 && val < 0) || (fractional > 0 && val > 0)
+        self.modulo(val)
+      else
+        self.modulo(val) - (val.is_a?(Money) ? val : Money.new(val, currency))
+      end
     end
 
     # Return absolute value of self as a new Money object.

data/lib/money/money/formatting.rb

@@ -1,49 +1,30 @@
 # encoding: UTF-8
 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 || ","
+    def self.included(base)
+      [
+        [:thousands_separator, :delimiter, "."],
+        [:decimal_mark, :separator, ","]
+      ].each do |method, name, character|
+        define_i18n_method(method, name, character)
       end
     end
-    alias :delimiter :thousands_separator
 
-
-    if Object.const_defined?("I18n")
-      def decimal_mark
+    def self.define_i18n_method(method, name, character)
+      define_method(method) do
         if self.class.use_i18n
           I18n.t(
-            :"number.currency.format.separator",
-            :default => I18n.t(
-              :"number.format.separator",
-              :default => (currency.decimal_mark || ".")
+            :"number.currency.format.#{name}", :default => I18n.t(
+              :"number.format.#{name}",
+              :default => (currency.send(method) || character)
             )
           )
         else
-          currency.decimal_mark || "."
+          currency.send(method) || character
         end
       end
-    else
-      def decimal_mark
-        currency.decimal_mark || "."
-      end
+      alias_method name, method
     end
-    alias :separator :decimal_mark
 
     # Creates a formatted price string according to several rules.
     #
@@ -213,20 +194,7 @@ class Money
         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 == '' ? currency.symbol : currency.html_entity
-        else
-          symbol
-        end
+      symbol_value = symbol_value_from(rules)
 
       formatted = self.abs.to_s
 
@@ -254,14 +222,7 @@ class Money
       formatted.gsub!(regexp_format(formatted, rules, decimal_mark, symbol_value),
                       "\\1#{thousands_separator_value}")
 
-      symbol_position =
-        if rules.has_key?(:symbol_position)
-          rules[:symbol_position]
-        elsif currency.symbol_first?
-          :before
-        else
-          :after
-        end
+      symbol_position = symbol_position_from(rules)
 
       if rules[:sign_positive] == true && self.positive?
         sign = '+'
@@ -298,7 +259,6 @@ class Money
       formatted
     end
 
-
     private
 
     # Cleans up formatting rules.
@@ -345,4 +305,30 @@ class Money
     end
     rules
   end
+
+  def symbol_value_from(rules)
+    if rules.has_key?(:symbol)
+      if rules[:symbol] === true
+        symbol
+      elsif rules[:symbol]
+        rules[:symbol]
+      else
+        ""
+      end
+    elsif rules[:html]
+      currency.html_entity == '' ? currency.symbol : currency.html_entity
+    else
+      symbol
+    end
+  end
+
+  def symbol_position_from(rules)
+    if rules.has_key?(:symbol_position)
+      rules[:symbol_position]
+    elsif currency.symbol_first?
+      :before
+    else
+      :after
+    end
+  end
 end

data/lib/money/money/parsing.rb

@@ -7,369 +7,39 @@ class Money
     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 @fractional=10000>
-      #   '100.37'.to_money             #=> #<Money @fractional=10037>
-      #   '100 USD'.to_money            #=> #<Money @fractional=10000, @currency=#<Money::Currency id: usd>>
-      #   'USD 100'.to_money            #=> #<Money @fractional=10000, @currency=#<Money::Currency id: usd>>
-      #   '$100 USD'.to_money           #=> #<Money @fractional=10000, @currency=#<Money::Currency id: usd>>
-      #   'hello 2000 world'.to_money   #=> #<Money @fractional=200000 @currency=#<Money::Currency id: usd>>
-      #
-      # @example Mismatching currencies
-      #   'USD 2000'.to_money("EUR")    #=> ArgumentError
-      #
-      # @see #from_string
-      #
       def parse(input, currency = nil)
-        Money.deprecate ".parse is depreciated and will be remove in 6.1.0. Please write your own parsing methods."
-        i = input.to_s.strip
-
-        # raise Money::Currency.table.collect{|c| c[1][:symbol]}.inspect
-
-        # Check the first character for a currency symbol, alternatively get it
-        # from the stated currency string
-        c = if Money.assume_from_symbol && i =~ /^(\$|€|£)/
-          case i
-          when /^\$/ then "USD"
-          when /^€/ then "EUR"
-          when /^£/ then "GBP"
-          end
-        else
-          i[/[A-Z]{2,3}/]
-        end
-
-        # 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)
-
-        fractional = extract_cents(i, currency)
-        new(fractional, currency)
+        Money.deprecate ".parse is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.parse(input, currency)
       end
 
-      # Converts a String into a Money object treating the +value+
-      # as amount and converting to fractional unit,
-      # according to +currency+ subunit property,
-      # before instantiating the Money object.
-      #
-      # Behind the scenes, this method relies on {#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 @fractional=10000 @currency="USD">
-      #   Money.from_string("100", "USD")
-      #   #=> #<Money @fractional=10000 @currency="USD">
-      #   Money.from_string("100", "EUR")
-      #   #=> #<Money @fractional=10000 @currency="EUR">
-      #   Money.from_string("100", "BHD")
-      #   #=> #<Money @fractional=100 @currency="BHD">
-      #
-      # @see String#to_money
-      # @see #parse
-      #
       def from_string(value, currency = Money.default_currency)
-        Money.deprecate ".from_string is depreciated and will be remove in 6.1.0. Please write your own parsing methods."
-        from_bigdecimal(BigDecimal.new(value.to_s), currency)
+        Money.deprecate ".from_string is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.from_string(value, currency)
       end
 
-      # Converts a Fixnum into a Money object treating the +value+
-      # as amount and to corresponding fractional unit,
-      # 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 @fractional=10000 @currency="USD">
-      #   Money.from_fixnum(100, "USD")
-      #   #=> #<Money @fractional=10000 @currency="USD">
-      #   Money.from_fixnum(100, "EUR")
-      #   #=> #<Money @fractional=10000 @currency="EUR">
-      #   Money.from_fixnum(100, "BHD")
-      #   #=> #<Money @fractional=100 @currency="BHD">
-      #
-      # @see Fixnum#to_money
-      # @see #from_numeric
-      #
       def from_fixnum(value, currency = Money.default_currency)
-        currency = Money::Currency.wrap(currency)
-        amount   = value * currency.subunit_to_unit
-        new(amount, currency)
+        Money.deprecate ".from_fixnum is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.from_fixnum(value, currency)
       end
 
-      # Converts a Float into a Money object treating the +value+
-      # as dollars and to corresponding fractional unit,
-      # 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 @fractional=10000 @currency="USD">
-      #   Money.from_float(100.0, "USD")
-      #   #=> #<Money @fractional=10000 @currency="USD">
-      #   Money.from_float(100.0, "EUR")
-      #   #=> #<Money @fractional=10000 @currency="EUR">
-      #   Money.from_float(100.0, "BHD")
-      #   #=> #<Money @fractional=100 @currency="BHD">
-      #
-      # @see Float#to_money
-      # @see #from_numeric
-      #
       def from_float(value, currency = Money.default_currency)
-        Money.deprecate ".from_float is depreciated and will be remove in 6.1.0. Please write your own parsing methods."
-        from_bigdecimal(BigDecimal.new(value.to_s), currency)
+        Money.deprecate ".from_float is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.from_float(value, currency)
       end
 
-      # Converts a BigDecimal into a Money object treating the +value+
-      # as dollars and converting to corresponding fractional unit,
-      # 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 @fractional=10000 @currency="USD">
-      #   Money.from_bigdecimal(BigDecimal.new("100", "USD")
-      #   #=> #<Money @fractional=10000 @currency="USD">
-      #   Money.from_bigdecimal(BigDecimal.new("100", "EUR")
-      #   #=> #<Money @fractional=10000 @currency="EUR">
-      #   Money.from_bigdecimal(BigDecimal.new("100", "BHD")
-      #   #=> #<Money @fractional=100 @currency="BHD">
-      #
-      # @see BigDecimal#to_money
-      # @see #from_numeric
-      #
       def from_bigdecimal(value, currency = Money.default_currency)
-        currency = Money::Currency.wrap(currency)
-        amount   = value * currency.subunit_to_unit
-        amount   = amount.round unless Money.infinite_precision
-        new(amount, currency)
+        Money.deprecate ".from_bigdecimal is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.from_bigdecimal(value, currency)
       end
 
-      # Converts a Numeric value into a Money object treating the +value+
-      # as dollars and converting to corresponding fractional unit,
-      # 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
-      # {#from_fixnum} instead of using the default
-      # {#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 @fractional=10000 @currency="USD">
-      #   Money.from_numeric(100.00)
-      #   #=> #<Money @fractional=10000 @currency="USD">
-      #   Money.from_numeric("100")
-      #   #=> ArgumentError
-      #
-      # @see Numeric#to_money
-      # @see #from_fixnum
-      # @see #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
+        Money.deprecate ".from_numeric is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.from_numeric(value, currency)
       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)
-        Money.deprecate ".extract_cents is depreciated and will be remove in 6.1.0. Please write your own parsing methods."
-        # remove anything that's not a number, potential thousands_separator, or minus sign
-        num = input.gsub(/[^\d.,'-]/, '')
-
-        # set a boolean flag for if the number is negative or not
-        negative = num =~ /^-|-$/ ? true : false
-
-        # decimal mark character
-        decimal_char = currency.decimal_mark
-
-        # if negative, remove the minus sign from the number
-        # if it's not negative, the hyphen makes the value invalid
-        if negative
-          num = num.sub(/^-|-$/, '')
-        end
-
-        raise ArgumentError, "Invalid currency amount (hyphen)" if num.include?('-')
-
-        #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_delimiters = 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_delimiters.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
-          thousands_separator, decimal_mark = used_delimiters.uniq
-
-          # remove all thousands_separator, split on the decimal_mark
-          major, minor = num.gsub(thousands_separator, '').split(decimal_mark)
-          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_delimiters.first
-
-          # When we have identified the decimal mark character
-          if decimal_char == decimal_mark
-            major, minor = num.split(decimal_char)
-
-          else
-            # 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
-          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
+        Money.deprecate ".extract_cents is deprecated and will be removed in 6.1.0. Please use the `monetize` gem."
+        Monetize.extract_cents(input, currency)
       end
     end
   end