timeprice 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1b427948a0943958a53ce1820f72eb27b7dc41de61c9e216194aae9c03183d
-  data.tar.gz: 5daac2f9428564420379cc33db7893a8b9dbf0f0344355c1439636e8abf647a7
+  metadata.gz: fc65e20b859501552fbc5b53a7d6d3f833159d941ed5afc52bd1e9b51153d0fe
+  data.tar.gz: 93f795ee7466123a98dd56d6ef202d19de8e2e68ea0588cfcfd6a1172142d681
 SHA512:
-  metadata.gz: 14ec61a1a5cc71b33fb0de18bbbfc19ec152697d4f8ddcd2f14cf2d739e80571512ccb067d939f60207c0b2abc2971a03f32272cd2468d273782a1022d9d0dbb
-  data.tar.gz: 5d7fae9eb6583d38f2245830aa66a0ce61fec10aa02cdec600005aea185635d0312c80a7d3bec62f0067a42651839a2af4de4d3c67335b1eb2a649dfe35b2419
+  metadata.gz: d94e236e90f83d00a5e9ce871f74353aaf67245649ad7c3d21f69515b06049fecf4170844b4decea5533a3a82a9ceb444a5906f868535181ce0f13ce684119a5
+  data.tar.gz: f456c4a3b346031d6d69c2a55de77177022c9cabe7e1f656a8221dad767427786bc12d2838a81e67c514d6d9b86c76a33151f8f58095b672960f0f3b3f5c0bae

data/CHANGELOG.md

@@ -5,6 +5,18 @@ Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## [Unreleased]
 
+## [0.1.1] - 2026-05-11
+
+### Changed
+- CLI output formatting: currency-aware decimals (no `.0000` on JPY/VND), magnitude-aware FX rate precision (no `91.180000` for a 91.18 rate).
+- `granularity` is omitted from human output when it's `monthly` (the happy path); surfaced only when the result used annual data.
+- Error messages hint at supported values: `Unsupported country: "FR" (supported: US, UK, EU, JP, VN)`; out-of-range CPI errors include the actual coverage range.
+- Validate FX currencies against the supported list up front instead of failing with a generic "no FX rate" message.
+- Tightened CLI command descriptions so `timeprice help` fits in a standard terminal.
+
+### Fixed
+- Hide Thor's built-in `tree` command — it was leaking into `timeprice help` as an internal-looking debug command.
+
 ## [0.1.0] - 2026-05-11
 
 ### Added

data/lib/timeprice/cli.rb

@@ -6,15 +6,23 @@ require_relative "../timeprice"
 
 module Timeprice
   class CLI < Thor
+    # Thor 1.5 ships a built-in `tree` command on every subclass. Strip it
+    # from this subclass — it's an internal debugging aid that leaks into
+    # our help output. all_commands inherits from the base Thor class, so
+    # filter it on read.
+    def self.all_commands
+      super.except("tree")
+    end
+
     class_option :json, type: :boolean, default: false, desc: "Output result as JSON"
 
     def self.exit_on_failure?
       true
     end
 
-    desc "inflation AMOUNT", "Adjust AMOUNT for inflation between two dates"
-    method_option :from, type: :string, required: true, desc: "Source date (YYYY or YYYY-MM)"
-    method_option :to,   type: :string, required: true, desc: "Target date (YYYY or YYYY-MM)"
+    desc "inflation AMOUNT", "Inflation-adjust an amount between two dates"
+    method_option :from,    type: :string, required: true, desc: "Source date (YYYY or YYYY-MM)"
+    method_option :to,      type: :string, required: true, desc: "Target date (YYYY or YYYY-MM)"
     method_option :country, type: :string, required: true, desc: "Country code (US, UK, EU, JP, VN)"
     def inflation(amount)
       with_error_handling do
@@ -28,7 +36,7 @@ module Timeprice
       end
     end
 
-    desc "fx AMOUNT FROM_CURRENCY TO_CURRENCY", "Convert AMOUNT between currencies on a given date"
+    desc "fx AMOUNT FROM TO", "Convert an amount between currencies on a date"
     method_option :date, type: :string, required: true, desc: "Date (YYYY-MM-DD)"
     def fx(amount, from_currency, to_currency)
       with_error_handling do
@@ -58,7 +66,7 @@ module Timeprice
       end
     end
 
-    desc "sources", "List bundled data sources, licenses, attribution, and coverage"
+    desc "sources", "List bundled data sources and coverage"
     def sources
       list = Timeprice::Sources.list
       if options[:json]
@@ -86,19 +94,19 @@ module Timeprice
     end
 
     no_commands do
+      # Currencies with no minor unit — render whole numbers, no decimals.
+      ZERO_DECIMAL_CURRENCIES = %w[JPY VND KRW IDR HUF CLP].freeze
+
       def with_error_handling
         yield
       rescue Timeprice::Error => e
         warn "Error: #{e.message}"
         exit 1
       rescue ArgumentError => e
-        # Bad numeric/date format from Float() or library parsers — treat as user error.
         warn "Error: #{e.message}"
         exit 1
       end
 
-      # Accepts "1995 USD" or "USD 1995" — order-agnostic.
-      # Returns [currency, year_string] tuple matching Timeprice.compare's API.
       def parse_compare_token(token, label:)
         raise ArgumentError, "#{label} is required" if token.nil? || token.strip.empty?
         parts = token.strip.split(/\s+/)
@@ -115,15 +123,38 @@ module Timeprice
         [currency.upcase, year]
       end
 
+      def fmt_money(amount, currency)
+        decimals = ZERO_DECIMAL_CURRENCIES.include?(currency.to_s.upcase) ? 0 : 2
+        format("%.#{decimals}f", amount)
+      end
+
+      def fmt_rate(rate)
+        abs = rate.to_f.abs
+        decimals = if abs >= 1000 then 0
+                   elsif abs >= 100 then 2
+                   elsif abs >= 10  then 3
+                   else 4
+                   end
+        format("%.#{decimals}f", rate)
+      end
+
+      # Granularity is loud noise on the happy path. Only surface it when the
+      # answer actually used annual data — that's where users want a heads-up.
+      def granularity_suffix(granularity)
+        return "" if granularity == :monthly
+        " (granularity: #{granularity})"
+      end
+
       def emit_inflation(result)
         if options[:json]
           say JSON.generate(result.to_h)
         else
+          ccy = result.country_currency_label
           say format(
-            "%.2f %s in %s is %.2f %s in %s (%s, granularity: %s)",
-            result.original_amount, result.country_currency_label,
-            result.from, result.amount, result.country_currency_label,
-            result.to, result.country, result.granularity
+            "%s %s in %s is %s %s in %s [%s]%s",
+            fmt_money(result.original_amount, ccy), ccy, result.from,
+            fmt_money(result.amount, ccy), ccy, result.to,
+            result.country, granularity_suffix(result.granularity)
           )
         end
       end
@@ -133,12 +164,12 @@ module Timeprice
           say JSON.generate(result.to_h)
         else
           line = format(
-            "%.2f %s on %s = %.2f %s (rate: %.4f)",
-            result.original_amount, result.from, result.date,
-            result.amount, result.to, result.rate
+            "%s %s on %s = %s %s (rate: %s)",
+            fmt_money(result.original_amount, result.from), result.from, result.date,
+            fmt_money(result.amount, result.to), result.to, fmt_rate(result.rate)
           )
           if result.effective_date && result.effective_date != result.date
-            line += " (effective date: #{result.effective_date} — fallback)"
+            line += " [effective: #{result.effective_date}, fallback]"
           end
           say line
         end
@@ -149,14 +180,16 @@ module Timeprice
           say JSON.generate(result.to_h)
         else
           say format(
-            "%.2f %s in %s -> %.2f %s in %s",
-            result.original_amount, result.from_currency, result.from_date,
-            result.amount, result.to_currency, result.to_date
+            "%s %s in %s -> %s %s in %s",
+            fmt_money(result.original_amount, result.from_currency), result.from_currency, result.from_date,
+            fmt_money(result.amount, result.to_currency), result.to_currency, result.to_date
           )
           say format(
-            "  steps: convert at %s (fx rate %.6f) -> %.4f %s, then inflate in %s (cpi ratio %.6f, granularity: %s)",
-            result.from_date, result.fx_rate, result.converted_amount,
-            result.to_currency, result.country, result.cpi_ratio, result.granularity
+            "  steps: %s %s -> %s %s (fx %s on %s), then inflate in %s x%.4f%s",
+            fmt_money(result.original_amount, result.from_currency), result.from_currency,
+            fmt_money(result.converted_amount, result.to_currency), result.to_currency,
+            fmt_rate(result.fx_rate), result.from_date,
+            result.country, result.cpi_ratio, granularity_suffix(result.granularity)
           )
         end
       end

data/lib/timeprice/errors.rb

@@ -3,12 +3,15 @@
 module Timeprice
   class Error < StandardError; end
 
+  SUPPORTED_COUNTRIES = %w[US UK EU JP VN].freeze
+  SUPPORTED_CURRENCIES = %w[USD GBP EUR JPY VND].freeze
+
   class UnsupportedCountry < Error
     attr_reader :country
 
     def initialize(country)
       @country = country
-      super("Unsupported country: #{country.inspect}")
+      super("Unsupported country: #{country.inspect} (supported: #{SUPPORTED_COUNTRIES.join(", ")})")
     end
   end
 
@@ -17,7 +20,7 @@ module Timeprice
 
     def initialize(currency)
       @currency = currency
-      super("Unsupported currency: #{currency.inspect}")
+      super("Unsupported currency: #{currency.inspect} (supported: #{SUPPORTED_CURRENCIES.join(", ")})")
     end
   end
 

data/lib/timeprice/exchange.rb

@@ -20,6 +20,8 @@ module Timeprice
     def convert(amount:, from:, to:, date:)
       from = from.to_s.upcase
       to   = to.to_s.upcase
+      raise UnsupportedCurrency, from unless SUPPORTED_CURRENCIES.include?(from)
+      raise UnsupportedCurrency, to   unless SUPPORTED_CURRENCIES.include?(to)
       d = parse_date(date)
 
       rate, eff_date = resolve_rate(from, to, d)

data/lib/timeprice/inflation.rb

@@ -61,7 +61,7 @@ module Timeprice
           if annual.key?(year)
             [annual[year], :annual]
           else
-            raise DataNotFound, "No CPI data for #{key.inspect} in #{data["country"]}"
+            raise DataNotFound, missing_cpi_message(key, data, monthly, annual)
           end
         end
       when /\A\d{4}\z/
@@ -69,7 +69,7 @@ module Timeprice
           [annual[key], :annual]
         else
           months = monthly.select { |k, _| k.start_with?("#{key}-") }
-          raise DataNotFound, "No CPI data for #{key.inspect} in #{data["country"]}" if months.empty?
+          raise DataNotFound, missing_cpi_message(key, data, monthly, annual) if months.empty?
           avg = months.values.sum.to_f / months.size
           [avg, :annual_from_monthly_avg]
         end
@@ -78,6 +78,21 @@ module Timeprice
       end
     end
 
+    def missing_cpi_message(key, data, monthly, annual)
+      country = data["country"]
+      ranges = []
+      if monthly.any?
+        ks = monthly.keys.sort
+        ranges << "monthly #{ks.first}..#{ks.last}"
+      end
+      if annual.any?
+        ks = annual.keys.sort
+        ranges << "annual #{ks.first}..#{ks.last}"
+      end
+      hint = ranges.empty? ? "" : " (supported: #{ranges.join(", ")})"
+      "No CPI data for #{key.inspect} in #{country}#{hint}"
+    end
+
     # If either end fell back to annual_from_monthly_avg, propagate that label;
     # else if either is annual, propagate :annual; else :monthly.
     def merge_granularity(a, b)

data/lib/timeprice/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timeprice
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrick