shopify-money 0.14.6 → 1.0.0.pre

data/lib/money/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Money
-  VERSION = "0.14.6"
+  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/lib/rubocop/cop/money.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require 'rubocop/cop/money/missing_currency'
+require 'rubocop/cop/money/zero_money'

data/lib/rubocop/cop/money/missing_currency.rb

@@ -20,11 +20,11 @@ module RuboCop
         #
 
         def_node_matcher :money_new, <<~PATTERN
-          (send (const nil? :Money) {:new :from_amount :from_cents} $...)
+          (send (const {nil? cbase} :Money) {:new :from_amount :from_cents} $...)
         PATTERN
 
         def_node_matcher :to_money_without_currency?, <<~PATTERN
-          (send _ :to_money)
+          ({send csend} _ :to_money)
         PATTERN
 
         def_node_matcher :to_money_block?, <<~PATTERN
@@ -42,11 +42,9 @@ module RuboCop
             add_offense(node, message: 'to_money is missing currency argument')
           end
         end
+        alias on_csend on_send
 
         def autocorrect(node)
-          currency = cop_config['ReplacementCurrency']
-          return unless currency
-
           receiver, method, _ = *node
 
           lambda do |corrector|
@@ -55,20 +53,30 @@ module RuboCop
 
               corrector.replace(
                 node.loc.expression,
-                "#{receiver.source}.#{method}(#{amount&.source || 0}, '#{currency}')"
+                "#{receiver.source}.#{method}(#{amount&.source || 0}, #{replacement_currency})"
               )
             end
 
             if to_money_without_currency?(node)
-              corrector.insert_after(node.loc.expression, "('#{currency}')")
+              corrector.insert_after(node.loc.expression, "(#{replacement_currency})")
             elsif to_money_block?(node)
               corrector.replace(
                 node.loc.expression,
-                "#{receiver.source}.#{method} { |x| x.to_money('#{currency}') }"
+                "#{receiver.source}.#{method} { |x| x.to_money(#{replacement_currency}) }"
               )
             end
           end
         end
+
+        private
+
+        def replacement_currency
+          if cop_config['ReplacementCurrency']
+            "'#{cop_config['ReplacementCurrency']}'"
+          else
+            'Money::NULL_CURRENCY'
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/money/zero_money.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Money
+      class ZeroMoney < Cop
+        # `Money.zero` and it's alias `empty`, with or without currency
+        # argument is removed in favour of the more explicit Money.new
+        # syntax. Supplying it with a real currency is preferred for
+        # additional currency safety checks.
+        #
+        # If no currency was supplied, it defaults to
+        # Money::NULL_CURRENCY which was the default setting of
+        # Money.default_currency and should effectively be the same. The cop
+        # can be configured with a ReplacementCurrency in case that is more
+        # appropriate for your application.
+        #
+        # @example
+        #
+        #   # bad
+        #   Money.zero
+        #
+        #   # good when configured with `ReplacementCurrency: CAD`
+        #   Money.new(0, 'CAD')
+        #
+
+        MSG = 'Money.zero is removed, use `Money.new(0, %<currency>s)`.'
+
+        def_node_matcher :money_zero, <<~PATTERN
+          (send (const {nil? cbase} :Money) {:zero :empty} $...)
+        PATTERN
+
+        def on_send(node)
+          money_zero(node) do |currency_arg|
+            add_offense(node, message: format(MSG, currency: replacement_currency(currency_arg)))
+          end
+        end
+
+        def autocorrect(node)
+          receiver, _ = *node
+
+          lambda do |corrector|
+            money_zero(node) do |currency_arg|
+              replacement_currency = replacement_currency(currency_arg)
+
+              corrector.replace(
+                node.loc.expression,
+                "#{receiver.source}.new(0, #{replacement_currency})"
+              )
+            end
+          end
+        end
+
+        private
+
+        def replacement_currency(currency_arg)
+          return currency_arg.first.source unless currency_arg.empty?
+          return "'#{cop_config['ReplacementCurrency']}'" if cop_config['ReplacementCurrency']
+
+          'Money::NULL_CURRENCY'
+        end
+      end
+    end
+  end
+end

data/money.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.metadata['allowed_push_host'] = "https://rubygems.org"
 
-  s.add_development_dependency("bundler", ">= 1.5")
+  s.add_development_dependency("bundler")
   s.add_development_dependency("simplecov", ">= 0")
   s.add_development_dependency("rails", "~> 6.0")
   s.add_development_dependency("rspec", "~> 3.2")

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

@@ -43,7 +43,7 @@ RSpec.describe "Allocator" do
 
     specify "#allocate will convert rationals with high precision" do
       ratios = [Rational(1, 1), Rational(0)]
-      expect(new_allocator("858993456.12").allocate(ratios)).to eq([Money.new("858993456.12"), Money.empty])
+      expect(new_allocator("858993456.12").allocate(ratios)).to eq([Money.new("858993456.12"), Money.new(0, Money::NULL_CURRENCY)])
       ratios = [Rational(1, 6), Rational(5, 6)]
       expect(new_allocator("3.00").allocate(ratios)).to eq([Money.new("0.50"), Money.new("2.50")])
     end
@@ -131,8 +131,8 @@ RSpec.describe "Allocator" do
 
     specify "#allocate_max_amounts supports all-zero maxima" do
       expect(
-        new_allocator(3).allocate_max_amounts([Money.empty, Money.empty, Money.empty]),
-      ).to eq([Money.empty, Money.empty, Money.empty])
+        new_allocator(3).allocate_max_amounts([Money.new(0, Money::NULL_CURRENCY), Money.new(0, Money::NULL_CURRENCY), Money.new(0, Money::NULL_CURRENCY)]),
+      ).to eq([Money.new(0, Money::NULL_CURRENCY), Money.new(0, Money::NULL_CURRENCY), Money.new(0, Money::NULL_CURRENCY)])
     end
 
     specify "#allocate_max_amounts allocates the right amount without rounding error" 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/core_extensions_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Integer do
   it_should_behave_like "an object supporting to_money"
 
   it "parses 0 to Money.zero" do
-    expect(0.to_money).to eq(Money.zero)
+    expect(0.to_money).to eq(Money.new(0, Money::NULL_CURRENCY))
   end
 end
 
@@ -30,7 +30,7 @@ RSpec.describe Float do
   it_should_behave_like "an object supporting to_money"
 
   it "parses 0.0 to Money.zero" do
-    expect(0.0.to_money).to eq(Money.zero)
+    expect(0.0.to_money).to eq(Money.new(0, Money::NULL_CURRENCY))
   end
 end
 
@@ -43,8 +43,8 @@ RSpec.describe String do
   it_should_behave_like "an object supporting to_money"
 
   it "parses an empty string to Money.zero" do
-    expect(''.to_money).to eq(Money.zero)
-    expect(' '.to_money).to eq(Money.zero)
+    expect(''.to_money).to eq(Money.new(0, Money::NULL_CURRENCY))
+    expect(' '.to_money).to eq(Money.new(0, Money::NULL_CURRENCY))
   end
 end
 
@@ -57,6 +57,6 @@ RSpec.describe BigDecimal do
   it_should_behave_like "an object supporting to_money"
 
   it "parses a zero BigDecimal to Money.zero" do
-    expect(BigDecimal("-0.000").to_money).to eq(Money.zero)
+    expect(BigDecimal("-0.000").to_money).to eq(Money.new(0, Money::NULL_CURRENCY))
   end
 end

data/spec/currency_spec.rb

@@ -77,6 +77,16 @@ RSpec.describe "Currency" do
     end
   end
 
+  describe "#hash" do
+    specify "equal currencies from different loaders have the same hash" do
+      currency_1 = Money::Currency.find('USD')
+      currency_2 = YAML.load(Money::Currency.find('USD').to_yaml)
+
+      expect(currency_1.eql?(currency_2)).to eq(true)
+      expect(currency_1.hash).to eq(currency_2.hash)
+    end
+  end
+
   describe "==" do
     it "returns true when both objects have the same currency" do
       expect(currency == Money.new(1, 'USD').currency).to eq(true)

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
@@ -136,7 +143,7 @@ RSpec.describe 'MoneyColumn' do
 
   it 'does not overwrite a currency column with a default currency when saving zero' do
     expect(record.currency.to_s).to eq('EUR')
-    record.update(price: Money.zero)
+    record.update(price: Money.new(0, Money::NULL_CURRENCY))
     expect(record.currency.to_s).to eq('EUR')
   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