Class | Money::Currency |
In: |
lib/money/currency.rb
|
Parent: | Object |
Represents a specific currency unit.
decimal_mark | -> | separator |
thousands_separator | -> | delimiter |
decimal_mark | [R] |
The decimal mark, or character used to separate the whole unit from the
subunit.
@return [String] |
html_entity | [R] |
The html entity for the currency symbol
@return [String] |
id | [R] |
The symbol used to identify the currency, usually the lowercase
iso_code attribute.
@return [Symbol] |
iso_code | [R] |
The international 3-letter code as
defined by the ISO 4217 standard.
@return [String] |
iso_numeric | [R] |
The international 3-numeric code as
defined by the ISO 4217 standard.
@return [String] |
name | [R] |
The currency name.
@return [String] |
priority | [R] |
A numerical value you can use to sort/group the currency list.
@return [Integer] |
subunit | [R] |
The name of the fractional monetary unit.
@return [String] |
subunit_to_unit | [R] |
The proportion between the unit and the subunit
@return [Integer] |
symbol | [R] |
The currency symbol (UTF-8 encoded).
@return [String] |
symbol_first | [R] |
Should the currency symbol precede the amount, or should it come after?
@return [boolean] |
thousands_separator | [R] |
The character used to separate thousands grouping of the whole unit.
@return [String] |
Lookup a currency with given id an returns a Currency instance on success, nil otherwise.
@param [String, Symbol, to_s] id Used to look into table and retrieve the applicable attributes.
@return [Money::Currency]
@example
Money::Currency.find(:eur) #=> #<Money::Currency id: eur ...> Money::Currency.find(:foo) #=> nil
We need a string-based validator before creating an unbounded number of symbols. www.randomhacks.net/articles/2007/01/20/13-ways-of-looking-at-a-ruby-symbol#11 github.com/RubyMoney/money/issues/132
List of known currencies.
The standard unit of value of a currency, as the dollar in the United States or the peso in Mexico. www.answers.com/topic/monetary-unit
A monetary unit that is valued at a fraction (usually one hundredth) of the basic monetary unit www.answers.com/topic/fractional-monetary-unit-subunit
See en.wikipedia.org/wiki/List_of_circulating_currencies and search.cpan.org/~tnguyen/Locale-Currency-Format-1.28/Format.pm
Wraps the object in a Currency unless it‘s already a Currency object.
@param [Object] object The object to attempt and wrap as a Currency object.
@return [Money::Currency]
@example
c1 = Money::Currency.new(:usd) Money::Currency.wrap(nil) #=> nil Money::Currency.wrap(c1) #=> #<Money::Currency id: usd ...> Money::Currency.wrap("usd") #=> #<Money::Currency id: usd ...>
Compares self with other_currency against the value of priority attribute.
@param [Money::Currency] other_currency The currency to compare to.
@return [-1,0,1] -1 if less than, 0 is equal to, 1 if greater than
@example
c1 = Money::Currency.new(:usd) c2 = Money::Currency.new(:jpy) c1 <=> c2 #=> 1 c2 <=> c1 #=> -1 c1 <=> c1 #=> 0
Compares self with other_currency and returns true if the are the same or if their id attributes match.
@param [Money::Currency] other_currency The currency to compare to.
@return [Boolean]
@example
c1 = Money::Currency.new(:usd) c2 = Money::Currency.new(:jpy) c1 == c1 #=> true c1 == c2 #=> false
Compares self with other_currency and returns true if the are the same or if their id attributes match.
@param [Money::Currency] other_currency The currency to compare to.
@return [Boolean]
@example
c1 = Money::Currency.new(:usd) c2 = Money::Currency.new(:jpy) c1.eql? c1 #=> true c1.eql? c2 #=> false
Returns a Fixnum hash value based on the id attribute in order to use functions like & (intersection), group_by, etc.
@return [Fixnum]
@example
Money::Currency.new(:usd).hash #=> 428936
Returns a human readable representation.
@return [String]
@example
Money::Currency.new(:usd) #=> #<Currency id: usd ...>