money 6.13.4 → 6.13.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca21de22dba51f2c9b00ca1301f5d21ea936767a
-  data.tar.gz: 1cfb4f822e6f7a948f8ff31955422372658c0394
+SHA256:
+  metadata.gz: 1773172616f278d2f107e19153498c029c5f1b63f4ae68a7468ef66fbbef8991
+  data.tar.gz: 035cd8170e536decc4748cd8a6c2ef1b7a7d5e985e6a2ecba0c989f8cf89096c
 SHA512:
-  metadata.gz: 207a714b183381a90c2c46f1b4cef2a9246e5a8be0f0c30a088b4d71c98fbdc814e356cb3dac8d2301eefd7d18cf7f70914f6ef9e314975039edbe5bc2b2a7c8
-  data.tar.gz: 8dca4236991ae835e822cd09bc4e0a6fbeb0b2fee52bb85be3dbb38cfa07f7fa60bbde94045b9a643071435126954324da1aa00065af9ab79f2cd961ee50b7d9
+  metadata.gz: 5636c6323a8538ccc669a2ecfd07a3108adde4f6315e43d0d2b0bb818fc31d1c230ff0ca9715a2c1ca67edcdfa7cb71c9c4d8405410f0764cc82aaad5d3af4e1
+  data.tar.gz: 4b2532f674ca8b665b43c745f5b8cc2beb3d7d5fda0584273bc53d8a42e8a551037758374b6864cfe4b227d61d043282394ed51b62e27f82b8f374ddb27dbe5b

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # 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
@@ -46,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
@@ -65,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.
@@ -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
@@ -421,6 +423,13 @@ 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).
@@ -484,6 +493,16 @@ 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

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",

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": {
@@ -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,
@@ -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",

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

@@ -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]

data/lib/money/money/allocation.rb

@@ -2,9 +2,9 @@
 
 class Money
   class Allocation
-    # Splits a given amount in parts without loosing pennies.
-    # The left-over pennies will be distributed round-robin amongst the parties. This means that
-    # parties listed first will likely receive more pennies than ones that are listed later.
+    # 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.
     #
     # The results should always add up to the original amount.
     #

data/lib/money/money/arithmetic.rb

@@ -46,7 +46,7 @@ class Money
     # Compares two Money objects. If money objects have a different currency it
     # will attempt to convert the currency.
     #
-    # @param [Money] other_money Value to compare with.
+    # @param [Money] other Value to compare with.
     #
     # @return [Integer]
     #
@@ -103,7 +103,7 @@ class Money
     # values. If +other_money+ has a different currency then its monetary value
     # is automatically exchanged to this object's currency using +exchange_to+.
     #
-    # @param [Money] other_money Other +Money+ object to add.
+    # @param [Money] other Other +Money+ object to add.
     #
     # @return [Money]
     #
@@ -116,7 +116,7 @@ class Money
     # its monetary value is automatically exchanged to this object's currency
     # using +exchange_to+.
     #
-    # @param [Money] other_money Other +Money+ object to subtract.
+    # @param [Money] other Other +Money+ object to subtract.
     #
     # @return [Money]
     #

data/lib/money/money.rb

@@ -91,51 +91,63 @@ class Money
   class << self
 
     # @!attribute [rw] default_bank
-    #   @return [Money::Bank::Base] Each Money object is associated to a bank
-    #     object, which is responsible for currency exchange. This property
-    #     allows you to specify the default bank object. The default value for
-    #     this property is an instance of +Bank::VariableExchange.+ It allows
-    #     one to specify custom exchange rates.
+    #   Used to set a default bank for currency exchange.
+    #
+    #   Each Money object is associated with a bank
+    #   object, which is responsible for currency exchange. This property
+    #   allows you to specify the default bank object. The default value for
+    #   this property is an instance of +Bank::VariableExchange.+ It allows
+    #   one to specify custom exchange rates.
+    #
+    #   @return [Money::Bank::Base]
     #
     # @!attribute default_formatting_rules
-    #   @return [Hash] Use this to define a default hash of rules for every time
-    #     +Money#format+ is called.  Rules provided on method call will be
-    #     merged with the default ones.  To overwrite a rule, just provide the
-    #     intended value while calling +format+.
+    #   Used to define a default hash of rules for every time
+    #   +Money#format+ is called.  Rules provided on method call will be
+    #   merged with the default ones.  To overwrite a rule, just provide the
+    #   intended value while calling +format+.
     #
-    #   @see +Money::Formatting#format+ for more details.
+    #   @see Money::Formatter#initialize Money::Formatter for more details
     #
     #   @example
     #     Money.default_formatting_rules = { display_free: true }
     #     Money.new(0, "USD").format                          # => "free"
     #     Money.new(0, "USD").format(display_free: false)  # => "$0.00"
     #
+    #   @return [Hash]
+    #
     # @!attribute [rw] use_i18n
-    #   @return [Boolean] Use this to disable i18n even if it's used by other
-    #     objects in your app.
+    #   Used to disable i18n even if it's used by other components of your app.
+    #
+    #   @return [Boolean]
     #
     # @!attribute [rw] infinite_precision
-    #   @return [Boolean] Use this to enable infinite precision cents
+    #   Used to enable infinite precision cents
+    #
+    #   @return [Boolean]
     #
     # @!attribute [rw] conversion_precision
-    #   @return [Integer] Use this to specify precision for converting Rational
-    #     to BigDecimal
-    attr_accessor :default_bank, :default_formatting_rules,
-      :use_i18n, :infinite_precision, :conversion_precision,
-      :locale_backend
-
-    # @attr_writer rounding_mode Use this to specify the rounding mode
+    #   Used to specify precision for converting Rational to BigDecimal
     #
-    # @!attribute default_currency
-    #   @return [Money::Currency] The default currency, which is used when
-    #     +Money.new+ is called without an explicit currency argument. The
-    #     default value is Currency.new("USD"). The value must be a valid
-    #     +Money::Currency+ instance.
-    attr_writer :rounding_mode, :default_currency
+    #   @return [Integer]
+    attr_accessor :default_bank, :default_formatting_rules,
+      :infinite_precision, :conversion_precision
 
+    attr_reader :use_i18n, :locale_backend
   end
 
+  # @!attribute default_currency
+  #   @return [Money::Currency] The default currency, which is used when
+  #     +Money.new+ is called without an explicit currency argument. The
+  #     default value is Currency.new("USD"). The value must be a valid
+  #     +Money::Currency+ instance.
   def self.default_currency
+    if @using_deprecated_default_currency
+      warn '[WARNING] The default currency will change from `USD` to `nil` in the next major release. Make ' \
+           'sure to set it explicitly using `Money.default_currency=` to avoid potential issues'
+      @using_deprecated_default_currency = false
+    end
+
     if @default_currency.respond_to?(:call)
       Money::Currency.new(@default_currency.call)
     else
@@ -143,10 +155,21 @@ class Money
     end
   end
 
+  def self.default_currency=(currency)
+    @using_deprecated_default_currency = false
+    @default_currency = currency
+  end
+
   def self.locale_backend=(value)
     @locale_backend = value ? LocaleBackend.find(value) : nil
   end
 
+  # @attr_writer rounding_mode Use this to specify the rounding mode
+  def self.rounding_mode=(new_rounding_mode)
+    @using_deprecated_default_rounding_mode = false
+    @rounding_mode = new_rounding_mode
+  end
+
   def self.use_i18n=(value)
     if value
       warn '[DEPRECATION] `use_i18n` is deprecated - use `Money.locale_backend = :i18n` instead for locale based formatting'
@@ -163,6 +186,7 @@ class Money
 
     # Set the default currency for creating new +Money+ object.
     self.default_currency = Currency.new("USD")
+    @using_deprecated_default_currency = true
 
     # Default to using i18n
     @use_i18n = true
@@ -175,6 +199,7 @@ class Money
 
     # Default to bankers rounding
     self.rounding_mode = BigDecimal::ROUND_HALF_EVEN
+    @using_deprecated_default_rounding_mode = true
 
     # Default the conversion of Rationals precision to 16
     self.conversion_precision = 16
@@ -192,18 +217,30 @@ class Money
   #
   # @return [BigDecimal::ROUND_MODE] rounding mode
   def self.rounding_mode(mode = nil)
-    return Thread.current[:money_rounding_mode] || @rounding_mode unless mode
+    if mode
+      warn "[DEPRECATION] calling `rounding_mode` with a block is deprecated. Please use `.with_rounding_mode` instead."
+      return with_rounding_mode(mode) { yield }
+    end
 
-    warn "[DEPRECATION] calling `rounding_mode` with a block is deprecated. Please use `.with_rounding_mode` instead."
-    with_rounding_mode(mode) { yield }
+    return Thread.current[:money_rounding_mode] if Thread.current[:money_rounding_mode]
+
+    if @using_deprecated_default_rounding_mode
+      warn '[WARNING] The default rounding mode will change from `ROUND_HALF_EVEN` to `ROUND_HALF_UP` in the ' \
+           'next major release. Set it explicitly using `Money.rounding_mode=` to avoid potential problems.'
+      @using_deprecated_default_rounding_mode = false
+    end
+
+    @rounding_mode
   end
 
-  # This method temporarily changes the rounding mode. It will then return the
-  # results of the block instead.
+  # Temporarily changes the rounding mode in a given block.
   #
   # @param [BigDecimal::ROUND_MODE] mode
   #
-  # @return [BigDecimal::ROUND_MODE,Yield] block results
+  # @yield The block within which rounding mode will be changed. Its return
+  #   value will also be the return value of the whole method.
+  #
+  # @return [Object] block results
   #
   # @example
   #   fee = Money.with_rounding_mode(BigDecimal::ROUND_HALF_UP) do
@@ -509,13 +546,15 @@ class Money
     exchange_to("EUR")
   end
 
-  # Splits a given amount in parts without loosing pennies. The left-over pennies will be
-  # distributed round-robin amongst the parties. This means that parties listed first will likely
-  # receive more pennies than ones that are listed later.
+  # Splits a given amount in parts without losing pennies. The left-over pennies will be
+  # distributed round-robin amongst the parties. This means that parts listed first will likely
+  # receive more pennies than ones listed later.
+  #
+  # Pass [2, 1, 1] as input to give twice as much to part1 as part2 or
+  # part3 which results in 50% of the cash to party1, 25% to part2, and 25% to part3. Passing a
+  # number instead of an array will split the amount evenly (without losing pennies when rounding).
   #
-  # @param [Array<Numeric>, Numeric] pass [2, 1, 1] to give twice as much to party1 as party2 or
-  # party3 which results in 50% of the cash to party1, 25% to party2, and 25% to party3. Passing a
-  # number instead of an array will split the amount evenly (without loosing pennies when rounding).
+  # @param [Array<Numeric>, Numeric] parts how amount should be distributed to parts
   #
   # @return [Array<Money>]
   #
@@ -553,7 +592,7 @@ class Money
 
   # Creates a formatted price string according to several rules.
   #
-  # @param [Hash] See Money::Formatter for the list of formatting options
+  # @param [Hash] rules See {Money::Formatter Money::Formatter} for the list of formatting options
   #
   # @return [String]
   #

data/lib/money/rates_store/memory.rb

@@ -1,3 +1,5 @@
+require 'monitor'
+
 class Money
   module RatesStore
 
@@ -17,11 +19,11 @@ class Money
       #
       # @param [Hash] opts Optional store options.
       # @option opts [Boolean] :without_mutex disables the usage of a mutex
-      # @param [Hash] rt Optional initial exchange rate data.
-      def initialize(opts = {}, rt = {})
-        @options, @index = opts, rt
-        @mutex = Mutex.new
-        @in_transaction = false
+      # @param [Hash] rates Optional initial exchange rate data.
+      def initialize(opts = {}, rates = {})
+        @rates = rates
+        @options = opts
+        @guard = Monitor.new
       end
 
       # Registers a conversion rate and returns it. Uses +Mutex+ to synchronize data access.
@@ -37,7 +39,9 @@ class Money
       #   store.add_rate("USD", "CAD", 1.24515)
       #   store.add_rate("CAD", "USD", 0.803115)
       def add_rate(currency_iso_from, currency_iso_to, rate)
-        transaction { index[rate_key_for(currency_iso_from, currency_iso_to)] = rate }
+        guard.synchronize do
+          rates[rate_key_for(currency_iso_from, currency_iso_to)] = rate
+        end
       end
 
       # Retrieve the rate for the given currencies. Uses +Mutex+ to synchronize data access.
@@ -54,24 +58,21 @@ class Money
       #
       #   store.get_rate("USD", "CAD") #=> 1.24515
       def get_rate(currency_iso_from, currency_iso_to)
-        transaction { index[rate_key_for(currency_iso_from, currency_iso_to)] }
+        guard.synchronize do
+          rates[rate_key_for(currency_iso_from, currency_iso_to)]
+        end
       end
 
       def marshal_dump
-        [self.class, options, index]
+        guard.synchronize do
+          return [self.class, options, rates.dup]
+        end
       end
 
       # Wraps block execution in a thread-safe transaction
       def transaction(&block)
-        if @in_transaction || options[:without_mutex]
-          block.call self
-        else
-          @mutex.synchronize do
-            @in_transaction = true
-            result = block.call
-            @in_transaction = false
-            result
-          end
+        guard.synchronize do
+          yield
         end
       end
 
@@ -88,19 +89,19 @@ class Money
       #     puts [iso_from, iso_to, rate].join
       #   end
       def each_rate(&block)
-        enum = Enumerator.new do |yielder|
-          index.each do |key, rate|
+        return to_enum(:each_rate) unless block_given?
+
+        guard.synchronize do
+          rates.each do |key, rate|
             iso_from, iso_to = key.split(INDEX_KEY_SEPARATOR)
-            yielder.yield iso_from, iso_to, rate                  
+            yield iso_from, iso_to, rate
           end
         end
-
-        block_given? ? enum.each(&block) : enum
       end
 
       private
 
-      attr_reader :index, :options
+      attr_reader :rates, :options, :guard
 
       # Return the rate hashkey for the given currencies.
       #

data/lib/money/version.rb

@@ -1,3 +1,3 @@
 class Money
-  VERSION = '6.13.4'
+  VERSION = '6.13.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money
 version: !ruby/object:Gem::Version
-  version: 6.13.4
+  version: 6.13.8
 platform: ruby
 authors:
 - Shane Emmons
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -159,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Ruby Library for dealing with money and currency conversion.