money 7.0.2 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbdcafa7432cc94f273e6d50d820af8e6656707f9a4eb738d8ae694191d8f470
-  data.tar.gz: '093235eead41422c4804dcafde91b396c80f1b4c2d269606f2ce6287ad613871'
+  metadata.gz: 3a44852483d5fd18199ba0d2fdd0db1507c14ff84b2303080029a4a7323f50b2
+  data.tar.gz: 2e7ba93f0fd0963992fdede55c944383e61c61426fb67d3a6ae0281a54095ee2
 SHA512:
-  metadata.gz: 87ca3a9c81395fd38474dc8f46ceec7a0484054093f8aed50ff3a1358ea6214851d2fd81b165d68d94e5902e6229ad03debae12dfacab7dd043359d025f15d64
-  data.tar.gz: 8b8a0e2a12646b28b1859c226fbe3ef1b534458ec198d3cd51124263624709b7ced902ce9637e5409061ed0eefe3df67a70e159c9281ccd841e2dda1c1a0b4c1
+  metadata.gz: c6d5f8ed8ddabb9cd8cb9641afc2a80721cbfc1edf1b5143695072297484ead6551424fb8f2f92a84b2da24baf483745ce0d34b8e9a84cec54f3b4e0c630a712
+  data.tar.gz: '0639a68c4ee3b0d896d96b2bbc8fcf7419b8e6d6ba55ae68f4811c4082f7e2288c9d7f694ee869d629f143a8b00a4d2356fd536307744eb713c9aa1f75f1ae14'

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 7.1.0
+
+- Fix symbol for XPF (CFP Franc) currency to use "₣"
+- Fix name for ANG currency
+- Change disambiguate symbol for ARS from historical to international format
+- Update documentation of disambiguate feature
+- Include RBS type signatures (`sig/`) in the released gem
+- Fix RBS signatures: add the missing `Money#+`, `Money#-`, `Money.from_dollars`, `Money::Currency#cents_based?` and the error classes, drop entries for methods that no longer exist, and validate the signatures in CI
+
 ## 7.0.2
 
 - Fix `Money::Currency.register` exception when table is not initialized.

data/README.md

@@ -441,6 +441,7 @@ implementations.
 - [money-historical-bank](https://github.com/atwam/money-historical-bank)
 - [russian_central_bank](https://github.com/rmustafin/russian_central_bank)
 - [money-uphold-bank](https://github.com/subvisual/money-uphold-bank)
+- [money-unirate-api](https://github.com/UniRate-API/money-unirate-api)
 
 ## Formatting
 

data/config/currency_iso.json

@@ -67,7 +67,7 @@
   "ang": {
     "priority": 100,
     "iso_code": "ANG",
-    "name": "Netherlands Antillean Gulden",
+    "name": "Netherlands Antillean Guilder",
     "symbol": "ƒ",
     "alternate_symbols": ["NAƒ", "NAf", "f"],
     "subunit": "Cent",
@@ -100,8 +100,8 @@
     "iso_code": "ARS",
     "name": "Argentine Peso",
     "symbol": "$",
-    "disambiguate_symbol": "$m/n",
-    "alternate_symbols": ["$m/n", "m$n"],
+    "disambiguate_symbol": "AR$",
+    "alternate_symbols": ["AR$"],
     "subunit": "Centavo",
     "subunit_to_unit": 100,
     "symbol_first": true,
@@ -2624,7 +2624,7 @@
     "priority": 100,
     "iso_code": "XPF",
     "name": "Cfp Franc",
-    "symbol": "Fr",
+    "symbol": "₣",
     "alternate_symbols": ["F"],
     "subunit": "Centime",
     "subunit_to_unit": 1,

data/lib/money/bank/base.rb

@@ -4,7 +4,6 @@ class Money
   # Provides classes that aid in the ability of exchange one currency with
   # another.
   module Bank
-
     # The lowest Money::Bank error class.
     # All Money::Bank errors should inherit from it.
     class Error < StandardError
@@ -15,7 +14,6 @@ class Money
     class UnknownRate < Error
     end
 
-
     # Money::Bank::Base is the basic interface for creating a money exchange
     # object, also called Bank.
     #
@@ -40,12 +38,11 @@ class Money
     #  +Money::Bank+ class. You can also override +#setup+ instead of
     #  +#initialize+ to setup initial variables, etc.
     class Base
-
       # Returns the singleton instance of the Base bank.
       #
       # @return [Money::Bank::Base]
       def self.instance
-        @singleton ||= self.new
+        @instance ||= new
       end
 
       # The rounding method to use when exchanging rates.
@@ -81,8 +78,7 @@ class Money
       #  +Money::Bank+ class.
       #
       # @return [self]
-      def setup
-      end
+      def setup; end
 
       # Exchanges the given +Money+ object to a new +Money+ object in
       # +to_currency+.
@@ -102,7 +98,7 @@ class Money
       # @yieldreturn [Integer]
       #
       # @return [Money]
-      def exchange_with(from, to_currency, &block)
+      def exchange_with(from, to_currency, &)
         raise NotImplementedError, "#exchange_with must be implemented"
       end
 

data/lib/money/bank/single_currency.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'money/bank/base'
+require "money/bank/base"
 
 class Money
   module Bank
@@ -15,10 +15,9 @@ class Money
     # where exchanges happen are erroneous. Using this as the default bank
     # means that that these mistakes don't silently do the wrong thing.
     class SingleCurrency < Base
-
       # Raises a DifferentCurrencyError to remove possibility of accidentally
       # exchanging currencies
-      def exchange_with(from, to_currency, &block)
+      def exchange_with(from, to_currency, &)
         raise DifferentCurrencyError, "No exchanging of currencies allowed: #{from} #{from.currency} to #{to_currency}"
       end
     end

data/lib/money/bank/variable_exchange.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'money/bank/base'
-require 'money/rates_store/memory'
-require 'json'
-require 'yaml'
+require "money/bank/base"
+require "money/rates_store/memory"
+require "json"
+require "yaml"
 
 class Money
   module Bank
@@ -43,13 +43,12 @@ class Money
     #   # Get rate from redis
     #   bank.get_rate 'USD', 'CAD'
     class VariableExchange < Base
-
       attr_reader :mutex
 
       # Available formats for importing/exporting rates.
       RATE_FORMATS = [:json, :ruby, :yaml].freeze
-      SERIALIZER_SEPARATOR = '_TO_'.freeze
-      FORMAT_SERIALIZERS = {json: JSON, ruby: Marshal, yaml: YAML}.freeze
+      SERIALIZER_SEPARATOR = "_TO_"
+      FORMAT_SERIALIZERS = { json: JSON, ruby: Marshal, yaml: YAML }.freeze
 
       # Initializes a new +Money::Bank::VariableExchange+ object.
       # It defaults to using an in-memory, thread safe store instance for
@@ -58,9 +57,9 @@ class Money
       # @param [RateStore] st An exchange rate store, used to persist exchange rate pairs.
       # @yield [n] Optional block to use when rounding after exchanging one
       #  currency for another. See +Money::bank::base+
-      def initialize(st = Money::RatesStore::Memory.new, &block)
-        @store = st
-        super(&block)
+      def initialize(store = Money::RatesStore::Memory.new, &)
+        @store = store
+        super(&)
       end
 
       def store
@@ -108,21 +107,19 @@ class Money
       #
       #   # Exchange 100 CAD to USD:
       #   bank.exchange_with(c2, "USD") #=> #<Money fractional:8031 currency:USD>
-      def exchange_with(from, to_currency, &block)
+      def exchange_with(from, to_currency, &)
         to_currency = Currency.wrap(to_currency)
         if from.currency == to_currency
           from
+        elsif (rate = get_rate(from.currency, to_currency))
+          fractional = calculate_fractional(from, to_currency)
+          from.dup_with(
+            fractional: exchange(fractional, rate, &),
+            currency: to_currency,
+            bank: self,
+          )
         else
-          if rate = get_rate(from.currency, to_currency)
-            fractional = calculate_fractional(from, to_currency)
-            from.dup_with(
-              fractional: exchange(fractional, rate, &block),
-              currency: to_currency,
-              bank: self
-            )
-          else
-            raise UnknownRate, "No conversion rate known for '#{from.currency.iso_code}' -> '#{to_currency}'"
-          end
+          raise UnknownRate, "No conversion rate known for '#{from.currency.iso_code}' -> '#{to_currency}'"
         end
       end
 
@@ -133,7 +130,7 @@ class Money
         )
       end
 
-      def exchange(fractional, rate, &block)
+      def exchange(fractional, rate, &)
         ex = fractional * BigDecimal(rate.to_s)
         if block_given?
           yield ex
@@ -176,7 +173,7 @@ class Money
       #   bank = Money::Bank::VariableExchange.new
       #   bank.set_rate("USD", "CAD", 1.24515)
       #   bank.set_rate("CAD", "USD", 0.803115)
-      def set_rate(from, to, rate, opts = {})
+      def set_rate(from, to, rate, _opts = {})
         store.add_rate(Currency.wrap(from).iso_code, Currency.wrap(to).iso_code, rate)
       end
 
@@ -197,7 +194,7 @@ class Money
       #
       #   bank.get_rate("USD", "CAD") #=> 1.24515
       #   bank.get_rate("CAD", "USD") #=> 0.803115
-      def get_rate(from, to, opts = {})
+      def get_rate(from, to, _opts = {})
         store.get_rate(Currency.wrap(from).iso_code, Currency.wrap(to).iso_code)
       end
 
@@ -220,14 +217,14 @@ class Money
       #
       #   s = bank.export_rates(:json)
       #   s #=> "{\"USD_TO_CAD\":1.24515,\"CAD_TO_USD\":0.803115}"
-      def export_rates(format, file = nil, opts = {})
+      def export_rates(format, file = nil, _opts = {})
         raise Money::Bank::UnknownRateFormat unless RATE_FORMATS.include?(format)
 
         store.transaction do
           s = FORMAT_SERIALIZERS[format].dump(rates)
 
           unless file.nil?
-            File.open(file, "w") {|f| f.write(s) }
+            File.write(file, s)
           end
 
           s
@@ -236,17 +233,17 @@ class Money
 
       # This should be deprecated.
       def rates
-        store.each_rate.each_with_object({}) do |(from,to,rate),hash|
+        store.each_rate.with_object({}) do |(from, to, rate), hash|
           hash[[from, to].join(SERIALIZER_SEPARATOR)] = rate
         end
       end
 
-      # Loads rates provided in +s+ given the specified format. Available
+      # Loads rates provided in +string+ given the specified format. Available
       # formats are +:json+, +:ruby+ and +:yaml+.
       # Delegates to +Money::RatesStore::Memory+
       #
-      # @param [Symbol] format The format of +s+.
-      # @param [String] s The rates string.
+      # @param [Symbol] format The format of +string+.
+      # @param [String] string The rates string.
       # @param [Hash] opts Options hash to set special parameters. Backwards compatibility only.
       #
       # @return [self]
@@ -254,23 +251,23 @@ class Money
       # @raise +Money::Bank::UnknownRateFormat+ if format is unknown.
       #
       # @example
-      #   s = "{\"USD_TO_CAD\":1.24515,\"CAD_TO_USD\":0.803115}"
+      #   string = "{\"USD_TO_CAD\":1.24515,\"CAD_TO_USD\":0.803115}"
       #   bank = Money::Bank::VariableExchange.new
-      #   bank.import_rates(:json, s)
+      #   bank.import_rates(:json, string)
       #
       #   bank.get_rate("USD", "CAD") #=> 1.24515
       #   bank.get_rate("CAD", "USD") #=> 0.803115
-      def import_rates(format, s, opts = {})
+      def import_rates(format, string, _opts = {})
         raise Money::Bank::UnknownRateFormat unless RATE_FORMATS.include?(format)
 
         if format == :ruby
-          warn '[WARNING] Using :ruby format when importing rates is potentially unsafe and ' \
-            'might lead to remote code execution via Marshal.load deserializer. Consider using ' \
-            'safe alternatives such as :json and :yaml.'
+          warn "[WARNING] Using :ruby format when importing rates is potentially unsafe and " \
+               "might lead to remote code execution via Marshal.load deserializer. Consider using " \
+               "safe alternatives such as :json and :yaml."
         end
 
         store.transaction do
-          data = FORMAT_SERIALIZERS[format].load(s)
+          data = FORMAT_SERIALIZERS[format].load(string)
 
           data.each do |key, rate|
             from, to = key.split(SERIALIZER_SEPARATOR)

data/lib/money/currency/heuristics.rb

@@ -3,7 +3,7 @@
 class Money
   class Currency
     module Heuristics
-      def analyze(str)
+      def analyze(_str)
         raise StandardError, 'Heuristics deprecated, add `gem "money-heuristics"` to Gemfile'
       end
     end

data/lib/money/currency/loader.rb

@@ -3,7 +3,7 @@
 class Money
   class Currency
     module Loader
-      DATA_PATH = File.expand_path("../../../../config", __FILE__)
+      DATA_PATH = File.expand_path("../../../config", __dir__)
 
       class << self
         # Loads and returns the currencies stored in JSON files in the config directory.

data/lib/money/currency.rb

@@ -5,7 +5,6 @@ require "money/currency/loader"
 require "money/currency/heuristics"
 
 class Money
-
   # Represents a specific currency unit.
   #
   # @see https://en.wikipedia.org/wiki/Currency
@@ -24,7 +23,7 @@ class Money
     class MissingAttributeError < StandardError
       def initialize(method, currency, attribute)
         super(
-          "Can't call Currency.#{method} - currency '#{currency}' is missing "\
+          "Can't call Currency.#{method} - currency '#{currency}' is missing " \
           "the attribute '#{attribute}'"
         )
       end
@@ -81,8 +80,9 @@ class Money
       #   Money::Currency.find_by_iso_numeric(51) #=> #<Money::Currency id: amd ...>
       #   Money::Currency.find_by_iso_numeric('001') #=> nil
       def find_by_iso_numeric(num)
-        num = num.to_s.rjust(3, '0')
+        num = num.to_s.rjust(3, "0")
         return if num.empty?
+
         id = iso_numeric_index[num]
         new(id) if id
       rescue UnknownCurrency
@@ -139,6 +139,7 @@ class Money
           if c.priority.nil?
             raise MissingAttributeError.new(:all, c.id, :priority)
           end
+
           c
         end.sort_by(&:priority)
       end
@@ -195,19 +196,22 @@ class Money
       #
       # @return [Boolean] true if the currency previously existed, false
       #   if it didn't.
+      # rubocop:disable Naming/PredicateMethod
       def unregister(curr)
-        if curr.is_a?(Hash)
-          key = curr.fetch(:iso_code).downcase.to_sym
-        else
-          key = curr.downcase.to_sym
-        end
+        key =
+          if curr.is_a?(Hash)
+            curr.fetch(:iso_code).downcase.to_sym
+          else
+            curr.downcase.to_sym
+          end
         existed = @table.delete(key)
         @stringified_keys = nil if existed
         existed ? true : false
       end
+      # rubocop:enable Naming/PredicateMethod
 
-      def each
-        all.each { |c| yield(c) }
+      def each(&)
+        all.each(&)
       end
 
       def reset!
@@ -271,12 +275,12 @@ class Money
     #     this currency)
 
     attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
-      :disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
-      :thousands_separator, :symbol_first, :smallest_denomination, :format
+                :disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
+                :thousands_separator, :symbol_first, :smallest_denomination, :format
 
-    alias_method :separator, :decimal_mark
-    alias_method :delimiter, :thousands_separator
-    alias_method :eql?, :==
+    alias separator decimal_mark
+    alias delimiter thousands_separator
+    alias eql? ==
 
     # Create a new +Currency+ object.
     #
@@ -305,12 +309,12 @@ class Money
     #   c1 <=> c2 #=> 1
     #   c2 <=> c1 #=> -1
     #   c1 <=> c1 #=> 0
-    def <=>(other_currency)
+    def <=>(other)
       # <=> returns nil when one of the values is nil
-      comparison = self.priority <=> other_currency.priority || 0
+      comparison = priority <=> other.priority || 0
 
       if comparison == 0
-        self.id <=> other_currency.id
+        id <=> other.id
       else
         comparison
       end
@@ -328,19 +332,9 @@ class Money
     #   c2 = Money::Currency.new(:jpy)
     #   c1 == c1 #=> true
     #   c1 == c2 #=> false
-    def ==(other_currency)
-      self.equal?(other_currency) || compare_ids(other_currency)
-    end
-
-    def compare_ids(other_currency)
-      other_currency_id = if other_currency.is_a?(Currency)
-                            other_currency.id.to_s.downcase
-                          else
-                            other_currency.to_s.downcase
-                          end
-      self.id.to_s.downcase == other_currency_id
+    def ==(other)
+      equal?(other) || compare_ids(other)
     end
-    private :compare_ids
 
     # Returns a Integer hash value based on the +id+ attribute in order to use
     # functions like & (intersection), group_by, etc.
@@ -360,7 +354,22 @@ class Money
     # @example
     #   Money::Currency.new(:usd) #=> #<Currency id: usd ...>
     def inspect
-      "#<#{self.class.name} id: #{id}, priority: #{priority}, symbol_first: #{symbol_first}, thousands_separator: #{thousands_separator}, html_entity: #{html_entity}, decimal_mark: #{decimal_mark}, name: #{name}, symbol: #{symbol}, subunit_to_unit: #{subunit_to_unit}, exponent: #{exponent}, iso_code: #{iso_code}, iso_numeric: #{iso_numeric}, subunit: #{subunit}, smallest_denomination: #{smallest_denomination}, format: #{format}>"
+      "#<#{self.class.name} " \
+        "id: #{id}, " \
+        "priority: #{priority}, " \
+        "symbol_first: #{symbol_first}, " \
+        "thousands_separator: #{thousands_separator}, " \
+        "html_entity: #{html_entity}, " \
+        "decimal_mark: #{decimal_mark}, " \
+        "name: #{name}, " \
+        "symbol: #{symbol}, " \
+        "subunit_to_unit: #{subunit_to_unit}, " \
+        "exponent: #{exponent}, " \
+        "iso_code: #{iso_code}, " \
+        "iso_numeric: #{iso_numeric}, " \
+        "subunit: #{subunit}, " \
+        "smallest_denomination: #{smallest_denomination}, " \
+        "format: #{format}>"
     end
 
     # Returns a string representation corresponding to the upcase +id+
@@ -428,7 +437,7 @@ class Money
     #   Money::Currency.new(:usd).iso?
     #
     def iso?
-      iso_numeric && iso_numeric != ''
+      iso_numeric && iso_numeric != ""
     end
 
     # Returns true if a subunit is cents-based.
@@ -455,6 +464,18 @@ class Money
 
     private
 
+    # rubocop:disable Naming/PredicateMethod
+    def compare_ids(other_currency)
+      other_currency_id =
+        if other_currency.is_a?(Currency)
+          other_currency.id.to_s.downcase
+        else
+          other_currency.to_s.downcase
+        end
+      id.to_s.downcase == other_currency_id
+    end
+    # rubocop:enable Naming/PredicateMethod
+
     def initialize_data!
       data = self.class.table[@id]
       @alternate_symbols     = data[:alternate_symbols]

data/lib/money/locale_backend/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'money/locale_backend/errors'
+require "money/locale_backend/errors"
 
 class Money
   module LocaleBackend

data/lib/money/locale_backend/currency.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'money/locale_backend/base'
+require "money/locale_backend/base"
 
 class Money
   module LocaleBackend

data/lib/money/locale_backend/i18n.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'money/locale_backend/base'
+require "money/locale_backend/base"
 
 class Money
   module LocaleBackend
@@ -13,15 +13,17 @@ class Money
       }.freeze
 
       def initialize
-        raise NotSupported, 'I18n not found' unless defined?(::I18n)
+        raise NotSupported, "I18n not found" unless defined?(::I18n)
+
+        super
       end
 
       def lookup(key, _)
         i18n_key = KEY_MAP[key]
 
-        ::I18n.t i18n_key, scope: 'number.currency.format', raise: true
+        ::I18n.t i18n_key, scope: "number.currency.format", raise: true
       rescue ::I18n::MissingTranslationData
-        ::I18n.t i18n_key, scope: 'number.format', default: nil
+        ::I18n.t i18n_key, scope: "number.format", default: nil
       end
     end
   end

data/lib/money/money/allocation.rb

@@ -22,15 +22,16 @@ class Money
     # @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?)
-        Array.new(parts.count, 1)
-      else
-        parts.dup
-      end
+      parts =
+        if parts.is_a?(Numeric)
+          Array.new(parts, 1)
+        elsif parts.all?(&:zero?)
+          Array.new(parts.count, 1)
+        else
+          parts.dup
+        end
 
-      raise ArgumentError, 'need at least one part' 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)
@@ -44,7 +45,7 @@ class Money
 
       parts_sum = parts.sum
 
-      until parts.empty? do
+      until parts.empty?
         part = parts.pop
 
         current_split = 0