shopify-money 0.16.0 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9919cf2d14833f204c05a9642efb7a48bb23822c70c48cf523ccbc68c3e7491
-  data.tar.gz: d73bd65e6cb49ee8f5be7add57683274bb006fbfd0ec61aec566385fd92d50f6
+  metadata.gz: ddeb1f02ca7fda02ed007433687bf2fdbce36e9b11d64724753cf2e2420507c0
+  data.tar.gz: de0de61cbe5c6ae02b2fbf333e4136edbfcd1c2388441c219ffb1a00e2d0a963
 SHA512:
-  metadata.gz: b3dc0c02cee6598d2369ce472a5df01dfb3528cfb45f517394ab7c29b059338b8d65d10c03ae397a4ecdff98a7987a61e0312b894947b728e1ed32078b726086
-  data.tar.gz: 1e7cec90da29c1327fdf64984f34e7b6fa01282eb7a0c2e3eda6482d688b06d148b7b7bff760555e3a7d7302ec8b20079ad468cd7c02dabb83c7e9a0aeb0a1f2
+  metadata.gz: 86ef224eb66a9d8d6249b921cdd9162594babac0e5fa7525f2e9e5125ad94ab02e395bef9af508d4f6d08622d2c3fa6628b902aac3de803ef81fd30fcae0464c
+  data.tar.gz: 7332ed67b6d7389123131538c7c05faae5b9e67a4b77ae66c21f0d2bbd7031f4994576fdaa14c54294ad2969c70ffe1e70958528f16116e944fa6457d5c80d6e

data/README.md

@@ -20,6 +20,10 @@ money_column expects a DECIMAL(21,3) database field.
 
     gem 'shopify-money', require: 'money'
 
+## Upgrading to v1.0
+
+see instructions and breaking changes: https://github.com/Shopify/money/blob/master/UPGRADING.md
+
 ## Usage
 
 ``` ruby
@@ -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/lib/money.rb

@@ -4,6 +4,7 @@ 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'

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?
@@ -138,7 +140,11 @@ class Money
 
   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
     Money.new(value.to_r * numeric, currency)
   end
@@ -198,8 +204,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
@@ -230,11 +240,19 @@ class Money
   end
 
   def to_json(options = {})
-    to_s
+    if 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 = {})
+    if options.delete(:legacy_format) || Money.config.legacy_json_format
+      to_s
+    else
+      { value: to_s(:amount), currency: currency.to_s }
+    end
   end
 
   def abs

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/version.rb

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

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

data/spec/money_column_spec.rb

@@ -30,13 +30,18 @@ end
 
 class MoneyWithDelegatedCurrency < ActiveRecord::Base
   self.table_name = 'money_records'
-  attr_accessor :delegated_record
   delegate :currency, to: :delegated_record
   money_column :price, currency_column: 'currency', currency_read_only: true
   money_column :prix, currency_column: 'currency2', currency_read_only: true
   def currency2
     delegated_record.currency
   end
+
+  private
+
+  def delegated_record
+    MoneyRecord.new(currency: 'USD')
+  end
 end
 
 class MoneyWithCustomAccessors < ActiveRecord::Base
@@ -97,11 +102,13 @@ RSpec.describe 'MoneyColumn' do
   end
 
   it 'returns money with null currency when the currency in the DB is invalid' do
-    expect(Money).to receive(:deprecate).once
-    record.update_columns(currency: 'invalid')
-    record.reload
-    expect(record.price.currency).to be_a(Money::NullCurrency)
-    expect(record.price.value).to eq(1.23)
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      record.update_columns(currency: 'invalid')
+      record.reload
+      expect(record.price.currency).to be_a(Money::NullCurrency)
+      expect(record.price.value).to eq(1.23)
+    end
   end
 
   it 'handles legacy support for saving floats' do
@@ -114,12 +121,12 @@ RSpec.describe 'MoneyColumn' do
     expect(record.prix.currency.to_s).to eq('CAD')
   end
 
-  it 'handles legacy support for saving floats with correct currency rounding' do
+  it 'handles legacy support for saving floats as provided' do
     record.update(price: 3.2112, prix: 3.2156)
-    expect(record.attributes['price']).to eq(3.21)
+    expect(record.attributes['price']).to eq(3.2112)
     expect(record.price.value).to eq(3.21)
     expect(record.price.currency.to_s).to eq(currency)
-    expect(record.attributes['prix']).to eq(3.22)
+    expect(record.attributes['prix']).to eq(3.2156)
     expect(record.prix.value).to eq(3.22)
     expect(record.prix.currency.to_s).to eq('CAD')
   end
@@ -165,8 +172,8 @@ RSpec.describe 'MoneyColumn' do
   describe 'garbage amount' do
     let(:amount) { 'foo' }
 
-    it 'raises a deprecation warning' do
-      expect { subject }.to raise_error(ActiveSupport::DeprecationException)
+    it 'raises an ArgumentError' do
+      expect { subject }.to raise_error(ArgumentError)
     end
   end
 
@@ -174,7 +181,7 @@ RSpec.describe 'MoneyColumn' do
     let(:currency) { 'foo' }
 
     it 'raises an UnknownCurrency error' do
-      expect { subject }.to raise_error(ActiveSupport::DeprecationException)
+      expect { subject }.to raise_error(Money::Currency::UnknownCurrency)
     end
   end
 
@@ -217,11 +224,20 @@ RSpec.describe 'MoneyColumn' do
   describe 'read_only_currency true' do
     it 'does not write the currency to the db' do
       record = MoneyWithReadOnlyCurrency.create
-      record.update_columns(price: 1, currency: 'USD')
-      expect(Money).to receive(:deprecate).once
-      record.update(price: Money.new(4, 'CAD'))
-      expect(record.price.value).to eq(4)
-      expect(record.price.currency.to_s).to eq('USD')
+      record.update_columns(currency: 'USD')
+      expect { record.update(price: Money.new(4, 'CAD')) }.to raise_error(MoneyColumn::CurrencyReadOnlyError)
+    end
+
+    it 'legacy_deprecations does not write the currency to the db' do
+      configure(legacy_deprecations: true) do
+        record = MoneyWithReadOnlyCurrency.create
+        record.update_columns(currency: 'USD')
+
+        expect(Money).to receive(:deprecate).once
+        record.update(price: Money.new(4, 'CAD'))
+        expect(record.price.value).to eq(4)
+        expect(record.price.currency.to_s).to eq('USD')
+      end
     end
 
     it 'reads the currency that is already in the db' do
@@ -233,12 +249,14 @@ RSpec.describe 'MoneyColumn' do
     end
 
     it 'reads an invalid currency from the db and generates a no currency object' do
-      expect(Money).to receive(:deprecate).once
-      record = MoneyWithReadOnlyCurrency.create
-      record.update_columns(currency: 'invalid', price: 1)
-      record.reload
-      expect(record.price.value).to eq(1)
-      expect(record.price.currency.to_s).to eq('')
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).once
+        record = MoneyWithReadOnlyCurrency.create
+        record.update_columns(currency: 'invalid', price: 1)
+        record.reload
+        expect(record.price.value).to eq(1)
+        expect(record.price.currency.to_s).to eq('')
+      end
     end
 
     it 'sets the currency correctly when the currency is changed' do
@@ -248,12 +266,12 @@ RSpec.describe 'MoneyColumn' do
     end
 
     it 'handle cases where the delegate allow_nil is false' do
-      record = MoneyWithDelegatedCurrency.new(price: Money.new(10, 'USD'), delegated_record: MoneyRecord.new(currency: 'USD'))
+      record = MoneyWithDelegatedCurrency.new(price: Money.new(10, 'USD'))
       expect(record.price.currency.to_s).to eq('USD')
     end
 
     it 'handle cases where a manual delegate does not allow nil' do
-      record = MoneyWithDelegatedCurrency.new(prix: Money.new(10, 'USD'), delegated_record: MoneyRecord.new(currency: 'USD'))
+      record = MoneyWithDelegatedCurrency.new(prix: Money.new(10, 'USD'))
       expect(record.price.currency.to_s).to eq('USD')
     end
   end
@@ -370,10 +388,7 @@ RSpec.describe 'MoneyColumn' do
 
   describe 'default_currency = nil' do
     around do |example|
-      default_currency = Money.default_currency
-      Money.default_currency = nil
-      example.run
-      Money.default_currency = default_currency
+      configure(default_currency: nil) { example.run }
     end
 
     it 'writes currency from input value to the db' do
@@ -384,11 +399,17 @@ RSpec.describe 'MoneyColumn' do
       expect(record.price.currency.to_s).to eq('GBP')
     end
 
-    it 'raises missing currency error when input is not a money object' do
-      record.update(currency: nil)
+    it 'raises missing currency error reading a value that was saved using legacy non-money object' do
+      record.update(currency: nil, price: 3)
+      expect { record.price }.to raise_error(ArgumentError, 'missing currency')
+    end
 
-      expect { record.update(price: 3) }
-        .to raise_error(ArgumentError, 'missing currency')
+    it 'handles legacy support for saving price and currency separately' do
+      record.update(currency: nil)
+      record.update(price: 7, currency: 'GBP')
+      record.reload
+      expect(record.price.value).to eq(7)
+      expect(record.price.currency.to_s).to eq('GBP')
     end
   end
 end

data/spec/money_parser_spec.rb

@@ -12,9 +12,11 @@ RSpec.describe MoneyParser do
     end
 
     it "parses an invalid string when not strict" do
-      expect(Money).to receive(:deprecate).twice
-      expect(@parser.parse("no money")).to eq(Money.new(0, Money::NULL_CURRENCY))
-      expect(@parser.parse("1..")).to eq(Money.new(1))
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).twice
+        expect(@parser.parse("no money", 'USD')).to eq(Money.new(0, 'USD'))
+        expect(@parser.parse("1..", 'USD')).to eq(Money.new(1, 'USD'))
+      end
     end
 
     it "parses raise with an invalid string and strict option" do
@@ -22,6 +24,12 @@ RSpec.describe MoneyParser do
       expect { @parser.parse("1..1", strict: true) }.to raise_error(MoneyParser::MoneyFormatError)
     end
 
+    it "parses raise with an invalid when a currency is missing" do
+      configure do
+        expect { @parser.parse("1") }.to raise_error(Money::Currency::UnknownCurrency)
+      end
+    end
+
     it "parses a single digit integer string" do
       expect(@parser.parse("1")).to eq(Money.new(1.00))
     end
@@ -144,8 +152,10 @@ RSpec.describe MoneyParser do
     end
 
     it "parses amount with multiple inconsistent thousands delimiters" do
-      expect(Money).to receive(:deprecate).once
-      expect(@parser.parse("1.1.11.111")).to eq(Money.new(1_111_111))
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).once
+        expect(@parser.parse("1.1.11.111", 'USD')).to eq(Money.new(1_111_111, 'USD'))
+      end
     end
 
     it "parses raises with multiple inconsistent thousands delimiters and strict option" do
@@ -216,8 +226,10 @@ RSpec.describe MoneyParser do
     end
 
     it "parses amount with multiple inconsistent thousands delimiters" do
-      expect(Money).to receive(:deprecate).once
-      expect(@parser.parse("1,1,11,111")).to eq(Money.new(1_111_111))
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).once
+        expect(@parser.parse("1,1,11,111", 'USD')).to eq(Money.new(1_111_111, 'USD'))
+      end
     end
 
     it "parses raises with multiple inconsistent thousands delimiters and strict option" do

data/spec/money_spec.rb

@@ -3,23 +3,16 @@ require 'spec_helper'
 require 'yaml'
 
 RSpec.describe "Money" do
-
   let (:money) { Money.new(1) }
   let (:amount_money) { Money.new(1.23, 'USD') }
   let (:non_fractional_money) { Money.new(1, 'JPY') }
   let (:zero_money) { Money.new(0) }
 
   context "default currency not set" do
-    before(:each) do
-      @default_currency = Money.default_currency
-      Money.default_currency = nil
-    end
-    after(:each) do
-      Money.default_currency = @default_currency
-    end
-
     it "raises an error" do
-      expect { money }.to raise_error(ArgumentError)
+      configure(default_currency: nil) do
+        expect { money }.to raise_error(ArgumentError)
+      end
     end
   end
 
@@ -39,9 +32,15 @@ RSpec.describe "Money" do
     expect(Money.new(1).to_money('CAD')).to eq(Money.new(1, 'CAD'))
   end
 
-  it "#to_money doesn't overwrite the money object's currency" do
-    expect(Money).to receive(:deprecate).once
-    expect(Money.new(1, 'USD').to_money('CAD')).to eq(Money.new(1, 'USD'))
+  it "legacy_deprecations #to_money doesn't overwrite the money object's currency" do
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      expect(Money.new(1, 'USD').to_money('CAD')).to eq(Money.new(1, 'USD'))
+    end
+  end
+
+  it "#to_money raises when changing currency" do
+    expect{ Money.new(1, 'USD').to_money('CAD') }.to raise_error(Money::IncompatibleCurrencyError)
   end
 
   it "defaults to 0 when constructed with no arguments" do
@@ -52,9 +51,15 @@ RSpec.describe "Money" do
     expect(Money.new('')).to eq(Money.new(0))
   end
 
-  it "defaults to 0 when constructed with an invalid string" do
-    expect(Money).to receive(:deprecate).once
-    expect(Money.new('invalid')).to eq(Money.new(0.00))
+  it "legacy_deprecations defaults to 0 when constructed with an invalid string" do
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      expect(Money.new('invalid', 'USD')).to eq(Money.new(0.00, 'USD'))
+    end
+  end
+
+  it "raises when constructed with an invalid string" do
+    expect{ Money.new('invalid') }.to raise_error(ArgumentError)
   end
 
   it "to_s correctly displays the right number of decimal places" do
@@ -99,8 +104,19 @@ RSpec.describe "Money" do
     expect{ money.to_s(:some_weird_style) }.to raise_error(ArgumentError)
   end
 
-  it "as_json as a float with 2 decimal places" do
-    expect(money.as_json).to eq("1.00")
+  it "legacy_json_format makes as_json return the legacy format" do
+    configure(legacy_json_format: true) do
+      expect(Money.new(1, 'CAD').as_json).to eq("1.00")
+    end
+  end
+
+  it "legacy_format correctly sets the json format" do
+    expect(Money.new(1, 'CAD').as_json(legacy_format: true)).to eq("1.00")
+    expect(Money.new(1, 'CAD').to_json(legacy_format: true)).to eq("1.00")
+  end
+
+  it "as_json as a json containing the value and currency" do
+    expect(money.as_json).to eq(value: "1.00", currency: "CAD")
   end
 
   it "is constructable with a BigDecimal" do
@@ -139,9 +155,15 @@ RSpec.describe "Money" do
     expect((Money.new + Money.new)).to eq(Money.new)
   end
 
-  it "adds inconsistent currencies" do
-    expect(Money).to receive(:deprecate).once
-    expect(Money.new(5, 'USD') + Money.new(1, 'CAD')).to eq(Money.new(6, 'USD'))
+  it "legacy_deprecations adds inconsistent currencies" do
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      expect(Money.new(5, 'USD') + Money.new(1, 'CAD')).to eq(Money.new(6, 'USD'))
+    end
+  end
+
+  it "raises when adding inconsistent currencies" do
+    expect{ Money.new(5, 'USD') + Money.new(1, 'CAD') }.to raise_error(Money::IncompatibleCurrencyError)
   end
 
   it "is subtractable" do
@@ -157,8 +179,10 @@ RSpec.describe "Money" do
   end
 
   it "logs a deprecation warning when adding across currencies" do
-    expect(Money).to receive(:deprecate)
-    expect(Money.new(10, 'USD') - Money.new(1, 'JPY')).to eq(Money.new(9, 'USD'))
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate)
+      expect(Money.new(10, 'USD') - Money.new(1, 'JPY')).to eq(Money.new(9, 'USD'))
+    end
   end
 
   it "keeps currency when doing a computation with a null currency" do
@@ -254,9 +278,15 @@ RSpec.describe "Money" do
     expect(((1.0 / 12) * Money.new(3.3))).to eq(Money.new(0.28))
   end
 
-  it "is multipliable by a money object" do
-    expect(Money).to receive(:deprecate).once
-    expect((Money.new(3.3) * Money.new(1))).to eq(Money.new(3.3))
+  it "legacy_deprecations is multipliable by a money object" do
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      expect((Money.new(3.3, 'USD') * Money.new(1, 'USD'))).to eq(Money.new(3.3, 'USD'))
+    end
+  end
+
+  it "raises when multiplied by a money object" do
+    expect{ (Money.new(3.3) * Money.new(1)) }.to raise_error(ArgumentError)
   end
 
   it "rounds multiplication result with fractional penny of 5 or higher up" do
@@ -294,7 +324,13 @@ RSpec.describe "Money" do
   end
 
   it "returns cents in to_json" do
-    expect(Money.new(1.00).to_json).to eq("1.00")
+    configure(legacy_json_format: true) do
+      expect(Money.new('1.23', 'USD').to_json).to eq('1.23')
+    end
+  end
+
+  it "returns value and currency in to_json" do
+    expect(Money.new(1.00).to_json).to eq('{"value":"1.00","currency":"CAD"}')
   end
 
   it "supports absolute value" do
@@ -352,9 +388,12 @@ RSpec.describe "Money" do
   end
 
   it "generates a true rational" do
-    expect(Money.rational(Money.new(10.0), Money.new(15.0))).to eq(Rational(2,3))
-    expect(Money).to receive(:deprecate).once
-    expect(Money.rational(Money.new(10.0, 'USD'), Money.new(15.0, 'JPY'))).to eq(Rational(2,3))
+    expect(Money.rational(Money.new(10.0, 'USD'), Money.new(15.0, 'USD'))).to eq(Rational(2,3))
+
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      expect(Money.rational(Money.new(10.0, 'USD'), Money.new(15.0, 'JPY'))).to eq(Rational(2,3))
+    end
   end
 
   describe "frozen with amount of $1" do
@@ -413,9 +452,11 @@ RSpec.describe "Money" do
     end
 
     it "<=> issues deprecation warning when comparing incompatible currency" do
-      expect(Money).to receive(:deprecate).twice
-      expect(Money.new(1000, 'USD') <=> Money.new(2000, 'JPY')).to eq(-1)
-      expect(Money.new(2000, 'JPY') <=> Money.new(1000, 'USD')).to eq(1)
+      configure(legacy_deprecations: true) do
+        expect(Money).to receive(:deprecate).twice
+        expect(Money.new(1000, 'USD') <=> Money.new(2000, 'JPY')).to eq(-1)
+        expect(Money.new(2000, 'JPY') <=> Money.new(1000, 'USD')).to eq(1)
+      end
     end
 
     describe('same values') do
@@ -437,15 +478,22 @@ RSpec.describe "Money" do
         it { expect(cad_10 <  nil_10).to(eq(false)) }
       end
 
-      describe('different currencies') do
+      describe('legacy different currencies') do
+        around(:each) do |test|
+          configure(legacy_deprecations: true) { test.run }
+        end
+
         it { expect(Money).to(receive(:deprecate).once); expect(cad_10 <=> usd_10).to(eq(0)) }
         it { expect(Money).to(receive(:deprecate).once); expect(cad_10 >  usd_10).to(eq(false)) }
         it { expect(Money).to(receive(:deprecate).once); expect(cad_10 >= usd_10).to(eq(true)) }
-        it { expect(cad_10 == usd_10).to(eq(false)) }
         it { expect(Money).to(receive(:deprecate).once); expect(cad_10 <= usd_10).to(eq(true)) }
         it { expect(Money).to(receive(:deprecate).once); expect(cad_10 <  usd_10).to(eq(false)) }
       end
 
+      describe('different currencies') do
+        it { expect(cad_10 == usd_10).to(eq(false)) }
+      end
+
       describe('to_money types') do
         it { expect(cad_10 <=> 10.00).to(eq(0)) }
         it { expect(cad_10 >   10.00).to(eq(false)) }
@@ -710,8 +758,7 @@ RSpec.describe "Money" do
   end
 
   describe "parser dependency injection" do
-    before(:each) { Money.parser = AccountingMoneyParser }
-    after(:each) { Money.parser = MoneyParser }
+    around(:each) { |test| configure(parser: AccountingMoneyParser, default_currency: 'CAD') { test.run }}
 
     it "keeps AccountingMoneyParser class on new money objects" do
       expect(Money.new.class.parser).to eq(AccountingMoneyParser)
@@ -875,8 +922,7 @@ RSpec.describe "Money" do
     end
 
     context "with .default_currency set" do
-      before(:each) { Money.default_currency = Money::Currency.new('EUR') }
-      after(:each) { Money.default_currency = Money::NULL_CURRENCY }
+      around(:each) { |test| configure(default_currency: Money::Currency.new('EUR')) { test.run }}
 
       it "can be nested and falls back to default_currency outside of the blocks" do
         money2, money3 = nil

data/spec/spec_helper.rb

@@ -68,3 +68,18 @@ RSpec::Matchers.define :quack_like do
     expected.instance_methods - actual.instance_methods
   end
 end
+
+
+def configure(default_currency: nil, legacy_json_format: nil, legacy_deprecations: nil, legacy_default_currency: nil, parser: nil)
+  old_config = Money.config
+  Money.config = Money::Config.new.tap do |config|
+    config.default_currency = default_currency if default_currency
+    config.parser = parser if parser
+    config.legacy_json_format! if legacy_json_format
+    config.legacy_deprecations! if legacy_deprecations
+    config.legacy_default_currency! if legacy_default_currency
+  end
+  yield
+ensure
+  Money.config = old_config
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING.md
 - bin/console
 - config/currency_historic.yml
 - config/currency_iso.yml
@@ -118,6 +119,7 @@ files:
 - lib/money.rb
 - lib/money/accounting_money_parser.rb
 - lib/money/allocator.rb
+- lib/money/config.rb
 - lib/money/core_extensions.rb
 - lib/money/currency.rb
 - lib/money/currency/loader.rb
@@ -139,6 +141,7 @@ files:
 - money.gemspec
 - spec/accounting_money_parser_spec.rb
 - spec/allocator_spec.rb
+- spec/config_spec.rb
 - spec/core_extensions_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb
@@ -168,9 +171,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -179,6 +182,7 @@ summary: Shopify's money gem
 test_files:
 - spec/accounting_money_parser_spec.rb
 - spec/allocator_spec.rb
+- spec/config_spec.rb
 - spec/core_extensions_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb