shopify-money 0.12.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e95441c6aa9e01d7ac17c8e76f8008cf94dba8d4af2bd75f101d743a333311e
-  data.tar.gz: 07d99a0656016292183ef0a782879f018d4a8fdb814ab6e97470675003280805
+  metadata.gz: 9b719c9a9971dd875ee577e791f2caf49c146c9a08cdc5f9b415a8b1359645fc
+  data.tar.gz: f1e2d5250c520dd76491f2adacb6d6a9f99f91ae2fc1529c9fe9d58589d4172b
 SHA512:
-  metadata.gz: e18f193d30427adb99f4ebb28e1125a5819ec489801c25698069f1c48448edb492ea3effbd9117bac45d77a613f59688a5ff5ed3327d4b20d03b6dd0a51231d7
-  data.tar.gz: b5cc2766b02db02ebf0df626cc531d0996444f78e7939c7fee7e3caa050cb2fb06c767e88e7256ad12131f225436c68b7ebf776c6e8ea1995e18525004f34896
+  metadata.gz: 907fa206d1f4405be598d50f7d72591ab6f048c1b2b454a281d1789d958ef9ff659aacf2a440f6c7ec29f7e607e793667edb0e7dd29cd411688cb8899d917371
+  data.tar.gz: 809321fe1d30b417bed08a20719d576eb28f478edaa00e919dea0be995bc37897534563574404e689a1da9f8ce374908abb84d6ce426b07f45df039e30674f7c

data/.travis.yml

@@ -5,9 +5,8 @@ branches:
   only:
   - master
 rvm:
-  - 2.5
-  - 2.4
-  - 2.3
+  - 2.7
+  - 2.6
 before_install:
   # https://github.com/travis-ci/travis-ci/issues/8978#issuecomment-354036443
   - gem update --system

data/Gemfile

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 gem "pry-byebug", require: false
-gem 'codecov', require: false
+gem 'rubocop', "~> 0.81.0", require: false
 
 gemspec

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) [![codecov](https://codecov.io/gh/Shopify/money/branch/master/graph/badge.svg)](https://codecov.io/gh/Shopify/money)
+[![Build Status](https://travis-ci.org/Shopify/money.svg?branch=master)](https://travis-ci.org/Shopify/money)
 
 
 money_column expects a DECIMAL(21,3) database field.
@@ -139,6 +139,25 @@ currency on the model or attribute level.
 There are no validations generated. You can add these for the specified money
 and currency attributes as you normally would for any other.
 
+## Rubocop
+
+A RuboCop rule to enforce the presence of a currency using static analysis is available.
+
+Add to your `.rubocop.yml`
+```yaml
+require:
+  - money
+
+Money/MissingCurrency:
+  Enabled: true
+```
+
+If your application is currently handling only one currency, it can autocorrect this by specifying a currency under the `Enabled` line:
+
+```yaml
+ReplacementCurrency: 'CAD'
+```
+
 ## Contributing to money
 
 - Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/Rakefile

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 begin
   require 'bundler/gem_tasks'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "money"

data/config/currency_iso.json

@@ -934,7 +934,7 @@
     "symbol": "Ft",
     "alternate_symbols": [],
     "subunit": "",
-    "subunit_to_unit": 1,
+    "subunit_to_unit": 100,
     "symbol_first": false,
     "html_entity": "",
     "decimal_mark": ",",

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,7 +1,9 @@
+# frozen_string_literal: true
 require_relative 'money/money_parser'
 require_relative 'money/helpers'
 require_relative 'money/currency'
 require_relative 'money/null_currency'
+require_relative 'money/allocator'
 require_relative 'money/money'
 require_relative 'money/errors'
 require_relative 'money/deprecations'
@@ -9,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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+require 'delegate'
+
+class Money
+  class Allocator < SimpleDelegator
+    def initialize(money)
+      super
+    end
+
+    # 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
+    # listed first will likely receive more pennies than ones that are listed later
+    #
+    # @param splits [Array<Numeric>]
+    # @param strategy Symbol
+    # @return [Array<Money>]
+    #
+    # Strategies:
+    # - `:roundrobin` (default): leftover pennies will be accumulated starting from the first allocation left to right
+    # - `:roundrobin_reverse`: leftover pennies will be accumulated starting from the last allocation right to left
+    #
+    # @example
+    #   Money.new(5, "USD").allocate([0.50, 0.25, 0.25])
+    #     #=> [#<Money value:2.50 currency:USD>, #<Money value:1.25 currency:USD>, #<Money value:1.25 currency:USD>]
+    #   Money.new(5, "USD").allocate([0.3, 0.7])
+    #     #=> [#<Money value:1.50 currency:USD>, #<Money value:3.50 currency:USD>]
+    #   Money.new(100, "USD").allocate([0.33, 0.33, 0.33])
+    #     #=> [#<Money value:33.34 currency:USD>, #<Money value:33.33 currency:USD>, #<Money value:33.33 currency:USD>]
+
+    # @example left over cents distributed to first party due to rounding, and two solutions for a more natural distribution
+    #   Money.new(30, "USD").allocate([0.667, 0.333])
+    #     #=> [#<Money value:20.01 currency:USD>, #<Money value:9.99 currency:USD>]
+    #   Money.new(30, "USD").allocate([0.333, 0.667])
+    #     #=> [#<Money value:20.00 currency:USD>, #<Money value:10.00 currency:USD>]
+    #   Money.new(30, "USD").allocate([Rational(2, 3), Rational(1, 3)])
+    #     #=> [#<Money value:20.00 currency:USD>, #<Money value:10.00 currency:USD>]
+
+    # @example left over pennies distributed reverse order when using roundrobin_reverse strategy
+    #   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)
+      splits.map!(&:to_r)
+      allocations = splits.inject(0, :+)
+
+      if (allocations - BigDecimal("1")) > Float::EPSILON
+        raise ArgumentError, "splits add to more than 100%"
+      end
+
+      amounts, left_over = amounts_from_splits(allocations, splits)
+
+      left_over.to_i.times do |i|
+        amounts[allocation_index_for(strategy, amounts.length, i)] += 1
+      end
+
+      amounts.collect { |subunits| Money.from_subunits(subunits, currency) }
+    end
+
+    # Allocates money between different parties up to the maximum amounts specified.
+    # Left over pennies will be assigned round-robin up to the maximum specified.
+    # Pennies are dropped when the maximums are attained.
+    #
+    # @example
+    #   Money.new(30.75).allocate_max_amounts([Money.new(26), Money.new(4.75)])
+    #     #=> [Money.new(26), Money.new(4.75)]
+    #
+    #   Money.new(30.75).allocate_max_amounts([Money.new(26), Money.new(4.74)]
+    #     #=> [Money.new(26), Money.new(4.74)]
+    #
+    #   Money.new(30).allocate_max_amounts([Money.new(15), Money.new(15)]
+    #     #=> [Money.new(15), Money.new(15)]
+    #
+    #   Money.new(1).allocate_max_amounts([Money.new(33), Money.new(33), Money.new(33)])
+    #     #=> [Money.new(0.34), Money.new(0.33), Money.new(0.33)]
+    #
+    #   Money.new(100).allocate_max_amounts([Money.new(5), Money.new(2)])
+    #     #=> [Money.new(5), Money.new(2)]
+    def allocate_max_amounts(maximums)
+      allocation_currency = extract_currency(maximums + [self.__getobj__])
+      maximums = maximums.map { |max| max.to_money(allocation_currency) }
+      maximums_total = maximums.reduce(Money.new(0, allocation_currency), :+)
+
+      splits = maximums.map do |max_amount|
+        next(Rational(0)) if maximums_total.zero?
+        Money.rational(max_amount, maximums_total)
+      end
+
+      total_allocatable = [maximums_total.subunits, self.subunits].min
+
+      subunits_amounts, left_over = amounts_from_splits(1, splits, total_allocatable)
+
+      subunits_amounts.each_with_index do |amount, index|
+        break unless left_over > 0
+
+        max_amount = maximums[index].value * allocation_currency.subunit_to_unit
+        next unless amount < max_amount
+
+        left_over -= 1
+        subunits_amounts[index] += 1
+      end
+
+      subunits_amounts.map { |cents| Money.from_subunits(cents, allocation_currency) }
+    end
+
+    private
+
+    def extract_currency(money_array)
+      currencies = money_array.lazy.select { |money| money.is_a?(Money) }.reject(&:no_currency?).map(&:currency).to_a.uniq
+      if currencies.size > 1
+        raise ArgumentError, "operation not permitted for Money objects with different currencies #{currencies.join(', ')}"
+      end
+      currencies.first || NULL_CURRENCY
+    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 = (subunits_to_split * ratio / allocations.to_r).floor
+        left_over -= frac
+        frac
+      end
+
+      [amounts, left_over]
+    end
+
+    def all_rational?(splits)
+      splits.all? { |split| split.is_a?(Rational) }
+    end
+
+    def allocation_index_for(strategy, length, idx)
+      case strategy
+      when :roundrobin
+        idx % length
+      when :roundrobin_reverse
+        length - (idx % length) - 1
+      else
+        raise ArgumentError, "Invalid strategy. Valid options: :roundrobin, :roundrobin_reverse"
+      end
+    end
+  end
+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,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 
 class Money

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)
@@ -245,94 +246,14 @@ class Money
     Money.new(result, currency)
   end
 
-  # 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
-  # listed first will likely receive more pennies than ones that are listed later
-  #
-  # @param splits [Array<Numeric>]
-  # @return [Array<Money>]
-  #
-  # @example
-  #   Money.new(5, "USD").allocate([0.50, 0.25, 0.25])
-  #     #=> [#<Money value:2.50 currency:USD>, #<Money value:1.25 currency:USD>, #<Money value:1.25 currency:USD>]
-  #   Money.new(5, "USD").allocate([0.3, 0.7])
-  #     #=> [#<Money value:1.50 currency:USD>, #<Money value:3.50 currency:USD>]
-  #   Money.new(100, "USD").allocate([0.33, 0.33, 0.33])
-  #     #=> [#<Money value:33.34 currency:USD>, #<Money value:33.33 currency:USD>, #<Money value:33.33 currency:USD>]
-
-  # @example left over cents distributed to first party due to rounding, and two solutions for a more natural distribution
-  #   Money.new(30, "USD").allocate([0.667, 0.333])
-  #     #=> [#<Money value:20.01 currency:USD>, #<Money value:9.99 currency:USD>]
-  #   Money.new(30, "USD").allocate([0.333, 0.667])
-  #     #=> [#<Money value:20.00 currency:USD>, #<Money value:10.00 currency:USD>]
-  #   Money.new(30, "USD").allocate([Rational(2, 3), Rational(1, 3)])
-  #     #=> [#<Money value:20.00 currency:USD>, #<Money value:10.00 currency:USD>]
-  def allocate(splits)
-    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
-
-    if (allocations - BigDecimal("1")) > Float::EPSILON
-      raise ArgumentError, "splits add to more than 100%"
-    end
-
-    amounts, left_over = amounts_from_splits(allocations, splits)
-
-    left_over.to_i.times { |i| amounts[i % amounts.length] += 1 }
-
-    amounts.collect { |subunits| Money.from_subunits(subunits, currency) }
+  # @see Money::Allocator#allocate
+  def allocate(splits, strategy = :roundrobin)
+    Money::Allocator.new(self).allocate(splits, strategy)
   end
 
-  # Allocates money between different parties up to the maximum amounts specified.
-  # Left over pennies will be assigned round-robin up to the maximum specified.
-  # Pennies are dropped when the maximums are attained.
-  #
-  # @example
-  #   Money.new(30.75).allocate_max_amounts([Money.new(26), Money.new(4.75)])
-  #     #=> [Money.new(26), Money.new(4.75)]
-  #
-  #   Money.new(30.75).allocate_max_amounts([Money.new(26), Money.new(4.74)]
-  #     #=> [Money.new(26), Money.new(4.74)]
-  #
-  #   Money.new(30).allocate_max_amounts([Money.new(15), Money.new(15)]
-  #     #=> [Money.new(15), Money.new(15)]
-  #
-  #   Money.new(1).allocate_max_amounts([Money.new(33), Money.new(33), Money.new(33)])
-  #     #=> [Money.new(0.34), Money.new(0.33), Money.new(0.33)]
-  #
-  #   Money.new(100).allocate_max_amounts([Money.new(5), Money.new(2)])
-  #     #=> [Money.new(5), Money.new(2)]
+  # @see Money::Allocator#allocate_max_amounts
   def allocate_max_amounts(maximums)
-    allocation_currency = extract_currency(maximums + [self])
-    maximums = maximums.map { |max| max.to_money(allocation_currency) }
-    maximums_total = maximums.reduce(Money.new(0, allocation_currency), :+)
-
-    splits = maximums.map do |max_amount|
-      next(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
-
-    subunits_amounts, left_over = amounts_from_splits(1, splits, total_allocatable)
-
-    subunits_amounts.each_with_index do |amount, index|
-      break unless left_over > 0
-
-      max_amount = maximums[index].value * allocation_currency.subunit_to_unit
-      next unless amount < max_amount
-
-      left_over -= 1
-      subunits_amounts[index] += 1
-    end
-
-    subunits_amounts.map { |cents| Money.from_subunits(cents, allocation_currency) }
+    Money::Allocator.new(self).allocate_max_amounts(maximums)
   end
 
   # Split money amongst parties evenly without losing pennies.
@@ -395,22 +316,6 @@ class Money
 
   private
 
-  def all_rational?(splits)
-    splits.all? { |split| split.is_a?(Rational) }
-  end
-
-  def amounts_from_splits(allocations, splits, subunits_to_split = subunits)
-    left_over = subunits_to_split
-
-    amounts = splits.collect do |ratio|
-      frac = (Helpers.value_to_decimal(subunits_to_split * ratio) / allocations).floor
-      left_over -= frac
-      frac
-    end
-
-    [amounts, left_over]
-  end
-
   def arithmetic(money_or_numeric)
     raise TypeError, "#{money_or_numeric.class.name} can't be coerced into Money" unless money_or_numeric.respond_to?(:to_money)
     other = money_or_numeric.to_money(currency)
@@ -421,12 +326,4 @@ class Money
   def calculated_currency(other)
     no_currency? ? other : currency
   end
-
-  def extract_currency(money_array)
-    currencies = money_array.lazy.select { |money| money.is_a?(Money) }.reject(&:no_currency?).map(&:currency).to_a.uniq
-    if currencies.size > 1
-      raise ArgumentError, "operation not permitted for Money objects with different currencies #{currencies.join(', ')}"
-    end
-    currencies.first || NULL_CURRENCY
-  end
 end