shopify-money 0.13.0 → 0.14.3

data/config/currency_non_iso.yml

@@ -0,0 +1,77 @@
+---
+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
+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/dev.yml

@@ -3,7 +3,7 @@
 ---
 name: money
 up:
-- ruby: 2.5.3
+- ruby: 2.6.6
 - bundler
 commands:
   test: bundle exec rspec

data/lib/money.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'money/money_parser'
 require_relative 'money/helpers'
 require_relative 'money/currency'
@@ -10,3 +11,5 @@ 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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+require 'delegate'
+
 class Money
   class Allocator < SimpleDelegator
     def initialize(money)
@@ -37,11 +40,8 @@ class Money
     #   Money.new(10.01, "USD").allocate([0.5, 0.5], :roundrobin_reverse)
     #     #=> [#<Money value:5.00 currency:USD>, #<Money value:5.01 currency:USD>]
     def allocate(splits, strategy = :roundrobin)
-      if all_rational?(splits)
-        allocations = splits.inject(0) { |sum, n| sum + n }
-      else
-        allocations = splits.inject(0) { |sum, n| sum + Helpers.value_to_decimal(n) }
-      end
+      splits.map!(&:to_r)
+      allocations = splits.inject(0, :+)
 
       if (allocations - BigDecimal("1")) > Float::EPSILON
         raise ArgumentError, "splits add to more than 100%"
@@ -81,14 +81,11 @@ class Money
       maximums_total = maximums.reduce(Money.new(0, allocation_currency), :+)
 
       splits = maximums.map do |max_amount|
-        next(0) if maximums_total.zero?
+        next(Rational(0)) if maximums_total.zero?
         Money.rational(max_amount, maximums_total)
       end
 
-      total_allocatable = [
-        value * allocation_currency.subunit_to_unit,
-        maximums_total.value * allocation_currency.subunit_to_unit
-      ].min
+      total_allocatable = [maximums_total.subunits, self.subunits].min
 
       subunits_amounts, left_over = amounts_from_splits(1, splits, total_allocatable)
 
@@ -116,10 +113,12 @@ class Money
     end
 
     def amounts_from_splits(allocations, splits, subunits_to_split = subunits)
+      raise ArgumentError, "All splits values must be of type Rational." unless all_rational?(splits)
+
       left_over = subunits_to_split
 
       amounts = splits.collect do |ratio|
-        frac = (Helpers.value_to_decimal(subunits_to_split * ratio) / allocations).floor
+        frac = (subunits_to_split * ratio / allocations.to_r).floor
         left_over -= frac
         frac
       end

data/lib/money/core_extensions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Allows Writing of 100.to_money for +Numeric+ types
 #   100.to_money => #<Money @cents=10000>
 #   100.37.to_money => #<Money @cents=10037>

data/lib/money/currency.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "money/currency/loader"
 
 class Money

data/lib/money/currency/loader.rb

@@ -1,25 +1,38 @@
-require 'json'
+# frozen_string_literal: true
+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.duplicable? ? data.freeze : data
+          end
+        end
       end
     end
   end

data/lib/money/deprecations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Money.class_eval do
   ACTIVE_SUPPORT_DEFINED = defined?(ActiveSupport)
 

data/lib/money/errors.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Money
   class Error < StandardError
   end

data/lib/money/helpers.rb

@@ -5,7 +5,6 @@ class Money
   module Helpers
     module_function
 
-    NUMERIC_REGEX = /\A\s*[\+\-]?(\d+|\d*\.\d+)\s*\z/
     DECIMAL_ZERO = BigDecimal(0).freeze
     MAX_DECIMAL = 21
 
@@ -25,7 +24,11 @@ class Money
         when Rational
           BigDecimal(num, MAX_DECIMAL)
         when String
-          string_to_decimal(num)
+          decimal = BigDecimal(num, exception: false)
+          return decimal if decimal
+
+          Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
+          DECIMAL_ZERO
         else
           raise ArgumentError, "could not parse as decimal #{num.inspect}"
         end
@@ -54,18 +57,5 @@ class Money
         raise ArgumentError, "could not parse as currency #{currency.inspect}"
       end
     end
-
-    def string_to_decimal(num)
-      if num =~ NUMERIC_REGEX
-        return BigDecimal(num)
-      end
-
-      Money.deprecate("using Money.new('#{num}') is deprecated and will raise an ArgumentError in the next major release")
-      begin
-        BigDecimal(num)
-      rescue ArgumentError
-        DECIMAL_ZERO
-      end
-    end
   end
 end

data/lib/money/money.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'forwardable'
 
 class Money
@@ -30,8 +31,8 @@ class Money
     end
     alias_method :empty, :zero
 
-    def parse(*args)
-      parser.parse(*args)
+    def parse(*args, **kwargs)
+      parser.parse(*args, **kwargs)
     end
 
     def from_cents(cents, currency = nil)

data/lib/money/null_currency.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Money
   class NullCurrency
 

data/lib/money/version.rb

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

data/lib/money_accessor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MoneyAccessor
   def self.included(base)
     base.extend(ClassMethods)

data/lib/money_column.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'money_column/active_record_hooks'
 require_relative 'money_column/active_record_type'
 require_relative 'money_column/railtie'

data/lib/money_column/active_record_hooks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MoneyColumn
   module ActiveRecordHooks
     def self.included(base)
@@ -57,7 +58,7 @@ module MoneyColumn
       if options[:currency_read_only]
         currency_source = Money::Helpers.value_to_currency(currency_raw_source)
         if currency_raw_source && !money.currency.compatible?(currency_source)
-          Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency}.")
+          Money.deprecate("[money_column] currency mismatch between #{currency_source} and #{money.currency} in column #{column}.")
         end
       else
         self[options[:currency_column]] = money.currency.to_s unless money.no_currency?

data/lib/money_column/active_record_type.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class MoneyColumn::ActiveRecordType < ActiveRecord::Type::Decimal
   def serialize(money)
     return nil unless money

data/lib/money_column/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module MoneyColumn
   class Railtie < Rails::Railtie
     ActiveSupport.on_load :active_record do

data/lib/rubocop/cop/money.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/money/missing_currency'

data/lib/rubocop/cop/money/missing_currency.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Money
+      class MissingCurrency < Cop
+        # `Money.new()` without a currency argument cannot guarantee correctness:
+        # - no error raised for cross-currency computation (e.g. 5 CAD + 5 USD)
+        # - #subunits returns wrong values for 0 and 3 decimals currencies
+        #
+        # @example
+        #   # bad
+        #   Money.new(123.45)
+        #   Money.new
+        #   "1,234.50".to_money
+        #
+        #   # good
+        #   Money.new(123.45, 'CAD')
+        #   "1,234.50".to_money('CAD')
+        #
+
+        def_node_matcher :money_new, <<~PATTERN
+          (send (const nil? :Money) {:new :from_amount :from_cents} $...)
+        PATTERN
+
+        def_node_matcher :to_money_without_currency?, <<~PATTERN
+          (send _ :to_money)
+        PATTERN
+
+        def_node_matcher :to_money_block?, <<~PATTERN
+          (send _ _ (block_pass (sym :to_money)))
+        PATTERN
+
+        def on_send(node)
+          money_new(node) do |_amount, currency_arg|
+            return if currency_arg
+
+            add_offense(node, message: 'Money is missing currency argument')
+          end
+
+          if to_money_block?(node) || to_money_without_currency?(node)
+            add_offense(node, message: 'to_money is missing currency argument')
+          end
+        end
+
+        def autocorrect(node)
+          currency = cop_config['ReplacementCurrency']
+          return unless currency
+
+          receiver, method, _ = *node
+
+          lambda do |corrector|
+            money_new(node) do |amount, currency_arg|
+              return if currency_arg
+
+              corrector.replace(
+                node.loc.expression,
+                "#{receiver.source}.#{method}(#{amount&.source || 0}, '#{currency}')"
+              )
+            end
+
+            if to_money_without_currency?(node)
+              corrector.insert_after(node.loc.expression, "('#{currency}')")
+            elsif to_money_block?(node)
+              corrector.replace(
+                node.loc.expression,
+                "#{receiver.source}.#{method} { |x| x.to_money('#{currency}') }"
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify-money.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'money'

data/money.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 require_relative "lib/money/version"
 
 Gem::Specification.new do |s|
@@ -12,13 +13,16 @@ Gem::Specification.new do |s|
   s.licenses = "MIT"
   s.summary = "Shopify's money gem"
 
+  s.metadata['allowed_push_host'] = "https://rubygems.org"
+
   s.add_development_dependency("bundler", ">= 1.5")
   s.add_development_dependency("simplecov", ">= 0")
-  s.add_development_dependency("rails", "~> 5.0")
+  s.add_development_dependency("rails", "~> 6.0")
   s.add_development_dependency("rspec", "~> 3.2")
   s.add_development_dependency("database_cleaner", "~> 1.6")
-  s.add_development_dependency("sqlite3", "~> 1.3.6")
-  s.add_development_dependency("bigdecimal", "~> 1.3.2")
+  s.add_development_dependency("sqlite3", "~> 1.4.2")
+
+  s.required_ruby_version = '>= 2.6'
 
   s.files = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/accounting_money_parser_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 RSpec.describe AccountingMoneyParser do