money 6.16.0 → 6.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de47437ec002ed24a400508cac96b2ff6812f484c666fe3db3a82e921a805c0
-  data.tar.gz: f96755602e56ea81d734b7505e7cfc88caaa948d7a8d285eeb470801028c15b9
+  metadata.gz: 331d852b12ab9a5e62108f3610d1ec5eed8f4fa9bb683be1aab2703cd2df26cd
+  data.tar.gz: 56e2bcad250542c80b800db800c2216dd2b3b10f1df5d8a77819d13153a77844
 SHA512:
-  metadata.gz: 2f8cd71611e96a80cb733651675cb6fac59d358cb7c9576c8c264abbfec6eb1da11b8cbe2af12cdfb070e5dd01cd74f6fdc70772da16aa4c2abc5248b13fca3c
-  data.tar.gz: '092ba5a188eb29d462431e94420e1c6d7a7f9a4a59c0895f66a4a1cf92cfaa37cbc1bc344a241f5f8cc9fc4e998189164bc2d0ab11480a589fe7bb0e341754ba'
+  metadata.gz: ae6d529a7382aaab721a4ae933658828f975eaa4c9a0ad9444b74b28d8ff1141d59f3e264d08b650367e327987266be03dcd480e0a850fe224feb6cdca4163d1
+  data.tar.gz: bbb76570efd7bf4be700cc3f46d01e26945e9790f5f9f3fee666d4ac3164d1422f5ca1614622a429c430804a9047bcc8f5178886905e5ad814ce21ab4117f94a

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## Upcoming
+
+-
+
+## 6.19.0
+
+- Change Peruvian Sol (PEN) decimal mark and thousands separator.
+- Improves Precision and Simplifies Allocation Logic
+- explicit declaration of i18n locales
+- Add space to CHF format
+- Update deprecation message to suggest correct formatting.
+
+## 6.18.0
+
+- Add second dobra (STN) from São Tomé and Príncipe
+- Correct South African Rand (ZAR) to use comma decimal mark, and space thousands separator
+- Use euro symbol as html_entity for euro currency
+- Update Georgian Lari symbol
+- Add Ruby 3.1 and 3.2 to the CI matrix
+- Add `Money.from_dollars` alias as a more explicit initializer, it's the same as `Money.from_amount`
+- Mark Croatian Kuna (HRK) as obsolete by moving its definition to the backwards compatibility data source
+
+## 6.17.0
+
+- Allow true for `thousands_separator`
+
 ## 6.16.0
 
 - Add `Money.from_cents` alias as a more explicit initializer, it's the same as `Money.new`

data/LICENSE

@@ -2,7 +2,7 @@ MIT License
 
 Copyright (c) 2005 Tobias Lutke
 Copyright (c) 2008 Phusion
-Copyright (c) 2021 Shane Emmons
+Copyright (c) 2024 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

data/README.md

@@ -1,7 +1,7 @@
 # RubyMoney - Money
 
 [![Gem Version](https://badge.fury.io/rb/money.svg)](https://rubygems.org/gems/money)
-[![Build Status](https://travis-ci.org/RubyMoney/money.svg?branch=master)](https://travis-ci.org/RubyMoney/money)
+[![Ruby](https://github.com/RubyMoney/money/actions/workflows/ruby.yml/badge.svg)](https://github.com/RubyMoney/money/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/RubyMoney/money.svg)](https://codeclimate.com/github/RubyMoney/money)
 [![Inline docs](https://inch-ci.org/github/RubyMoney/money.svg)](https://inch-ci.org/github/RubyMoney/money)
 [![License](https://img.shields.io/github/license/RubyMoney/money.svg)](https://opensource.org/licenses/MIT)
@@ -60,6 +60,10 @@ The development version (hosted on Github) can be installed with:
 ``` ruby
 require 'money'
 
+# explicitly define locales
+I18n.config.available_locales = :en
+Money.locale_backend = :i18n
+
 # 10.00 USD
 money = Money.from_cents(1000, "USD")
 money.cents     #=> 1000
@@ -334,6 +338,59 @@ class ExchangeRate < ApplicationRecord
       yield rate.from, rate.to, rate.rate
     end
   end
+
+  def self.marshal_dump
+    [self]
+  end
+end
+```
+
+The following example implements a `Redis` store to save exchange rates to a redis database.
+
+```ruby
+
+class RedisRateStore
+  INDEX_KEY_SEPARATOR = '_TO_'.freeze
+  
+  # Using second db of the redis instance
+  # because sidekiq uses the first db
+  REDIS_DATABASE = 1
+  
+  # Using Hash to store rates data
+  REDIS_STORE_KEY = 'rates'
+
+  def initialize
+    conn_url = "#{Rails.application.credentials.redis_server}/#{REDIS_DATABASE}"
+    @connection = Redis.new(url: conn_url)
+  end
+
+  def add_rate(iso_from, iso_to, rate)
+    @connection.hset(REDIS_STORE_KEY, rate_key_for(iso_from, iso_to), rate)
+  end
+
+  def get_rate(iso_from, iso_to)
+    @connection.hget(REDIS_STORE_KEY, rate_key_for(iso_from, iso_to))
+  end
+
+  def each_rate
+    rates = @connection.hgetall(REDIS_STORE_KEY)
+    return to_enum(:each_rate) unless block_given?
+
+    rates.each do |key, rate|
+      iso_from, iso_to = key.split(INDEX_KEY_SEPARATOR)
+      yield iso_from, iso_to, rate
+    end
+  end
+
+  def transaction
+    yield
+  end
+
+  private
+
+  def rate_key_for(iso_from, iso_to)
+    [iso_from, iso_to].join(INDEX_KEY_SEPARATOR).upcase
+  end
 end
 ```
 

data/config/currency_backwards_compatible.json

@@ -31,6 +31,22 @@
     "iso_numeric": "288",
     "smallest_denomination": 1
   },
+  "hrk": {
+    "priority": 100,
+    "iso_code": "HRK",
+    "name": "Croatian Kuna",
+    "symbol": "kn",
+    "alternate_symbols": [],
+    "subunit": "Lipa",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "format": "%n %u",
+    "html_entity": "",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
+    "iso_numeric": "191",
+    "smallest_denomination": 1
+  },
   "ltl": {
     "priority": 100,
     "iso_code": "LTL",

data/config/currency_iso.json

@@ -452,7 +452,7 @@
     "subunit": "Rappen",
     "subunit_to_unit": 100,
     "symbol_first": true,
-    "format": "%u%n",
+    "format": "%u %n",
     "html_entity": "",
     "decimal_mark": ".",
     "thousands_separator": ",",
@@ -723,7 +723,7 @@
     "subunit": "Cent",
     "subunit_to_unit": 100,
     "symbol_first": true,
-    "html_entity": "€",
+    "html_entity": "€",
     "decimal_mark": ",",
     "thousands_separator": ".",
     "iso_numeric": "978",
@@ -782,7 +782,7 @@
     "priority": 100,
     "iso_code": "GEL",
     "name": "Georgian Lari",
-    "symbol": "ლ",
+    "symbol": "₾",
     "alternate_symbols": ["lari"],
     "subunit": "Tetri",
     "subunit_to_unit": 100,
@@ -922,22 +922,6 @@
     "iso_numeric": "340",
     "smallest_denomination": 5
   },
-  "hrk": {
-    "priority": 100,
-    "iso_code": "HRK",
-    "name": "Croatian Kuna",
-    "symbol": "kn",
-    "alternate_symbols": [],
-    "subunit": "Lipa",
-    "subunit_to_unit": 100,
-    "symbol_first": false,
-    "format": "%n %u",
-    "html_entity": "",
-    "decimal_mark": ",",
-    "thousands_separator": ".",
-    "iso_numeric": "191",
-    "smallest_denomination": 1
-  },
   "htg": {
     "priority": 100,
     "iso_code": "HTG",
@@ -1706,8 +1690,8 @@
     "subunit_to_unit": 100,
     "symbol_first": true,
     "html_entity": "S/",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
     "iso_numeric": "604",
     "smallest_denomination": 1
   },
@@ -1999,11 +1983,28 @@
     "iso_numeric": "703",
     "smallest_denomination": 50
   },
+  "sle": {
+    "priority": 100,
+    "iso_code": "SLE",
+    "name": "New Leone",
+    "symbol": "Le",
+    "alternate_symbols": [],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "format": "%n %u",
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "925",
+    "smallest_denomination": 1000
+  },
   "sll": {
     "priority": 100,
     "iso_code": "SLL",
     "name": "Sierra Leonean Leone",
     "symbol": "Le",
+    "disambiguate_symbol": "SLL",
     "alternate_symbols": [],
     "subunit": "Cent",
     "subunit_to_unit": 100,
@@ -2081,6 +2082,23 @@
     "iso_numeric": "678",
     "smallest_denomination": 10000
   },
+  "stn": {
+    "priority": 100,
+    "iso_code": "STN",
+    "name": "São Tomé and Príncipe Second Dobra",
+    "symbol": "Db",
+    "disambiguate_symbol": "STN",
+    "alternate_symbols": [],
+    "subunit": "Cêntimo",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "format": "%n %u",
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "930",
+    "smallest_denomination": 10
+  },
   "svc": {
     "priority": 100,
     "iso_code": "SVC",
@@ -2661,8 +2679,8 @@
     "subunit_to_unit": 100,
     "symbol_first": true,
     "html_entity": "R",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
+    "decimal_mark": ",",
+    "thousands_separator": " ",
     "iso_numeric": "710",
     "smallest_denomination": 10
   },

data/config/currency_non_iso.json

@@ -126,5 +126,21 @@
     "thousands_separator": ",",
     "iso_numeric": "",
     "smallest_denomination": 1
+  },
+  "usdc": {
+    "priority": 100,
+    "iso_code": "USDC",
+    "name": "USD Coin",
+    "symbol": "USDC",
+    "disambiguate_symbol": "USDC",
+    "alternate_symbols": [],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "html_entity": "$",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "",
+    "smallest_denomination": 1
   }
 }

data/lib/money/money/allocation.rb

@@ -2,16 +2,17 @@
 
 class Money
   class Allocation
-    # 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.
+    # Splits a given amount in parts. The allocation is based on the parts' proportions
+    # or evenly if parts are numerically specified.
     #
     # The results should always add up to the original amount.
     #
-    # The parts can be specified as:
-    #   Numeric — performs the split between a given number of parties evenely
-    #   Array<Numeric> — allocates the amounts proportionally to the given array
+    # @param amount [Numeric] The total amount to be allocated.
+    # @param parts [Numeric, Array<Numeric>] Number of parts to split into or an array (proportions for allocation)
+    # @param whole_amounts [Boolean] Specifies whether to allocate whole amounts only. Defaults to true.
     #
+    # @return [Array<Numeric>] An array containing the allocated amounts.
+    # @raise [ArgumentError] If parts is empty or not provided.
     def self.generate(amount, parts, whole_amounts = true)
       parts = if parts.is_a?(Numeric)
         Array.new(parts, 1)
@@ -21,7 +22,12 @@ class Money
         parts.dup
       end
 
-      raise ArgumentError, 'need at least one party' if parts.empty?
+      raise ArgumentError, 'need at least one part' if parts.empty?
+
+      if [amount, *parts].any? { |i| i.is_a?(BigDecimal) || i.is_a?(Float) || i.is_a?(Rational) }
+        amount = convert_to_big_decimal(amount)
+        parts.map! { |p| convert_to_big_decimal(p) }
+      end
 
       result = []
       remaining_amount = amount
@@ -42,5 +48,21 @@ class Money
 
       result
     end
+
+    # Converts a given number to BigDecimal.
+    # This method supports inputs of BigDecimal, Rational, and other numeric types by ensuring they are all returned
+    # as BigDecimal instances for consistent handling.
+    #
+    # @param number [Numeric, BigDecimal, Rational] The number to convert.
+    # @return [BigDecimal] The converted number as a BigDecimal.
+    def self.convert_to_big_decimal(number)
+      if number.is_a? BigDecimal
+        number
+      elsif number.is_a? Rational
+        BigDecimal(number.to_f.to_s)
+      else
+        BigDecimal(number.to_s)
+      end
+    end
   end
 end

data/lib/money/money/formatter.rb

@@ -124,11 +124,14 @@ class Money
     #  the currency should be delimited by the specified character or ','
     #
     # @example
-    #   # If false is specified, no thousands_separator is used.
+    #   # If a falsey value is specified, no thousands_separator is used.
     #   Money.new(100000, "USD").format(thousands_separator: false) #=> "1000.00"
     #   Money.new(100000, "USD").format(thousands_separator: nil)   #=> "1000.00"
     #   Money.new(100000, "USD").format(thousands_separator: "")    #=> "1000.00"
     #
+    #   # If true is specified, the locale or default thousands_separator is used.
+    #   Money.new(100000, "USD").format(thousands_separator: true) #=> "1,000.00"
+    #
     #   # If a string is specified, it's value is used.
     #   Money.new(100000, "USD").format(thousands_separator: ".") #=> "$1.000.00"
     #
@@ -241,7 +244,11 @@ class Money
     end
 
     def thousands_separator
-      lookup :thousands_separator
+      val = lookup :thousands_separator
+
+      return val unless val == true
+
+      lookup_default :thousands_separator
     end
 
     def decimal_mark
@@ -371,6 +378,10 @@ class Money
     def lookup(key)
       return rules[key] || DEFAULTS[key] if rules.has_key?(key)
 
+      lookup_default key
+    end
+
+    def lookup_default(key)
       (Money.locale_backend && Money.locale_backend.lookup(key, currency)) || DEFAULTS[key]
     end
 

data/lib/money/money/formatting_rules.rb

@@ -117,7 +117,7 @@ class Money
     def warn_about_deprecated_rules(rules)
       if rules.has_key?(:symbol_position)
         position = rules[:symbol_position]
-        template = position == :before ? '%u %n' : '%n %u'
+        template = position == :before ? '%u%n' : '%n%u'
 
         warn "[DEPRECATION] `symbol_position: :#{position}` is deprecated - you can replace it with `format: #{template}`"
       end

data/lib/money/money.rb

@@ -314,6 +314,7 @@ class Money
 
   class << self
     alias_method :from_cents, :new
+    alias_method :from_dollars, :from_amount
   end
 
   # Creates a new Money object of value given in the

data/lib/money/version.rb

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

data/money.gemspec

@@ -23,8 +23,6 @@ Gem::Specification.new do |s|
   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) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
   if s.respond_to?(:metadata)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money
 version: !ruby/object:Gem::Version
-  version: 6.16.0
+  version: 6.19.0
 platform: ruby
 authors:
 - Shane Emmons
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Ruby Library for dealing with money and currency conversion.