Class: Money::Currency

Inherits:
Object
  • Object
show all
Extended by:
Enumerable, Heuristics
Includes:
Comparable
Defined in:
lib/money/currency.rb,
lib/money/currency/loader.rb,
lib/money/currency/heuristics.rb

Overview

Represents a specific currency unit.

See Also:

Defined Under Namespace

Modules: Heuristics, Loader Classes: MissingAttributeError, NoCurrency, UnknownCurrency

Constant Summary collapse

@@mutex =

Keeping cached instances in sync between threads

Mutex.new
@@instances = 
{}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Heuristics

analyze

Constructor Details

#initialize(id) ⇒ Money::Currency

Create a new +Currency+ object.

Examples:

Money::Currency.new(:usd) #=> #<Money::Currency id: usd ...>

Parameters:

  • id (String, Symbol, #to_s) —

    Used to look into +table+ and retrieve the applicable attributes.



290
291
292
293
 
# File 'lib/money/currency.rb', line 290

def initialize(id)
  @id = id.to_sym
  initialize_data!
end

Instance Attribute Details

#decimal_mark ⇒ String (readonly) Also known as: separator

Returns The decimal mark, or character used to separate the whole unit from the subunit.

Returns:

  • (String) —

    The decimal mark, or character used to separate the whole unit from the subunit.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#disambiguate_symbol ⇒ String (readonly)

Returns Alternative currency used if symbol is ambiguous.

Returns:

  • (String) —

    Alternative currency used if symbol is ambiguous



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#format ⇒ Object (readonly)

Returns the value of attribute format.



273
274
275
 
# File 'lib/money/currency.rb', line 273

def format
  @format
end

#html_entity ⇒ String (readonly)

Returns The html entity for the currency symbol.

Returns:

  • (String) —

    The html entity for the currency symbol



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#id ⇒ Symbol (readonly)

Returns The symbol used to identify the currency, usually THE lowercase +iso_code+ attribute.

Returns:

  • (Symbol) —

    The symbol used to identify the currency, usually THE lowercase +iso_code+ attribute.



273
274
275
 
# File 'lib/money/currency.rb', line 273

def id
  @id
end

#iso_code ⇒ String (readonly)

Returns The international 3-letter code as defined by the ISO 4217 standard.

Returns:

  • (String) —

    The international 3-letter code as defined by the ISO 4217 standard.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#iso_numeric ⇒ String (readonly)

Returns The international 3-numeric code as defined by the ISO 4217 standard.

Returns:

  • (String) —

    The international 3-numeric code as defined by the ISO 4217 standard.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#name ⇒ String (readonly)

Returns The currency name.

Returns:

  • (String) —

    The currency name.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#priority ⇒ Integer (readonly)

Returns A numerical value you can use to sort/group the currency list.

Returns:

  • (Integer) —

    A numerical value you can use to sort/group the currency list.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#smallest_denomination ⇒ Integer (readonly)

Returns Smallest amount of cash possible (in the subunit of this currency).

Returns:

  • (Integer) —

    Smallest amount of cash possible (in the subunit of this currency)



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#subunit ⇒ String (readonly)

Returns The name of the fractional monetary unit.

Returns:

  • (String) —

    The name of the fractional monetary unit.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#subunit_to_unit ⇒ Integer (readonly)

Returns The proportion between the unit and the subunit.

Returns:

  • (Integer) —

    The proportion between the unit and the subunit



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#symbol ⇒ String (readonly)

Returns The currency symbol (UTF-8 encoded).

Returns:

  • (String) —

    The currency symbol (UTF-8 encoded).



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#symbol_first ⇒ Boolean (readonly)

Returns Should the currency symbol precede the amount, or should it come after?.

Returns:

  • (Boolean) —

    Should the currency symbol precede the amount, or should it come after?



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

#thousands_separator ⇒ String (readonly) Also known as: delimiter

Returns The character used to separate thousands grouping of the whole unit.

Returns:

  • (String) —

    The character used to separate thousands grouping of the whole unit.



273
274
275
 
# File 'lib/money/currency.rb', line 273

attr_reader :id, :priority, :iso_code, :iso_numeric, :name, :symbol,
:disambiguate_symbol, :html_entity, :subunit, :subunit_to_unit, :decimal_mark,
:thousands_separator, :symbol_first, :smallest_denomination, :format

Class Method Details

._instances ⇒ Object 



49
50
51
 
# File 'lib/money/currency.rb', line 49

def _instances
  @@instances
end

.all ⇒ Array

List the currencies imported and registered

Examples:

Money::Currency.all()
[#<Currency ..USD>, 'CAD', 'EUR']...

Returns:

  • (Array) 


136
137
138
139
140
141
142
143
144
 
# File 'lib/money/currency.rb', line 136

def all
  table.keys.map do |curr|
    c = Currency.new(curr)
    if c.priority.nil?
      raise MissingAttributeError.new(:all, c.id, :priority)
    end
    c
  end.sort_by(&:priority)
end

.each ⇒ Object 



209
210
211
 
# File 'lib/money/currency.rb', line 209

def each
  all.each { |c| yield(c) }
end

.find(id) ⇒ Money::Currency

Lookup a currency with given +id+ an returns a +Currency+ instance on success, +nil+ otherwise.

retrieve the applicable attributes.

Examples:

Money::Currency.find(:eur) #=> #<Money::Currency id: eur ...>
Money::Currency.find(:foo) #=> nil

Parameters:

  • id (String, Symbol, #to_s) —

    Used to look into +table+ and

Returns:



64
65
66
67
68
69
 
# File 'lib/money/currency.rb', line 64

def find(id)
  id = id.to_s.downcase.to_sym
  new(id)
rescue UnknownCurrency
  nil
end

.find_by_iso_numeric(num) ⇒ Money::Currency

Lookup a currency with given +num+ as an ISO 4217 numeric and returns an +Currency+ instance on success, +nil+ otherwise.

the right currency id.

Examples:

Money::Currency.find_by_iso_numeric(978) #=> #<Money::Currency id: eur ...>
Money::Currency.find_by_iso_numeric(51) #=> #<Money::Currency id: amd ...>
Money::Currency.find_by_iso_numeric('001') #=> nil

Parameters:

  • num (#to_s) —

    used to look into +table+ in +iso_numeric+ and find

Returns:



83
84
85
86
87
88
89
90
 
# File 'lib/money/currency.rb', line 83

def find_by_iso_numeric(num)
  num = num.to_s.rjust(3, '0')
  return if num.empty?
  id = iso_numeric_index[num]
  new(id) if id
rescue UnknownCurrency
  nil
end

.inherit(parent_iso_code, curr) ⇒ Object

Inherit a new currency from existing one

Parameters:

  • parent_iso_code (String) —

    the international 3-letter code as defined

  • curr (Hash) —

    See register method for hash structure



185
186
187
188
189
 
# File 'lib/money/currency.rb', line 185

def inherit(parent_iso_code, curr)
  parent_iso_code = parent_iso_code.downcase.to_sym
  curr = @table.fetch(parent_iso_code, {}).merge(curr)
  register(curr)
end

.new(id) ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'lib/money/currency.rb', line 40

def new(id)
  id = id.to_s.downcase
  unless stringified_keys.include?(id)
    raise UnknownCurrency, "Unknown currency '#{id}'"
  end

  _instances[id] || @@mutex.synchronize { _instances[id] ||= super }
end

.register(curr) ⇒ Object

Register a new currency

Parameters:

  • curr (Hash) —

    information about the currency

  • priority (Hash) —

    a customizable set of options

  • iso_code (Hash) —

    a customizable set of options

  • iso_numeric (Hash) —

    a customizable set of options

  • name (Hash) —

    a customizable set of options

  • symbol (Hash) —

    a customizable set of options

  • subunit (Hash) —

    a customizable set of options

  • subunit_to_unit (Hash) —

    a customizable set of options

  • separator (Hash) —

    a customizable set of options

  • delimiter (Hash) —

    a customizable set of options



173
174
175
176
177
178
179
 
# File 'lib/money/currency.rb', line 173

def register(curr)
  key = curr.fetch(:iso_code).downcase.to_sym
  @@mutex.synchronize { _instances.delete(key.to_s) }
  @table[key] = curr
  @stringified_keys = nil
  clear_iso_numeric_cache
end

.reset! ⇒ Object 



213
214
215
216
217
 
# File 'lib/money/currency.rb', line 213

def reset!
  @@instances = {}
  @table = Loader.load_currencies
  clear_iso_numeric_cache
end

.stringified_keys ⇒ Set

We need a string-based validator before creating an unbounded number of symbols. http://www.randomhacks.net.s3-website-us-east-1.amazonaws.com/2007/01/20/13-ways-of-looking-at-a-ruby-symbol/#11 https://github.com/RubyMoney/money/issues/132

Returns:

  • (Set) 


152
153
154
 
# File 'lib/money/currency.rb', line 152

def stringified_keys
  @stringified_keys ||= stringify_keys
end

.table ⇒ Object

List of known currencies.

== monetary unit The standard unit of value of a currency, as the dollar in the United States or the peso in Mexico. https://www.answers.com/redirectSearch?query=monetary-unit == fractional monetary unit, subunit A monetary unit that is valued at a fraction (usually one hundredth) of the basic monetary unit https://www.answers.com/redirectSearch?query=fractional-monetary-unit-subunit

See https://en.wikipedia.org/wiki/List_of_circulating_currencies and https://metacpan.org/release/TNGUYEN/Locale-Currency-Format-1.28/view/Format.pm



126
127
128
 
# File 'lib/money/currency.rb', line 126

def table
  @table ||= Loader.load_currencies
end

.unregister(curr) ⇒ Boolean

Unregister a currency.

Parameters:

  • curr (Object) —

    A Hash with the key :iso_code, or the ISO code as a String or Symbol.

Returns:

  • (Boolean) —

    true if the currency previously existed, false if it didn't.



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/money/currency.rb', line 198

def unregister(curr)
  if curr.is_a?(Hash)
    key = curr.fetch(:iso_code).downcase.to_sym
  else
    key = curr.downcase.to_sym
  end
  existed = @table.delete(key)
  @stringified_keys = nil if existed
  existed ? true : false
end

.wrap(object) ⇒ Money::Currency

Wraps the object in a +Currency+ unless it's already a +Currency+ object.

object.

Examples:

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 ...>

Parameters:

  • object (Object) —

    The object to attempt and wrap as a +Currency+

Returns:



105
106
107
108
109
110
111
112
113
 
# File 'lib/money/currency.rb', line 105

def wrap(object)
  if object.nil?
    nil
  elsif object.is_a?(Currency)
    object
  else
    Currency.new(object)
  end
end

Instance Method Details

#<=>(other_currency) ⇒ -1, ...

Compares +self+ with +other_currency+ against the value of +priority+ attribute.

Examples:

c1 = Money::Currency.new(:usd)
c2 = Money::Currency.new(:jpy)
c1 <=> c2 #=> 1
c2 <=> c1 #=> -1
c1 <=> c1 #=> 0

Parameters:

Returns:

  • (-1, 0, 1) —

    -1 if less than, 0 is equal to, 1 if greater than



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/money/currency.rb', line 308

def <=>(other_currency)
  # <=> returns nil when one of the values is nil
  comparison = self.priority <=> other_currency.priority || 0

  if comparison == 0
    self.id <=> other_currency.id
  else
    comparison
  end
end

#==(other_currency) ⇒ Boolean

Compares +self+ with +other_currency+ and returns +true+ if the are the same or if their +id+ attributes match.

Examples:

c1 = Money::Currency.new(:usd)
c2 = Money::Currency.new(:jpy)
c1 == c1 #=> true
c1 == c2 #=> false

Parameters:

Returns:

  • (Boolean) 


331
332
333
 
# File 'lib/money/currency.rb', line 331

def ==(other_currency)
  self.equal?(other_currency) || compare_ids(other_currency)
end

#cents_based? ⇒ Boolean

Returns true if a subunit is cents-based.

Examples:

Money::Currency.new(:usd).cents_based?

Returns:

  • (Boolean) 


441
442
443
 
# File 'lib/money/currency.rb', line 441

def cents_based?
  subunit_to_unit == 100
end

#code ⇒ String

Returns currency symbol or iso code for currencies with no symbol.

Returns:

  • (String) 


415
416
417
 
# File 'lib/money/currency.rb', line 415

def code
  symbol || iso_code
end

#eql? ⇒ Object 



279
 
# File 'lib/money/currency.rb', line 279

alias_method :eql?, :==

#exponent ⇒ Integer Also known as: decimal_places

Returns the relation between subunit and unit as a base 10 exponent.

Note that MGA and MRU are exceptions and are rounded to 1

Returns:

  • (Integer)

See Also:



451
452
453
 
# File 'lib/money/currency.rb', line 451

def exponent
  Math.log10(subunit_to_unit).round
end

#hash ⇒ Integer

Returns a Integer hash value based on the +id+ attribute in order to use functions like & (intersection), group_by, etc.

Examples:

Money::Currency.new(:usd).hash #=> 428936

Returns:

  • (Integer) 


352
353
354
 
# File 'lib/money/currency.rb', line 352

def hash
  id.hash
end

#inspect ⇒ String

Returns a human readable representation.

Examples:

Money::Currency.new(:usd) #=> #<Currency id: usd ...>

Returns:

  • (String) 


362
363
364
 
# File 'lib/money/currency.rb', line 362

def inspect
  "#<#{self.class.name} id: #{id}, priority: #{priority}, symbol_first: #{symbol_first}, thousands_separator: #{thousands_separator}, html_entity: #{html_entity}, decimal_mark: #{decimal_mark}, name: #{name}, symbol: #{symbol}, subunit_to_unit: #{subunit_to_unit}, exponent: #{exponent}, iso_code: #{iso_code}, iso_numeric: #{iso_numeric}, subunit: #{subunit}, smallest_denomination: #{smallest_denomination}, format: #{format}>"
end

#iso? ⇒ Boolean

Returns true if a code currency is ISO.

Examples:

Money::Currency.new(:usd).iso?

Returns:

  • (Boolean) 


430
431
432
 
# File 'lib/money/currency.rb', line 430

def iso?
  iso_numeric && iso_numeric != ''
end

#symbol_first? ⇒ Boolean

Returns:

  • (Boolean) 


419
420
421
 
# File 'lib/money/currency.rb', line 419

def symbol_first?
  !!@symbol_first
end

#to_currency ⇒ self

Conversion to +self+.

Returns:

  • (self) 


408
409
410
 
# File 'lib/money/currency.rb', line 408

def to_currency
  self
end

#to_s ⇒ String

Returns a string representation corresponding to the upcase +id+ attribute.

-- DEV: id.to_s.upcase corresponds to iso_code but don't use ISO_CODE for consistency.

Examples:

Money::Currency.new(:usd).to_s #=> "USD"
Money::Currency.new(:eur).to_s #=> "EUR"

Returns:

  • (String) 


377
378
379
 
# File 'lib/money/currency.rb', line 377

def to_s
  id.to_s.upcase
end

#to_str ⇒ String

Returns a string representation corresponding to the upcase +id+ attribute. Useful in cases where only implicit conversions are made.

Examples:

Money::Currency.new(:usd).to_str #=> "USD"
Money::Currency.new(:eur).to_str #=> "EUR"

Returns:

  • (String) 


389
390
391
 
# File 'lib/money/currency.rb', line 389

def to_str
  id.to_s.upcase
end

#to_sym ⇒ Symbol

Returns a symbol representation corresponding to the upcase +id+ attribute.

Examples:

Money::Currency.new(:usd).to_sym #=> :USD
Money::Currency.new(:eur).to_sym #=> :EUR

Returns:

  • (Symbol) 


401
402
403
 
# File 'lib/money/currency.rb', line 401

def to_sym
  id.to_s.upcase.to_sym
end