reckon 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52cfe9cf67708213b2650008196a5177e9732285e320e7024d92cab9155aab5b
-  data.tar.gz: 82197ab9f98b310892471cc1cbe5b7d924b8fa57ca2b2cf3b4dbd2abc428f654
+  metadata.gz: f25c7df49774d944ebc40a73374ac593ebeac2e0b0a201e0d29f9c5ace2642e9
+  data.tar.gz: 27acd960b5210e7e0fb88c50acf35def784411d0b8112f0f0b8e6c4e2f5ab621
 SHA512:
-  metadata.gz: 5601c43ce038078a9ce825a05b7cd09f57953632e7abc9882f7025806a7c5a6d89f350c41b0b4964e9a3302090e07839064597f343c348e00ad514e8796852bd
-  data.tar.gz: 3de71c2b8ab50d203ceb9fe888d13c7bf68785f428322a7a865a21315aa781a809639d95cab5c0eeb96c678e871f83505b61bf0860b08ff0387d772e836a8488
+  metadata.gz: ddd5fe0ef08b2718e8083cdbd9695e936737b9ff6b258808787192496675f9a371c302e9936069019821f1c865a3280488aa4396185f1e0bf6e7d84b78dc5c0a
+  data.tar.gz: f611a48dad98a6a4764518dcb2e72969898d6dfbdaf5e06a77f36ab071429ac6f3bd0b0f51200dc8fbaaca913a95519a6bb38e6ec203dc0af61d861802d101f6

data/.ruby-version

@@ -1 +1 @@
-2.7
+2.0.0-p648

data/CHANGELOG.md

@@ -1,8 +1,24 @@
 # Changelog
 
-## [0.5.4](https://github.com/cantino/reckon/tree/0.5.4) (2020-06-04)
+## [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.3...0.5.4)
+[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:**
 
@@ -36,7 +52,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 +79,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))
@@ -182,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)
@@ -216,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,58 +1,25 @@
 PATH
   remote: .
   specs:
-    reckon (0.5.4)
+    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/
   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

@@ -114,13 +114,3 @@ You can override them with `--default_outof_account` and `--default_into_account
 Copyright (c) 2013 Andrew 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>`

data/lib/reckon.rb

@@ -4,9 +4,8 @@ require 'rubygems'
 require 'rchardet'
 require 'chronic'
 require 'csv'
-require 'highline/import'
+require 'highline'
 require 'optparse'
-require 'terminal-table'
 require 'time'
 require 'logger'
 

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
@@ -167,16 +157,93 @@ 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] }.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 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 )
+    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)
@@ -185,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
 
@@ -196,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
@@ -207,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)
@@ -321,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
@@ -332,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"

data/lib/reckon/version.rb

@@ -1,3 +1,3 @@
 module Reckon
-  VERSION = "0.5.4"
+  VERSION="0.6.0"
 end

data/reckon.gemspec

@@ -13,15 +13,13 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec", ">= 1.2.9"
   s.add_development_dependency "pry", ">= 0.12.2"
   s.add_development_dependency "rantly", "= 1.2.0"
-  s.add_development_dependency "github_changelog_generator"
   s.add_runtime_dependency "chronic", ">= 0.3.0"
   s.add_runtime_dependency "highline", ">= 1.5.2"
-  s.add_runtime_dependency "terminal-table", ">= 1.4.2"
   s.add_runtime_dependency "rchardet", ">= 1.8.0"
 end

data/spec/reckon/app_spec.rb

@@ -8,7 +8,7 @@ describe Reckon::App do
   context 'with chase csv input' do
     before do
       @chase = Reckon::App.new(string: BANK_CSV)
-      @chase.learn_from(BANK_LEDGER)
+      @chase.learn_from_ledger(BANK_LEDGER)
       @rows = []
       @chase.each_row_backwards { |row| @rows.push(row) }
     end
@@ -68,7 +68,7 @@ describe Reckon::App do
       end
 
       it 'should learn from a ledger file' do
-        chase.learn_from( BANK_LEDGER )
+        chase.learn_from_ledger(BANK_LEDGER)
         chase.walk_backwards
         output_file.string.scan('Expenses:Books').count.should == 1
       end

data/spec/reckon/ledger_parser_spec.rb

@@ -58,10 +58,10 @@ describe Reckon::LedgerParser do
         headers = %w[date code desc name currency amount type commend]
         safe_s = Shellwords.escape(s)
 
-        lp_csv = Reckon::LedgerParser.new(s, date_format: '%Y-%m-%d').to_csv.join("\n")
+        lp_csv = Reckon::LedgerParser.new(s, date_format: '%Y/%m/%d').to_csv.join("\n")
         actual = CSV.parse(lp_csv, headers: headers).map(&filter_format)
 
-        ledger_csv = `echo #{safe_s} | ledger csv --date-format '%Y-%m-%d' -f - `
+        ledger_csv = `echo #{safe_s} | ledger csv --date-format '%Y/%m/%d' -f - `
         expected = CSV.parse(ledger_csv.gsub('\"', '""'), headers: headers).map(&filter_format)
         expected.length.times do |i|
           expect(actual[i]).to eq(expected[i])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reckon
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Cantino
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -54,20 +54,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -96,20 +82,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.2
-- !ruby/object:Gem::Dependency
-  name: terminal-table
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rchardet
   requirement: !ruby/object:Gem::Requirement