Module: Timeprice

Defined in:
lib/timeprice.rb,
lib/timeprice/cli.rb,
lib/timeprice/point.rb,
lib/timeprice/errors.rb,
lib/timeprice/compare.rb,
lib/timeprice/sources.rb,
lib/timeprice/version.rb,
lib/timeprice/exchange.rb,
lib/timeprice/inflation.rb,
lib/timeprice/supported.rb,
lib/timeprice/cpi_lookup.rb,
lib/timeprice/data_loader.rb,
lib/timeprice/cli/formatting.rb,
lib/timeprice/sources/coverage.rb,
lib/timeprice/cli/presenters/compare.rb,
lib/timeprice/cli/presenters/sources.rb,
lib/timeprice/cli/presenters/exchange.rb,
lib/timeprice/cli/presenters/inflation.rb

Overview

Offline historical inflation & FX for Ruby.

Top-level module functions wrap the three core operations: inflation adjustment, currency exchange, and a combined “compare” that does both in the right order. Each returns an immutable ‘Data.define` value object.

Examples:

Inflation

Timeprice.inflation(amount: 100, from: "1990-01", to: "2024-01", country: "US")

FX

Timeprice.exchange(amount: 100, from: "USD", to: "JPY", date: "2010-06-15")

Compare

Timeprice.compare(amount: 100, from: ["USD", "2010"], to: ["VND", "2024"])

Defined Under Namespace

Modules: Compare, DataLoader, Exchange, Inflation, Sources, Supported Classes: CLI, CompareResult, CpiLookup, CpiPoint, DataNotFound, DateOutOfRange, Error, ExchangeResult, InflationResult, Point, UnsupportedCountry, UnsupportedCurrency, UnsupportedSchemaVersion

Constant Summary collapse

VERSION = 
"0.3.0"

Class Method Summary collapse

Class Method Details

.compare(amount:, from:, to:) ⇒ CompareResult

Compare an amount across two (currency, date) points: convert at the source date, then inflate in the destination currency. See README.md “Compare semantics” for why this order is correct.

Parameters:

  • amount (Numeric)
  • from (Point, Array(String, String)) —

    source point

  • to (Point, Array(String, String)) —

    destination point

Returns:



62
63
64
 
# File 'lib/timeprice.rb', line 62

def compare(amount:, from:, to:)
  Compare.run(amount: amount, from: from, to: to)
end

.exchange(amount:, from:, to:, date:) ⇒ ExchangeResult

Convert an amount between currencies on a specific date.

Parameters:

  • amount (Numeric) —

    the original amount

  • from (String) —

    source currency (ISO 4217)

  • to (String) —

    destination currency (ISO 4217)

  • date (String) —

    date as “YYYY-MM-DD”

Returns:

Raises:



50
51
52
 
# File 'lib/timeprice.rb', line 50

def exchange(amount:, from:, to:, date:)
  Exchange.convert(amount: amount, from: from, to: to, date: date)
end

.inflation(amount:, from:, to:, country:) ⇒ InflationResult

Inflation-adjust an amount between two dates using a country’s CPI.

Parameters:

  • amount (Numeric) —

    the original amount

  • from (String) —

    source date as “YYYY” or “YYYY-MM”

  • to (String) —

    target date as “YYYY” or “YYYY-MM”

  • country (String) —

    country code from Timeprice::Supported::COUNTRIES

Returns:

Raises:



37
38
39
 
# File 'lib/timeprice.rb', line 37

def inflation(amount:, from:, to:, country:)
  Inflation.adjust(amount: amount, from: from, to: to, country: country)
end