hledger-forecast 0.4.0 → 1.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Oli Morris
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -113,10 +113,16 @@ files:
 - example.yml
 - hledger-forecast.gemspec
 - lib/hledger_forecast.rb
+- lib/hledger_forecast/calculator.rb
 - lib/hledger_forecast/cli.rb
+- lib/hledger_forecast/formatter.rb
 - lib/hledger_forecast/generator.rb
-- lib/hledger_forecast/summarize.rb
-- lib/hledger_forecast/tracker.rb
+- lib/hledger_forecast/settings.rb
+- lib/hledger_forecast/summarizer.rb
+- lib/hledger_forecast/summarizer_formatter.rb
+- lib/hledger_forecast/transactions/default.rb
+- lib/hledger_forecast/transactions/modifiers.rb
+- lib/hledger_forecast/transactions/trackers.rb
 - lib/hledger_forecast/version.rb
 - spec/command_spec.rb
 - spec/computed_amounts_spec.rb
@@ -132,6 +138,7 @@ files:
 - spec/stubs/transactions_found.journal
 - spec/stubs/transactions_found_inverse.journal
 - spec/stubs/transactions_not_found.journal
+- spec/summarizer_spec.rb
 - spec/track_spec.rb
 - spec/yearly_spec.rb
 homepage: https://github.com/olimorris/hledger-forecast
@@ -144,16 +151,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: An extended wrapper around hledger's forecasting functionality
@@ -172,5 +179,6 @@ test_files:
 - spec/stubs/transactions_found.journal
 - spec/stubs/transactions_found_inverse.journal
 - spec/stubs/transactions_not_found.journal
+- spec/summarizer_spec.rb
 - spec/track_spec.rb
 - spec/yearly_spec.rb

data/lib/hledger_forecast/summarize.rb

@@ -1,134 +0,0 @@
-module HledgerForecast
-  # Summarise a forecast YAML file and output it to the CLI
-  class Summarize
-    @table = nil
-    @generator = nil
-
-    def self.init_table
-      table = Terminal::Table.new
-
-      table.add_row([{ value: 'FORECAST SUMMARY'.bold, colspan: 3, alignment: :center }])
-      table.add_separator
-
-      @table = table
-    end
-
-    def self.init_generator(forecast_data)
-      generator = HledgerForecast::Generator
-      generator.set_options(forecast_data)
-
-      @generator = generator
-    end
-
-    def self.sum_transactions(forecast_data, period)
-      category_total = Hash.new(0)
-      forecast_data[period]&.each do |entry|
-        entry['transactions'].each do |transaction|
-          category_total[transaction['category']] += transaction['amount']
-        end
-      end
-
-      category_total
-    end
-
-    def self.sum_custom_transactions(forecast_data)
-      category_total = Hash.new(0)
-      custom_periods = []
-
-      forecast_data['custom']&.each do |entry|
-        period_data = {}
-        period_data[:frequency] = entry['frequency']
-        period_data[:category] = entry['transactions'].first['category']
-        period_data[:amount] = entry['transactions'].first['amount']
-
-        entry['transactions'].each do |transaction|
-          category_total[transaction['category']] += transaction['amount']
-        end
-
-        custom_periods << period_data
-      end
-
-      { totals: category_total, periods: custom_periods }
-    end
-
-    def self.format_amount(amount)
-      formatted_amount = @generator.format_amount(amount)
-      amount.to_f < 0 ? formatted_amount.green : formatted_amount.red
-    end
-
-    def self.add_rows_to_table(row_data, period_total, custom: false)
-      if custom
-        row_data[:periods].each do |period|
-          @table.add_row [{ value: period[:category], alignment: :left },
-                          { value: period[:frequency], alignment: :right },
-                          { value: format_amount(period[:amount]), alignment: :right }]
-
-          period_total += period[:amount]
-        end
-      else
-        row_data.each do |category, amount|
-          @table.add_row [{ value: category, colspan: 2, alignment: :left },
-                          { value: format_amount(amount), alignment: :right }]
-
-          period_total += amount
-        end
-      end
-
-      period_total
-    end
-
-    def self.add_categories_to_table(categories, forecast_data)
-      first_period = true
-      categories.each do |period, total|
-        category_total = total.reject { |_, amount| amount == 0 }
-        next if category_total.empty?
-
-        sorted_category_total = sort_transactions(category_total)
-
-        @table.add_separator unless first_period
-        @table.add_row([{ value: period.capitalize.bold, colspan: 3, alignment: :center }])
-
-        period_total = 0
-        period_total += if period == 'custom'
-                          add_rows_to_table(sum_custom_transactions(forecast_data), period_total, custom: true)
-                        else
-                          add_rows_to_table(sorted_category_total, period_total)
-                        end
-
-        format_total("#{period.capitalize} TOTAL", period_total)
-        first_period = false
-      end
-    end
-
-    def self.sort_transactions(category_total)
-      negatives = category_total.select { |_, amount| amount < 0 }.sort_by { |_, amount| amount }
-      positives = category_total.select { |_, amount| amount > 0 }.sort_by { |_, amount| -amount }
-
-      negatives.concat(positives).to_h
-    end
-
-    def self.format_total(text, total)
-      @table.add_row [{ value: text.bold, colspan: 2, alignment: :left },
-                      { value: format_amount(total).bold, alignment: :right }]
-    end
-
-    def self.generate(forecast)
-      forecast_data = YAML.safe_load(forecast)
-
-      init_table
-      init_generator(forecast_data)
-
-      category_totals = {}
-      %w[monthly quarterly half-yearly yearly once custom].each do |period|
-        category_totals[period] = sum_transactions(forecast_data, period)
-      end
-
-      add_categories_to_table(category_totals, forecast_data)
-
-      @table.add_separator
-      format_total("TOTAL", category_totals.values.map(&:values).flatten.sum)
-
-      puts @table
-    end
-  end
-end

data/lib/hledger_forecast/tracker.rb

@@ -1,37 +0,0 @@
-module HledgerForecast
-  # Checks for the existence of a transaction in a journal file and tracks it
-  class Tracker
-    def self.track(transactions, transaction_file)
-      next_month = Date.new(Date.today.year, Date.today.month, 1).next_month
-
-      transactions.each_with_object({}) do |(key, transaction), updated_transactions|
-        found = transaction_exists?(transaction_file, transaction['from'], Date.today, transaction['account'],
-                                    transaction['transaction'])
-        updated_transactions[key] = transaction.merge('from' => next_month, 'found' => found)
-      end
-    end
-
-    def self.latest_date(file)
-      command = %(hledger print --file #{file} | grep '^[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}' | awk '{print $1}' | sort -r | head -n 1)
-
-      date_output = `#{command}`
-      date_output.strip
-    end
-
-    def self.transaction_exists?(file, from, to, account, transaction)
-      category = escape_str(transaction['category'])
-      amount = transaction['amount']
-      inverse_amount = transaction['inverse_amount']
-
-      # We run two commands and check to see if category +/- amount or account +/- amount exists
-      command1 = %(hledger print -f #{file} "date:#{from}..#{to}" | tr -s '[:space:]' ' ' | grep -q -Eo "#{category} (#{amount}|#{inverse_amount})")
-      command2 = %(hledger print -f #{file} "date:#{from}..#{to}" | tr -s '[:space:]' ' ' | grep -q -Eo "#{account} (#{amount}|#{inverse_amount})")
-
-      system(command1) || system(command2)
-    end
-
-    def self.escape_str(str)
-      str.gsub('[', '\\[').gsub(']', '\\]').gsub('(', '\\(').gsub(')', '\\)')
-    end
-  end
-end