RubyGems - hledger-forecast - Versions diffs - 1.5.2 → 2.0.0 - Mend

hledger-forecast 1.5.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

checksums.yaml +4 -4
data/.rubocop.yml +17 -17
data/README.md +7 -171
data/example.journal +14 -14
data/hledger-forecast.gemspec +1 -1
data/lib/hledger_forecast/calculator.rb +5 -1
data/lib/hledger_forecast/cli.rb +5 -18
data/lib/hledger_forecast/generator.rb +52 -35
data/lib/hledger_forecast/settings.rb +42 -27
data/lib/hledger_forecast/summarizer.rb +28 -62
data/lib/hledger_forecast/summarizer_formatter.rb +4 -4
data/lib/hledger_forecast/transactions/default.rb +28 -57
data/lib/hledger_forecast/transactions/trackers.rb +34 -40
data/lib/hledger_forecast/utilities.rb +14 -0
data/lib/hledger_forecast/version.rb +1 -1
data/lib/hledger_forecast.rb +1 -2
data/spec/cli_spec.rb +3 -12
data/spec/computed_amounts_spec.rb +11 -22
data/spec/custom_spec.rb +15 -35
data/spec/half-yearly_spec.rb +6 -13
data/spec/monthly_end_date_spec.rb +8 -18
data/spec/monthly_end_date_transaction_spec.rb +20 -45
data/spec/monthly_spec.rb +11 -28
data/spec/once_spec.rb +6 -13
data/spec/quarterly_spec.rb +5 -12
data/spec/summarizer_spec.rb +11 -42
data/spec/track_spec.rb +19 -49
data/spec/verbose_output_spec.rb +3 -3
data/spec/yearly_spec.rb +5 -12
metadata +4 -13
data/example.yml +0 -98
data/lib/hledger_forecast/csv_parser.rb +0 -106
data/spec/csv_and_yml_comparison_spec.rb +0 -32
data/spec/csv_parser_spec.rb +0 -110
data/spec/modifier_spec.rb +0 -102
data/spec/stubs/forecast.yml +0 -19

data/spec/csv_and_yml_comparison_spec.rb DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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