reckon 0.6.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f25c7df49774d944ebc40a73374ac593ebeac2e0b0a201e0d29f9c5ace2642e9
-  data.tar.gz: 27acd960b5210e7e0fb88c50acf35def784411d0b8112f0f0b8e6c4e2f5ab621
+  metadata.gz: 5984a4f8cd36d4e14f013c14bb111725f8681b90768b6710679820d1325a02e5
+  data.tar.gz: b392d89078a7679f01a344799512ec0467cfe8cad101374a5b8fd198c7e39480
 SHA512:
-  metadata.gz: ddd5fe0ef08b2718e8083cdbd9695e936737b9ff6b258808787192496675f9a371c302e9936069019821f1c865a3280488aa4396185f1e0bf6e7d84b78dc5c0a
-  data.tar.gz: f611a48dad98a6a4764518dcb2e72969898d6dfbdaf5e06a77f36ab071429ac6f3bd0b0f51200dc8fbaaca913a95519a6bb38e6ec203dc0af61d861802d101f6
+  metadata.gz: ae9b8348e93294d45354f1b96045305dd480b23cd34dcaca3f958fcbc866582000faa1711ea6cbb552578ffe98f126943221b98af298757b86e6dfa54c623f9d
+  data.tar.gz: f43e7128e198c9b73fc40b148cbe281d0bc02aeec90d576615e24fe98789a1846553121319152bffb3a9ca966fd26e1b3916da90480979c5d55106e06dbfe7f2

data/.github/workflows/ruby.yml

@@ -0,0 +1,50 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Build Status
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          # Current ruby stable version
+          - 3.0
+          # Ubuntu 20.10
+          - 2.7
+          # Ubuntu 19.10
+          - 2.5
+          # Mac v11 Big Sur
+          # - 2.6?
+          # Mac v10.15 Catalina
+          - 2.6
+          # Mac v10.14 Mojave
+          - 2.3.7
+    steps:
+    - uses: actions/checkout@v2
+    - name: Update package
+      run: sudo apt-get update
+    - name: Install packages
+      run: sudo apt-get -y install ledger hledger expect
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      # uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems
+    - name: Run tests
+      run: bundle exec rake test_all

data/.gitignore

@@ -28,3 +28,6 @@ private_tests
 
 ## Bundler
 vendor
+
+test.log
+test_log.txt

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p648
+3.0.0

data/CHANGELOG.md

@@ -1,8 +1,76 @@
 # Changelog
 
-## [0.6.0](https://github.com/cantino/reckon/tree/0.6.0) (2020-09-03)
+## [v0.7.2](https://github.com/cantino/reckon/tree/v0.7.2) (2021-04-22)
 
-[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.4...0.6.0)
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.7.1...v0.7.2)
+
+**Closed issues:**
+
+- \[feature request\] Better format for large transactions [\#108](https://github.com/cantino/reckon/issues/108)
+- cosine similarity not comparing documents correctly [\#106](https://github.com/cantino/reckon/issues/106)
+
+**Merged pull requests:**
+
+- Add thousands separator in money output.  Fixes \#108. [\#109](https://github.com/cantino/reckon/pull/109) ([benprew](https://github.com/benprew))
+- Cosine similarity should use all docs tokens. not just matched tokens. [\#107](https://github.com/cantino/reckon/pull/107) ([benprew](https://github.com/benprew))
+- Test getting expect working with actions [\#105](https://github.com/cantino/reckon/pull/105) ([benprew](https://github.com/benprew))
+
+## [v0.7.1](https://github.com/cantino/reckon/tree/v0.7.1) (2021-02-07)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.7.0...v0.7.1)
+
+**Closed issues:**
+
+- bug when asking for account name [\#103](https://github.com/cantino/reckon/issues/103)
+
+## [v0.7.0](https://github.com/cantino/reckon/tree/v0.7.0) (2021-02-06)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.6.2...v0.7.0)
+
+**Closed issues:**
+
+- fail on unknown accounts [\#96](https://github.com/cantino/reckon/issues/96)
+
+**Merged pull requests:**
+
+- Fail on unknown account [\#102](https://github.com/cantino/reckon/pull/102) ([benprew](https://github.com/benprew))
+- Joined split sentence to one [\#101](https://github.com/cantino/reckon/pull/101) ([RidaAyed](https://github.com/RidaAyed))
+
+## [v0.6.2](https://github.com/cantino/reckon/tree/v0.6.2) (2021-01-25)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.6.1...v0.6.2)
+
+**Closed issues:**
+
+- spaces in tokens [\#97](https://github.com/cantino/reckon/issues/97)
+- read from stdin [\#95](https://github.com/cantino/reckon/issues/95)
+
+**Merged pull requests:**
+
+- Allow using '-' as filename in -f to read csv from STDIN.  Fixes \#95 [\#98](https://github.com/cantino/reckon/pull/98) ([benprew](https://github.com/benprew))
+
+## [v0.6.1](https://github.com/cantino/reckon/tree/v0.6.1) (2021-01-23)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.6.0...v0.6.1)
+
+**Implemented enhancements:**
+
+- \[Feature Request\] Note flag --add-notes in CLI to allow additional notes for each ledger entry [\#86](https://github.com/cantino/reckon/issues/86)
+
+**Closed issues:**
+
+- Migrate CI system from travis-ci.org [\#93](https://github.com/cantino/reckon/issues/93)
+- \[Feature Request\] Pipe ledger file input to the bayesian predictor \(instead of csv\) [\#91](https://github.com/cantino/reckon/issues/91)
+
+**Merged pull requests:**
+
+- Add github actions [\#100](https://github.com/cantino/reckon/pull/100) ([benprew](https://github.com/benprew))
+- Add documentation for doing a substring match.  Fixes \#97 [\#99](https://github.com/cantino/reckon/pull/99) ([benprew](https://github.com/benprew))
+- Test fixes [\#94](https://github.com/cantino/reckon/pull/94) ([benprew](https://github.com/benprew))
+
+## [v0.6.0](https://github.com/cantino/reckon/tree/v0.6.0) (2020-09-04)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.4...v0.6.0)
 
 **Fixed bugs:**
 
@@ -82,7 +150,6 @@
 - Fix bugs in ledger file parsing.  Fixes \#56. [\#81](https://github.com/cantino/reckon/pull/81) ([benprew](https://github.com/benprew))
 - Better file encoding suggestions [\#80](https://github.com/cantino/reckon/pull/80) ([benprew](https://github.com/benprew))
 - :bug: fix matching algorithm, add logging and a spec helper.  Fixes \#73 [\#79](https://github.com/cantino/reckon/pull/79) ([benprew](https://github.com/benprew))
-- bug: invalid header lines should be ignored, not parsed. [\#78](https://github.com/cantino/reckon/pull/78) ([benprew](https://github.com/benprew))
 - convert default date format to iso8601 [\#77](https://github.com/cantino/reckon/pull/77) ([benprew](https://github.com/benprew))
 - Fix rspec failure for ruby 2.3 and 2.4 [\#69](https://github.com/cantino/reckon/pull/69) ([BlackEdder](https://github.com/BlackEdder))
 - Allow setting of money and date columns by index [\#67](https://github.com/cantino/reckon/pull/67) ([cantino](https://github.com/cantino))
@@ -135,6 +202,7 @@
 
 **Merged pull requests:**
 
+- bug: invalid header lines should be ignored, not parsed. [\#78](https://github.com/cantino/reckon/pull/78) ([benprew](https://github.com/benprew))
 - Better ISO 8601 dates support [\#49](https://github.com/cantino/reckon/pull/49) ([vzctl](https://github.com/vzctl))
 - Unattended mode and custom tokens support [\#47](https://github.com/cantino/reckon/pull/47) ([vzctl](https://github.com/vzctl))
 - \[RFC\] Implement issue \#40: Tab completion [\#46](https://github.com/cantino/reckon/pull/46) ([BlackEdder](https://github.com/BlackEdder))
@@ -148,6 +216,7 @@
 
 - Fix --encoding option [\#41](https://github.com/cantino/reckon/pull/41) ([mamciek](https://github.com/mamciek))
 - Bumped version number [\#37](https://github.com/cantino/reckon/pull/37) ([BlackEdder](https://github.com/BlackEdder))
+- Ing csv [\#30](https://github.com/cantino/reckon/pull/30) ([BlackEdder](https://github.com/BlackEdder))
 
 ## [v0.3.9](https://github.com/cantino/reckon/tree/v0.3.9) (2014-02-20)
 
@@ -164,15 +233,12 @@
 - Date format [\#35](https://github.com/cantino/reckon/pull/35) ([BlackEdder](https://github.com/BlackEdder))
 - Added example from a french bank [\#34](https://github.com/cantino/reckon/pull/34) ([BlackEdder](https://github.com/BlackEdder))
 - Austrian example [\#33](https://github.com/cantino/reckon/pull/33) ([BlackEdder](https://github.com/BlackEdder))
-- Ing csv [\#30](https://github.com/cantino/reckon/pull/30) ([BlackEdder](https://github.com/BlackEdder))
 - Further improvements in nationwide csv handling [\#29](https://github.com/cantino/reckon/pull/29) ([BlackEdder](https://github.com/BlackEdder))
 - Refactor: Add money class [\#28](https://github.com/cantino/reckon/pull/28) ([BlackEdder](https://github.com/BlackEdder))
 - Initial split of CSVparser from class App [\#27](https://github.com/cantino/reckon/pull/27) ([BlackEdder](https://github.com/BlackEdder))
 - Updated version of pull request 24: Allow for other currency symbols while calculating money\_score [\#26](https://github.com/cantino/reckon/pull/26) ([BlackEdder](https://github.com/BlackEdder))
 - Change double column detection [\#23](https://github.com/cantino/reckon/pull/23) ([BlackEdder](https://github.com/BlackEdder))
-- Added optional argument to contains\_header to skip multiple header lines [\#22](https://github.com/cantino/reckon/pull/22) ([BlackEdder](https://github.com/BlackEdder))
 - Add a Bitdeli Badge to README [\#20](https://github.com/cantino/reckon/pull/20) ([bitdeli-chef](https://github.com/bitdeli-chef))
-- Update README to show latest usage info [\#19](https://github.com/cantino/reckon/pull/19) ([purcell](https://github.com/purcell))
 
 ## [v0.3.8](https://github.com/cantino/reckon/tree/v0.3.8) (2013-07-03)
 
@@ -189,6 +255,7 @@
 
 **Merged pull requests:**
 
+- Update README to show latest usage info [\#19](https://github.com/cantino/reckon/pull/19) ([purcell](https://github.com/purcell))
 - add support for spanish dates dd/mm/yyyy closes \#13 [\#14](https://github.com/cantino/reckon/pull/14) ([mauromorales](https://github.com/mauromorales))
 - fix issue showing true when parsing the currency option related to \#7 [\#12](https://github.com/cantino/reckon/pull/12) ([mauromorales](https://github.com/mauromorales))
 
@@ -198,6 +265,8 @@
 
 **Merged pull requests:**
 
+- Added optional argument to contains\_header to skip multiple header lines [\#22](https://github.com/cantino/reckon/pull/22) ([BlackEdder](https://github.com/BlackEdder))
+- Updated the sources to allow for custom curreny [\#11](https://github.com/cantino/reckon/pull/11) ([ghost](https://github.com/ghost))
 - Add --account option on the commandline [\#10](https://github.com/cantino/reckon/pull/10) ([copiousfreetime](https://github.com/copiousfreetime))
 
 ## [v0.3.6](https://github.com/cantino/reckon/tree/v0.3.6) (2013-04-30)
@@ -231,7 +300,6 @@
 
 **Merged pull requests:**
 
-- Updated the sources to allow for custom curreny [\#11](https://github.com/cantino/reckon/pull/11) ([ghost](https://github.com/ghost))
 - adds support for Nordea csv files [\#1](https://github.com/cantino/reckon/pull/1) ([x2q](https://github.com/x2q))
 
 ## [v0.3.3](https://github.com/cantino/reckon/tree/v0.3.3) (2013-01-13)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reckon (0.6.0)
+    reckon (0.7.2)
       chronic (>= 0.3.0)
       highline (>= 1.5.2)
       rchardet (>= 1.8.0)

data/README.md

@@ -1,6 +1,6 @@
 # Reckon
 
-[![Build Status](https://travis-ci.org/cantino/reckon.png?branch=master)](https://travis-ci.org/cantino/reckon)
+![Build Status](https://github.com/cantino/reckon/workflows/Build%20Status/badge.svg)
 
 Reckon automagically converts CSV files for use with the command-line accounting tool [Ledger](http://www.ledger-cli.org/).  It also helps you to select the correct accounts associated with the CSV data using Bayesian machine learning.
 
@@ -34,35 +34,42 @@ Learn more:
 
     Usage: Reckon.rb [options]
 
-
     -f, --file FILE                  The CSV file to parse
-    -a, --account name               The Ledger Account this file is for
+    -a, --account NAME               The Ledger Account this file is for
     -v, --[no-]verbose               Run verbosely
     -i, --inverse                    Use the negative of each amount
     -p, --print-table                Print out the parsed CSV in table form
     -o, --output-file FILE           The ledger file to append to
     -l, --learn-from FILE            An existing ledger file to learn accounts from
         --ignore-columns 1,2,5
-                                     Columns to ignore in the CSV file - the first column is column 1
+                                     Columns to ignore, starts from 1
+        --money-column 2
+                                     Column number of the money column, starts from 1
+        --raw-money
+                                     Don't format money column (for stocks)
+        --date-column 3
+                                     Column number of the date column, starts from 1
         --contains-header [N]
-                                     The first row of the CSV is a header and should be skipped. Optionally add the number of rows to skip.
+                                     Skip N header rows - default 1
         --csv-separator ','
-                                     Separator for parsing the CSV - default is comma.
+                                     CSV separator (default ',')
         --comma-separates-cents
-                                     Use comma instead of period to deliminate dollars from cents when parsing ($100,50 instead of $100.50)
+                                     Use comma to separate cents ($100,50 vs. $100.50)
         --encoding 'UTF-8'
-                                     Specify an encoding for the CSV file; not usually needed
-    -c, --currency '$'               Currency symbol to use, defaults to $ (£, EUR)
+                                     Specify an encoding for the CSV file
+    -c, --currency '$'               Currency symbol to use - default $ (ex £, EUR)
         --date-format '%d/%m/%Y'
                                      Force the date format (see Ruby DateTime strftime)
-    -u, --unattended                 Don't ask questions and guess all the accounts automatically. Used with --learn-from or --account-tokens options.
+    -u, --unattended                 Don't ask questions and guess all the accounts automatically. Use with --learn-from or --account-tokens options.
     -t, --account-tokens FILE        YAML file with manually-assigned tokens for each account (see README)
-        --default-into-account name
+        --default-into-account NAME
                                      Default into account
-        --default-outof-account name
+        --default-outof-account NAME
                                      Default 'out of' account
+        --fail-on-unknown-account
+                                     Fail on unmatched transactions.
         --suffixed
-                                     If --currency should be used as a suffix. Defaults to false.
+                                     Append currency symbol as a suffix.
     -h, --help                       Show this message
         --version                    Show version
 
@@ -77,6 +84,20 @@ To guess the accounts reckon can use an existing ledger file or a token file wit
 
 `reckon --unattended --account-tokens tokens.yaml -f bank.csv -o ledger.dat`
 
+In unattended mode, you can use STDIN to read your csv data, by specifying `-` as the argument to `-f`.
+
+`csv_file_generator | reckon --unattended -l 2010.dat -o ledger.dat -f -`
+
+### Account Tokens
+
+The account tokens file provides a way to teach reckon about what tokens are associated with an account.  As an example, this `tokens.yaml` file:
+
+    Expenses:
+      Bank:
+        - 'ING Direct Deposit'
+
+Would tokenize to 'ING', 'Direct' and 'Deposit'.  The matcher would then suggest matches to transactions that included those tokens. (ex 'Chase Direct Deposit')
+
 Here's an example of `tokens.yaml`:
 
 ```
@@ -96,21 +117,61 @@ Expenses:
   - '4433221100' # Your own account number
 ```
 
-If reckon can not guess the accounts it will use `Income:Unknown` or `Expenses:Unknown` names.
-You can override them with `--default_outof_account` and `--default_into_account` options.
+Reckon will use `Income:Unknown` or `Expenses:Unknown` if it can't match a transaction to an account.
+
+You can override these names with the `--default_outof_account` and `--default_into_account` options.
+
+### Substring Match
+
+If, in the above example, you'd prefer to match any transaction that contains the string 'ING Direct Deposit' you have to use a regex:
+
+    Expenses:
+      Bank:
+        - /ING Direct Deposit/
+
+## Contributing
+
+We encourage you to contribute to Reckon! Here is some information to help you.
+
+### Patches/Pull Requests Process
 
-## Note on Patches/Pull Requests
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version unintentionally.
+4. Commit, do not mess with rakefile, version, or history.
+   - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+### Integration Tests
+
+Reckon has integration test located in `spec/integration`.  These are integration and regression tests for reckon.
+
+Run all the tests:
+
+    ./spec/integration/test.sh
+
+Run a single test
+
+    ./spec/integration/test.sh chase/account_tokens_and_regex
+
+#### Add a new integration test
+
+Each test has it's own directory, which you can add any files you want, but the following files are required:
+
+- `test_args` - arguments to add to the reckon command to test against, can specify `--unattended`, `-f input.csv`, etc
+- `output.ledger` - the expected ledger file output
+
+If the result of running reckon with `test_args` does not match `output.ledger`, then the test fails.
+
+Most tests will specify `--unattended`, otherwise reckon prompts for keyboard input.
+
+The convention is to use `input.csv` as the input file, and `tokens.yml` as the tokens file, but it is not required.
 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
 
 ## Copyright
 
-Copyright (c) 2013 Andrew Cantino. See LICENSE for details.
+Copyright (c) 2013 Andrew Cantino (@cantino). See LICENSE for details.
 
 Thanks to @BlackEdder for many contributions!
+
+Currently maintained by @benprew. Thank you!

data/Rakefile

@@ -1,6 +1,22 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
+require 'English'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
+
+task :test_all do
+  puts "#{`ledger --version |head -n1`}"
+  puts "Running unit tests"
+  Rake::Task["spec"].invoke
+  puts "Running integration tests"
+  Rake::Task["integration_tests"].invoke
+end
+
+task :integration_tests do
+  cmd = 'prove -v ./spec/integration/test.sh'
+  raise 'Integration tests failed' unless system(cmd)
+end

data/bin/build-new-version.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -e
+
+VERSION=$1
+
+echo "Install github_changelog_generator"
+# gem install --user github_changelog_generator
+
+echo "Update 'lib/reckon/version.rb'"
+echo -e "module Reckon\n  VERSION=\"$VERSION\"\nend" > lib/reckon/version.rb
+echo "Run `bundle install` to build updated Gemfile.lock"
+bundle install
+echo "Run changelog generator (requires $TOKEN to be your github token)"
+github_changelog_generator -u cantino -p reckon -t $TOKEN --future-release v$VERSION
+echo "Commit changes"
+git add CHANGELOG.md lib/reckon/version.rb Gemfile.lock
+git commit -m "Release $VERSION"
+echo "Tag release"
+git tag v$VERSION
+echo "Build new gem"
+gem build reckon.gemspec
+echo "Push changes and tags"
+echo "git push && git push --tags"
+echo "Push new gem"
+echo "gem push reckon-$VERSION.gem"

data/bin/reckon

@@ -3,11 +3,19 @@
 require 'rubygems'
 require 'reckon'
 
-options = Reckon::App.parse_opts
+begin
+  options = Reckon::Options.parse
+rescue RuntimeError => e
+  puts("ERROR: #{e}")
+  exit(1)
+end
 reckon = Reckon::App.new(options)
 
 if options[:print_table]
   reckon.output_table
+  if options[:table_output_file]
+    File.open(options[:table_output_file], 'w') { |fh| reckon.output_table fh }
+  end
   exit
 end