Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marvincaspar/go-money
Go implementation of Martin Fowler's Money pattern. https://martinfowler.com/eaaCatalog/money.html
https://github.com/marvincaspar/go-money
fowler-money-pattern go golang money
Last synced: 3 months ago
JSON representation
Go implementation of Martin Fowler's Money pattern. https://martinfowler.com/eaaCatalog/money.html
- Host: GitHub
- URL: https://github.com/marvincaspar/go-money
- Owner: marvincaspar
- License: mit
- Created: 2018-10-16T06:47:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-22T13:45:14.000Z (over 5 years ago)
- Last Synced: 2024-05-14T00:23:49.767Z (6 months ago)
- Topics: fowler-money-pattern, go, golang, money
- Language: Go
- Size: 18.6 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - go-money
README
# Go Money
[](https://travis-ci.org/marvincaspar/go-money)
[](https://scrutinizer-ci.com/g/mc388/go-money/?branch=master)
[](https://scrutinizer-ci.com/g/mc388/go-money/?branch=master)
[](https://goreportcard.com/report/github.com/marvincaspar/go-money)
[](https://github.com/marvincaspar/go-money)
Go libraray to make working with money safer and easier!
```go
package main
import "github.com/marvincaspar/go-money"
func main() {
oneEuro := money.New(100, money.EUR())
twoEuro, err := oneEuro.Add(oneEuro)
if err != nil {
log.Fatal(err)
}
parties, err := twoEuro.Allocate(1, 1, 1)
if err != nil {
log.Fatal(err)
}
parties[0].Display() // €0.67
parties[1].Display() // €0.67
parties[2].Display() // €0.66
}
```
## Install
Get the package:
```sh
go get github.com/mc388/go-money
```
## Usage
### Initialzation
Initialze Money by using the smalles unit (e.g. 100 represents 1€) and one of the given currency factories.
```go
euro := money.New(100, money.EUR())
```
### Calculations
The following calculations are available:
* Add
* Subtract
* Multiply
* Allocate
#### Add
Use `Add(money)` to perform additions.
```go
oneEuro := money.New(100, money.EUR())
twoEuro := money.New(200, money.EUR())
threeEuro, err := oneEuro.Add(twoEuro) // €3, nil
}
```
#### Subtract
Use `Subtract(money)` to perform substractions.
```go
threeEuro := money.New(300, money.EUR())
twoEuro := money.New(200, money.EUR())
oneEuro, err := threeEuro.Subtract(twoEuro) // €1, nil
}
```
#### Multiply
Use `Multiply(multiplicator)` to perform multiplications.
```go
twoEuro := money.New(200, money.EUR())
eightEuro, err := twoEuro.Multiply(4) // €8, nil
}
```
#### Allocate
Use `Allocate(...ratioX)` to allocate money by a given rations without loosing any cent.
```go
oneEuro := money.New(100, money.EUR())
parties, err := oneEuro.Allocate(50, 50)
if err != nil {
log.Fatal(err)
}
parties[0].Display() // €0.50
parties[1].Display() // €0.50
}
```
```go
oneEuro := money.New(100, money.EUR())
parties, err := oneEuro.Allocate(1, 1, 1)
if err != nil {
log.Fatal(err)
}
parties[0].Display() // €0.34
parties[1].Display() // €0.33
parties[2].Display() // €0.33
}
```
### Comparison
The following comparion methods are available:
* Equals
* GreaterThan
* GreaterThanOrEqual
* LessThan
* LessThanOrEqual
Comparison can only performe between the same currency.
```go
oneEuro := money.New(100, money.EUR())
twoEuro := money.New(200, money.EUR())
oneDollar := money.New(100, money.USD())
result1, err := oneEuro.GreaterThan(twoEuro) // false, nil
result2, err := oneEuro.LessThan(twoEuro) // true, nil
result3, err := oneEuro.Equals(oneDollar) // nil, error: Currency don't match
}
```
## Tests
Run the unit tests with `go test -v -covermode=count -coverprofile=coverage.out`.
To view the coverage report use `go tool cover -func=coverage.out`