reckon 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b58a745c730c0dfaf022a98c19dfaf8568c0b3091548d70c9202f8f7c0d78ada
-  data.tar.gz: 030d2036524a19c5eff981608133e8aac15f185b57a891e91a6f1fdabd3796c7
+  metadata.gz: f25c7df49774d944ebc40a73374ac593ebeac2e0b0a201e0d29f9c5ace2642e9
+  data.tar.gz: 27acd960b5210e7e0fb88c50acf35def784411d0b8112f0f0b8e6c4e2f5ab621
 SHA512:
-  metadata.gz: 1daf76a19078f1707e847a7ac54aad5836ee3d49ce9c2f612bfefeb86f8c1bf9c9d1f97b7bbecb309f9f44f8097f8f2dbe0d6b6062bc376a62fc88f45bab1dfc
-  data.tar.gz: 4784ac871dbdb6160dc53ef8a7f5d69f31ccc7f7f7ea876b97bf60941abb2d13a968f5229747dd74d0b574ecc12326485e1eaba7ea368a91162d36d3ef4f9f86
+  metadata.gz: ddd5fe0ef08b2718e8083cdbd9695e936737b9ff6b258808787192496675f9a371c302e9936069019821f1c865a3280488aa4396185f1e0bf6e7d84b78dc5c0a
+  data.tar.gz: f611a48dad98a6a4764518dcb2e72969898d6dfbdaf5e06a77f36ab071429ac6f3bd0b0f51200dc8fbaaca913a95519a6bb38e6ec203dc0af61d861802d101f6

data/.gitignore

@@ -25,3 +25,6 @@ pkg
 .idea
 reckon_local
 private_tests
+
+## Bundler
+vendor

data/.ruby-version

@@ -1 +1 @@
-2.5
+2.0.0-p648

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## [0.6.0](https://github.com/cantino/reckon/tree/0.6.0) (2020-09-03)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.4...0.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:**
+
+- order of transactions [\#88](https://github.com/cantino/reckon/issues/88)
+- Is reckon failing to handle comments when learning? [\#87](https://github.com/cantino/reckon/issues/87)
+
+## [v0.5.3](https://github.com/cantino/reckon/tree/v0.5.3) (2020-05-02)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.2...v0.5.3)
+
+**Closed issues:**
+
+- \[FEATURE REQUEST\] Ask for currency of Account and output in output file in standard format of xxxx TLA for currency [\#84](https://github.com/cantino/reckon/issues/84)
+
+## [v0.5.2](https://github.com/cantino/reckon/tree/v0.5.2) (2020-03-07)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.1...v0.5.2)
+
+**Closed issues:**
+
+- \[Bug\]? Reckon fails to run on ruby 2.7.0 on Catalina  [\#83](https://github.com/cantino/reckon/issues/83)
+- --account-tokens issue [\#51](https://github.com/cantino/reckon/issues/51)
+
+## [v0.5.1](https://github.com/cantino/reckon/tree/v0.5.1) (2020-02-25)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.5.0...v0.5.1)
+
+**Closed issues:**
+
+- Error Importing [\#64](https://github.com/cantino/reckon/issues/64)
+
+**Merged pull requests:**
+
+- 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)
 
 [Full Changelog](https://github.com/cantino/reckon/compare/v0.4.4...v0.5.0)
@@ -144,7 +198,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))
 - 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)
@@ -178,6 +231,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))
 - 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,11 +1,10 @@
 PATH
   remote: .
   specs:
-    reckon (0.5.0)
+    reckon (0.6.0)
       chronic (>= 0.3.0)
       highline (>= 1.5.2)
       rchardet (>= 1.8.0)
-      terminal-table (>= 1.4.2)
 
 GEM
   remote: http://rubygems.org/
@@ -34,9 +33,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,7 +8,7 @@ Reckon automagically converts CSV files for use with the command-line accounting
 
 Assuming you have Ruby and [Rubygems](http://rubygems.org/pages/download) installed on your system, simply run
 
-    (sudo) gem install reckon
+    gem install --user reckon
 
 ## Example Usage
 

data/lib/reckon.rb

@@ -4,18 +4,16 @@ require 'rubygems'
 require 'rchardet'
 require 'chronic'
 require 'csv'
-require 'highline/import'
+require 'highline'
 require 'optparse'
-require 'terminal-table'
 require 'time'
 require 'logger'
 
-LOGGER = Logger.new(STDOUT)
-LOGGER.level = Logger::ERROR
-
 require_relative 'reckon/version'
+require_relative 'reckon/logger'
 require_relative 'reckon/cosine_similarity'
-require File.expand_path(File.join(File.dirname(__FILE__), "reckon", "app"))
-require File.expand_path(File.join(File.dirname(__FILE__), "reckon", "ledger_parser"))
-require File.expand_path(File.join(File.dirname(__FILE__), "reckon", "csv_parser"))
-require File.expand_path(File.join(File.dirname(__FILE__), "reckon", "money"))
+require_relative 'reckon/date_column'
+require_relative 'reckon/money'
+require_relative 'reckon/ledger_parser'
+require_relative 'reckon/csv_parser'
+require_relative 'reckon/app'

data/lib/reckon/app.rb

@@ -1,18 +1,19 @@
 # coding: utf-8
+
 require 'pp'
 require 'yaml'
 
 module Reckon
   class App
     attr_accessor :options, :seen, :csv_parser, :regexps, :matcher
+    @@cli = HighLine.new
 
     def initialize(options = {})
       LOGGER.level = Logger::INFO if options[:verbose]
       self.options = options
       self.regexps = {}
-      self.seen = {}
+      self.seen = Set.new
       self.options[:currency] ||= '$'
-      options[:string] = File.read(options[:file]) unless options[:string]
       @csv_parser = CSVParser.new( options )
       @matcher = CosineSimilarity.new(options)
       learn!
@@ -20,22 +21,19 @@ module Reckon
 
     def interactive_output(str)
       return if options[:unattended]
+
       puts str
     end
 
     def learn!
       learn_from_account_tokens(options[:account_tokens_file])
-
-      ledger_file = options[:existing_ledger_file]
-      return unless ledger_file
-      fail "#{ledger_file} doesn't exist!" unless File.exists?(ledger_file)
-      learn_from(File.read(ledger_file))
+      learn_from_ledger_file(options[:existing_ledger_file])
     end
 
     def learn_from_account_tokens(filename)
       return unless filename
 
-      fail "#{filename} doesn't exist!" unless File.exists?(filename)
+      raise "#{filename} doesn't exist!" unless File.exist?(filename)
 
       extract_account_tokens(YAML.load_file(filename)).each do |account, tokens|
         tokens.each do |t|
@@ -48,14 +46,27 @@ module Reckon
       end
     end
 
-    def learn_from(ledger)
+    def learn_from_ledger_file(ledger_file)
+      return unless ledger_file
+
+      raise "#{ledger_file} doesn't exist!" unless File.exist?(ledger_file)
+
+      learn_from_ledger(File.read(ledger_file))
+    end
+
+    def learn_from_ledger(ledger)
+      LOGGER.info "learning from #{ledger}"
       LedgerParser.new(ledger).entries.each do |entry|
         entry[:accounts].each do |account|
           str = [entry[:desc], account[:amount]].join(" ")
-          @matcher.add_document(account[:name], str) unless account[:name] == options[:bank_account]
+          if account[:name] != options[:bank_account]
+            LOGGER.info "adding document #{account[:name]} #{str}"
+            @matcher.add_document(account[:name], str)
+          end
           pretty_date = entry[:date].iso8601
-          seen[pretty_date] ||= {}
-          seen[pretty_date][@csv_parser.pretty_money(account[:amount])] = true
+          if account[:name] == options[:bank_account]
+            seen << seen_key(pretty_date, @csv_parser.pretty_money(account[:amount]))
+          end
         end
       end
     end
@@ -91,9 +102,10 @@ module Reckon
     end
 
     def walk_backwards
+      cmd_options = "[account]/[q]uit/[s]kip/[n]ote/[d]escription"
       seen_anything_new = false
       each_row_backwards do |row|
-        interactive_output Terminal::Table.new(:rows => [ [ row[:pretty_date], row[:pretty_money], row[:description] ] ])
+        print_transaction([row])
 
         if already_seen?(row)
           interactive_output "NOTE: This row is very similar to a previous one!"
@@ -105,50 +117,28 @@ module Reckon
           seen_anything_new = true
         end
 
-        possible_answers = suggest(row)
-
-        ledger = if row[:money] > 0
-          if options[:unattended]
-            out_of_account = possible_answers.first || options[:default_outof_account] || 'Income:Unknown'
-          else
-            out_of_account = ask("Which account provided this income? ([account]/[q]uit/[s]kip) ") { |q|
-              q.completion = possible_answers
-              q.readline = true
-              q.default = possible_answers.first
-            }
-          end
-
-          finish if out_of_account == "quit" || out_of_account == "q"
-          if out_of_account == "skip" || out_of_account == "s"
-            interactive_output "Skipping"
-            next
-          end
-
-          ledger_format( row,
-                         [options[:bank_account], row[:pretty_money]],
-                         [out_of_account, row[:pretty_money_negated]] )
+        if row[:money] > 0
+          # out_of_account
+          answer = ask_account_question("Which account provided this income? (#{cmd_options})", row)
+          line1 = [options[:bank_account], row[:pretty_money]]
+          line2 = [answer, ""]
         else
-          if options[:unattended]
-            into_account = possible_answers.first || options[:default_into_account] || 'Expenses:Unknown'
-          else
-            into_account = ask("To which account did this money go? ([account]/[q]uit/[s]kip) ") { |q|
-              q.completion = possible_answers
-              q.readline = true
-              q.default = possible_answers.first
-            }
-          end
-          finish if into_account == "quit" || into_account == 'q'
-          if into_account == "skip" || into_account == 's'
-            interactive_output "Skipping"
-            next
-          end
+          # into_account
+          answer = ask_account_question("To which account did this money go? (#{cmd_options})", row)
+#          line1 = [answer, row[:pretty_money_negated]]
+          line1 = [answer, ""]
+          line2 = [options[:bank_account], row[:pretty_money]]
+        end
 
-          ledger_format( row,
-                         [into_account, row[:pretty_money_negated]],
-                         [options[:bank_account], row[:pretty_money]] )
+        finish if %w[quit q].include?(answer)
+        if %w[skip s].include?(answer)
+          interactive_output "Skipping"
+          next
         end
 
-        learn_from(ledger) unless options[:account_tokens_file]
+        ledger = ledger_format(row, line1, line2)
+        LOGGER.info "ledger line: #{ledger}"
+        learn_from_ledger(ledger) unless options[:account_tokens_file]
         output(ledger)
       end
     end
@@ -156,6 +146,10 @@ module Reckon
     def each_row_backwards
       rows = []
       (0...@csv_parser.columns.first.length).to_a.each do |index|
+        if @csv_parser.date_for(index).nil?
+          LOGGER.warn("Skipping row: '#{@csv_parser.row(index)}' that doesn't have a valid date")
+          next
+        end
         rows << { :date => @csv_parser.date_for(index),
                   :pretty_date => @csv_parser.pretty_date_for(index),
                   :pretty_money => @csv_parser.pretty_money_for(index),
@@ -163,18 +157,93 @@ module Reckon
                   :money => @csv_parser.money_for(index),
                   :description => @csv_parser.description_for(index) }
       end
-      rows.sort { |a, b| a[:date] <=> b[:date] }.each do |row|
-        yield row
+      rows.sort_by { |n| n[:date] }.each { |row| yield row }
+    end
+
+    def print_transaction(rows)
+      str = "\n"
+      header = %w[Date Amount Description Note]
+      maxes = header.map(&:length)
+
+      rows = rows.map { |r| [r[:pretty_date], r[:pretty_money], r[:description], r[:note]] }
+
+      rows.each do |r|
+        r.length.times { |i| l = r[i] ? r[i].length : 0; maxes[i] = l if maxes[i] < l }
       end
+
+      header.each_with_index do |n, i|
+        str += " #{n.center(maxes[i])} |"
+      end
+      str += "\n"
+
+      rows.each do |row|
+        row.each_with_index do |_, i|
+          just = maxes[i]
+          str += sprintf(" %#{just}s |", row[i])
+        end
+        str += "\n"
+      end
+
+      interactive_output str
+    end
+
+    def ask_account_question(msg, row)
+      possible_answers = suggest(row)
+      LOGGER.info "possible_answers===> #{possible_answers.inspect}"
+
+      if options[:unattended]
+        default = if row[:pretty_money][0] == '-'
+                    options[:default_into_account] || 'Expenses:Unknown'
+                  else
+                    options[:default_outof_account] || 'Income:Unknown'
+                  end
+        return possible_answers[0] || default
+      end
+
+      answer = @@cli.ask(msg) do |q|
+        q.completion = possible_answers
+        q.readline = true
+        q.default = possible_answers.first
+      end
+
+      # if answer isn't n/note/d/description, must be an account name, or skip, or quit
+      return answer unless %w[n note d description].include?(answer)
+
+      add_description(row) if %w[d description].include?(answer)
+      add_note(row) if %w[n note].include?(answer)
+
+      print_transaction([row])
+      # give user a chance to set account name or retry description
+      return ask_account_question(msg, row)
     end
 
-    def most_specific_regexp_match( row )
+    def add_description(row)
+      desc_answer = @@cli.ask("Enter a new description for this transaction (empty line aborts)\n") do |q|
+        q.overwrite = true
+        q.readline = true
+        q.default = row[:description]
+      end
+
+      row[:description] = desc_answer unless desc_answer.empty?
+    end
+
+    def add_note(row)
+      desc_answer = @@cli.ask("Enter a new note for this transaction (empty line aborts)\n") do |q|
+        q.overwrite = true
+        q.readline = true
+        q.default = row[:note]
+      end
+
+      row[:note] = desc_answer unless desc_answer.empty?
+    end
+
+    def most_specific_regexp_match(row)
       matches = regexps.map { |regexp, account|
         if match = regexp.match(row[:description])
           [account, match[0]]
         end
       }.compact
-      matches.sort_by! { |account, matched_text| matched_text.length }.map(&:first)
+      matches.sort_by! { |_account, matched_text| matched_text.length }.map(&:first)
     end
 
     def suggest(row)
@@ -183,9 +252,9 @@ module Reckon
     end
 
     def ledger_format(row, line1, line2)
-      out = "#{row[:pretty_date]}\t#{row[:description]}\n"
-      out += "\t#{line1.first}\t\t\t\t\t#{line1.last}\n"
-      out += "\t#{line2.first}\t\t\t\t\t#{line2.last}\n\n"
+      out = "#{row[:pretty_date]}\t#{row[:description]}\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
     end
 
@@ -194,8 +263,12 @@ module Reckon
       options[:output_file].flush
     end
 
+    def seen_key(date, amount)
+      return [date, amount].join("|")
+    end
+
     def already_seen?(row)
-      seen[row[:pretty_date]] && seen[row[:pretty_date]][row[:pretty_money]]
+      seen.include?(seen_key(row[:pretty_date], row[:pretty_money]))
     end
 
     def finish
@@ -205,13 +278,11 @@ module Reckon
     end
 
     def output_table
-      output = Terminal::Table.new do |t|
-        t.headings = 'Date', 'Amount', 'Description'
-        each_row_backwards do |row|
-          t << [ row[:pretty_date], row[:pretty_money], row[:description] ]
-        end
+      rows = []
+      each_row_backwards do |row|
+        rows << row
       end
-      interactive_output output
+      print_transaction(rows)
     end
 
     def self.parse_opts(args = ARGV)
@@ -319,7 +390,7 @@ module Reckon
       end
 
       unless options[:file]
-        options[:file] = ask("What CSV file should I parse? ")
+        options[:file] = @@cli.ask("What CSV file should I parse? ")
         unless options[:file].length > 0
           puts "\nYou must provide a CSV file to parse.\n"
           puts parser
@@ -330,7 +401,7 @@ module Reckon
       unless options[:bank_account]
         fail "Please specify --account for the unattended mode" if options[:unattended]
 
-        options[:bank_account] = ask("What is the account name of this bank account in Ledger? ") do |q|
+        options[:bank_account] = @@cli.ask("What is the account name of this bank account in Ledger? ") do |q|
           q.readline = true
           q.validate = /^.{2,}$/
           q.default = "Assets:Bank:Checking"