shopify-money 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de174294a88067d61cfcf9321bc62fc3de2b4c265e089d07ff8bedca30ce782a
-  data.tar.gz: 9cb65f619cf3ceb3054437c3ede664d9fa949859af7858e1f280d82f983cdace
+  metadata.gz: 591c60e355144246085ac254fe82b099c85ab4bf7f1e37672b8082331bd9d0aa
+  data.tar.gz: 493384ced59c9a37ebc798b4cb499bd0532ea30243c8248704bf0df6f776ca0f
 SHA512:
-  metadata.gz: cfd7348a2506689d46b70eebb613c4ebdb3ef33ad31ae361d130c4348691f90049a66a50920f96c9f39f532bfe3fc0901c939a6d2e0be6d90d6d045165209f37
-  data.tar.gz: 729391b98fbbfc671726cedd35d6ee13afed28f6b88b98d825eb6cae23cc968de72437fdacf51bf5f68dbaf3aabf4f84d296709764031ce83128a4010012a1b7
+  metadata.gz: 1867df0795206ccd5996b1d8471f23f60340ace3e5e685ddbb98f601402a7748aade38263dbc7f12971c1e4368919cb0122c53eacf0b96b96df44189be3ca32e
+  data.tar.gz: 9ed8869fce8e66c4e9aee275ac3a28c24db47fd2ae8537f2ff3ee100541f122cd9b8b87e7ca102567b976548eb04b53b06f6c560f2e6e12dc3ca506e0bb87f01

data/.github/workflows/tests.yml

@@ -1,7 +1,7 @@
 name: tests
 
 on: [push, pull_request]
-  
+
 jobs:
   build:
 
@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
 
     name: Ruby ${{ matrix.ruby }}
     steps:

data/README.md

@@ -1,20 +1,17 @@
 # money
 
-[![tests](https://github.com/Shopify/money/workflows/tests/badge.svg)](https://github.com/Shopify/money/actions?query=workflow%3Atests+branch%3Amaster)
+[![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.
 
 ### Features
 
-- Keeps value in decimal
-- Provides a `Money` class which encapsulates all information about an certain
-  amount of money, such as its value and its currency.
-- Provides a `Money::Currency` class which encapsulates all information about
-  a monetary unit.
-- Does NOT provides APIs for exchanging money from one currency to another.
-- wont lose pennies during division!
-- Money::NullCurrency for no currency support
+- Provides a `Money` class which encapsulates all information about a certain amount of money, such as its value and its currency.
+- Provides a `Money::Currency` class which encapsulates all information about a monetary unit.
+- Represents monetary values as decimals. No need to convert your amounts every time you use them. Easily understand the data in your DB.
+- Does NOT provide APIs for exchanging money from one currency to another.
+- Will not lose pennies during divisions
 
 ## Installation
 
@@ -22,7 +19,7 @@ money_column expects a DECIMAL(21,3) database field.
 
 ## Upgrading to v1.0
 
-see instructions and breaking changes: https://github.com/Shopify/money/blob/master/UPGRADING.md
+see instructions and breaking changes: https://github.com/Shopify/money/blob/main/UPGRADING.md
 
 ## Usage
 
@@ -32,7 +29,7 @@ require 'money'
 # 10.00 USD
 money = Money.new(10.00, "USD")
 money.subunits     #=> 1000
-money.currency  #=> Currency.new("USD")
+money.currency     #=> Money::Currency.new("USD")
 
 # Comparisons
 Money.new(1000, "USD") == Money.new(1000, "USD")   #=> true
@@ -43,13 +40,30 @@ Money.new(1000, "USD") != Money.new(1000, "EUR")   #=> true
 # Arithmetic
 Money.new(1000, "USD") + Money.new(500, "USD") == Money.new(1500, "USD")
 Money.new(1000, "USD") - Money.new(200, "USD") == Money.new(800, "USD")
-Money.new(1000, "USD") / 5                     == Money.new(200, "USD")
 Money.new(1000, "USD") * 5                     == Money.new(5000, "USD")
 
+m = Money.new(1000, "USD")
+# Splitting money evenly
+m.split(2)              == [Money.new(500, "USD"), Money.new(500, "USD")]
+m.split(3).map(&:value) == [333.34, 333.33, 333.33]
+m.calculate_splits(2)   == { Money.new(500, "USD") => 2 }
+m.calculate_splits(3)   == { Money.new(333.34, "USD") => 1, Money.new(333.33, "USD") =>2 }
+
+# Allocating money proportionally
+m.allocate([0.50, 0.25, 0.25]).map(&:value)               == [500, 250, 250]
+m.allocate([Rational(2, 3), Rational(1, 3)]).map(&:value) == [666.67, 333.33]
+
+## Allocating up to a cutoff
+m.allocate_max_amounts([500, 300, 200]).map(&:value) == [500, 300, 200]
+m.allocate_max_amounts([500, 300, 300]).map(&:value) == [454.55, 272.73, 272.72]
+
+# Clamp
+Money.new(50, "USD").clamp(1, 100) == Money.new(50, "USD")
+
 # Unit to subunit conversions
-Money.from_subunits(500, "USD") == Money.new(5, "USD")  # 5 USD
-Money.from_subunits(5, "JPY") == Money.new(5, "JPY")    # 5 JPY
-Money.from_subunits(5000, "TND") == Money.new(5, "TND") # 5 TND
+Money.from_subunits(500, "USD")  == Money.new(5, "USD")   # 5 USD
+Money.from_subunits(5, "JPY")    == Money.new(5, "JPY")   # 5 JPY
+Money.from_subunits(5000, "TND") == Money.new(5, "TND")   # 5 TND
 ```
 
 ## Currency
@@ -171,7 +185,7 @@ Money/UnsafeToMoney:
 
 ## Contributing to money
 
-- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+- Check out the latest main to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 - Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 - Fork the project
 - Start a feature/bugfix branch

data/dev.yml

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

data/lib/money/core_extensions.rb

@@ -14,6 +14,14 @@ end
 #   '100.37'.to_money => #<Money @cents=10037>
 class String
   def to_money(currency = nil)
-    Money::Parser::Fuzzy.parse(self, currency)
+    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)
+      end
+    else
+      Money.new(self, currency)
+    end
   end
 end

data/lib/money/deprecations.rb

@@ -3,7 +3,10 @@ Money.class_eval do
   ACTIVE_SUPPORT_DEFINED = defined?(ActiveSupport)
 
   def self.active_support_deprecator
-    @active_support_deprecator ||= ActiveSupport::Deprecation.new('1.0.0', 'Shopify/Money')
+    @active_support_deprecator ||= begin
+      next_major_version = Money::VERSION.split(".").first.to_i + 1
+      ActiveSupport::Deprecation.new("#{next_major_version}.0.0", "Shopify/Money")
+    end
   end
 
   def self.deprecate(message)

data/lib/money/helpers.rb

@@ -16,8 +16,6 @@ class Money
     def value_to_decimal(num)
       value =
         case num
-        when Money
-          num.value
         when BigDecimal
           num
         when nil, 0, ''

data/lib/money/money.rb

@@ -137,13 +137,8 @@ class Money
   end
 
   def *(numeric)
-    unless numeric.is_a?(Numeric)
-      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
+    raise ArgumentError, "Money objects can only be multiplied by a Numeric" unless numeric.is_a?(Numeric)
+
     return self if numeric == 1
     Money.new(value.to_r * numeric, currency)
   end

data/lib/money/version.rb

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

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

@@ -32,7 +32,8 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          money_new(node) do |_amount, currency_arg|
+          money_new(node) do |amount, currency_arg|
+            return if amount&.splat_type?
             return if currency_arg
 
             add_offense(node, message: 'Money is missing currency argument')

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

@@ -16,7 +16,7 @@ module RuboCop
 
         def on_send(node)
           return unless node.method?(:to_money)
-          return if node.receiver.is_a?(AST::NumericNode)
+          return if node.receiver.nil? || node.receiver.is_a?(AST::NumericNode)
 
           add_offense(node, location: :selector)
         end

data/money.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("database_cleaner", "~> 1.6")
   s.add_development_dependency("sqlite3", "~> 1.4.2")
 
-  s.required_ruby_version = '>= 2.6'
+  s.required_ruby_version = '>= 3.0'
 
   s.files = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/core_extensions_spec.rb

@@ -43,8 +43,26 @@ 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.new(0, Money::NULL_CURRENCY))
-    expect(' '.to_money).to eq(Money.new(0, Money::NULL_CURRENCY))
+    expect("".to_money("USD")).to eq(Money.new(0, "USD"))
+
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).once
+      expect(" ".to_money("CAD")).to eq(Money.new(0, "CAD"))
+    end
+  end
+
+  it "#to_money to handle thousands delimiters" do
+    configure(legacy_deprecations: true) do
+      expect(Money).to receive(:deprecate).exactly(4).times
+      expect("29.000".to_money("USD")).to eq(Money.new("29000", "USD"))
+      expect("29.000,00".to_money("USD")).to eq(Money.new("29000", "USD"))
+      expect("29,000".to_money("USD")).to eq(Money.new("29000", "USD"))
+      expect("29,000.00".to_money("USD")).to eq(Money.new("29000", "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
 end
 

data/spec/deprecations_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe "deprecations" do
+  it "has the deprecation_horizon as the next major release" do
+    allow(Money).to receive(:const_get).with('VERSION').and_return("2.0.0")
+    expect(Money.active_support_deprecator.deprecation_horizon).to eq("3.0.0")
+  end
+end

data/spec/helpers_spec.rb

@@ -7,8 +7,8 @@ RSpec.describe Money::Helpers do
     let (:amount) { BigDecimal('1.23') }
     let (:money) { Money.new(amount) }
 
-    it 'returns the value of a money object' do
-      expect(subject.value_to_decimal(money)).to eq(amount)
+    it 'raises when provided with a money object' do
+      expect { subject.value_to_decimal(money) }.to raise_error(ArgumentError)
     end
 
     it 'returns itself if it is already a big decimal' do

data/spec/money_spec.rb

@@ -290,13 +290,6 @@ RSpec.describe "Money" do
     expect(((1.0 / 12) * Money.new(3.3))).to eq(Money.new(0.28))
   end
 
-  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

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

@@ -26,6 +26,13 @@ RSpec.describe RuboCop::Cop::Money::MissingCurrency do
       RUBY
     end
 
+    it 'does not register an offense for Money.new with splat argument' do
+      expect_no_offenses(<<~RUBY)
+        value_and_currency = [1, 'CAD']
+        Money.new(*value_and_currency)
+      RUBY
+    end
+
     it 'registers an offense and corrects for Money.new without a currency argument' do
       expect_offense(<<~RUBY)
         Money.new

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

@@ -53,5 +53,11 @@ RSpec.describe RuboCop::Cop::Money::UnsafeToMoney do
         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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-20 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,7 @@ files:
 - spec/core_extensions_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb
+- spec/deprecations_spec.rb
 - spec/helpers_spec.rb
 - spec/money_column_spec.rb
 - spec/money_spec.rb
@@ -178,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.5.5
 signing_key: 
 specification_version: 4
 summary: Shopify's money gem
@@ -195,6 +196,7 @@ test_files:
 - spec/core_extensions_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb
+- spec/deprecations_spec.rb
 - spec/helpers_spec.rb
 - spec/money_column_spec.rb
 - spec/money_spec.rb