reckon 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f25c7df49774d944ebc40a73374ac593ebeac2e0b0a201e0d29f9c5ace2642e9
-  data.tar.gz: 27acd960b5210e7e0fb88c50acf35def784411d0b8112f0f0b8e6c4e2f5ab621
+  metadata.gz: aebd4114b69fd94cc45e9cf425da57269ae80508b90f781fbbc5c96c6912b100
+  data.tar.gz: 0de1e3fb308bc2dad8cfa679056189092a4f07ece989b8e3b57c8acca100c77c
 SHA512:
-  metadata.gz: ddd5fe0ef08b2718e8083cdbd9695e936737b9ff6b258808787192496675f9a371c302e9936069019821f1c865a3280488aa4396185f1e0bf6e7d84b78dc5c0a
-  data.tar.gz: f611a48dad98a6a4764518dcb2e72969898d6dfbdaf5e06a77f36ab071429ac6f3bd0b0f51200dc8fbaaca913a95519a6bb38e6ec203dc0af61d861802d101f6
+  metadata.gz: c59e8ae6ecbf11534086bd9fc179ff5e8aa52066b8fb0cd5ddbce28b6a4a01b32659fdf51cdaa00403a86be2b3023e390184b76924fb13a6ed5288b8d637c8c0
+  data.tar.gz: 75a5921df0c427351768c803bbe019b3bdf7a12ec8f8d714779086a73ab850ea50b49708c9430ac823b97c0ef35493b5888b5980cdbfab4691cecc05b759224e

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,5 @@ private_tests
 
 ## Bundler
 vendor
+
+test.log

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,8 +1,28 @@
 # Changelog
 
-## [0.6.0](https://github.com/cantino/reckon/tree/0.6.0) (2020-09-03)
+## [0.6.1](https://github.com/cantino/reckon/tree/0.6.1) (2021-01-23)
 
-[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.4...0.6.0)
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.6.0...0.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:**
+
+- spaces in tokens [\#97](https://github.com/cantino/reckon/issues/97)
+- 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:**
 
@@ -198,6 +218,7 @@
 
 **Merged pull requests:**
 
+- 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 +252,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.6.1)
       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,9 +34,8 @@ 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
@@ -44,6 +43,12 @@ Learn more:
     -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
+        --money-column 2
+                                     Specify the money column instead of letting Reckon guess - the first column is column 1
+        --raw-money
+                                     Don't format money column (for stocks)
+        --date-column 3
+                                     Specify the date column instead of letting Reckon guess - the first column is column 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.
         --csv-separator ','
@@ -57,9 +62,9 @@ Learn more:
                                      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.
     -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
         --suffixed
                                      If --currency should be used as a suffix. Defaults to false.
@@ -77,6 +82,16 @@ 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`
 
+### 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 +111,62 @@ 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
+4. future version unintentionally.
+5. 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)
+6. Send me a pull request. Bonus points for topic branches.
 
-## Note on Patches/Pull Requests
+### 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
+  puts `./spec/integration/test.sh`
+  raise 'Integration tests failed' if $CHILD_STATUS.exitstatus != 0
+end

data/lib/reckon/app.rb

@@ -8,9 +8,10 @@ module Reckon
     attr_accessor :options, :seen, :csv_parser, :regexps, :matcher
     @@cli = HighLine.new
 
-    def initialize(options = {})
+    def initialize(opts = {})
+      self.options = opts
       LOGGER.level = Logger::INFO if options[:verbose]
-      self.options = options
+
       self.regexps = {}
       self.seen = Set.new
       self.options[:currency] ||= '$'
@@ -157,7 +158,7 @@ module Reckon
                   :money => @csv_parser.money_for(index),
                   :description => @csv_parser.description_for(index) }
       end
-      rows.sort_by { |n| n[:date] }.each { |row| yield row }
+      rows.sort_by { |n| [n[:date], -n[:money], n[:description]] }.each { |row| yield row }
     end
 
     def print_transaction(rows)
@@ -252,7 +253,7 @@ module Reckon
     end
 
     def ledger_format(row, line1, line2)
-      out = "#{row[:pretty_date]}\t#{row[:description]}\t; #{row[:note]}\n"
+      out = "#{row[:pretty_date]}\t#{row[:description]}#{row[:note] ? "\t; " + row[:note]: ""}\n"
       out += "\t#{line1.first}\t\t\t#{line1.last}\n"
       out += "\t#{line2.first}\t\t\t#{line2.last}\n\n"
       out
@@ -327,6 +328,10 @@ module Reckon
           options[:money_column] = column_number
         end
 
+        opts.on("", "--raw-money", "Don't format money column (for stocks)") do |n|
+          options[:raw] = n
+        end
+
         opts.on("", "--date-column 3", Integer, "Specify the date column instead of letting Reckon guess - the first column is column 1") do |column_number|
           options[:date_column] = column_number
         end
@@ -399,7 +404,7 @@ module Reckon
       end
 
       unless options[:bank_account]
-        fail "Please specify --account for the unattended mode" if options[:unattended]
+        fail "Please specify --account in unattended mode" if options[:unattended]
 
         options[:bank_account] = @@cli.ask("What is the account name of this bank account in Ledger? ") do |q|
           q.readline = true

data/lib/reckon/csv_parser.rb

@@ -89,12 +89,7 @@ module Reckon
           money_score += Money::likelihood( entry )
           possible_neg_money_count += 1 if entry =~ /^\$?[\-\(]\$?\d+/
           possible_pos_money_count += 1 if entry =~ /^\+?\$?\+?\d+/
-          date_score += 10 if entry =~ /\b(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)/i
-          date_score += 5 if entry =~ /^[\-\/\.\d:\[\]]+$/
-          date_score += entry.gsub(/[^\-\/\.\d:\[\]]/, '').length if entry.gsub(/[^\-\/\.\d:\[\]]/, '').length > 3
-          date_score -= entry.gsub(/[\-\/\.\d:\[\]]/, '').length
-          date_score += 30 if entry =~ /^\d+[:\/\.-]\d+[:\/\.-]\d+([ :]\d+[:\/\.]\d+)?$/
-          date_score += 10 if entry =~ /^\d+\[\d+:GMT\]$/i
+          date_score += DateColumn.likelihood(entry)
 
           # Try to determine if this is a balance column
           entry_as_num = entry.gsub(/[^\-\d\.]/, '').to_f
@@ -168,7 +163,7 @@ module Reckon
       results = evaluate_columns(columns)
 
       if options[:money_column]
-        self.money_column_indices = [ options[:money_column] - 1 ]
+        self.money_column_indices = [options[:money_column] - 1]
       else
         self.money_column_indices = results.select { |n| n[:is_money_column] }.map { |n| n[:index] }
         if self.money_column_indices.length == 1

data/lib/reckon/date_column.rb

@@ -56,5 +56,15 @@ module Reckon
       date.iso8601
     end
 
+    def self.likelihood(entry)
+      date_score = 0
+      date_score += 10 if entry =~ /\b(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)/i
+      date_score += 5 if entry =~ /^[\-\/\.\d:\[\]]+$/
+      date_score += entry.gsub(/[^\-\/\.\d:\[\]]/, '').length if entry.gsub(/[^\-\/\.\d:\[\]]/, '').length > 3
+      date_score -= entry.gsub(/[\-\/\.\d:\[\]]/, '').length
+      date_score += 30 if entry =~ /^\d+[:\/\.-]\d+[:\/\.-]\d+([ :]\d+[:\/\.]\d+)?$/
+      date_score += 10 if entry =~ /^\d+\[\d+:GMT\]$/i
+      return date_score
+    end
   end
 end

data/lib/reckon/money.rb

@@ -5,12 +5,13 @@ module Reckon
   class Money
     include Comparable
     attr_accessor :amount, :currency, :suffixed
-    def initialize( amount, options = {} )
-      if options[:inverse]
-        @amount = -1*amount.to_f
-      else
-        @amount = amount.to_f
-      end
+    def initialize(amount, options = {})
+      @options = options
+      @amount_raw = amount
+      @raw = options[:raw]
+
+      @amount = parse(amount, options)
+      @amount = -@amount if options[:inverse]
       @currency = options[:currency] || "$"
       @suffixed = options[:suffixed]
     end
@@ -19,11 +20,19 @@ module Reckon
       return @amount
     end
 
+    def to_s
+      return @options[:raw] ? "#{@amount_raw} | #{@amount}" : @amount
+    end
+
+    # unary minus
+    # ex
+    # m = Money.new
+    # -m
     def -@
-      Money.new( -@amount, :currency => @currency, :suffixed => @suffixed )
+      Money.new(-@amount, :currency => @currency, :suffixed => @suffixed)
     end
 
-    def <=>( mon )
+    def <=>(mon)
       other_amount = mon.to_f
       if @amount < other_amount
         -1
@@ -34,7 +43,13 @@ module Reckon
       end
     end
 
-    def pretty( negate = false )
+    def pretty(negate = false)
+      if @raw
+        return @amount_raw unless negate
+
+        return @amount_raw[0] == '-' ? @amount_raw[1..-1] : "-#{@amount_raw}"
+      end
+
       if @suffixed
         (@amount >= 0 ? " " : "") + sprintf("%0.2f #{@currency}", @amount * (negate ? -1 : 1))
       else
@@ -42,34 +57,20 @@ module Reckon
       end
     end
 
-    def Money::from_s( value, options = {} )
+    def parse(value, options = {})
+      value = value.to_s
       # Empty string is treated as money with value 0
-      return Money.new( 0.00, options ) if value.empty?
-
-      # Remove 1000 separaters and replace , with . if comma_separates_cents
-      # 1.000,00 -> 1000.00
-      value = value.gsub(/\./, '').gsub(/,/, '.') if options[:comma_separates_cents]
-      value = value.gsub(/,/, '')
-
-      money_format_regex = /^(.*?)(\d+\.\d\d)/ # Money has two decimal precision
-      any_number_regex = /^(.*?)([\d\.]+)/
-
-      # Prefer matching the money_format, match any number otherwise
-      m = value.match( money_format_regex ) ||
-        value.match( any_number_regex )
-      if m
-        amount = m[2].to_f
-        # Check whether the money had a - or (, which indicates negative amounts
-        if (m[1].match( /^[\(-]/ ) || m[1].match( /-$/  ))
-          amount *= -1
-        end
-        return Money.new( amount, options )
-      else
-        return nil
-      end
+      return value.to_f if value.to_s.empty?
+
+      invert = value.match(/^\(.*\)$/)
+      value = value.gsub(/[^0-9,.-]/, '')
+      value = value.tr('.', '').tr(',', '.') if options[:comma_separates_cents]
+      value = value.tr(',', '')
+      value = value.to_f
+      return invert ? -value : value
     end
 
-    def Money::likelihood( entry )
+    def Money::likelihood(entry)
       money_score = 0
       # digits separated by , or . with no more than 2 trailing digits
       money_score += 40 if entry.match(/\d+[,.]\d{2}[^\d]*$/)
@@ -83,31 +84,30 @@ module Reckon
   end
 
   class MoneyColumn < Array
-    def initialize( arr = [], options = {} )
-      arr.each { |str| self.push( Money.from_s( str, options ) ) }
+    def initialize(arr = [], options = {})
+      arr.each { |str| push(Money.new(str, options)) }
     end
 
     def positive?
-      self.each do |money|
-        return false if money < 0 if money
+      each do |money|
+        return false if money && money < 0
       end
       true
     end
 
-    def merge!( other_column )
+    def merge!(other_column)
       invert = false
-      invert = true if self.positive? && other_column.positive?
-      self.each_with_index do |mon, i|
+      invert = true if positive? && other_column.positive?
+      each_with_index do |mon, i|
         other = other_column[i]
-        return nil if (!mon || !other)
-        if mon != 0.00 && other == 0.0
-          if invert
-            self[i]= -mon
-          end
-        elsif mon == 0.00 && other != 0.00
+        return nil if !mon || !other
+
+        if mon != 0.0 && other == 0.0
+          self[i] = -mon if invert
+        elsif mon == 0.0 && other != 0.0
           self[i] = other
         else
-          return nil
+          self[i] = Money.new(0)
         end
       end
       self