hledger-forecast 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37dbc9f011b6a43fa1d186e92dfb77c3c184cdb4a7cc5ef690a77d53c57f4722
-  data.tar.gz: e71185f0ad678b45f1ffa155c89c491bd37d36307d845dd023b823db6ced42d4
+  metadata.gz: 410b448de275184312f25f5f5cc008fbaf945c27c40827c9f203fd3c14422729
+  data.tar.gz: d9c9f019852246dee148758231bd8619f10e8246459dd2b719ede97f31ee8e05
 SHA512:
-  metadata.gz: d25713fb91fde68daaa07f6809a3c567afc18864a759e47fd032c31cd78cbe195eba2919deff4547d2fe6888e032f7394af4012aea839d1fc6b3d4ee7b1e94bf
-  data.tar.gz: 363185c38d788ae91528dc1fde6e21201fc19bec673848202a43589c36c8be3f6fe8e54cb367bfb8652ea286eda6513ab38e86e20aef99f8b7011cb1351fed3b
+  metadata.gz: 7700e2fc1778ad1e0548cd53ce3648b38ec2f56ce493204b5bb1efedff0d6621c3563ec09494ed2362f926aa3fe22c10f06394f551b5907cb8c9106c2642e3a1
+  data.tar.gz: fba3f08d0c906fddaab46c31a236602b2843a0c6a5f56723cac9fdc89453e46b6871f129d0e8a684d369883f4dfa8a81cfde64e5997cf8ee4485e90e345ad772

data/.gitignore

@@ -18,3 +18,4 @@ pkg/*
 # Misc
 test_output.journal
 todo.md
+.vscode

data/README.md

@@ -92,6 +92,7 @@ The available options are:
     -f, --forecast FILE              The path to the FORECAST yaml file to summarize
     -r, --roll-up PERIOD             The period to roll-up your forecasts into. One of:
                                      [yearly], [half-yearly], [quarterly], [monthly], [weekly], [daily]
+    -v, --verbose                    Show additional information in the summary
     -h, --help                       Show this help message
 
 ## :gear: Configuration
@@ -346,11 +347,11 @@ settings:
 
 **Yaml config file and output**
 
-<img src="https://user-images.githubusercontent.com/9512444/234382872-b81ac84d-2bcc-4488-a041-364f72627087.png" alt="Hledger-Forecast" />
+<img src="https://github.com/olimorris/hledger-forecast/assets/9512444/c3c3222e-f797-4643-bebd-9c94134bee92" alt="Hledger-Forecast" />
 
 **Summarize command**
 
-<img src="https://user-images.githubusercontent.com/9512444/234386807-1301c8d9-af77-4f58-a3c3-a345b5e890a2.png" alt="Summarize command" />
+<img src="https://github.com/olimorris/hledger-forecast/assets/9512444/f5017ea2-9606-46ec-8b38-8840dc175e7b" alt="Summarize command" />
 
 ## :paintbrush: Rationale
 

data/lib/hledger_forecast/cli.rb

@@ -124,22 +124,27 @@ module HledgerForecast
           options[:roll_up] = rollup
         end
 
-        opts.on("--from DATE",
-                "Include transactions that start FROM a given DATE [yyyy-mm-dd]") do |from|
-          options[:from] = from
+        opts.on("-v", "--verbose",
+                "Show additional information in the summary") do |_|
+          options[:verbose] = true
         end
 
-        opts.on("--to DATE",
-                "Include transactions that run TO a given DATE [yyyy-mm-dd]") do |to|
-          options[:to] = to
-        end
-
-        opts.on("-s", "--scenario \"NAMES\"",
-                "Include transactions from given scenarios, e.g.:",
-                "\"base, rennovation, car purchase\"") do |_scenario|
-          # Loop through scenarios, seperated by a comma
-          options[:scenario] = {}
-        end
+        # opts.on("--from DATE",
+        #         "Include transactions that start FROM a given DATE [yyyy-mm-dd]") do |from|
+        #   options[:from] = from
+        # end
+        #
+        # opts.on("--to DATE",
+        #         "Include transactions that run TO a given DATE [yyyy-mm-dd]") do |to|
+        #   options[:to] = to
+        # end
+
+        # opts.on("-s", "--scenario \"NAMES\"",
+        #         "Include transactions from given scenarios, e.g.:",
+        #         "\"base, rennovation, car purchase\"") do |_scenario|
+        #   # Loop through scenarios, seperated by a comma
+        #   options[:scenario] = {}
+        # end
 
         opts.on_tail("-h", "--help", "Show this help message") do
           puts opts

data/lib/hledger_forecast/summarizer_formatter.rb

@@ -42,8 +42,15 @@ module HledgerForecast
         total = 0
         items.each do |item|
           total += item[:amount]
-          @table.add_row [{ value: item[:category], colspan: 2, alignment: :left },
-                          { value: format_amount(item[:amount]), alignment: :right }]
+
+          if @settings[:verbose]
+            @table.add_row [{ value: item[:category], alignment: :left },
+                            { value: item[:description], alignment: :left },
+                            { value: format_amount(item[:amount]), alignment: :right }]
+          else
+            @table.add_row [{ value: item[:category], colspan: 2, alignment: :left },
+                            { value: format_amount(item[:amount]), alignment: :right }]
+          end
         end
 
         @table.add_row [{ value: "TOTAL".bold, colspan: 2, alignment: :left },
@@ -78,9 +85,17 @@ module HledgerForecast
       # Sort the array
       sorted_sums = sort_roll_up(sum_hash, :sum)
 
-      sorted_sums.each do |hash|
-        @table.add_row [{ value: hash[:category], colspan: 2, alignment: :left },
-                        { value: format_amount(hash[:sum]), alignment: :right }]
+      if @settings[:verbose]
+        sorted_sums.each do |hash|
+          @table.add_row [{ value: hash[:category], colspan: 1, alignment: :left },
+                          { value: hash[:descriptions], colspan: 1, alignment: :left },
+                          { value: format_amount(hash[:sum]), alignment: :right }]
+        end
+      else
+        sorted_sums.each do |hash|
+          @table.add_row [{ value: hash[:category], colspan: 2, alignment: :left },
+                          { value: format_amount(hash[:sum]), alignment: :right }]
+        end
       end
     end
 

data/lib/hledger_forecast/version.rb

@@ -1,3 +1,3 @@
 module HledgerForecast
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Oli Morris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-20 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize