hledger-forecast 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac4e0a16f2b440612fb4596519b02c02d4a88b0d5f9cdb95c0988047a9892c3e
-  data.tar.gz: 6f9aed952f65c445d965a9b3dd7ccdb25fdb2c300bdee748ffab51b6a5a5056e
+  metadata.gz: b5ba12a84909e9d92ac3a9b1b5d977b661131fe6673f8a1c6e73f9ec57d790e2
+  data.tar.gz: 8f7f23fde8f640912eacb23982e198d67bfe83671c43eba6357a1cdde9a87528
 SHA512:
-  metadata.gz: 40eb12f6238c4cc0f8fc37e85a74a6f4e88fbbd12917b07dfd2d305dd47f0cb09e1c999a343744d5766cb03c1484533e67ae6eb3e7ed6a7c3548f5f177eea55e
-  data.tar.gz: e09a771caf387bf62d9b09ca58ff59073589edeb0d9cbc3a9523246c31b7172b83869101fe6a020474d501a3b739dbe7a24ac6676a4baafb1380a5fe0c2a84b5
+  metadata.gz: 33c532dc9e25ff41c968a1ada59379dbc56a9a0587e2abc4f07acdd10387c88b6f834ec6025dccb44e5ab5f4b3446341e09b947275e540857884728e84b5392a
+  data.tar.gz: 918e5be4d90e1bd52a75436ce0ded33a72e49dd29e9d0a112067eddf2b86693a8ac6c21bd027ed2148d28819e5af432e594a063ca28fdcbe14bceeaee335d283

data/README.md

@@ -70,6 +70,7 @@ The available options are:
       -f, --forecast FILE              The path to the FORECAST CSV/YML file to generate from
       -o, --output-file FILE           The path to the OUTPUT file to create
       -t, --transaction FILE           The path to the TRANSACTION journal file
+      -v, --verbose                    Don't group transactions by type in the output file
           --force                      Force an overwrite of the output file
           --no-track                   Don't track any transactions
       -h, --help                       Show this help message
@@ -86,6 +87,8 @@ To work with hledger, include the forecast file and use the `--forecast` flag:
 
 The command will generate a forecast up to the end of Feb 2024, showing the balance for any asset accounts, overlaying some bank transactions with the forecast journal file. Forecasting in hledger can be complicated so be sure to refer to the [documentation](https://hledger.org/dev/hledger.html) or start a [discussion](https://github.com/olimorris/hledger-forecast/discussions/new?category=q-a).
 
+If you use the `hledger-ui` tool, it may be helpful to use the `--verbose` flag. This ensures that transactions are not grouped together in the forecast journal file, making descriptions much easier to read.
+
 ### Summarize command
 
 As your configuration file grows, it can be helpful to sum up the total amounts and output them to the CLI.

data/lib/hledger_forecast/cli.rb

@@ -91,6 +91,11 @@ module HledgerForecast
           options[:transaction_file] = file
         end
 
+        opts.on("-v", "--verbose",
+                "Don't group transactions by type in the output file") do
+          options[:verbose] = true
+        end
+
         opts.on("--force",
                 "Force an overwrite of the output file") do
           options[:force] = true

data/lib/hledger_forecast/transactions/default.rb

@@ -13,11 +13,7 @@ module HledgerForecast
       def generate
         data.each_value do |blocks|
           blocks.each do |block|
-            if block[:type] == "custom"
-              process_custom_block(block)
-            else
-              process_block(block)
-            end
+            process_block(block)
           end
         end
 
@@ -34,30 +30,59 @@ module HledgerForecast
         @output = []
       end
 
-      def process_custom_block(block)
+      def process_block(block)
         block[:transactions].each do |to, transactions|
           to = get_header(block[:to], to)
 
-          transactions.each do |t|
-            header = "~ #{t[:frequency]} from #{block[:from]}#{to}  * #{t[:description]}\n"
-            footer = "    #{block[:account]}\n\n"
-            output << { header: header, transactions: write_transactions([t]), footer: footer }
+          if block[:type] == "custom"
+            process_custom_transactions(block, to, transactions)
+          else
+            process_standard_transactions(block, to, transactions)
           end
         end
       end
 
-      def process_block(block)
-        block[:transactions].each do |to, transactions|
-          to = get_header(block[:to], to)
-          block[:descriptions] = get_descriptions(transactions)
+      def process_custom_transactions(block, to, transactions)
+        transactions.each do |t|
+          frequency = get_periodic_rules(block[:type], t[:frequency])
 
-          frequency = get_periodic_rules(block[:type], block[:frequency])
+          header = build_header(block, to, frequency, t[:description])
+          footer = build_footer(block)
+          output << build_transaction(header, [t], footer)
+        end
+      end
 
-          header = "#{frequency} #{block[:from]}#{to}  * #{block[:descriptions]}\n"
-          footer = "    #{block[:account]}\n\n"
+      def process_standard_transactions(block, to, transactions)
+        if @options[:verbose]
+          transactions.map do |t|
+            # Skip transactions that have been marked as tracked
+            next if t[:track]
 
-          output << { header: header, transactions: write_transactions(transactions), footer: footer }
+            frequency = get_periodic_rules(block[:type], block[:frequency])
+            header = build_header(block, to, frequency, t[:description])
+            footer = build_footer(block)
+            output << build_transaction(header, [t], footer)
+          end
+          return
         end
+
+        block[:descriptions] = get_descriptions(transactions)
+        frequency = get_periodic_rules(block[:type], block[:frequency])
+        header = build_header(block, to, frequency, block[:descriptions])
+        footer = build_footer(block)
+        output << build_transaction(header, transactions, footer)
+      end
+
+      def build_header(block, to, frequency, description)
+        "#{frequency} #{block[:from]}#{to}  * #{description}\n"
+      end
+
+      def build_footer(block)
+        "    #{block[:account]}\n\n"
+      end
+
+      def build_transaction(header, transactions, footer)
+        { header: header, transactions: write_transactions(transactions), footer: footer }
       end
 
       def get_header(block, transaction)

data/lib/hledger_forecast/version.rb

@@ -1,3 +1,3 @@
 module HledgerForecast
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/verbose_output_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../lib/hledger_forecast'
+
+output = <<~JOURNAL
+  ~ monthly from 2023-03-01  * Mortgage
+      Expenses:Mortgage    £2,000.55;  Mortgage
+      Assets:Bank
+
+  ~ monthly from 2023-03-01  * Food
+      Expenses:Food        £100.00  ;  Food
+      Assets:Bank
+
+  ~ monthly from 2023-03-01  * Savings
+      Assets:Bank          £-1,000.00;  Savings
+      Assets:Savings
+
+JOURNAL
+
+RSpec.describe 'verbose command' do
+  it 'does not group similar type transactions together in the output' do
+    generated_journal = './test_output.journal'
+    File.delete(generated_journal) if File.exist?(generated_journal)
+
+    system("./bin/hledger-forecast generate -f ./spec/stubs/forecast.csv -o ./test_output.journal --verbose --force")
+
+    expect(File.read(generated_journal)).to eq(output)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Oli Morris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -145,6 +145,7 @@ files:
 - spec/stubs/transactions_not_found.journal
 - spec/summarizer_spec.rb
 - spec/track_spec.rb
+- spec/verbose_output_spec.rb
 - spec/yearly_spec.rb
 homepage: https://github.com/olimorris/hledger-forecast
 licenses:
@@ -189,4 +190,5 @@ test_files:
 - spec/stubs/transactions_not_found.journal
 - spec/summarizer_spec.rb
 - spec/track_spec.rb
+- spec/verbose_output_spec.rb
 - spec/yearly_spec.rb