shopify-money 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03fea29a7733cd7ac14493fff381a197b42a16de9369c8a15b0bba9905f7a8a0
-  data.tar.gz: '025213910adf2f5090dfb7afaa85f715f05515094e15f14c25b5805eaef569eb'
+  metadata.gz: c927d4e18e7362a5ad3ddfb642785343d4f504f804b61e0bdac87f410a323c6e
+  data.tar.gz: 6eaa57e295c85d1d94e271a8cda1a7fa0f702198878e6087b25b17ea651bf38a
 SHA512:
-  metadata.gz: dad64b959edcde085fc92904dd442babdc33122c7b2c30b91e204e597fd38e547ccf62c3e6881d78d1a2b2005581d27dcad1177b1d64ae066d2bfbafabe89cb5
-  data.tar.gz: 2047c647afe7e4a9b373997184bde9c1a84e47e410571531266fc60075a99da1a65ec4de685c6e79fd852e7de61af427a40440e317ad8a13014a8cc4ccd4f372
+  metadata.gz: 76a3752201eec5bceba4252233a754114de80c3e4e223af5fb2ee9f52b86c280436d55b52457b0d972451392b394aaca40c1240d47535e6c9b24d59f0f0e6dbb
+  data.tar.gz: e4ec1cd96dd48a5ca060cf773843f834c97a8be50eb0d0b55e390556966d439d5aab597a2af9ab139a7008a714fb7c9f20168dac081436b2fb5091e1be602a7d

data/.github/dependabot.yml

@@ -1,5 +1,9 @@
 version: 2
 updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
   - package-ecosystem: bundler
     directory: "/"
     schedule:

data/.github/workflows/tests.yml

@@ -13,12 +13,12 @@ jobs:
 
     name: Ruby ${{ matrix.ruby }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@e34163cd15f4bb403dcd72d98e295997e6a55798 # v1.238.0
       with:
         ruby-version: ${{ matrix.ruby }}
-    - uses: actions/cache@v4
+    - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
       with:
         path: vendor/bundle
         key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}

data/Gemfile.lock

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

data/lib/money/config.rb

@@ -2,7 +2,62 @@
 
 class Money
   class Config
-    attr_accessor :default_currency, :legacy_json_format, :legacy_deprecations, :experimental_crypto_currencies
+    CONFIG_THREAD = :shopify_money__configs
+
+    class << self
+      def global
+        @config ||= new
+      end
+
+      def current
+        thread_local_config[Fiber.current.object_id] ||= global.dup
+      end
+
+      def current=(config)
+        thread_local_config[Fiber.current.object_id] = config
+      end
+
+      def configure_current(**configs, &block)
+        old_config = current.dup
+        current.tap do |config|
+          configs.each do |k, v|
+            config.public_send("#{k}=", v)
+          end
+        end
+        yield
+      ensure
+        self.current = old_config
+      end
+
+      def reset_current
+        thread_local_config.delete(Fiber.current.object_id)
+        Thread.current[CONFIG_THREAD] = nil if thread_local_config.empty?
+      end
+
+      private
+
+      def thread_local_config
+        Thread.current[CONFIG_THREAD] ||= {}
+      end
+    end
+
+    attr_accessor :legacy_json_format, :legacy_deprecations, :experimental_crypto_currencies
+
+    attr_reader :default_currency
+    alias_method :currency, :default_currency
+
+    def default_currency=(value)
+      @default_currency =
+        case value
+        when String
+          Currency.find!(value)
+        when Money::Currency, Money::NullCurrency, nil
+          value
+        else
+          raise ArgumentError, "Invalid currency"
+        end
+    end
+    alias_method :currency=, :default_currency=
 
     def legacy_default_currency!
       @default_currency ||= Money::NULL_CURRENCY
@@ -26,13 +81,5 @@ class Money
       @legacy_deprecations = false
       @experimental_crypto_currencies = false
     end
-
-    def without_legacy_deprecations(&block)
-      old_legacy_deprecations = @legacy_deprecations
-      @legacy_deprecations = false
-      yield
-    ensure
-      @legacy_deprecations = old_legacy_deprecations
-    end
   end
 end

data/lib/money/core_extensions.rb

@@ -17,7 +17,7 @@ class String
   def to_money(currency = nil)
     currency = Money::Helpers.value_to_currency(currency)
 
-    unless Money.config.legacy_deprecations
+    unless Money::Config.current.legacy_deprecations
       return Money.new(self, currency)
     end
 

data/lib/money/currency.rb

@@ -30,6 +30,10 @@ class Money
       def crypto_currencies
         @@crypto_currencies ||= Loader.load_crypto_currencies
       end
+
+      def reset_loaded_currencies
+        @@loaded_currencies = {}
+      end
     end
 
     attr_reader :iso_code,
@@ -45,7 +49,10 @@ class Money
 
     def initialize(currency_iso)
       data = self.class.currencies[currency_iso]
-      data = self.class.crypto_currencies[currency_iso] if data.nil? && Money.config.experimental_crypto_currencies
+      if data.nil? && Money::Config.current.experimental_crypto_currencies
+        data = self.class.crypto_currencies[currency_iso]
+      end
+
       raise UnknownCurrency, "Invalid iso4217 currency '#{currency_iso}'" unless data
       @symbol                = data['symbol']
       @disambiguate_symbol   = data['disambiguate_symbol'] || data['symbol']

data/lib/money/helpers.rb

@@ -44,7 +44,7 @@ class Money
       when Money::Currency, Money::NullCurrency
         currency
       when nil, ''
-        default = Money.current_currency || Money.default_currency
+        default = Money::Config.current.currency
         raise(Money::Currency::UnknownCurrency, 'missing currency') if default.nil? || default == ''
         value_to_currency(default)
       when 'xxx', 'XXX'
@@ -53,7 +53,7 @@ class Money
         begin
           Currency.find!(currency)
         rescue Money::Currency::UnknownCurrency => error
-          if Money.config.legacy_deprecations
+          if Money::Config.current.legacy_deprecations
             Money.deprecate(error.message)
             Money::NULL_CURRENCY
           else

data/lib/money/money.rb

@@ -39,19 +39,37 @@ class Money
 
   class << self
     extend Forwardable
-    def_delegators :config, :default_currency, :default_currency=, :without_legacy_deprecations
+    def_delegators :'Money::Config.global', :default_currency, :default_currency=
+
+    def without_legacy_deprecations(&block)
+      with_config(legacy_deprecations: false, &block)
+    end
+
+    def with_config(**configs, &block)
+      Money::Config.configure_current(**configs, &block)
+    end
 
     def config
-      Thread.current[:shopify_money__config] ||= @config.dup
+      Money::Config.global
     end
 
-    def config=(config)
-      Thread.current[:shopify_money__config] = config
+    def configure(&block)
+      Money::Config.global.tap(&block)
     end
 
-    def configure
-      @config ||= Config.new
-      yield(@config) if block_given?
+    def current_currency
+      Money::Config.current.currency
+    end
+
+    def current_currency=(value)
+      Money::Config.current.currency = value
+    end
+
+    def with_currency(currency, &block)
+      if currency.nil?
+        currency = current_currency
+      end
+      with_config(currency: currency, &block)
     end
 
     def new(value = 0, currency = nil)
@@ -101,26 +119,6 @@ class Money
       end
     end
 
-    def current_currency
-      Thread.current[:money_currency]
-    end
-
-    def current_currency=(currency)
-      Thread.current[:money_currency] = currency
-    end
-
-    # Set Money.default_currency inside the supplied block, resets it to
-    # the previous value when done to prevent leaking state. Similar to
-    # I18n.with_locale and ActiveSupport's Time.use_zone. This won't affect
-    # instances being created with explicitly set currency.
-    def with_currency(new_currency)
-      old_currency = Money.current_currency
-      Money.current_currency = new_currency
-      yield
-    ensure
-      Money.current_currency = old_currency
-    end
-
     private
 
     def new_from_money(amount, currency)
@@ -137,7 +135,7 @@ class Money
       msg = "Money.new(Money.new(amount, #{amount.currency}), #{currency}) " \
         "is changing the currency of an existing money object"
 
-      if Money.config.legacy_deprecations
+      if Money::Config.current.legacy_deprecations
         Money.deprecate("#{msg}. A Money::IncompatibleCurrencyError will raise in the next major release")
         Money.new(amount.value, currency)
       else
@@ -145,7 +143,6 @@ class Money
       end
     end
   end
-  configure
 
   def initialize(value, currency)
     raise ArgumentError if value.nan?
@@ -286,7 +283,7 @@ class Money
   alias_method :to_formatted_s, :to_fs
 
   def to_json(options = nil)
-    if (options.is_a?(Hash) && options[:legacy_format]) || Money.config.legacy_json_format
+    if (options.is_a?(Hash) && options[:legacy_format]) || Money::Config.current.legacy_json_format
       to_s
     else
       as_json(options).to_json
@@ -294,7 +291,7 @@ class Money
   end
 
   def as_json(options = nil)
-    if (options.is_a?(Hash) && options[:legacy_format]) || Money.config.legacy_json_format
+    if (options.is_a?(Hash) && options[:legacy_format]) || Money::Config.current.legacy_json_format
       to_s
     else
       { value: to_s(:amount), currency: currency.to_s }
@@ -407,7 +404,7 @@ class Money
   def ensure_compatible_currency(other_currency, msg)
     return if currency.compatible?(other_currency)
 
-    if Money.config.legacy_deprecations
+    if Money::Config.current.legacy_deprecations
       Money.deprecate("#{msg}. A Money::IncompatibleCurrencyError will raise in the next major release")
     else
       raise Money::IncompatibleCurrencyError, msg

data/lib/money/version.rb

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

data/lib/money_column/active_record_hooks.rb

@@ -60,7 +60,7 @@ module MoneyColumn
         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
+          if Money::Config.current.legacy_deprecations
             Money.deprecate(msg)
           else
             raise MoneyColumn::CurrencyReadOnlyError, msg

data/spec/config_spec.rb

@@ -3,27 +3,52 @@ require 'spec_helper'
 
 RSpec.describe "Money::Config" do
   describe 'thread safety' do
-    it 'does not share the same config across threads' do
+    it 'does not share the same config across fibers' do
       configure(legacy_deprecations: false, default_currency: 'USD') do
-        expect(Money.config.legacy_deprecations).to eq(false)
-        expect(Money.config.default_currency).to eq('USD')
-        thread = Thread.new do
-          Money.config.legacy_deprecations!
-          Money.default_currency = "EUR"
-          expect(Money.config.legacy_deprecations).to eq(true)
-          expect(Money.config.default_currency).to eq("EUR")
+        expect(Money::Config.current.legacy_deprecations).to eq(false)
+        expect(Money::Config.current.default_currency.to_s).to eq('USD')
+
+        fiber = Fiber.new do
+          Money::Config.current.legacy_deprecations!
+          Money::Config.current.default_currency = "EUR"
+
+          expect(Money::Config.current.legacy_deprecations).to eq(true)
+          expect(Money::Config.current.default_currency.to_s).to eq("EUR")
+
+          :fiber_completed
         end
-        thread.join
-        expect(Money.config.legacy_deprecations).to eq(false)
-        expect(Money.config.default_currency).to eq('USD')
+        # run the fiber
+        expect(fiber.resume).to eq(:fiber_completed)
+
+        # Verify main fiber's config was not affected
+        expect(Money::Config.current.legacy_deprecations).to eq(false)
+        expect(Money::Config.current.default_currency.to_s).to eq('USD')
       end
     end
+
+    it 'isolates configuration between threads' do
+      expect(Money::Config.current.legacy_deprecations).to eq(false)
+      expect(Money::Config.current.default_currency).to eq(Money::Currency.find!('CAD'))
+
+      thread = Thread.new do
+        Money::Config.current.legacy_deprecations!
+        Money::Config.current.default_currency = "EUR"
+
+        expect(Money::Config.current.legacy_deprecations).to eq(true)
+        expect(Money::Config.current.default_currency).to eq(Money::Currency.find!("EUR"))
+      end
+
+      thread.join
+
+      expect(Money::Config.current.legacy_deprecations).to eq(false)
+      expect(Money::Config.current.default_currency).to eq(Money::Currency.find!('CAD'))
+    end
   end
 
   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")
+        expect(Money::Config.current.default_currency.to_s).to eq("USD")
       end
     end
 
@@ -33,7 +58,7 @@ RSpec.describe "Money::Config" do
 
     it 'legacy_deprecations returns true when opting in to v1' do
       configure(legacy_deprecations: true) do
-        expect(Money.config.legacy_deprecations).to eq(true)
+        expect(Money::Config.current.legacy_deprecations).to eq(true)
       end
     end
 
@@ -45,30 +70,33 @@ RSpec.describe "Money::Config" do
 
     it 'legacy_deprecations defaults to NULL_CURRENCY' do
       configure(legacy_default_currency: true) do
-        expect(Money.config.default_currency).to eq(Money::NULL_CURRENCY)
+        expect(Money::Config.current.default_currency).to eq(Money::NULL_CURRENCY)
       end
     end
   end
 
   describe 'default_currency' do
     it 'defaults to nil' do
-      configure do
-        expect(Money.config.default_currency).to eq(nil)
-      end
+      expect(Money::Config.new.default_currency).to eq(nil)
     end
 
     it 'can be set to a new currency' do
       configure(default_currency: 'USD') do
-        expect(Money.config.default_currency).to eq('USD')
+        expect(Money::Config.current.default_currency.to_s).to eq('USD')
       end
     end
+
+    it 'raises ArgumentError for invalid currency' do
+      config = Money::Config.new
+      expect { config.default_currency = 123 }.to raise_error(ArgumentError, "Invalid currency")
+    end
   end
-  
+
   describe 'experimental_crypto_currencies' do
     it 'defaults to false' do
       expect(Money::Config.new.experimental_crypto_currencies).to eq(false)
     end
-    
+
     it 'can be set to true' do
       config = Money::Config.new
       config.experimental_crypto_currencies = true

data/spec/money_spec.rb

@@ -20,6 +20,15 @@ RSpec.describe "Money" do
     end
   end
 
+  it ".configure the config" do
+    config = Money::Config.new
+    allow(Money::Config).to receive(:global).and_return(config)
+
+    expect {
+      Money.configure { |c| c.default_currency = "USD" }
+    }.to change { config.default_currency }.from(nil).to(Money::Currency.find!("USD"))
+  end
+
   it ".zero has no currency" do
     expect(Money.new(0, Money::NULL_CURRENCY).currency).to be_a(Money::NullCurrency)
   end
@@ -1095,7 +1104,7 @@ RSpec.describe "Money" do
     end
   end
 
-  describe '#use_currency' do
+  describe '.with_currency' do
     it "allows setting the implicit default currency for a block scope" do
       money = nil
       Money.with_currency('CAD') do
@@ -1114,6 +1123,15 @@ RSpec.describe "Money" do
       expect(money.currency.iso_code).to eq('USD')
     end
 
+    it "accepts nil as currency" do
+      money = nil
+      Money.with_currency(nil) do
+        money = Money.new(1.00)
+      end
+      # uses the default currency
+      expect(money.currency.iso_code).to eq('CAD')
+    end
+
     context "with .default_currency set" do
       around(:each) { |test| configure(default_currency: Money::Currency.new('EUR')) { test.run }}
 
@@ -1159,4 +1177,12 @@ RSpec.describe "Money" do
       expect(money.currency.iso_code).to eq('EUR')
     end
   end
+
+  describe ".current_currency" do
+    it "gets and sets the current currency via Config.current" do
+      Money.current_currency = "USD"
+      expect(Money.default_currency.iso_code).to eq("CAD")
+      expect(Money.current_currency.iso_code).to eq("USD")
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -54,6 +54,8 @@ RSpec.configure do |config|
     DatabaseCleaner.cleaning do
       example.run
     end
+  ensure
+    Money::Config.reset_current
   end
 end
 
@@ -73,20 +75,18 @@ end
 
 
 def configure(default_currency: nil, legacy_json_format: nil, legacy_deprecations: nil, legacy_default_currency: nil, experimental_crypto_currencies: nil)
-  old_currencies = Money::Currency.class_variable_get(:@@loaded_currencies) rescue {}
-  Money::Currency.class_variable_set(:@@loaded_currencies, {})
-  old_config = Money.config
-  Money.config = Money::Config.new.tap do |config|
+  Money::Config.current = Money::Config.new.tap do |config|
     config.default_currency = default_currency if default_currency
     config.legacy_json_format! if legacy_json_format
     config.legacy_deprecations! if legacy_deprecations
     config.legacy_default_currency! if legacy_default_currency
     config.experimental_crypto_currencies! if experimental_crypto_currencies
   end
+  Money::Currency.reset_loaded_currencies if experimental_crypto_currencies == false
+
   yield
 ensure
-  Money::Currency.class_variable_set(:@@loaded_currencies, old_currencies)
-  Money.config = old_config
+  Money::Config.reset_current
 end
 
 def yaml_load(yaml)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Shopify Inc
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Shopify's money gem
 test_files: []