hledger-forecast 0.2.0 → 0.3.0

data/spec/track_spec.rb

@@ -0,0 +1,197 @@
+require_relative '../lib/hledger_forecast'
+
+current_month = Date.new(Date.today.year, Date.today.month, 1)
+previous_month = current_month.prev_month
+next_month = current_month.next_month
+
+base_config = <<~YAML
+  once:
+    - account: "Assets:Bank"
+      from: "2023-03-05"
+      transactions:
+        - amount: 3000
+          category: "Expenses:Tax"
+          description: Tax owed
+          track: true
+        - amount: 100
+          category: "Expenses:Food"
+          description: Food expenses
+        - amount: -1500
+          category: "Income:Salary"
+          description: Salary
+          to: "2023-08-01"
+          track: true
+
+  settings:
+    currency: GBP
+YAML
+
+base_output = <<~JOURNAL
+  ~ 2023-03-05  * Food expenses
+      Expenses:Food    £100.00 ;  Food expenses
+      Assets:Bank
+
+  ~ #{next_month}  * [TRACKED] Tax owed
+      Expenses:Tax     £3,000.00;  Tax owed
+      Assets:Bank
+
+  ~ #{next_month}  * [TRACKED] Salary
+      Income:Salary    £-1,500.00;  Salary
+      Assets:Bank
+
+JOURNAL
+
+RSpec.describe 'Tracking transactions -' do
+  it 'Determines which transactions should be tracked' do
+    generated = HledgerForecast::Generator
+    generated.generate(base_config)
+    tracked = generated.tracked
+
+    expect(tracked[0]['transaction']).to eq(
+      { "amount" => "£3,000.00", "category" => "Expenses:Tax", "description" => "Tax owed",
+        "inverse_amount" => "£-3,000.00", "track" => true }
+    )
+    expect(tracked[0]['account']).to eq("Assets:Bank")
+
+    expect(tracked[1]['transaction']).to eq(
+      { "amount" => "£-1,500.00", "category" => "Income:Salary", "description" => "Salary", "to" => "2023-08-01",
+        "inverse_amount" => "£1,500.00", "track" => true }
+    )
+    expect(tracked[1]['account']).to eq("Assets:Bank")
+  end
+
+  it 'marks a transaction as NOT FOUND if it doesnt exist' do
+    generated = HledgerForecast::Generator
+    generated.tracked = {} # Clear tracked transactions
+    generated.generate(base_config)
+    transactions_to_track = generated.tracked
+
+    track = HledgerForecast::Tracker.track(transactions_to_track, 'spec/stubs/transactions_not_found.journal')
+
+    expect(track[0]['found']).to eq(false)
+    expect(track[1]['found']).to eq(false)
+  end
+
+  it 'marks a transaction as FOUND if it exists' do
+    generated = HledgerForecast::Generator
+    generated.tracked = {} # Clear tracked transactions
+    generated.generate(base_config)
+    transactions_to_track = generated.tracked
+
+    track = HledgerForecast::Tracker.track(transactions_to_track, 'spec/stubs/transactions_found.journal')
+
+    expect(track[0]['found']).to eq(true)
+    expect(track[1]['found']).to eq(true)
+  end
+
+  it 'marks a transaction as FOUND if it exists, even if the category/amount are inversed' do
+    generated = HledgerForecast::Generator
+    generated.tracked = {} # Clear tracked transactions
+    generated.generate(base_config)
+    transactions_to_track = generated.tracked
+
+    track = HledgerForecast::Tracker.track(transactions_to_track, 'spec/stubs/transactions_found_inverse.journal')
+
+    expect(track[0]['found']).to eq(true)
+  end
+
+  it 'writes a NON-FOUND entry into a journal' do
+    options = {}
+    options[:transaction_file] = 'spec/stubs/transactions_not_found.journal'
+
+    generated = HledgerForecast::Generator
+    generated.tracked = {} # Clear tracked transactions
+
+    generated_journal = generated.generate(base_config, options)
+
+    expected_output = base_output
+    expect(generated_journal).to eq(expected_output)
+  end
+
+  it 'writes a NON-FOUND entry for dates that are close to the current period' do
+    require 'tempfile'
+
+    forecast_config = <<~YAML
+      once:
+        - account: "Assets:Bank"
+          from: "#{previous_month}"
+          transactions:
+            - amount: 5000
+              category: "Expenses:House"
+              description: New kitchen
+              track: true
+
+      settings:
+        currency: GBP
+    YAML
+
+    journal = <<~JOURNAL
+      #{previous_month} * Opening balance
+          Assets:Bank                             £1,000.00
+          Equity:Opening balance
+
+      #{previous_month} * Mortgage payment
+          Expenses:Mortgage                 £1,500.00
+          Assets:Bank
+
+      #{current_month - 10} * Groceries
+          Expenses:Groceries                £1,500.00
+          Assets:Bank
+
+    JOURNAL
+
+    temp_file = Tempfile.new('journal')
+    temp_file.write(journal)
+    temp_file.close
+
+    options = {}
+    options[:transaction_file] = temp_file.path
+
+    generated = HledgerForecast::Generator
+    generated.tracked = {} # Clear tracked transactions
+
+    generated_journal = generated.generate(forecast_config, options)
+
+    expected_output = <<~JOURNAL
+      ~ #{next_month}  * [TRACKED] New kitchen
+          Expenses:House    £5,000.00;  New kitchen
+          Assets:Bank
+
+    JOURNAL
+
+    expect(generated_journal).to eq(expected_output)
+  end
+
+  it 'treats a future tracked transaction as a regular transaction' do
+    forecast_config = <<~YAML
+      monthly:
+        - account: "Assets:Bank"
+          from: "#{next_month}"
+          transactions:
+            - amount: 100
+              category: "Expenses:Food"
+              description: Food expenses
+              track: true
+
+      settings:
+        currency: GBP
+    YAML
+
+    options = {}
+    options[:transaction_file] = 'spec/stubs/transactions_not_found.journal'
+
+    generated = HledgerForecast::Generator
+    generated.tracked = {} # Clear tracked transactions
+
+    generated_journal = generated.generate(forecast_config, options)
+
+    output = <<~JOURNAL
+      ~ monthly from #{next_month}  * Food expenses
+          Expenses:Food    £100.00;  Food expenses
+          Assets:Bank
+
+    JOURNAL
+
+    expect(generated_journal).to eq(output)
+  end
+end

data/spec/yearly_spec.rb

@@ -1,13 +1,27 @@
 require_relative '../lib/hledger_forecast'
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct YEARLY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/yearly/forecast_yearly.yml')
+config = <<~YAML
+  settings:
+    currency: GBP
+
+  yearly:
+    - account: "Assets:Bank"
+      from: "2023-04-01"
+      transactions:
+        - description: Bonus
+          category: "Income:Bonus"
+          amount: -3,000.00
+YAML
 
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2024-04-30')
+output = <<~JOURNAL
+  ~ yearly from 2023-04-01  * Bonus
+      Income:Bonus    £-3,000.00;  Bonus
+      Assets:Bank
 
-    expected_output = File.read('spec/stubs/yearly/output_yearly.journal')
-    expect(generated_journal).to eq(expected_output)
+JOURNAL
+
+RSpec.describe 'generate' do
+  it 'generates a forecast with correct YEARLY transactions' do
+    expect(HledgerForecast::Generator.generate(config)).to eq(output)
   end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Oli Morris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-22 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
-  name: money
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.16.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.16.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: money
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 6.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 6.16.0
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
-description: Uses a YAML file to generate monthly, quarterly, yearly and one-off transactions
-  for better forecasting in Hledger
+description: Uses a YAML file to generate forecasts which can be used to extend the
+  default functionality in hledger
 email: olimorris@users.noreply.github.com
 executables:
 - hledger-forecast
@@ -95,49 +95,29 @@ files:
 - LICENSE
 - README.md
 - bin/hledger-forecast
+- example.journal
 - example.yml
 - hledger-forecast.gemspec
 - lib/hledger_forecast.rb
 - lib/hledger_forecast/cli.rb
 - lib/hledger_forecast/generator.rb
 - lib/hledger_forecast/summarize.rb
+- lib/hledger_forecast/tracker.rb
 - lib/hledger_forecast/version.rb
 - spec/command_spec.rb
 - spec/custom_spec.rb
 - spec/half-yearly_spec.rb
+- spec/modifier_spec.rb
+- spec/monthly_end_date_spec.rb
+- spec/monthly_end_date_transaction_spec.rb
 - spec/monthly_spec.rb
 - spec/once_spec.rb
 - spec/quarterly_spec.rb
-- spec/start_date_spec.rb
-- spec/stubs/custom/forecast_custom_days.yml
-- spec/stubs/custom/forecast_custom_months.yml
-- spec/stubs/custom/forecast_custom_weeks.yml
-- spec/stubs/custom/forecast_custom_weeks_twice.yml
-- spec/stubs/custom/output_custom_days.journal
-- spec/stubs/custom/output_custom_months.journal
-- spec/stubs/custom/output_custom_weeks.journal
-- spec/stubs/custom/output_custom_weeks_twice.journal
-- spec/stubs/half-yearly/forecast_half-yearly.yml
-- spec/stubs/half-yearly/output_half-yearly.journal
-- spec/stubs/modifiers/forecast_modifiers.yml
-- spec/stubs/modifiers/output_modifiers.journal
-- spec/stubs/monthly/forecast_monthly.yml
-- spec/stubs/monthly/forecast_monthly_enddate.yml
-- spec/stubs/monthly/forecast_monthly_enddate_top.yml
-- spec/stubs/monthly/forecast_monthly_modifier.yml
-- spec/stubs/monthly/output_monthly.journal
-- spec/stubs/monthly/output_monthly_enddate.journal
-- spec/stubs/monthly/output_monthly_enddate_top.journal
-- spec/stubs/monthly/output_monthly_modifier.journal
-- spec/stubs/once/forecast_once.yml
-- spec/stubs/once/output_once.journal
-- spec/stubs/quarterly/forecast_quarterly.yml
-- spec/stubs/quarterly/output_quarterly.journal
-- spec/stubs/start_date/forecast_startdate.yml
-- spec/stubs/start_date/output_startdate.journal
-- spec/stubs/transactions.journal
-- spec/stubs/yearly/forecast_yearly.yml
-- spec/stubs/yearly/output_yearly.journal
+- spec/stubs/forecast.yml
+- spec/stubs/transactions_found.journal
+- spec/stubs/transactions_found_inverse.journal
+- spec/stubs/transactions_not_found.journal
+- spec/track_spec.rb
 - spec/yearly_spec.rb
 homepage: https://github.com/olimorris/hledger-forecast
 licenses:
@@ -161,42 +141,20 @@ requirements: []
 rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: Utility to generate forecasts in Hledger
+summary: An extended wrapper around hledger's forecasting functionality
 test_files:
 - spec/command_spec.rb
 - spec/custom_spec.rb
 - spec/half-yearly_spec.rb
+- spec/modifier_spec.rb
+- spec/monthly_end_date_spec.rb
+- spec/monthly_end_date_transaction_spec.rb
 - spec/monthly_spec.rb
 - spec/once_spec.rb
 - spec/quarterly_spec.rb
-- spec/start_date_spec.rb
-- spec/stubs/custom/forecast_custom_days.yml
-- spec/stubs/custom/forecast_custom_months.yml
-- spec/stubs/custom/forecast_custom_weeks.yml
-- spec/stubs/custom/forecast_custom_weeks_twice.yml
-- spec/stubs/custom/output_custom_days.journal
-- spec/stubs/custom/output_custom_months.journal
-- spec/stubs/custom/output_custom_weeks.journal
-- spec/stubs/custom/output_custom_weeks_twice.journal
-- spec/stubs/half-yearly/forecast_half-yearly.yml
-- spec/stubs/half-yearly/output_half-yearly.journal
-- spec/stubs/modifiers/forecast_modifiers.yml
-- spec/stubs/modifiers/output_modifiers.journal
-- spec/stubs/monthly/forecast_monthly.yml
-- spec/stubs/monthly/forecast_monthly_enddate.yml
-- spec/stubs/monthly/forecast_monthly_enddate_top.yml
-- spec/stubs/monthly/forecast_monthly_modifier.yml
-- spec/stubs/monthly/output_monthly.journal
-- spec/stubs/monthly/output_monthly_enddate.journal
-- spec/stubs/monthly/output_monthly_enddate_top.journal
-- spec/stubs/monthly/output_monthly_modifier.journal
-- spec/stubs/once/forecast_once.yml
-- spec/stubs/once/output_once.journal
-- spec/stubs/quarterly/forecast_quarterly.yml
-- spec/stubs/quarterly/output_quarterly.journal
-- spec/stubs/start_date/forecast_startdate.yml
-- spec/stubs/start_date/output_startdate.journal
-- spec/stubs/transactions.journal
-- spec/stubs/yearly/forecast_yearly.yml
-- spec/stubs/yearly/output_yearly.journal
+- spec/stubs/forecast.yml
+- spec/stubs/transactions_found.journal
+- spec/stubs/transactions_found_inverse.journal
+- spec/stubs/transactions_not_found.journal
+- spec/track_spec.rb
 - spec/yearly_spec.rb

data/spec/start_date_spec.rb

@@ -1,12 +0,0 @@
-require_relative '../lib/hledger_forecast'
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct MONTHLY transactions that have a START DATE' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/start_date/forecast_startdate.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2023-08-30')
-
-    expected_output = File.read('spec/stubs/start_date/output_startdate.journal')
-    expect(generated_journal).to eq(expected_output)
-  end
-end

data/spec/stubs/custom/forecast_custom_days.yml

@@ -1,14 +0,0 @@
-custom:
-  - description: Repeat every 3 days
-    recurrence:
-      period: days
-      quantity: 3
-    account: "[Assets:Bank]"
-    start: "2023-03-01"
-    transactions:
-      - amount: 80
-        category: "[Expenses:Personal Care]"
-        description: Hair and beauty
-
-settings:
-  currency: GBP

data/spec/stubs/custom/forecast_custom_months.yml

@@ -1,14 +0,0 @@
-custom:
-  - description: Repeat every 5 months
-    recurrence:
-      period: months
-      quantity: 5
-    account: "[Assets:Bank]"
-    start: "2023-03-01"
-    transactions:
-      - amount: 100
-        category: "[Expenses:Personal Care]"
-        description: Hair and beauty
-
-settings:
-  currency: GBP

data/spec/stubs/custom/forecast_custom_weeks.yml

@@ -1,14 +0,0 @@
-custom:
-  - description: Repeat every 2 weeks
-    recurrence:
-      period: weeks
-      quantity: 2
-    account: "[Assets:Bank]"
-    start: "2023-03-01"
-    transactions:
-      - amount: 75
-        category: "[Expenses:Personal Care]"
-        description: Hair and beauty
-
-settings:
-  currency: GBP

data/spec/stubs/custom/forecast_custom_weeks_twice.yml

@@ -1,24 +0,0 @@
-custom:
-  - description: Beauty expenses every 2 weeks
-    recurrence:
-      period: weeks
-      quantity: 2
-    account: "[Assets:Bank]"
-    start: "2023-03-01"
-    transactions:
-      - amount: 75
-        category: "[Expenses:Personal Care]"
-        description: Hair and beauty
-  - description: Car fuel every 5 days
-    recurrence:
-      period: days
-      quantity: 5
-    account: "[Assets:Bank]"
-    start: "2023-03-01"
-    transactions:
-      - amount: 150
-        category: "[Expenses:Car:Fuel]"
-        description: Car Fuel
-
-settings:
-  currency: GBP

data/spec/stubs/custom/output_custom_days.journal

@@ -1,24 +0,0 @@
-2023-02-01 * Opening balance
-    Assets:Bank                             £1,000.00
-    Equity:Opening balance
-
-2023-02-05 * Mortgage payment
-    Expenses:Mortgage                 £1,500.00
-    Assets:Bank
-
-2023-03-01 * Hair and beauty
-    [Expenses:Personal Care]                £80.00
-    [Assets:Bank]
-
-2023-03-04 * Hair and beauty
-    [Expenses:Personal Care]                £80.00
-    [Assets:Bank]
-
-2023-03-07 * Hair and beauty
-    [Expenses:Personal Care]                £80.00
-    [Assets:Bank]
-
-2023-03-10 * Hair and beauty
-    [Expenses:Personal Care]                £80.00
-    [Assets:Bank]
-

data/spec/stubs/custom/output_custom_months.journal

@@ -1,20 +0,0 @@
-2023-02-01 * Opening balance
-    Assets:Bank                             £1,000.00
-    Equity:Opening balance
-
-2023-02-05 * Mortgage payment
-    Expenses:Mortgage                 £1,500.00
-    Assets:Bank
-
-2023-03-01 * Hair and beauty
-    [Expenses:Personal Care]                £100.00
-    [Assets:Bank]
-
-2023-08-01 * Hair and beauty
-    [Expenses:Personal Care]                £100.00
-    [Assets:Bank]
-
-2024-01-01 * Hair and beauty
-    [Expenses:Personal Care]                £100.00
-    [Assets:Bank]
-

data/spec/stubs/custom/output_custom_weeks.journal

@@ -1,28 +0,0 @@
-2023-02-01 * Opening balance
-    Assets:Bank                             £1,000.00
-    Equity:Opening balance
-
-2023-02-05 * Mortgage payment
-    Expenses:Mortgage                 £1,500.00
-    Assets:Bank
-
-2023-03-01 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-
-2023-03-15 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-
-2023-03-29 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-
-2023-04-12 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-
-2023-04-26 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-

data/spec/stubs/custom/output_custom_weeks_twice.journal

@@ -1,44 +0,0 @@
-2023-02-01 * Opening balance
-    Assets:Bank                             £1,000.00
-    Equity:Opening balance
-
-2023-02-05 * Mortgage payment
-    Expenses:Mortgage                 £1,500.00
-    Assets:Bank
-
-2023-03-01 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-
-2023-03-01 * Car Fuel
-    [Expenses:Car:Fuel]                £150.00
-    [Assets:Bank]
-
-2023-03-06 * Car Fuel
-    [Expenses:Car:Fuel]                £150.00
-    [Assets:Bank]
-
-2023-03-11 * Car Fuel
-    [Expenses:Car:Fuel]                £150.00
-    [Assets:Bank]
-
-2023-03-15 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-
-2023-03-16 * Car Fuel
-    [Expenses:Car:Fuel]                £150.00
-    [Assets:Bank]
-
-2023-03-21 * Car Fuel
-    [Expenses:Car:Fuel]                £150.00
-    [Assets:Bank]
-
-2023-03-26 * Car Fuel
-    [Expenses:Car:Fuel]                £150.00
-    [Assets:Bank]
-
-2023-03-29 * Hair and beauty
-    [Expenses:Personal Care]                £75.00
-    [Assets:Bank]
-

data/spec/stubs/half-yearly/forecast_half-yearly.yml

@@ -1,10 +0,0 @@
-settings:
-  currency: GBP
-
-half-yearly:
-  - start: "2023-04-01"
-    account: "[Assets:Bank]"
-    transactions:
-      - description: Holiday
-        category: "[Expenses:Holiday]"
-        amount: 500

data/spec/stubs/half-yearly/output_half-yearly.journal

@@ -1,20 +0,0 @@
-2023-02-01 * Opening balance
-    Assets:Bank                             £1,000.00
-    Equity:Opening balance
-
-2023-02-05 * Mortgage payment
-    Expenses:Mortgage                 £1,500.00
-    Assets:Bank
-
-2023-04-01 * Holiday
-    [Expenses:Holiday]                £500.00
-    [Assets:Bank]
-
-2023-10-01 * Holiday
-    [Expenses:Holiday]                £500.00
-    [Assets:Bank]
-
-2024-04-01 * Holiday
-    [Expenses:Holiday]                £500.00
-    [Assets:Bank]
-

data/spec/stubs/modifiers/forecast_modifiers.yml

@@ -1,13 +0,0 @@
-monthly:
-  - account: "[Assets:Bank]"
-    start: "2023-03-01"
-    transactions:
-      - amount: 2000
-        category: "[Expenses:Mortgage]"
-        description: Mortgage
-        modifier:
-          amount: 2.0
-          period: yearly
-
-settings:
-  currency: GBP