monies 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457a633b330a9b30ecebac6694ed2b29566e96ed3db33b3ba2a8feca86501c88
-  data.tar.gz: 9b3fe5366065d52108a6b3b6d74f0daba814174f47063ce12dfac75d10ecb132
+  metadata.gz: 736b4a239f90fc0979d0b7a0ad4ab2b55986a6d9b371420ab250d8c6c3cb6e5c
+  data.tar.gz: 9a4127b66e6321c91baf2f39200584fab7fbedb3d653278de6beb6c995664065
 SHA512:
-  metadata.gz: ef772a5e785576896d10adc3638aa7062f9e148cf6678394c82e2d5f1555ea486822cc1bc018b3babc3c3976480d6fb8b7fff15bf4c315861b175c4f996ffbf2
-  data.tar.gz: a69ffff9d64b66179c71bdeb7d4443a594818523e7d54ba845d3ad7cebf9f580cdd86173be0a7cb68a5ed4078262946620f8908fbc2c58a86254e60a60ae248e
+  metadata.gz: 37bcf8de107b4d63468a8b717ccc2bf3b901128a89f4b2a394d8ce24b33b3d12317fb2a66978163ec7625af29edd6748435d7a2016aa4ea701281a5efb3a9170
+  data.tar.gz: c66aa18d837262bfd5e0072dc566fa0bd2a044a14ead9a46a11cbbb6338a5a38c3f7a659d545d2cc9cf75417eaea0eeaf6ef30850b19f6f851801d7d86f8d4c9

data/README.md

@@ -1,5 +1,9 @@
 # monies
 
+![Gem Version](https://badge.fury.io/rb/monies.svg)
+![Test Status](https://github.com/readysteady/monies/actions/workflows/test.yml/badge.svg)
+
+
 Ruby gem for representing monetary values.
 
 Pure Ruby—compatible with MRI/CRuby, JRuby, TruffleRuby, and Natalie.
@@ -76,6 +80,12 @@ the maximum number of decimal places you want:
 Monies(1, 'USD').div(9, 100)
 ```
 
+Use the #allocate method to split an amount into a number of smaller amounts:
+
+```ruby
+installments = Monies(1, 'USD').allocate(3, 2)
+```
+
 
 ## Currency conversion
 

data/lib/monies.rb

@@ -195,6 +195,22 @@ class Monies
     self.class.new(@value.abs, @scale, @currency)
   end
 
+  def allocate(n, digits)
+    unless n.is_a?(Integer) && n >= 1
+      raise ArgumentError, 'n must be greater than or equal to 1'
+    end
+
+    quotient = (self / n).truncate(digits)
+
+    remainder = self - quotient * n
+
+    array = Array.new(n) { quotient }
+
+    array[-1] += remainder unless remainder.zero?
+
+    array
+  end
+
   def ceil(digits = 0)
     round(digits, :ceil)
   end
@@ -271,10 +287,18 @@ class Monies
     raise TypeError, "#{self.class} can't be divided by #{other.class}"
   end
 
+  def fix
+    self.class.new(@value / (BASE ** @scale), 0, @currency)
+  end
+
   def floor(digits = 0)
     round(digits, :floor)
   end
 
+  def frac
+    self - fix
+  end
+
   def inspect
     "#<#{self.class.name}: #{Monies::Digits.dump(self)} #{@currency}>"
   end
@@ -389,7 +413,7 @@ class Monies
   def divide(value, scale, divisor, max_scale)
     quotient, carry = 0, 0
 
-    value.digits.reverse_each do |digit|
+    value.abs.digits.reverse_each do |digit|
       dividend = carry + digit
 
       quotient = (quotient * BASE) + (dividend / divisor)
@@ -411,6 +435,8 @@ class Monies
       iterations -= 1
     end
 
+    quotient = -quotient if value.negative?
+
     self.class.new(quotient, scale, @currency)
   end
 

data/monies.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'monies'
-  s.version = '1.0.0'
+  s.version = '1.1.0'
   s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
@@ -15,5 +15,6 @@ Gem::Specification.new do |s|
     'homepage' => 'https://github.com/readysteady/monies',
     'source_code_uri' => 'https://github.com/readysteady/monies',
     'bug_tracker_uri' => 'https://github.com/readysteady/monies/issues',
+    'changelog_uri' => 'https://github.com/readysteady/monies/blob/main/CHANGES.md'
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monies
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem for representing monetary values
 email:
@@ -35,6 +35,7 @@ metadata:
   homepage: https://github.com/readysteady/monies
   source_code_uri: https://github.com/readysteady/monies
   bug_tracker_uri: https://github.com/readysteady/monies/issues
+  changelog_uri: https://github.com/readysteady/monies/blob/main/CHANGES.md
 post_install_message:
 rdoc_options: []
 require_paths: