struct Money

• Money
• Struct
• Value
• Object

Overview

"Money is any object or record that is generally accepted as payment for goods and services and repayment of debts in a given socio-economic context or country." - Wikipedia

An instance of Money represents an amount of a specific currency.

Money is a value object and should be treated as immutable.

Included Modules

• Comparable(Money)
• JSON::Serializable
• Money::Allocate
• Money::Arithmetic
• Money::Casting
• Money::Exchange
• Money::Formatting
• Money::Rounding
• Steppable

Extended Modules

• Money::Constructors
• Money::Context::Delegators
• Money::Parse

Defined in:

Constant Summary

VERSION = {{ (`shards version \"/home/runner/work/money/money/src/money\"`).chomp.stringify }}

Constructors

• .new(pull : JSON::PullParser)
• .new(value : Int = 0, currency = Money.default_currency, exchange = nil)

  Creates a new Money object of value given as an fractional amount of the given currency.

• .new(value : Number, currency = Money.default_currency, exchange = nil)

  Creates a new Money object of value given as an whole amount of the given currency.

• .new(*, amount : Number, currency = Money.default_currency, exchange : Money::Currency::Exchange | Nil = nil)

  Creates a new Money object of value given as an amount of the given currency.

• .new(*, fractional : Number, currency = Money.default_currency, exchange : Money::Currency::Exchange | Nil = nil)

  Creates a new Money object of value given as a fractional of the given currency.

Class Method Summary

• .configure(& : Money::Context -> ) : Nil

  Yields the given block with the current Money.context as an argument.

• .disallow_currency_conversion!

  Sets the default exchange to be a Currency::Exchange::SingleCurrency exchange that raises on currency exchange.

• .spawn_with_same_context(**options, &block : -> ) : Nil

  Spawns a new fiber with the Money::Context copied from the current fiber.

• .with_infinite_precision(enabled = true, &)

  Sets the given infinite precision value within the lifetime of the given block.

• .with_rounding_mode(mode : Number::RoundingMode, &)

  Sets the given rounding mode within the lifetime of the given block.

• .without_currency_conversion(&)

  Disallows currency conversion within the lifetime of the given block.

Instance Method Summary

• #<=>(other : Money) : Int32

  Compares two Money objects.

• #amount : BigDecimal

  Returns the numerical value of the money.

• #cents : BigDecimal

  Alias of #fractional.

• #currency : Currency

  The money's currency.

• #eql?(other : Money) : Bool

  Returns true if the two Money objects have same #amount and #currency, false otherwise.

• #exchange : Currency::Exchange
• #exchange=(exchange : Currency::Exchange | Nil)
• #fractional : BigDecimal

  The value of the monetary amount represented in the fractional or subunit of the currency.

• #hash(hasher)

  Returns hash value based on the #amount and #currency attributes.

• #succ : Money

  Returns a new Money instance with incremented #fractional value.

• #to_json(json : JSON::Builder)
• #with_currency(new_currency : String | Symbol | Currency) : Money

  Returns a new Money instance in a given currency - if it's different from the current #currency - or self otherwise, leaving the amount intact and not performing currency conversion.

Constructor Detail

Money.new(0, "USD")    # => Money(@amount=0.0 @currency="USD")
Money.new(1_50, "USD") # => Money(@amount=1.5 @currency="USD")

Money.new(1.5, "USD")          # => Money(@amount=1.5 @currency="USD")
Money.new(1.5.to_big_d, "USD") # => Money(@amount=1.5 @currency="USD")

Money.new(amount: 13.37) # => Money(@amount=13.37)

Money.new(fractional: 13_37) # => Money(@amount=13.37)

Class Method Detail

Money.configure do |context|
  context.infinite_precision = true
  context.default_currency = "EUR"
end

Money.default_currency.code # => "USD"
Money.default_currency = "PLN"

spawn do
  Money.default_currency.code # => "USD"
end

# vs

Money.spawn_with_same_context do
  Money.default_currency.code # => "PLN"
end

Instance Method Detail

Money.new(1_00, "USD").amount # => 1.0

Money.new(1_00, "USD").succ # => Money(@amount=1.01 @currency="USD")
Money.new(1, "JPY").succ    # => Money(@amount=2 @currency="JPY")