Class: Mint::Money

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/minting/mint/i18n.rb,
lib/minting/money/clamp.rb,
lib/minting/money/money.rb,
lib/minting/money/coercion.rb,
lib/minting/money/comparable.rb,
lib/minting/money/conversion.rb,
lib/minting/money/format/to_s.rb,
lib/minting/money/constructors.rb,
lib/minting/money/allocation/split.rb,
lib/minting/money/format/formatting.rb,
lib/minting/money/arithmetics/methods.rb,
lib/minting/money/allocation/allocation.rb,
lib/minting/money/arithmetics/operators.rb

Overview

:nodoc:

Constant Summary collapse

DEFAULT_FORMAT =

The default display format pattern for formatting monetary values. Uses ‘%<symbol>s` for the currency symbol and `%<amount>f` for the rounded amount.

'%<symbol>s%<amount>f'
PRESETS = 
{
  amount: { format: '%<amount>f' },
  accounting: { format: { negative: '(%<symbol>s%<amount>f)' } },
  european: { format: '%<amount>f %<symbol>s', decimal: ',', thousand: '.' },
  currency: { format: '%<currency>s %<amount>f' }
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



24
25
26
 
# File 'lib/minting/money/money.rb', line 24

def amount
  @amount
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



24
25
26
 
# File 'lib/minting/money/money.rb', line 24

def currency
  @currency
end

Class Method Details

.create(amount, currency) ⇒ Object

Backwards-compatible alias for previous API TODO: deprecate in a future major release



69
70
71
72
 
# File 'lib/minting/money/constructors.rb', line 69

def self.create(amount, currency)
  warn 'Money.create is now deprecated. Use Money.from'
  from(amount, currency)
end

.from(amount, currency) ⇒ Money

Creates a new Money immutable object with the specified amount and currency

Examples:

Money.from(10, 'USD')  #=> [USD 10.00]

Parameters:

  • amount (Numeric) —

    The monetary amount

  • currency (Currency, String) —

    The currency code or currency object

Returns:

  • (Money) —

    the new Money instance

Raises:

  • (ArgumentError) —

    If amount is not numeric or currency is invalid



13
14
15
16
17
18
19
20
 
# File 'lib/minting/money/constructors.rb', line 13

def self.from(amount, currency)
  raise ArgumentError, 'amount must be Numeric' unless amount.is_a?(Numeric)

  currency = Currency.resolve!(currency)
  amount = currency.normalize_amount(amount)

  amount.zero? ? currency.zero : new(amount, currency)
end

.from_subunits(subunits, currency) ⇒ Money

Builds a Money from a subunit (smallest-unit) Integer amount. This is the inverse of #subunits: for USD, the subunit is 1 cent; for JPY it is 1 yen; for IQD it is 1 dinar (subunit 3).

Examples:

USD cents

Money.from_subunits(123_456, 'USD') #=> [USD 1234.56]

JPY (subunit 0)

Money.from_subunits(1234, 'JPY')    #=> [JPY 1234]

Round trip

m = Mint.money(9.99, 'USD')
Money.from_subunits(m.subunits, 'USD') == m #=> true

Parameters:

  • subunits (Integer) —

    the amount expressed in the currency’s smallest unit (e.g. cents). Must be an Integer to preserve exactness.

  • currency (String, Symbol, Currency) —

    the currency identifier

Returns:

  • (Money) —

    the resulting Money instance

Raises:

  • (ArgumentError) —

    if subunits is not an Integer or currency is not registered



92
93
94
95
96
97
98
 
# File 'lib/minting/money/constructors.rb', line 92

def self.from_subunits(subunits, currency)
  raise ArgumentError, 'subunits must be an Integer' unless subunits.is_a?(Integer)

  currency = Currency.resolve!(currency)
  amount = Rational(subunits, currency.fractional_multiplier)
  amount.zero? ? currency.zero : new(amount, currency)
end

.no_currency(amount) ⇒ Money

Creates a new Money without a currency (ISO 4217 XXX — “No Currency”).

Examples:

Money.no_currency(100)  #=> [XXX 100]

Parameters:

  • amount (Numeric) —

    The monetary amount

Returns:

  • (Money) —

    a Money instance with the XXX currency

Raises:

  • (ArgumentError) —

    If amount is not numeric



29
 
# File 'lib/minting/money/constructors.rb', line 29

def self.no_currency(amount) = from(amount, 'XXX')

.parse(input, currency = nil) ⇒ Money?

Parses a human-readable money string into a Mint::Money object.

Returns nil when the input is invalid or currency cannot be determined.

Examples:

With explicit currency

Money.parse('19.99', 'USD')    #=> [USD 19.99]
Money.parse('garbage', 'USD')  #=> nil

With symbol or code in the string

Money.parse('$19.99')            #=> [USD 19.99]
Money.parse('USD 1,234.56')    #=> [USD 1234.56]

Parameters:

  • input (String) —

    Amount input, optionally including a currency symbol or code

  • currency (String, Symbol, Currency, nil) (defaults to: nil) —

    ISO code when not present in input

Returns:



46
 
# File 'lib/minting/money/constructors.rb', line 46

def self.parse(input, currency = nil) = Mint.parse(input, currency)

.parse!(input, currency = nil) ⇒ Money

Like parse but raises on failure.

Examples:

Money.parse!('19.99', 'USD')    #=> [USD 19.99]
Money.parse!('garbage', 'USD')  #=> ArgumentError

Parameters:

  • input (String) —

    Amount input, optionally including a currency symbol or code

  • currency (String, Symbol, Currency, nil) (defaults to: nil) —

    ISO code when not present in input

Returns:

Raises:

  • (ArgumentError) —

    when input is invalid or currency cannot be determined



58
 
# File 'lib/minting/money/constructors.rb', line 58

def self.parse!(input, currency = nil) = Mint.parse!(input, currency)

.zero(currency) ⇒ Money

Returns a frozen zero Money in the given currency.

Parameters:

  • currency (String, Currency) —

    a currency code or object

Returns:

  • (Money) —

    a frozen zero-Money

Raises:

  • (ArgumentError) —

    if the currency can’t be resolved



65
 
# File 'lib/minting/money/constructors.rb', line 65

def self.zero(currency) = Currency.resolve!(currency).zero

Instance Method Details

#*(multiplicand) ⇒ Money

Performs multiplication of the monetary value by a standard scalar Numeric.

Parameters:

  • multiplicand (Numeric) —

    the scalar multiplier

Returns:

  • (Money) —

    the multiplied Money instance

Raises:

  • (TypeError) —

    if multiplier is not Numeric or is a Money object



42
43
44
45
46
 
# File 'lib/minting/money/arithmetics/operators.rb', line 42

def *(multiplicand)
  raise TypeError, "#{self} can't be multiplied by #{multiplicand}" unless multiplicand.is_a?(Numeric)

  copy_with(amount: amount * multiplicand)
end

#**(exponent) ⇒ Money

Performs exponentiation of the monetary value by a standard scalar Numeric.

Parameters:

  • exponent (Numeric)

Returns:

  • (Money) —

    reult of amount ** exponent

Raises:

  • (TypeError) —

    if exponent is not Numeric



67
68
69
70
71
 
# File 'lib/minting/money/arithmetics/operators.rb', line 67

def **(exponent)
  return copy_with(amount: amount**exponent) if exponent.is_a?(Numeric)

  raise TypeError, "#{self} can't be powered by #{exponent}"
end

#+(addend) ⇒ Money

Performs addition with another Mint::Money instance or standard zero Numeric.

Parameters:

  • addend (Money, Numeric) —

    the value to add

Returns:

  • (Money) —

    the sum of the addition

Raises:

  • (TypeError) —

    if addition involves a different currency or incompatible types



11
12
13
14
15
16
17
 
# File 'lib/minting/money/arithmetics/operators.rb', line 11

def +(addend)
  case addend
  in 0 then self
  in Money if same_currency?(addend) then copy_with(amount: amount + addend.amount)
  else raise TypeError, "#{addend} can't be added to #{self}"
  end
end

#-(subtrahend) ⇒ Money

Performs subtraction with another Mint::Money instance or standard zero Numeric.

Parameters:

  • subtrahend (Money, Numeric) —

    the value to subtract

Returns:

  • (Money) —

    the difference of the subtraction

Raises:

  • (TypeError) —

    if subtraction involves a different currency or incompatible types



24
25
26
27
28
29
30
 
# File 'lib/minting/money/arithmetics/operators.rb', line 24

def -(subtrahend)
  case subtrahend
  when 0     then return self
  when Money then return copy_with(amount: amount - subtrahend.amount) if same_currency?(subtrahend)
  end
  raise TypeError, "#{subtrahend} can't be subtracted from #{self}"
end

#-@ ⇒ Money

Unary negation operator. Returns a new Mint::Money instance with the inverted sign.

Returns:

  • (Money) —

    negated Money instance



35
 
# File 'lib/minting/money/arithmetics/operators.rb', line 35

def -@ = copy_with(amount: -amount)

#/(divisor) ⇒ Money, Numeric

Performs division of the monetary value by a scalar Numeric or identical currency Mint::Money.

Parameters:

  • divisor (Numeric, Money) —

    the divisor

Returns:

  • (Money, Numeric) —

    a new Money (scalar division) or a numeric ratio (Money division)

Raises:

  • (TypeError) —

    if divisor is of incompatible type or different currency

  • (ZeroDivisionError) —

    if division by zero is attempted



54
55
56
57
58
59
60
 
# File 'lib/minting/money/arithmetics/operators.rb', line 54

def /(divisor)
  case divisor
  when Numeric then return copy_with(amount: amount / divisor)
  when Money   then return amount / divisor.amount if same_currency? divisor
  end
  raise TypeError, "#{self} can't be divided by #{divisor}"
end

#<=>(other) ⇒ Object

Examples:

two_usd == Mint.money(2r, 'USD') #=> [$ 2.00]
two_usd > 0                      #=> true
two_usd > Mint.money(2, 'USD')   #=> false
two_usd > 1
=> TypeError: [$ 2.00] can't be compared to 1
two_usd > Mint.money(2, 'BRL')
=> TypeError: [$ 2.00] can't be compared to [R$ 2.00]


36
37
38
39
40
41
42
 
# File 'lib/minting/money/comparable.rb', line 36

def <=>(other)
  case other
  in 0                                    then amount <=> other
  in Mint::Money if same_currency?(other) then amount <=> other.amount
  else                                    raise TypeError, "#{inspect} can't be compared to #{other.inspect}"
  end
end

#==(other) ⇒ Object

Returns true if both are zero, or both have same amount and same currency.

Returns:

  • true if both are zero, or both have same amount and same currency



9
10
11
12
13
14
15
 
# File 'lib/minting/money/comparable.rb', line 9

def ==(other)
  case other
  when 0           then zero?
  when Mint::Money then amount == other.amount && currency == other.currency
  else                  false
  end
end

#abs ⇒ Money

Returns the absolute value of the monetary amount as a new Mint::Money instance.

Returns:

  • (Money) —

    the absolute value



9
 
# File 'lib/minting/money/arithmetics/methods.rb', line 9

def abs = copy_with(amount: amount.abs)

#allocate(proportions) ⇒ Array<Money>

Proportionally allocates the monetary amount among a list of ratios. Disperses any subunit rounding amounts across the initial slots

Examples:

Proportional allocation

money = Mint.money(10.00, 'USD')
money.allocate([1, 2, 3]) #=> [[USD 1.67], [USD 3.33], [USD 5.00]]

Parameters:

  • proportions (Array<Numeric>) —

    a list of numeric proportions/ratios to allocate by

Returns:

  • (Array<Money>) —

    the list of newly allocated Money objects

Raises:

  • (ArgumentError) —

    if the proportions list is empty or sums to zero



15
16
17
18
19
20
21
22
 
# File 'lib/minting/money/allocation/allocation.rb', line 15

def allocate(proportions)
  whole = proportions.sum.to_r
  raise ArgumentError, 'Need at least 1 proportion element' if proportions.empty?
  raise ArgumentError, 'Proportions total must not be zero' if whole.zero?

  amounts = proportions.map { |rate| currency.normalize_amount(Rational(amount * rate, whole)) }
  allocate_left_over(amounts: amounts, left_over: amount - amounts.sum)
end

#clamp(min_or_range, max = nil) ⇒ Money

Constrains self to the inclusive range [min, max].

Bounds may be:

  • nil meaning no boundary

  • same-currency Mint::Money or Range

  • Numeric amount, or Range

Numeric is interpreted as an amount in self‘s currency, so the common pricing idiom price.clamp(0, 100) reads as “0 to 100 in the same currency as price”.

When self is already in range the receiver is returned (no new object allocated). When out of range, the nearest bound is returned as a new frozen Mint::Money in self‘s currency.

Examples:

In range

Mint.money(5, 'USD').clamp(0, 10) #=> [USD 5.00]  (returns self)

Out of range, with Numeric bounds

Mint.money(50, 'USD').clamp(0, 10) #=> [USD 10.00]

Out of range, with Money bounds

loss  = Mint.money(-5, 'USD')
floor = Mint.money(0,  'USD')
ceil  = Mint.money(10, 'USD')
loss.clamp(floor, ceil) #=> [USD 0.00]

Subunit-0 currency (JPY)

Mint.money(500, 'JPY').clamp(0, 100) #=> [JPY 100]

Parameters:

  • min_or_range (Money, Numeric, Range, nil) —

    lower bound (inclusive), or range

  • max (Money, Numeric, nil) (defaults to: nil) —

    upper bound (inclusive)

Returns:

  • (Money) —

    self if in range, otherwise the nearer bound

Raises:

  • (ArgumentError) —

    if min or max is not a Money, Numeric or nil; if a Money operand has a different currency; if min > max; if min is a Range, and max is not nil



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/minting/money/clamp.rb', line 42

def clamp(min_or_range, max = nil)
  if min_or_range.is_a?(Range)
    raise(ArgumentError, "Either amount range alone or two amounts accepted: #{max}") if max

    min, max = min_or_range.minmax
  else
    min = min_or_range
  end
  copy_with(amount: amount.clamp(normalize_boundary(min), normalize_boundary(max)))
end

#coerce(other) ⇒ Array(CoercedNumber, Money)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Allows Mint::Money to interact seamlessly as the right-hand operand in Numeric arithmetic. This enables expressions like ‘5 * money` where `5` is a Numeric and `money` is a Money object.

Examples:

price = Mint.money(10, 'USD')
5 * price  #=> [USD 50.00] (via coercion)

Parameters:

  • other (Numeric) —

    the left-hand operand to coerce

Returns:

  • (Array(CoercedNumber, Money)) —

    coerced operand array



14
15
16
 
# File 'lib/minting/money/coercion.rb', line 14

def coerce(other)
  [CoercedNumber.new(other), self]
end

#copy_with(amount:) ⇒ Money

Returns a new Money object with the specified amount, or self if unchanged. This is the primary method for creating a modified copy of a Money instance while preserving immutability.

Examples:

price = Mint.money(10.00, 'USD')
price.copy_with(amount: 15.00)  #=> [USD 15.00]
price.copy_with(amount: 10.00)  #=> [USD 10.00] (returns self)

Parameters:

  • amount (Numeric) —

    The new monetary amount

Returns:

  • (Money) —

    A new Money object with the new amount, or self if the amount is unchanged



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/minting/money/constructors.rb', line 110

def copy_with(amount:)
  amount = currency.normalize_amount(amount)

  if amount == self.amount
    self
  elsif amount.zero?
    currency.zero
  else
    Money.new(amount, currency)
  end
end

#currency_code ⇒ String

Returns the ISO 3-letter currency code string.

Examples:

Mint.money(100, 'USD').currency_code  #=> "USD"

Returns:

  • (String) —

    the ISO currency code (e.g., “USD”, “EUR”, “BRL”)



31
 
# File 'lib/minting/money/money.rb', line 31

def currency_code = currency.code

#eql?(other) ⇒ Boolean

Strict equality — both amount and currency must match exactly. Unlike ==, does not treat zero as equivalent across currencies.

Returns:

  • (Boolean) 


21
22
23
24
25
 
# File 'lib/minting/money/comparable.rb', line 21

def eql?(other)
  other.is_a?(Mint::Money) &&
    amount == other.amount &&
    currency == other.currency
end

#fractional ⇒ Object

Returns the fractional part of the amount.

Examples:

Mint.money(1234.56, 'USD').fractional  #=> 56
Mint.money(1000, 'JPY').fractional     #=> 0
Mint.money(123.456, 'IQD').fractional  #=> 456


48
 
# File 'lib/minting/money/money.rb', line 48

def fractional = ((amount.abs % 1) * currency.fractional_multiplier).to_i

#hash ⇒ Integer

Generates a stable hash key for Money instances.

Returns:

  • (Integer) —

    the calculated hash value



53
 
# File 'lib/minting/money/money.rb', line 53

def hash = [amount, currency_code].hash

#inspect ⇒ String

Returns a standard developer-oriented string inspection of the Money object.

Returns:

  • (String) —

    the formatted inspect representation



58
59
60
 
# File 'lib/minting/money/money.rb', line 58

def inspect
  Kernel.format "[#{currency_code} %0.#{currency.subunit}f]", amount
end

#mint(new_amount) ⇒ Money

Deprecated.

Use #copy_with instead. Will be removed in v2.

Returns a new Money with the given amount in the same currency.

Examples:

Mint.money(10, 'USD').mint(15)  #=> [USD 15.00]

Parameters:

  • new_amount (Numeric) —

    the new monetary amount

Returns:

  • (Money) —

    a new Money instance, or self if unchanged



129
130
131
132
 
# File 'lib/minting/money/constructors.rb', line 129

def mint(new_amount)
  warn 'Money#mint is now deprecated and will be removed in v2'
  copy_with(amount: new_amount)
end

#negative? ⇒ Boolean

Returns true if the monetary amount is less than zero.

Returns:

  • (Boolean) —

    true if negative, false otherwise



14
 
# File 'lib/minting/money/arithmetics/methods.rb', line 14

def negative? = amount.negative?

#nonzero? ⇒ self?

Returns self if amount is non-zero, nil otherwise.

Returns:

  • (self, nil) —

    self if amount is non-zero, nil otherwise



45
 
# File 'lib/minting/money/comparable.rb', line 45

def nonzero? = amount.nonzero?

#positive? ⇒ Boolean

Returns true if the monetary amount is greater than zero.

Returns:

  • (Boolean) —

    true if positive, false otherwise



19
 
# File 'lib/minting/money/arithmetics/methods.rb', line 19

def positive? = amount.positive?

#same_currency?(other) ⇒ Boolean

Helper method to verify if another Money has the identical currency.

Parameters:

  • other (Money) —

    the target currency to compare

Returns:

  • (Boolean) —

    true if currencies match, false otherwise



51
 
# File 'lib/minting/money/comparable.rb', line 51

def same_currency?(other) = other.currency == currency

#split(slices) ⇒ Array<Money>

Splits the monetary amount into a given quantity of equal parts. Disperses any fractional subunit rounding differences across the initial slots so that the sum is preserved.

Examples:

Even split

money = Mint.money(10.00, 'USD')
money.split(3) #=> [[USD 3.34], [USD 3.33], [USD 3.33]]

Parameters:

  • slices (Integer) —

    the number of equal parts to divide the money into (must be > 0)

Returns:

  • (Array<Money>) —

    the list of newly split Money objects

Raises:

  • (ArgumentError) —

    if quantity is not a positive integer



17
18
19
20
21
22
23
 
# File 'lib/minting/money/allocation/split.rb', line 17

def split(slices)
  raise ArgumentError, 'Slices quantity must be an poitive integer' unless slices.positive? && slices.integer?

  fraction = currency.normalize_amount(amount / slices)
  allocate_left_over(amounts: Array.new(slices, fraction),
                     left_over: amount - (fraction * slices))
end

#subunits ⇒ Integer

Returns the monetary amount expressed in the currency’s smallest unit (fractional units). For example, cents for USD (subunit 2), yen for JPY (subunit 0), fils for IQD (subunit 3).

Examples:

Mint.money(1234.56, 'USD').subunits  #=> 123456
Mint.money(1000, 'JPY').subunits     #=> 1000
Mint.money(123.456, 'IQD').subunits  #=> 123456

Returns:

  • (Integer) —

    the amount in fractional units



41
 
# File 'lib/minting/money/money.rb', line 41

def subunits = (amount * currency.fractional_multiplier).to_i

#succ ⇒ Money

Returns the successor of the Money instance by adding the minimum possible subunit amount. Enables standard ranges and stepping (e.g. ‘1.dollar..10.dollars`).

Returns:

  • (Money) —

    successor Money instance



25
 
# File 'lib/minting/money/arithmetics/methods.rb', line 25

def succ = copy_with(amount: amount + currency.minimum_amount)

#to_d ⇒ BigDecimal

Converts the monetary amount to a BigDecimal object.

Examples:

Mint.money(9.99, 'USD').to_d  #=> 0.999e1

Returns:

  • (BigDecimal) —

    the decimal representation of the money amount



14
 
# File 'lib/minting/money/conversion.rb', line 14

def to_d = amount.to_d 0

#to_f ⇒ Float

Converts the monetary amount to a standard float. Note: Using float conversion loses precision guarantees.

Returns:

  • (Float) —

    the floating-point representation of the money amount



20
 
# File 'lib/minting/money/conversion.rb', line 20

def to_f = amount.to_f

#to_hash ⇒ Hash

Returns a Hash representation of the money instance.

Examples:

Mint.money(134120, 'BRL').to_hash
#=> { currency: "BRL", amount: "134120.00" }

Returns:

  • (Hash) —

    hash with :currency (String) and :amount (String) keys



47
48
49
 
# File 'lib/minting/money/conversion.rb', line 47

def to_hash
  { currency: currency_code, amount: Kernel.format("%0.#{currency.subunit}f", amount) }
end

#to_html(format = DEFAULT_FORMAT) ⇒ String

Renders a safe HTML5 ‘<data>` element containing the formatted currency. Embeds the ISO currency description and raw value as the metadata `title` attribute.

Parameters:

  • format (String) (defaults to: DEFAULT_FORMAT) —

    the display format to apply to the visible HTML text

Returns:

  • (String) —

    HTML5 ‘<data>` representation



27
28
29
30
31
 
# File 'lib/minting/money/conversion.rb', line 27

def to_html(format = DEFAULT_FORMAT)
  title = Kernel.format("#{currency_code} %0.#{currency.subunit}f", amount)
  body = to_s(format: format)
  %(<data class='money' title='#{title}'>#{ERB::Util.html_escape(body)}</data>)
end

#to_i ⇒ Integer

Truncates and converts the monetary amount to an Integer.

Examples:

Mint.money(9.99, 'USD').to_i  #=> 9
Mint.money(-9.99, 'USD').to_i #=> -9

Returns:

  • (Integer) —

    the integer representation of the money amount



39
 
# File 'lib/minting/money/conversion.rb', line 39

def to_i = amount.to_i

#to_json(*_args) ⇒ String

Serializes the money instance to a standard JSON object containing the amount and currency. Highly optimized to run without external dependencies.

Returns:

  • (String) —

    the JSON serialized string representation



55
56
57
58
59
 
# File 'lib/minting/money/conversion.rb', line 55

def to_json(*_args)
  Kernel.format(
    %({"currency": "#{currency_code}", "amount": "%0.#{currency.subunit}f"}), amount
  )
end

#to_r ⇒ Rational

Returns the exact internal Rational representation of the monetary amount.

Returns:

  • (Rational) —

    the rational representation of the money amount



64
 
# File 'lib/minting/money/conversion.rb', line 64

def to_r = amount

#to_s(preset = nil, format: nil, decimal: nil, thousand: nil, width: nil) ⇒ String

Formats money as a string with customizable format, thousand delimiter, and decimal

Examples:

Basic formatting

money = Mint.money(1234.56, 'USD')
money.to_s                               #=> "$1,234.56"
money.to_s(thousand: '.', decimal: ',')  #=> "$1.234,56"
money.to_s(decimal: ',', thousand: '')   #=> "$1234,56"

Preset formats

loss = Mint.money(-1234.56, 'USD')
loss.to_s(:accounting)                   #=> "($1,234.56)"
money.to_s(:european)                    #=> "1.234,56 €"
money.to_s(:amount)                      #=> "1234.56"
money.to_s(:currency)                    #=> "USD 1234.56"

Custom formats

money.to_s(format: '%<amount>f')                    #=> "1234.56"
money.to_s(format: '%<currency>s %<amount>f')       #=> "USD 1234.56"
money.to_s(format: '%<amount>f %<symbol>s')         #=> "1234.56 $"
money.to_s(format: '%<symbol>s%<amount>+f')         #=> "$+1234.56"

Integral & fractional parts

money.to_s(format: '%<integral>d.%<fractional>02d')  #=> "1234.56"
price = Mint.money(0.99, 'USD')
price.to_s(format: '%<integral>d dollars and %<fractional>02d cents')
#=> "0 dollars and 99 cents"

Per-sign Hash format (accounting parentheses)

loss = Mint.money(-1234.56, 'USD')
loss.to_s(format: { negative: '(%<symbol>s%<amount>f)' }) #=> "($1,234.56)"
Mint.money(0, 'BRL').to_s(format: { zero: '--' })        #=> "--"

Padding and alignment

money.to_s(format: '%<amount>10.2f')                #=> "   1234.56"
money.to_s(format: '%<symbol>s%<amount>010.2f')     #=> "$0001234.56"

Locale-aware formatting (with Mint.locale_backend set)

money.to_s  # decimal and thousand come from locale_backend

Parameters:

  • preset (Symbol, nil) (defaults to: nil) —

    Named format preset, one of: :accounting, :european, :amount, :currency. When provided, expands to the preset’s format options and merges with any explicit keyword arguments (kwargs override the preset).

  • format (String, Hash, nil) (defaults to: nil) —

    Either a Format string with placeholders (%<symbol>s, %<amount>f, %<currency>s, %<integral>d, %<fractional>d), or a Hash with per-sign keys (:positive, :negative, :zero) each holding a format string. A Hash is convenient for sign-aware formats such as accounting parentheses:

    money.to_s(format: { negative: '(%<symbol>s%<amount>f)' })

    Missing keys fall back to the module default, so a Hash with only :negative will still format positives sensibly. The valid keys are :positive, :negative, :zero; anything else raises ArgumentError. When nil, falls back to Mint.locale_backend if set, otherwise “%<symbol>s%<amount>f”.

  • thousand (String, false, nil) (defaults to: nil) —

    Thousands delimiter (e.g., ‘,’ for 1,000). When nil, falls back to Mint.locale_backend if set, otherwise “,”.

  • decimal (String, nil) (defaults to: nil) —

    Decimal separator (e.g., ‘.’ or ‘,’). When nil, falls back to Mint.locale_backend if set, otherwise “.”.

Returns:

  • (String) —

    Formatted money string

Raises:

  • (ArgumentError) —

    if preset is not a recognised name, or if format is not a String or Hash, the Hash is empty, or the Hash contains an unrecognised key.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/minting/money/format/to_s.rb', line 79

def to_s(preset = nil, format: nil, decimal: nil, thousand: nil, width: nil)
  if preset
    config = PRESETS.fetch(preset) { raise ArgumentError, "Unknown format preset: #{preset.inspect}" }
    format ||= config[:format]
    decimal ||= config[:decimal]
    thousand ||= config[:thousand]
    width ||= config[:width]
  end

  validate_separators!(decimal:, thousand:)

  format, decimal, thousand = resolve_locale_for(format, decimal, thousand)

  case format
  when {}, '' then raise ArgumentError, 'format must not be empty'
  when Hash   then validate_format_hash(format)
  when String then format = { positive: format }
  else        raise ArgumentError, 'Invalid format. Only String or Hash are accepted'
  end

  formatted = format_amount(format, decimal: decimal, thousand: thousand)

  width ? formatted.rjust(width) : formatted
end

#zero? ⇒ Boolean

Returns true if amount is zero.

Returns:

  • (Boolean) —

    true if amount is zero



54
 
# File 'lib/minting/money/comparable.rb', line 54

def zero? = amount.zero?