hledger-forecast 2.0.0 → 3.0.0

data/lib/hledger_forecast.rb

@@ -1,29 +1,28 @@
 #!/usr/bin/env ruby
 
-require 'colorize'
-require 'csv'
-require 'date'
-require 'dentaku'
-require 'highline'
-require 'money'
-require 'optparse'
-require 'terminal-table'
+require "colorize"
+require "csv"
+require "date"
+require "dentaku"
+require "highline"
+require "money"
+require "optparse"
+require "terminal-table"
 
 Money.locale_backend = nil
 Money.rounding_mode = BigDecimal::ROUND_HALF_UP
-Money.default_currency = 'USD'
+Money.default_currency = "USD"
 
-require_relative 'hledger_forecast/calculator'
-require_relative 'hledger_forecast/cli'
-require_relative 'hledger_forecast/comparator'
-require_relative 'hledger_forecast/formatter'
-require_relative 'hledger_forecast/generator'
-require_relative 'hledger_forecast/settings'
-require_relative 'hledger_forecast/summarizer'
-require_relative 'hledger_forecast/summarizer_formatter'
-require_relative 'hledger_forecast/utilities'
-require_relative 'hledger_forecast/version'
+require_relative "hledger_forecast/calculator"
+require_relative "hledger_forecast/settings"
+require_relative "hledger_forecast/transaction"
+require_relative "hledger_forecast/forecast"
+require_relative "hledger_forecast/formatter"
+require_relative "hledger_forecast/generator"
+require_relative "hledger_forecast/summarizer"
+require_relative "hledger_forecast/summarizer_formatter"
+require_relative "hledger_forecast/comparator"
+require_relative "hledger_forecast/cli"
+require_relative "hledger_forecast/version"
 
-require_relative 'hledger_forecast/transactions/default'
-require_relative 'hledger_forecast/transactions/modifiers'
-require_relative 'hledger_forecast/transactions/trackers'
+require_relative "hledger_forecast/transactions/default"

data/spec/calculator_spec.rb

@@ -0,0 +1,45 @@
+require_relative "../lib/hledger_forecast"
+
+RSpec.describe HledgerForecast::Calculator do
+  describe ".evaluate" do
+    it "returns a float for an integer" do
+      expect(described_class.evaluate(250)).to(eq(250.0))
+    end
+
+    it "returns a float for a float" do
+      expect(described_class.evaluate(99.5)).to(eq(99.5))
+    end
+
+    it "evaluates a division formula" do
+      expect(described_class.evaluate("=5000/24")).to(be_within(0.01).of(208.33))
+    end
+
+    it "evaluates a multiplication formula" do
+      expect(described_class.evaluate("=25*4.3")).to(be_within(0.01).of(107.5))
+    end
+
+    it "evaluates a compound expression" do
+      expect(described_class.evaluate("=(102.50+3.25)/2")).to(be_within(0.01).of(52.875))
+    end
+  end
+
+  describe ".evaluate_date" do
+    let(:from) { Date.parse("2023-03-01") }
+
+    it "parses a plain date string" do
+      expect(described_class.evaluate_date(from, "2023-06-01")).to(eq(Date.parse("2023-06-01")))
+    end
+
+    it "calculates N months forward and subtracts one day" do
+      expect(described_class.evaluate_date(from, "=12")).to(eq(Date.parse("2024-02-29")))
+    end
+
+    it "handles a 6-month offset" do
+      expect(described_class.evaluate_date(from, "=6")).to(eq(Date.parse("2023-08-31")))
+    end
+
+    it "handles a 24-month offset" do
+      expect(described_class.evaluate_date(from, "=24")).to(eq(Date.parse("2025-02-28")))
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -1,13 +1,13 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 output = <<~JOURNAL
   ~ monthly from 2023-03-01  * Mortgage, Food
-      Expenses:Mortgage    £2,000.55   ;  Mortgage
-      Expenses:Food        £100.00     ;  Food
+      Expenses:Mortgage    £2,000.55
+      Expenses:Food        £100.00
       Assets:Bank
 
   ~ monthly from 2023-03-01  * Savings
-      Assets:Bank          £-1,000.00  ;  Savings
+      Assets:Bank          £-1,000.00
       Assets:Savings
 
 JOURNAL
@@ -25,28 +25,30 @@ ensure
   $stdout = old_stdout
 end
 
-RSpec.describe 'command' do
-  it 'uses the CLI to generate an output with a CSV config file' do
-    generated_journal = './test_output.journal'
+RSpec.describe "command" do
+  it "uses the CLI to generate an output with a CSV config file" do
+    generated_journal = "./test_output.journal"
     File.delete(generated_journal) if File.exist?(generated_journal)
 
     system("./bin/hledger-forecast generate -f ./spec/stubs/forecast.csv -o ./test_output.journal --force")
 
-    expect(File.read(generated_journal)).to eq(output)
+    expect(File.read(generated_journal)).to(eq(output))
   end
 
-  it 'uses the CLI to compare two CSV files' do
-    expected_output = strip_ansi_codes(<<~OUTPUT)
-      +---------+---------+---------+
-      | account | 2023-07 | 2023-08 |
-      +---------+---------+---------+
-      | total   | £10.00  | €-10.00 |
-      +---------+---------+---------+
+  it "uses the CLI to compare two CSV files" do
+    expected_output = strip_ansi_codes(
+      <<~OUTPUT
+        +---------+---------+---------+
+        | account | 2023-07 | 2023-08 |
+        +---------+---------+---------+
+        | total   | £10.00  | €-10.00 |
+        +---------+---------+---------+
 
-    OUTPUT
+      OUTPUT
+    )
 
     actual_output = `./bin/hledger-forecast compare ./spec/stubs/output1.csv ./spec/stubs/output2.csv`
 
-    expect(strip_ansi_codes(actual_output)).to eq(expected_output)
+    expect(strip_ansi_codes(actual_output)).to(eq(expected_output))
   end
 end

data/spec/compare_spec.rb

@@ -1,5 +1,5 @@
-require_relative '../lib/hledger_forecast'
-require 'stringio'
+require_relative "../lib/hledger_forecast"
+require "stringio"
 
 def strip_ansi_codes(str)
   str.gsub(/\e\[([;\d]+)?m/, "")
@@ -33,22 +33,24 @@ RSpec.describe HledgerForecast::Comparator do
   let(:file2) { StringIO.new(file2_content) }
 
   before do
-    allow(CSV).to receive(:read).with('file1.csv').and_return(CSV.parse(file1.read))
-    allow(CSV).to receive(:read).with('file2.csv').and_return(CSV.parse(file2.read))
+    allow(CSV).to(receive(:read).with("file1.csv").and_return(CSV.parse(file1.read)))
+    allow(CSV).to(receive(:read).with("file2.csv").and_return(CSV.parse(file2.read)))
   end
 
   it "compares the contents of two CSV files and outputs the difference" do
     comparator = described_class.new
 
-    expected_output = strip_ansi_codes(<<~OUTPUT)
-      +---------+---------+----------+---------+
-      | account | 2023-07 | 2023-08  | 2023-09 |
-      +---------+---------+----------+---------+
-      | total   | £10.00  | €-400.00 | 1144.00 |
-      +---------+---------+----------+---------+
-    OUTPUT
-
-    actual_output = capture_stdout { comparator.compare('file1.csv', 'file2.csv') }
-    expect(strip_ansi_codes(actual_output)).to eq(expected_output)
+    expected_output = strip_ansi_codes(
+      <<~OUTPUT
+        +---------+---------+----------+---------+
+        | account | 2023-07 | 2023-08  | 2023-09 |
+        +---------+---------+----------+---------+
+        | total   | £10.00  | €-400.00 | 1144.00 |
+        +---------+---------+----------+---------+
+      OUTPUT
+    )
+
+    actual_output = capture_stdout { comparator.compare("file1.csv", "file2.csv") }
+    expect(strip_ansi_codes(actual_output)).to(eq(expected_output))
   end
 end

data/spec/computed_amounts_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -10,15 +10,15 @@ CSV
 
 output = <<~JOURNAL
   ~ monthly from 2023-05-01  * New kitchen, Monthly food shop, Random food
-      Expenses:House    £208.33              ;  New kitchen
-      Expenses:Food     £107.50              ;  Monthly food shop
-      Expenses:Food     £52.88               ;  Random food
+      Expenses:House    £208.33
+      Expenses:Food     £107.50
+      Expenses:Food     £52.88
       Liabilities:Amex
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct CALCULATED transactions' do
-    expect(HledgerForecast::Generator.generate(config)).to eq(output)
+RSpec.describe "generate" do
+  it "generates a forecast with correct CALCULATED transactions" do
+    expect(HledgerForecast::Generator.generate(config)).to(eq(output))
   end
 end

data/spec/custom_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 base_config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -9,11 +9,11 @@ CSV
 
 base_output = <<~JOURNAL
   ~ every 2 weeks from 2023-05-01  * Hair and beauty
-      [Expenses:Personal Care]    £80.00 ;  Hair and beauty
+      [Expenses:Personal Care]    £80.00
       [Assets:Bank]
 
   ~ every 5 days from 2023-05-01  * Food
-      [Expenses:Groceries]        £50.00 ;  Food
+      [Expenses:Groceries]        £50.00
       [Assets:Bank]
 
 JOURNAL
@@ -26,19 +26,19 @@ CSV
 
 calculated_output = <<~JOURNAL
   ~ every 2 weeks from 2023-05-01 to 2023-10-31  * Hair and beauty
-      [Expenses:Personal Care]    £80.00 ;  Hair and beauty
+      [Expenses:Personal Care]    £80.00
       [Assets:Bank]
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct CUSTOM transactions' do
+RSpec.describe "generate" do
+  it "generates a forecast with correct CUSTOM transactions" do
     generated_journal = HledgerForecast::Generator.generate(base_config)
-    expect(generated_journal).to eq(base_output)
+    expect(generated_journal).to(eq(base_output))
   end
 
-  it 'generates a forecast with correct CUSTOM transactions and CALCULATED to dates' do
+  it "generates a forecast with correct CUSTOM transactions and CALCULATED to dates" do
     generated_journal = HledgerForecast::Generator.generate(calculated_config)
-    expect(generated_journal).to eq(calculated_output)
+    expect(generated_journal).to(eq(calculated_output))
   end
 end

data/spec/formatter_spec.rb

@@ -0,0 +1,51 @@
+require_relative "../lib/hledger_forecast"
+
+RSpec.describe HledgerForecast::Formatter do
+  def make_settings(overrides = {})
+    rows = []
+    overrides.each do |key, value|
+      rows << {type: "settings", frequency: key.to_s, account: value.to_s}
+    end
+
+    csv_rows = rows.map { |r| "settings,#{r[:frequency]},#{r[:account]},,,,,,,," }.join("\n")
+    full_csv = "type,frequency,account,from,to,description,category,amount,roll_up,summary_exclude\n#{csv_rows}\n"
+
+    parsed = CSV.parse(
+      full_csv,
+      headers: true,
+      header_converters: -> (h) { h.to_s.tr("-", "_").to_sym },
+      converters: :numeric
+    )
+    HledgerForecast::Settings.parse(parsed.select { |r| r[:type] == "settings" })
+  end
+
+  describe ".format_money" do
+    context("GBP with defaults") do
+      let(:settings) { make_settings(currency: "GBP") }
+
+      it "formats a positive amount" do
+        expect(described_class.format_money(1000, settings)).to(eq("£1,000.00"))
+      end
+
+      it "formats a negative amount" do
+        expect(described_class.format_money(-500, settings)).to(eq("£-500.00"))
+      end
+    end
+
+    context("with thousands_separator disabled") do
+      let(:settings) { make_settings(currency: "USD", thousands_separator: "false") }
+
+      it "omits the thousands separator" do
+        expect(described_class.format_money(1000, settings)).to(eq("$1000.00"))
+      end
+    end
+
+    context("with no settings (all defaults)") do
+      let(:settings) { make_settings }
+
+      it "defaults to USD" do
+        expect(described_class.format_money(100, settings)).to(eq("$100.00"))
+      end
+    end
+  end
+end

data/spec/half-yearly_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -8,15 +8,15 @@ CSV
 
 output = <<~JOURNAL
   ~ every 6 months from 2023-04-01  * Holiday
-      Expenses:Holiday    £500.00 ;  Holiday
+      Expenses:Holiday    £500.00
       Assets:Bank
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct HALF-YEARLY transactions' do
+RSpec.describe "generate" do
+  it "generates a forecast with correct HALF-YEARLY transactions" do
     generated_journal = HledgerForecast::Generator.generate(config)
 
-    expect(generated_journal).to eq(output)
+    expect(generated_journal).to(eq(output))
   end
 end

data/spec/monthly_end_date_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -9,14 +9,14 @@ CSV
 
 output = <<~JOURNAL
   ~ monthly from 2023-03-01 to 2023-06-01  * Mortgage, Food
-      Expenses:Mortgage    £2,000.00   ;  Mortgage
-      Expenses:Food        £100.00     ;  Food
+      Expenses:Mortgage    £2,000.00
+      Expenses:Food        £100.00
       Assets:Bank
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct MONTHLY transactions that have an end date, at the top level' do
-    expect(HledgerForecast::Generator.generate(config)).to eq(output)
+RSpec.describe "generate" do
+  it "generates a forecast with correct MONTHLY transactions that have an end date, at the top level" do
+    expect(HledgerForecast::Generator.generate(config)).to(eq(output))
   end
 end

data/spec/monthly_end_date_transaction_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -10,12 +10,12 @@ CSV
 
 output = <<~JOURNAL
   ~ monthly from 2023-03-01 to 2023-06-01  * Mortgage, Mortgage top up
-      Expenses:Mortgage    £2,000.00   ;  Mortgage
-      Expenses:Mortgage    £200.00     ;  Mortgage top up
+      Expenses:Mortgage    £2,000.00
+      Expenses:Mortgage    £200.00
       Assets:Bank
 
   ~ monthly from 2023-03-01  * Food
-      Expenses:Food        £100.00     ;  Food
+      Expenses:Food        £100.00
       Assets:Bank
 
 JOURNAL
@@ -28,17 +28,17 @@ CSV
 
 computed_output = <<~JOURNAL
   ~ monthly from 2023-03-01 to 2024-02-29  * Mortgage
-      Expenses:Mortgage    £2,000.00   ;  Mortgage
+      Expenses:Mortgage    £2,000.00
       Assets:Bank
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct MONTHLY transactions that have an end date' do
-    expect(HledgerForecast::Generator.generate(config)).to eq(output)
+RSpec.describe "generate" do
+  it "generates a forecast with correct MONTHLY transactions that have an end date" do
+    expect(HledgerForecast::Generator.generate(config)).to(eq(output))
   end
 
-  it 'generates a forecast with correct MONTHLY transactions that have a COMPUTED end date' do
-    expect(HledgerForecast::Generator.generate(computed_config)).to eq(computed_output)
+  it "generates a forecast with correct MONTHLY transactions that have a COMPUTED end date" do
+    expect(HledgerForecast::Generator.generate(computed_config)).to(eq(computed_output))
   end
 end

data/spec/monthly_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -10,15 +10,15 @@ CSV
 
 output = <<~JOURNAL
   ~ monthly from 2023-03-01  * Bills, Food, Savings
-      Expenses:Bills    £175.00   ;  Bills
-      Expenses:Food     £500.00   ;  Food
-      Assets:Savings    £-1,000.00;  Savings
+      Expenses:Bills    £175.00
+      Expenses:Food     £500.00
+      Assets:Savings    £-1,000.00
       Assets:Bank
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct MONTHLY transactions' do
-    expect(HledgerForecast::Generator.generate(config)).to eq(output)
+RSpec.describe "generate" do
+  it "generates a forecast with correct MONTHLY transactions" do
+    expect(HledgerForecast::Generator.generate(config)).to(eq(output))
   end
 end

data/spec/once_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -8,14 +8,14 @@ CSV
 
 output = <<~JOURNAL
   ~ 2023-07-01  * New Kitchen
-      Expenses:House    £5,000.00;  New Kitchen
+      Expenses:House    £5,000.00
       Assets:Bank
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct ONCE transactions' do
+RSpec.describe "generate" do
+  it "generates a forecast with correct ONCE transactions" do
     generated_journal = HledgerForecast::Generator.generate(config)
-    expect(generated_journal).to eq(output)
+    expect(generated_journal).to(eq(output))
   end
 end

data/spec/quarterly_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/hledger_forecast'
+require_relative "../lib/hledger_forecast"
 
 config = <<~CSV
   type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
@@ -8,13 +8,13 @@ CSV
 
 output = <<~JOURNAL
   ~ every 3 months from 2023-04-01  * Bonus
-      Income:Bonus    £-1,000.00;  Bonus
+      Income:Bonus    £-1,000.00
       Assets:Bank
 
 JOURNAL
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct QUARTERLY transactions' do
-    expect(HledgerForecast::Generator.generate(config)).to eq(output)
+RSpec.describe "generate" do
+  it "generates a forecast with correct QUARTERLY transactions" do
+    expect(HledgerForecast::Generator.generate(config)).to(eq(output))
   end
 end

data/spec/settings_spec.rb

@@ -0,0 +1,101 @@
+require_relative "../lib/hledger_forecast"
+
+RSpec.describe HledgerForecast::Settings do
+  def settings_rows_from(csv)
+    CSV
+      .parse(csv, headers: true, header_converters: -> (h) { h.to_s.tr("-", "_").to_sym }, converters: :numeric)
+      .select { |r| r[:type] == "settings" }
+  end
+
+  describe "defaults when no settings rows are present" do
+    let(:rows) {
+      settings_rows_from("type,frequency,account,from,to,description,category,amount,roll_up,summary_exclude\n")
+    }
+
+    it "defaults to USD" do
+      expect(described_class.parse(rows).currency).to(eq("USD"))
+    end
+
+    it "shows the currency symbol" do
+      expect(described_class.parse(rows).show_symbol).to(eq(true))
+    end
+
+    it "uses a thousands separator" do
+      expect(described_class.parse(rows).thousands_separator).to(eq(","))
+    end
+
+    it "is not verbose" do
+      expect(described_class.parse(rows).verbose?).to(eq(false))
+    end
+  end
+
+  describe "single settings row" do
+    let(:rows) do
+      settings_rows_from(
+        <<~CSV
+          type,frequency,account,from,to,description,category,amount,roll_up,summary_exclude
+          settings,currency,GBP,,,,,,,,
+        CSV
+      )
+    end
+
+    it "applies the currency" do
+      expect(described_class.parse(rows).currency).to(eq("GBP"))
+    end
+
+    it "retains other defaults" do
+      settings = described_class.parse(rows)
+      expect(settings.show_symbol).to(eq(true))
+      expect(settings.thousands_separator).to(eq(","))
+    end
+  end
+
+  describe "multiple settings rows do not clobber each other" do
+    let(:rows) do
+      settings_rows_from(
+        <<~CSV
+          type,frequency,account,from,to,description,category,amount,roll_up,summary_exclude
+          settings,currency,GBP,,,,,,,,
+          settings,show_symbol,false,,,,,,,,
+          settings,thousands_separator,false,,,,,,,,
+        CSV
+      )
+    end
+
+    it "preserves all three settings independently" do
+      settings = described_class.parse(rows)
+      expect(settings.currency).to(eq("GBP"))
+      expect(settings.show_symbol).to(eq("false"))
+      expect(settings.thousands_separator).to(eq("false"))
+    end
+  end
+
+  describe "cli_options take precedence over csv settings" do
+    let(:rows) do
+      settings_rows_from(
+        <<~CSV
+          type,frequency,account,from,to,description,category,amount,roll_up,summary_exclude
+          settings,currency,GBP,,,,,,,,
+        CSV
+      )
+    end
+
+    it "overrides currency from cli" do
+      expect(described_class.parse(rows, {currency: "EUR"}).currency).to(eq("EUR"))
+    end
+  end
+
+  describe "cli-only options" do
+    let(:rows) {
+      settings_rows_from("type,frequency,account,from,to,description,category,amount,roll_up,summary_exclude\n")
+    }
+
+    it "stores verbose from cli_options" do
+      expect(described_class.parse(rows, {verbose: true}).verbose?).to(eq(true))
+    end
+
+    it "stores roll_up from cli_options" do
+      expect(described_class.parse(rows, {roll_up: "monthly"}).roll_up).to(eq("monthly"))
+    end
+  end
+end

data/spec/stubs/forecast.csv

@@ -1,5 +1,5 @@
-type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
-monthly,,Assets:Bank,01/03/2023,,Mortgage,Expenses:Mortgage,2000.55,,,
-monthly,,Assets:Bank,01/03/2023,,Food,Expenses:Food,100,,,
-monthly,,Assets:Savings,01/03/2023,,Savings,Assets:Bank,-1000,,,
+type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude
+monthly,,Assets:Bank,01/03/2023,,Mortgage,Expenses:Mortgage,2000.55,,
+monthly,,Assets:Bank,01/03/2023,,Food,Expenses:Food,100,,
+monthly,,Assets:Savings,01/03/2023,,Savings,Assets:Bank,-1000,,
 settings,currency,GBP,,,,,,,,