money 6.12.0 → 6.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 833d36d87efd793fa9e73986df700da145b59578
-  data.tar.gz: 5fae93b474a739c79e45c18e45b3d652c4f1d4d6
+  metadata.gz: 7929d62cf482b5ad0876b0ff4950440cec3051ff
+  data.tar.gz: 8b40765349b517c8182f20de9378ad14b76eb863
 SHA512:
-  metadata.gz: 77560afc19c7447c654daa551924ee3a0cd84e17a880d64b9d012aefda8fabc23ea100ad229278937817025f986839d9c6112c04cd8b1ee862ca0faf02fe9b4c
-  data.tar.gz: 8c126aadb1cd5beedff854a8353a46a423296ceccdc8e1f72b7c65016937df8cb643c78c735fa87327bb41838ff12a76919a561e35ad5d3cb3eeca2573b5f526
+  metadata.gz: 1bc3a9c7fc84b6c4cd7e78d2dbe7bd666ab25f0715523953751984405f0ae858396e20e7bf0d8199b50c1d94d5947a1d3b0308094f3f2b347f07c93b655b28f1
+  data.tar.gz: 1a1dae32b195ccb6a93125fd2526e1c60e24c794cdd26fc08eb6254a1e6f8f4c0aef270ac215d1606b5163f7a1690443230161a75a5e522f72aa824b1f6f2efd

data/.travis.yml

@@ -9,9 +9,11 @@ rvm:
   - 2.3.7
   - 2.4.4
   - 2.5.1
+  - 2.6.0
   - rbx-3
   - jruby-9.0.5.0
-  - jruby-9.1.16.0
+  - jruby-9.1.17.0
+  - jruby-9.2.0.0
   - ruby-head
   - jruby-head
 matrix:

data/AUTHORS

@@ -65,6 +65,7 @@ Julien Boyer
 Kaleem Ullah
 Kenichi Kamiya
 Kenn Ejima
+Kenneth Salomon
 kirillian
 Laurynas Butkus
 Marcel Scherf

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 6.13.0
+- Add :format option to the Formatter
+- Add ruby 2.6.0 support
+- Performance improvement (lazy stringify currency keys)
+- Add `Money.locale_backend` for translation lookups
+- Deprecate `use_i18n` flag in favour of `locale_backend = :i18n`
+- Deprecate old formatting rules in favour of `:format`
+- LVL and LTL are no longer used
+- Add `Currency#iso?` for checking if currency is iso or not
+- Relax versions-lock of `i18n` and `rspec` dependencies
+- Add Bitcoin Cash
+- Fix incorrect behaviour of `Currency#find_by_currency_iso` when given empty input
+
 ## 6.12.0
 - Remove caching of `.empty`/`.zero`
 - Preserve assigned bank when rounding

data/README.md

@@ -5,7 +5,6 @@
 [![Code Climate](https://codeclimate.com/github/RubyMoney/money.svg)](https://codeclimate.com/github/RubyMoney/money)
 [![Coverage Status](https://coveralls.io/repos/RubyMoney/money/badge.svg?branch=master)](https://coveralls.io/r/RubyMoney/money?branch=master)
 [![Inline docs](https://inch-ci.org/github/RubyMoney/money.svg)](https://inch-ci.org/github/RubyMoney/money)
-[![Dependency Status](https://gemnasium.com/RubyMoney/money.svg)](https://gemnasium.com/RubyMoney/money)
 [![License](https://img.shields.io/github/license/RubyMoney/money.svg)](https://opensource.org/licenses/MIT)
 
 :warning: Please read the [migration notes](#migration-notes) before upgrading to a new major version.
@@ -199,7 +198,7 @@ using:
 Money.default_currency = Money::Currency.new("CAD")
 ```
 
-If you use Rails, then `environment.rb` is a very good place to put this.
+If you use [Rails](https://github.com/RubyMoney/money/tree/master#ruby-on-rails), then `config/initializers/money.rb` is a very good place to put this.
 
 ### Currency Exponent
 
@@ -399,34 +398,40 @@ To integrate money in a Rails application use [money-rails](https://github.com/R
 
 For deprecated methods of integrating with Rails, check [the wiki](https://github.com/RubyMoney/money/wiki).
 
-## I18n
+## Localization
 
-If you want thousands seperator and decimal mark to be same across all
-currencies this can be defined in your `I18n` translation files.
+In order to localize formatting you can use `I18n` gem:
 
-In an rails application this may look like:
+```ruby
+Money.locale_backend = :i18n
+```
+
+With this enabled a thousands seperator and a decimal mark will get looked up in your `I18n` translation files. In a Rails application this may look like:
 
 ```yml
 # config/locale/en.yml
 en:
-  number:
-    format:
-      delimiter: ","
-      separator: "."
-  # or
   number:
     currency:
       format:
         delimiter: ","
         separator: "."
+  # falling back to
+  number:
+    format:
+      delimiter: ","
+      separator: "."
 ```
 
 For this example `Money.new(123456789, "SEK").format` will return `1,234,567.89
-kr` which otherwise will return `1 234 567,89 kr`.
+kr` which otherwise would have returned `1 234 567,89 kr`.
+
+This will work seamlessly with [rails-i18n](https://github.com/svenfuchs/rails-i18n) gem that already has a lot of locales defined.
+
+If you wish to disable this feature and use defaults instead:
 
-If you wish to disable this feature:
 ``` ruby
-Money.use_i18n = false
+Money.locale_backend = nil
 ```
 
 ## Collection
@@ -436,7 +441,7 @@ for improved performance and accuracy.
 
 ### Troubleshooting
 
-If you get a runtime error such as:
+If you don't have some locale and don't want to get a runtime error such as:
 
     I18n::InvalidLocale: :en is not a valid locale
 

data/config/currency_backwards_compatible.json

@@ -30,6 +30,36 @@
     "iso_numeric": "288",
     "smallest_denomination": 1
   },
+  "ltl": {
+    "priority": 100,
+    "iso_code": "LTL",
+    "name": "Lithuanian Litas",
+    "symbol": "Lt",
+    "alternate_symbols": [],
+    "subunit": "Centas",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "440",
+    "smallest_denomination": 1
+  },
+  "lvl": {
+    "priority": 100,
+    "iso_code": "LVL",
+    "name": "Latvian Lats",
+    "symbol": "Ls",
+    "alternate_symbols": [],
+    "subunit": "Santīms",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "428",
+    "smallest_denomination": 1
+  },
   "mtl": {
     "priority": 100,
     "iso_code": "MTL",

data/config/currency_iso.json

@@ -1291,36 +1291,6 @@
     "iso_numeric": "426",
     "smallest_denomination": 1
   },
-  "ltl": {
-    "priority": 100,
-    "iso_code": "LTL",
-    "name": "Lithuanian Litas",
-    "symbol": "Lt",
-    "alternate_symbols": [],
-    "subunit": "Centas",
-    "subunit_to_unit": 100,
-    "symbol_first": false,
-    "html_entity": "",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "440",
-    "smallest_denomination": 1
-  },
-  "lvl": {
-    "priority": 100,
-    "iso_code": "LVL",
-    "name": "Latvian Lats",
-    "symbol": "Ls",
-    "alternate_symbols": [],
-    "subunit": "Santīms",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "428",
-    "smallest_denomination": 1
-  },
   "lyd": {
     "priority": 100,
     "iso_code": "LYD",

data/config/currency_non_iso.json

@@ -1,4 +1,20 @@
 {
+  "bch": {
+    "priority": 100,
+    "iso_code": "BCH",
+    "name": "Bitcoin Cash",
+    "symbol": "₿",
+    "disambiguate_symbol": "₿CH",
+    "alternate_symbols": ["BCH"],
+    "subunit": "Satoshi",
+    "subunit_to_unit": 100000000,
+    "symbol_first": false,
+    "html_entity": "₿",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
+  },
   "btc": {
     "priority": 100,
     "iso_code": "BTC",

data/lib/money/currency.rb

@@ -79,7 +79,8 @@ class Money
       #   Money::Currency.find_by_iso_numeric('001') #=> nil
       def find_by_iso_numeric(num)
         num = num.to_s
-        id, _ = self.table.find{|key, currency| currency[:iso_numeric] == num}
+        return if num.empty?
+        id, _ = self.table.find { |key, currency| currency[:iso_numeric] == num }
         new(id)
       rescue UnknownCurrency
         nil
@@ -170,13 +171,13 @@ class Money
         key = curr.fetch(:iso_code).downcase.to_sym
         @@mutex.synchronize { _instances.delete(key.to_s) }
         @table[key] = curr
-        @stringified_keys = stringify_keys
+        @stringified_keys = nil
       end
 
       # Inherit a new currency from existing one
       #
       # @param parent_iso_code [String] the international 3-letter code as defined
-      # @param curr [Hash] See {register} method for hash structure 
+      # @param curr [Hash] See {register} method for hash structure
       def inherit(parent_iso_code, curr)
         parent_iso_code = parent_iso_code.downcase.to_sym
         curr = @table.fetch(parent_iso_code, {}).merge(curr)
@@ -197,11 +198,10 @@ class Money
           key = curr.downcase.to_sym
         end
         existed = @table.delete(key)
-        @stringified_keys = stringify_keys if existed
+        @stringified_keys = nil if existed
         existed ? true : false
       end
 
-
       def each
         all.each { |c| yield(c) }
       end
@@ -401,6 +401,17 @@ class Money
       !!@symbol_first
     end
 
+    # Returns if a code currency is ISO.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   Money::Currency.new(:usd).iso?
+    #
+    def iso?
+      iso_numeric && iso_numeric != ''
+    end
+
     # Returns the relation between subunit and unit as a base 10 exponent.
     #
     # Note that MGA and MRO are exceptions and are rounded to 1

data/lib/money/locale_backend/base.rb

@@ -0,0 +1,7 @@
+require 'money/locale_backend/errors'
+
+class Money
+  module LocaleBackend
+    class Base; end
+  end
+end

data/lib/money/locale_backend/errors.rb

@@ -0,0 +1,6 @@
+class Money
+  module LocaleBackend
+    class NotSupported < StandardError; end
+    class Unknown < ArgumentError; end
+  end
+end

data/lib/money/locale_backend/i18n.rb

@@ -0,0 +1,24 @@
+require 'money/locale_backend/base'
+
+class Money
+  module LocaleBackend
+    class I18n < Base
+      KEY_MAP = {
+        thousands_separator: :delimiter,
+        decimal_mark: :separator
+      }.freeze
+
+      def initialize
+        raise NotSupported, 'I18n not found' unless defined?(::I18n)
+      end
+
+      def lookup(key, _)
+        i18n_key = KEY_MAP[key]
+
+        ::I18n.t i18n_key, scope: 'number.currency.format', raise: true
+      rescue ::I18n::MissingTranslationData
+        ::I18n.t i18n_key, scope: 'number.format', default: nil
+      end
+    end
+  end
+end

data/lib/money/locale_backend/legacy.rb

@@ -0,0 +1,28 @@
+require 'money/locale_backend/base'
+require 'money/locale_backend/i18n'
+
+class Money
+  module LocaleBackend
+    class Legacy < Base
+      def initialize
+        raise NotSupported, 'I18n not found' if Money.use_i18n && !defined?(::I18n)
+      end
+
+      def lookup(key, currency)
+        if Money.use_i18n
+          warn '[DEPRECATION] `use_i18n` is deprecated - use `Money.locale_backend = :i18n` instead'
+
+          i18n_backend.lookup(key, nil) || currency.public_send(key)
+        else
+          currency.public_send(key)
+        end
+      end
+
+      private
+
+      def i18n_backend
+        @i18n_backend ||= Money::LocaleBackend::I18n.new
+      end
+    end
+  end
+end

data/lib/money/money.rb

@@ -5,6 +5,7 @@ require "money/money/arithmetic"
 require "money/money/constructors"
 require "money/money/formatter"
 require "money/money/allocation"
+require "money/money/locale_backend"
 
 # "Money is any object or record that is generally accepted as payment for
 # goods and services and repayment of debts in a given socio-economic context
@@ -120,7 +121,8 @@ class Money
     #   @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
+      :use_i18n, :infinite_precision, :conversion_precision,
+      :locale_backend
 
     # @attr_writer rounding_mode Use this to specify the rounding mode
     #
@@ -141,6 +143,18 @@ class Money
     end
   end
 
+  def self.locale_backend=(value)
+    @locale_backend = value ? LocaleBackend.find(value) : nil
+  end
+
+  def self.use_i18n=(value)
+    if value
+      warn '[DEPRECATION] `use_i18n` is deprecated - use `Money.locale_backend = :i18n` instead'
+    end
+
+    @use_i18n = value
+  end
+
   def self.setup_defaults
     # Set the default bank for creating new +Money+ objects.
     self.default_bank = Bank::VariableExchange.instance
@@ -149,7 +163,10 @@ class Money
     self.default_currency = Currency.new("USD")
 
     # Default to using i18n
-    self.use_i18n = true
+    @use_i18n = true
+
+    # Default to using legacy locale backend
+    self.locale_backend = :legacy
 
     # Default to not using infinite precision cents
     self.infinite_precision = false
@@ -179,7 +196,7 @@ class Money
   #   fee = Money.rounding_mode(BigDecimal::ROUND_HALF_UP) do
   #     Money.new(1200) * BigDecimal('0.029')
   #   end
-  def self.rounding_mode(mode=nil)
+  def self.rounding_mode(mode = nil)
     if mode.nil?
       Thread.current[:money_rounding_mode] || @rounding_mode
     else
@@ -540,7 +557,8 @@ class Money
   # @return [String]
   #
   def thousands_separator
-    Money::Formatter.new(self, {}).thousands_separator
+    (locale_backend && locale_backend.lookup(:thousands_separator, currency)) ||
+      Money::Formatter::DEFAULTS[:thousands_separator]
   end
 
   # Returns a decimal mark according to the locale
@@ -548,7 +566,8 @@ class Money
   # @return [String]
   #
   def decimal_mark
-    Money::Formatter.new(self, {}).decimal_mark
+    (locale_backend && locale_backend.lookup(:decimal_mark, currency)) ||
+      Money::Formatter::DEFAULTS[:decimal_mark]
   end
 
   private
@@ -568,4 +587,8 @@ class Money
       value.round(0, self.class.rounding_mode).to_i
     end
   end
+
+  def locale_backend
+    self.class.locale_backend
+  end
 end

data/lib/money/money/formatter.rb

@@ -3,6 +3,11 @@ require 'money/money/formatting_rules'
 
 class Money
   class Formatter
+    DEFAULTS = {
+      thousands_separator: '',
+      decimal_mark: '.'
+    }.freeze
+
     # Creates a formatted price string according to several rules.
     #
     # @param [Hash] rules The options used to format the string.
@@ -203,6 +208,13 @@ class Money
     #   Money.new(89000, :btc).format(drop_trailing_zeros: true) #=> B⃦0.00089
     #   Money.new(110, :usd).format(drop_trailing_zeros: true)   #=> $1.1
     #
+    # @option rules [String] :format (nil) Provide a template for formatting. `%u` will be replaced
+    # with the symbol (if present) and `%n` will be replaced with the number.
+    #
+    # @example
+    #   Money.new(10000, "USD").format(format: '%u %n') #=> "$ 100.00"
+    #   Money.new(10000, "USD").format(format: '<span>%u%n</span>')  #=> "<span>$100.00</span>"
+    #
     # Note that the default rules can be defined through {Money.default_formatting_rules} hash.
     #
     # @see Money.default_formatting_rules Money.default_formatting_rules for more information.
@@ -214,15 +226,27 @@ class Money
 
     def to_s
       return free_text if show_free_text?
+      result = format_number
+      formatted = append_sign(result)
+      append_currency_symbol(formatted)
+    end
 
-      if rules[:html]
-        warn "[DEPRECATION] `html` is deprecated - use `html_wrap` instead. Please note that `html_wrap` will wrap all parts of currency and if you use `with_currency` option, currency element class changes from `currency` to `money-currency`."
-      end
+    def thousands_separator
+      lookup :thousands_separator
+    end
 
-      if rules[:html_wrap_symbol]
-        warn "[DEPRECATION] `html_wrap_symbol` is deprecated - use `html_wrap` instead. Please note that `html_wrap` will wrap all parts of currency."
-      end
+    def decimal_mark
+      lookup :decimal_mark
+    end
 
+    alias_method :delimiter, :thousands_separator
+    alias_method :separator, :decimal_mark
+
+    private
+
+    attr_reader :money, :currency, :rules
+
+    def format_number
       whole_part, decimal_part = extract_whole_and_decimal_parts
 
       # Format whole and decimal parts separately
@@ -230,16 +254,22 @@ class Money
       whole_part = format_whole_part(whole_part)
 
       # Assemble the final formatted amount
-      formatted = if rules[:html_wrap]
+      if rules[:html_wrap]
         if decimal_part.nil?
           html_wrap(whole_part, "whole")
         else
-          [html_wrap(whole_part, "whole"), html_wrap(decimal_mark, "decimal-mark"), html_wrap(decimal_part, "decimal")].join
+          [
+            html_wrap(whole_part, "whole"),
+            html_wrap(decimal_mark, "decimal-mark"),
+            html_wrap(decimal_part, "decimal")
+          ].join
         end
       else
         [whole_part, decimal_part].compact.join(decimal_mark)
       end
+    end
 
+    def append_sign(formatted_number)
       sign = money.negative? ? '-' : ''
 
       if rules[:sign_positive] == true && money.positive?
@@ -259,56 +289,30 @@ class Money
         elsif rules[:html_wrap]
           symbol_value = html_wrap(symbol_value, "currency-symbol")
         end
-        symbol_position = symbol_position_from(rules)
 
-        formatted = if symbol_position == :before
-          symbol_space = rules[:symbol_before_without_space] === false ? " " : ""
-          "#{sign_before}#{symbol_value}#{symbol_space}#{sign}#{formatted}"
-        else
-          symbol_space = rules[:symbol_after_without_space] ? "" : " "
-          "#{sign_before}#{sign}#{formatted}#{symbol_space}#{symbol_value}"
-        end
+        rules[:format]
+          .gsub('%u', [sign_before, symbol_value].join)
+          .gsub('%n', [sign, formatted_number].join)
       else
-        formatted="#{sign_before}#{sign}#{formatted}"
+        formatted_number = "#{sign_before}#{sign}#{formatted_number}"
       end
+    end
 
+    def append_currency_symbol(formatted_number)
       if rules[:with_currency]
-        formatted << " "
+        formatted_number << " "
 
         if rules[:html]
-          formatted << "<span class=\"currency\">#{currency.to_s}</span>"
+          formatted_number << "<span class=\"currency\">#{currency.to_s}</span>"
         elsif rules[:html_wrap]
-          formatted << html_wrap(currency.to_s, "currency")
+          formatted_number << html_wrap(currency.to_s, "currency")
         else
-          formatted << currency.to_s
+          formatted_number << currency.to_s
         end
       end
-      formatted
-    end
-
-    def thousands_separator
-      if rules.has_key?(:thousands_separator)
-        rules[:thousands_separator] || ''
-      else
-        i18n_format_for(:thousands_separator, :delimiter, ',')
-      end
-    end
-
-    def decimal_mark
-      if rules.has_key?(:decimal_mark)
-        rules[:decimal_mark] || '.'
-      else
-        i18n_format_for(:decimal_mark, :separator, '.')
-      end
+      formatted_number
     end
 
-    alias_method :delimiter, :thousands_separator
-    alias_method :separator, :decimal_mark
-
-    private
-
-    attr_reader :money, :currency, :rules
-
     def show_free_text?
       money.zero? && rules[:display_free]
     end
@@ -322,15 +326,8 @@ class Money
     end
 
     def format_whole_part(value)
-      # Determine thousands_separator
-      thousands_separator_value = if rules.has_key?(:thousands_separator)
-                                    rules[:thousands_separator] || ''
-                                  else
-                                    thousands_separator
-                                  end
-
       # Apply thousands_separator
-      value.gsub regexp_format, "\\1#{thousands_separator_value}"
+      value.gsub regexp_format, "\\1#{thousands_separator}"
     end
 
     def extract_whole_and_decimal_parts
@@ -360,16 +357,10 @@ class Money
       value.empty? ? nil : value
     end
 
-    def i18n_format_for(method, name, character)
-      if Money.use_i18n
-        begin
-          I18n.t name, scope: "number.currency.format", raise: true
-        rescue I18n::MissingTranslationData
-          I18n.t name, scope: "number.format", default: (currency.send(method) || character)
-        end
-      else
-        currency.send(method) || character
-      end
+    def lookup(key)
+      return rules[key] || DEFAULTS[key] if rules.has_key?(key)
+
+      (Money.locale_backend && Money.locale_backend.lookup(key, currency)) || DEFAULTS[key]
     end
 
     def regexp_format
@@ -402,19 +393,5 @@ class Money
         money.symbol
       end
     end
-
-    def symbol_position_from(rules)
-      if rules.has_key?(:symbol_position)
-        if [:before, :after].include?(rules[:symbol_position])
-          return rules[:symbol_position]
-        else
-          raise ArgumentError, ":symbol_position must be ':before' or ':after'"
-        end
-      elsif currency.symbol_first?
-        :before
-      else
-        :after
-      end
-    end
   end
 end

data/lib/money/money/formatting_rules.rb

@@ -11,6 +11,9 @@ class Money
       @rules = default_formatting_rules.merge(@rules) unless @rules[:ignore_defaults]
       @rules = localize_formatting_rules(@rules)
       @rules = translate_formatting_rules(@rules) if @rules[:translate]
+      @rules[:format] ||= determine_format_from_formatting_rules(@rules)
+
+      warn_about_deprecated_rules(@rules)
     end
 
     def [](key)
@@ -62,10 +65,56 @@ class Money
     def localize_formatting_rules(rules)
       if currency.iso_code == "JPY" && I18n.locale == :ja
         rules[:symbol] = "円" unless rules[:symbol] == false
-        rules[:symbol_position] = :after
-        rules[:symbol_after_without_space] = true
+        rules[:format] = '%n%u'
       end
       rules
     end
+
+    def determine_format_from_formatting_rules(rules)
+      symbol_position = symbol_position_from(rules)
+
+      if symbol_position == :before
+        rules.fetch(:symbol_before_without_space, true) ? '%u%n' : '%u %n'
+      else
+        rules[:symbol_after_without_space] ? '%n%u' : '%n %u'
+      end
+    end
+
+    def symbol_position_from(rules)
+      if rules.has_key?(:symbol_position)
+        if [:before, :after].include?(rules[:symbol_position])
+          return rules[:symbol_position]
+        else
+          raise ArgumentError, ":symbol_position must be ':before' or ':after'"
+        end
+      elsif currency.symbol_first?
+        :before
+      else
+        :after
+      end
+    end
+
+    def warn_about_deprecated_rules(rules)
+      if rules.has_key?(:symbol_position)
+        warn '[DEPRECATION] `symbol_position:` option is deprecated - use `format` to specify the formatting template.'
+      end
+
+      if rules.has_key?(:symbol_before_without_space)
+        warn '[DEPRECATION] `symbol_before_without_space:` option is deprecated - use `format` to specify the formatting template.'
+      end
+
+      if rules.has_key?(:symbol_after_without_space)
+        warn '[DEPRECATION] `symbol_after_without_space:` option is deprecated - use `format` to specify the formatting template.'
+      end
+
+      if rules.has_key?(:html)
+        warn "[DEPRECATION] `html` is deprecated - use `html_wrap` instead. Please note that `html_wrap` will wrap all parts of currency and if you use `with_currency` option, currency element class changes from `currency` to `money-currency`."
+      end
+
+      if rules.has_key?(:html_wrap_symbol)
+        warn "[DEPRECATION] `html_wrap_symbol` is deprecated - use `html_wrap` instead. Please note that `html_wrap` will wrap all parts of currency."
+      end
+
+    end
   end
 end

data/lib/money/money/locale_backend.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+
+require 'money/locale_backend/errors'
+require 'money/locale_backend/legacy'
+require 'money/locale_backend/i18n'
+
+class Money
+  module LocaleBackend
+    BACKENDS = {
+      legacy: Money::LocaleBackend::Legacy,
+      i18n: Money::LocaleBackend::I18n
+    }.freeze
+
+    def self.find(name)
+      raise Unknown, "Unknown locale backend: #{name}" unless BACKENDS.key?(name)
+
+      BACKENDS[name].new
+    end
+  end
+end

data/lib/money/version.rb

@@ -1,3 +1,3 @@
 class Money
-  VERSION = '6.12.0'
+  VERSION = '6.13.0'
 end

data/money.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |s|
   s.description = "A Ruby Library for dealing with money and currency conversion."
   s.license     = "MIT"
 
-  s.add_dependency 'i18n', [">= 0.6.4", '< 1.1']
+  s.add_dependency 'i18n', [">= 0.6.4", '<= 2']
 
   s.add_development_dependency "bundler", "~> 1.3"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "~> 3.4.0"
+  s.add_development_dependency "rspec", "~> 3.4"
   s.add_development_dependency "yard", "~> 0.9.11"
   s.add_development_dependency "kramdown", "~> 1.1"
 
@@ -26,4 +26,10 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
+
+  if s.respond_to?(:metadata)
+    s.metadata['changelog_uri'] = 'https://github.com/RubyMoney/money/blob/master/CHANGELOG.md'
+    s.metadata['source_code_uri'] = 'https://github.com/RubyMoney/money/'
+    s.metadata['bug_tracker_uri'] = 'https://github.com/RubyMoney/money/issues'
+  end
 end

data/spec/currency_spec.rb

@@ -59,6 +59,11 @@ class Money
         expect(Currency.find_by_iso_numeric('non iso 4217 numeric code')).to be_nil
         expect(Currency.find_by_iso_numeric(0)).to be_nil
       end
+
+      it "returns nil when given empty input" do
+        expect(Currency.find_by_iso_numeric('')).to be_nil
+        expect(Currency.find_by_iso_numeric(nil)).to be_nil
+      end
     end
 
     describe ".wrap" do
@@ -321,6 +326,16 @@ class Money
       end
     end
 
+    describe "#iso?" do
+      it "returns true for iso currency" do
+        expect(Money::Currency.new(:eur).iso?).to be true
+      end
+
+      it "returns false if the currency is not iso" do
+        expect(Money::Currency.new(:btc).iso?).to be false
+      end
+    end
+
     describe "#to_s" do
       it "works as documented" do
         expect(Currency.new(:usd).to_s).to eq("USD")

data/spec/locale_backend/i18n_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+describe Money::LocaleBackend::I18n do
+  describe '#initialize' do
+    it 'raises an error when I18n is not defined' do
+      hide_const('I18n')
+
+      expect { described_class.new }.to raise_error(Money::LocaleBackend::NotSupported)
+    end
+  end
+
+  describe '#lookup' do
+    after do
+      reset_i18n
+      I18n.locale = :en
+    end
+
+    subject { described_class.new }
+
+    context 'with number.currency.format defined' do
+      before do
+        I18n.locale = :de
+        I18n.backend.store_translations(:de, number: {
+          currency: { format: { delimiter: '.', separator: ',' } }
+        })
+      end
+
+      it 'returns thousands_separator based on the current locale' do
+        expect(subject.lookup(:thousands_separator, nil)).to eq('.')
+      end
+
+      it 'returns decimal_mark based on the current locale' do
+        expect(subject.lookup(:decimal_mark, nil)).to eq(',')
+      end
+    end
+
+    context 'with number.format defined' do
+      before do
+        I18n.locale = :de
+        I18n.backend.store_translations(:de, number: { format: { delimiter: '.', separator: ',' } })
+      end
+
+      it 'returns thousands_separator based on the current locale' do
+        expect(subject.lookup(:thousands_separator, nil)).to eq('.')
+      end
+
+      it 'returns decimal_mark based on the current locale' do
+        expect(subject.lookup(:decimal_mark, nil)).to eq(',')
+      end
+    end
+
+    context 'with no translation defined' do
+      it 'returns thousands_separator based on the current locale' do
+        expect(subject.lookup(:thousands_separator, nil)).to eq(nil)
+      end
+
+      it 'returns decimal_mark based on the current locale' do
+        expect(subject.lookup(:decimal_mark, nil)).to eq(nil)
+      end
+    end
+  end
+end

data/spec/locale_backend/legacy_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+describe Money::LocaleBackend::Legacy do
+  after { Money.use_i18n = true }
+
+  describe '#initialize' do
+    it 'raises an error when use_i18n is true and I18n is not defined' do
+      Money.use_i18n = true
+      hide_const('I18n')
+
+      expect { described_class.new }.to raise_error(Money::LocaleBackend::NotSupported)
+    end
+
+    it 'does not raise error when use_i18n is false and I18n is not defined' do
+      Money.use_i18n = false
+      hide_const('I18n')
+
+      expect { described_class.new }.not_to raise_error
+    end
+  end
+
+  describe '#lookup' do
+    subject { described_class.new }
+    let(:currency) { Money::Currency.new('USD') }
+
+    context 'use_i18n is true and i18n lookup is successful' do
+      before do
+        allow(subject.send(:i18n_backend))
+          .to receive(:lookup)
+          .with(:thousands_separator, nil)
+          .and_return('.')
+
+        allow(subject.send(:i18n_backend))
+          .to receive(:lookup)
+          .with(:decimal_mark, nil)
+          .and_return(',')
+      end
+
+      it 'returns thousands_separator from I18n' do
+        expect(subject.lookup(:thousands_separator, currency)).to eq('.')
+      end
+
+      it 'returns decimal_mark based from I18n' do
+        expect(subject.lookup(:decimal_mark, currency)).to eq(',')
+      end
+    end
+
+    context 'use_i18n is true but i18n lookup is unsuccessful' do
+      before do
+        allow(subject.send(:i18n_backend)).to receive(:lookup).and_return(nil)
+      end
+
+      it 'returns thousands_separator as defined in currency' do
+        expect(subject.lookup(:thousands_separator, currency)).to eq(',')
+      end
+
+      it 'returns decimal_mark based as defined in currency' do
+        expect(subject.lookup(:decimal_mark, currency)).to eq('.')
+      end
+    end
+
+    context 'use_i18n is false' do
+      before { Money.use_i18n = false }
+
+      it 'returns thousands_separator as defined in currency' do
+        expect(subject.lookup(:thousands_separator, currency)).to eq(',')
+      end
+
+      it 'returns decimal_mark based as defined in currency' do
+        expect(subject.lookup(:decimal_mark, currency)).to eq('.')
+      end
+    end
+  end
+end

data/spec/money/formatting_spec.rb

@@ -18,6 +18,19 @@ describe Money, "formatting" do
     end
   end
 
+  context 'without locale_backend' do
+    before { Money.locale_backend = nil }
+    after { Money.locale_backend = :legacy }
+
+    subject(:money) { Money.new(1099_99, 'USD') }
+
+    it 'falls back to using defaults' do
+      expect(money.thousands_separator).to eq('')
+      expect(money.decimal_mark).to eq('.')
+      expect(money.format).to eq('$1099.99')
+    end
+  end
+
   context "with i18n but use_i18n = false" do
     before :each do
       reset_i18n
@@ -661,6 +674,42 @@ describe Money, "formatting" do
       end
     end
 
+    describe ':format option' do
+      let(:money) { Money.new(99_99, 'USD') }
+
+      it 'uses provided format as a template' do
+        expect(money.format(format: '%n')).to eq('99.99')
+        expect(money.format(format: '%u')).to eq('$')
+        expect(money.format(format: '%u%n')).to eq('$99.99')
+        expect(money.format(format: '%n%u')).to eq('99.99$')
+        expect(money.format(format: '%u %n')).to eq('$ 99.99')
+        expect(money.format(format: 'Your balance is: %u%n')).to eq('Your balance is: $99.99')
+      end
+
+      it 'ignores :symbol_position in favour of format' do
+        expect(money.format(format: '%u%n', symbol_position: :after)).to eq('$99.99')
+        expect(money.format(format: '%n%u', symbol_position: :before)).to eq('99.99$')
+      end
+
+      it 'ignores :symbol_before_without_space in favour of format' do
+        expect(money.format(format: '%u %n', symbol_position: :before, symbol_before_without_space: true)).to eq('$ 99.99')
+        expect(money.format(format: '%u%n', symbol_position: :before, symbol_before_without_space: false)).to eq('$99.99')
+      end
+
+      it 'ignores :symbol_after_without_space in favour of format' do
+        expect(money.format(format: '%n %u', symbol_position: :after, symbol_after_without_space: true)).to eq('99.99 $')
+        expect(money.format(format: '%n%u', symbol_position: :after, symbol_after_without_space: false)).to eq('99.99$')
+      end
+
+      it 'works with sign' do
+        money = Money.new(-99_99, 'USD')
+
+        expect(money.format(format: '%n%u', sign_before_symbol: false)).to eq('-99.99$')
+        expect(money.format(format: '%u%n', sign_before_symbol: false)).to eq('$-99.99')
+        expect(money.format(format: '%u%n', sign_before_symbol: true)).to eq('-$99.99')
+      end
+    end
+
     context "when the monetary value is 0" do
       let(:money) { Money.us_dollar(0) }
 
@@ -730,6 +779,7 @@ describe Money, "formatting" do
       expect(Money.new(1999_98, "DKK").format).to eq("1.999,98 kr.")
       expect(Money.new(1999_98, "NOK").format).to eq("1.999,98 kr")
       expect(Money.new(1999_98, "SEK").format).to eq("1 999,98 kr")
+      expect(Money.new(1999_98, "BCH").format).to eq("0.00199998 ₿")
     end
 
     it "returns ambiguous signs when disambiguate is false" do
@@ -738,6 +788,7 @@ describe Money, "formatting" do
       expect(Money.new(1999_98, "DKK").format(disambiguate: false)).to eq("1.999,98 kr.")
       expect(Money.new(1999_98, "NOK").format(disambiguate: false)).to eq("1.999,98 kr")
       expect(Money.new(1999_98, "SEK").format(disambiguate: false)).to eq("1 999,98 kr")
+      expect(Money.new(1999_98, "BCH").format(disambiguate: false)).to eq("0.00199998 ₿")
     end
 
     it "returns disambiguate signs when disambiguate: true" do
@@ -746,6 +797,7 @@ describe Money, "formatting" do
       expect(Money.new(1999_98, "DKK").format(disambiguate: true)).to eq("1.999,98 DKK")
       expect(Money.new(1999_98, "NOK").format(disambiguate: true)).to eq("1.999,98 NOK")
       expect(Money.new(1999_98, "SEK").format(disambiguate: true)).to eq("1 999,98 SEK")
+      expect(Money.new(1999_98, "BCH").format(disambiguate: true)).to eq("0.00199998 ₿CH")
     end
 
     it "returns disambiguate signs when disambiguate: true and symbol: true" do
@@ -754,6 +806,7 @@ describe Money, "formatting" do
       expect(Money.new(1999_98, "DKK").format(disambiguate: true, symbol: true)).to eq("1.999,98 DKK")
       expect(Money.new(1999_98, "NOK").format(disambiguate: true, symbol: true)).to eq("1.999,98 NOK")
       expect(Money.new(1999_98, "SEK").format(disambiguate: true, symbol: true)).to eq("1 999,98 SEK")
+      expect(Money.new(1999_98, "BCH").format(disambiguate: true, symbol: true)).to eq("0.00199998 ₿CH")
     end
 
     it "returns no signs when disambiguate: true and symbol: false" do
@@ -762,6 +815,7 @@ describe Money, "formatting" do
       expect(Money.new(1999_98, "DKK").format(disambiguate: true, symbol: false)).to eq("1.999,98")
       expect(Money.new(1999_98, "NOK").format(disambiguate: true, symbol: false)).to eq("1.999,98")
       expect(Money.new(1999_98, "SEK").format(disambiguate: true, symbol: false)).to eq("1 999,98")
+      expect(Money.new(1999_98, "BCH").format(disambiguate: true, symbol: false)).to eq("0.00199998")
     end
 
     it "should never return an ambiguous format with disambiguate: true" do
@@ -779,15 +833,21 @@ describe Money, "formatting" do
     describe ":drop_trailing_zeros option" do
       specify "(drop_trailing_zeros: true) works as documented" do
         expect(Money.new(89000, "BTC").format(drop_trailing_zeros: true, symbol: false)).to eq "0.00089"
+        expect(Money.new(89000, "BCH").format(drop_trailing_zeros: true, symbol: false)).to eq "0.00089"
         expect(Money.new(100089000, "BTC").format(drop_trailing_zeros: true, symbol: false)).to eq "1.00089"
+        expect(Money.new(100089000, "BCH").format(drop_trailing_zeros: true, symbol: false)).to eq "1.00089"
         expect(Money.new(100000000, "BTC").format(drop_trailing_zeros: true, symbol: false)).to eq "1"
+        expect(Money.new(100000000, "BCH").format(drop_trailing_zeros: true, symbol: false)).to eq "1"
         expect(Money.new(110, "AUD").format(drop_trailing_zeros: true, symbol: false)).to eq "1.1"
       end
 
       specify "(drop_trailing_zeros: false) works as documented" do
         expect(Money.new(89000, "BTC").format(drop_trailing_zeros: false, symbol: false)).to eq "0.00089000"
+        expect(Money.new(89000, "BCH").format(drop_trailing_zeros: false, symbol: false)).to eq "0.00089000"
         expect(Money.new(100089000, "BTC").format(drop_trailing_zeros: false, symbol: false)).to eq "1.00089000"
+        expect(Money.new(100089000, "BCH").format(drop_trailing_zeros: false, symbol: false)).to eq "1.00089000"
         expect(Money.new(100000000, "BTC").format(drop_trailing_zeros: false, symbol: false)).to eq "1.00000000"
+        expect(Money.new(100000000, "BCH").format(drop_trailing_zeros: false, symbol: false)).to eq "1.00000000"
         expect(Money.new(110, "AUD").format(drop_trailing_zeros: false, symbol: false)).to eq "1.10"
       end
     end

data/spec/money/locale_backend_spec.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+describe Money::LocaleBackend do
+  describe '.find' do
+    it 'returns an initialized backend' do
+      expect(described_class.find(:legacy)).to be_a(Money::LocaleBackend::Legacy)
+      expect(described_class.find(:i18n)).to be_a(Money::LocaleBackend::I18n)
+    end
+
+    it 'raises an error if a backend is unknown' do
+      expect { described_class.find(:foo) }.to raise_error(Money::LocaleBackend::Unknown)
+    end
+  end
+end

data/spec/money_spec.rb

@@ -1,6 +1,22 @@
 # encoding: utf-8
 
 describe Money do
+  describe '.locale_backend' do
+    after { Money.locale_backend = :legacy }
+
+    it 'sets the locale_backend' do
+      Money.locale_backend = :i18n
+
+      expect(Money.locale_backend).to be_a(Money::LocaleBackend::I18n)
+    end
+
+    it 'sets the locale_backend to nil' do
+      Money.locale_backend = nil
+
+      expect(Money.locale_backend).to eq(nil)
+    end
+  end
+
   describe ".new" do
     let(:initializing_value) { 1 }
     subject(:money) { Money.new(initializing_value) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money
 version: !ruby/object:Gem::Version
-  version: 6.12.0
+  version: 6.13.0
 platform: ruby
 authors:
 - Shane Emmons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.4
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.4
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -128,12 +128,17 @@ files:
 - lib/money/currency.rb
 - lib/money/currency/heuristics.rb
 - lib/money/currency/loader.rb
+- lib/money/locale_backend/base.rb
+- lib/money/locale_backend/errors.rb
+- lib/money/locale_backend/i18n.rb
+- lib/money/locale_backend/legacy.rb
 - lib/money/money.rb
 - lib/money/money/allocation.rb
 - lib/money/money/arithmetic.rb
 - lib/money/money/constructors.rb
 - lib/money/money/formatter.rb
 - lib/money/money/formatting_rules.rb
+- lib/money/money/locale_backend.rb
 - lib/money/rates_store/memory.rb
 - lib/money/version.rb
 - money.gemspec
@@ -143,10 +148,13 @@ files:
 - spec/currency/heuristics_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb
+- spec/locale_backend/i18n_spec.rb
+- spec/locale_backend/legacy_spec.rb
 - spec/money/allocation_spec.rb
 - spec/money/arithmetic_spec.rb
 - spec/money/constructors_spec.rb
 - spec/money/formatting_spec.rb
+- spec/money/locale_backend_spec.rb
 - spec/money_spec.rb
 - spec/rates_store/memory_spec.rb
 - spec/spec_helper.rb
@@ -154,7 +162,10 @@ files:
 homepage: https://rubymoney.github.io/money
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/RubyMoney/money/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/RubyMoney/money/
+  bug_tracker_uri: https://github.com/RubyMoney/money/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -182,10 +193,13 @@ test_files:
 - spec/currency/heuristics_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb
+- spec/locale_backend/i18n_spec.rb
+- spec/locale_backend/legacy_spec.rb
 - spec/money/allocation_spec.rb
 - spec/money/arithmetic_spec.rb
 - spec/money/constructors_spec.rb
 - spec/money/formatting_spec.rb
+- spec/money/locale_backend_spec.rb
 - spec/money_spec.rb
 - spec/rates_store/memory_spec.rb
 - spec/spec_helper.rb