reckon 0.5.4 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cfe9cf67708213b2650008196a5177e9732285e320e7024d92cab9155aab5b
-  data.tar.gz: 82197ab9f98b310892471cc1cbe5b7d924b8fa57ca2b2cf3b4dbd2abc428f654
+  metadata.gz: 13ec00f6b1277d98d6df6264af61020310ab5bf61197412a116a2f61901e6214
+  data.tar.gz: cf1b1e21a64fac57a5796b64f53da971a48c4bb3f439be94fd847441c5b36a0f
 SHA512:
-  metadata.gz: 5601c43ce038078a9ce825a05b7cd09f57953632e7abc9882f7025806a7c5a6d89f350c41b0b4964e9a3302090e07839064597f343c348e00ad514e8796852bd
-  data.tar.gz: 3de71c2b8ab50d203ceb9fe888d13c7bf68785f428322a7a865a21315aa781a809639d95cab5c0eeb96c678e871f83505b61bf0860b08ff0387d772e836a8488
+  metadata.gz: 450fb569cf8509563edd5fb36239965b9cd29b28d544399bcc10cf510a146d68fb56c3dd1737a1904cd7f23ab3453128d522fb07159068bbc6ed2d44cb0fe1d6
+  data.tar.gz: 461bade5035f16c278131102df52b91e39a365b18c3e73875730616b5489f07f7c0528094da13a06558791b4238d1d6cc495452b14c917b15eef5eea2719e909

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: Install packages
+      run: sudo apt-get -y install ledger hledger
+    - name: Install bundler
+      run: sudo gem install -v 1.17.3 bundler
+    - 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 automatically
+    - 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.7
+3.0.0

data/CHANGELOG.md

@@ -1,8 +1,77 @@
 # Changelog
 
-## [0.5.4](https://github.com/cantino/reckon/tree/0.5.4) (2020-06-04)
+## [v0.7.1](https://github.com/cantino/reckon/tree/v0.7.1) (2021-02-06)
 
-[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.3...0.5.4)
+[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:**
+
+- \[BUG\] Reckon appears not to be parsing ISO standard date yyyy-mm-dd? [\#85](https://github.com/cantino/reckon/issues/85)
+
+**Closed issues:**
+
+- duplicate detection [\#16](https://github.com/cantino/reckon/issues/16)
+
+**Merged pull requests:**
+
+- Add ability to add note to transaction when entering it [\#89](https://github.com/cantino/reckon/pull/89) ([benprew](https://github.com/benprew))
+
+## [v0.5.4](https://github.com/cantino/reckon/tree/v0.5.4) (2020-06-05)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.3...v0.5.4)
 
 **Fixed bugs:**
 
@@ -36,7 +105,7 @@
 
 **Merged pull requests:**
 
-- Fix bugs in ledger file parsing.  Fixes \#56. [\#81](https://github.com/cantino/reckon/pull/81) ([benprew](https://github.com/benprew))
+- guard against rows that don't parse dates [\#82](https://github.com/cantino/reckon/pull/82) ([benprew](https://github.com/benprew))
 
 ## [v0.5.0](https://github.com/cantino/reckon/tree/v0.5.0) (2020-02-19)
 
@@ -63,7 +132,7 @@
 
 **Merged pull requests:**
 
-- guard against rows that don't parse dates [\#82](https://github.com/cantino/reckon/pull/82) ([benprew](https://github.com/benprew))
+- 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))

data/Gemfile.lock

@@ -1,58 +1,25 @@
 PATH
   remote: .
   specs:
-    reckon (0.5.4)
+    reckon (0.7.1)
       chronic (>= 0.3.0)
       highline (>= 1.5.2)
       rchardet (>= 1.8.0)
-      terminal-table (>= 1.4.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
     chronic (0.10.2)
     coderay (1.1.2)
-    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.2.0)
-      faraday (>= 0.8)
-    github_changelog_generator (1.15.2)
-      activesupport
-      faraday-http-cache
-      multi_json
-      octokit (~> 4.6)
-      rainbow (>= 2.2.1)
-      rake (>= 10.0)
-      retriable (~> 3.0)
     highline (2.0.3)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.14.1)
-    multi_json (1.14.1)
-    multipart-post (2.1.1)
-    octokit (4.18.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (4.0.5)
-    rainbow (3.0.0)
     rake (12.3.3)
     rantly (1.2.0)
     rchardet (1.8.0)
-    retriable (3.1.2)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -66,22 +33,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    sawyer (0.8.2)
-      addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github_changelog_generator
   pry (>= 0.12.2)
   rake
   rantly (= 1.2.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,31 +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
+
+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.
 
-## Note on Patches/Pull Requests
+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!
 
-## Building a new version of reckon
-1. Update reckon/version.rb
-2. Run `bundle install` to build updated Gemfile.lock
-3. Run `bundle exec github_changelog_generator -u cantino -p reckon -t $TOKEN --future-release $VERSION`
-3. Commit changes with: 'Release $VERSION'
-4. Tag release `git tag v$VERSION`
-5. `git push && git push --tags`
-6. Build new gem `gem build reckon.gemspec`
-7. Push new gem `gem push <gemname>`
+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
+  puts `./spec/integration/test.sh`
+  raise 'Integration tests failed' if $CHILD_STATUS.exitstatus != 0
+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"