monies 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffee4b91733b331056188aef0f3576b9e90fc16847f91174749f7ffc154e7ff
-  data.tar.gz: bac13063005ebde101cf5faa4405fcfe48c1107bb10e6568ae35fe9c51191ce7
+  metadata.gz: 411e7bb7e471b8d8df69c510b07c810984dce43c7a753a1431c0f40c849cb1c8
+  data.tar.gz: 8b84016a100c83249bf9845c1592b1a20b405c1bdeb297b887abe8163b98d411
 SHA512:
-  metadata.gz: e7a50b0b8c9584a16dc75be18bac0e54f706028cda755d501e8e91f3a2c84487b4b4763ac6ba651c36ccb70b2b275baa445983133982d926efb299653989611b
-  data.tar.gz: 9a1f89469a73048e45e55cd6db7e3a93b4e2cfc99a9a5dbf6d247e56ee89f68ddea4bd76b66d819e8e844f5967911878a88c7a12996743923416e475d56db57d
+  metadata.gz: 7d6080e16f4d8c3fb149149635573d0e2615f4c104aa742623ba1d36e127b19572a59197d2cfc45f06de56f9f85b72db220e737b1448ea1da33a48f4109349fd
+  data.tar.gz: a251134b700e1659e6d0ff07162288ef44e3f69bb9fd8605bc407bf5e319d438b1cab818a0cd5144d3759f136cf856f1b73dfef4cf30474af0ef13e44ba0bed4

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2024 TIMCRAFT
+Copyright (c) 2024-2025 TIMCRAFT
 
 This is an Open Source project licensed under the terms of the LGPLv3 license.
 Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.

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/digits.rb

@@ -60,4 +60,10 @@ module Monies::Digits
 
     Monies.new(value, scale, currency)
   end
+
+  REGEXP = /\A\-?\d+(\.\d+)?\z/
+
+  def self.match?(string)
+    REGEXP.match?(string)
+  end
 end

data/lib/monies.rb

@@ -116,6 +116,7 @@ class Monies
       end
 
       scale = other.scale
+      scale = length - exponent if length < scale
 
       return reduce(@value * value, @scale + scale)
     end
@@ -195,6 +196,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 +288,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
@@ -463,7 +488,7 @@ class Monies
   end
 end
 
-def Monies(object, currency = Monies.currency)
+def Monies(object, currency = Monies.currency, exception: true)
   case object
   when Monies
     object
@@ -472,7 +497,11 @@ def Monies(object, currency = Monies.currency)
   when Rational
     Monies.new(object.numerator, 0, currency) / object.denominator
   when String
-    Monies::Digits.load(object, currency)
+    if Monies::Digits.match?(object)
+      Monies::Digits.load(object, currency)
+    elsif exception
+      raise ArgumentError, "invalid value for Monies(): #{object.inspect}"
+    end
   else
     if defined?(BigDecimal) && object.is_a?(BigDecimal)
       sign, significant_digits, base, exponent = object.split
@@ -486,10 +515,11 @@ def Monies(object, currency = Monies.currency)
       end
 
       scale = object.scale
+      scale = length - exponent if length < scale
 
       return Monies.new(value, scale, currency)
     end
 
-    raise TypeError, "can't convert #{object.inspect} into #{Monies}"
+    raise TypeError, "can't convert #{object.inspect} into #{Monies}" if exception
   end
 end

data/monies.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'monies'
-  s.version = '1.0.1'
+  s.version = '1.2.0'
   s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
@@ -9,11 +9,12 @@ Gem::Specification.new do |s|
   s.description = 'Ruby gem for representing monetary values'
   s.summary = 'See description'
   s.files = Dir.glob('lib/**/*.rb') + %w[LICENSE.txt README.md monies.gemspec]
-  s.required_ruby_version = '>= 3.1.0'
+  s.required_ruby_version = '>= 3.2.0'
   s.require_path = 'lib'
   s.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'
   }
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: monies
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Tim Craft
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem for representing monetary values
 email:
@@ -35,7 +34,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
-post_install_message:
+  changelog_uri: https://github.com/readysteady/monies/blob/main/CHANGES.md
 rdoc_options: []
 require_paths:
 - lib
@@ -43,15 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: See description
 test_files: []