hledger-forecast 1.5.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0e4168dd9c64b1de4aec0c02fcf1601ef926c0f2f911931052c627df53b922
-  data.tar.gz: bf24674eeae1cac5714ddd56a23cdd86059afaba3d376d8538424372f4ae74b0
+  metadata.gz: c025630ee2a5d379fcf9e27509c1c5cc5438e5b0a38fcc73c3277fab8e1a6e2e
+  data.tar.gz: 6d50f7774dbf3331328b9126392bad45aba281b00b4e93eb9060671b982560f6
 SHA512:
-  metadata.gz: 72666051a083ae0381717c58bcb7c09de8dd250df683d26a16bce25ebf79315323b5bd2d0b9f2a19f553ecf3fe0c0327b5449c7435f5b3a461b121a6ab810537
-  data.tar.gz: 83f063a2ca35895d5104b2ff573de4b44e28b731fd8461462e87c9fb0d84ed26b818383bcaaccb4a7f52e784a383af0350eaab3d7d49d1b01930f4eee19a7f4d
+  metadata.gz: 7a21eca09d0f5145a54e4acff809090179cc48e9aa060ed6117c5ef2d17f578aab93b6779396254c3ff0437ff29ecffecf92546622f0dc2f9d12ee61e2794dbd
+  data.tar.gz: 43509f84789f5dc0700924e22d3137eb4f07a11ee4cbbecef291770c4bdb2bbf83ef63c4aaecc7a87c0a4b77bc5ff29d578dc0e231cf68db85e76fc00f187ec7

data/.rubocop.yml

@@ -4,20 +4,20 @@ AllCops:
 Layout/LineLength:
   Max: 120
 
-Style/StringLiterals:
-  Enabled: false
-
-Style/RedundantReturn:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: False
-
-Metrics/MethodLength:
-  Enabled: False
-
-Metrics/AbcSize:
-  Enabled: False
-
-Style/NumericPredicate:
-  Enabled: False
+# Style/StringLiterals:
+#   Enabled: false
+#
+# Style/RedundantReturn:
+#   Enabled: false
+#
+# Metrics/ClassLength:
+#   Enabled: False
+#
+# Metrics/MethodLength:
+#   Enabled: False
+#
+# Metrics/AbcSize:
+#   Enabled: False
+#
+# Style/NumericPredicate:
+#   Enabled: False

data/README.md

@@ -11,13 +11,13 @@
 <a href="https://github.com/olimorris/hledger-forecast/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/olimorris/hledger-forecast/test.yml?branch=main&label=tests&style=for-the-badge"></a>
 </p>
 
-**"Improved", you say?** Using a _CSV_ (or _YML_) file, forecasts can be quickly generated into a _journal_ file ready to be fed into [hledger](https://github.com/simonmichael/hledger). **A 16 line [CSV file](https://github.com/olimorris/hledger-forecast/blob/main/example.csv) can generate a 46 line hledger [forecast file](https://github.com/olimorris/hledger-forecast/blob/main/example.journal)!**
+**"Improved", you say?** Using a _CSV_ file, forecasts can be quickly generated into a _journal_ file ready to be fed into [hledger](https://github.com/simonmichael/hledger). **A 16 line [CSV file](https://github.com/olimorris/hledger-forecast/blob/main/example.csv) can generate a 46 line hledger [forecast file](https://github.com/olimorris/hledger-forecast/blob/main/example.journal)!**
 
 Forecasts can also be constrained between dates, inflated by modifiers, tracked until they appear in your bank statements and summarized into your own daily/weekly/monthly/yearly personal forecast income and expenditure statement.
 
 ## :sparkles: Features
 
-- :rocket: Uses a simple CSV (or YML) file to generate forecasts which can be used with hledger
+- :rocket: Uses a simple CSV file to generate forecasts which can be used with hledger
 - :calendar: Can smartly track forecasts against your bank statement
 - :dollar: Can automatically apply modifiers such as inflation/deflation to forecasts
 - :mag: Enables the use of maths in your forecasts (for amounts and dates)
@@ -62,13 +62,13 @@ The available options are:
 
 ### Generate command
 
-The `hledger-forecast generate` command will generate a forecast _from_ a `CSV` or `YML` file _to_ a journal file. You can see the output of this command in the [example.journal](https://github.com/olimorris/hledger-forecast/blob/main/example.journal) file.
+The `hledger-forecast generate` command will generate a forecast _from_ a `CSV` file _to_ a journal file. You can see the output of this command in the [example.journal](https://github.com/olimorris/hledger-forecast/blob/main/example.journal) file.
 
 The available options are:
 
     Usage: hledger-forecast generate [options]
 
-      -f, --forecast FILE              The path to the FORECAST CSV/YML file to generate from
+      -f, --forecast FILE              The path to the FORECAST CSV 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
@@ -78,7 +78,7 @@ The available options are:
 
 > **Note**: For the tracking of transactions you need to include the `-t` flag
 
-Running the command with no options will assume a `forecast.yml` file exists.
+Running the command with no options will assume a `forecast.csv` file exists.
 
 ### Using with hledger
 
@@ -100,7 +100,7 @@ The available options are:
 
     Usage: hledger-forecast summarize [options]
 
-    -f, --forecast FILE              The path to the FORECAST CSV/YML file to summarize
+    -f, --forecast FILE              The path to the FORECAST CSV 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
@@ -138,7 +138,7 @@ The _CSV_ file _should_ contain a header row with the following columns:
 - `summary_exclude` - (boolean) _(optional)_ - Exclude the transaction from the summarizer?
 - `track` - (boolean) _(optional)_ - Track the transaction against your confirmed transactions?
 
-### An example CSV forecast
+### Example forecast
 
 Putting it together, we end up with a CSV file like:
 
@@ -198,157 +198,6 @@ settings,show_symbol,true,,,,,,,,
 settings,thousands_separator,true,,,,,,,,
 ```
 
-### An example YML forecast
-
-> **Note**: The app uses `yml` in place of `yaml` by default
-
-Taking the _CSV_ example above and applying it to a _YML_ file:
-
-```yml
-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
-      - 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
-```
-
-#### Modifiers
-
-> **Note**: For modifiers to be included in your hledger reporting, use the `--auto` flag
-
-Currently, a YML forecast allows a user to include forecasted % uplifts or downshifts:
-
-```yml
-monthly:
-  - account: "Assets:Bank"
-    from: "2023-03-01"
-    transactions:
-      - 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"
-```
-
-This will generate an [auto-posting](https://hledger.org/dev/hledger.html#auto-postings) in your forecast which will uplift any transaction with an `Expenses:Food` category. In the first year the uplift with be 2% and in the following year, 5%.
-
-#### Additional YML features
-
-Dates in a YML file can be constrained by the `to` date in two ways:
-
-```yml
-monthly:
-  - account: "Assets:Bank"
-    from: "2023-03-01"
-    to: "2025-01-01"
-    transactions:
-      # details omitted for brevity
-```
-
-or:
-
-```yml
-monthly:
-  - account: "Assets:Bank"
-    from: "2023-03-01"
-    transactions:
-      - amount: 2000
-        category: "Expenses:Mortgage"
-        description: Mortgage
-        to: "2025-01-01"
-```
-
 ### Tracking
 
 > **Note**: Marking a transaction for tracking will ensure that it is only written into the forecast if it isn't found within a specified transaction file
@@ -362,19 +211,6 @@ type,frequency,account,from,to,description,category,amount,roll-up,summary_exclu
 once,,Assets:Bank,2023-03-05,,Refund for that damn laptop,Expenses:Shopping,-3000,,,TRUE
 ```
 
-Or:
-
-```yml
-once:
-  - account: "Assets:Bank"
-    from: "2023-03-05"
-    transactions:
-      - amount: -3000
-        category: "Expenses:Shopping"
-        description: Refund for that damn laptop
-        track: true
-```
-
 > **Note**: This feature has been designed to work with `once` transaction types only
 
 To use this feature, ensure you pass a filepath to the `-t` flag, such as:

data/example.journal

@@ -1,47 +1,47 @@
 ~ monthly from 2023-03-01  * Salary, Bills, Food, New Kitchen
-    Income:Salary                $-3,500.00;  Salary
-    Expenses:Bills               $175.00   ;  Bills
-    Expenses:Food                $500.00   ;  Food
-    Expenses:House               $208.33   ;  New Kitchen
+    Income:Salary                $-3,500.00   ;  Salary
+    Expenses:Bills               $175.00      ;  Bills
+    Expenses:Food                $500.00      ;  Food
+    Expenses:House               $208.33      ;  New Kitchen
     Assets:Bank
 
 ~ monthly from 2023-03-01 to 2025-01-01  * Mortgage
-    Expenses:Mortgage            $2,000.00 ;  Mortgage
+    Expenses:Mortgage            $2,000.00    ;  Mortgage
     Assets:Bank
 
 ~ monthly from 2023-03-01 to 2024-02-29  * Holiday
-    Expenses:Holiday             $125.00   ;  Holiday
+    Expenses:Holiday             $125.00      ;  Holiday
     Assets:Bank
 
 ~ monthly from 2023-03-01 to 2025-03-01  * Rainy day fund
-    Assets:Savings               $300.00   ;  Rainy day fund
+    Assets:Savings               $300.00      ;  Rainy day fund
     Assets:Bank
 
 ~ monthly from 2024-01-01  * Pension draw down
-    Income:Pension               $-500.00  ;  Pension draw down
+    Income:Pension               $-500.00     ;  Pension draw down
     Assets:Pension
 
 ~ every 3 months from 2023-04-01  * Quarterly bonus
-    Income:Bonus                 $-1,000.00;  Quarterly bonus
+    Income:Bonus                 $-1,000.00   ;  Quarterly bonus
     Assets:Bank
 
 ~ every 6 months from 2023-04-01  * Top up holiday funds
-    Expenses:Holiday             $500.00   ;  Top up holiday funds
+    Expenses:Holiday             $500.00      ;  Top up holiday funds
     Assets:Bank
 
 ~ yearly from 2023-04-01  * Annual bonus
-    Income:Bonus                 $-2,000.00;  Annual bonus
+    Income:Bonus                 $-2,000.00   ;  Annual bonus
     Assets:Bank
 
 ~ every 2 weeks from 2023-03-01  * Hair and beauty
-    Expenses:Personal Care       $80.00    ;  Hair and beauty
+    Expenses:Personal Care       $80.00       ;  Hair and beauty
     Assets:Bank
 
 ~ every 5 weeks from 2023-03-01  * Misc expenses
-    Expenses:General Expenses    $30.00    ;  Misc expenses
+    Expenses:General Expenses    $30.00       ;  Misc expenses
     Assets:Bank
 
-~ 2023-07-01  * [TRACKED] Refund for that damn laptop
+~ 2024-01-01  * [TRACKED] Refund for that damn laptop
     Expenses:Shopping            $-3,000.00;  Refund for that damn laptop
     Assets:Bank
 

data/hledger-forecast.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.version     = HledgerForecast::VERSION
   s.authors     = ['Oli Morris']
   s.summary     = "An extended wrapper around hledger's forecasting functionality"
-  s.description = 'Use a CSV or YAML file for improved forecasting with hledger'
+  s.description = 'Use a CSV file for improved forecasting with hledger'
   s.email       = 'olimorris@users.noreply.github.com'
   s.homepage    = 'https://github.com/olimorris/hledger-forecast'
   s.license     = 'MIT'

data/lib/hledger_forecast/calculator.rb

@@ -12,7 +12,11 @@ module HledgerForecast
     end
 
     def evaluate_date(from, to)
-      return to unless to[0] == "="
+      if to[0] != "="
+        return to if to.is_a?(Date)
+
+        return Date.parse(to)
+      end
 
       # Subtract a day from the final date
       (from >> @calculator.evaluate(to.slice(1..-1))) - 1

data/lib/hledger_forecast/cli.rb

@@ -79,16 +79,9 @@ module HledgerForecast
         opts.separator ""
 
         opts.on("-f", "--forecast FILE",
-                "The path to the FORECAST csv/yml file to generate from") do |file|
+                "The path to the FORECAST csv file to generate from") do |file|
           options[:forecast_file] = file
-
-          options[:file_type] = if File.extname(file) == '.csv'
-                                  "csv"
-                                else
-                                  "yml"
-                                end
-
-          options[:output_file] ||= file.sub(options[:file_type], 'journal')
+          options[:output_file] ||= file.sub('csv', 'journal')
         end
 
         opts.on("-o", "--output-file FILE",
@@ -102,7 +95,7 @@ module HledgerForecast
         end
 
         opts.on("-v", "--verbose",
-                "Don't group transactions by type in the output file") do
+                "Do not group transactions in the output file") do
           options[:verbose] = true
         end
 
@@ -112,7 +105,7 @@ module HledgerForecast
         end
 
         opts.on("--no-track",
-                "Don't track any transactions") do
+                "Do not track any transactions") do
           options[:no_track] = true
         end
 
@@ -150,12 +143,7 @@ module HledgerForecast
         opts.separator ""
 
         opts.on("-f", "--forecast FILE",
-                "The path to the FORECAST csv/yml file to summarize") do |file|
-          options[:file_type] = if File.extname(file) == '.csv'
-                                  "csv"
-                                else
-                                  "yml"
-                                end
+                "The path to the FORECAST csv file to summarize") do |file|
           options[:forecast_file] = file
         end
 
@@ -240,7 +228,6 @@ module HledgerForecast
       forecast = File.read(options[:forecast_file])
 
       begin
-        forecast = HledgerForecast::CSVParser.parse(forecast) if options[:file_type] == "csv"
         transactions = Generator.generate(forecast, options)
       rescue StandardError => e
         puts "An error occurred while generating transactions: #{e.message}"

data/lib/hledger_forecast/generator.rb

@@ -6,61 +6,78 @@ module HledgerForecast
     end
 
     def generate(config, cli_options = nil)
-      forecast = YAML.safe_load(config)
+      forecast = CSV.parse(config, headers: true)
       @settings = Settings.config(forecast, cli_options)
 
-      output = {}
-      forecast.each do |period, blocks|
-        next if %w[settings].include?(period)
+      processed = []
+      forecast.each do |row|
+        next if row['type'] == "settings"
 
-        blocks.each do |block|
-          output[output.length] = process_block(period, block)
+        processed.push(process_forecast(row))
+      end
+
+      unless @settings[:verbose]
+        processed = processed.group_by do |row|
+          [row[:type], row[:frequency], row[:from], row[:to], row[:account], row[:track]]
+        end
+
+        processed = processed.map do |(type, frequency, from, to, account, track), transactions|
+          {
+            type: type,
+            frequency: frequency,
+            from: from,
+            to: to,
+            account: account,
+            track: track || false,
+            transactions: transactions
+          }
         end
       end
 
       Formatter.output_to_ledger(
-        Transactions::Default.generate(output, @settings),
-        Transactions::Trackers.generate(output, @settings),
-        Transactions::Modifiers.generate(output, @settings)
+        Transactions::Default.generate(processed, @settings),
+        Transactions::Trackers.generate(processed, @settings)
       )
     end
 
     private
 
-    def process_block(period, block)
-      output = []
+    def process_forecast(row)
+      row['amount'] = Utilities.convert_amount(row['amount'])
 
-      output << {
-        account: block['account'],
-        from: Date.parse(block['from']),
-        to: block['to'] ? Date.parse(block['to']) : nil,
-        type: period,
-        frequency: block['frequency'],
-        transactions: []
+      {
+        type: row['type'],
+        frequency: row['frequency'] || nil,
+        account: row['account'],
+        from: Date.parse(row['from']),
+        to: row['to'] ? Calculator.new.evaluate_date(Date.parse(row['from']), row['to']) : nil,
+        description: row['description'],
+        category: row['category'],
+        amount: Formatter.format_money(Calculator.new.evaluate(row['amount']), @settings),
+        track: Transactions::Trackers.track?(row, @settings) ? true : false
       }
+    end
 
-      output = process_transactions(block, output)
+    def transform_data(data)
+      transformed_data = []
 
-      output.map do |item|
-        transactions = item[:transactions].group_by { |t| t[:to] }
-        item.merge(transactions: transactions)
-      end
-    end
+      data.each do |group_key, transactions|
+        next if group_key == "settings"
 
-    def process_transactions(block, output)
-      block['transactions'].each do |t|
-        output.last[:transactions] << {
-          category: t['category'],
-          amount: Formatter.format_money(Calculator.new.evaluate(t['amount']), @settings),
-          description: t['description'],
-          to: t['to'] ? Calculator.new.evaluate_date(Date.parse(block['from']), t['to']) : nil,
-          modifiers: t['modifiers'] ? Transactions::Modifiers.get_modifiers(t, block) : [],
-          track: Transactions::Trackers.track?(t, block, @settings) ? true : false,
-          frequency: t['frequency'] || nil
+        split_keys = group_key.split("@@")
+
+        group_info = {
+          type: split_keys[0],
+          from: split_keys[1],
+          to: split_keys[2],
+          account: split_keys[3],
+          transactions: transactions
         }
+
+        transformed_data << group_info
       end
 
-      output
+      transformed_data
     end
   end
 end

data/lib/hledger_forecast/settings.rb

@@ -1,41 +1,56 @@
 module HledgerForecast
-  # Set the options from a user's confgi
+  # Set the options from a user's config
   class Settings
     def self.config(forecast, cli_options)
       settings = {}
+      settings[:max_amount] = 0
+      settings[:max_category] = 0
 
-      settings[:max_amount] = get_max_field_size(forecast, 'amount') + 1 # +1 for the negatives
-      settings[:max_category] = get_max_field_size(forecast, 'category')
+      forecast.each do |row|
+        if row['type'] != 'settings'
+          category_length = row['category'].length
+          settings[:max_category] = category_length if category_length > settings[:max_category]
 
-      settings[:currency] = Money::Currency.new(forecast.fetch('settings', {}).fetch('currency', 'USD'))
-      settings[:show_symbol] = forecast.fetch('settings', {}).fetch('show_symbol', true)
-      # settings[:sign_before_symbol] = forecast.fetch('settings', {}).fetch('sign_before_symbol', false)
-      settings[:thousands_separator] = forecast.fetch('settings', {}).fetch('thousands_separator', true)
+          amount = if row['amount'].is_a?(Integer) || row['amount'].is_a?(Float)
+                     ((row['amount'] + 3) * 100).to_s
+                   else
+                     row['amount'].to_s
+                   end
 
-      settings.merge!(cli_options) if cli_options
-
-      settings
-    end
+          settings[:max_amount] = amount.length if amount.length > settings[:max_amount]
+        end
 
-    def self.get_max_field_size(block, field)
-      max_size = 0
-
-      block.each do |period, items|
-        next if %w[settings].include?(period)
-
-        items.each do |item|
-          item['transactions'].each do |t|
-            field_value = if t[field].is_a?(Integer) || t[field].is_a?(Float)
-                            ((t[field] + 3) * 100).to_s
-                          else
-                            t[field].to_s
-                          end
-            max_size = [max_size, field_value.length].max
-          end
+        if row['type'] == 'settings'
+
+          settings[:currency] = if row['frequency'] == "currency"
+                                  row['account']
+                                else
+                                  "USD"
+                                end
+
+          settings[:show_symbol] = if row['frequency'] == "show_symbol"
+                                     row['account']
+                                   else
+                                     true
+                                   end
+
+          settings[:sign_before_symbol] = if row['frequency'] == "sign_before_symbol"
+                                            row['account']
+                                          else
+                                            false
+                                          end
+
+          settings[:thousands_separator] = if row['frequency'] == "thousands_separator"
+                                             row['account']
+                                           else
+                                             ","
+                                           end
         end
+
+        settings.merge!(cli_options) if cli_options
       end
 
-      max_size
+      settings
     end
   end
 end