shopify-money 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c927d4e18e7362a5ad3ddfb642785343d4f504f804b61e0bdac87f410a323c6e
-  data.tar.gz: 6eaa57e295c85d1d94e271a8cda1a7fa0f702198878e6087b25b17ea651bf38a
+  metadata.gz: d16632a569c75054c496e3d341e83ffb2ce08e25177b0c12a344c9b1c5fa23c2
+  data.tar.gz: 43d4b4e5f1c8b79c2d366dbad9077056cdd00744a86035ff58931e192b8fbff7
 SHA512:
-  metadata.gz: 76a3752201eec5bceba4252233a754114de80c3e4e223af5fb2ee9f52b86c280436d55b52457b0d972451392b394aaca40c1240d47535e6c9b24d59f0f0e6dbb
-  data.tar.gz: e4ec1cd96dd48a5ca060cf773843f834c97a8be50eb0d0b55e390556966d439d5aab597a2af9ab139a7008a714fb7c9f20168dac081436b2fb5091e1be602a7d
+  metadata.gz: a15a1d6761fd8bed35cedf19ebec19b03aa7a8f10eb03c52004ce6fb166158feab2bba29a41f7fb005cf49339d39361f572c3636e716dd80dbd0a2a702db1476
+  data.tar.gz: e2b3760497b1d8c4947ae5adea3592a01e625e41d4d916a8155c0d18809358a040e63b897edd5942030ec8652e7e39487adb5b965023b991c8e100fa4f637c73

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    shopify-money (3.2.0)
+    shopify-money (3.2.1)
+      bigdecimal (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -107,8 +108,8 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.10.2)
-    language_server-protocol (3.17.0.4)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
     loofah (2.24.0)
@@ -148,8 +149,8 @@ GEM
     nokogiri (1.18.7-x86_64-linux-gnu)
       racc (~> 1.4)
     ostruct (0.6.1)
-    parallel (1.26.3)
-    parser (3.3.7.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     pp (0.6.2)
@@ -223,7 +224,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.75.2)
+    rubocop (1.75.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -234,14 +235,14 @@ GEM
       rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.0)
+    rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-performance (1.25.0)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
-    rubocop-shopify (2.16.0)
+    rubocop-shopify (2.17.0)
       rubocop (~> 1.62)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)

data/README.md

@@ -165,6 +165,45 @@ Money.configure do |config|
 end
 ```
 
+### Converters
+The Money gem provides a flexible converter system for handling different subunit formats. This is particularly useful when working with payment providers or APIs that have their own conventions for handling currency subunits.
+
+#### Built-in Converters
+- `:iso4217` (default) - Uses the standard ISO 4217 subunit definitions
+- `:stripe` - Uses Stripe's special cases for certain currencies
+- `:legacy_dollar` - Always uses 100 as the subunit_to_unit value
+
+#### Using Converters
+```ruby
+# Convert to subunits using ISO4217 format (default)
+Money.new(1.00, 'USD').subunits                    # => 100
+Money.new(1.00, 'ISK').subunits                    # => 1
+
+# Convert to subunits using Stripe format
+Money.new(1.00, 'ISK').subunits(format: :stripe)   # => 100
+
+# Convert from subunits
+Money.from_subunits(100, 'ISK', format: :stripe)                    # => Money.new(1.00, 'ISK')
+```
+
+#### Custom Converters
+You can create your own converter by subclassing `Money::Converters::Converter`:
+
+```ruby
+class MyCustomConverter < Money::Converters::Converter
+  def subunit_to_unit(currency)
+    # Your custom logic here
+    1000
+  end
+end
+
+# Register your converter
+Money::Converters.register(:my_format, MyCustomConverter)
+
+# Use your converter
+Money.new(1.00, 'USD').subunits(format: :my_format) # => 1000
+```
+
 ## Money column
 
 Since money internally uses BigDecimal it's logical to use a `decimal` column

data/lib/money/config.rb

@@ -41,7 +41,7 @@ class Money
       end
     end
 
-    attr_accessor :legacy_json_format, :legacy_deprecations, :experimental_crypto_currencies
+    attr_accessor :legacy_json_format, :legacy_deprecations, :experimental_crypto_currencies, :default_subunit_format
 
     attr_reader :default_currency
     alias_method :currency, :default_currency
@@ -80,6 +80,7 @@ class Money
       @legacy_json_format = false
       @legacy_deprecations = false
       @experimental_crypto_currencies = false
+      @default_subunit_format = :iso4217
     end
   end
 end

data/lib/money/converters/converter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Money
+  module Converters
+    class Converter
+      def to_subunits(money)
+        raise ArgumentError, "money cannot be nil" if money.nil?
+        (money.value * subunit_to_unit(money.currency)).to_i
+      end
+
+      def from_subunits(subunits, currency)
+        currency = Helpers.value_to_currency(currency)
+        value = Helpers.value_to_decimal(subunits) / subunit_to_unit(currency)
+        Money.new(value, currency)
+      end
+
+      protected
+
+      def subunit_to_unit(currency)
+        raise NotImplementedError, "subunit_to_unit method must be implemented in subclasses"
+      end
+    end
+  end
+end

data/lib/money/converters/factory.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Money
+  module Converters
+    class << self
+      def subunit_converters
+        @subunit_converters ||= {}
+      end
+
+      def register(key, klass)
+        subunit_converters[key.to_sym] = klass
+      end
+
+      def for(format)
+        format ||= Money::Config.current.default_subunit_format
+
+        if (klass = subunit_converters[format.to_sym])
+          klass.new
+        else
+          raise(ArgumentError, "unknown format: '#{format}'")
+        end
+      end
+    end
+  end
+end

data/lib/money/converters/iso4217_converter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Money
+  module Converters
+    class Iso4217Converter < Converter
+      def subunit_to_unit(currency)
+        currency.subunit_to_unit
+      end
+    end
+  end
+end
+Money::Converters.register(:iso4217, Money::Converters::Iso4217Converter)

data/lib/money/converters/legacy_dollars_converter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Money
+  module Converters
+    class LegacyDollarsConverter < Converter
+      def subunit_to_unit(currency)
+        100
+      end
+    end
+  end
+end
+Money::Converters.register(:legacy_dollar, Money::Converters::LegacyDollarsConverter)

data/lib/money/converters/stripe_converter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Money
+  module Converters
+    class StripeConverter < Iso4217Converter
+      SUBUNIT_TO_UNIT = {
+        # https://docs.stripe.com/currencies#special-cases
+        'ISK' => 100,
+        'UGX' => 100,
+        'HUF' => 100,
+        'TWD' => 100,
+        # https://docs.stripe.com/currencies#zero-decimal
+        'BIF' => 1,
+        'CLP' => 1,
+        'DJF' => 1,
+        'GNF' => 1,
+        'JPY' => 1,
+        'KMF' => 1,
+        'KRW' => 1,
+        'MGA' => 1,
+        'PYG' => 1,
+        'RWF' => 1,
+        'VND' => 1,
+        'VUV' => 1,
+        'XAF' => 1,
+        'XOF' => 1,
+        'XPF' => 1,
+        'USDC' => 1_000_000,
+      }.freeze
+
+      def subunit_to_unit(currency)
+        SUBUNIT_TO_UNIT.fetch(currency.iso_code, super)
+      end
+    end
+  end
+end
+Money::Converters.register(:stripe, Money::Converters::StripeConverter)

data/lib/money/helpers.rb

@@ -9,12 +9,6 @@ class Money
     DECIMAL_ZERO = BigDecimal(0).freeze
     MAX_DECIMAL = 21
 
-    STRIPE_SUBUNIT_OVERRIDE = {
-      'ISK' => 100,
-      'UGX' => 100,
-      'USDC' => 1_000_000,
-    }.freeze
-
     def value_to_decimal(num)
       value =
         case num

data/lib/money/money.rb

@@ -87,19 +87,8 @@ class Money
     end
     alias_method :from_amount, :new
 
-    def from_subunits(subunits, currency_iso, format: :iso4217)
-      currency = Helpers.value_to_currency(currency_iso)
-
-      subunit_to_unit_value = if format == :iso4217
-        currency.subunit_to_unit
-      elsif format == :stripe
-        Helpers::STRIPE_SUBUNIT_OVERRIDE.fetch(currency.iso_code, currency.subunit_to_unit)
-      else
-        raise ArgumentError, "unknown format #{format}"
-      end
-
-      value = Helpers.value_to_decimal(subunits) / subunit_to_unit_value
-      new(value, currency)
+    def from_subunits(subunits, currency_iso, format: nil)
+      Converters.for(format).from_subunits(subunits, currency_iso)
     end
 
     def from_json(string)
@@ -160,16 +149,8 @@ class Money
     coder['currency'] = @currency.iso_code
   end
 
-  def subunits(format: :iso4217)
-    subunit_to_unit_value = if format == :iso4217
-      @currency.subunit_to_unit
-    elsif format == :stripe
-      Helpers::STRIPE_SUBUNIT_OVERRIDE.fetch(@currency.iso_code, @currency.subunit_to_unit)
-    else
-      raise ArgumentError, "unknown format #{format}"
-    end
-
-    (@value * subunit_to_unit_value).to_i
+  def subunits(format: nil)
+    Converters.for(format).to_subunits(self)
   end
 
   def no_currency?

data/lib/money/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Money
-  VERSION = "3.2.0"
+  VERSION = "3.2.1"
 end

data/lib/money.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
 require_relative 'money/version'
-require_relative 'money/parser/fuzzy'
-require_relative 'money/helpers'
 require_relative 'money/currency'
 require_relative 'money/null_currency'
 require_relative 'money/allocator'
 require_relative 'money/splitter'
 require_relative 'money/config'
 require_relative 'money/money'
+require_relative 'money/converters/factory'
+require_relative 'money/converters/converter'
+require_relative 'money/converters/iso4217_converter'
+require_relative 'money/converters/stripe_converter'
+require_relative 'money/converters/legacy_dollars_converter'
 require_relative 'money/errors'
 require_relative 'money/deprecations'
+require_relative 'money/parser/fuzzy'
 require_relative 'money/parser/accounting'
-require_relative 'money/parser/locale_aware'
 require_relative 'money/parser/simple'
+require_relative 'money/parser/locale_aware'
+require_relative 'money/helpers'
 require_relative 'money/core_extensions'
 require_relative 'money_column' if defined?(ActiveRecord)
 require_relative 'money/railtie' if defined?(Rails::Railtie)

data/lib/money_column/active_record_hooks.rb

@@ -57,9 +57,8 @@ module MoneyColumn
       end
 
       if options[:currency_read_only]
-        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}."
+        unless compatible_currency?(money, options)
+          msg = "Cannot update #{column}: Attempting to write a money with currency #{money.currency} to a record with currency #{currency}. If you do want to change the currency, either remove `currency_read_only` or update the record's currency manually"
           if Money::Config.current.legacy_deprecations
             Money.deprecate(msg)
           else
@@ -73,6 +72,22 @@ module MoneyColumn
       self[column] = money.value
     end
 
+    def compatible_currency?(money, options)
+      currency_column = options[:currency_column]
+      currency = options[:currency] ||
+        @money_raw_new_attributes[currency_column.to_sym] ||
+        try(currency_column)
+
+      currency.nil? || money.currency.compatible?(Money::Helpers.value_to_currency(currency))
+    end
+
+    def _assign_attributes(new_attributes)
+      @money_raw_new_attributes = new_attributes.symbolize_keys
+      super
+    ensure
+      @money_raw_new_attributes = nil
+    end
+
     module ClassMethods
       attr_reader :money_column_options
 

data/money.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |s|
 
   s.metadata['allowed_push_host'] = "https://rubygems.org"
 
+  s.add_dependency("bigdecimal", ">= 3.0")
+
   s.add_development_dependency("bundler")
   s.add_development_dependency("database_cleaner", "~> 2.0")
   s.add_development_dependency("ostruct")

data/spec/converters_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Money::Converters do
+  let(:usd) { Money::Currency.find!('USD') }
+  let(:ugx) { Money::Currency.find!('UGX') }
+
+  describe '.for' do
+    it 'returns Iso4217Converter for :iso4217' do
+      expect(Money::Converters.for(:iso4217)).to be_a(Money::Converters::Iso4217Converter)
+    end
+
+    it 'returns StripeConverter for :stripe' do
+      expect(Money::Converters.for(:stripe)).to be_a(Money::Converters::StripeConverter)
+    end
+
+    it 'returns LegacyDollarsConverter for :legacy_dollar' do
+      expect(Money::Converters.for(:legacy_dollar)).to be_a(Money::Converters::LegacyDollarsConverter)
+    end
+
+    it 'raises ArgumentError for unknown format' do
+      expect { Money::Converters.for(:unknown) }.to raise_error(ArgumentError, /unknown format/)
+    end
+  end
+
+  describe 'registering a custom converter' do
+    class DummyConverter < Money::Converters::Converter
+      def subunit_to_unit(currency); 42; end
+    end
+
+    class InvalidConverter < Money::Converters::Converter
+      # Intentionally not implementing subunit_to_unit
+    end
+
+    after { Money::Converters.subunit_converters.delete(:dummy) }
+
+    it 'registers and uses a custom converter' do
+      Money::Converters.register(:dummy, DummyConverter)
+      converter = Money::Converters.for(:dummy)
+      expect(converter).to be_a(DummyConverter)
+      expect(converter.to_subunits(Money.new(1, 'USD'))).to eq(42)
+    end
+
+    it 'raises NotImplementedError when subunit_to_unit is not implemented' do
+      Money::Converters.register(:invalid, InvalidConverter)
+      converter = Money::Converters.for(:invalid)
+      expect { converter.to_subunits(Money.new(1, 'USD')) }.to raise_error(NotImplementedError, "subunit_to_unit method must be implemented in subclasses")
+    end
+  end
+
+  describe Money::Converters::Iso4217Converter do
+    let(:converter) { described_class.new }
+    it 'uses currency.subunit_to_unit' do
+      expect(converter.to_subunits(Money.new(1, usd))).to eq(100)
+      expect(converter.from_subunits(100, usd)).to eq(Money.new(1, usd))
+    end
+  end
+
+  describe Money::Converters::StripeConverter do
+    let(:converter) { described_class.new }
+
+    it 'uses Stripe special cases' do
+      expect(converter.to_subunits(Money.new(1, ugx))).to eq(100)
+      expect(converter.from_subunits(100, ugx)).to eq(Money.new(1, ugx))
+      expect(converter.to_subunits(Money.new(1, usd))).to eq(100)
+      expect(converter.from_subunits(100, usd)).to eq(Money.new(1, usd))
+    end
+
+    it 'handles USDC if present' do
+      configure(experimental_crypto_currencies: true) do
+        expect(converter.to_subunits(Money.new(1, "usdc"))).to eq(1_000_000)
+        expect(converter.from_subunits(1_000_000, "usdc")).to eq(Money.new(1, "usdc"))
+      end
+    end
+  end
+
+  describe Money::Converters::LegacyDollarsConverter do
+    let(:converter) { described_class.new }
+    it 'always uses 100 as subunit_to_unit' do
+      expect(converter.to_subunits(Money.new(1, usd))).to eq(100)
+      expect(converter.from_subunits(100, usd)).to eq(Money.new(1, usd))
+    end
+  end
+end

data/spec/money_column_spec.rb

@@ -412,4 +412,19 @@ RSpec.describe 'MoneyColumn' do
       expect(record.price.currency.to_s).to eq('GBP')
     end
   end
+
+  describe 'updating amount and currency simultaneously' do
+    let(:record) { MoneyWithReadOnlyCurrency.create!(currency: "CAD") }
+
+    it 'allows updating both amount and currency at the same time' do
+      record.update!(
+        price: Money.new(10, 'USD'),
+        currency: 'USD'
+      )
+      record.reload
+      expect(record.price.value).to eq(10)
+      expect(record.price.currency.to_s).to eq('USD')
+      expect(record.currency).to eq('USD')
+    end
+  end
 end

data/spec/money_spec.rb

@@ -167,6 +167,13 @@ RSpec.describe "Money" do
     expect(Money.new("999999999999999999.99", "USD").to_s).to eq("999999999999999999.99")
   end
 
+  it "to_fs formats with correct decimal places" do
+    expect(amount_money.to_fs).to eq("1.23")
+    expect(non_fractional_money.to_fs).to eq("1")
+    expect(Money.new(1.2345, 'USD').to_fs).to eq("1.23")
+    expect(Money.new(1.2345, 'BHD').to_fs).to eq("1.235")
+  end
+
   it "to_fs raises ArgumentError on unsupported style" do
     expect{ money.to_fs(:some_weird_style) }.to raise_error(ArgumentError)
   end
@@ -758,6 +765,12 @@ RSpec.describe "Money" do
         expect(Money.new(1, 'UGX').subunits(format: :stripe)).to eq(100)
       end
 
+      it 'overrides the subunit_to_unit amount for USDC' do
+        configure(experimental_crypto_currencies: true) do
+          expect(Money.from_subunits(500000, "USDC", format: :stripe)).to eq(Money.new(0.50, 'USDC'))
+        end
+      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
@@ -1185,4 +1198,40 @@ RSpec.describe "Money" do
       expect(Money.current_currency.iso_code).to eq("USD")
     end
   end
+
+  describe 'from_subunits' do
+    it 'creates money from subunits using ISO4217 format' do
+      expect(Money.from_subunits(100, 'USD')).to eq(Money.new(1.00, 'USD'))
+      expect(Money.from_subunits(10, 'JPY')).to eq(Money.new(10, 'JPY'))
+    end
+
+    it 'creates money from subunits using custom format' do
+      expect(Money.from_subunits(100, 'USD', format: :iso4217)).to eq(Money.new(1.00, 'USD'))
+      expect(Money.from_subunits(100, 'USD', format: :stripe)).to eq(Money.new(1.00, 'USD'))
+    end
+
+    it 'raises error for unknown format' do
+      expect {
+        Money.from_subunits(100, 'USD', format: :unknown)
+      }.to raise_error(ArgumentError, /unknown format/)
+    end
+  end
+
+  describe 'subunits' do
+    it 'converts money to subunits using ISO4217 format' do
+      expect(Money.new(1.00, 'USD').subunits).to eq(100)
+      expect(Money.new(10, 'JPY').subunits).to eq(10)
+    end
+
+    it 'converts money to subunits using custom format' do
+      expect(Money.new(1.00, 'USD').subunits(format: :iso4217)).to eq(100)
+      expect(Money.new(1.00, 'USD').subunits(format: :stripe)).to eq(100)
+    end
+
+    it 'raises error for unknown format' do
+      expect {
+        Money.new(1.00, 'USD').subunits(format: :unknown)
+      }.to raise_error(ArgumentError, /unknown format/)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Shopify Inc
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,11 @@ files:
 - lib/money.rb
 - lib/money/allocator.rb
 - lib/money/config.rb
+- lib/money/converters/converter.rb
+- lib/money/converters/factory.rb
+- lib/money/converters/iso4217_converter.rb
+- lib/money/converters/legacy_dollars_converter.rb
+- lib/money/converters/stripe_converter.rb
 - lib/money/core_extensions.rb
 - lib/money/currency.rb
 - lib/money/currency/loader.rb
@@ -164,6 +183,7 @@ files:
 - money.gemspec
 - spec/allocator_spec.rb
 - spec/config_spec.rb
+- spec/converters_spec.rb
 - spec/core_extensions_spec.rb
 - spec/currency/loader_spec.rb
 - spec/currency_spec.rb