hledger-forecast 0.2.1 → 0.3.0

data/lib/hledger_forecast/tracker.rb

@@ -0,0 +1,37 @@
+module HledgerForecast
+  # Checks for the existence of a transaction in a journal file and tracks it
+  class Tracker
+    def self.track(transactions, transaction_file)
+      next_month = Date.new(Date.today.year, Date.today.month, 1).next_month
+
+      transactions.each_with_object({}) do |(key, transaction), updated_transactions|
+        found = transaction_exists?(transaction_file, transaction['from'], Date.today, transaction['account'],
+                                    transaction['transaction'])
+        updated_transactions[key] = transaction.merge('from' => next_month, 'found' => found)
+      end
+    end
+
+    def self.latest_date(file)
+      command = %(hledger print --file #{file} | grep '^[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}' | awk '{print $1}' | sort -r | head -n 1)
+
+      date_output = `#{command}`
+      date_output.strip
+    end
+
+    def self.transaction_exists?(file, from, to, account, transaction)
+      category = escape_str(transaction['category'])
+      amount = transaction['amount']
+      inverse_amount = transaction['inverse_amount']
+
+      # We run two commands and check to see if category +/- amount or account +/- amount exists
+      command1 = %(hledger print -f #{file} "date:#{from}..#{to}" | tr -s '[:space:]' ' ' | grep -q -Eo "#{category} (#{amount}|#{inverse_amount})")
+      command2 = %(hledger print -f #{file} "date:#{from}..#{to}" | tr -s '[:space:]' ' ' | grep -q -Eo "#{account} (#{amount}|#{inverse_amount})")
+
+      system(command1) || system(command2)
+    end
+
+    def self.escape_str(str)
+      str.gsub('[', '\\[').gsub(']', '\\]').gsub('(', '\\(').gsub(')', '\\)')
+    end
+  end
+end

data/lib/hledger_forecast/version.rb

@@ -1,3 +1,3 @@
 module HledgerForecast
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/hledger_forecast.rb

@@ -14,5 +14,5 @@ Money.rounding_mode = BigDecimal::ROUND_HALF_UP
 require_relative 'hledger_forecast/version'
 require_relative 'hledger_forecast/generator'
 require_relative 'hledger_forecast/summarize'
-# require_relative 'hledger_forecast/checker'
+require_relative 'hledger_forecast/tracker'
 require_relative 'hledger_forecast/cli'

data/spec/command_spec.rb

@@ -1,15 +1,25 @@
 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
+      Assets:Bank
+
+  ~ monthly from 2023-03-01  * Savings
+      Assets:Bank          £-1,000.00;  Savings
+      Assets:Savings
+
+JOURNAL
+
 RSpec.describe 'command' do
   it 'uses the CLI to generate an output' do
     # Delete the file if it exists
     generated_journal = './test_output.journal'
     File.delete(generated_journal) if File.exist?(generated_journal)
 
-    system("./bin/hledger-forecast generate -t ./spec/stubs/transactions.journal -f ./spec/stubs/monthly/forecast_monthly.yml -o ./test_output.journal -s 2023-03-01 -e 2023-05-30 --force")
-
-    expected_output = File.read('spec/stubs/monthly/output_monthly.journal')
+    system("./bin/hledger-forecast generate -f ./spec/stubs/forecast.yml -o ./test_output.journal --force")
 
-    expect(File.read(generated_journal)).to eq(expected_output)
+    expect(File.read(generated_journal)).to eq(output)
   end
 end

data/spec/custom_spec.rb

@@ -1,47 +1,40 @@
 require_relative '../lib/hledger_forecast'
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct CUSTOM DAILY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/custom/forecast_custom_days.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01',
-                                                                          '2023-03-10')
-
-    expected_output = File.read('spec/stubs/custom/output_custom_days.journal')
-    expect(generated_journal).to eq(expected_output)
-  end
-
-  it 'generates a forecast with correct CUSTOM WEEKlY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/custom/forecast_custom_weeks.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01',
-                                                                          '2023-04-30')
-
-    expected_output = File.read('spec/stubs/custom/output_custom_weeks.journal')
-    expect(generated_journal).to eq(expected_output)
-  end
+config = <<~YAML
+  custom:
+    - frequency: "every 2 weeks"
+      from: "2023-05-01"
+      account: "[Assets:Bank]"
+      transactions:
+        - amount: 80
+          category: "[Expenses:Personal Care]"
+          description: Hair and beauty
+    - frequency: "every 5 days"
+      from: "2023-05-01"
+      account: "[Assets:Checking]"
+      transactions:
+        - amount: 50
+          category: "[Expenses:Groceries]"
+          description: Gotta feed that stomach
+
+  settings:
+    currency: GBP
+YAML
+
+output = <<~JOURNAL
+  ~ every 2 weeks from 2023-05-01  * Hair and beauty
+      [Expenses:Personal Care]    £80.00;  Hair and beauty
+      [Assets:Bank]
+
+  ~ every 5 days from 2023-05-01  * Gotta feed that stomach
+      [Expenses:Groceries]        £50.00;  Gotta feed that stomach
+      [Assets:Checking]
+
+JOURNAL
 
-  it 'generates a forecast with MULTIPLE correct CUSTOM WEEKlY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/custom/forecast_custom_weeks_twice.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01',
-                                                                          '2023-03-30')
-
-    expected_output = File.read('spec/stubs/custom/output_custom_weeks_twice.journal')
-    expect(generated_journal).to eq(expected_output)
-  end
-
-  it 'generates a forecast with correct CUSTOM MONTHLY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/custom/forecast_custom_months.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01',
-                                                                          '2024-02-28')
-
-    expected_output = File.read('spec/stubs/custom/output_custom_months.journal')
-    expect(generated_journal).to eq(expected_output)
+RSpec.describe 'generate' do
+  it 'generates a forecast with correct CUSTOM transactions' do
+    generated_journal = HledgerForecast::Generator.generate(config)
+    expect(generated_journal).to eq(output)
   end
 end

data/spec/half-yearly_spec.rb

@@ -1,13 +1,29 @@
 require_relative '../lib/hledger_forecast'
 
+config = <<~YAML
+  settings:
+    currency: GBP
+
+  half-yearly:
+    - from: "2023-04-01"
+      account: "Assets:Bank"
+      transactions:
+        - description: Holiday
+          category: "Expenses:Holiday"
+          amount: 500
+YAML
+
+output = <<~JOURNAL
+  ~ every 6 months from 2023-04-01  * Holiday
+      Expenses:Holiday    £500.00;  Holiday
+      Assets:Bank
+
+JOURNAL
+
 RSpec.describe 'generate' do
   it 'generates a forecast with correct HALF-YEARLY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/half-yearly/forecast_half-yearly.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2024-04-30')
+    generated_journal = HledgerForecast::Generator.generate(config)
 
-    expected_output = File.read('spec/stubs/half-yearly/output_half-yearly.journal')
-    expect(generated_journal).to eq(expected_output)
+    expect(generated_journal).to eq(output)
   end
 end

data/spec/modifier_spec.rb

@@ -0,0 +1,87 @@
+require_relative '../lib/hledger_forecast'
+
+base_config = <<~YAML
+  monthly:
+    - account: "Assets:Bank"
+      from: "2023-01-01"
+      transactions:
+        - amount: 500
+          category: "Expenses:Groceries"
+          description: Food shopping
+          modifiers:
+            - amount: 0.02
+              description: "Y1 inflation"
+              from: "2024-01-01"
+              to: "2024-12-31"
+            - amount: 0.05
+              description: "Y2 inflation"
+              from: "2025-01-01"
+              to: "2025-12-31"
+
+  settings:
+    currency: USD
+YAML
+
+base_journal = <<~JOURNAL
+  ~ monthly from 2023-01-01  * Food shopping
+      Expenses:Groceries    $500.00;  Food shopping
+      Assets:Bank
+
+  = Expenses:Groceries date:2024-01-01..2024-12-31
+      Expenses:Groceries    *0.02 ;  Food shopping - Y1 inflation
+      Assets:Bank           *-0.02
+
+  = Expenses:Groceries date:2025-01-01..2025-12-31
+      Expenses:Groceries    *0.05 ;  Food shopping - Y2 inflation
+      Assets:Bank           *-0.05
+
+JOURNAL
+
+no_date_config = <<~YAML
+  monthly:
+    - account: "Assets:Bank"
+      from: "2023-01-01"
+      transactions:
+        - amount: 500
+          category: "Expenses:Groceries"
+          description: Food shopping
+          modifiers:
+            - amount: 0.1
+              description: "Inflation"
+
+  settings:
+    currency: USD
+YAML
+
+no_date_journal = <<~JOURNAL
+  ~ monthly from 2023-01-01  * Food shopping
+      Expenses:Groceries    $500.00;  Food shopping
+      Assets:Bank
+
+  = Expenses:Groceries date:2023-01-01
+      Expenses:Groceries    *0.1  ;  Food shopping - Inflation
+      Assets:Bank           *-0.1
+
+JOURNAL
+
+RSpec.describe 'Applying modifiers to transactions -' do
+  it 'Auto-postings should be created correctly' do
+    generated = HledgerForecast::Generator
+    generated.modified = {} # Clear modified transactions
+
+    generated_journal = generated.generate(base_config)
+    generated.modified = {} # Clear modified transactions
+
+    expect(generated_journal).to eq(base_journal)
+  end
+
+  it 'Auto-postings should be created correctly if no dates are set' do
+    generated = HledgerForecast::Generator
+    generated.modified = {} # Clear modified transactions
+
+    generated_journal = generated.generate(no_date_config)
+    generated.modified = {} # Clear modified transactions
+
+    expect(generated_journal).to eq(no_date_journal)
+  end
+end

data/spec/monthly_end_date_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../lib/hledger_forecast'
+
+config = <<~YAML
+settings:
+  currency: GBP
+
+monthly:
+  - from: "2023-03-01"
+    account: "Assets:Bank"
+    transactions:
+      - description: Mortgage
+        to: "2023-06-01"
+        category: "Expenses:Mortgage"
+        amount: 2000.00
+      - description: Mortgage top up
+        to: "2023-06-01"
+        category: "Expenses:Mortgage Top Up"
+        amount: 200.00
+      - description: Food
+        category: "Expenses:Food"
+        amount: 100.00
+      - description: Party time
+        category: "Expenses:Going Out"
+        amount: 50.00
+YAML
+
+output = <<~JOURNAL
+~ monthly from 2023-03-01  * Food, Party time
+    Expenses:Food               £100.00  ;  Food
+    Expenses:Going Out          £50.00   ;  Party time
+    Assets:Bank
+
+~ monthly from 2023-03-01 to 2023-06-01  * Mortgage
+    Expenses:Mortgage           £2,000.00;  Mortgage
+    Assets:Bank
+
+~ monthly from 2023-03-01 to 2023-06-01  * Mortgage top up
+    Expenses:Mortgage Top Up    £200.00  ;  Mortgage top up
+    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)
+  end
+end

data/spec/monthly_end_date_transaction_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../lib/hledger_forecast'
+
+config = <<~YAML
+  settings:
+    currency: GBP
+
+  monthly:
+    - from: "2023-03-01"
+      to: "2023-06-01"
+      account: "Assets:Bank"
+      transactions:
+        - description: Mortgage
+          category: "Expenses:Mortgage"
+          amount: 2000.00
+        - description: Food
+          category: "Expenses:Food"
+          amount: 100.00
+YAML
+
+output = <<~JOURNAL
+  ~ monthly from 2023-03-01 to 2023-06-01  * Mortgage, Food
+      Expenses:Mortgage    £2,000.00;  Mortgage
+      Expenses:Food        £100.00  ;  Food
+      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)
+  end
+end

data/spec/monthly_spec.rb

@@ -1,33 +1,41 @@
 require_relative '../lib/hledger_forecast'
 
+config = <<~YAML
+  monthly:
+    - account: "Assets:Bank"
+      from: "2023-03-01"
+      transactions:
+        - amount: 2000.55
+          category: "Expenses:Mortgage"
+          description: Mortgage
+        - amount: 100
+          category: "Expenses:Food"
+          description: Food
+    - account: "Assets:Savings"
+      from: "2023-03-01"
+      transactions:
+        - amount: -1000
+          category: "Assets:Bank"
+          description: Savings
+
+  settings:
+    currency: GBP
+YAML
+
+output = <<~JOURNAL
+~ monthly from 2023-03-01  * Mortgage, Food
+    Expenses:Mortgage    £2,000.55;  Mortgage
+    Expenses:Food        £100.00  ;  Food
+    Assets:Bank
+
+~ monthly from 2023-03-01  * Savings
+    Assets:Bank          £-1,000.00;  Savings
+    Assets:Savings
+
+JOURNAL
+
 RSpec.describe 'generate' do
   it 'generates a forecast with correct MONTHLY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/monthly/forecast_monthly.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2023-05-30')
-
-    expected_output = File.read('spec/stubs/monthly/output_monthly.journal')
-    expect(generated_journal).to eq(expected_output)
-  end
-
-  it 'generates a forecast with correct MONTHLY transactions that have an end date' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/monthly/forecast_monthly_enddate.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2023-08-30')
-
-    expected_output = File.read('spec/stubs/monthly/output_monthly_enddate.journal')
-    expect(generated_journal).to eq(expected_output)
-  end
-
-  it 'generates a forecast with correct MONTHLY transactions that have an end date, at the top level' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/monthly/forecast_monthly_enddate_top.yml')
-
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2023-08-30')
-
-    expected_output = File.read('spec/stubs/monthly/output_monthly_enddate_top.journal')
-    expect(generated_journal).to eq(expected_output)
+    expect(HledgerForecast::Generator.generate(config)).to eq(output)
   end
 end

data/spec/once_spec.rb

@@ -1,13 +1,28 @@
 require_relative '../lib/hledger_forecast'
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct ONCE transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/once/forecast_once.yml')
+config = <<~YAML
+  settings:
+    currency: GBP
+
+  once:
+    - from: "2023-07-01"
+      account: "Assets:Bank"
+      transactions:
+        - description: New Kitchen
+          category: "Expense:House"
+          amount: 5,000.00
+YAML
 
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2024-04-30')
+output = <<~JOURNAL
+  ~ 2023-07-01  * New Kitchen
+      Expense:House    £5,000.00;  New Kitchen
+      Assets:Bank
 
-    expected_output = File.read('spec/stubs/once/output_once.journal')
-    expect(generated_journal).to eq(expected_output)
+JOURNAL
+
+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)
   end
 end

data/spec/quarterly_spec.rb

@@ -1,13 +1,27 @@
 require_relative '../lib/hledger_forecast'
 
-RSpec.describe 'generate' do
-  it 'generates a forecast with correct QUARTERLY transactions' do
-    transactions = File.read('spec/stubs/transactions.journal')
-    forecast = File.read('spec/stubs/quarterly/forecast_quarterly.yml')
+config = <<~YAML
+  settings:
+    currency: GBP
+
+  quarterly:
+    - from: "2023-04-01"
+      account: "Assets:Bank"
+      transactions:
+        - description: Bonus
+          category: "Income:Bonus"
+          amount: -1,000.00
+YAML
 
-    generated_journal = HledgerForecast::Generator.generate(transactions, forecast, '2023-03-01', '2023-10-30')
+output = <<~JOURNAL
+  ~ every 3 months from 2023-04-01  * Bonus
+      Income:Bonus    £-1,000.00;  Bonus
+      Assets:Bank
 
-    expected_output = File.read('spec/stubs/quarterly/output_quarterly.journal')
-    expect(generated_journal).to eq(expected_output)
+JOURNAL
+
+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/stubs/{monthly/forecast_monthly.yml → forecast.yml}

@@ -1,18 +1,18 @@
 monthly:
-  - account: "[Assets:Bank]"
-    start: "2023-03-01"
+  - account: "Assets:Bank"
+    from: "2023-03-01"
     transactions:
       - amount: 2000.55
-        category: "[Expenses:Mortgage]"
+        category: "Expenses:Mortgage"
         description: Mortgage
       - amount: 100
-        category: "[Expenses:Food]"
+        category: "Expenses:Food"
         description: Food
-  - account: "[Assets:Savings]"
-    start: "2023-03-01"
+  - account: "Assets:Savings"
+    from: "2023-03-01"
     transactions:
       - amount: -1000
-        category: "[Assets:Bank]"
+        category: "Assets:Bank"
         description: Savings
 
 settings:

data/spec/stubs/transactions_found.journal

@@ -0,0 +1,24 @@
+2023-04-01 * Opening balance
+    Assets:Bank                             £1,000.00
+    Equity:Opening balance
+
+2023-04-01 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+
+2023-05-01 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+
+2023-06-01 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+
+2023-03-05 * Tax owed
+    Expenses:Tax                £3,000.00
+    Assets:Bank
+
+2023-03-05 * Salary
+    Income:Salary             -£1,500.00
+    Assets:Bank
+

data/spec/stubs/transactions_found_inverse.journal

@@ -0,0 +1,24 @@
+2023-04-01 * Opening balance
+    Assets:Bank
+    Equity:Opening balance            £-1,000.00
+
+2023-04-01 * Mortgage payment
+    Expenses:Mortgage
+    Assets:Bank                       £-1,500.00
+
+2023-05-01 * Mortgage payment
+    Expenses:Mortgage
+    Assets:Bank                      £-1,500.00
+
+2023-06-01 * Mortgage payment
+    Expenses:Mortgage
+    Assets:Bank                      £-1,500.00
+
+2023-03-05 * Tax owed
+    Expenses:Tax
+    Assets:Bank                     £-3,000.00
+
+2023-03-05 * Salary
+    Income:Salary
+    Assets:Bank                     £1,500.00
+

data/spec/stubs/transactions_not_found.journal

@@ -0,0 +1,16 @@
+2023-04-01 * Opening balance
+    Assets:Bank                             £1,000.00
+    Equity:Opening balance
+
+2023-04-01 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+
+2023-05-01 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+
+2023-06-01 * Mortgage payment
+    Expenses:Mortgage                 £1,500.00
+    Assets:Bank
+