hledger-forecast 1.5.1 → 2.0.0

data/spec/custom_spec.rb

@@ -1,52 +1,32 @@
 require_relative '../lib/hledger_forecast'
 
-base_config = <<~YAML
-  custom:
-    - account: "[Assets:Bank]"
-      from: "2023-05-01"
-      transactions:
-        - amount: 80
-          category: "[Expenses:Personal Care]"
-          description: Hair and beauty
-          frequency: "every 2 weeks"
-        - amount: 50
-          category: "[Expenses:Groceries]"
-          description: Gotta feed that stomach
-          frequency: "every 5 days"
-
-  settings:
-    currency: GBP
-YAML
+base_config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  custom,every 2 weeks,[Assets:Bank],01/05/2023,,Hair and beauty,[Expenses:Personal Care],80,,,
+  custom,every 5 days,[Assets:Bank],01/05/2023,,Food,[Expenses:Groceries],50,,,
+  settings,currency,GBP,,,,,,,,
+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 ;  Hair and beauty
       [Assets:Bank]
 
-  ~ every 5 days from 2023-05-01  * Gotta feed that stomach
-      [Expenses:Groceries]        £50.00;  Gotta feed that stomach
+  ~ every 5 days from 2023-05-01  * Food
+      [Expenses:Groceries]        £50.00 ;  Food
       [Assets:Bank]
 
 JOURNAL
 
-calculated_config = <<~YAML
-  custom:
-    - account: "[Assets:Bank]"
-      from: "2023-05-01"
-      transactions:
-        - amount: 80
-          category: "[Expenses:Personal Care]"
-          description: Hair and beauty
-          frequency: "every 2 weeks"
-          to: "=6"
-
-  settings:
-    currency: GBP
-YAML
+calculated_config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  custom,every 2 weeks,[Assets:Bank],01/05/2023,=6,Hair and beauty,[Expenses:Personal Care],80,,,
+  settings,currency,GBP,,,,,,,,
+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 ;  Hair and beauty
       [Assets:Bank]
 
 JOURNAL

data/spec/half-yearly_spec.rb

@@ -1,21 +1,14 @@
 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
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  half-yearly,,Assets:Bank,01/04/2023,,Holiday,Expenses:Holiday,500,,,
+  settings,currency,GBP,,,,,,,,
+CSV
 
 output = <<~JOURNAL
   ~ every 6 months from 2023-04-01  * Holiday
-      Expenses:Holiday    £500.00;  Holiday
+      Expenses:Holiday    £500.00 ;  Holiday
       Assets:Bank
 
 JOURNAL

data/spec/monthly_end_date_spec.rb

@@ -1,26 +1,16 @@
 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
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  monthly,,Assets:Bank,01/03/2023,01/06/2023,Mortgage,Expenses:Mortgage,2000.00,,,
+  monthly,,Assets:Bank,01/03/2023,01/06/2023,Food,Expenses:Food,100.00,,,
+  settings,currency,GBP,,,,,,,,
+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   ;  Mortgage
+      Expenses:Food        £100.00     ;  Food
       Assets:Bank
 
 JOURNAL

data/spec/monthly_end_date_transaction_spec.rb

@@ -1,66 +1,41 @@
 require_relative '../lib/hledger_forecast'
 
-base_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
-
-base_output = <<~JOURNAL
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  monthly,,Assets:Bank,01/03/2023,01/06/2023,Mortgage,Expenses:Mortgage,2000.00,,,
+  monthly,,Assets:Bank,01/03/2023,01/06/2023,Mortgage top up,Expenses:Mortgage,200.00,,,
+  monthly,,Assets:Bank,01/03/2023,,Food,Expenses:Food,100.00,,,
+  settings,currency,GBP,,,,,,,,
+CSV
+
+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
+      Expenses:Mortgage    £2,000.00   ;  Mortgage
+      Expenses:Mortgage    £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
+  ~ monthly from 2023-03-01  * Food
+      Expenses:Food        £100.00     ;  Food
       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_config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  monthly,,Assets:Bank,01/03/2023,=12,Mortgage,Expenses:Mortgage,2000.00,,,
+  settings,currency,GBP,,,,,,,,
+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   ;  Mortgage
       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(base_config)).to eq(base_output)
+    expect(HledgerForecast::Generator.generate(config)).to eq(output)
   end
 
   it 'generates a forecast with correct MONTHLY transactions that have a COMPUTED end date' do

data/spec/monthly_spec.rb

@@ -1,37 +1,20 @@
 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
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  monthly,,Assets:Bank,01/03/2023,,Bills,Expenses:Bills,175,,,
+  monthly,,Assets:Bank,01/03/2023,,Food,Expenses:Food,500,,,
+  monthly,,Assets:Bank,01/03/2023,,Savings,Assets:Savings,-1000,,,
+  settings,currency,GBP,,,,,,,,
+CSV
 
 output = <<~JOURNAL
-  ~ monthly from 2023-03-01  * Mortgage, Food
-      Expenses:Mortgage    £2,000.55;  Mortgage
-      Expenses:Food        £100.00  ;  Food
+  ~ monthly from 2023-03-01  * Bills, Food, Savings
+      Expenses:Bills    £175.00   ;  Bills
+      Expenses:Food     £500.00   ;  Food
+      Assets:Savings    £-1,000.00;  Savings
       Assets:Bank
 
-  ~ monthly from 2023-03-01  * Savings
-      Assets:Bank          £-1,000.00;  Savings
-      Assets:Savings
-
 JOURNAL
 
 RSpec.describe 'generate' do

data/spec/once_spec.rb

@@ -1,21 +1,14 @@
 require_relative '../lib/hledger_forecast'
 
-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
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  once,,Assets:Bank,01/07/2023,,New Kitchen,Expenses:House,5000,,,
+  settings,currency,GBP,,,,,,,,
+CSV
 
 output = <<~JOURNAL
   ~ 2023-07-01  * New Kitchen
-      Expense:House    £5,000.00;  New Kitchen
+      Expenses:House    £5,000.00;  New Kitchen
       Assets:Bank
 
 JOURNAL

data/spec/quarterly_spec.rb

@@ -1,17 +1,10 @@
 require_relative '../lib/hledger_forecast'
 
-config = <<~YAML
-  settings:
-    currency: GBP
-
-  quarterly:
-    - from: "2023-04-01"
-      account: "Assets:Bank"
-      transactions:
-        - description: Bonus
-          category: "Income:Bonus"
-          amount: -1,000.00
-YAML
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  quarterly,,Assets:Bank,01/04/2023,,Bonus,Income:Bonus,-1000,,,
+  settings,currency,GBP,,,,,,,,
+CSV
 
 output = <<~JOURNAL
   ~ every 3 months from 2023-04-01  * Bonus

data/spec/summarizer_spec.rb

@@ -1,51 +1,20 @@
 require_relative '../lib/hledger_forecast'
 
-config = <<~YAML
-  monthly:
-    - account: "Assets:Bank"
-      from: "2023-03-01"
-      transactions:
-        - amount: 2000.55
-          category: "Expenses:Mortgage"
-          description: Mortgage
-          to: "=24"
-        - amount: 100
-          category: "Expenses:Food"
-          description: Food
-    - account: "Assets:Savings"
-      from: "2023-03-01"
-      transactions:
-        - amount: -1000
-          category: "Assets:Bank"
-          description: Savings
-
-  custom:
-    - account: "[Assets:Bank]"
-      from: "2023-05-01"
-      transactions:
-        - amount: 80
-          category: "[Expenses:Personal Care]"
-          description: Hair and beauty
-          frequency: "every 2 weeks"
-          roll-up: 26
-    - account: "[Assets:Checking]"
-      from: "2023-05-01"
-      transactions:
-        - amount: 50
-          category: "[Expenses:Groceries]"
-          description: Gotta feed that stomach
-          frequency: "every 5 days"
-          roll-up: 73
-
-  settings:
-    currency: GBP
-YAML
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  monthly,,Assets:Bank,01/03/2023,=24,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,,,
+  custom,every 2 weeks,[Assets:Bank],01/05/2023,,Hair and beauty,[Expenses:Personal Care],80,26,,
+  custom,every 2 weeks,[Assets:Checking],01/05/2023,,Extra Food,[Expenses:Groceries],50,73,,
+  settings,currency,GBP,,,,,,,,
+CSV
 
 RSpec.describe HledgerForecast::Summarizer do
   let(:summarizer) { described_class.new }
 
   describe '#generate with roll_up' do
-    let(:forecast) { YAML.safe_load(config) }
+    let(:forecast) { CSV.parse(config, headers: true) }
     let(:cli_options) { { roll_up: 'monthly' } }
 
     before do
@@ -69,7 +38,7 @@ RSpec.describe HledgerForecast::Summarizer do
   end
 
   describe '#generate' do
-    let(:forecast) { YAML.safe_load(config) }
+    let(:forecast) { CSV.parse(config, headers: true) }
     let(:cli_options) { nil }
 
     before do

data/spec/track_spec.rb

@@ -4,31 +4,17 @@ 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_config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  once,,Assets:Bank,05/03/2023,,Tax owed,Expenses:Tax,3000,,,true
+  once,,Assets:Bank,05/03/2023,,Food expenses,Expenses:Food,100,,,
+  once,,Assets:Bank,05/03/2023,01/08/2023,Salary,Income:Salary,-1500,,,true
+  settings,currency,GBP,,,,,,,,
+CSV
 
 base_output = <<~JOURNAL
   ~ 2023-03-05  * Food expenses
-      Expenses:Food    £100.00 ;  Food expenses
+      Expenses:Food    £100.00   ;  Food expenses
       Assets:Bank
 
   ~ #{next_month}  * [TRACKED] Tax owed
@@ -54,19 +40,11 @@ RSpec.describe 'Tracking transactions -' do
   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
+    forecast_config = <<~CSV
+      type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+      once,,Assets:Bank,"#{previous_month}",,New kitchen,Expenses:House,5000,,,true
+      settings,currency,GBP,,,,,,,,
+    CSV
 
     journal = <<~JOURNAL
       #{previous_month} * Opening balance
@@ -104,19 +82,11 @@ RSpec.describe 'Tracking transactions -' do
   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
+    forecast_config = <<~CSV
+      type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+      monthly,,Assets:Bank,"#{next_month}",,Food expenses,Expenses:Food,100,,,true
+      settings,currency,GBP,,,,,,,,
+    CSV
 
     options = {}
     options[:transaction_file] = 'spec/stubs/transactions_not_found.journal'
@@ -125,7 +95,7 @@ RSpec.describe 'Tracking transactions -' do
 
     output = <<~JOURNAL
       ~ monthly from #{next_month}  * Food expenses
-          Expenses:Food    £100.00;  Food expenses
+          Expenses:Food    £100.00 ;  Food expenses
           Assets:Bank
 
     JOURNAL

data/spec/verbose_output_spec.rb

@@ -2,15 +2,15 @@ require_relative '../lib/hledger_forecast'
 
 output = <<~JOURNAL
   ~ monthly from 2023-03-01  * Mortgage
-      Expenses:Mortgage    £2,000.55;  Mortgage
+      Expenses:Mortgage    £2,000.55   ;  Mortgage
       Assets:Bank
 
   ~ monthly from 2023-03-01  * Food
-      Expenses:Food        £100.00  ;  Food
+      Expenses:Food        £100.00     ;  Food
       Assets:Bank
 
   ~ monthly from 2023-03-01  * Savings
-      Assets:Bank          £-1,000.00;  Savings
+      Assets:Bank          £-1,000.00  ;  Savings
       Assets:Savings
 
 JOURNAL

data/spec/yearly_spec.rb

@@ -1,17 +1,10 @@
 require_relative '../lib/hledger_forecast'
 
-config = <<~YAML
-  settings:
-    currency: GBP
-
-  yearly:
-    - account: "Assets:Bank"
-      from: "2023-04-01"
-      transactions:
-        - description: Bonus
-          category: "Income:Bonus"
-          amount: -3,000.00
-YAML
+config = <<~CSV
+  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
+  yearly,,Assets:Bank,01/04/2023,,Bonus,Income:Bonus,-3000,,,
+  settings,currency,GBP,,,,,,,,
+CSV
 
 output = <<~JOURNAL
   ~ yearly from 2023-04-01  * Bonus

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Oli Morris
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2024-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -94,14 +94,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
-description: Use a CSV or YAML file for improved forecasting with hledger
+description: Use a CSV file for improved forecasting with hledger
 email: olimorris@users.noreply.github.com
 executables:
 - hledger-forecast
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -110,13 +111,11 @@ files:
 - bin/hledger-forecast
 - example.csv
 - example.journal
-- example.yml
 - hledger-forecast.gemspec
 - lib/hledger_forecast.rb
 - lib/hledger_forecast/calculator.rb
 - lib/hledger_forecast/cli.rb
 - lib/hledger_forecast/comparator.rb
-- lib/hledger_forecast/csv_parser.rb
 - lib/hledger_forecast/formatter.rb
 - lib/hledger_forecast/generator.rb
 - lib/hledger_forecast/settings.rb
@@ -125,22 +124,19 @@ files:
 - lib/hledger_forecast/transactions/default.rb
 - lib/hledger_forecast/transactions/modifiers.rb
 - lib/hledger_forecast/transactions/trackers.rb
+- lib/hledger_forecast/utilities.rb
 - lib/hledger_forecast/version.rb
 - spec/cli_spec.rb
 - spec/compare_spec.rb
 - spec/computed_amounts_spec.rb
-- spec/csv_and_yml_comparison_spec.rb
-- spec/csv_parser_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/stubs/forecast.csv
-- spec/stubs/forecast.yml
 - spec/stubs/output1.csv
 - spec/stubs/output2.csv
 - spec/stubs/transactions_found.journal
@@ -154,7 +150,7 @@ homepage: https://github.com/olimorris/hledger-forecast
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -169,26 +165,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: An extended wrapper around hledger's forecasting functionality
 test_files:
 - spec/cli_spec.rb
 - spec/compare_spec.rb
 - spec/computed_amounts_spec.rb
-- spec/csv_and_yml_comparison_spec.rb
-- spec/csv_parser_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/stubs/forecast.csv
-- spec/stubs/forecast.yml
 - spec/stubs/output1.csv
 - spec/stubs/output2.csv
 - spec/stubs/transactions_found.journal