hledger-forecast 1.5.1 → 2.0.0

data/example.yml

@@ -1,98 +0,0 @@
-monthly:
-  - account: "Assets:Bank"
-    from: "2023-03-01"
-    transactions:
-      - amount: -3500
-        category: "Income:Salary"
-        description: Salary
-      - amount: 2000
-        category: "Expenses:Mortgage"
-        description: Mortgage
-        to: "2025-01-01"
-      - amount: 175
-        category: "Expenses:Bills"
-        description: Bills
-      - amount: 500
-        category: "Expenses:Food"
-        description: Food
-        modifiers:
-          - amount: 0.02
-            description: "Inflation"
-            from: "2024-01-01"
-            to: "2024-12-31"
-          - amount: 0.05
-            description: "Inflation"
-            from: "2025-01-01"
-            to: "2025-12-31"
-      - amount: "=5000/24"
-        category: "Expenses:House"
-        description: New Kitchen
-      - amount: 125
-        category: "Expenses:Holiday"
-        description: Holiday
-        to: "=12"
-  - account: "Assets:Bank"
-    from: "2023-03-01"
-    to: "2025-01-01"
-    transactions:
-      - amount: 300
-        category: "Assets:Savings"
-        description: "Rainy day fund"
-  - account: "Assets:Pension"
-    from: "2024-01-01"
-    transactions:
-      - amount: -500
-        category: "Income:Pension"
-        description: Pension draw down
-
-quarterly:
-  - account: "Assets:Bank"
-    from: "2023-04-01"
-    transactions:
-      - amount: -1000.00
-        category: "Income:Bonus"
-        description: Quarterly bonus
-
-half-yearly:
-  - account: "Assets:Bank"
-    from: "2023-04-01"
-    transactions:
-      - amount: 500
-        category: "Expenses:Holiday"
-        description: Top up holiday funds
-
-yearly:
-  - account: "Assets:Bank"
-    from: "2023-04-01"
-    transactions:
-      - amount: -2000.00
-        category: "Income:Bonus"
-        description: Annual Bonus
-
-once:
-  - account: "Assets:Bank"
-    from: "2023-03-05"
-    transactions:
-      - amount: -3000
-        category: "Expenses:Shopping"
-        description: Refund for that damn laptop
-        summary_exclude: true
-        track: true
-
-custom:
-  - account: "Assets:Bank"
-    from: "2023-03-01"
-    transactions:
-      - amount: 80
-        category: "Expenses:Personal Care"
-        description: Hair and beauty
-        frequency: "every 2 weeks"
-        roll-up: 26
-      - amount: 30
-        category: "Expenses:General Expenses"
-        description: Misc expenses
-        frequency: "every 5 weeks"
-        roll-up: 10.4
-
-settings:
-  currency: USD

data/lib/hledger_forecast/csv_parser.rb

@@ -1,106 +0,0 @@
-module HledgerForecast
-  # Formats various items used throughout the application
-  class CSVParser
-    def self.parse(csv_data, cli_options = nil)
-      new.parse(csv_data, cli_options)
-    end
-
-    def parse(csv_data, _cli_options)
-      csv_data = CSV.parse(csv_data, headers: true)
-      yaml_data = {}
-      group_by_type(csv_data, yaml_data)
-      yaml_data.to_yaml
-    end
-
-    private
-
-    def group_by_type(csv_data, yaml_data)
-      csv_data.group_by { |row| row['type'] }.each do |type, rows|
-        if type == 'settings'
-          handle_settings(rows, yaml_data)
-        else
-          yaml_data[type] ||= []
-          group_by_account_and_from(rows, yaml_data[type], type)
-        end
-      end
-    end
-
-    def handle_settings(rows, yaml_data)
-      yaml_data['settings'] ||= {}
-      rows.each do |row|
-        yaml_data['settings'][row['frequency']] = cast_to_proper_type(row['account'])
-      end
-    end
-
-    def group_by_account_and_from(rows, yaml_rows, type)
-      rows.group_by { |row| [row['account'], row['from']] }.each do |(account, from), transactions|
-        yaml_rows << if type == 'custom'
-                       build_custom_transaction(account, from, transactions)
-                     else
-                       build_transaction(account, from, transactions)
-                     end
-      end
-    end
-
-    def build_transaction(account, from, transactions)
-      transaction = {
-        'account' => account,
-        'from' => Date.parse(from).strftime('%Y-%m-%d'),
-        'transactions' => []
-      }
-
-      transactions.each do |row|
-        transaction['transactions'] << build_transaction_data(row)
-      end
-
-      transaction
-    end
-
-    def build_custom_transaction(account, from, transactions)
-      transaction = {
-        'account' => account,
-        'from' => Date.parse(from).strftime('%Y-%m-%d'),
-        'transactions' => []
-      }
-
-      transactions.each do |row|
-        transaction_data = build_transaction_data(row)
-        transaction_data['frequency'] = row['frequency']
-        transaction_data['roll-up'] = row['roll-up'].to_f if row['roll-up']
-        transaction['transactions'] << transaction_data
-      end
-
-      transaction
-    end
-
-    def build_transaction_data(row)
-      transaction_data = {
-        'amount' => row['amount'].start_with?("=") ? row['amount'].to_s : row['amount'].to_f,
-        'category' => row['category'],
-        'description' => row['description']
-      }
-
-      if row['to']
-        transaction_data['to'] = if row['to'].start_with?("=")
-                                   row['to']
-                                 else
-                                   Date.parse(row['to']).strftime('%Y-%m-%d')
-                                 end
-      end
-
-      transaction_data['summary_exclude'] = true if row['summary_exclude'] && row['summary_exclude'].downcase == "true"
-      transaction_data['track'] = true if row['track'] && row['track'].downcase == "true"
-
-      transaction_data
-    end
-
-    def cast_to_proper_type(str)
-      case str.downcase
-      when 'true', 'false'
-        str.downcase == 'true'
-      else
-        str
-      end
-    end
-  end
-end

data/spec/csv_and_yml_comparison_spec.rb

@@ -1,32 +0,0 @@
-require_relative '../lib/hledger_forecast'
-
-RSpec.describe 'CSV and yml outputs' do
-  it 'should return the same value when ran through hledger' do
-    generated_journal = './test_output.journal'
-    File.delete(generated_journal) if File.exist?(generated_journal)
-
-    system("./bin/hledger-forecast generate -f example.csv -o ./test_output.journal -t ./spec/stubs/transactions_not_found.journal --force")
-    csv_output = `hledger -f ./test_output.journal --forecast bal -b=2023-01 -e=2023-06`
-
-    system("./bin/hledger-forecast generate -f example.yml -o ./test_output.journal -t ./spec/stubs/transactions_not_found.journal --force")
-    yml_output = `hledger -f ./test_output.journal --forecast bal -b=2023-01 -e=2023-06`
-
-    expect(csv_output).to eq(yml_output)
-  end
-
-  # it 'check that it can fail!' do
-  #   generated_journal = './test_output.journal'
-  #   File.delete(generated_journal) if File.exist?(generated_journal)
-  #
-  #   system("./bin/hledger-forecast generate -f ./spec/stubs/csv_and_yml/forecast.csv -o ./test_output.journal --force > /dev/null 2>&1")
-  #
-  #   ### CHANGE DATE!!!!!!!!!!!!!!!!
-  #   csv_output = `hledger -f ./test_output.journal --forecast bal -b=2023-01 -e=2023-03`
-  #   ### CHANGE DATE!!!!!!!!!!!!!!!!
-  #
-  #   system("./bin/hledger-forecast generate -f ./spec/stubs/csv_and_yml/forecast.yml -o ./test_output.journal --force > /dev/null 2>&1")
-  #   yml_output = `hledger -f ./test_output.journal --forecast bal -b=2023-01 -e=2023-06`
-  #
-  #   expect(csv_output).not_to eq(yml_output)
-  # end
-end

data/spec/csv_parser_spec.rb

@@ -1,110 +0,0 @@
-require_relative '../lib/hledger_forecast'
-
-input = <<~CSV
-  type,frequency,account,from,to,description,category,amount,roll-up,summary_exclude,track
-  monthly,,Assets:Bank,01/03/2023,,Salary,Income:Salary,-3500,,,
-  monthly,,Assets:Bank,01/03/2023,01/01/2025,Mortgage,Expenses:Mortgage,2000,,,
-  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,,New Kitchen,Expenses:House,=5000/24,,,
-  monthly,,Assets:Bank,01/03/2023,=12,Holiday,Expenses:Holiday,125,,,
-  monthly,,Assets:Bank,01/03/2023,01/01/2025,Rainy day fund,Assets:Savings,300,,,
-  monthly,,Assets:Pension,01/01/2024,,Pension draw down,Income:Pension,-500,,,
-  quarterly,,Assets:Bank,01/04/2023,,Quarterly bonus,Income:Bonus,-1000,,,
-  half-yearly,,Assets:Bank,01/04/2023,,Top up holiday funds,Expenses:Holiday,500,,,
-  yearly,,Assets:Bank,01/04/2023,,Annual bonus,Income:Bonus,-2000,,,
-  once,,Assets:Bank,05/03/2023,,Refund for that damn laptop,Expenses:Shopping,-3000,,TRUE,TRUE
-  custom,every 2 weeks,Assets:Bank,01/03/2023,,Hair and beauty,Expenses:Personal Care,80,26,,
-  settings,currency,USD,,,,,,,,
-  settings,show_symbol,TRUE,,,,,,,,
-  settings,thousands_separator,TRUE,,,,,,,,
-CSV
-
-output = <<~YAML
-  ---
-  monthly:
-  - account: Assets:Bank
-    from: '2023-03-01'
-    transactions:
-    - amount: -3500.0
-      category: Income:Salary
-      description: Salary
-    - amount: 2000.0
-      category: Expenses:Mortgage
-      description: Mortgage
-      to: '2025-01-01'
-    - amount: 175.0
-      category: Expenses:Bills
-      description: Bills
-    - amount: 500.0
-      category: Expenses:Food
-      description: Food
-    - amount: "=5000/24"
-      category: Expenses:House
-      description: New Kitchen
-    - amount: 125.0
-      category: Expenses:Holiday
-      description: Holiday
-      to: "=12"
-    - amount: 300.0
-      category: Assets:Savings
-      description: Rainy day fund
-      to: '2025-01-01'
-  - account: Assets:Pension
-    from: '2024-01-01'
-    transactions:
-    - amount: -500.0
-      category: Income:Pension
-      description: Pension draw down
-  quarterly:
-  - account: Assets:Bank
-    from: '2023-04-01'
-    transactions:
-    - amount: -1000.0
-      category: Income:Bonus
-      description: Quarterly bonus
-  half-yearly:
-  - account: Assets:Bank
-    from: '2023-04-01'
-    transactions:
-    - amount: 500.0
-      category: Expenses:Holiday
-      description: Top up holiday funds
-  yearly:
-  - account: Assets:Bank
-    from: '2023-04-01'
-    transactions:
-    - amount: -2000.0
-      category: Income:Bonus
-      description: Annual bonus
-  once:
-  - account: Assets:Bank
-    from: '2023-03-05'
-    transactions:
-    - amount: -3000.0
-      category: Expenses:Shopping
-      description: Refund for that damn laptop
-      summary_exclude: true
-      track: true
-  custom:
-  - account: Assets:Bank
-    from: '2023-03-01'
-    transactions:
-    - amount: 80.0
-      category: Expenses:Personal Care
-      description: Hair and beauty
-      frequency: every 2 weeks
-      roll-up: 26.0
-  settings:
-    currency: USD
-    show_symbol: true
-    thousands_separator: true
-YAML
-
-RSpec.describe 'CSV parser' do
-  it 'converts a CSV file to the YML output needed for the plugin' do
-    computed_yaml = HledgerForecast::CSVParser.parse(input)
-
-    expect(computed_yaml).to eq(output)
-  end
-end

data/spec/modifier_spec.rb

@@ -1,102 +0,0 @@
-require_relative '../lib/hledger_forecast'
-
-base_config = <<~YAML
-  monthly:
-    - account: "Assets:Bank"
-      from: "2023-01-01"
-      transactions:
-        - amount: 300
-          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"
-    - account: "Assets:Savings"
-      from: "2023-05-01"
-      transactions:
-        - amount: 500
-          category: "Assets:Bank"
-          description: Savings
-          modifiers:
-            - amount: 0.1
-              description: "Savings uplift"
-              from: "2024-05-01"
-              to: "2025-04-30"
-
-  settings:
-    currency: USD
-YAML
-
-base_journal = <<~JOURNAL
-  ~ monthly from 2023-01-01  * Food shopping
-      Expenses:Groceries    $300.00;  Food shopping
-      Assets:Bank
-
-  ~ monthly from 2023-05-01  * Savings
-      Assets:Bank           $500.00;  Savings
-      Assets:Savings
-
-  = 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
-
-  = Assets:Bank date:2024-05-01..2025-04-30
-      Assets:Bank           *0.1  ;  Savings - Savings uplift
-      Assets:Savings        *-0.1
-
-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_journal = generated.generate(base_config)
-
-    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_journal = generated.generate(no_date_config)
-
-    expect(generated_journal).to eq(no_date_journal)
-  end
-end

data/spec/stubs/forecast.yml

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