amount 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13044725c9fe6a8d41d0b7984ad962deec866d8a3674031bd9de40a91cdaa5be
+  data.tar.gz: 7e433ccc610c7b8e943f9ef60c7d8a36d9d3d8152d5ff190e351de6001e27a48
+SHA512:
+  metadata.gz: 60e119fe8ed12781242f6e6125f54d22503af83120d329eb42424332fe96b9d7a71bc96883d5fbcc0d1c2fc877fa5cce8c10716416dde2113b0355bb3b91c267
+  data.tar.gz: cf975eb171b90104205856acd2bb3a1f7e047d3296136067bc9a602ca4f96bd298b5d8735c6e5c62f5d321cd9c8cd5ee21cce7674485f8a97329797d1baa01d0

data/README.md

@@ -0,0 +1,31 @@
+# Amount
+
+The amount gem provides a class called `Amount` that represents an amount of money with currency and 18-digit precision. It extends the functionality of the fixed gem and adds currency support to handle monetary values accurately.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amount'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install amount
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/akuhn/amount](https://github.com/akuhn/amount). This project encourages collaboration and appreciates contributions. Feel free to contribute to the project by reporting bugs or submitting pull requests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/amount/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Amount < Fixed
+  VERSION = "1.0.0"
+end
+
+
+__END__
+
+# Major version bump when breaking changes or new features
+# Minor version bump when backward-compatible changes or enhancements
+# Patch version bump when backward-compatible bug fixes, security updates etc
+
+1.0.0
+
+  - Extends the fixed gem
+  - Adds currency support to handle monetary values
+  - Convenient constructors for creating money amounts

data/lib/amount.rb

@@ -0,0 +1,157 @@
+require 'fixed'
+require 'amount/version'
+
+# An amount of money with currency and 18-digit precision.
+
+
+class Amount < Fixed
+
+  attr_reader :currency
+
+
+  #------- constructors ---------------------------------------------
+
+  private_class_method :new
+
+  def initialize(currency, fractions)
+    raise unless Symbol === currency
+    @currency = currency
+    super fractions
+  end
+
+  def self.create(value, currency = nil)
+    if currency.nil?
+      case value
+      when Amount
+        return value
+      when String
+        return self.parse(value)
+      when Hash
+        case value.size
+        when 1
+          currency, value = value.first
+        when 2
+          return Amount.create value.fetch(:amount), value.fetch(:currency)
+        else
+          raise ArgumentError, "expected amount, got #{value.inspect}"
+        end
+      end
+    end
+
+    case value
+    when String
+      new currency.to_sym, string_as_fractions(value)
+    when Fixed
+      new currency.to_sym, value.fractions
+    when Numeric
+      new currency.to_sym, number_as_fractions(value)
+    else
+      raise ArgumentError, "expected amount, got #{[value,currency].inspect}"
+    end
+  end
+
+  def self.parse(string)
+    raise "expect amount and currency, got #{string.inspect}" unless string =~ /\A(\S+)\s+(\S+)\Z/
+    new $2.to_sym, string_as_fractions($1)
+  end
+
+  def self.from_number(currency, units)
+    new currency, number_as_fractions(units)
+  end
+
+  def self.from_fractions(currency, fractions, precision: nil)
+    if precision
+      raise unless (0..18) === precision
+      fractions = fractions * (10 ** (18 - precision))
+    end
+
+    new currency, fractions
+  end
+
+  def self.smallest(currency)
+    new currency, 1
+  end
+
+  def self.zero(currency)
+    new currency, 0
+  end
+
+  #------- arithmetics ----------------------------------------------
+
+  def +(amount)
+    raise "expected curreny #{self.currency}, got #{amount.currency}" unless self.currency == amount.currency
+    super
+  end
+
+  def -(amount)
+    raise "expected curreny #{self.currency}, got #{amount.currency}" unless self.currency == amount.currency
+    super
+  end
+
+  def *(number)
+    raise "expected curreny #{self.currency}, got #{number.currency}" unless self.currency == number.currency if Amount === number
+    super
+  end
+
+  def /(number)
+    raise "expected curreny #{self.currency}, got #{number.currency}" unless self.currency == number.currency if Amount === number
+    super
+  end
+
+
+  # ------- comparing -----------------------------------------------
+
+  def dollar?
+    self.currency == :USD
+  end
+
+  def ==(amount)
+    Amount === amount && self.currency == amount.currency && self.fractions == amount.fractions
+  end
+
+
+  # ------- printing ------------------------------------------------
+
+  def inspect
+    "#{super} #{currency}"
+  end
+
+  def format(precision = 8)
+    "#{super precision} #{currency}"
+  end
+
+
+  # ------- helpers -------------------------------------------------
+
+  def to_amount
+    self
+  end
+
+  def eps
+    self.fractions
+  end
+
+  def without_currency
+    Fixed.from_fractions self.fractions
+  end
+
+  protected
+
+  def make(new_fractions)
+    Amount.from_fractions self.currency, new_fractions
+  end
+
+end
+
+module Kernel
+  def Amount(value, currency = nil)
+    Amount.create value, currency
+  end
+end
+
+class String
+  def to_amount
+    Amount.parse self
+  end
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: amount
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adrian Kuhn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fixed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- akuhn@iam.unibe.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/amount.rb
+- lib/amount/version.rb
+homepage: https://github.com/akuhn/amount
+licenses: []
+metadata:
+  homepage_uri: https://github.com/akuhn/amount
+  source_code_uri: https://github.com/akuhn/amount
+  changelog_uri: https://github.com/akuhn/amount/blob/master/lib/amount/version.rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: An amount of money with currency and 18-digit precision.
+test_files: []