abstract class Money::Currency::RateStore

• Money::Currency::RateStore
• Reference
• Object

Included Modules

• Enumerable(Money::Currency::Rate)
• JSON::Serializable
• YAML::Serializable

Extended Modules

• Money::Registry

Direct Known Subclasses

• Money::Currency::RateStore::Memory

Defined in:

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

  Alias of Converter.from_yaml.

• .new(pull : JSON::PullParser)

  Alias of Converter.from_json.

• .new(*, ttl : Time::Span | Nil = nil)

Class Method Summary

• .find(name : String | Symbol) : Money::Currency::RateStore.class

  Returns the Money::Currency::RateStore.class for the given name if found, raises Money::Registry::NotFoundError otherwise.

• .find?(name : String | Symbol) : Money::Currency::RateStore.class | Nil

  Returns the Money::Currency::RateStore.class for the given name if found, nil otherwise.

• .registry

  All registered objects.

Instance Method Summary

• #<<(rate : Rate) : self

  Registers a conversion rate.

• #<<(rates : Enumerable(Rate)) : self

  Registers multiple conversion rates.

• #[](base : String | Symbol | Currency, target : String | Symbol | Currency) : BigDecimal

  Retrieves the rate for the given currency pair or raises UnknownRateError if not found.

• #[]=(base : String | Symbol | Currency, target : String | Symbol | Currency, value : Number) : Nil

  Registers a conversion rate.

• #[]?(base : String | Symbol | Currency, target : String | Symbol | Currency) : BigDecimal | Nil

  Retrieves the rate for the given currency pair or nil if not found.

• #clear(base : String | Symbol | Currency) : Nil

  Removes rates for the given base currency.

• #clear : Nil

  Empties currency rate index.

• #each(& : Rate -> ) : Nil

  Iterates over list of Rate objects.

• #rates : Array(Rate)

  Alias of #to_a.

• #transaction(*, mutable : Bool = false, & : -> _)

  Wraps block execution in a concurrency-safe transaction.

• #ttl : Time::Span | Nil
• #ttl=(ttl : Time::Span | Nil)

Constructor Detail

Class Method Detail

Instance Method Detail

store = Money::Currency::RateStore::Memory.new
store << Rate.new(
  Money::Currency.find("USD"),
  Money::Currency.find("CAD"),
  1.24515.to_big_d
)
store << Rate.new(
  Money::Currency.find("CAD"),
  Money::Currency.find("USD"),
  0.803115.to_big_d
)

store = Money::Currency::RateStore::Memory.new
store << [
  Rate.new(
    Money::Currency.find("USD"),
    Money::Currency.find("CAD"),
    1.24515.to_big_d
  ),
  Rate.new(
    Money::Currency.find("CAD"),
    Money::Currency.find("USD"),
    0.803115.to_big_d
  ),
]

store = Money::Currency::RateStore::Memory.new
store["USD", "CAD"] = 1.24515

store["USD", "CAD"] # => 1.24515
store["CAD", "USD"] # raises Money::UnknownRateError

store = Money::Currency::RateStore::Memory.new
store["USD", "CAD"] = 1.24515
store["CAD", "USD"] = 0.803115

store = Money::Currency::RateStore::Memory.new
store["USD", "CAD"] = 1.24515

store["USD", "CAD"]? # => 1.24515
store["CAD", "USD"]? # => nil

store.each do |rate|
  puts rate
end