money 6.14.1 → 6.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 766ce2bf89d38cdc9280a79a77e1e6ccf940d1453a6b3d507e1a9ea81fd1d8ca
-  data.tar.gz: 9fb7990b6742cc6778733f3369a129e8911ac85f6c796f94f3e120af2e7c9794
+  metadata.gz: 3de47437ec002ed24a400508cac96b2ff6812f484c666fe3db3a82e921a805c0
+  data.tar.gz: f96755602e56ea81d734b7505e7cfc88caaa948d7a8d285eeb470801028c15b9
 SHA512:
-  metadata.gz: 3c6f467ccdfac45d2603a7642cf0da25cf0a4057bfa4d03c33a20acb4805b120b8fbe4c9b9cb8bdea6a3cc89d92425c5da19aaf5eef07827e5b16f82d054db13
-  data.tar.gz: 749fc675428631b124ec50da09f76f253c7b76cb350262f82dc53de5f334e30bd4d143c1477ab76305ad747c29fb7750ca91976f5f2562d212580cf65158dde7
+  metadata.gz: 2f8cd71611e96a80cb733651675cb6fac59d358cb7c9576c8c264abbfec6eb1da11b8cbe2af12cdfb070e5dd01cd74f6fdc70772da16aa4c2abc5248b13fca3c
+  data.tar.gz: '092ba5a188eb29d462431e94420e1c6d7a7f9a4a59c0895f66a4a1cf92cfaa37cbc1bc344a241f5f8cc9fc4e998189164bc2d0ab11480a589fe7bb0e341754ba'

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 6.16.0
+
+- Add `Money.from_cents` alias as a more explicit initializer, it's the same as `Money.new`
+
+## 6.15.0
+
+- Add :delimiter_pattern option to the Formatter
+
 ## 6.14.1
 
 - Fix CHF format regression introduced in v6.14.0

data/LICENSE

@@ -1,23 +1,23 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2005 Tobias Lutke
 Copyright (c) 2008 Phusion
+Copyright (c) 2021 Shane Emmons
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -61,38 +61,38 @@ The development version (hosted on Github) can be installed with:
 require 'money'
 
 # 10.00 USD
-money = Money.new(1000, "USD")
+money = Money.from_cents(1000, "USD")
 money.cents     #=> 1000
 money.currency  #=> Currency.new("USD")
 
 # Comparisons
-Money.new(1000, "USD") == Money.new(1000, "USD")   #=> true
-Money.new(1000, "USD") == Money.new(100, "USD")    #=> false
-Money.new(1000, "USD") == Money.new(1000, "EUR")   #=> false
-Money.new(1000, "USD") != Money.new(1000, "EUR")   #=> true
+Money.from_cents(1000, "USD") == Money.from_cents(1000, "USD")   #=> true
+Money.from_cents(1000, "USD") == Money.from_cents(100, "USD")    #=> false
+Money.from_cents(1000, "USD") == Money.from_cents(1000, "EUR")   #=> false
+Money.from_cents(1000, "USD") != Money.from_cents(1000, "EUR")   #=> true
 
 # Arithmetic
-Money.new(1000, "USD") + Money.new(500, "USD") == Money.new(1500, "USD")
-Money.new(1000, "USD") - Money.new(200, "USD") == Money.new(800, "USD")
-Money.new(1000, "USD") / 5                     == Money.new(200, "USD")
-Money.new(1000, "USD") * 5                     == Money.new(5000, "USD")
+Money.from_cents(1000, "USD") + Money.from_cents(500, "USD") == Money.from_cents(1500, "USD")
+Money.from_cents(1000, "USD") - Money.from_cents(200, "USD") == Money.from_cents(800, "USD")
+Money.from_cents(1000, "USD") / 5                            == Money.from_cents(200, "USD")
+Money.from_cents(1000, "USD") * 5                            == Money.from_cents(5000, "USD")
 
 # Unit to subunit conversions
-Money.from_amount(5, "USD") == Money.new(500, "USD")  # 5 USD
-Money.from_amount(5, "JPY") == Money.new(5, "JPY")    # 5 JPY
-Money.from_amount(5, "TND") == Money.new(5000, "TND") # 5 TND
+Money.from_amount(5, "USD") == Money.from_cents(500, "USD")  # 5 USD
+Money.from_amount(5, "JPY") == Money.from_cents(5, "JPY")    # 5 JPY
+Money.from_amount(5, "TND") == Money.from_cents(5000, "TND") # 5 TND
 
 # Currency conversions
 some_code_to_setup_exchange_rates
-Money.new(1000, "USD").exchange_to("EUR") == Money.new(some_value, "EUR")
+Money.from_cents(1000, "USD").exchange_to("EUR") == Money.from_cents(some_value, "EUR")
 
 # Swap currency
-Money.new(1000, "USD").with_currency("EUR") == Money.new(1000, "EUR")
+Money.from_cents(1000, "USD").with_currency("EUR") == Money.from_cents(1000, "EUR")
 
 # Formatting (see Formatting section for more options)
-Money.new(100, "USD").format #=> "$1.00"
-Money.new(100, "GBP").format #=> "£1.00"
-Money.new(100, "EUR").format #=> "€1.00"
+Money.from_cents(100, "USD").format #=> "$1.00"
+Money.from_cents(100, "GBP").format #=> "£1.00"
+Money.from_cents(100, "EUR").format #=> "€1.00"
 ```
 
 ## Currency
@@ -102,15 +102,15 @@ The most part of `Money` APIs allows you to supply either a `String` or a
 `Money::Currency`.
 
 ``` ruby
-Money.new(1000, "USD") == Money.new(1000, Money::Currency.new("USD"))
-Money.new(1000, "EUR").currency == Money::Currency.new("EUR")
+Money.from_cents(1000, "USD") == Money.from_cents(1000, Money::Currency.new("USD"))
+Money.from_cents(1000, "EUR").currency == Money::Currency.new("EUR")
 ```
 
 A `Money::Currency` instance holds all the information about the currency,
 including the currency symbol, name and much more.
 
 ``` ruby
-currency = Money.new(1000, "USD").currency
+currency = Money.from_cents(1000, "USD").currency
 currency.iso_code #=> "USD"
 currency.name     #=> "United States Dollar"
 ```
@@ -230,18 +230,18 @@ an example of how it works:
 Money.add_rate("USD", "CAD", 1.24515)
 Money.add_rate("CAD", "USD", 0.803115)
 
-Money.us_dollar(100).exchange_to("CAD")  # => Money.new(124, "CAD")
-Money.ca_dollar(100).exchange_to("USD")  # => Money.new(80, "USD")
+Money.us_dollar(100).exchange_to("CAD")  # => Money.from_cents(124, "CAD")
+Money.ca_dollar(100).exchange_to("USD")  # => Money.from_cents(80, "USD")
 ```
 
 Comparison and arithmetic operations work as expected:
 
 ``` ruby
-Money.new(1000, "USD") <=> Money.new(900, "USD")   # => 1; 9.00 USD is smaller
-Money.new(1000, "EUR") + Money.new(10, "EUR") == Money.new(1010, "EUR")
+Money.from_cents(1000, "USD") <=> Money.from_cents(900, "USD")   # => 1; 9.00 USD is smaller
+Money.from_cents(1000, "EUR") + Money.from_cents(10, "EUR") == Money.from_cents(1010, "EUR")
 
 Money.add_rate("USD", "EUR", 0.5)
-Money.new(1000, "EUR") + Money.new(1000, "USD") == Money.new(1500, "EUR")
+Money.from_cents(1000, "EUR") + Money.from_cents(1000, "USD") == Money.from_cents(1500, "EUR")
 ```
 
 ### Exchange rate stores
@@ -349,7 +349,7 @@ Money.default_bank.add_rate('USD', 'CAD', 0.9)
 # Retrieve from the underlying store
 Money.default_bank.get_rate('USD', 'CAD') # => 0.9
 # Exchanging amounts just works.
-Money.new(1000, 'USD').exchange_to('CAD') #=> #<Money fractional:900 currency:CAD>
+Money.from_cents(1000, 'USD').exchange_to('CAD') #=> #<Money fractional:900 currency:CAD>
 ```
 
 There is nothing stopping you from creating store objects which scrapes
@@ -396,7 +396,7 @@ There are several formatting rules for when `Money#format` is called. For more i
 If you wish to format money according to the EU's [Rules for expressing monetary units](http://publications.europa.eu/code/en/en-370303.htm#position) in either English, Irish, Latvian or Maltese:
 
 ```ruby
-m = Money.new('123', :gbp) # => #<Money fractional:123 currency:GBP>
+m = Money.from_cents('123', :gbp) # => #<Money fractional:123 currency:GBP>
 m.format(symbol: m.currency.to_s + ' ') # => "GBP 1.23"
 ```
 
@@ -424,9 +424,9 @@ To round to the nearest cent (or anything more precise), you can use the `round`
 
 # Money
 Money.default_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"
+Money.from_cents(2.34567).format       #=> "$0.0234567"
+Money.from_cents(2.34567).round.format #=> "$0.02"
+Money.from_cents(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:
@@ -466,7 +466,7 @@ en:
       separator: "."
 ```
 
-For this example `Money.new(123456789, "SEK").format` will return `1,234,567.89
+For this example `Money.from_cents(123456789, "SEK").format` will return `1,234,567.89
 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.
@@ -490,12 +490,12 @@ 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
+Money.from_cents(10_000_00, 'USD').format # => $10,000.00
+Money.from_cents(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
+Money.from_cents(10_000_00, 'USD').format # => $10.000,00
+Money.from_cents(10_000_00, 'EUR').format # => €10.000,00
 ```
 
 If you need to localize the position of the currency symbol, you
@@ -505,7 +505,7 @@ 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 €
+Money.from_cents(10_00, 'EUR').format(format: format) # => 10,00 €
 ```
 
 For the legacy behaviour of "per currency" localization (formatting depends only on currency):
@@ -514,8 +514,8 @@ For the legacy behaviour of "per currency" localization (formatting depends only
 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
+Money.from_cents(10_000_00, 'USD').format # => $10,000.00
+Money.from_cents(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
@@ -525,8 +525,8 @@ In case you don't need localization and would like to use default values (can be
 Money.locale_backend = nil
 
 # example:
-Money.new(10_000_00, 'USD').format # => $10000.00
-Money.new(10_000_00, 'EUR').format # => €10000.00
+Money.from_cents(10_000_00, 'USD').format # => $10000.00
+Money.from_cents(10_000_00, 'EUR').format # => €10000.00
 ```
 
 ## Collection

data/lib/money/money.rb

@@ -312,6 +312,10 @@ class Money
     new(value, currency, options)
   end
 
+  class << self
+    alias_method :from_cents, :new
+  end
+
   # Creates a new Money object of value given in the
   # +fractional unit+ of the given +currency+.
   #

data/lib/money/money/formatter.rb

@@ -211,6 +211,12 @@ 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 [Boolean] :delimiter_pattern (/(\d)(?=(?:\d{3})+(?:[^\d]{1}|$))/) Regular expression to set the placement
+    #   for the thousands delimiter
+    #
+    # @example
+    #   Money.new(89000, :btc).format(delimiter_pattern: /(\d)(?=\d)/) #=> B⃦8,9,0.00
+    #
     # @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.
     #
@@ -330,7 +336,9 @@ class Money
 
     def format_whole_part(value)
       # Apply thousands_separator
-      value.gsub regexp_format, "\\1#{thousands_separator}"
+      value.gsub(rules[:delimiter_pattern]) do |digit_to_delimit|
+        "#{digit_to_delimit}#{thousands_separator}"
+      end
     end
 
     def extract_whole_and_decimal_parts
@@ -366,15 +374,6 @@ class Money
       (Money.locale_backend && Money.locale_backend.lookup(key, currency)) || DEFAULTS[key]
     end
 
-    def regexp_format
-      if rules[:south_asian_number_formatting]
-        # from http://blog.revathskumar.com/2014/11/regex-comma-seperated-indian-currency-format.html
-        /(\d+?)(?=(\d\d)+(\d)(?!\d))(\.\d+)?/
-      else
-        /(\d)(?=(?:\d{3})+(?:[^\d]{1}|$))/
-      end
-    end
-
     def symbol_value_from(rules)
       if rules.has_key?(:symbol)
         if rules[:symbol] === true

data/lib/money/money/formatting_rules.rb

@@ -12,6 +12,7 @@ class Money
       @rules = localize_formatting_rules(@rules)
       @rules = translate_formatting_rules(@rules) if @rules[:translate]
       @rules[:format] ||= determine_format_from_formatting_rules(@rules)
+      @rules[:delimiter_pattern] ||= delimiter_pattern_rule(@rules)
 
       warn_about_deprecated_rules(@rules)
     end
@@ -90,6 +91,15 @@ class Money
       end
     end
 
+    def delimiter_pattern_rule(rules)
+      if rules[:south_asian_number_formatting]
+        # from http://blog.revathskumar.com/2014/11/regex-comma-seperated-indian-currency-format.html
+        /(\d+?)(?=(\d\d)+(\d)(?!\d))(\.\d+)?/
+      else
+        /(\d)(?=(?:\d{3})+(?:[^\d]{1}|$))/
+      end
+    end
+
     def symbol_position_from(rules)
       if rules.has_key?(:symbol_position)
         if [:before, :after].include?(rules[:symbol_position])

data/lib/money/version.rb

@@ -1,3 +1,3 @@
 class Money
-  VERSION = '6.14.1'
+  VERSION = '6.16.0'
 end

data/money.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 3.4"
   s.add_development_dependency "yard", "~> 0.9.11"
-  s.add_development_dependency "kramdown", "~> 1.1"
+  s.add_development_dependency "kramdown", "~> 2.3"
 
   s.files         = `git ls-files -z -- config/* lib/* CHANGELOG.md LICENSE money.gemspec README.md`.split("\x0")
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: money
 version: !ruby/object:Gem::Version
-  version: 6.14.1
+  version: 6.16.0
 platform: ruby
 authors:
 - Shane Emmons
 - Anthony Dmitriyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.3'
 description: A Ruby Library for dealing with money and currency conversion.
 email:
 - shane@emmons.io
@@ -144,7 +144,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,8 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Ruby Library for dealing with money and currency conversion.
 test_files: []