timeprice 0.6.0 → 0.8.0

data/lib/timeprice/sources.rb

@@ -39,7 +39,7 @@ module Timeprice
         id: "jp_cpi",
         kind: "cpi",
         country: "JP",
-        name: "World Bank — FP.CPI.TOTL (annual, JP fallback)",
+        name: "World Bank — FP.CPI.TOTL (annual)",
         license: "CC BY 4.0",
         license_url: "https://datacatalog.worldbank.org/public-licenses#cc-by",
         attribution: "Source: World Bank, FP.CPI.TOTL",

data/lib/timeprice/supported.rb

@@ -26,6 +26,22 @@ module Timeprice
       ([base] + DataLoader.load_manifest.dig("fx", "currencies")).uniq.freeze
     end
 
+    # @return [Array<String>] currencies with daily FX observations.
+    def daily_currencies
+      manifest = DataLoader.load_manifest
+      list = manifest.dig("fx", "daily_currencies")
+      return currencies if list.nil?
+
+      base = manifest.dig("fx", "base")
+      ([base] + list).uniq.freeze
+    end
+
+    # @return [Array<String>] currencies served only annually (e.g. VND, RUB).
+    def annual_only_currencies
+      manifest = DataLoader.load_manifest
+      (manifest.dig("fx", "annual_only_currencies") || []).freeze
+    end
+
     # @return [Hash{String=>String}] country code → currency code.
     def country_to_currency
       manifest_countries.to_h { |c| [c["code"], c["currency"]] }.freeze

data/lib/timeprice/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Timeprice
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/timeprice.rb

@@ -1,14 +1,21 @@
 # frozen_string_literal: true
 
 require_relative "timeprice/version"
+require_relative "timeprice/errors"
+require_relative "timeprice/schema"
+require_relative "timeprice/date"
 require_relative "timeprice/data_loader"
 require_relative "timeprice/supported"
-require_relative "timeprice/errors"
 require_relative "timeprice/point"
 require_relative "timeprice/inflation"
 require_relative "timeprice/exchange"
 require_relative "timeprice/compare"
+require_relative "timeprice/forecast"
+require_relative "timeprice/forecast/cagr"
+require_relative "timeprice/forecast/cpi_forecaster"
+require_relative "timeprice/forecast/fx_forecaster"
 require_relative "timeprice/sources"
+require_relative "timeprice/metadata"
 
 # Offline historical inflation & FX for Ruby.
 #
@@ -51,6 +58,34 @@ module Timeprice
     Exchange.convert(amount: amount, from: from, to: to, date: date)
   end
 
+  # Project a CPI index or FX rate forward past the last bundled data point.
+  #
+  # @param kind         [Symbol] :cpi or :fx
+  # @param target       [String] target date as "YYYY" or "YYYY-MM"
+  # @param country      [String] (only when kind: :cpi)
+  # @param from         [String] (only when kind: :fx) source currency
+  # @param to           [String] (only when kind: :fx) destination currency
+  # @param window_years [Integer, nil] override default trailing window
+  # @return [Forecast::Result]
+  def forecast(kind:, target:, country: nil, from: nil, to: nil, window_years: nil)
+    case kind
+    when :cpi
+      fail ArgumentError, "country: required for kind: :cpi" unless country
+
+      opts = { country: country, target: target }
+      opts[:window_years] = window_years if window_years
+      Forecast::CpiForecaster.project(**opts)
+    when :fx
+      fail ArgumentError, "from:/to: required for kind: :fx" unless from && to
+
+      opts = { from: from, to: to, target: target }
+      opts[:window_years] = window_years if window_years
+      Forecast::FxForecaster.project(**opts)
+    else
+      fail ArgumentError, "unknown forecast kind: #{kind.inspect} (expected :cpi or :fx)"
+    end
+  end
+
   # 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.
@@ -59,7 +94,17 @@ module Timeprice
   # @param from   [Point, Array(String, String)] source point
   # @param to     [Point, Array(String, String)] destination point
   # @return [CompareResult]
-  def compare(amount:, from:, to:)
-    Compare.run(amount: amount, from: from, to: to)
+  def compare(amount:, from:, to:, forecast: false)
+    Compare.run(amount: amount, from: from, to: to, forecast: forecast)
+  end
+
+  # Snapshot describing the bundled dataset: version, refresh date, country
+  # list with CPI ranges, currency list with display names, and FX coverage.
+  # Intended as the single source of truth for downstream UIs (the website
+  # in particular) so dropdowns and date pickers never drift from the data.
+  #
+  # @return [Hash] frozen, JSON-serialisable
+  def metadata
+    Metadata.build
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timeprice
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Patrick
@@ -16,13 +16,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,11 +121,35 @@ files:
 - LICENSE.txt
 - NOTICE
 - README.md
+- data/cpi/au.json
+- data/cpi/br.json
+- data/cpi/ca.json
+- data/cpi/ch.json
+- data/cpi/cn.json
+- data/cpi/cz.json
 - data/cpi/eu.json
+- data/cpi/hk.json
+- data/cpi/hu.json
+- data/cpi/id.json
+- data/cpi/il.json
+- data/cpi/in.json
 - data/cpi/jp.json
+- data/cpi/kr.json
+- data/cpi/mx.json
+- data/cpi/my.json
+- data/cpi/no.json
+- data/cpi/nz.json
+- data/cpi/ph.json
+- data/cpi/pl.json
+- data/cpi/ru.json
+- data/cpi/se.json
+- data/cpi/sg.json
+- data/cpi/th.json
+- data/cpi/tr.json
 - data/cpi/uk.json
 - data/cpi/us.json
 - data/cpi/vn.json
+- data/cpi/za.json
 - data/fx/usd/1999.json
 - data/fx/usd/2000.json
 - data/fx/usd/2001.json
@@ -151,13 +189,22 @@ files:
 - lib/timeprice/cli/presenters/inflation.rb
 - lib/timeprice/cli/presenters/sources.rb
 - lib/timeprice/compare.rb
+- lib/timeprice/compare/series.rb
 - lib/timeprice/cpi_lookup.rb
 - lib/timeprice/data_loader.rb
+- lib/timeprice/date.rb
 - lib/timeprice/errors.rb
 - lib/timeprice/exchange.rb
+- lib/timeprice/forecast.rb
+- lib/timeprice/forecast/cagr.rb
+- lib/timeprice/forecast/cpi_forecaster.rb
+- lib/timeprice/forecast/fx_forecaster.rb
 - lib/timeprice/granularity.rb
 - lib/timeprice/inflation.rb
+- lib/timeprice/metadata.rb
+- lib/timeprice/metadata_snapshot.rb
 - lib/timeprice/point.rb
+- lib/timeprice/schema.rb
 - lib/timeprice/sources.rb
 - lib/timeprice/sources/coverage.rb
 - lib/timeprice/supported.rb