reckon 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08cdfad096b04db11f671775c0119fcecefa7db46134f1c43677e949628498db'
-  data.tar.gz: 5ed2722b2843a5147faabdd82b0027fe590ff9dd66000100e756fad6de13a116
+  metadata.gz: 03c20b48d4333969c8304a5bb9a3c01fc6053050ab9146329ce14ae6a9886b38
+  data.tar.gz: 27a2ce4e8db5c7818cc4cefb19f180a7c727190f0a990403f565fad503e749a9
 SHA512:
-  metadata.gz: 7ebe28c482f091424d405efa1dc4b94cdc76022b114ce6f0db22a96e3ec6104a6e1efecec833af981f9c97f4c705cbbbd7f791403b5b669452abccd2caf295c8
-  data.tar.gz: 7af0ef7c71bcca9b189d23939ebeb93eedbe0875373818419d878461c33035a5e92359204c939ac3d8933935ad29b8a9cec319ddb84ea13626e22f51897f2fea
+  metadata.gz: 2f569b3d5cf4038714065a6d184d6c07f57d10598e5efc610eeb9919e8b18c65aff5e5329ab89a9ed30f72cabce9d11f5645af4d0df3bda6d05ad9afd988f7e7
+  data.tar.gz: 1783a63ba138c2b87a0756d6b9bcfbce068daf977e582a4c920a37ff50358328f8514f308dbbf932ef5cc4111e9e52dadfaed5876b9d30f4759d4a1eb31299fa

data/.github/workflows/ruby.yml

@@ -31,7 +31,7 @@ jobs:
     - name: Update package
       run: sudo apt-get update
     - name: Install packages
-      run: sudo apt-get -y install ledger hledger expect
+      run: sudo apt-get -y install ledger hledger
     - 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):

data/.gitignore

@@ -29,6 +29,11 @@ private_tests
 ## Bundler
 vendor
 .bundle
+# binstubs
+exec/
+
+# Don't commit gem files
+*.gem
 
 test.log
 test_log.txt

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Layout/LineLength:
+  Max: 88
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: False
+
+Metrics/MethodLength:
+  Enabled: False
+
+Metrics/AbcSize:
+  Enabled: False
+
+Style/NumericPredicate:
+  Enabled: False

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [v0.9.1](https://github.com/cantino/reckon/tree/v0.9.1) (2023-03-19)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.9.0...v0.9.1)
+
+**Closed issues:**
+
+- More than one column support [\#120](https://github.com/cantino/reckon/issues/120)
+- Beancount support [\#119](https://github.com/cantino/reckon/issues/119)
+- Problem with importing CSV [\#60](https://github.com/cantino/reckon/issues/60)
+
+## [v0.9.0](https://github.com/cantino/reckon/tree/v0.9.0) (2023-02-23)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.9.0-beta...v0.9.0)
+
+**Merged pull requests:**
+
+- Add support for multiple money columns [\#118](https://github.com/cantino/reckon/pull/118) ([oskarth](https://github.com/oskarth))
+
+## [v0.9.0-beta](https://github.com/cantino/reckon/tree/v0.9.0-beta) (2023-02-21)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.8.1...v0.9.0-beta)
+
 ## [v0.8.1](https://github.com/cantino/reckon/tree/v0.8.1) (2022-07-02)
 
 [Full Changelog](https://github.com/cantino/reckon/compare/v0.8.0...v0.8.1)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reckon (0.8.1)
+    reckon (0.9.1)
       chronic (>= 0.3.0)
       highline (>= 1.5.2)
       matrix (>= 0.4.2)
@@ -11,30 +11,30 @@ GEM
   remote: http://rubygems.org/
   specs:
     chronic (0.10.2)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    highline (2.0.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    highline (2.1.0)
     matrix (0.4.2)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (12.3.3)
+    method_source (1.0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
     rantly (1.2.0)
     rchardet (1.8.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
 
 PLATFORMS
   ruby
@@ -47,4 +47,4 @@ DEPENDENCIES
   rspec (>= 1.2.9)
 
 BUNDLED WITH
-   1.17.3
+   2.3.5

data/README.md

@@ -45,6 +45,8 @@ Learn more:
                                      Columns to ignore, starts from 1
         --money-column 2
                                      Column number of the money column, starts from 1
+        --money-columns 2,3
+                                     Column number of the money columns, starts from 1 (1 or 2 columns)
         --raw-money
                                      Don't format money column (for stocks)
         --date-column 3

data/Rakefile

@@ -13,10 +13,10 @@ task :test_all do
   puts "Running unit tests"
   Rake::Task["spec"].invoke
   puts "Running integration tests"
-  Rake::Task["integration_tests"].invoke
+  Rake::Task["test_integration"].invoke
 end
 
-task :integration_tests do
+task :test_integration do
   cmd = 'prove -v ./spec/integration/test.sh'
   raise 'Integration tests failed' unless system(cmd)
 end

data/bin/build-new-version.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-set -e
+set -xe
 
 VERSION=$1
 
@@ -8,7 +8,7 @@ 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 -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)"
@@ -24,3 +24,4 @@ echo "Push changes and tags"
 echo "git push && git push --tags"
 echo "Push new gem"
 echo "gem push reckon-$VERSION.gem"
+gh release create v$VERSION reckon-$VERSION.gem --draft --generate-notes

data/bin/reckon

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'reckon'
 
 begin
-  options = Reckon::Options.parse
+  options = Reckon::Options.parse_command_line_options
 rescue RuntimeError => e
   puts("ERROR: #{e}")
   exit(1)

data/lib/reckon/app.rb

@@ -1,12 +1,12 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-require 'pp'
 require 'yaml'
+require 'stringio'
 
 module Reckon
+  # The main app
   class App
     attr_accessor :options, :seen, :csv_parser, :regexps, :matcher
-    @@cli = HighLine.new
 
     def initialize(opts = {})
       self.options = opts
@@ -14,9 +14,10 @@ module Reckon
 
       self.regexps = {}
       self.seen = Set.new
-      self.options[:currency] ||= '$'
-      @csv_parser = CSVParser.new( options )
+      @cli = HighLine.new
+      @csv_parser = CSVParser.new(options)
       @matcher = CosineSimilarity.new(options)
+      @parser = options[:format] =~ /beancount/i ? BeancountParser.new : LedgerParser.new
       learn!
     end
 
@@ -26,9 +27,13 @@ module Reckon
       fh.puts str
     end
 
+    # Learn from previous transactions. Used to recommend accounts for a transaction.
     def learn!
       learn_from_account_tokens(options[:account_tokens_file])
       learn_from_ledger_file(options[:existing_ledger_file])
+      # TODO: make this work
+      # this doesn't work because output_file is an IO object
+      # learn_from_ledger_file(options[:output_file]) if File.exist?(options[:output_file])
     end
 
     def learn_from_account_tokens(filename)
@@ -52,12 +57,13 @@ module Reckon
 
       raise "#{ledger_file} doesn't exist!" unless File.exist?(ledger_file)
 
-      learn_from_ledger(File.read(ledger_file))
+      learn_from_ledger(File.new(ledger_file))
     end
 
+    # Takes an IO-like object
     def learn_from_ledger(ledger)
       LOGGER.info "learning from #{ledger}"
-      LedgerParser.new(ledger).entries.each do |entry|
+      @parser.parse(ledger).each do |entry|
         entry[:accounts].each do |account|
           str = [entry[:desc], account[:amount]].join(" ")
           if account[:name] != options[:bank_account]
@@ -84,7 +90,7 @@ module Reckon
           merged_acct = [account, k].compact.join(':')
           extract_account_tokens(v, merged_acct)
         end
-        at.inject({}) { |memo, e| memo.merge!(e)}
+        at.inject({}) { |memo, e| memo.merge!(e) }
       end
     end
 
@@ -92,6 +98,7 @@ module Reckon
       # https://github.com/tenderlove/psych/blob/master/lib/psych/visitors/to_ruby.rb
       match = regex_str.match(/^\/(.*)\/([ix]*)$/m)
       fail "failed to parse regexp #{regex_str}" unless match
+
       options = 0
       (match[2] || '').split('').each do |option|
         case option
@@ -120,13 +127,16 @@ module Reckon
 
         if row[:money] > 0
           # out_of_account
-          answer = ask_account_question("Which account provided this income? (#{cmd_options})", row)
+          answer = ask_account_question(
+            "Which account provided this income? (#{cmd_options})", row
+          )
           line1 = [options[:bank_account], row[:pretty_money]]
           line2 = [answer, ""]
         else
           # into_account
-          answer = ask_account_question("To which account did this money go? (#{cmd_options})", row)
-#          line1 = [answer, row[:pretty_money_negated]]
+          answer = ask_account_question(
+            "To which account did this money go? (#{cmd_options})", row
+          )
           line1 = [answer, ""]
           line2 = [options[:bank_account], row[:pretty_money]]
         end
@@ -137,9 +147,9 @@ module Reckon
           next
         end
 
-        ledger = ledger_format(row, line1, line2)
+        ledger = @parser.format_row(row, line1, line2)
         LOGGER.info "ledger line: #{ledger}"
-        learn_from_ledger(ledger) unless options[:account_tokens_file]
+        learn_from_ledger(StringIO.new(ledger)) unless options[:account_tokens_file]
         output(ledger)
       end
     end
@@ -203,7 +213,7 @@ module Reckon
         return possible_answers[0] || default
       end
 
-      answer = @@cli.ask(msg) do |q|
+      answer = @cli.ask(msg) do |q|
         q.completion = possible_answers
         q.readline = true
         q.default = possible_answers.first
@@ -221,7 +231,7 @@ module Reckon
     end
 
     def add_description(row)
-      desc_answer = @@cli.ask("Enter a new description for this transaction (empty line aborts)\n") do |q|
+      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]
@@ -231,7 +241,7 @@ module Reckon
     end
 
     def add_note(row)
-      desc_answer = @@cli.ask("Enter a new note for this transaction (empty line aborts)\n") do |q|
+      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]
@@ -246,7 +256,7 @@ module Reckon
           [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)
@@ -254,13 +264,6 @@ module Reckon
         @matcher.find_similar(row[:description]).map { |n| n[:account] }
     end
 
-    def ledger_format(row, line1, line2)
-      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
-    end
-
     def output(ledger_line)
       options[:output_file].puts ledger_line
       options[:output_file].flush

data/lib/reckon/beancount_parser.rb

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'date'
+
+module Reckon
+  class BeancountParser
+
+    attr_accessor :entries
+
+    def initialize(options = {})
+      @options = options
+      @date_format = options[:ledger_date_format] || options[:date_format] || '%Y-%m-%d'
+    end
+
+    # 2015-01-01 * "Opening Balance for checking account"
+    #   Assets:US:BofA:Checking                         3490.52 USD
+    #   Equity:Opening-Balances                        -3490.52 USD
+    
+    # input is an object that response to #each_line,
+    # (i.e. a StringIO or an IO object)
+    def parse(input)
+      entries = []
+      comment_chars = ';#%*|'
+      new_entry = {}
+
+      input.each_line do |entry|
+
+        next if entry =~ /^\s*[#{comment_chars}]/
+
+        m = entry.match(%r{
+          ^
+          (\d+[\d/-]+)  # date
+          \s+
+          ([*!])? # type
+          \s*
+          ("[^"]*")? # description (optional)
+          \s*
+          ("[^"]*")? # notes (optional)
+          # tags (not implemented)
+        }x)
+
+        # (date, type, code, description), type and code are optional
+        if (m)
+          add_entry(entries, new_entry)
+          new_entry = {
+            date: try_parse_date(m[1]),
+            type: m[2] || "",
+            desc: trim_quote(m[3]),
+            notes: trim_quote(m[4]),
+            accounts: []
+          }
+        elsif entry =~ /^\s*$/ && new_entry[:date]
+          add_entry(entries, new_entry)
+          new_entry = {}
+        elsif new_entry[:date] && entry =~ /^\s+/
+          LOGGER.info("Adding new account #{entry}")
+          new_entry[:accounts] << parse_account_line(entry)
+        else
+          LOGGER.info("Unknown entry type: #{entry}")
+          add_entry(entries, new_entry)
+          new_entry = {}
+        end
+
+      end
+      entries
+    end
+
+    def format_row(row, line1, line2)
+      out = %Q{#{row[:pretty_date]} * "#{row[:description]}" "#{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
+
+    private
+
+    # remove leading and trailing quote character (")
+    def trim_quote(str)
+      return str if !str
+      str.gsub(/^"([^"]*)"$/, '\1')
+    end
+
+    def add_entry(entries, entry)
+      return unless entry[:date] && entry[:accounts].length > 1
+
+      entry[:accounts] = balance(entry[:accounts])
+      entries << entry
+    end
+
+    def try_parse_date(date_str)
+      date = Date.parse(date_str)
+      return nil if date.year > 9999 || date.year < 1000
+
+      date
+    rescue ArgumentError
+      nil
+    end
+
+    def parse_account_line(entry)
+      # TODO handle buying stocks
+      #   Assets:US:ETrade:VHT                                 19 VHT {132.32 USD, 2017-08-27}
+      (account_name, rest) = entry.strip.split(/\s{2,}|\t+/, 2)
+
+      if rest.nil? || rest.empty?
+        return {
+          name: account_name,
+          amount: clean_money("")
+        }
+      end
+              
+      value = if rest =~ /{/
+                (qty, dollar_value, date) = rest.split(/[{,]/)
+                (qty.to_f * dollar_value.to_f).to_s
+              else
+                rest
+              end
+
+      return {
+        name: account_name,
+        amount: clean_money(value || "")
+      }
+    end
+
+    def balance(accounts)
+      return accounts unless accounts.any? { |i| i[:amount].nil? }
+
+      sum = accounts.reduce(0) { |m, n| m + (n[:amount] || 0) }
+      count = 0
+      accounts.each do |account|
+        next unless account[:amount].nil?
+
+        count += 1
+        account[:amount] = -sum
+      end
+      if count > 1
+        puts "Warning: unparsable entry due to more than one missing money value."
+        p accounts
+        puts
+      end
+
+      accounts
+    end
+
+    def clean_money(money)
+      return nil if money.nil? || money.empty?
+
+      money.gsub(/[^0-9.-]/, '').to_f
+    end
+  end
+end
+

data/lib/reckon/cosine_similarity.rb

@@ -17,7 +17,6 @@ module Reckon
 
     def initialize(options)
       @docs = DocumentInfo.new({}, {})
-      @options = options
     end
 
     def add_document(account, doc)