shopify-money 0.15.0 → 1.0.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56953634d128da5cb62dfb11b5c60868a162c4ff7edb9bb810110d17c02469f9
-  data.tar.gz: c8e6f0e99b480cfcf9be4183adfc633baf14f0f9ee0d777bea01b225c01cfc09
+  metadata.gz: ae5e66176d7c6e79d5c6346a3ca6915489d3750d7bb67aa68973c52a0198cb3f
+  data.tar.gz: 7219d1edd8665498e64eb06e6212028d8ec559dd5ce9206cbe698e5b1e42d2ed
 SHA512:
-  metadata.gz: 4888a59e2f50348092b73c2b7255b215f994f9b47efbd379ad88d6f4624f4eca403840f584f4d5760a17c02d20f38f0fc49f286c0e19e3557e4976037d1f8049
-  data.tar.gz: ce77e720fae3724a0cc8303336ac12aee09a7a61862f0ba01f0dc7dce3c4e86f2fd7073ee7828d5cc313b77d9b285dfce07bd84e1d8e289e597e1cf25a349c7d
+  metadata.gz: 4188d1251f442d347b287b3b3ac69c08f716b149ef9cc8a78f2c8e75fb563524f3818a9b8116cf2d433117a9e66cbb96b428aed9bf8cd9f9e79eaefa94ca5c45
+  data.tar.gz: 9e70a02a0acdf5eca299ad5f4b201b3fb44a98977d972d08db4167938f24793b732a55f25d6ea3585c8c63d92b014bc108083cce1aef1659b65c628f3ab0b27f

data/README.md

@@ -18,7 +18,11 @@ money_column expects a DECIMAL(21,3) database field.
 
 ## Installation
 
-    gem 'shopify-money', require: 'money'
+    gem 'shopify-money'
+
+## Upgrading to v1.0
+
+see instructions and breaking changes: https://github.com/Shopify/money/blob/master/UPGRADING.md
 
 ## Usage
 
@@ -77,7 +81,9 @@ By default `Money` defaults to Money::NullCurrency as its currency. This is a
 global variable that can be changed using:
 
 ``` ruby
-Money.default_currency = Money::Currency.new("USD")
+Money.configure do |config|
+  config.default_currency = Money::Currency.new("USD")
+end
 ```
 
 In web apps you might want to set the default currency on a per request basis.

data/UPGRADING.md

@@ -0,0 +1,57 @@
+## Upgrading to v1.0
+
+In an initializer add the following
+```ruby
+Money.configure do |config|
+  config.legacy_default_currency!
+  config.legacy_deprecations!
+  config.legacy_json_format!
+  #...
+end
+```
+
+Remove each legacy setting making sure your app functions as expected.
+
+### Legacy support
+
+#### legacy_default_currency!
+
+By enabling this setting your app will accept money object that are missing a currency
+
+```ruby
+Money.new(1) #=> value: 1, currency: XXX
+```
+
+#### legacy_deprecations!
+
+invalid money values return zero
+```ruby
+Money.new('a', 'USD') #=> Money.new(0, 'USD')
+```
+
+invalid currency is ignored
+```ruby
+Money.new(1, 'ABCD') #=> Money.new(1)
+```
+
+mathematical operations between objects are allowed
+```ruby
+Money.new(1, 'USD') + Money.new(1, 'CAD') #=> Money.new(2, 'USD')
+```
+
+parsing a string with invalid delimiters
+```ruby
+Money.parse('123*12') #=> Money.new(123)
+```
+
+#### legacy_json_format!
+
+to_json will return only the value (no currency)
+```ruby
+# with legacy_json_format!
+money.to_json #=> "1"
+
+# without
+money.to_json #=> { value: 1, currency: 'USD' }
+```
+

data/config/currency_historic.yml

@@ -29,7 +29,7 @@ eek:
   smallest_denomination: 5
 ghc:
   priority: 100
-  iso_code: GHS
+  iso_code: GHC
   name: Ghanaian Cedi
   symbol: "₵"
   disambiguate_symbol: GH₵
@@ -73,6 +73,20 @@ mtl:
   thousands_separator: ","
   iso_numeric: '470'
   smallest_denomination: 1
+std:
+  priority: 100
+  iso_code: STD
+  name: São Tomé and Príncipe Dobra
+  symbol: Db
+  alternate_symbols: []
+  subunit: Cêntimo
+  subunit_to_unit: 100
+  symbol_first: false
+  html_entity: ''
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: '678'
+  smallest_denomination: 10000
 tmm:
   priority: 100
   iso_code: TMM

data/config/currency_iso.yml

@@ -2029,9 +2029,9 @@ ssp:
   thousands_separator: ","
   iso_numeric: '728'
   smallest_denomination: 5
-std:
+stn:
   priority: 100
-  iso_code: STD
+  iso_code: STN
   name: São Tomé and Príncipe Dobra
   symbol: Db
   alternate_symbols: []
@@ -2041,8 +2041,8 @@ std:
   html_entity: ''
   decimal_mark: "."
   thousands_separator: ","
-  iso_numeric: '678'
-  smallest_denomination: 10000
+  iso_numeric: '930'
+  smallest_denomination: 1
 svc:
   priority: 100
   iso_code: SVC
@@ -2304,6 +2304,24 @@ uzs:
   thousands_separator: ","
   iso_numeric: '860'
   smallest_denomination: 100
+ved:
+  priority: 100
+  iso_code: VED
+  name: Venezuelan Bolívar soberano
+  symbol: Bs.D.
+  alternate_symbols: []
+  subunit: Céntimo
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: ''
+  decimal_mark: ","
+  thousands_separator: "."
+  iso_numeric: '926'
+  # "On 1 Oct 2021, [...] another (redenomination) happened, but called 'Nueva expresión monetaria', 
+  # or new monetary expression, which removed 6 zeroes from the currency without affecting its denomination."
+  # The VED has banknotes in denominations of 5, 10, 20, 50, and 100, and coins in 50 céntimos and 1 Bs.D.
+  # Source: https://en.wikipedia.org/wiki/Venezuelan_bol%C3%ADvar
+  smallest_denomination: 1
 ves:
   priority: 100
   iso_code: VES

data/lib/money/allocator.rb

@@ -7,6 +7,8 @@ class Money
       super
     end
 
+    ONE = BigDecimal("1")
+
     # Allocates money between different parties without losing pennies.
     # After the mathematically split has been performed, left over pennies will
     # be distributed round-robin amongst the parties. This means that parties
@@ -43,7 +45,7 @@ class Money
       splits.map!(&:to_r)
       allocations = splits.inject(0, :+)
 
-      if (allocations - BigDecimal("1")) > Float::EPSILON
+      if (allocations - ONE) > Float::EPSILON
         raise ArgumentError, "splits add to more than 100%"
       end
 

data/lib/money/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Money
+  class Config
+    attr_accessor :parser, :default_currency, :legacy_json_format, :legacy_deprecations
+
+    def legacy_default_currency!
+      @default_currency ||= Money::NULL_CURRENCY
+    end
+
+    def legacy_deprecations!
+      @legacy_deprecations = true
+    end
+
+    def legacy_json_format!
+      @legacy_json_format = true
+    end
+
+    def initialize
+      @parser = MoneyParser
+      @default_currency = nil
+      @legacy_json_format = false
+      @legacy_deprecations = false
+    end
+  end
+end

data/lib/money/helpers.rb

@@ -28,7 +28,7 @@ class Money
         when Rational
           BigDecimal(num, MAX_DECIMAL)
         when String
-          decimal = BigDecimal(num, exception: false)
+          decimal = BigDecimal(num, exception: !Money.config.legacy_deprecations)
           return decimal if decimal
 
           Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
@@ -46,7 +46,7 @@ class Money
         currency
       when nil, ''
         default = Money.current_currency || Money.default_currency
-        raise(ArgumentError, 'missing currency') if default.nil? || default == ''
+        raise(Money::Currency::UnknownCurrency, 'missing currency') if default.nil? || default == ''
         value_to_currency(default)
       when 'xxx', 'XXX'
         Money::NULL_CURRENCY
@@ -54,8 +54,12 @@ class Money
         begin
           Currency.find!(currency)
         rescue Money::Currency::UnknownCurrency => error
-          Money.deprecate(error.message)
-          Money::NULL_CURRENCY
+          if Money.config.legacy_deprecations
+            Money.deprecate(error.message)
+            Money::NULL_CURRENCY
+          else
+            raise error
+          end
         end
       else
         raise ArgumentError, "could not parse as currency #{currency.inspect}"

data/lib/money/money.rb

@@ -11,7 +11,14 @@ class Money
   def_delegators :@value, :zero?, :nonzero?, :positive?, :negative?, :to_i, :to_f, :hash
 
   class << self
-    attr_accessor :parser, :default_currency
+    extend Forwardable
+    attr_accessor :config
+    def_delegators :@config, :parser, :parser=, :default_currency, :default_currency=
+
+    def configure
+      self.config ||= Config.new
+      yield(config) if block_given?
+    end
 
     def new(value = 0, currency = nil)
       value = Helpers.value_to_decimal(value)
@@ -73,13 +80,8 @@ class Money
         Money.current_currency = old_currency
       end
     end
-
-    def default_settings
-      self.parser = MoneyParser
-      self.default_currency = Money::NULL_CURRENCY
-    end
   end
-  default_settings
+  configure
 
   def initialize(value, currency)
     raise ArgumentError if value.nan?
@@ -126,20 +128,27 @@ class Money
 
   def +(other)
     arithmetic(other) do |money|
+      return self if money.value == 0 && !no_currency?
       Money.new(value + money.value, calculated_currency(money.currency))
     end
   end
 
   def -(other)
     arithmetic(other) do |money|
+      return self if money.value == 0 && !no_currency?
       Money.new(value - money.value, calculated_currency(money.currency))
     end
   end
 
   def *(numeric)
     unless numeric.is_a?(Numeric)
-      Money.deprecate("Multiplying Money with #{numeric.class.name} is deprecated and will be removed in the next major release.")
+      if Money.config.legacy_deprecations
+        Money.deprecate("Multiplying Money with #{numeric.class.name} is deprecated and will be removed in the next major release.")
+      else
+        raise ArgumentError, "Money objects can only be multiplied by a Numeric"
+      end
     end
+    return self if numeric == 1
     Money.new(value.to_r * numeric, currency)
   end
 
@@ -198,8 +207,12 @@ class Money
 
     curr = Helpers.value_to_currency(curr)
     unless currency.compatible?(curr)
-      Money.deprecate("mathematical operation not permitted for Money objects with different currencies #{curr} and #{currency}. " \
-        "A Money::IncompatibleCurrencyError will raise in the next major release")
+      msg = "mathematical operation not permitted for Money objects with different currencies #{curr} and #{currency}"
+      if Money.config.legacy_deprecations
+        Money.deprecate("#{msg}. A Money::IncompatibleCurrencyError will raise in the next major release")
+      else
+        raise Money::IncompatibleCurrencyError, msg
+      end
     end
 
     self
@@ -209,14 +222,14 @@ class Money
     value
   end
 
-  def to_s(style = nil)
+  def to_fs(style = nil)
     units = case style
     when :legacy_dollars
       2
     when :amount, nil
       currency.minor_units
     else
-      raise ArgumentError, "Unexpected style: #{style}"
+      raise ArgumentError, "Unexpected format: #{style}"
     end
 
     rounded_value = value.round(units)
@@ -228,25 +241,41 @@ class Money
       sprintf("%s%d.%0#{units}d", sign, rounded_value.truncate, rounded_value.frac * (10 ** units))
     end
   end
+  alias_method :to_s, :to_fs
+  alias_method :to_formatted_s, :to_fs
 
-  def to_json(options = {})
-    to_s
+  def to_json(options = nil)
+    if (options.is_a?(Hash) && options.delete(:legacy_format)) || Money.config.legacy_json_format
+      to_s
+    else
+      as_json(options).to_json
+    end
   end
 
-  def as_json(*args)
-    to_s
+  def as_json(options = nil)
+    if (options.is_a?(Hash) && options.delete(:legacy_format)) || Money.config.legacy_json_format
+      to_s
+    else
+      { value: to_s(:amount), currency: currency.to_s }
+    end
   end
 
   def abs
-    Money.new(value.abs, currency)
+    abs = value.abs
+    return self if value == abs
+    Money.new(abs, currency)
   end
 
   def floor
-    Money.new(value.floor, currency)
+    floor = value.floor
+    return self if floor == value
+    Money.new(floor, currency)
   end
 
   def round(ndigits=0)
-    Money.new(value.round(ndigits), currency)
+    round = value.round(ndigits)
+    return self if round == value
+    Money.new(round, currency)
   end
 
   def fraction(rate)

data/lib/money/money_parser.rb

@@ -82,9 +82,12 @@ class MoneyParser
     number = number.to_s.strip
 
     if number.empty?
-      raise MoneyFormatError, "invalid money string: #{input}" if strict
-      Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
-      return '0'
+      if Money.config.legacy_deprecations && !strict
+        Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
+        return '0'
+      else
+        raise MoneyFormatError, "invalid money string: #{input}"
+      end
     end
 
     marks = number.scan(/[#{ESCAPED_MARKS}]/).flatten
@@ -107,8 +110,11 @@ class MoneyParser
       return amount.tr(ESCAPED_NON_COMMA_MARKS, '').sub(',', '.')
     end
 
-    raise MoneyFormatError, "invalid money string: #{input}" if strict
-    Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
+    if Money.config.legacy_deprecations && !strict
+      Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
+    else
+      raise MoneyFormatError, "invalid money string: #{input}"
+    end
 
     normalize_number(number, marks, currency)
   end

data/lib/money/rails/job_argument_serializer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Money
+  module Rails
+    class JobArgumentSerializer < ::ActiveJob::Serializers::ObjectSerializer
+      def serialize(money)
+        super("value" => money.value, "currency" => money.currency.iso_code)
+      end
+
+      def deserialize(hash)
+        Money.new(hash["value"], hash["currency"])
+      end
+
+      private
+
+      def klass
+        Money
+      end
+    end
+  end
+end
+

data/lib/money/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Money
+  class Railtie < Rails::Railtie
+    initializer "shopify-money.setup_active_job_serializer" do
+      ActiveSupport.on_load :active_job do
+        require_relative "rails/job_argument_serializer"
+        ActiveJob::Serializers.add_serializers ::Money::Rails::JobArgumentSerializer
+      end
+    end
+  end
+end

data/lib/money/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Money
-  VERSION = "0.15.0"
+  VERSION = "1.0.1.pre"
 end

data/lib/money.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
+require_relative 'money/version'
 require_relative 'money/money_parser'
 require_relative 'money/helpers'
 require_relative 'money/currency'
 require_relative 'money/null_currency'
 require_relative 'money/allocator'
+require_relative 'money/config'
 require_relative 'money/money'
 require_relative 'money/errors'
 require_relative 'money/deprecations'
 require_relative 'money/accounting_money_parser'
 require_relative 'money/core_extensions'
-require_relative 'money_accessor'
 require_relative 'money_column' if defined?(ActiveRecord)
+require_relative 'money/railtie' if defined?(Rails::Railtie)
 
 require_relative 'rubocop/cop/money' if defined?(RuboCop)

data/lib/money_column/active_record_hooks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module MoneyColumn
+  class CurrencyReadOnlyError < StandardError; end
+
   module ActiveRecordHooks
     def self.included(base)
       base.extend(ClassMethods)
@@ -49,16 +51,19 @@ module MoneyColumn
         return self[column] = nil
       end
 
-      currency_raw_source = options[:currency] || (send(options[:currency_column]) rescue nil)
-
-      if !money.is_a?(Money)
-        return self[column] = Money.new(money, currency_raw_source).value
+      unless money.is_a?(Money)
+        return self[column] = Money::Helpers.value_to_decimal(money)
       end
 
       if options[:currency_read_only]
-        currency_source = Money::Helpers.value_to_currency(currency_raw_source)
-        if currency_raw_source && !money.currency.compatible?(currency_source)
-          Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency} in column #{column}.")
+        currency = options[:currency] || try(options[:currency_column])
+        if currency && !money.currency.compatible?(Money::Helpers.value_to_currency(currency))
+          msg = "[money_column] currency mismatch between #{currency} and #{money.currency} in column #{column}."
+          if Money.config.legacy_deprecations
+            Money.deprecate(msg)
+          else
+            raise MoneyColumn::CurrencyReadOnlyError, msg
+          end
         end
       else
         self[options[:currency_column]] = money.currency.to_s unless money.no_currency?

data/spec/accounting_money_parser_spec.rb

@@ -20,8 +20,10 @@ RSpec.describe AccountingMoneyParser do
     end
 
     it "parses an invalid string to $0" do
-      expect(Money).to receive(:deprecate).once
-      expect(@parser.parse("no money")).to eq(Money.new)
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).once
+        expect(@parser.parse("no money", 'USD')).to eq(Money.new(0, 'USD'))
+      end
     end
 
     it "parses a single digit integer string" do

data/spec/config_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe "Money::Config" do
+  describe 'legacy_deprecations' do
+    it "respects the default currency" do
+      configure(default_currency: 'USD', legacy_deprecations: true) do
+        expect(Money.default_currency).to eq("USD")
+      end
+    end
+
+    it 'defaults to not opt-in to v1' do
+      expect(Money::Config.new.legacy_deprecations).to eq(false)
+    end
+
+    it 'legacy_deprecations returns true when opting in to v1' do
+      configure(legacy_deprecations: true) do
+        expect(Money.config.legacy_deprecations).to eq(true)
+      end
+    end
+
+    it 'sets the deprecations to raise' do
+      configure(legacy_deprecations: true) do
+        expect { Money.deprecate("test") }.to raise_error(ActiveSupport::DeprecationException)
+      end
+    end
+
+    it 'legacy_deprecations defaults to NULL_CURRENCY' do
+      configure(legacy_default_currency: true) do
+        expect(Money.config.default_currency).to eq(Money::NULL_CURRENCY)
+      end
+    end
+  end
+
+  describe 'parser' do
+    it 'defaults to MoneyParser' do
+      expect(Money::Config.new.parser).to eq(MoneyParser)
+    end
+
+    it 'can be set to a new parser' do
+      configure(parser: AccountingMoneyParser) do
+        expect(Money.config.parser).to eq(AccountingMoneyParser)
+      end
+    end
+  end
+
+  describe 'default_currency' do
+    it 'defaults to nil' do
+      configure do
+        expect(Money.config.default_currency).to eq(nil)
+      end
+    end
+
+    it 'can be set to a new currency' do
+      configure(default_currency: 'USD') do
+        expect(Money.config.default_currency).to eq('USD')
+      end
+    end
+  end
+end

data/spec/helpers_spec.rb

@@ -46,8 +46,10 @@ RSpec.describe Money::Helpers do
     end
 
     it 'invalid string returns zero' do
-      expect(Money).to receive(:deprecate).once
-      expect(subject.value_to_decimal('invalid')).to eq(0)
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).once
+        expect(subject.value_to_decimal('invalid')).to eq(0)
+      end
     end
 
     it 'raises on invalid object' do
@@ -70,7 +72,9 @@ RSpec.describe Money::Helpers do
     end
 
     it 'returns the default currency when value is empty' do
-      expect(subject.value_to_currency('')).to eq(Money.default_currency)
+      configure(legacy_deprecations: true, default_currency: 'USD') do
+        expect(subject.value_to_currency('')).to eq(Money::Currency.new('USD'))
+      end
     end
 
     it 'returns the default currency when value is xxx' do
@@ -86,8 +90,10 @@ RSpec.describe Money::Helpers do
     end
 
     it 'returns the null currency when invalid iso is passed' do
-      expect(Money).to receive(:deprecate).once
-      expect(subject.value_to_currency('invalid')).to eq(Money::NULL_CURRENCY)
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).once
+        expect(subject.value_to_currency('invalid')).to eq(Money::NULL_CURRENCY)
+      end
     end
 
     it 'raises on invalid object' do