shopify-money 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae2953d70e905d5f2425b6c334f5e8a920ec749a0e82341739b90dee7c446254
-  data.tar.gz: 42fd32e212f52fb97c366cc39fe8bf462fff7be09ebb54690a6c7a3d80e5c08d
+  metadata.gz: c67c2dd8b088c4dd304e61c162f100be69c492de2a3a45f8954bca27a5a524dc
+  data.tar.gz: d162ab0971609899ac9b152e62eb96bce8c54908761310e99a361280b20fd005
 SHA512:
-  metadata.gz: 538545671ca1a88fd930f5148b0477a2558a6166764439a2a30ff3a7b34f7057fbf510c11f238d44cae13296c2eb81cfd07ffa510bfacae2b8780c49920404ed
-  data.tar.gz: 67944f9355d6b02e61c0e90f9e34cfd3ec7d3adea2f6dfbb45fc88241e38af516ad89726bd13b2e4a211e4adb26741f842904f92095e678808e1e25b871abfde
+  metadata.gz: b272a70b2e03787371782b781e62b291d292c5486070899253ba286d8a91461581fda8904e1f38025dceabda6d3690373b72333f8d103d8b6cd698bf1213787c
+  data.tar.gz: b3f3165474b9d0fc614dca9c3f1a771de70aa8e02423e68deb3ecc2c90201454d52dac62a813ab132605526f122e43822abfd3049d55ced561b0eecb2532fc9a

data/.github/workflows/tests.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ['2.6', '2.7', '3.0', '3.1']
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2']
 
     name: Ruby ${{ matrix.ruby }}
     steps:

data/README.md

@@ -156,12 +156,17 @@ 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
 
-If your application is currently handling only one currency, it can autocorrect this by specifying a currency under the `Enabled` line:
+Money/ZeroMoney:
+  Enabled: true
+  # Same here:
+  # ReplacementCurrency: CAD
 
-```yaml
-ReplacementCurrency: 'CAD'
+Money/UnsafeToMoney:
+  Enabled: true
 ```
 
 ## Contributing to money

data/dev.yml

@@ -3,7 +3,7 @@
 ---
 name: money
 up:
-- ruby: 2.6.6
+- ruby: 3.2.0
 - bundler
 commands:
   test: bundle exec rspec

data/lib/money/helpers.rb

@@ -10,6 +10,7 @@ class Money
 
     STRIPE_SUBUNIT_OVERRIDE = {
       'ISK' => 100,
+      'UGX' => 100,
     }.freeze
 
     def value_to_decimal(num)

data/lib/money/version.rb

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

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

@@ -0,0 +1,35 @@
+
+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.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/money_spec.rb

@@ -376,6 +376,10 @@ RSpec.describe "Money" do
         expect(Money.from_subunits(100, 'ISK', format: :stripe)).to eq(Money.new(1, 'ISK'))
       end
 
+      it 'overrides the subunit_to_unit amount for UGX' do
+        expect(Money.from_subunits(100, 'UGX', format: :stripe)).to eq(Money.new(1, 'UGX'))
+      end
+
       it 'fallbacks to the default subunit_to_unit amount if no override is specified' do
         expect(Money.from_subunits(100, 'USD', format: :stripe)).to eq(Money.new(1, 'USD'))
       end
@@ -622,6 +626,10 @@ RSpec.describe "Money" do
         expect(Money.new(1, 'ISK').subunits(format: :stripe)).to eq(100)
       end
 
+      it 'overrides the subunit_to_unit amount for UGX' do
+        expect(Money.new(1, 'UGX').subunits(format: :stripe)).to eq(100)
+      end
+
       it 'fallbacks to the default subunit_to_unit amount if no override is specified' do
         expect(Money.new(1, 'USD').subunits(format: :stripe)).to eq(100)
       end

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

@@ -0,0 +1,57 @@
+# 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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,6 +140,7 @@ 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
@@ -159,6 +160,7 @@ 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
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: Shopify's money gem
@@ -204,6 +206,7 @@ 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