money 6.18.0 → 7.0.0

data/config/currency_iso.json

@@ -52,13 +52,13 @@
     "priority": 100,
     "iso_code": "AMD",
     "name": "Armenian Dram",
-    "symbol": "դր.",
+    "symbol": "֏",
     "alternate_symbols": ["dram"],
     "subunit": "Luma",
     "subunit_to_unit": 100,
     "symbol_first": false,
     "format": "%n %u",
-    "html_entity": "",
+    "html_entity": "֏",
     "decimal_mark": ".",
     "thousands_separator": ",",
     "iso_numeric": "051",
@@ -452,10 +452,10 @@
     "subunit": "Rappen",
     "subunit_to_unit": 100,
     "symbol_first": true,
-    "format": "%u%n",
+    "format": "%u %n",
     "html_entity": "",
     "decimal_mark": ".",
-    "thousands_separator": ",",
+    "thousands_separator": "'",
     "iso_numeric": "756",
     "smallest_denomination": 5
   },
@@ -922,22 +922,6 @@
     "iso_numeric": "340",
     "smallest_denomination": 5
   },
-  "hrk": {
-    "priority": 100,
-    "iso_code": "HRK",
-    "name": "Croatian Kuna",
-    "symbol": "kn",
-    "alternate_symbols": [],
-    "subunit": "Lipa",
-    "subunit_to_unit": 100,
-    "symbol_first": false,
-    "format": "%n %u",
-    "html_entity": "",
-    "decimal_mark": ",",
-    "thousands_separator": ".",
-    "iso_numeric": "191",
-    "smallest_denomination": 1
-  },
   "htg": {
     "priority": 100,
     "iso_code": "HTG",
@@ -988,7 +972,7 @@
   "ils": {
     "priority": 100,
     "iso_code": "ILS",
-    "name": "Israeli New Sheqel",
+    "name": "Israeli New Shekel",
     "symbol": "₪",
     "alternate_symbols": ["ש״ח", "NIS"],
     "subunit": "Agora",
@@ -1387,7 +1371,7 @@
     "symbol": "Ar",
     "alternate_symbols": [],
     "subunit": "Iraimbilanja",
-    "subunit_to_unit": 5,
+    "subunit_to_unit": 1,
     "symbol_first": true,
     "html_entity": "",
     "decimal_mark": ".",
@@ -1706,8 +1690,8 @@
     "subunit_to_unit": 100,
     "symbol_first": true,
     "html_entity": "S/",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
     "iso_numeric": "604",
     "smallest_denomination": 1
   },
@@ -1826,14 +1810,14 @@
     "priority": 100,
     "iso_code": "RSD",
     "name": "Serbian Dinar",
-    "symbol": "РСД",
-    "alternate_symbols": ["RSD", "din", "дин"],
+    "symbol": "RSD",
+    "alternate_symbols": ["РСД", "din", "дин", "din.", "DIN", "Din", "дин."],
     "subunit": "Para",
     "subunit_to_unit": 100,
-    "symbol_first": true,
+    "symbol_first": false,
     "html_entity": "",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
     "iso_numeric": "941",
     "smallest_denomination": 100
   },
@@ -2196,13 +2180,13 @@
     "priority": 100,
     "iso_code": "TMT",
     "name": "Turkmenistani Manat",
-    "symbol": "T",
+    "symbol": "m",
     "alternate_symbols": [],
     "subunit": "Tenge",
     "subunit_to_unit": 100,
     "symbol_first": false,
     "format": "%n %u",
-    "html_entity": "",
+    "html_entity": "m",
     "decimal_mark": ".",
     "thousands_separator": ",",
     "iso_numeric": "934",
@@ -2573,6 +2557,21 @@
     "iso_numeric": "951",
     "smallest_denomination": 1
   },
+  "xcg": {
+    "priority": 100,
+    "iso_code": "XCG",
+    "name": "Caribbean Guilder",
+    "symbol": "Cg",
+    "alternate_symbols": [],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
+    "iso_numeric": "532",
+    "smallest_denomination": 1
+  },
   "xdr": {
     "priority": 100,
     "iso_code": "XDR",
@@ -2695,8 +2694,8 @@
     "subunit_to_unit": 100,
     "symbol_first": true,
     "html_entity": "R",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
+    "decimal_mark": ",",
+    "thousands_separator": " ",
     "iso_numeric": "710",
     "smallest_denomination": 10
   },
@@ -2732,5 +2731,20 @@
     "thousands_separator": ",",
     "iso_numeric": "967",
     "smallest_denomination": 5
+  },
+  "zwg": {
+    "priority": 100,
+    "iso_code": "ZWG",
+    "name": "Zimbabwe Gold",
+    "symbol": "ZiG",
+    "alternate_symbols": [],
+    "subunit": "cent",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "924",
+    "smallest_denomination": 1
   }
 }

data/config/currency_non_iso.json

@@ -135,7 +135,7 @@
     "disambiguate_symbol": "USDC",
     "alternate_symbols": [],
     "subunit": "Cent",
-    "subunit_to_unit": 100,
+    "subunit_to_unit": 1000000,
     "symbol_first": false,
     "html_entity": "$",
     "decimal_mark": ".",

data/lib/money/bank/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Money
   # Provides classes that aid in the ability of exchange one currency with
   # another.

data/lib/money/bank/single_currency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'money/bank/base'
 
 class Money

data/lib/money/bank/variable_exchange.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'money/bank/base'
 require 'money/rates_store/memory'
 require 'json'

data/lib/money/currency/heuristics.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 class Money
   class Currency

data/lib/money/currency/loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Money
   class Currency
     module Loader

data/lib/money/currency.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require "json"
 require "money/currency/loader"
@@ -9,7 +9,7 @@ class Money
   # Represents a specific currency unit.
   #
   # @see https://en.wikipedia.org/wiki/Currency
-  # @see http://iso4217.net/
+  # @see https://www.iso.org/iso-4217-currency-codes.html
   class Currency
     include Comparable
     extend Enumerable
@@ -33,6 +33,9 @@ class Money
     # Thrown when an unknown currency is requested.
     class UnknownCurrency < ArgumentError; end
 
+    # Thrown when currency is not provided.
+    class NoCurrency < ArgumentError; end
+
     class << self
       def new(id)
         id = id.to_s.downcase
@@ -80,8 +83,8 @@ class Money
       def find_by_iso_numeric(num)
         num = num.to_s.rjust(3, '0')
         return if num.empty?
-        id, _ = self.table.find { |key, currency| currency[:iso_numeric] == num }
-        new(id)
+        id = iso_numeric_index[num]
+        new(id) if id
       rescue UnknownCurrency
         nil
       end
@@ -113,13 +116,13 @@ class Money
       #
       # == monetary unit
       # The standard unit of value of a currency, as the dollar in the United States or the peso in Mexico.
-      # https://www.answers.com/topic/monetary-unit
+      # https://www.answers.com/redirectSearch?query=monetary-unit
       # == fractional monetary unit, subunit
       # A monetary unit that is valued at a fraction (usually one hundredth) of the basic monetary unit
-      # https://www.answers.com/topic/fractional-monetary-unit-subunit
+      # https://www.answers.com/redirectSearch?query=fractional-monetary-unit-subunit
       #
       # See https://en.wikipedia.org/wiki/List_of_circulating_currencies and
-      # http://search.cpan.org/~tnguyen/Locale-Currency-Format-1.28/Format.pm
+      # https://metacpan.org/release/TNGUYEN/Locale-Currency-Format-1.28/view/Format.pm
       def table
         @table ||= Loader.load_currencies
       end
@@ -142,7 +145,7 @@ class Money
 
       # We need a string-based validator before creating an unbounded number of
       # symbols.
-      # http://www.randomhacks.net/articles/2007/01/20/13-ways-of-looking-at-a-ruby-symbol#11
+      # http://www.randomhacks.net.s3-website-us-east-1.amazonaws.com/2007/01/20/13-ways-of-looking-at-a-ruby-symbol/#11
       # https://github.com/RubyMoney/money/issues/132
       #
       # @return [Set]
@@ -172,6 +175,7 @@ class Money
         @@mutex.synchronize { _instances.delete(key.to_s) }
         @table[key] = curr
         @stringified_keys = nil
+        clear_iso_numeric_cache
       end
 
       # Inherit a new currency from existing one
@@ -209,10 +213,21 @@ class Money
       def reset!
         @@instances = {}
         @table = Loader.load_currencies
+        clear_iso_numeric_cache
       end
 
       private
 
+      def iso_numeric_index
+        @iso_numeric_index ||= table.each_with_object({}) do |(id, attrs), index|
+          index[attrs[:iso_numeric]] = id
+        end
+      end
+
+      def clear_iso_numeric_cache
+        @iso_numeric_index = nil
+      end
+
       def stringify_keys
         table.keys.each_with_object(Set.new) { |k, set| set.add(k.to_s.downcase) }
       end
@@ -405,7 +420,7 @@ class Money
       !!@symbol_first
     end
 
-    # Returns if a code currency is ISO.
+    # Returns true if a code currency is ISO.
     #
     # @return [Boolean]
     #
@@ -416,6 +431,17 @@ class Money
       iso_numeric && iso_numeric != ''
     end
 
+    # Returns true if a subunit is cents-based.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #  Money::Currency.new(:usd).cents_based?
+    #
+    def cents_based?
+      subunit_to_unit == 100
+    end
+
     # Returns the relation between subunit and unit as a base 10 exponent.
     #
     # Note that MGA and MRU are exceptions and are rounded to 1

data/lib/money/locale_backend/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'money/locale_backend/errors'
 
 class Money

data/lib/money/locale_backend/currency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'money/locale_backend/base'
 
 class Money

data/lib/money/locale_backend/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Money
   module LocaleBackend
     class NotSupported < StandardError; end

data/lib/money/locale_backend/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'money/locale_backend/base'
 
 class Money
@@ -6,7 +8,8 @@ class Money
       KEY_MAP = {
         thousands_separator: :delimiter,
         decimal_mark: :separator,
-        symbol: :unit
+        symbol: :unit,
+        format: :format,
       }.freeze
 
       def initialize

data/lib/money/money/allocation.rb

@@ -1,18 +1,27 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 class Money
   class Allocation
-    # Splits a given amount in parts without losing pennies.
-    # The left-over pennies will be distributed round-robin amongst the parts. This means that
-    # parts listed first will likely receive more pennies than the ones listed later.
+    # Allocates a specified amount into parts based on their proportions or distributes
+    # it evenly when the number of parts is specified numerically.
     #
-    # The results should always add up to the original amount.
+    # The total of the allocated amounts will always equal the original amount.
     #
     # The parts can be specified as:
-    #   Numeric — performs the split between a given number of parties evenely
+    #   Numeric — performs the split between a given number of parties evenly
     #   Array<Numeric> — allocates the amounts proportionally to the given array
     #
-    def self.generate(amount, parts, whole_amounts = true)
+    # @param amount [Numeric] The total amount to be allocated.
+    # @param parts [Numeric, Array<Numeric>] Number of parts to split into or an array (proportions for allocation)
+    # @param decimal_cutoff [Boolean, Integer] Controls per-split precision:
+    #   - When true, splits are truncated to whole amounts.
+    #   - When an Integer N, splits are rounded to N decimal places.
+    #   - When false or nil, no rounding/truncation is applied.
+    #   Defaults to true (whole amounts).
+    #
+    # @return [Array<Numeric>] An array containing the allocated amounts.
+    # @raise [ArgumentError] If parts is empty or not provided.
+    def self.generate(amount, parts, decimal_cutoff = true)
       parts = if parts.is_a?(Numeric)
         Array.new(parts, 1)
       elsif parts.all?(&:zero?)
@@ -21,26 +30,58 @@ class Money
         parts.dup
       end
 
-      raise ArgumentError, 'need at least one party' if parts.empty?
+      raise ArgumentError, 'need at least one part' if parts.empty?
+
+      if [amount, *parts].any? { |i| i.is_a?(BigDecimal) || i.is_a?(Float) || i.is_a?(Rational) }
+        amount = convert_to_big_decimal(amount)
+        parts.map! { |p| convert_to_big_decimal(p) }
+      end
 
       result = []
       remaining_amount = amount
+      round_to_whole = decimal_cutoff.is_a?(TrueClass)
+      round_to_precision = decimal_cutoff.is_a?(Integer)
+
+      parts_sum = parts.sum
 
       until parts.empty? do
-        parts_sum = parts.inject(0, :+)
         part = parts.pop
 
         current_split = 0
         if parts_sum > 0
           current_split = remaining_amount * part / parts_sum
-          current_split = current_split.truncate if whole_amounts
+          current_split =
+            if round_to_whole
+              current_split.truncate
+            elsif round_to_precision
+              current_split.round(decimal_cutoff)
+            else
+              current_split
+            end
         end
 
         result.unshift current_split
         remaining_amount -= current_split
+        parts_sum -= part
       end
 
       result
     end
+
+    # Converts a given number to BigDecimal.
+    # This method supports inputs of BigDecimal, Rational, and other numeric types by ensuring they are all returned
+    # as BigDecimal instances for consistent handling.
+    #
+    # @param number [Numeric, BigDecimal, Rational] The number to convert.
+    # @return [BigDecimal] The converted number as a BigDecimal.
+    def self.convert_to_big_decimal(number)
+      if number.is_a? BigDecimal
+        number
+      elsif number.is_a? Rational
+        BigDecimal(number.to_f.to_s)
+      else
+        BigDecimal(number.to_s)
+      end
+    end
   end
 end

data/lib/money/money/arithmetic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Money
   module Arithmetic
     # Wrapper for coerced numeric values to distinguish
@@ -20,24 +22,32 @@ class Money
     end
 
     # Checks whether two Money objects have the same currency and the same
-    # amount. If Money objects have a different currency it will only be true
-    # if the amounts are both zero. Checks against objects that are not Money or
-    # a subclass will always return false.
+    # amount. Checks against objects that are not Money or a subclass will
+    # always return false.
     #
     # @param [Money] other_money Value to compare with.
     #
     # @return [Boolean]
     #
     # @example
-    #   Money.new(100).eql?(Money.new(101))                #=> false
-    #   Money.new(100).eql?(Money.new(100))                #=> true
-    #   Money.new(100, "USD").eql?(Money.new(100, "GBP"))  #=> false
-    #   Money.new(0, "USD").eql?(Money.new(0, "EUR"))      #=> true
-    #   Money.new(100).eql?("1.00")                        #=> false
+    #   Money.new(1_00).eql?(Money.new(1_00))               #=> true
+    #   Money.new(1_00).eql?(Money.new(1_01))               #=> false
+    #   Money.new(1_00, "USD").eql?(Money.new(1_00, "GBP")) #=> false
+    #   Money.new(0, "USD").eql?(Money.new(0, "EUR"))       #=> false
+    #   Money.new(1_00).eql?("1.00")                        #=> false
+    #
+    # @see Money.strict_eql_compare
     def eql?(other_money)
       if other_money.is_a?(Money)
-        (fractional == other_money.fractional && currency == other_money.currency) ||
-          (fractional == 0 && other_money.fractional == 0)
+        if !Money.strict_eql_compare && fractional == 0 && other_money.fractional == 0
+          warn "[DEPRECATION] Comparing 0 #{currency} with 0 " \
+                "#{other_money.currency} using `#eql?` will return false in " \
+                "future versions of Money. Opt-in to the new behavior by " \
+                "setting `Money.strict_eql_compare = true`."
+          return true
+        end
+
+        fractional == other_money.fractional && currency == other_money.currency
       else
         false
       end
@@ -190,10 +200,15 @@ class Money
     #
     def /(value)
       if value.is_a?(self.class)
-        fractional / as_d(value.exchange_to(currency).fractional).to_f
+        exchanged = value.exchange_to(currency)
+        raise ZeroDivisionError, "divided by Money(0)" if exchanged.zero?
+        fractional / as_d(exchanged.fractional).to_f
       else
         raise TypeError, 'Can not divide by Money' if value.is_a?(CoercedNumeric)
-        dup_with(fractional: fractional / as_d(value))
+
+        value = as_d(value)
+        raise ZeroDivisionError, "divided by zero" if value.zero?
+        dup_with(fractional: fractional / value)
       end
     end
 
@@ -230,13 +245,16 @@ class Money
 
     def divmod_money(val)
       cents = val.exchange_to(currency).cents
+      raise ZeroDivisionError, "divided by Money(0)" if cents == 0
       quotient, remainder = fractional.divmod(cents)
       [quotient, dup_with(fractional: remainder)]
     end
     private :divmod_money
 
     def divmod_other(val)
-      quotient, remainder = fractional.divmod(as_d(val))
+      val = as_d(val)
+      raise ZeroDivisionError, "divided by zero" if val.zero?
+      quotient, remainder = fractional.divmod(val)
       [dup_with(fractional: quotient), dup_with(fractional: remainder)]
     end
     private :divmod_other

data/lib/money/money/constructors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Money
   module Constructors
 

data/lib/money/money/formatter.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'money/money/formatting_rules'
 
 class Money
@@ -82,33 +83,6 @@ class Money
     #   Money.new(10000000, "INR").format(south_asian_number_formatting: true) #=> "1,00,000.00"
     #   Money.new(10000000).format(south_asian_number_formatting: true) #=> "$1,00,000.00"
     #
-    # @option rules [Boolean, nil] :symbol_before_without_space (true) Whether
-    #   a space between the money symbol and the amount should be inserted when
-    #   +:symbol_position+ is +:before+. The default is true (meaning no space). Ignored
-    #   if +:symbol+ is false or +:symbol_position+ is not +:before+.
-    #
-    # @example
-    #   # Default is to not insert a space.
-    #   Money.new(100, "USD").format #=> "$1.00"
-    #
-    #   # Same thing.
-    #   Money.new(100, "USD").format(symbol_before_without_space: true) #=> "$1.00"
-    #
-    #   # If set to false, will insert a space.
-    #   Money.new(100, "USD").format(symbol_before_without_space: false) #=> "$ 1.00"
-    #
-    # @option rules [Boolean, nil] :symbol_after_without_space (false) Whether
-    #   a space between the amount and the money symbol should be inserted when
-    #   +:symbol_position+ is +:after+. The default is false (meaning space). Ignored
-    #   if +:symbol+ is false or +:symbol_position+ is not +:after+.
-    #
-    # @example
-    #   # Default is to insert a space.
-    #   Money.new(100, "USD").format(symbol_position: :after) #=> "1.00 $"
-    #
-    #   # If set to true, will not insert a space.
-    #   Money.new(100, "USD").format(symbol_position: :after, symbol_after_without_space: true) #=> "1.00$"
-    #
     # @option rules [Boolean, String, nil] :decimal_mark (true) Whether the
     #  currency should be separated by the specified character or '.'
     #
@@ -139,13 +113,6 @@ class Money
     #   # 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
-    #   Money.ca_dollar(570).format(html: true, with_currency: true)
-    #   #=> "$5.70 <span class=\"currency\">CAD</span>"
-    #
     # @option rules [Boolean] :html_wrap (false) Whether all currency parts should be HTML-formatted.
     #
     # @example
@@ -181,20 +148,6 @@ class Money
     #   Money.new(10000, "USD").format(disambiguate: true)    #=> "$100.00"
     #   Money.new(10000, "CAD").format(disambiguate: true)    #=> "C$100.00"
     #
-    # @option rules [Boolean] :html_wrap_symbol (false) Wraps the currency symbol
-    #  in a html <span> tag.
-    #
-    # @example
-    #   Money.new(10000, "USD").format(disambiguate: false)
-    #   #=> "<span class=\"currency_symbol\">$100.00</span>
-    #
-    # @option rules [Symbol] :symbol_position (:before) `:before` if the currency
-    #   symbol goes before the amount, `:after` if it goes after.
-    #
-    # @example
-    #   Money.new(10000, "USD").format(symbol_position: :before) #=> "$100.00"
-    #   Money.new(10000, "USD").format(symbol_position: :after)  #=> "100.00 $"
-    #
     # @option rules [Boolean] :translate (true) `true` Checks for custom
     #   symbol definitions using I18n.
     #
@@ -300,9 +253,7 @@ class Money
       symbol_value = symbol_value_from(rules)
 
       if symbol_value && !symbol_value.empty?
-        if rules[:html_wrap_symbol]
-          symbol_value = "<span class=\"currency_symbol\">#{symbol_value}</span>"
-        elsif rules[:html_wrap]
+        if rules[:html_wrap]
           symbol_value = html_wrap(symbol_value, "currency-symbol")
         end
 
@@ -316,17 +267,17 @@ class Money
 
     def append_currency_symbol(formatted_number)
       if rules[:with_currency]
-        formatted_number << " "
+        currency_part =
+          if rules[:html_wrap]
+            html_wrap(currency.to_s, "currency")
+          else
+            currency.to_s
+          end
 
-        if rules[:html]
-          formatted_number << "<span class=\"currency\">#{currency.to_s}</span>"
-        elsif rules[:html_wrap]
-          formatted_number << html_wrap(currency.to_s, "currency")
-        else
-          formatted_number << currency.to_s
-        end
+        "#{formatted_number} #{currency_part}"
+      else
+        formatted_number
       end
-      formatted_number
     end
 
     def show_free_text?
@@ -398,7 +349,7 @@ class Money
         else
           ""
         end
-      elsif rules[:html] || rules[:html_wrap]
+      elsif rules[:html_wrap]
         currency.html_entity == '' ? currency.symbol : currency.html_entity
       elsif rules[:disambiguate] && currency.disambiguate_symbol
         currency.disambiguate_symbol