shopify-money 3.0.0 → 3.0.1

data/config/currency_iso.yml

@@ -105,7 +105,7 @@ ars:
   subunit: Centavo
   subunit_to_unit: 100
   symbol_first: true
-  html_entity: "₱"
+  html_entity: "$"
   decimal_mark: ","
   thousands_separator: "."
   iso_numeric: '032'
@@ -225,7 +225,7 @@ bhd:
   priority: 100
   iso_code: BHD
   name: Bahraini Dinar
-  symbol: ب.د
+  symbol: د.ب
   alternate_symbols:
   - BD
   subunit: Fils
@@ -458,7 +458,7 @@ chf:
   symbol_first: true
   html_entity: ''
   decimal_mark: "."
-  thousands_separator: ","
+  thousands_separator: "'"
   iso_numeric: '756'
   smallest_denomination: 5
 clf:
@@ -715,7 +715,7 @@ eur:
   subunit: Cent
   subunit_to_unit: 100
   symbol_first: true
-  html_entity: "€"
+  html_entity: "€"
   decimal_mark: ","
   thousands_separator: "."
   iso_numeric: '978'
@@ -771,7 +771,7 @@ gel:
   priority: 100
   iso_code: GEL
   name: Georgian Lari
-  symbol: ლ
+  symbol: "₾"
   alternate_symbols:
   - lari
   subunit: Tetri
@@ -905,20 +905,6 @@ hnl:
   thousands_separator: ","
   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
-  html_entity: ''
-  decimal_mark: ","
-  thousands_separator: "."
-  iso_numeric: '191'
-  smallest_denomination: 1
 htg:
   priority: 100
   iso_code: HTG
@@ -964,7 +950,7 @@ idr:
 ils:
   priority: 100
   iso_code: ILS
-  name: Israeli New Sheqel
+  name: Israeli New Shekel
   symbol: "₪"
   alternate_symbols:
   - ש״ח
@@ -1034,7 +1020,7 @@ isk:
   - Íkr
   subunit:
   subunit_to_unit: 1
-  symbol_first: true
+  symbol_first: false
   html_entity: ''
   decimal_mark: ","
   thousands_separator: "."
@@ -1210,7 +1196,7 @@ kzt:
   priority: 100
   iso_code: KZT
   name: Kazakhstani Tenge
-  symbol: "〒"
+  symbol: "₸"
   alternate_symbols: []
   subunit: Tiyn
   subunit_to_unit: 100
@@ -1302,34 +1288,6 @@ lsl:
   thousands_separator: ","
   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
@@ -1620,11 +1578,12 @@ npr:
   priority: 100
   iso_code: NPR
   name: Nepalese Rupee
-  symbol: "₨"
+  symbol: Rs.
   disambiguate_symbol: NPR
   alternate_symbols:
   - Rs
   - रू
+  - "₨"
   subunit: Paisa
   subunit_to_unit: 100
   symbol_first: true
@@ -1681,14 +1640,14 @@ pen:
   priority: 100
   iso_code: PEN
   name: Peruvian Sol
-  symbol: S/.
+  symbol: S/
   alternate_symbols: []
   subunit: Céntimo
   subunit_to_unit: 100
   symbol_first: true
-  html_entity: S/.
   decimal_mark: "."
   thousands_separator: ","
+  html_entity: S/
   iso_numeric: '604'
   smallest_denomination: 1
 pgk:
@@ -1970,6 +1929,20 @@ skk:
   thousands_separator: ","
   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
+  html_entity: ''
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: '925'
+  smallest_denomination: 1000
 sll:
   priority: 100
   iso_code: SLL
@@ -2274,13 +2247,13 @@ uyu:
   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'
@@ -2289,7 +2262,7 @@ uzs:
   priority: 100
   iso_code: UZS
   name: Uzbekistan Som
-  symbol: ''
+  symbol: so'm
   alternate_symbols:
   - so‘m
   - сўм
@@ -2325,9 +2298,10 @@ ved:
 ves:
   priority: 100
   iso_code: VES
-  name: Venezuelan Bolívar soberano
-  symbol: Bs.S.
-  alternate_symbols: []
+  name: Venezuelan Bolívar Soberano
+  symbol: Bs
+  alternate_symbols:
+  - Bs.S
   subunit: Céntimo
   subunit_to_unit: 100
   symbol_first: true
@@ -2389,7 +2363,7 @@ xaf:
   priority: 100
   iso_code: XAF
   name: Central African Cfa Franc
-  symbol: Fr
+  symbol: CFA
   disambiguate_symbol: FCFA
   alternate_symbols:
   - FCFA
@@ -2576,7 +2550,7 @@ xpt:
   smallest_denomination: ''
 xts:
   priority: 100
-  iso_code: xts
+  iso_code: XTS
   name: Codes specifically reserved for testing purposes
   symbol: ''
   alternate_symbols: []
@@ -2612,8 +2586,8 @@ zar:
   subunit_to_unit: 100
   symbol_first: true
   html_entity: "R"
-  decimal_mark: "."
-  thousands_separator: ","
+  decimal_mark: ","
+  thousands_separator: " "
   iso_numeric: '710'
   smallest_denomination: 10
 zmk:
@@ -2635,7 +2609,7 @@ zmw:
   priority: 100
   iso_code: ZMW
   name: Zambian Kwacha
-  symbol: ZK
+  symbol: K
   disambiguate_symbol: ZMW
   alternate_symbols: []
   subunit: Ngwee

data/lib/money/allocator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'delegate'
 
 class Money
@@ -107,7 +108,7 @@ class Money
     #   Money.new(100).allocate_max_amounts([Money.new(5), Money.new(2)])
     #     #=> [Money.new(5), Money.new(2)]
     def allocate_max_amounts(maximums)
-      allocation_currency = extract_currency(maximums + [self.__getobj__])
+      allocation_currency = extract_currency(maximums + [__getobj__])
       maximums = maximums.map { |max| max.to_money(allocation_currency) }
       maximums_total = maximums.reduce(Money.new(0, allocation_currency), :+)
 
@@ -116,16 +117,16 @@ class Money
         Money.rational(max_amount, maximums_total)
       end
 
-      total_allocatable = [maximums_total.subunits, self.subunits].min
+      total_allocatable = [maximums_total.subunits, subunits].min
 
       subunits_amounts, left_over = amounts_from_splits(1, splits, total_allocatable)
       subunits_amounts.map! { |amount| amount[:whole_subunits] }
 
       subunits_amounts.each_with_index do |amount, index|
-        break unless left_over > 0
+        break if left_over <= 0
 
         max_amount = maximums[index].value * allocation_currency.subunit_to_unit
-        next unless amount < max_amount
+        next if amount >= max_amount
 
         left_over -= 1
         subunits_amounts[index] += 1
@@ -137,9 +138,12 @@ class Money
     private
 
     def extract_currency(money_array)
-      currencies = money_array.lazy.select { |money| money.is_a?(Money) }.reject(&:no_currency?).map(&:currency).to_a.uniq
+      currencies = money_array.lazy.select do |money|
+        money.is_a?(Money)
+      end.reject(&:no_currency?).map(&:currency).to_a.uniq
       if currencies.size > 1
-        raise ArgumentError, "operation not permitted for Money objects with different currencies #{currencies.join(', ')}"
+        raise ArgumentError,
+          "operation not permitted for Money objects with different currencies #{currencies.join(", ")}"
       end
       currencies.first || NULL_CURRENCY
     end
@@ -154,8 +158,8 @@ class Money
         fractional_subunits = (subunits_to_split * ratio / allocations.to_r).to_f - whole_subunits
         left_over -= whole_subunits
         {
-          :whole_subunits => whole_subunits,
-          :fractional_subunits => fractional_subunits
+          whole_subunits: whole_subunits,
+          fractional_subunits: fractional_subunits,
         }
       end
 
@@ -172,7 +176,7 @@ class Money
     # the next whole number. Similarly, given the input [9.1, 5.5, 3.9] the correct ranking is *still* 2, 1, 0. This
     # is because 3.9 is nearer to 4 than 9.1 is to 10.
     def rank_by_nearest(amounts)
-      amounts.each_with_index.sort_by{ |amount, i| 1 - amount[:fractional_subunits] }.map(&:last)
+      amounts.each_with_index.sort_by { |amount, _i| 1 - amount[:fractional_subunits] }.map(&:last)
     end
   end
 end

data/lib/money/config.rb

@@ -21,5 +21,13 @@ class Money
       @legacy_json_format = false
       @legacy_deprecations = false
     end
+
+    def without_legacy_deprecations(&block)
+      old_legacy_deprecations = @legacy_deprecations
+      @legacy_deprecations = false
+      yield
+    ensure
+      @legacy_deprecations = old_legacy_deprecations
+    end
   end
 end

data/lib/money/core_extensions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Allows Writing of 100.to_money for +Numeric+ types
 #   100.to_money => #<Money @cents=10000>
 #   100.37.to_money => #<Money @cents=10037>
@@ -25,7 +26,7 @@ class String
       return Money.new(self, currency)
     end
 
-    return Money.new(0, currency) if self.empty?
+    return Money.new(0, currency) if empty?
 
     Money::Parser::Fuzzy.parse(self, currency).tap do |money|
       old_value = money.value

data/lib/money/currency/loader.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'yaml'
 
 class Money
@@ -9,9 +10,9 @@ class Money
           currency_data_path = File.expand_path("../../../../config", __FILE__)
 
           currencies = {}
-          currencies.merge! YAML.load_file("#{currency_data_path}/currency_historic.yml")
-          currencies.merge! YAML.load_file("#{currency_data_path}/currency_non_iso.yml")
-          currencies.merge! YAML.load_file("#{currency_data_path}/currency_iso.yml")
+          currencies.merge!(YAML.load_file("#{currency_data_path}/currency_historic.yml"))
+          currencies.merge!(YAML.load_file("#{currency_data_path}/currency_non_iso.yml"))
+          currencies.merge!(YAML.load_file("#{currency_data_path}/currency_iso.yml"))
           deep_deduplicate!(currencies)
         end
 

data/lib/money/currency.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "money/currency/loader"
 
 class Money
@@ -27,8 +28,16 @@ class Money
       end
     end
 
-    attr_reader :iso_code, :iso_numeric, :name, :smallest_denomination, :subunit_symbol,
-                :subunit_to_unit, :minor_units, :symbol, :disambiguate_symbol, :decimal_mark
+    attr_reader :iso_code,
+      :iso_numeric,
+      :name,
+      :smallest_denomination,
+      :subunit_symbol,
+      :subunit_to_unit,
+      :minor_units,
+      :symbol,
+      :disambiguate_symbol,
+      :decimal_mark
 
     def initialize(currency_iso)
       data = self.class.currencies[currency_iso]
@@ -51,7 +60,7 @@ class Money
     end
 
     def hash
-      [ self.class, iso_code ].hash
+      [self.class, iso_code].hash
     end
 
     def compatible?(other)

data/lib/money/deprecations.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 Money.class_eval do
   ACTIVE_SUPPORT_DEFINED = defined?(ActiveSupport)
+  DEPRECATION_STACKTRACE_LENGTH = 5
 
   def self.active_support_deprecator
     @active_support_deprecator ||= begin
@@ -11,12 +13,28 @@ Money.class_eval do
 
   def self.deprecate(message)
     if ACTIVE_SUPPORT_DEFINED
-      external_callstack = caller_locations.reject do |location|
-        location.to_s.include?('gems/shopify-money')
-      end
-      active_support_deprecator.warn("[Shopify/Money] #{message}\n", external_callstack)
+      active_support_deprecator.warn("[Shopify/Money] #{message}\n", caller_stack)
     else
       Kernel.warn("DEPRECATION WARNING: [Shopify/Money] #{message}\n")
     end
   end
+
+  # :nocov:
+  if Thread.respond_to?(:each_caller_location)
+    def self.caller_stack
+      stack = []
+      Thread.each_caller_location do |location|
+        stack << location unless location.path.include?('gems/shopify-money')
+        break if stack.length == DEPRECATION_STACKTRACE_LENGTH
+      end
+      stack
+    end
+  else
+    def self.caller_stack
+      caller_locations(2, DEPRECATION_STACKTRACE_LENGTH * 2).reject do |location|
+        location.path.include?('gems/shopify-money')
+      end
+    end
+  end
+  # :nocov:
 end

data/lib/money/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Money
   class Error < StandardError
   end

data/lib/money/helpers.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 require 'bigdecimal'
 
 class Money
   module Helpers
-    module_function
+    extend self
 
     DECIMAL_ZERO = BigDecimal(0).freeze
     MAX_DECIMAL = 21

data/lib/money/money.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+
 require 'forwardable'
+require 'json'
 
 class Money
   include Comparable
@@ -8,6 +10,7 @@ class Money
   NULL_CURRENCY = NullCurrency.new.freeze
 
   attr_reader :value, :currency
+
   def_delegators :@value, :zero?, :nonzero?, :positive?, :negative?, :to_i, :to_f, :hash
 
   class ReverseOperationProxy
@@ -36,11 +39,17 @@ class Money
 
   class << self
     extend Forwardable
-    attr_accessor :config
-    def_delegators :@config, :default_currency, :default_currency=
+    def_delegators :config, :default_currency, :default_currency=, :without_legacy_deprecations
+
+    def config
+      Thread.current[:shopify_money__config] ||= Config.new
+    end
+
+    def config=(config)
+      Thread.current[:shopify_money__config] = config
+    end
 
     def configure
-      self.config ||= Config.new
       yield(config) if block_given?
     end
 
@@ -74,6 +83,16 @@ class Money
       new(value, currency)
     end
 
+    def from_json(string)
+      hash = JSON.parse(string, symbolize_names: true)
+      Money.new(hash.fetch(:value), hash.fetch(:currency))
+    end
+
+    def from_hash(hash)
+      hash = hash.transform_keys(&:to_sym)
+      Money.new(hash.fetch(:value), hash.fetch(:currency))
+    end
+
     def rational(money1, money2)
       money1.send(:arithmetic, money2) do
         factor = money1.currency.subunit_to_unit * money2.currency.subunit_to_unit
@@ -94,13 +113,11 @@ class Money
     # I18n.with_locale and ActiveSupport's Time.use_zone. This won't affect
     # instances being created with explicitly set currency.
     def with_currency(new_currency)
-      begin
-        old_currency = Money.current_currency
-        Money.current_currency = new_currency
-        yield
-      ensure
-        Money.current_currency = old_currency
-      end
+      old_currency = Money.current_currency
+      Money.current_currency = new_currency
+      yield
+    ensure
+      Money.current_currency = old_currency
     end
 
     private
@@ -116,10 +133,12 @@ class Money
         return amount
       end
 
-      msg = "Money.new(Money.new(amount, #{amount.currency}), #{currency}) is changing the currency of an existing money object"
+      msg = "Money.new(Money.new(amount, #{amount.currency}), #{currency}) " \
+        "is changing the currency of an existing money object"
+
       if Money.config.legacy_deprecations
         Money.deprecate("#{msg}. A Money::IncompatibleCurrencyError will raise in the next major release")
-        return Money.new(amount.value, currency)
+        Money.new(amount.value, currency)
       else
         raise Money::IncompatibleCurrencyError, msg
       end
@@ -184,19 +203,19 @@ class Money
     end
   end
 
-  def *(numeric)
-    raise ArgumentError, "Money objects can only be multiplied by a Numeric" unless numeric.is_a?(Numeric)
+  def *(other)
+    raise ArgumentError, "Money objects can only be multiplied by a Numeric" unless other.is_a?(Numeric)
 
-    return self if numeric == 1
-    Money.new(value.to_r * numeric, currency)
+    return self if other == 1
+    Money.new(value.to_r * other, currency)
   end
 
-  def /(numeric)
+  def /(other)
     raise "[Money] Dividing money objects can lose pennies. Use #split instead"
   end
 
   def inspect
-    "#<#{self.class} value:#{self} currency:#{self.currency}>"
+    "#<#{self.class} value:#{self} currency:#{currency}>"
   end
 
   def ==(other)
@@ -228,8 +247,10 @@ class Money
       return Money.new(value, new_currency)
     end
 
-    ensure_compatible_currency(Helpers.value_to_currency(new_currency),
-      "to_money is attempting to change currency of an existing money object from #{currency} to #{new_currency}")
+    ensure_compatible_currency(
+      Helpers.value_to_currency(new_currency),
+      "to_money is attempting to change currency of an existing money object from #{currency} to #{new_currency}",
+    )
 
     self
   end
@@ -250,7 +271,7 @@ class Money
 
     rounded_value = value.round(units)
     if units == 0
-      sprintf("%d", rounded_value)
+      format("%d", rounded_value)
     else
       formatted = rounded_value.to_s("F")
       decimal_digits = formatted.size - formatted.index(".") - 1
@@ -264,7 +285,7 @@ class Money
   alias_method :to_formatted_s, :to_fs
 
   def to_json(options = nil)
-    if (options.is_a?(Hash) && options.delete(:legacy_format)) || Money.config.legacy_json_format
+    if (options.is_a?(Hash) && options[:legacy_format]) || Money.config.legacy_json_format
       to_s
     else
       as_json(options).to_json
@@ -272,12 +293,13 @@ class Money
   end
 
   def as_json(options = nil)
-    if (options.is_a?(Hash) && options.delete(:legacy_format)) || Money.config.legacy_json_format
+    if (options.is_a?(Hash) && options[:legacy_format]) || Money.config.legacy_json_format
       to_s
     else
       { value: to_s(:amount), currency: currency.to_s }
     end
   end
+  alias_method :to_h, :as_json
 
   def abs
     abs = value.abs
@@ -291,7 +313,7 @@ class Money
     Money.new(floor, currency)
   end
 
-  def round(ndigits=0)
+  def round(ndigits = 0)
     round = value.round(ndigits)
     return self if round == value
     Money.new(round, currency)
@@ -352,13 +374,13 @@ class Money
   def clamp(min, max)
     raise ArgumentError, 'min cannot be greater than max' if min > max
 
-    clamped_value = min if self.value < min
-    clamped_value = max if self.value > max
+    clamped_value = min if value < min
+    clamped_value = max if value > max
 
     if clamped_value.nil?
       self
     else
-      Money.new(clamped_value, self.currency)
+      Money.new(clamped_value, currency)
     end
   end
 
@@ -367,8 +389,10 @@ class Money
   def arithmetic(other)
     case other
     when Money
-      ensure_compatible_currency(other.currency,
-        "mathematical operation not permitted for Money objects with different currencies #{other.currency} and #{currency}.")
+      desc = "mathematical operation not permitted for Money objects with different currencies " \
+        "#{other.currency} and #{currency}."
+
+      ensure_compatible_currency(other.currency, desc)
       yield(other)
 
     when Numeric, String

data/lib/money/null_currency.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Money
   # A placeholder currency for instances where no actual currency is available,
   # as defined by ISO4217. You should rarely, if ever, need to use this
@@ -32,9 +33,16 @@ class Money
   #   #=> #<Money value:5.00 currency:CAD>
   #
   class NullCurrency
-
-    attr_reader :iso_code, :iso_numeric, :name, :smallest_denomination, :subunit_symbol,
-                :subunit_to_unit, :minor_units, :symbol, :disambiguate_symbol, :decimal_mark
+    attr_reader :iso_code,
+      :iso_numeric,
+      :name,
+      :smallest_denomination,
+      :subunit_symbol,
+      :subunit_to_unit,
+      :minor_units,
+      :symbol,
+      :disambiguate_symbol,
+      :decimal_mark
 
     def initialize
       @symbol                = '$'

data/lib/money/parser/accounting.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Money
   module Parser
     class Accounting < Fuzzy