hledger-forecast 0.3.0 → 1.0.0

data/spec/monthly_end_date_spec.rb

@@ -1,47 +1,32 @@
 require_relative '../lib/hledger_forecast'
 
 config = <<~YAML
-settings:
-  currency: GBP
+  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
+  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  * 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
+  ~ 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' 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,32 +1,69 @@
 require_relative '../lib/hledger_forecast'
 
-config = <<~YAML
+base_config = <<~YAML
   settings:
     currency: GBP
 
   monthly:
     - from: "2023-03-01"
-      to: "2023-06-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 to 2023-06-01  * Mortgage, Food
+base_output = <<~JOURNAL
+  ~ monthly from 2023-03-01 to 2023-06-01  * Mortgage, Mortgage top up
+      Expenses:Mortgage           £2,000.00;  Mortgage
+      Expenses:Mortgage Top Up    £200.00  ;  Mortgage top up
+      Assets:Bank
+
+  ~ monthly from 2023-03-01  * Food, Party time
+      Expenses:Food               £100.00  ;  Food
+      Expenses:Going Out          £50.00   ;  Party time
+      Assets:Bank
+
+JOURNAL
+
+computed_config = <<~YAML
+  settings:
+    currency: GBP
+
+  monthly:
+    - from: "2023-03-01"
+      account: "Assets:Bank"
+      transactions:
+        - description: Mortgage
+          category: "Expenses:Mortgage"
+          to: "=12"
+          amount: 2000.00
+YAML
+
+computed_output = <<~JOURNAL
+  ~ monthly from 2023-03-01 to 2024-02-29  * Mortgage
       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)
+  it 'generates a forecast with correct MONTHLY transactions that have an end date' do
+    expect(HledgerForecast::Generator.generate(base_config)).to eq(base_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)
   end
 end

data/spec/track_spec.rb

@@ -42,70 +42,13 @@ base_output = <<~JOURNAL
 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)
+    generated_journal = HledgerForecast::Generator.generate(base_config, options)
 
-    expected_output = base_output
-    expect(generated_journal).to eq(expected_output)
+    expect(generated_journal).to eq(base_output)
   end
 
   it 'writes a NON-FOUND entry for dates that are close to the current period' do
@@ -147,12 +90,10 @@ RSpec.describe 'Tracking transactions -' do
     options = {}
     options[:transaction_file] = temp_file.path
 
-    generated = HledgerForecast::Generator
-    generated.tracked = {} # Clear tracked transactions
-
-    generated_journal = generated.generate(forecast_config, options)
+    generated_journal = HledgerForecast::Generator.generate(forecast_config, options)
 
     expected_output = <<~JOURNAL
+
       ~ #{next_month}  * [TRACKED] New kitchen
           Expenses:House    £5,000.00;  New kitchen
           Assets:Bank
@@ -180,10 +121,7 @@ RSpec.describe 'Tracking transactions -' do
     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)
+    generated_journal = HledgerForecast::Generator.generate(forecast_config, options)
 
     output = <<~JOURNAL
       ~ monthly from #{next_month}  * Food expenses

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Oli Morris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -99,12 +113,18 @@ files:
 - example.yml
 - hledger-forecast.gemspec
 - lib/hledger_forecast.rb
+- lib/hledger_forecast/calculator.rb
 - lib/hledger_forecast/cli.rb
+- lib/hledger_forecast/formatter.rb
 - lib/hledger_forecast/generator.rb
-- lib/hledger_forecast/summarize.rb
-- lib/hledger_forecast/tracker.rb
+- lib/hledger_forecast/settings.rb
+- lib/hledger_forecast/summarizer.rb
+- lib/hledger_forecast/transactions/default.rb
+- lib/hledger_forecast/transactions/modifiers.rb
+- lib/hledger_forecast/transactions/trackers.rb
 - lib/hledger_forecast/version.rb
 - spec/command_spec.rb
+- spec/computed_amounts_spec.rb
 - spec/custom_spec.rb
 - spec/half-yearly_spec.rb
 - spec/modifier_spec.rb
@@ -129,21 +149,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: An extended wrapper around hledger's forecasting functionality
 test_files:
 - spec/command_spec.rb
+- spec/computed_amounts_spec.rb
 - spec/custom_spec.rb
 - spec/half-yearly_spec.rb
 - spec/modifier_spec.rb

data/lib/hledger_forecast/tracker.rb

@@ -1,37 +0,0 @@
-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