hledger-forecast 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f769e017bc9ad46ea7d7571f74c64286e9c2415d0696e40f3301438a9038514
-  data.tar.gz: 52f69b30edfbc0c9d5430b88d25687c9c311d6c6aa4b1e5fd3b2815b3602d240
+  metadata.gz: 6f0e4168dd9c64b1de4aec0c02fcf1601ef926c0f2f911931052c627df53b922
+  data.tar.gz: bf24674eeae1cac5714ddd56a23cdd86059afaba3d376d8538424372f4ae74b0
 SHA512:
-  metadata.gz: 2721eb985469db575b66172a94ee670e96711437da7b94f27da53301beed9f385b46c19121c9d365ce01fb0423ea5ea728ce511296c29adc26fc2051ff33e794
-  data.tar.gz: e41363954be45ca668dd73cc1a816b47a94419be53cde4fccdfc5a88a55601a2166e5f6eeb6532d4673c3bfe204020122165b71fabcca07a9dbf7cf0f1f80271
+  metadata.gz: 72666051a083ae0381717c58bcb7c09de8dd250df683d26a16bce25ebf79315323b5bd2d0b9f2a19f553ecf3fe0c0327b5449c7435f5b3a461b121a6ab810537
+  data.tar.gz: 83f063a2ca35895d5104b2ff573de4b44e28b731fd8461462e87c9fb0d84ed26b818383bcaaccb4a7f52e784a383af0350eaab3d7d49d1b01930f4eee19a7f4d

data/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/{ci.yml → test.yml}

@@ -1,4 +1,4 @@
-name: Tests
+name: Test
 
 on:
   pull_request:
@@ -8,14 +8,13 @@ on:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Update packages
         run: sudo apt-get update
       - name: Install packages
@@ -23,7 +22,8 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          bundler-cache: true # runs 'bundle install' and caches installed gems
+          bundler-cache: true
           ruby-version: ${{ matrix.ruby-version }}
       - name: Run tests
-        run: bundle exec rspec
+        run: |
+          bundle exec rspec

data/README.md

@@ -8,7 +8,7 @@
 <a href="https://github.com/olimorris/hledger-forecast/stargazers"><img src="https://img.shields.io/github/stars/olimorris/hledger-forecast?color=c678dd&logoColor=e06c75&style=for-the-badge"></a>
 <a href="https://github.com/olimorris/hledger-forecast/issues"><img src="https://img.shields.io/github/issues/olimorris/hledger-forecast?color=%23d19a66&style=for-the-badge"></a>
 <a href="https://github.com/olimorris/hledger-forecast/blob/main/LICENSE"><img src="https://img.shields.io/github/license/olimorris/hledger-forecast?color=%2361afef&style=for-the-badge"></a>
-<a href="https://github.com/olimorris/hledger-forecast/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/olimorris/hledger-forecast/ci.yml?branch=main&label=tests&style=for-the-badge"></a>
+<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)!**

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 = 'Uses a YAML file to generate forecasts which can be used to extend the default functionality in hledger'
+  s.description = 'Use a CSV or YAML 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/comparator.rb

@@ -43,7 +43,7 @@ module HledgerForecast
           if header?(i) || j == 0 # Checking for the first column here
             csv2[i][j]
           else
-            difference = parse_money(cell) - parse_money(csv2[i][j])
+            difference = parse_money(csv2[i][j]) - parse_money(cell)
             format_difference(difference, detect_currency(cell))
           end
         end
@@ -51,7 +51,9 @@ module HledgerForecast
     end
 
     def detect_currency(str)
-      # Explicitly check for common currencies first
+      return nil if str == "0"
+
+      # Explicitly check for common currencies
       return "GBP" if str.include?("£")
       return "EUR" if str.include?("€")
       return "USD" if str.include?("$")
@@ -64,13 +66,17 @@ module HledgerForecast
     end
 
     def parse_money(value)
-      # Remove currency symbols and parse the result as a float, then convert to cents
-      cleaned_value = value.gsub(/[^0-9.]/, '').to_f
-      cleaned_value.to_i
+      return 0.0 if value.strip == '0'
+
+      value.gsub(/[^0-9.-]/, '').to_f
     end
 
     def format_difference(amount, currency)
-      formatted_amount = Formatter.format_money(amount, { currency: currency })
+      formatted_amount = if currency.nil?
+                           format("%.2f", amount)
+                         else
+                           Formatter.format_money(amount, { currency: currency })
+                         end
 
       return formatted_amount if amount == 0
 

data/lib/hledger_forecast/summarizer_formatter.rb

@@ -117,9 +117,18 @@ module HledgerForecast
         sum + item[row_to_sum]
       end
 
+      income = data.reduce(0) do |sum, item|
+        sum += item[row_to_sum] if item[row_to_sum] < 0
+        sum
+      end
+
+      savings = (total / income * 100).to_f.round(2)
+
       @table.add_separator
       @table.add_row [{ value: "TOTAL".bold, colspan: 2, alignment: :left },
                       { value: format_amount(total).bold, alignment: :right }]
+      @table.add_row [{ value: "as a % of income".italic, colspan: 2, alignment: :left },
+                      { value: "#{savings}%".italic, alignment: :right }]
     end
 
     def format_amount(amount)

data/lib/hledger_forecast/version.rb

@@ -1,3 +1,3 @@
 module HledgerForecast
-  VERSION = "1.5.0"
+  VERSION = "1.5.2".freeze
 end

data/spec/cli_spec.rb

@@ -49,7 +49,7 @@ RSpec.describe 'command' do
       +---------+---------+---------+
       | account | 2023-07 | 2023-08 |
       +---------+---------+---------+
-      | total   | £-10.00 | €10.00  |
+      | total   | £10.00  | €-10.00 |
       +---------+---------+---------+
 
     OUTPUT

data/spec/compare_spec.rb

@@ -17,15 +17,15 @@ end
 RSpec.describe HledgerForecast::Comparator do
   let(:file1_content) do
     <<~CSV
-      "account","2023-07","2023-08"
-      "total","£100.00","€200.00"
+      "account","2023-07","2023-08","2023-09"
+      "total","£100.00","€200.00",0
     CSV
   end
 
   let(:file2_content) do
     <<~CSV
-      "account","2023-07","2023-08"
-      "total","£110.00","€190.00"
+      "account","2023-07","2023-08","2023-09"
+      "total","£110.00","-€200.00",£1144.00
     CSV
   end
 
@@ -41,11 +41,11 @@ RSpec.describe HledgerForecast::Comparator do
     comparator = described_class.new
 
     expected_output = strip_ansi_codes(<<~OUTPUT)
-      +---------+---------+---------+
-      | account | 2023-07 | 2023-08 |
-      +---------+---------+---------+
-      | total   | £-10.00 | €10.00  |
-      +---------+---------+---------+
+      +---------+---------+----------+---------+
+      | account | 2023-07 | 2023-08  | 2023-09 |
+      +---------+---------+----------+---------+
+      | total   | £10.00  | €-400.00 | 1144.00 |
+      +---------+---------+----------+---------+
     OUTPUT
 
     actual_output = capture_stdout { comparator.compare('file1.csv', 'file2.csv') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hledger-forecast
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Oli Morris
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2023-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -94,15 +94,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
-description: Uses a YAML file to generate forecasts which can be used to extend the
-  default functionality in hledger
+description: Use a CSV or YAML file for improved forecasting with hledger
 email: olimorris@users.noreply.github.com
 executables:
 - hledger-forecast
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -155,7 +155,7 @@ homepage: https://github.com/olimorris/hledger-forecast
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: An extended wrapper around hledger's forecasting functionality
 test_files: