MoneyAttribute
Store and read Active Record attributes as Mint::Money objects with no manual serialization.
money_attribute uses two DB columns (amount + currency) for per-row multi-currency data. A simpler money_amount variant is also available for fixed-currency models (see note).
class Product < ApplicationRecord
money_attribute :price
end
p = Product.new(price: 12.44.dollars).price # => [USD 12.00]
p.price * 2 # => [USD 24.88]
Table of contents
- Quick start
- Why MoneyAttribute
- Requirements
- Installation
- Migration helpers
- Configuration
- Usage
- Column type detection
- Custom column names
- Column resolution
- Querying
- Convenience methods
- Form helpers
- Roadmap
- Development & Contributing
- License
Quick start
bundle add money_attribute
bin/rails g money_attribute:initializer
# db/migrate/20260620000000_create_products.rb
class CreateProducts < ActiveRecord::Migration[8.1]
def change
create_table :products do |t|
t.string :name
t.money_attribute :price # price: decimal(20,4), price_currency: string
t.
end
end
end
# app/models/product.rb
class Product < ApplicationRecord
money_attribute :price
end
That's it. Product.new(price: 12.dollars).price is a Mint::Money.
Why MoneyAttribute?
- No serialization boilerplate — declare once, read/write
Mint::Moneyeverywhere. - Integer or decimal columns — auto-detects the column type and adjusts serialization (e.g. integer stores cents, decimal stores unit value).
- Normalizes everything — pass a number, string, or
Mint::Money; always get aMint::Moneyback. - Currency enforcement — fixed-currency attributes reject wrong currencies at assignment time.
- Built on Rails primitives — uses
ActiveRecord::Type,composed_of, andnormalizesunder the hood. No monkey-patching of core classes.
At a glance — vs money-rails
| Feature | MoneyAttribute | money-rails |
|---|---|---|
| Declare | t.money_attribute :price / money_attribute :price or t.money_amount :price / money_amount :price |
monetize :price_cents |
| Column types | integer, decimal, bigint — auto-detected |
integer cents only |
| Storage modes | Composite (amount+currency), single column | Single cents column, composite (cents+currency) |
| Decimal columns | Native — t.decimal :price |
Not supported — must convert to cents manually |
| Multi-currency | money_attribute :price (convention: <name>_amount + <name>_currency) |
monetize :price_cents, with_currency: :price_currency |
| Rails integration | ActiveRecord::Type + composed_of — no monkey-patches |
monetize overrides reader/writer methods |
| Query (fixed) | Model.where(price: money) — =, IN, BETWEEN, ORDER, SUM |
Through cents column (price_cents) |
| Query (multi) | Model.where(price: money) |
Model.where(price_cents:, price_currency:) |
| Internal amount | Rational |
BigDecimal |
| Performance | See BENCHMARKS.md — wins 9/11 cells | — |
For a detailed side-by-side comparison, see COMPARISON.md.
Requirements
- Ruby 3.3+
- Rails 7.1.3.2+
- Minting 2.0+
Installation
# Gemfile
gem 'money_attribute'
bundle install
bin/rails g money_attribute:initializer
The generator creates config/initializers/money_attribute.rb.
Migration helpers
money_attribute (composite — amount + currency)
Primary migration helper for multi-currency attributes. Creates two columns — amount and currency.
| Method | Action |
|---|---|
add_money_attribute / t.money_attribute |
Amount column + currency column |
remove_money_attribute / t.remove_money_attribute |
Drops both columns |
Default columns: decimal(20,4) for amount + string(16) for currency.
Column types
| Amount type | Column type | Precision/Scale | Maximum | Integer digits |
|---|---|---|---|---|
:crypto_decimal |
decimal |
36/18 |
~1 quintillion | 18 |
:fiat_decimal |
decimal |
20/4 |
~10 quadrillion | 16 |
:fiat_integer |
bigint |
— | ~922 trillion | ~15 |
class CreateProducts < ActiveRecord::Migration[8.1]
def change
create_table :products do |t|
t.string :name
t.money_attribute :multi # decimal(20,4) + currency
t.money_attribute :tax, amount: { type: :fiat_integer } # bigint + currency
t.
end
end
end
class AddPriceToProducts < ActiveRecord::Migration[8.1]
def change
add_money_attribute :products, :price # price + price_currency
remove_money_attribute :products, :obsolete_fee # reversible in change
end
end
Naming
money_attribute (composite):
| Migration call | Columns created | Model declaration |
|---|---|---|
t.money_attribute :price |
price decimal(20,4) + price_currency string(16) |
money_attribute :price |
t.money_attribute :price_amount |
price_amount decimal(20,4) + price_currency string(16) |
money_attribute :price |
t.money_attribute :price, amount: { type: :fiat_integer } |
price bigint + price_currency string(16) |
money_attribute :price |
t.money_attribute :price, amount: { column: :a }, currency: { column: :c } |
a + c |
money_attribute :price, mapping: { amount: :a, currency: :c } |
t.money_attribute :price, currency: { limit: 5 } |
price decimal(20,4) + price_currency string(5) |
money_attribute :price |
t.remove_money_attribute :price |
Removes price + price_currency |
money_attribute :price |
Inside change_table:
change_table :products do |t|
t.remove_money_attribute :obsolete_fee # removes obsolete_fee + obsolete_fee_currency
end
Configuration
# config/initializers/money_attribute.rb
MoneyAttribute.configure do |config|
config.default_currency = 'USD'
end
See the Minting gem for full configuration options (custom currencies, formatting, rounding).
I18n / Locale-aware formatting
MoneyAttribute integrates with Rails I18n to automatically format money amounts according to the current locale.
With I18n.locale set to :en:
Mint.money(1234.56, 'USD').to_s # => "$1,234.56"
Switch to :'pt-BR' and the separators change automatically (requires rails-i18n or your own locale file):
I18n.locale = :'pt-BR'
Mint.money(1234.56, 'USD').to_s # => "$1.234,56"
The locale backend reads number.currency.format from your I18n translations and maps Rails format syntax (%n for amount, %u for unit) to Mint::Money#to_s. If the translation key is missing (no locale file for that language), it falls back to hardcoded defaults (. decimal, , thousand, %<symbol>s%<amount>f format).
You can configure per-sign formatting by adding positive, negative, and zero keys to your locale:
# config/locales/money_attribute.en.yml
en:
number:
currency:
format:
format: "%u%n" # fallback when no per-sign key matches
positive: "%u%n" # "$1,234.56"
negative: "(%u%n)" # "($1,234.56)"
zero: "--" # "--"
separator: "."
delimiter: ","
When any of positive, negative, or zero is present, a Hash format is built. Missing keys fall back to format:
Mint.money(1234.56, 'USD').to_s # => "$1,234.56"
Mint.money(-1234.56, 'USD').to_s # => "($1,234.56)"
Mint.money(0, 'USD').to_s # => "--"
If none of those keys are set, format is used as a plain string (simple formatting).
Formatting respects the currency's own
subunitfor decimal precision —I18nlocale settings forprecisionare ignored since that is a currency property, not a locale one.
Usage
class Offer < ApplicationRecord
money_attribute :price
end
offer = Offer.new(price: 15.to_money('EUR'))
offer.price # => [EUR 15.00]
offer.price_amount # => 15.0
offer.price_currency # => "EUR"
offer = Offer.new(price: '12')
offer.price.currency.code # => "USD"
Unlike fixed-currency attributes, composite mode does not enforce a specific currency — any registered currency is accepted at assignment.
Invalid currencies in the database
If the currency column contains a value that is not a registered currency (e.g. a legacy code that was removed, or data corruption), money_attribute does not crash. The currency resolves to XXX (ISO 4217 "No Currency") and the monetary amount is preserved:
offer = Offer.find(42)
offer.price # => [XXX 10.00] # amount preserved, currency flagged
Records with XXX currency are easily queryable for cleanup:
Offer.where(price_currency: 'XXX')
Column type detection
Select the amount column type via the type: option. The gem adapts serialization accordingly:
# Migration
create_table :orders do |t|
t.money_attribute :total, amount: { type: :fiat_integer } # bigint — stored as subunits
end
# Model
class Order < ApplicationRecord
money_attribute :total
end
Order.new(total: 19.99.to_money('USD')).total_amount # => 1999
Use
:fiat_integer(bigint) for large tables — smaller and sufficient for most fiat use cases (~922 trillion max). Use:fiat_decimal(decimal) when SQL-level readability matters. For cryto currencies support,:crypto_decimalis mandatory.
Custom column names
If your columns don't follow the <name>_amount / <name>_currency convention:
class Invoice < ApplicationRecord
money_attribute :total, mapping: {
amount: :total_amount,
currency: :currency_code
}
end
The mapping keys are :amount and :currency; values are your database column names. You can provide only one key — the other falls back to the <name>_amount / <name>_currency convention:
class Invoice < ApplicationRecord
money_attribute :total, mapping: { amount: :total_amount }
# currency column inferred as `total_currency`
end
Column resolution
money_attribute :name is always composite. It resolves columns in this order:
| Step | Condition | Columns used |
|---|---|---|
| 1 | mapping: provided |
As specified (missing keys fall back to <name>_amount / <name>_currency) |
| 2 | name_currency column exists AND name column exists |
name + name_currency |
| 3 | name == 'amount' AND currency column exists |
amount + currency |
| 4 | None of the above | <name>_amount + <name>_currency (convention) |
Step 4 raises ArgumentError if the convention columns don't exist. For single-column fixed-currency attributes, see money_amount.
Example
create_table :financial_transactions do |t|
t.integer :amount
t.string :currency, limit: 3
t.integer :discount
t.string :discount_currency, limit: 3
t.decimal :price_amount
t.string :price_currency, limit: 3
t.bigint :tax
t.decimal :total_amount
t.string :currency_code, limit: 3
end
class FinancialTransaction < ApplicationRecord
money_attribute :amount # step 3: amount(int) + currency
money_attribute :discount # step 2: discount(int) + discount_currency
money_attribute :price # step 4: price_amount + price_currency
money_attribute :total, mapping: { amount: :total_amount, currency: :currency_code } # step 1: explicit
money_amount :tax # single-column, fixed-currency (uses default currency)
end
Querying
Multi-currency (money_attribute) attributes support equality queries via composed_of:
Offer.where(price: 10.to_money('EUR'))
For comparisons, use the backing columns directly:
Offer.where(price_amount: 10..20, price_currency: 'EUR')
Offer.where('price_amount > ? AND price_currency = ?', 10, 'EUR')
For fixed-currency (money_amount) attributes, see the single-column section.
Convenience methods
MoneyAttribute adds small helpers on Numeric and String:
12.to_money('USD') # => [USD 12.00]
12.dollars # => [USD 12.00]
12.euros # => [EUR 12.00]
If you prefer not to extend core classes, use
Mint.money(12, 'USD')instead.
Form helpers
MoneyAttribute adds money_field and money_amount_field to Rails form builders. money_field renders a text input with the locale-formatted money string; money_amount_field renders a number input with the raw decimal value.
<%= form_with model: @product do |form| %>
<%= form.label :price %>
<%= form.money_field :price %> <!-- text input, e.g. "$1,234.56" -->
<%= form.label :tax %>
<%= form.money_amount_field :tax %> <!-- number input, e.g. "1234.56" -->
<% end %>
Single-column mode — money_amount (fixed-currency)
money_amount wraps a numeric column as Mint::Money using the application's default currency. No per-row currency. A lighter alternative when you don't need multi-currency support.
Migration helpers
| Method | Action |
|---|---|
add_money_amount / t.money_amount |
Amount column only |
remove_money_amount / t.remove_money_amount |
Drops the column |
Default column: decimal(20,4). The top-level type: shortcut selects the column type:
t.money_amount :price # decimal(20,4)
t.money_amount :btc_balance, type: :crypto_decimal # decimal(36,18)
t.money_amount :qty, type: :fiat_integer # bigint
Naming
| Migration call | Columns created | Model declaration |
|---|---|---|
t.money_amount :price |
price decimal(20,4) |
money_amount :price |
t.money_amount :btc, type: :crypto_decimal |
btc decimal(36,18) |
money_amount :btc |
t.money_amount :price, type: :fiat_integer |
price bigint |
money_amount :price |
t.money_amount :price, type: :fiat_decimal |
price decimal(20,4) |
money_amount :price |
Usage
class Product < ApplicationRecord
money_amount :price
end
product = Product.new(price: 12)
product.price # => [USD 12.00]
Product.new(price: 12.to_money('EUR'))
# => ArgumentError: ... has different currency. Only USD allowed.
Column type shortcut
# Migration
t.money_amount :price, type: :fiat_integer # bigint column
# Model
money_amount :price
Querying
Fixed-currency attributes support Rails-native querying through the custom type:
Product.where(price: 10.to_money('USD')) # equality
Product.where(price: [10.to_money('USD'), 20.to_money('USD')]) # IN
Product.where(price: 10.to_money('USD')..20.to_money('USD')) # BETWEEN
Product.order(price: :desc) # ordering
Product.where(price: 10.to_money('USD')).sum(:price) # aggregation
Roadmap
- Method-level currency — lambda-based currency resolution for multi-tenant and instance-level scenarios
Contributions and suggestions are welcome — open an issue or PR at gferraz/money-attribute.
Development
bundle install
bundle exec rake test
The dummy Rails app under test/dummy exercises the engine in a full Rails environment.
Contributing
Bug reports and pull requests welcome at gferraz/money-attribute.