Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rhymond/Go-money
Go implementation of Fowler's Money pattern
https://github.com/rhymond/Go-money
currency formatter fowler-money-pattern money money-library
Last synced: 20 days ago
JSON representation
Go implementation of Fowler's Money pattern
- Host: GitHub
- URL: https://github.com/rhymond/Go-money
- Owner: Rhymond
- License: mit
- Created: 2017-03-20T16:23:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-29T06:27:03.000Z (4 months ago)
- Last Synced: 2024-10-15T13:41:38.966Z (29 days ago)
- Topics: currency, formatter, fowler-money-pattern, money, money-library
- Language: Go
- Homepage:
- Size: 165 KB
- Stars: 1,661
- Watchers: 20
- Forks: 148
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Money
[](https://goreportcard.com/report/github.com/rhymond/go-money)
[](https://coveralls.io/github/Rhymond/go-money?branch=master)
[](https://godoc.org/github.com/Rhymond/go-money)
[](https://opensource.org/licenses/MIT)
**GoMoney** provides ability to work with [monetary value using a currency's smallest unit](https://martinfowler.com/eaaCatalog/money.html).
This package provides basic and precise Money operations such as rounding, splitting and allocating. Monetary values should not be stored as floats due to small rounding differences.
```go
package main
import (
"log"
"github.com/Rhymond/go-money"
)
func main() {
pound := money.New(100, money.GBP)
twoPounds, err := pound.Add(pound)
if err != nil {
log.Fatal(err)
}
parties, err := twoPounds.Split(3)
if err != nil {
log.Fatal(err)
}
parties[0].Display() // £0.67
parties[1].Display() // £0.67
parties[2].Display() // £0.66
}
```
Quick start
-
Get the package:
``` bash
$ go get github.com/Rhymond/go-money
```
## Features
* Provides a Money struct which stores information about an Money amount value and its currency.
* Provides a ```Money.Amount``` struct which encapsulates all information about a monetary unit.
* Represents monetary values as integers, in cents. This avoids floating point rounding errors.
* Represents currency as ```Money.Currency``` instances providing a high level of flexibility.
Usage
-
### Initialization
Initialize Money by using smallest unit value (e.g 100 represents 1 pound). Use ISO 4217 Currency Code to set money Currency. Note that constants are also provided for all ISO 4217 currency codes.
```go
pound := money.New(100, money.GBP)
```
Or initialize Money using the direct amount.
```go
quarterEuro := money.NewFromFloat(0.25, money.EUR)
```
Comparison
-
**Go-money** provides base compare operations like:
* Equals
* GreaterThan
* GreaterThanOrEqual
* LessThan
* LessThanOrEqual
* Compare
Comparisons must be made between the same currency units.
```go
pound := money.New(100, money.GBP)
twoPounds := money.New(200, money.GBP)
twoEuros := money.New(200, money.EUR)
pound.GreaterThan(twoPounds) // false, nil
pound.LessThan(twoPounds) // true, nil
twoPounds.Equals(twoEuros) // false, error: Currencies don't match
twoPounds.Compare(pound) // 1, nil
pound.Compare(twoPounds) // -1, nil
pound.Compare(pound) // 0, nil
pound.Compare(twoEuros) // pound.amount, ErrCurrencyMismatch
```
Asserts
-
* IsZero
* IsNegative
* IsPositive
#### Zero value
To assert if Money value is equal to zero use `IsZero()`
```go
pound := money.New(100, money.GBP)
result := pound.IsZero() // false
```
#### Positive value
To assert if Money value is more than zero use `IsPositive()`
```go
pound := money.New(100, money.GBP)
pound.IsPositive() // true
```
#### Negative value
To assert if Money value is less than zero use `IsNegative()`
```go
pound := money.New(100, money.GBP)
pound.IsNegative() // false
```
Operations
-
* Add
* Subtract
* Multiply
* Absolute
* Negative
Comparisons must be made between the same currency units.
#### Addition
Additions can be performed using `Add()`.
```go
pound := money.New(100, money.GBP)
twoPounds := money.New(200, money.GBP)
result, err := pound.Add(twoPounds) // £3.00, nil
```
#### Subtraction
Subtraction can be performed using `Subtract()`.
```go
pound := money.New(100, money.GBP)
twoPounds := money.New(200, money.GBP)
result, err := pound.Subtract(twoPounds) // -£1.00, nil
```
#### Multiplication
Multiplication can be performed using `Multiply()`.
```go
pound := money.New(100, money.GBP)
result := pound.Multiply(2) // £2.00
```
#### Absolute
Return `absolute` value of Money structure
```go
pound := money.New(-100, money.GBP)
result := pound.Absolute() // £1.00
```
#### Negative
Return `negative` value of Money structure
```go
pound := money.New(100, money.GBP)
result := pound.Negative() // -£1.00
```
Allocation
-
* Split
* Allocate
#### Splitting
In order to split Money for parties without losing any pennies due to rounding differences, use `Split()`.
After division leftover 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.
```go
pound := money.New(100, money.GBP)
parties, err := pound.Split(3)
if err != nil {
log.Fatal(err)
}
parties[0].Display() // £0.34
parties[1].Display() // £0.33
parties[2].Display() // £0.33
```
#### Allocation
To perform allocation operation use `Allocate()`.
It splits money using the given ratios without losing pennies and as Split operations distributes leftover pennies amongst the parties with round-robin principle.
```go
pound := money.New(100, money.GBP)
// Allocate is variadic function which can receive ratios as
// slice (int[]{33, 33, 33}...) or separated by a comma integers
parties, err := pound.Allocate(33, 33, 33)
if err != nil {
log.Fatal(err)
}
parties[0].Display() // £0.34
parties[1].Display() // £0.33
parties[2].Display() // £0.33
```
Format
-
To format and return Money as a string use `Display()`.
```go
money.New(123456789, money.EUR).Display() // €1,234,567.89
```
To format and return Money as a float64 representing the amount value in the currency's subunit use `AsMajorUnits()`.
```go
money.New(123456789, money.EUR).AsMajorUnits() // 1234567.89
```
Contributing
-
Thank you for considering contributing!
Please use GitHub issues and Pull Requests for contributing.
License
-
The MIT License (MIT). Please see License File for more information.
[](https://github.com/Rhymond/go-money)