shopify-money 0.14.3 → 0.14.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8e01e6d1e01fca5740240f5a229ae89f9ab26a9f351ee3b3adfdfda2460d55
-  data.tar.gz: 04e697b1be43c759ee3a69febedc2b3d160b674c0c04e63a621ba7a0b59c77e4
+  metadata.gz: 186250af5f49f67f218ce8b30f47cd6c20ff762f9fdb2813ca9ffe1d12a7700d
+  data.tar.gz: 1e6ce179c120a2781dc0be48ee0377c4179e6dc07c8fd6306689947a0847daf4
 SHA512:
-  metadata.gz: cfdbc7082d679edf08bd54c397484255eb68227529a1d444b88d549f4bffe3d3c8abb8a29f387b1032aa4f9a8641c7126494972db231393053c4a40a8ec55324
-  data.tar.gz: 1ee9f16a6b1c2f7583dd907902ac9e45e309e18bc7f657f95756e5e62af9ded5725c317adfba9adef623c2e225702ee166736aa3e6253a5a8baae81a5678086c
+  metadata.gz: 3d2076a57d0b364a782ce10ffe8961e8ca57b535b8c12ba006887a92336902694ecf1a9b34538632bdad51ea3bbbf2e44aa15988344a406d16890168c72823a8
+  data.tar.gz: 8b539f90a996544a93fbb733dbde048460a4a5069e1efef6e44b63ae8e790dd6f90a407b7e4ae0fbbb2d850864b5015204ec8a4663b2d45673589611e16ce02b

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.

data/config/currency_historic.yml

@@ -43,6 +43,21 @@ ghc:
   thousands_separator: ","
   iso_numeric: '288'
   smallest_denomination: 1
+mro:
+  priority: 100
+  iso_code: MRO
+  name: Mauritanian Ouguiya
+  symbol: UM
+  disambiguate_symbol: MRO
+  alternate_symbols: []
+  subunit: Khoums
+  subunit_to_unit: 5
+  symbol_first: false
+  html_entity: ''
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: '478'
+  smallest_denomination: 1
 mtl:
   priority: 100
   iso_code: MTL
@@ -86,6 +101,20 @@ VEB:
   thousands_separator: "."
   iso_numeric: '862'
   smallest_denomination: 1
+vef:
+  priority: 100
+  iso_code: VEF
+  name: Venezuelan Bolívar fuerte
+  symbol: Bs.F.
+  alternate_symbols: []
+  subunit: Céntimo
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: ''
+  decimal_mark: ","
+  thousands_separator: "."
+  iso_numeric: '937'
+  smallest_denomination: 1
 zwd:
   priority: 100
   iso_code: ZWD

data/config/currency_iso.yml

@@ -1446,19 +1446,23 @@ mop:
   thousands_separator: ","
   iso_numeric: '446'
   smallest_denomination: 10
-mro:
+mru:
   priority: 100
-  iso_code: MRO
-  name: Mauritanian Ouguiya
+  iso_code: MRU
+  name: Mauritanian New Ouguiya
   symbol: UM
+  disambiguate_symbol: MRU
   alternate_symbols: []
   subunit: Khoums
-  subunit_to_unit: 5
+  # MRU actually has 5 Khoums per Ouguiya, but we treat it as if it has no subunits.
+  # We do this because the Khoum's value is so small that it's not likely to be relevant in an online transaction,
+  # and we suspect that, when our payment partners add support for MRU, they're likely to ignore subunits.
+  subunit_to_unit: 1
   symbol_first: false
   html_entity: ''
   decimal_mark: "."
   thousands_separator: ","
-  iso_numeric: '478'
+  iso_numeric: '929'
   smallest_denomination: 1
 mur:
   priority: 100
@@ -2300,11 +2304,11 @@ uzs:
   thousands_separator: ","
   iso_numeric: '860'
   smallest_denomination: 100
-vef:
+ves:
   priority: 100
-  iso_code: VEF
-  name: Venezuelan Bolívar fuerte
-  symbol: Bs.F.
+  iso_code: VES
+  name: Venezuelan Bolívar soberano
+  symbol: Bs.S.
   alternate_symbols: []
   subunit: Céntimo
   subunit_to_unit: 100
@@ -2312,8 +2316,11 @@ vef:
   html_entity: ''
   decimal_mark: ","
   thousands_separator: "."
-  iso_numeric: '937'
-  smallest_denomination: 1
+  iso_numeric: '928'
+  # "On 20 August 2018, [...] New coins in denominations of 50 céntimos and 1 bolívar soberano, and new banknotes
+  #  in denominations of 2, 5, 10, 20, 50, 100, 200 and 500 bolívares soberanos were introduced."
+  # Source: https://en.wikipedia.org/wiki/Venezuelan_bol%C3%ADvar
+  smallest_denomination: 50
 vnd:
   priority: 100
   iso_code: VND

data/config/currency_non_iso.yml

@@ -14,6 +14,25 @@ jep:
   thousands_separator: ","
   iso_numeric: ''
   smallest_denomination: 1
+kid:
+  # The Kiribati Dollar is pegged 1:1 to the AUD, but banknotes and coins in both currencies circulate interchangeably.
+  # "Although Kiribati retained 1 and 2 cents coins well after Australia demoted theirs,
+  #  redundancy and devaluation has slowly removed these coins from general circulation."
+  # Source:  https://en.wikipedia.org/wiki/Kiribati_dollar
+  priority: 100
+  iso_code: KID
+  name: Kiribati Dollar
+  symbol: "$"
+  disambiguate_symbol: KID
+  alternate_symbols: []
+  subunit: Cent
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: "$"
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: ''
+  smallest_denomination: 5
 ggp:
   priority: 100
   iso_code: GGP

data/lib/money/currency/loader.rb

@@ -30,7 +30,7 @@ class Money
           when String
             -data
           else
-            data.duplicable? ? data.freeze : data
+            data.freeze
           end
         end
       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

data/lib/money/money.rb

@@ -39,9 +39,18 @@ class Money
       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
 
@@ -84,7 +93,7 @@ class Money
   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
 
@@ -102,8 +111,16 @@ class Money
     (value * 100).to_i
   end
 
-  def subunits
-    (@value * @currency.subunit_to_unit).to_i
+  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
   end
 
   def no_currency?
@@ -207,11 +224,22 @@ class Money
   end
 
   def to_s(style = nil)
-    case style
+    units = case style
     when :legacy_dollars
-      sprintf("%.2f", value)
+      2
     when :amount, nil
-      sprintf("%.#{currency.minor_units}f", value)
+      currency.minor_units
+    else
+      raise ArgumentError, "Unexpected style: #{style}"
+    end
+
+    rounded_value = value.round(units)
+    if units == 0
+      sprintf("%d", rounded_value)
+    else
+      sign = rounded_value < 0 ? '-' : ''
+      rounded_value = rounded_value.abs
+      sprintf("%s%d.%0#{units}d", sign, rounded_value.truncate, rounded_value.frac * (10 ** units))
     end
   end
 

data/lib/money/version.rb

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

data/money.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.metadata['allowed_push_host'] = "https://rubygems.org"
 
-  s.add_development_dependency("bundler", ">= 1.5")
+  s.add_development_dependency("bundler")
   s.add_development_dependency("simplecov", ">= 0")
   s.add_development_dependency("rails", "~> 6.0")
   s.add_development_dependency("rspec", "~> 3.2")

data/spec/money_spec.rb

@@ -80,6 +80,33 @@ RSpec.describe "Money" do
     expect(non_fractional_money.to_s(:amount)).to eq("1")
   end
 
+  it "to_s correctly displays negative numbers" do
+    expect((-money).to_s).to eq("-1.00")
+    expect((-amount_money).to_s).to eq("-1.23")
+    expect((-non_fractional_money).to_s).to eq("-1")
+    expect((-Money.new("0.05")).to_s).to eq("-0.05")
+  end
+
+  it "to_s rounds when  more fractions than currency allows" do
+    expect(Money.new("9.999", "USD").to_s).to eq("10.00")
+    expect(Money.new("9.889", "USD").to_s).to eq("9.89")
+  end
+
+  it "to_s does not round when fractions same as currency allows" do
+    expect(Money.new("1.25", "USD").to_s).to eq("1.25")
+    expect(Money.new("9.99", "USD").to_s).to eq("9.99")
+    expect(Money.new("9.999", "BHD").to_s).to eq("9.999")
+  end
+
+  it "to_s does not round if amount is larger than float allows" do
+    expect(Money.new("99999999999999.99", "USD").to_s).to eq("99999999999999.99")
+    expect(Money.new("999999999999999999.99", "USD").to_s).to eq("999999999999999999.99")
+  end
+
+  it "to_s raises ArgumentError on unsupported style" do
+    expect{ money.to_s(:some_weird_style) }.to raise_error(ArgumentError)
+  end
+
   it "as_json as a float with 2 decimal places" do
     expect(money.as_json).to eq("1.00")
   end
@@ -315,12 +342,28 @@ RSpec.describe "Money" do
     expect(Money.from_cents(1950.5)).to eq(Money.new(19.51))
   end
 
-  it "is creatable from an integer value in cents and currency" do
-    expect(Money.from_subunits(1950, 'CAD')).to eq(Money.new(19.50))
-  end
+  describe '#from_subunits' do 
+    it "creates Money object from an integer value in cents and currency" do
+      expect(Money.from_subunits(1950, 'CAD')).to eq(Money.new(19.50))
+    end
+
+    it "creates Money object from an integer value in dollars and currency with no cents" do
+      expect(Money.from_subunits(1950, 'JPY')).to eq(Money.new(1950, 'JPY'))
+    end
+
+    describe 'with format specified' do
+      it 'overrides the subunit_to_unit amount' do
+        expect(Money.from_subunits(100, 'ISK', format: :stripe)).to eq(Money.new(1, 'ISK'))
+      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
 
-  it "is creatable from an integer value in dollars and currency with no cents" do
-    expect(Money.from_subunits(1950, 'JPY')).to eq(Money.new(1950, 'JPY'))
+      it 'raises if the format is not found' do
+        expect { Money.from_subunits(100, 'ISK', format: :unknown) }.to(raise_error(ArgumentError))
+      end
+    end
   end
 
   it "raises when constructed with a NaN value" do
@@ -517,6 +560,20 @@ RSpec.describe "Money" do
       expect(Money.new(1, 'IQD').subunits).to eq(1000)
       expect(Money.new(1).subunits).to eq(100)
     end
+
+    describe 'with format specified' do
+      it 'overrides the subunit_to_unit amount' do
+        expect(Money.new(1, 'ISK').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
+
+      it 'raises if the format is not found' do
+        expect { Money.new(1, 'ISK').subunits(format: :unknown) }.to(raise_error(ArgumentError))
+      end
+    end
   end
 
   describe "value" do
@@ -906,4 +963,10 @@ RSpec.describe "Money" do
       expect(money.currency.iso_code).to eq('EUR')
     end
   end
+
+  describe '#to_yaml' do
+    it 'returns a yaml representation' do
+      expect(Money.new(100, 'JPY').to_yaml).to eq("--- !ruby/object:Money\nvalue: '100.0'\ncurrency: JPY\n")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.8
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -103,9 +103,9 @@ extra_rdoc_files: []
 files:
 - ".document"
 - ".github/probots.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-branches:
-  only:
-  - master
-rvm:
-  - 2.7
-  - 2.6
-before_install:
-  # https://github.com/travis-ci/travis-ci/issues/8978#issuecomment-354036443
-  - gem update --system
-  - gem install bundler