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

Extended Modules

• Money::Constructors
• Money::Parse

Defined in:

Constant Summary

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

Constructors

• .new(amount : Number = 0, currency = Money.default_currency, bank = nil)

  Creates a new Money object of value given as an amount of the given currency (as fractional if Int, or whole amount otherwise)

• .new(pull : JSON::PullParser)

Class Method Summary

• .default_bank : Bank

  Each Money object is associated to a bank object, which is responsible for currency exchange.

• .default_bank=(default_bank : Bank)

  Each Money object is associated to a bank object, which is responsible for currency exchange.

• .default_currency : Currency

  Sets the default currency for creating new Money object.

• .default_currency=(default_currency : Currency)

  Sets the default currency for creating new Money object.

• .default_currency=(currency_code : String | Symbol)

  Sets the default currency for creating new Money object.

• .disallow_currency_conversion!

  Sets the default bank to be a Bank::SingleCurrency bank that raises on currency exchange.

• .infinite_precision=(infinite_precision : Bool)

  Use this to enable infinite precision cents

• .infinite_precision? : Bool

  Use this to enable infinite precision cents

• .rounding_mode : Number::RoundingMode

  Default rounding mode

• .rounding_mode=(rounding_mode : Number::RoundingMode)

  Default rounding mode

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

  Sets the given rounding mode within the scope of the given block

Instance Method Summary

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

  Compares two Money objects.

• #amount : BigDecimal

  Returns the numerical value of the money.

• #bank : Bank

  The Bank object which currency exchanges are performed with.

• #bank=(bank : Bank | Nil)

  The Bank object which currency exchanges are performed with.

• #cents : BigInt

  Alias of #fractional.

• #currency : Currency

  The money's currency.

• #dollars : BigDecimal

  Alias of #amount.

• #fractional : BigInt

  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.

• #nearest_cash_value : BigInt

  Returns the nearest possible amount in cash value (cents).

• #rounded_to_nearest_cash_value : Money

  See #nearest_cash_value.

Constructor Detail

Money.new                      # => Money(@amount=0 @currency="USD")
Money.new(1_50)                # => 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")

Class Method Detail

Instance Method Detail

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