shopify-money 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75ba2eb41fa1e50dac837fab61774cdb4a05407b030cb7ba2989b60de27bbfe4
-  data.tar.gz: e612602f0f07fe052e6a2e53046e7b6b9a05c56775a75c6a3e4d1f7984671a49
+  metadata.gz: afe8dd7e74692587c2a65622a5ee6f1703ef9c0af100c0b0940f225399f2391f
+  data.tar.gz: e925f921795d0317f06d9d01c88f981560f353a5746e6d293e103a309600f881
 SHA512:
-  metadata.gz: ffa8231621bc6d26f446425cab725e4a3fdcef5a5ec1c7bc240f6397c6fd07514863b56a44c89b413c4750f4a20eb8b218500ea2ab5c0120b7c158f5a24b9a46
-  data.tar.gz: 6b9582714d55a4e1150b01fcb3eada86751f6408b943811570470c88fda04a7e9db8fdc8a1da65ff46bdf465eb641be521ac474fe1ec6dcc952598d6c32594c0
+  metadata.gz: 99b9dccc03de12fd78021c9af07b26fe1897395f7762d0b14d0397064cbffc64eeb96e1e504a91591703c1e1d04c681416fbf51f60fff839939915e600a9bfe9
+  data.tar.gz: 062a4c38ce1fff9b93df7a33d19323e995ebd3a0b74cae3882f8f3f34654febc19bfb761cdb3092838db738868b475ef7fe84002f9c04c8736d49b7484742f85

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify-money (2.2.0)
+    shopify-money (2.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,7 +3,7 @@
 [![tests](https://github.com/Shopify/money/workflows/tests/badge.svg)](https://github.com/Shopify/money/actions?query=workflow%3Atests+branch%3Amain)
 
 
-money_column expects a DECIMAL(21,3) database field.
+`money_column` expects a `DECIMAL(21,3)` database field.
 
 ### Features
 
@@ -195,17 +195,11 @@ require:
 
 Money/MissingCurrency:
   Enabled: true
-  # If your application is currently handling only one currency,
-  # it can autocorrect this by specifying a default currency.
-  ReplacementCurrency: CAD
+  # ReplacementCurrency: CAD
 
 Money/ZeroMoney:
   Enabled: true
-  # Same here:
   # ReplacementCurrency: CAD
-
-Money/UnsafeToMoney:
-  Enabled: true
 ```
 
 ## Contributing to money
@@ -218,6 +212,21 @@ Money/UnsafeToMoney:
 - Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 - Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+### Releasing
+
+To release a new version of the gem, follow these steps:
+
+- Audit what has changed since the last version of the gem was released.
+- Determine what the next version number should be, according to [Semantic Versioning](https://semver.org/).
+- Open a PR to update the version accordingly in `lib/money/version`.
+- After getting approval, merge the PR.
+- [**Publish** a release in Github](https://github.com/Shopify/money/releases/new):
+  - Target the `main` branch with a tag matching the new version, prefixed with `v` (e.g. `v1.2.3`).
+  - Use the "Generate Release Notes" button to help generate the copy for the release. Include **consumer facing changes** in the release notes.
+- Deploy the new version to Rubygems using [ShipIt](https://shipit.shopify.io/shopify/money/production).
+- For more information see [the publish a gem vault page](https://vault.shopify.io/page/Publish-a-new-version-of-an-internal-gem~dhbc57d.md)
+- You are now responsible to [merge the bump PR in core](https://github.com/Shopify/shopify/pulls?q=is%3Aopen+is%3Apr+author%3Aapp%2Fdependabot+shopify-money+)
+
 ## Copyright
 
 Copyright (c) 2011 Shopify. See LICENSE.txt for

data/lib/money/core_extensions.rb

@@ -14,14 +14,26 @@ end
 #   '100.37'.to_money => #<Money @cents=10037>
 class String
   def to_money(currency = nil)
-    if Money.config.legacy_deprecations
-      Money::Parser::Fuzzy.parse(self, currency).tap do |money|
-        message = "`#{self}.to_money` will behave like `Money.new` and raise on the next release. " \
-          "To parse user input, do so on the browser and use the user's locale."
-        Money.deprecate(message) if money.value != BigDecimal(self, exception: false)
+    currency = Money::Helpers.value_to_currency(currency)
+
+    unless Money.config.legacy_deprecations
+      return Money.new(self, currency)
+    end
+
+    Money::Parser::Fuzzy.parse(self, currency).tap do |money|
+      new_value = BigDecimal(self, exception: false)&.round(currency.minor_units)
+      old_value = money.value
+
+      if new_value != old_value
+        message = "`\"#{self}\".to_money` will soon behave like `Money.new(\"#{self}\")` and "
+        message +=
+          if new_value.nil?
+            "raise an ArgumentError exception. Use the browser's locale to parse money strings."
+          else
+            "return #{new_value} instead of #{old_value}."
+          end
+        Money.deprecate(message)
       end
-    else
-      Money.new(self, currency)
     end
   end
 end

data/lib/money/money.rb

@@ -106,9 +106,17 @@ class Money
     private
 
     def new_from_money(amount, currency)
-      return amount if amount.currency.compatible?(Helpers.value_to_currency(currency))
+      currency = Helpers.value_to_currency(currency)
 
-      msg = "Money.new is attempting to change currency of an existing money object"
+      if amount.no_currency?
+        return Money.new(amount.value, currency)
+      end
+
+      if amount.currency.compatible?(currency)
+        return amount
+      end
+
+      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)
@@ -216,14 +224,8 @@ class Money
       return Money.new(value, new_currency)
     end
 
-    unless currency.compatible?(Helpers.value_to_currency(new_currency))
-      msg = "to_money is attempting to change currency of an existing money object from #{currency} to #{new_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
+    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
@@ -358,24 +360,33 @@ class Money
 
   private
 
-  def arithmetic(money_or_numeric)
-    case money_or_numeric
+  def arithmetic(other)
+    case other
     when Money
-      unless currency.compatible?(money_or_numeric.currency)
-        msg = "mathematical operation not permitted for Money objects with different currencies #{money_or_numeric.currency} 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
+      ensure_compatible_currency(other.currency,
+        "mathematical operation not permitted for Money objects with different currencies #{other.currency} and #{currency}.")
+      yield(other)
+
+    when Numeric, String
+      yield(Money.new(other, currency))
+
+    else
+      if Money.config.legacy_deprecations && other.respond_to?(:to_money)
+        Money.deprecate("#{other.inspect} is being implicitly coerced into a Money object. Call `to_money` on this object to transform it into a money explicitly. An TypeError will raise in the next major release")
+        yield(other.to_money(currency))
+      else
+        raise TypeError, "#{other.class.name} can't be coerced into Money"
       end
-      yield(money_or_numeric)
+    end
+  end
 
-    when Numeric
-      yield(Money.new(money_or_numeric, currency))
+  def ensure_compatible_currency(other_currency, msg)
+    return if currency.compatible?(other_currency)
 
+    if Money.config.legacy_deprecations
+      Money.deprecate("#{msg}. A Money::IncompatibleCurrencyError will raise in the next major release")
     else
-      raise TypeError, "#{money_or_numeric.class.name} can't be coerced into Money"
+      raise Money::IncompatibleCurrencyError, msg
     end
   end
 

data/lib/money/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Money
-  VERSION = "2.2.0"
+  VERSION = "2.2.2"
 end

data/lib/rubocop/cop/money.rb

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

data/spec/core_extensions_spec.rb

@@ -61,6 +61,14 @@ RSpec.describe String do
     end
   end
 
+  it "#to_money does not warn when it already behaves like Money.new" do
+  configure(legacy_deprecations: true) do
+    expect(Money).to receive(:deprecate).never
+    expect("71.94999999999999".to_money("USD")).to eq(Money.new("71.95", "USD"))
+    expect("0.001".to_money("USD")).to eq(Money.new("0", "USD"))
+  end
+end
+
   it "#to_money should behave like Money.new with three decimal places amounts" do
     expect("29.000".to_money("USD")).to eq(Money.new("29.00", "USD"))
   end

data/spec/money_spec.rb

@@ -41,6 +41,16 @@ RSpec.describe "Money" do
     expect(Money.new(1, 'CAD').to_money('CAD')).to eq(Money.new(1, 'CAD'))
   end
 
+  it "#to_money works with money objects that doesn't have a currency" do
+    money = Money.new(1, Money::NULL_CURRENCY).to_money('USD')
+    expect(money.value).to eq(1)
+    expect(money.currency.to_s).to eq('USD')
+
+    money = Money.new(1, 'USD').to_money(Money::NULL_CURRENCY)
+    expect(money.value).to eq(1)
+    expect(money.currency.to_s).to eq('USD')
+  end
+
   it "legacy_deprecations #to_money doesn't overwrite the money object's currency" do
     configure(legacy_deprecations: true) do
       expect(Money).to receive(:deprecate).with(match(/to_money is attempting to change currency of an existing money object/)).once
@@ -70,6 +80,17 @@ RSpec.describe "Money" do
 
   it "can be constructed with a money object" do
     expect(Money.new(Money.new(1))).to eq(Money.new(1))
+    expect(Money.new(Money.new(1, "USD"), "USD")).to eq(Money.new(1, "USD"))
+  end
+
+  it "can be constructed with a money object with a null currency" do
+    money = Money.new(Money.new(1, Money::NULL_CURRENCY), 'USD')
+    expect(money.value).to eq(1)
+    expect(money.currency.to_s).to eq('USD')
+
+    money = Money.new(Money.new(1, 'USD'), Money::NULL_CURRENCY)
+    expect(money.value).to eq(1)
+    expect(money.currency.to_s).to eq('USD')
   end
 
   it "constructor raises when changing currency" do
@@ -78,7 +99,7 @@ RSpec.describe "Money" do
 
   it "legacy_deprecations constructor with money used the constructor currency" do
     configure(legacy_deprecations: true) do
-     expect(Money).to receive(:deprecate).with(match(/Money.new is attempting to change currency of an existing money object/)).once
+     expect(Money).to receive(:deprecate).with(match(/Money.new\(Money.new\(amount, USD\), CAD\) is changing the currency of an existing money object/)).once
       expect(Money.new(Money.new(1, 'USD'), 'CAD')).to eq(Money.new(1, 'CAD'))
     end
   end
@@ -556,13 +577,49 @@ RSpec.describe "Money" do
         it { expect(cad_10 == usd_10).to(eq(false)) }
       end
 
-      describe('to_money types') do
+      describe('coerced types') do
         it { expect(cad_10 <=> 10.00).to(eq(0)) }
         it { expect(cad_10 >   10.00).to(eq(false)) }
         it { expect(cad_10 >=  10.00).to(eq(true)) }
         it { expect(cad_10 ==  10.00).to(eq(false)) }
         it { expect(cad_10 <=  10.00).to(eq(true)) }
         it { expect(cad_10 <   10.00).to(eq(false)) }
+        it { expect(cad_10 <=>'10.00').to(eq(0)) }
+        it { expect(cad_10 >  '10.00').to(eq(false)) }
+        it { expect(cad_10 >= '10.00').to(eq(true)) }
+        it { expect(cad_10 == '10.00').to(eq(false)) }
+        it { expect(cad_10 <= '10.00').to(eq(true)) }
+        it { expect(cad_10 <  '10.00').to(eq(false)) }
+      end
+
+      describe('to_money coerced types') do
+        let(:coercible_object) do
+          double("coercible_object").tap do |mock|
+            allow(mock).to receive(:to_money).with(any_args) { |currency| Money.new(10, currency) }
+          end
+        end
+
+        it { expect { cad_10 <=> coercible_object }.to(raise_error(TypeError)) }
+        it { expect { cad_10 >   coercible_object }.to(raise_error(TypeError)) }
+        it { expect { cad_10 >=  coercible_object }.to(raise_error(TypeError)) }
+        it { expect { cad_10 <=  coercible_object }.to(raise_error(TypeError)) }
+        it { expect { cad_10 <   coercible_object }.to(raise_error(TypeError)) }
+        it { expect { cad_10 +   coercible_object }.to(raise_error(TypeError)) }
+        it { expect { cad_10 -   coercible_object }.to(raise_error(TypeError)) }
+
+        describe('with legacy_deprecations') do
+          around(:each) do |test|
+            configure(legacy_deprecations: true) { test.run }
+          end
+
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 <=> coercible_object).to(eq(0)) }
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 >   coercible_object).to(eq(false)) }
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 >=  coercible_object).to(eq(true)) }
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 <=  coercible_object).to(eq(true)) }
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 <   coercible_object).to(eq(false)) }
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 +   coercible_object).to(eq(Money.new(20, 'CAD'))) }
+          it { expect(Money).to(receive(:deprecate).once); expect(cad_10 -   coercible_object).to(eq(Money.new(0, 'CAD'))) }
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,6 @@ files:
 - lib/money_column/railtie.rb
 - lib/rubocop/cop/money.rb
 - lib/rubocop/cop/money/missing_currency.rb
-- lib/rubocop/cop/money/unsafe_to_money.rb
 - lib/rubocop/cop/money/zero_money.rb
 - lib/shopify-money.rb
 - money.gemspec
@@ -164,7 +163,6 @@ files:
 - spec/rails/job_argument_serializer_spec.rb
 - spec/rails_spec_helper.rb
 - spec/rubocop/cop/money/missing_currency_spec.rb
-- spec/rubocop/cop/money/unsafe_to_money_spec.rb
 - spec/rubocop/cop/money/zero_money_spec.rb
 - spec/rubocop_helper.rb
 - spec/schema.rb
@@ -212,7 +210,6 @@ test_files:
 - spec/rails/job_argument_serializer_spec.rb
 - spec/rails_spec_helper.rb
 - spec/rubocop/cop/money/missing_currency_spec.rb
-- spec/rubocop/cop/money/unsafe_to_money_spec.rb
 - spec/rubocop/cop/money/zero_money_spec.rb
 - spec/rubocop_helper.rb
 - spec/schema.rb

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

@@ -1,35 +0,0 @@
-
-module RuboCop
-  module Cop
-    module Money
-      # Prevents the use of `to_money` because it has inconsistent behaviour.
-      # Use `Money.new` instead.
-      #
-      # @example
-      #  # bad
-      #  "2.000".to_money("USD")     #<Money value:2000.00 currency:USD>
-      #
-      #  # good
-      #  Money.new("2.000", "USD")   #<Money value:2.00 currency:USD>
-      class UnsafeToMoney < Cop
-        MSG = '`to_money` has inconsistent behaviour. Use `Money.new` instead.'.freeze
-
-        def on_send(node)
-          return unless node.method?(:to_money)
-          return if node.receiver.nil? || node.receiver.is_a?(AST::NumericNode)
-
-          add_offense(node, location: :selector)
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            receiver = node.receiver.source
-            args = node.arguments.map(&:source)
-            args.prepend(receiver)
-            corrector.replace(node.loc.expression, "Money.new(#{args.join(', ')})")
-          end
-        end
-      end
-    end
-  end
-end

data/spec/rubocop/cop/money/unsafe_to_money_spec.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../rubocop_helper'
-require 'rubocop/cop/money/unsafe_to_money'
-
-RSpec.describe RuboCop::Cop::Money::UnsafeToMoney do
-  subject(:cop) { described_class.new(config) }
-
-  let(:config) { RuboCop::Config.new }
-
-  context 'with default configuration' do
-    it 'does not register an offense for literal integer' do
-      expect_no_offenses(<<~RUBY)
-        1.to_money
-      RUBY
-    end
-
-    it 'does not register an offense for literal float' do
-      expect_no_offenses(<<~RUBY)
-        1.000.to_money
-      RUBY
-    end
-
-    it 'registers an offense and corrects for Money.new without a currency argument' do
-      expect_offense(<<~RUBY)
-        '2.000'.to_money
-                ^^^^^^^^ #{described_class::MSG}
-      RUBY
-
-      expect_correction(<<~RUBY)
-        Money.new('2.000')
-      RUBY
-    end
-
-    it 'registers an offense and corrects for Money.new with a currency argument' do
-      expect_offense(<<~RUBY)
-        '2.000'.to_money('USD')
-                ^^^^^^^^ #{described_class::MSG}
-      RUBY
-
-      expect_correction(<<~RUBY)
-        Money.new('2.000', 'USD')
-      RUBY
-    end
-
-    it 'registers an offense and corrects for Money.new with a complex receiver' do
-      expect_offense(<<~RUBY)
-        obj.money.to_money('USD')
-                  ^^^^^^^^ #{described_class::MSG}
-      RUBY
-
-      expect_correction(<<~RUBY)
-        Money.new(obj.money, 'USD')
-      RUBY
-    end
-
-    it 'does not register an offense for receiver-less calls' do
-      expect_no_offenses(<<~RUBY)
-        a = to_money
-      RUBY
-    end
-  end
-end