shopify-money 0.14.2 → 0.14.7

data/config/currency_non_iso.yml

@@ -0,0 +1,96 @@
+---
+jep:
+  priority: 100
+  iso_code: JEP
+  name: Jersey Pound
+  symbol: "£"
+  disambiguate_symbol: JEP
+  alternate_symbols: []
+  subunit: Penny
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: "£"
+  decimal_mark: "."
+  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
+  name: Guernsey Pound
+  symbol: "£"
+  disambiguate_symbol: GGP
+  alternate_symbols: []
+  subunit: Penny
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: "£"
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: ''
+  smallest_denomination: 1
+imp:
+  priority: 100
+  iso_code: IMP
+  name: Isle of Man Pound
+  symbol: "£"
+  disambiguate_symbol: IMP
+  alternate_symbols:
+  - M£
+  subunit: Penny
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: "£"
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: ''
+  smallest_denomination: 1
+xfu:
+  priority: 100
+  iso_code: XFU
+  name: UIC Franc
+  symbol: ''
+  disambiguate_symbol: XFU
+  alternate_symbols: []
+  subunit: ''
+  subunit_to_unit: 100
+  symbol_first: true
+  html_entity: ''
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: ''
+  smallest_denomination: ''
+gbx:
+  priority: 100
+  iso_code: GBX
+  name: British Penny
+  symbol: ''
+  disambiguate_symbol: GBX
+  alternate_symbols: []
+  subunit: ''
+  subunit_to_unit: 1
+  symbol_first: true
+  html_entity: ''
+  decimal_mark: "."
+  thousands_separator: ","
+  iso_numeric: ''
+  smallest_denomination: 1

data/lib/money/currency/loader.rb

@@ -1,26 +1,38 @@
 # frozen_string_literal: true
-require 'json'
+require 'yaml'
 
 class Money
   class Currency
     module Loader
-      extend self
+      class << self
+        def load_currencies
+          currency_data_path = File.expand_path("../../../../config", __FILE__)
 
-      CURRENCY_DATA_PATH = File.expand_path("../../../../config", __FILE__)
+          currencies = {}
+          currencies.merge! YAML.load_file("#{currency_data_path}/currency_historic.yml")
+          currencies.merge! YAML.load_file("#{currency_data_path}/currency_non_iso.yml")
+          currencies.merge! YAML.load_file("#{currency_data_path}/currency_iso.yml")
+          deep_deduplicate!(currencies)
+        end
 
-      def load_currencies
-        currencies = {}
-        currencies.merge! parse_currency_file("currency_historic.json")
-        currencies.merge! parse_currency_file("currency_non_iso.json")
-        currencies.merge! parse_currency_file("currency_iso.json")
-      end
-
-      private
+        private
 
-      def parse_currency_file(filename)
-        json = File.read("#{CURRENCY_DATA_PATH}/#{filename}")
-        json.force_encoding(::Encoding::UTF_8) if defined?(::Encoding)
-        JSON.parse(json)
+        def deep_deduplicate!(data)
+          case data
+          when Hash
+            return data if data.frozen?
+            data.transform_keys! { |k| deep_deduplicate!(k) }
+            data.transform_values! { |v| deep_deduplicate!(v) }
+            data.freeze
+          when Array
+            return data if data.frozen?
+            data.map! { |d| deep_deduplicate!(d) }.freeze
+          when String
+            -data
+          else
+            data.freeze
+          end
+        end
       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
 
@@ -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.2"
+  VERSION = "0.14.7"
 end

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
 
-  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'))
+    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 '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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-money
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.7
 platform: ruby
 authors:
 - Shopify Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,9 +111,9 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- config/currency_historic.json
-- config/currency_iso.json
-- config/currency_non_iso.json
+- config/currency_historic.yml
+- config/currency_iso.yml
+- config/currency_non_iso.yml
 - dev.yml
 - lib/money.rb
 - lib/money/accounting_money_parser.rb

data/config/currency_historic.json

@@ -1,157 +0,0 @@
-{
-  "cyp": {
-    "priority": 100,
-    "iso_code": "CYP",
-    "name": "Cypriot pound",
-    "symbol": "£",
-    "alternate_symbols": [],
-    "subunit": "Cent",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "£",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "196",
-    "smallest_denomination": 1
-  },
-  "eek": {
-    "priority": 100,
-    "iso_code": "EEK",
-    "name": "Estonian Kroon",
-    "symbol": "KR",
-    "alternate_symbols": [],
-    "subunit": "Sent",
-    "subunit_to_unit": 100,
-    "symbol_first": false,
-    "html_entity": "",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "233",
-    "smallest_denomination": 5
-  },
-  "ghc": {
-    "priority": 100,
-    "iso_code": "GHS",
-    "name": "Ghanaian Cedi",
-    "symbol": "₵",
-    "disambiguate_symbol": "GH₵",
-    "alternate_symbols": ["GH₵"],
-    "subunit": "Pesewa",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "₵",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "288",
-    "smallest_denomination": 1
-  },
-  "mtl": {
-    "priority": 100,
-    "iso_code": "MTL",
-    "name": "Maltese Lira",
-    "symbol": "₤",
-    "alternate_symbols": ["Lm"],
-    "subunit": "Cent",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "£",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "470",
-    "smallest_denomination": 1
-  },
-  "tmm": {
-    "priority": 100,
-    "iso_code": "TMM",
-    "name": "Turkmenistani Manat",
-    "symbol": "m",
-    "alternate_symbols": [],
-    "subunit": "Tennesi",
-    "subunit_to_unit": 100,
-    "symbol_first": false,
-    "html_entity": "",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "795",
-    "smallest_denomination": 1
-  },
-  "VEB": {
-    "priority": 100,
-    "iso_code": "VEB",
-    "name": "Venezuelan Bolívar",
-    "symbol": "Bs.",
-    "alternate_symbols": [],
-    "subunit": "Céntimo",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "",
-    "decimal_mark": ",",
-    "thousands_separator": ".",
-    "iso_numeric": "862",
-    "smallest_denomination": 1
-  },
-  "zwd": {
-    "priority": 100,
-    "iso_code": "ZWD",
-    "name": "Zimbabwean Dollar",
-    "symbol": "$",
-    "disambiguate_symbol": "ZWD",
-    "alternate_symbols": ["Z$"],
-    "subunit": "Cent",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "$",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "716",
-    "smallest_denomination": 100
-  },
-  "zwl": {
-    "priority": 100,
-    "iso_code": "ZWL",
-    "name": "Zimbabwean Dollar",
-    "symbol": "$",
-    "disambiguate_symbol": "ZWL",
-    "alternate_symbols": ["Z$"],
-    "subunit": "Cent",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "$",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "932",
-    "smallest_denomination": 100
-  },
-  "zwn": {
-    "priority": 100,
-    "iso_code": "ZWN",
-    "name": "Zimbabwean Dollar",
-    "symbol": "$",
-    "disambiguate_symbol": "ZWN",
-    "alternate_symbols": ["Z$"],
-    "subunit": "Cent",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "$",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "942",
-    "smallest_denomination": 100
-  },
-  "zwr": {
-    "priority": 100,
-    "iso_code": "ZWR",
-    "name": "Zimbabwean Dollar",
-    "symbol": "$",
-    "disambiguate_symbol": "ZWR",
-    "alternate_symbols": ["Z$"],
-    "subunit": "Cent",
-    "subunit_to_unit": 100,
-    "symbol_first": true,
-    "html_entity": "$",
-    "decimal_mark": ".",
-    "thousands_separator": ",",
-    "iso_numeric": "935",
-    "smallest_denomination": 100
-  }
-}