money

# Money

[![CI Status](https://github.com/elixirmoney/money/actions/workflows/ci.yml/badge.svg)](https://github.com/elixirmoney/money/actions/workflows/ci.yml)
[![Module Version](https://img.shields.io/hexpm/v/money.svg)](https://hex.pm/packages/money)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/money/)
[![Total Download](https://img.shields.io/hexpm/dt/money.svg)](https://hex.pm/packages/money)
[![License](https://img.shields.io/hexpm/l/money.svg)](https://hex.pm/packages/money)
[![Last Updated](https://img.shields.io/github/last-commit/elixirmoney/money.svg)](https://github.com/elixirmoney/money/commits/master)

Elixir library for working with Money safer, easier, and fun, is an interpretation of the Martin Fowler's [Money pattern](https://www.martinfowler.com/eaaCatalog/money.html) in functional programming.

> "If I had a dime for every time I've seen someone use FLOAT to store currency, I'd have \$999.997634" -- [Bill Karwin](https://twitter.com/billkarwin/status/347561901460447232)

In short: You shouldn't represent monetary values by a float. Wherever
you need to represent money, use `Money`.

## Installation

Money comes with no required dependencies.

Add the following to your `mix.exs`:

```elixir
def deps do
  [{:money, "~> 1.14"}]
end
```

then run [`mix deps.get`](http://elixir-lang.org/getting-started/mix-otp/introduction-to-mix).

## Usage

```elixir
five_eur         = Money.new(500, :EUR)             # %Money{amount: 500, currency: :EUR}
ten_eur          = Money.add(five_eur, five_eur)    # %Money{amount: 10_00, currency: :EUR}
hundred_eur      = Money.multiply(ten_eur, 10)      # %Money{amount: 100_00, currency: :EUR}
ninety_nine_eur  = Money.subtract(hundred_eur, 100) # %Money{amount: 99_00, currency: :EUR}
shares           = Money.divide(ninety_nine_eur, 2) # [%Money{amount: 4950, currency: :EUR}, %Money{amount: 4950, currency: :EUR}]

Money.equals?(five_eur, Money.new(500, :EUR)) # true
Money.zero?(five_eur);                        # false
Money.positive?(five_eur);                    # true

Money.Currency.symbol(:USD)                   # $
Money.Currency.symbol(Money.new(500, :AFN))   # ؋
Money.Currency.name(Money.new(500, :AFN))     # Afghani

Money.to_string(Money.new(500, :CNY))         # ¥ 5.00
Money.to_string(Money.new(1_234_56, :EUR), separator: ".", delimiter: ",", symbol: false)
"1.234,56"
Money.to_string(Money.new(1_234_56, :USD), fractional_unit: false)  # "$1,234"
Money.to_string(Money.new(1_234_50, :USD), strip_insignificant_zeros: true)  # "$1,234.5"
```

### Serialization to database with single currency

Bring `Money` to your Ecto project.
The underlying database type is `integer`

1.  Set a default currency in `config.ex`:

    ```elixir
    config :money,
      default_currency: :USD
    ```

2.  Create migration with integer type:

    ```elixir
    create table(:jobs) do
      add :amount, :integer
    end
    ```

3.  Create schema using the `Money.Ecto.Amount.Ty