money 6.13.0 → 6.13.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7929d62cf482b5ad0876b0ff4950440cec3051ff
-  data.tar.gz: 8b40765349b517c8182f20de9378ad14b76eb863
+SHA256:
+  metadata.gz: 1773172616f278d2f107e19153498c029c5f1b63f4ae68a7468ef66fbbef8991
+  data.tar.gz: 035cd8170e536decc4748cd8a6c2ef1b7a7d5e985e6a2ecba0c989f8cf89096c
 SHA512:
-  metadata.gz: 1bc3a9c7fc84b6c4cd7e78d2dbe7bd666ab25f0715523953751984405f0ae858396e20e7bf0d8199b50c1d94d5947a1d3b0308094f3f2b347f07c93b655b28f1
-  data.tar.gz: 1a1dae32b195ccb6a93125fd2526e1c60e24c794cdd26fc08eb6254a1e6f8f4c0aef270ac215d1606b5163f7a1690443230161a75a5e522f72aa824b1f6f2efd
+  metadata.gz: 5636c6323a8538ccc669a2ecfd07a3108adde4f6315e43d0d2b0bb818fc31d1c230ff0ca9715a2c1ca67edcdfa7cb71c9c4d8405410f0764cc82aaad5d3af4e1
+  data.tar.gz: 4b2532f674ca8b665b43c745f5b8cc2beb3d7d5fda0584273bc53d8a42e8a551037758374b6864cfe4b227d61d043282394ed51b62e27f82b8f374ddb27dbe5b

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
+## 6.13.8
+- Update symbol for XOF
+- Update UYU currency symbol
+- Allow double conversion using same bank
+- Warn when using unsafe serializer for rate import
+- Move Icelandic symbol after the amount
+
+## 6.13.7
+- Improve deprecation warnings for the upcoming major release
+
+## 6.13.6
+- Fix a regression introduced in 6.13.5 that broken RatesStore::Memory subclasses
+
+## 6.13.5
+- Raise warning on using Money.default_currency
+- Raise warning on using default Money.rounding_mode
+- Add Second Ouguiya MRU 929 to currency iso file
+- Add symbol for UZS
+- Use monitor for recursive mutual exclusion in RatesStore::Memory
+- Allow passing store as a string to Money::Bank::VariableExchange (to support Rails 6)
+
+## 6.13.4
+- Update currency config for Zambian Kwacha (ZMW)
+- Do not modify options passed to FormattingRules
+
+## 6.13.3
+- Remove specs from the packaged gem
+- Use Currency::Loader directly without extending
+- Add Money.with_rounding_mode as a replacement for calling Money.rounding_mode with a block
+- Fix currency search for two digit ISO numbers
+- Add description to TypeError raised by +/- operations
+
+## 6.13.2
+- Prevent Money initialization with non-finite amounts
+- Convert the fractional value of a Money object to BigDecimal when initializing
+- Offer replacements for currency position deprecations
+- Fix Peruvian Sol symbol
+- Lock i18n to <= 1.2.0 for older (< 2.3) rubies
+- Prevent Divide By Zero in `Money#allocate`
+
+## 6.13.1
+- Add bolívar soberano (VES)
+- Deprecate bolívar fuerte (VEF)
+- Deprecate old `#format` rules passed as a symbol
+- Clarify `use_i18n` deprecation
+- Add `:currency` locale_backend for explicit per-currency localization
+
 ## 6.13.0
 - Add :format option to the Formatter
 - Add ruby 2.6.0 support
@@ -20,7 +67,7 @@
 - Wrap all amount parts when `:html_wrap` option is used
 - Deprecate `#currency_as_string` and `#currency_as_string=` (in favour of `#with_currency`)
 - Add `#with_currency` for swapping the currency
-- Rewrite allocate/split (fixing some penny loosing issues)
+- Rewrite allocate/split (fixing some penny losing issues)
 
 ## 6.11.3
 - Fix regression: if enabled use i18n locales in Money#to_s
@@ -39,7 +86,7 @@
 - Added new symbol for bitcoin denomination
 - Specify custom rounding precision when using `infinite_precision`
 - Allow splits with sums greater than 1
-- Prevent arithmetic methods from loosing reference to the bank
+- Prevent arithmetic methods from losing reference to the bank
 - Fix coerced zero numeric subtraction
 - Fix south asian formatting to support whole numbers
 - Refactor formatting logic

data/README.md

@@ -21,7 +21,7 @@ A Ruby Library for dealing with money and currency conversion.
 
 ### Features
 
-- Provides a `Money` class which encapsulates all information about an certain
+- Provides a `Money` class which encapsulates all information about a certain
   amount of money, such as its value and its currency.
 - Provides a `Money::Currency` class which encapsulates all information about
   a monetary unit.
@@ -253,7 +253,7 @@ The default bank is initialized with an in-memory store for exchange rates.
 Money.default_bank = Money::Bank::VariableExchange.new(Money::RatesStore::Memory.new)
 ```
 
-You can pass you own store implementation, ie. for storing and retrieving rates off a database, file, cache, etc.
+You can pass your own store implementation, i.e. for storing and retrieving rates off a database, file, cache, etc.
 
 ```ruby
 Money.default_bank = Money::Bank::VariableExchange.new(MyCustomStore.new)
@@ -270,7 +270,7 @@ Stores must implement the following interface:
 # @return [Numeric] rate.
 def add_rate(iso_from, iso_to, rate); end
 
-# Get rate. Must be idempotent. ie. adding the same rate must not produce duplicates.
+# Get rate. Must be idempotent. i.e. adding the same rate must not produce duplicates.
 # @param [String] iso_from Currency ISO code. ex. 'USD'
 # @param [String] iso_to Currency ISO code. ex. 'CAD'
 #
@@ -334,6 +334,8 @@ end
 Now you can use it with the default bank.
 
 ```ruby
+# For Rails 6 pass model name as a string to make it compatible with zeitwerk
+# Money.default_bank = Money::Bank::VariableExchange.new("ExchangeRate")
 Money.default_bank = Money::Bank::VariableExchange.new(ExchangeRate)
 
 # Add to the underlying store
@@ -392,6 +394,42 @@ m = Money.new('123', :gbp) # => #<Money fractional:123 currency:GBP>
 m.format(symbol: m.currency.to_s + ' ') # => "GBP 1.23"
 ```
 
+## Rounding
+
+By default, `Money` objects are rounded to the nearest cent and the additional precision is not preserved:
+
+```ruby
+Money.from_amount(2.34567).format #=> "$2.35"
+```
+
+To retain the additional precision, you will also need to set `infinite_precision` to `true`.
+
+```ruby
+Money.infinite_precision = true
+Money.from_amount(2.34567).format #=> "$2.34567"
+```
+
+To round to the nearest cent (or anything more precise), you can use the `round` method. However, note that the `round` method on a `Money` object does not work the same way as a normal Ruby `Float` object. Money's `round` method accepts different arguments. The first argument to the round method is the rounding mode, while the second argument is the level of precision relative to the cent.
+
+```
+# Float
+2.34567.round     #=> 2
+2.34567.round(2)  #=> 2.35
+
+# Money
+Money.infinite_precision = true
+Money.new(2.34567).format       #=> "$0.0234567"
+Money.new(2.34567).round.format #=> "$0.02"
+Money.new(2.34567).round(BigDecimal::ROUND_HALF_UP, 2).format #=> "$0.0235"
+```
+
+You can set the default rounding mode by passing one of the `BigDecimal` mode enumerables like so:
+```ruby
+Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
+```
+See [BigDecimal::ROUND_MODE](https://ruby-doc.org/stdlib-2.5.1/libdoc/bigdecimal/rdoc/BigDecimal.html#ROUND_MODE) for more information
+
+
 ## Ruby on Rails
 
 To integrate money in a Rails application use [money-rails](https://github.com/RubyMoney/money-rails).
@@ -434,6 +472,58 @@ If you wish to disable this feature and use defaults instead:
 Money.locale_backend = nil
 ```
 
+### Deprecation
+
+The current default behaviour always checks the I18n locale first, falling back to "per currency"
+localization. This is now deprecated and will be removed in favour of explicitly defined behaviour
+in the next major release.
+
+If you would like to use I18n localization (formatting depends on the locale):
+
+```ruby
+Money.locale_backend = :i18n
+
+# example (using default localization from rails-i18n):
+I18n.locale = :en
+Money.new(10_000_00, 'USD').format # => $10,000.00
+Money.new(10_000_00, 'EUR').format # => €10,000.00
+
+I18n.locale = :es
+Money.new(10_000_00, 'USD').format # => $10.000,00
+Money.new(10_000_00, 'EUR').format # => €10.000,00
+```
+
+If you need to localize the position of the currency symbol, you
+have to pass it manually. *Note: this will become the default formatting
+behavior in the next version.*
+
+```ruby
+I18n.locale = :fr
+format = I18n.t :format, scope: 'number.currency.format'
+Money.new(10_00, 'EUR').format(format: format) # => 10,00 €
+```
+
+For the legacy behaviour of "per currency" localization (formatting depends only on currency):
+
+```ruby
+Money.locale_backend = :currency
+
+# example:
+Money.new(10_000_00, 'USD').format # => $10,000.00
+Money.new(10_000_00, 'EUR').format # => €10.000,00
+```
+
+In case you don't need localization and would like to use default values (can be redefined using
+`Money.default_formatting_rules`):
+
+```ruby
+Money.locale_backend = nil
+
+# example:
+Money.new(10_000_00, 'USD').format # => $10000.00
+Money.new(10_000_00, 'EUR').format # => €10000.00
+```
+
 ## Collection
 
 In case you're working with collections of `Money` instances, have a look at [money-collection](https://github.com/RubyMoney/money-collection)

data/config/currency_backwards_compatible.json

@@ -60,6 +60,22 @@
     "iso_numeric": "428",
     "smallest_denomination": 1
   },
+  "mro": {
+    "priority": 100,
+    "iso_code": "MRO",
+    "name": "Mauritanian Ouguiya",
+    "symbol": "UM",
+    "disambiguate_symbol": "A-UM",
+    "alternate_symbols": [],
+    "subunit": "Khoums",
+    "subunit_to_unit": 5,
+    "symbol_first": false,
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "478",
+    "smallest_denomination": 1
+  },
   "mtl": {
     "priority": 100,
     "iso_code": "MTL",
@@ -169,5 +185,20 @@
     "thousands_separator": ",",
     "iso_numeric": "935",
     "smallest_denomination": 100
+  },
+  "vef": {
+    "priority": 100,
+    "iso_code": "VEF",
+    "name": "Venezuelan Bolívar",
+    "symbol": "Bs.F",
+    "alternate_symbols": ["Bs"],
+    "subunit": "Céntimo",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
+    "iso_numeric": "937",
+    "smallest_denomination": 1
   }
 }

data/config/currency_iso.json

@@ -1019,11 +1019,11 @@
     "priority": 100,
     "iso_code": "ISK",
     "name": "Icelandic Króna",
-    "symbol": "kr",
+    "symbol": "kr.",
     "alternate_symbols": ["Íkr"],
     "subunit": null,
     "subunit_to_unit": 1,
-    "symbol_first": true,
+    "symbol_first": false,
     "html_entity": "",
     "decimal_mark": ",",
     "thousands_separator": ".",
@@ -1412,9 +1412,9 @@
     "iso_numeric": "446",
     "smallest_denomination": 10
   },
-  "mro": {
+  "mru": {
     "priority": 100,
-    "iso_code": "MRO",
+    "iso_code": "MRU",
     "name": "Mauritanian Ouguiya",
     "symbol": "UM",
     "alternate_symbols": [],
@@ -1424,7 +1424,7 @@
     "html_entity": "",
     "decimal_mark": ".",
     "thousands_separator": ",",
-    "iso_numeric": "478",
+    "iso_numeric": "929",
     "smallest_denomination": 1
   },
   "mur": {
@@ -1647,12 +1647,12 @@
     "priority": 100,
     "iso_code": "PEN",
     "name": "Peruvian Sol",
-    "symbol": "S/.",
+    "symbol": "S/",
     "alternate_symbols": [],
     "subunit": "Céntimo",
     "subunit_to_unit": 100,
     "symbol_first": true,
-    "html_entity": "S/.",
+    "html_entity": "S/",
     "decimal_mark": ".",
     "thousands_separator": ",",
     "iso_numeric": "604",
@@ -2245,12 +2245,12 @@
     "priority": 100,
     "iso_code": "UYU",
     "name": "Uruguayan Peso",
-    "symbol": "$",
+    "symbol": "$U",
     "alternate_symbols": ["$U"],
     "subunit": "Centésimo",
     "subunit_to_unit": 100,
     "symbol_first": true,
-    "html_entity": "₱",
+    "html_entity": "$U",
     "decimal_mark": ",",
     "thousands_separator": ".",
     "iso_numeric": "858",
@@ -2260,7 +2260,7 @@
     "priority": 100,
     "iso_code": "UZS",
     "name": "Uzbekistan Som",
-    "symbol": "",
+    "symbol": "so'm",
     "alternate_symbols": ["so‘m", "сўм", "сум", "s", "с"],
     "subunit": "Tiyin",
     "subunit_to_unit": 100,
@@ -2271,19 +2271,19 @@
     "iso_numeric": "860",
     "smallest_denomination": 100
   },
-  "vef": {
+  "ves": {
     "priority": 100,
-    "iso_code": "VEF",
-    "name": "Venezuelan Bolívar",
+    "iso_code": "VES",
+    "name": "Venezuelan Bolívar Soberano",
     "symbol": "Bs",
-    "alternate_symbols": ["Bs.F"],
+    "alternate_symbols": ["Bs.S"],
     "subunit": "Céntimo",
     "subunit_to_unit": 100,
     "symbol_first": true,
     "html_entity": "",
     "decimal_mark": ",",
     "thousands_separator": ".",
-    "iso_numeric": "937",
+    "iso_numeric": "928",
     "smallest_denomination": 1
   },
   "vnd": {
@@ -2336,7 +2336,7 @@
     "priority": 100,
     "iso_code": "XAF",
     "name": "Central African Cfa Franc",
-    "symbol": "Fr",
+    "symbol": "CFA",
     "disambiguate_symbol": "FCFA",
     "alternate_symbols": ["FCFA"],
     "subunit": "Centime",
@@ -2594,12 +2594,12 @@
     "priority": 100,
     "iso_code": "ZMW",
     "name": "Zambian Kwacha",
-    "symbol": "ZK",
+    "symbol": "K",
     "disambiguate_symbol": "ZMW",
     "alternate_symbols": [],
     "subunit": "Ngwee",
     "subunit_to_unit": 100,
-    "symbol_first": false,
+    "symbol_first": true,
     "html_entity": "",
     "decimal_mark": ".",
     "thousands_separator": ",",

data/lib/money/bank/variable_exchange.rb

@@ -42,7 +42,7 @@ class Money
     #   bank.get_rate 'USD', 'CAD'
     class VariableExchange < Base
 
-      attr_reader :mutex, :store
+      attr_reader :mutex
 
       # Available formats for importing/exporting rates.
       RATE_FORMATS = [:json, :ruby, :yaml].freeze
@@ -61,6 +61,10 @@ class Money
         super(&block)
       end
 
+      def store
+        @store.is_a?(String) ? Object.const_get(@store) : @store
+      end
+
       def marshal_dump
         [store.marshal_dump, @rounding_method]
       end
@@ -110,7 +114,7 @@ class Money
           if rate = get_rate(from.currency, to_currency)
             fractional = calculate_fractional(from, to_currency)
             from.class.new(
-              exchange(fractional, rate, &block), to_currency
+              exchange(fractional, rate, &block), to_currency, self
             )
           else
             raise UnknownRate, "No conversion rate known for '#{from.currency.iso_code}' -> '#{to_currency}'"
@@ -213,8 +217,7 @@ 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 = {})
-        raise Money::Bank::UnknownRateFormat unless
-          RATE_FORMATS.include? format
+        raise Money::Bank::UnknownRateFormat unless RATE_FORMATS.include?(format)
 
         store.transaction do
           s = FORMAT_SERIALIZERS[format].dump(rates)
@@ -254,8 +257,13 @@ class Money
       #   bank.get_rate("USD", "CAD") #=> 1.24515
       #   bank.get_rate("CAD", "USD") #=> 0.803115
       def import_rates(format, s, opts = {})
-        raise Money::Bank::UnknownRateFormat unless
-          RATE_FORMATS.include? format
+        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.'
+        end
 
         store.transaction do
           data = FORMAT_SERIALIZERS[format].load(s)

data/lib/money/currency.rb

@@ -13,7 +13,6 @@ class Money
   class Currency
     include Comparable
     extend Enumerable
-    extend Money::Currency::Loader
     extend Money::Currency::Heuristics
 
     # Keeping cached instances in sync between threads
@@ -76,9 +75,10 @@ class Money
       #
       # @example
       #   Money::Currency.find_by_iso_numeric(978) #=> #<Money::Currency id: eur ...>
+      #   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
+        num = num.to_s.rjust(3, '0')
         return if num.empty?
         id, _ = self.table.find { |key, currency| currency[:iso_numeric] == num }
         new(id)
@@ -121,7 +121,7 @@ class Money
       # See https://en.wikipedia.org/wiki/List_of_circulating_currencies and
       # http://search.cpan.org/~tnguyen/Locale-Currency-Format-1.28/Format.pm
       def table
-        @table ||= load_currencies
+        @table ||= Loader.load_currencies
       end
 
       # List the currencies imported and registered
@@ -414,7 +414,7 @@ class Money
 
     # Returns the relation between subunit and unit as a base 10 exponent.
     #
-    # Note that MGA and MRO are exceptions and are rounded to 1
+    # Note that MGA and MRU are exceptions and are rounded to 1
     # @see https://en.wikipedia.org/wiki/ISO_4217#Active_codes
     #
     # @return [Integer]