shopify-money 0.14.6 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1059640a2227392fc00f7292905bd4d4de2a71d075e8ffc1fb4d02944c5c8c2
-  data.tar.gz: 80db4d470ef80c27c09937b7fa146827d4183c519418a8382934e9a1875fd5f7
+  metadata.gz: ddeb1f02ca7fda02ed007433687bf2fdbce36e9b11d64724753cf2e2420507c0
+  data.tar.gz: de0de61cbe5c6ae02b2fbf333e4136edbfcd1c2388441c219ffb1a00e2d0a963
 SHA512:
-  metadata.gz: 2f8cf9b8ac4fafc4a372176ebe0e46d3b29c8fc82caf020f16732eef39d80ee3f35005faea7c9a96253791c9ce2c836776ca91dc31d55713bc577af55407eed2
-  data.tar.gz: d484b008600973688c52d232797e9ebb1efa6e782b33b8fa408853c08d35f96d8fde50c353ea53c9d9350378fd4f0390d579b619bef45b0f28d0fbe2d7e7c8b6
+  metadata.gz: 86ef224eb66a9d8d6249b921cdd9162594babac0e5fa7525f2e9e5125ad94ab02e395bef9af508d4f6d08622d2c3fa6628b902aac3de803ef81fd30fcae0464c
+  data.tar.gz: 7332ed67b6d7389123131538c7c05faae5b9e67a4b77ae66c21f0d2bbd7031f4994576fdaa14c54294ad2969c70ffe1e70958528f16116e944fa6457d5c80d6e

data/.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: tests
+
+on: [push, pull_request]
+  
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ['2.6', '2.7', '3.0']
+
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run tests
+      run: |
+        bundle exec rake

data/README.md

@@ -1,6 +1,6 @@
 # money
 
-[![Build Status](https://travis-ci.org/Shopify/money.svg?branch=master)](https://travis-ci.org/Shopify/money)
+[![tests](https://github.com/Shopify/money/workflows/tests/badge.svg)](https://github.com/Shopify/money/actions?query=workflow%3Atests+branch%3Amaster)
 
 
 money_column expects a DECIMAL(21,3) database field.
@@ -20,6 +20,10 @@ money_column expects a DECIMAL(21,3) database field.
 
     gem 'shopify-money', require: 'money'
 
+## Upgrading to v1.0
+
+see instructions and breaking changes: https://github.com/Shopify/money/blob/master/UPGRADING.md
+
 ## Usage
 
 ``` ruby
@@ -77,7 +81,9 @@ By default `Money` defaults to Money::NullCurrency as its currency. This is a
 global variable that can be changed using:
 
 ``` ruby
-Money.default_currency = Money::Currency.new("USD")
+Money.configure do |config|
+  config.default_currency = Money::Currency.new("USD")
+end
 ```
 
 In web apps you might want to set the default currency on a per request basis.

data/UPGRADING.md

@@ -0,0 +1,57 @@
+## Upgrading to v1.0
+
+In an initializer add the following
+```ruby
+Money.configure do |config|
+  config.legacy_default_currency!
+  config.legacy_deprecations!
+  config.legacy_json_format!
+  #...
+end
+```
+
+Remove each legacy setting making sure your app functions as expected.
+
+### Legacy support
+
+#### legacy_default_currency!
+
+By enabling this setting your app will accept money object that are missing a currency
+
+```ruby
+Money.new(1) #=> value: 1, currency: XXX
+```
+
+#### legacy_deprecations!
+
+invalid money values return zero
+```ruby
+Money.new('a', 'USD') #=> Money.new(0, 'USD')
+```
+
+invalid currency is ignored
+```ruby
+Money.new(1, 'ABCD') #=> Money.new(1)
+```
+
+mathematical operations between objects are allowed
+```ruby
+Money.new(1, 'USD') + Money.new(1, 'CAD') #=> Money.new(2, 'USD')
+```
+
+parsing a string with invalid delimiters
+```ruby
+Money.parse('123*12') #=> Money.new(123)
+```
+
+#### legacy_json_format!
+
+to_json will return only the value (no currency)
+```ruby
+# with legacy_json_format!
+money.to_json #=> "1"
+
+# without
+money.to_json #=> { value: 1, currency: 'USD' }
+```
+

data/config/currency_historic.yml

@@ -29,7 +29,7 @@ eek:
   smallest_denomination: 5
 ghc:
   priority: 100
-  iso_code: GHS
+  iso_code: GHC
   name: Ghanaian Cedi
   symbol: "₵"
   disambiguate_symbol: GH₵

data/lib/money.rb

@@ -4,12 +4,12 @@ require_relative 'money/helpers'
 require_relative 'money/currency'
 require_relative 'money/null_currency'
 require_relative 'money/allocator'
+require_relative 'money/config'
 require_relative 'money/money'
 require_relative 'money/errors'
 require_relative 'money/deprecations'
 require_relative 'money/accounting_money_parser'
 require_relative 'money/core_extensions'
-require_relative 'money_accessor'
 require_relative 'money_column' if defined?(ActiveRecord)
 
 require_relative 'rubocop/cop/money' if defined?(RuboCop)

data/lib/money/allocator.rb

@@ -7,6 +7,8 @@ class Money
       super
     end
 
+    ONE = BigDecimal("1")
+
     # Allocates money between different parties without losing pennies.
     # After the mathematically split has been performed, left over pennies will
     # be distributed round-robin amongst the parties. This means that parties
@@ -43,7 +45,7 @@ class Money
       splits.map!(&:to_r)
       allocations = splits.inject(0, :+)
 
-      if (allocations - BigDecimal("1")) > Float::EPSILON
+      if (allocations - ONE) > Float::EPSILON
         raise ArgumentError, "splits add to more than 100%"
       end
 

data/lib/money/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Money
+  class Config
+    attr_accessor :parser, :default_currency, :legacy_json_format, :legacy_deprecations
+
+    def legacy_default_currency!
+      @default_currency ||= Money::NULL_CURRENCY
+    end
+
+    def legacy_deprecations!
+      @legacy_deprecations = true
+    end
+
+    def legacy_json_format!
+      @legacy_json_format = true
+    end
+
+    def initialize
+      @parser = MoneyParser
+      @default_currency = nil
+      @legacy_json_format = false
+      @legacy_deprecations = false
+    end
+  end
+end

data/lib/money/currency.rb

@@ -50,6 +50,10 @@ class Money
       self.class == other.class && iso_code == other.iso_code
     end
 
+    def hash
+      [ self.class, iso_code ].hash
+    end
+
     def compatible?(other)
       other.is_a?(NullCurrency) || eql?(other)
     end

data/lib/money/helpers.rb

@@ -8,6 +8,10 @@ class Money
     DECIMAL_ZERO = BigDecimal(0).freeze
     MAX_DECIMAL = 21
 
+    STRIPE_SUBUNIT_OVERRIDE = {
+      'ISK' => 100,
+    }.freeze
+
     def value_to_decimal(num)
       value =
         case num
@@ -24,7 +28,7 @@ class Money
         when Rational
           BigDecimal(num, MAX_DECIMAL)
         when String
-          decimal = BigDecimal(num, exception: false)
+          decimal = BigDecimal(num, exception: !Money.config.legacy_deprecations)
           return decimal if decimal
 
           Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
@@ -42,7 +46,7 @@ class Money
         currency
       when nil, ''
         default = Money.current_currency || Money.default_currency
-        raise(ArgumentError, 'missing currency') if default.nil? || default == ''
+        raise(Money::Currency::UnknownCurrency, 'missing currency') if default.nil? || default == ''
         value_to_currency(default)
       when 'xxx', 'XXX'
         Money::NULL_CURRENCY
@@ -50,8 +54,12 @@ class Money
         begin
           Currency.find!(currency)
         rescue Money::Currency::UnknownCurrency => error
-          Money.deprecate(error.message)
-          Money::NULL_CURRENCY
+          if Money.config.legacy_deprecations
+            Money.deprecate(error.message)
+            Money::NULL_CURRENCY
+          else
+            raise error
+          end
         end
       else
         raise ArgumentError, "could not parse as currency #{currency.inspect}"

data/lib/money/money.rb

@@ -11,7 +11,14 @@ class Money
   def_delegators :@value, :zero?, :nonzero?, :positive?, :negative?, :to_i, :to_f, :hash
 
   class << self
-    attr_accessor :parser, :default_currency
+    extend Forwardable
+    attr_accessor :config
+    def_delegators :@config, :parser, :parser=, :default_currency, :default_currency=
+
+    def configure
+      self.config ||= Config.new
+      yield(config) if block_given?
+    end
 
     def new(value = 0, currency = nil)
       value = Helpers.value_to_decimal(value)
@@ -26,22 +33,22 @@ class Money
     end
     alias_method :from_amount, :new
 
-    def zero(currency = NULL_CURRENCY)
-      new(0, currency)
-    end
-    alias_method :empty, :zero
-
     def parse(*args, **kwargs)
       parser.parse(*args, **kwargs)
     end
 
-    def from_cents(cents, currency = nil)
-      new(cents.round.to_f / 100, currency)
-    end
-
-    def from_subunits(subunits, currency_iso)
+    def from_subunits(subunits, currency_iso, format: :iso4217)
       currency = Helpers.value_to_currency(currency_iso)
-      value = Helpers.value_to_decimal(subunits) / currency.subunit_to_unit
+
+      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)
     end
 
@@ -73,18 +80,13 @@ class Money
         Money.current_currency = old_currency
       end
     end
-
-    def default_settings
-      self.parser = MoneyParser
-      self.default_currency = Money::NULL_CURRENCY
-    end
   end
-  default_settings
+  configure
 
   def initialize(value, currency)
     raise ArgumentError if value.nan?
     @currency = Helpers.value_to_currency(currency)
-    @value = value.round(@currency.minor_units)
+    @value = BigDecimal(value.round(@currency.minor_units))
     freeze
   end
 
@@ -97,13 +99,16 @@ class Money
     coder['currency'] = @currency.iso_code
   end
 
-  def cents
-    # Money.deprecate('`money.cents` is deprecated and will be removed in the next major release. Please use `money.subunits` instead. Keep in mind, subunits are currency aware.')
-    (value * 100).to_i
-  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
 
-  def subunits
-    (@value * @currency.subunit_to_unit).to_i
+    (@value * subunit_to_unit_value).to_i
   end
 
   def no_currency?
@@ -135,7 +140,11 @@ class Money
 
   def *(numeric)
     unless numeric.is_a?(Numeric)
-      Money.deprecate("Multiplying Money with #{numeric.class.name} is deprecated and will be removed in the next major release.")
+      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
     Money.new(value.to_r * numeric, currency)
   end
@@ -195,8 +204,12 @@ class Money
 
     curr = Helpers.value_to_currency(curr)
     unless currency.compatible?(curr)
-      Money.deprecate("mathematical operation not permitted for Money objects with different currencies #{curr} and #{currency}. " \
-        "A Money::IncompatibleCurrencyError will raise in the next major release")
+      msg = "mathematical operation not permitted for Money objects with different currencies #{curr} 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
     end
 
     self
@@ -226,16 +239,20 @@ class Money
     end
   end
 
-  def to_liquid
-    cents
-  end
-
   def to_json(options = {})
-    to_s
+    if options.delete(:legacy_format) || Money.config.legacy_json_format
+      to_s
+    else
+      as_json(options).to_json
+    end
   end
 
-  def as_json(*args)
-    to_s
+  def as_json(options = {})
+    if options.delete(:legacy_format) || Money.config.legacy_json_format
+      to_s
+    else
+      { value: to_s(:amount), currency: currency.to_s }
+    end
   end
 
   def abs

data/lib/money/money_parser.rb

@@ -82,9 +82,12 @@ class MoneyParser
     number = number.to_s.strip
 
     if number.empty?
-      raise MoneyFormatError, "invalid money string: #{input}" if strict
-      Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
-      return '0'
+      if Money.config.legacy_deprecations && !strict
+        Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
+        return '0'
+      else
+        raise MoneyFormatError, "invalid money string: #{input}"
+      end
     end
 
     marks = number.scan(/[#{ESCAPED_MARKS}]/).flatten
@@ -107,8 +110,11 @@ class MoneyParser
       return amount.tr(ESCAPED_NON_COMMA_MARKS, '').sub(',', '.')
     end
 
-    raise MoneyFormatError, "invalid money string: #{input}" if strict
-    Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
+    if Money.config.legacy_deprecations && !strict
+      Money.deprecate("invalid money strings will raise in the next major release \"#{input}\"")
+    else
+      raise MoneyFormatError, "invalid money string: #{input}"
+    end
 
     normalize_number(number, marks, currency)
   end

data/lib/money/null_currency.rb

@@ -1,5 +1,36 @@
 # frozen_string_literal: true
 class Money
+  # A placeholder currency for instances where no actual currency is available,
+  # as defined by ISO4217. You should rarely, if ever, need to use this
+  # directly. It's here mostly for backwards compatibility and for that reason
+  # behaves like a dollar, which is how this gem worked before the introduction
+  # of currency.
+  #
+  # Here follows a list of preferred alternatives over using Money with
+  # NullCurrency:
+  #
+  # For comparisons where you don't know the currency beforehand, you can use
+  # Numeric predicate methods like #positive?/#negative?/#zero?/#nonzero?.
+  # Comparison operators with Numeric (==, !=, <=, =>, <, >) work as well.
+  #
+  # @example
+  #   Money.new(1, 'CAD').positive? #=> true
+  #   Money.new(2, 'CAD') >= 0      #=> true
+  #
+  # Money with NullCurrency has behaviour that may surprise you, such as
+  # database validations or GraphQL enum not allowing the string representation
+  # of NullCurrency. Prefer using Money.new(0, currency) where possible, as
+  # this sidesteps these issues and provides additional currency check
+  # safeties.
+  #
+  # Unlike other currencies, it is allowed to calculate a Money object with
+  # NullCurrency with another currency. The resulting Money object will have
+  # the other currency.
+  #
+  # @example
+  #   Money.new(0, Money::NULL_CURRENCY) + Money.new(5, 'CAD')
+  #   #=> #<Money value:5.00 currency:CAD>
+  #
   class NullCurrency
 
     attr_reader :iso_code, :iso_numeric, :name, :smallest_denomination, :subunit_symbol,
@@ -9,7 +40,7 @@ class Money
       @symbol                = '$'
       @disambiguate_symbol   = nil
       @subunit_symbol        = nil
-      @iso_code              = 'XXX' # Valid ISO4217
+      @iso_code              = 'XXX'
       @iso_numeric           = '999'
       @name                  = 'No Currency'
       @smallest_denomination = 1