reckon 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5debbf17f216c822d753863d7c4adf18318beaf06f608d9d145e7f07b2a0b91b
-  data.tar.gz: f1d393d4aae4cd646794c2b6388a77f2dcf0b154874b6a379922ab7b05a8da92
+  metadata.gz: fbf144e0683d1b618fbc046ade5af1c9fd37a69c2a62ee393301ce26f9b9a475
+  data.tar.gz: 32fc57d45adec068894497619c357a36482ede4e547a3169a4c8faf95e731a2c
 SHA512:
-  metadata.gz: e35912bb53131baa9a150ce05eede60946fd0101566e84fd9ab21476fbed54cadc011e56d18b29502d3b2c020cd325d6e8883f9f7827485bab1d8e4e6907a853
-  data.tar.gz: 4e67777ef46d71051372c41ec5be831cf8a6945d2da12d84bfc346b58db5604f79c1b1cfcc1471dd445a8767cc5ec47c4a465af9c41c9c830f38879ed3c3b6e4
+  metadata.gz: a5cdf653ec68d8360526c131335249fce69c9b51b12824023263621fb743c4c769cf9e9a44aa37108d8d1ef3ad51bba9b9268e36259c7d4597dddf20abf3c368
+  data.tar.gz: 0af870f477d800fb76edf3d7a4e31ef1120d40817b55d8e8da7175bad0e6daa2a981186e5bfc258a46703dd81cb1c07ed805a0260e9472264a5817fd207a9649

data/.github/workflows/ruby.yml

@@ -34,10 +34,10 @@ jobs:
           - 2.3.7
     steps:
     - uses: actions/checkout@v2
+    - name: Update package
+      run: sudo apt-get update
     - name: Install packages
-      run: sudo apt-get -y install ledger hledger
-    - name: Install bundler
-      run: sudo gem install -v 1.17.3 bundler
+      run: sudo apt-get -y install ledger hledger expect
     - 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):
@@ -45,6 +45,6 @@ jobs:
       # uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+        bundler-cache: true # runs 'bundle install' and caches installed gems
     - name: Run tests
       run: bundle exec rake test_all

data/.gitignore

@@ -30,3 +30,4 @@ private_tests
 vendor
 
 test.log
+test_log.txt

data/CHANGELOG.md

@@ -1,8 +1,59 @@
 # Changelog
 
-## [0.6.2](https://github.com/cantino/reckon/tree/0.6.2) (2021-01-24)
+## [v0.8.0](https://github.com/cantino/reckon/tree/v0.8.0) (2021-08-08)
 
-[Full Changelog](https://github.com/cantino/reckon/compare/v0.6.1...0.6.2)
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.7.2...v0.8.0)
+
+**Closed issues:**
+
+- --date-format '%d/%m/%Y' not working [\#113](https://github.com/cantino/reckon/issues/113)
+- Reckon behaviour does not match what is explained on README.md [\#112](https://github.com/cantino/reckon/issues/112)
+- --date-format '%d/%m/%Y' not working [\#111](https://github.com/cantino/reckon/issues/111)
+- --date-format '%d/ [\#110](https://github.com/cantino/reckon/issues/110)
+
+**Merged pull requests:**
+
+- Add ledger-date-format option to specify ledger file date format [\#114](https://github.com/cantino/reckon/pull/114) ([benprew](https://github.com/benprew))
+
+## [v0.7.2](https://github.com/cantino/reckon/tree/v0.7.2) (2021-04-22)
+
+[Full Changelog](https://github.com/cantino/reckon/compare/v0.7.1...v0.7.2)
+
+**Closed issues:**
+
+- \[feature request\] Better format for large transactions [\#108](https://github.com/cantino/reckon/issues/108)
+- cosine similarity not comparing documents correctly [\#106](https://github.com/cantino/reckon/issues/106)
+
+**Merged pull requests:**
+
+- Add thousands separator in money output.  Fixes \#108. [\#109](https://github.com/cantino/reckon/pull/109) ([benprew](https://github.com/benprew))
+- Cosine similarity should use all docs tokens. not just matched tokens. [\#107](https://github.com/cantino/reckon/pull/107) ([benprew](https://github.com/benprew))
+- Test getting expect working with actions [\#105](https://github.com/cantino/reckon/pull/105) ([benprew](https://github.com/benprew))
+
+## [v0.7.1](https://github.com/cantino/reckon/tree/v0.7.1) (2021-02-07)
+
+[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:**
 
@@ -171,6 +222,7 @@
 - Unattended mode and custom tokens support [\#47](https://github.com/cantino/reckon/pull/47) ([vzctl](https://github.com/vzctl))
 - \[RFC\] Implement issue \#40: Tab completion [\#46](https://github.com/cantino/reckon/pull/46) ([BlackEdder](https://github.com/BlackEdder))
 - set readline to allow for backspace in ask dialog [\#44](https://github.com/cantino/reckon/pull/44) ([mrtazz](https://github.com/mrtazz))
+- Fix --encoding option [\#41](https://github.com/cantino/reckon/pull/41) ([mamciek](https://github.com/mamciek))
 
 ## [v0.3.10](https://github.com/cantino/reckon/tree/v0.3.10) (2014-08-16)
 
@@ -191,7 +243,6 @@
 
 **Merged pull requests:**
 
-- Fix --encoding option [\#41](https://github.com/cantino/reckon/pull/41) ([mamciek](https://github.com/mamciek))
 - Added spec for csv files from Broker Canada [\#36](https://github.com/cantino/reckon/pull/36) ([BlackEdder](https://github.com/BlackEdder))
 - Date format [\#35](https://github.com/cantino/reckon/pull/35) ([BlackEdder](https://github.com/BlackEdder))
 - Added example from a french bank [\#34](https://github.com/cantino/reckon/pull/34) ([BlackEdder](https://github.com/BlackEdder))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reckon (0.6.2)
+    reckon (0.8.0)
       chronic (>= 0.3.0)
       highline (>= 1.5.2)
       rchardet (>= 1.8.0)

data/README.md

@@ -42,32 +42,37 @@ Learn more:
     -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
-                                     Specify the money column instead of letting Reckon guess - the first column is column 1
+                                     Column number of the money column, starts from 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
+                                     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)
-        --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.
+                                     Specify an encoding for the CSV file
+    -c, --currency '$'               Currency symbol to use - default $ (ex £, EUR)
+        --date-format FORMAT
+                                     CSV file date format (see `date` for format)
+        --ledger-date-format FORMAT
+                                     Ledger date format (see `date` for format)
+    -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)
+        --table-output-file FILE
         --default-into-account NAME
                                      Default into account
         --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
 
@@ -78,13 +83,13 @@ If you find CSV files that it can't parse, send me examples or pull requests!
 You can run reckon in a non-interactive mode.
 To guess the accounts reckon can use an existing ledger file or a token file with keywords.
 
-`reckon --unattended -l 2010.dat -f bank.csv -o ledger.dat`
+`reckon --unattended -a Checking -l 2010.dat -f bank.csv -o ledger.dat`
 
-`reckon --unattended --account-tokens tokens.yaml -f bank.csv -o ledger.dat`
+`reckon --unattended -a Checking --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 -`
+`csv_file_generator | reckon --unattended -a Checking -l 2010.dat -o ledger.dat -f -`
 
 ### Account Tokens
 
@@ -135,11 +140,10 @@ We encourage you to contribute to Reckon! Here is some information to help you.
 
 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.
+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)
-6. Send me a pull request. Bonus points for topic branches.
+5. Send me a pull request. Bonus points for topic branches.
 
 ### Integration Tests
 

data/Rakefile

@@ -17,6 +17,6 @@ task :test_all do
 end
 
 task :integration_tests do
-  puts `./spec/integration/test.sh`
-  raise 'Integration tests failed' if $CHILD_STATUS.exitstatus != 0
+  cmd = 'prove -v ./spec/integration/test.sh'
+  raise 'Integration tests failed' unless system(cmd)
 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"

data/bin/reckon

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'reckon'
 
 begin
-  options = Reckon::App.parse_opts
+  options = Reckon::Options.parse
 rescue RuntimeError => e
   puts("ERROR: #{e}")
   exit(1)
@@ -13,6 +13,9 @@ reckon = Reckon::App.new(options)
 
 if options[:print_table]
   reckon.output_table
+  if options[:table_output_file]
+    File.open(options[:table_output_file], 'w') { |fh| reckon.output_table fh }
+  end
   exit
 end
 

data/lib/reckon.rb

@@ -16,4 +16,5 @@ require_relative 'reckon/date_column'
 require_relative 'reckon/money'
 require_relative 'reckon/ledger_parser'
 require_relative 'reckon/csv_parser'
+require_relative 'reckon/options'
 require_relative 'reckon/app'

data/lib/reckon/app.rb

@@ -20,10 +20,10 @@ module Reckon
       learn!
     end
 
-    def interactive_output(str)
+    def interactive_output(str, fh = $stdout)
       return if options[:unattended]
 
-      puts str
+      fh.puts str
     end
 
     def learn!
@@ -161,7 +161,7 @@ module Reckon
       rows.sort_by { |n| [n[:date], -n[:money], n[:description]] }.each { |row| yield row }
     end
 
-    def print_transaction(rows)
+    def print_transaction(rows, fh = $stdout)
       str = "\n"
       header = %w[Date Amount Description Note]
       maxes = header.map(&:length)
@@ -185,7 +185,7 @@ module Reckon
         str += "\n"
       end
 
-      interactive_output str
+      interactive_output str, fh
     end
 
     def ask_account_question(msg, row)
@@ -193,11 +193,13 @@ module Reckon
       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
+        if options[:fail_on_unknown_account] && possible_answers.empty?
+          raise %(Couldn't find any matches for '#{row[:description]}'
+            Try adding an account token with --account-tokens)
+        end
+
+        default = options[:default_outof_account]
+        default = options[:default_into_account] if row[:pretty_money][0] == '-'
         return possible_answers[0] || default
       end
 
@@ -278,151 +280,12 @@ module Reckon
       exit
     end
 
-    def output_table
+    def output_table(fh = $stdout)
       rows = []
       each_row_backwards do |row|
         rows << row
       end
-      print_transaction(rows)
-    end
-
-    def self.parse_opts(args=ARGV, stdin=STDIN)
-      options = { :output_file => STDOUT }
-      OptionParser.new do |opts|
-        opts.banner = "Usage: Reckon.rb [options]"
-        opts.separator ""
-
-        opts.on("-f", "--file FILE", "The CSV file to parse") do |file|
-          options[:file] = file
-        end
-
-        opts.on("-a", "--account NAME", "The Ledger Account this file is for") do |a|
-          options[:bank_account] = a
-        end
-
-        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-          options[:verbose] = v
-        end
-
-        opts.on("-i", "--inverse", "Use the negative of each amount") do |v|
-          options[:inverse] = v
-        end
-
-        opts.on("-p", "--print-table", "Print out the parsed CSV in table form") do |p|
-          options[:print_table] = p
-        end
-
-        opts.on("-o", "--output-file FILE", "The ledger file to append to") do |o|
-          options[:output_file] = File.open(o, 'a')
-        end
-
-        opts.on("-l", "--learn-from FILE", "An existing ledger file to learn accounts from") do |l|
-          options[:existing_ledger_file] = l
-        end
-
-        opts.on("", "--ignore-columns 1,2,5", "Columns to ignore in the CSV file - the first column is column 1") do |ignore|
-          options[:ignore_columns] = ignore.split(",").map { |i| i.to_i }
-        end
-
-        opts.on("", "--money-column 2", Integer, "Specify the money column instead of letting Reckon guess - the first column is column 1") do |column_number|
-          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
-
-        opts.on("", "--contains-header [N]", "The first row of the CSV is a header and should be skipped. Optionally add the number of rows to skip.") do |contains_header|
-          options[:contains_header] = 1
-          options[:contains_header] = contains_header.to_i if contains_header
-        end
-
-        opts.on("", "--csv-separator ','", "Separator for parsing the CSV - default is comma.") do |csv_separator|
-          options[:csv_separator] = csv_separator
-        end
-
-        opts.on("", "--comma-separates-cents", "Use comma instead of period to deliminate dollars from cents when parsing ($100,50 instead of $100.50)") do |c|
-          options[:comma_separates_cents] = c
-        end
-
-        opts.on("", "--encoding 'UTF-8'", "Specify an encoding for the CSV file; not usually needed") do |e|
-          options[:encoding] = e
-        end
-
-        opts.on("-c", "--currency '$'", "Currency symbol to use, defaults to $ (£, EUR)") do |e|
-          options[:currency] = e
-        end
-
-        opts.on("", "--date-format '%d/%m/%Y'", "Force the date format (see Ruby DateTime strftime)") do |d|
-          options[:date_format] = d
-        end
-
-        opts.on("-u", "--unattended", "Don't ask questions and guess all the accounts automatically. Used with --learn-from or --account-tokens options.") do |n|
-          options[:unattended] = n
-        end
-
-        opts.on("-t", "--account-tokens FILE", "YAML file with manually-assigned tokens for each account (see README)") do |a|
-          options[:account_tokens_file] = a
-        end
-
-        opts.on("", "--default-into-account NAME", "Default into account") do |a|
-          options[:default_into_account] = a
-        end
-
-        opts.on("", "--default-outof-account NAME", "Default 'out of' account") do |a|
-          options[:default_outof_account] = a
-        end
-
-        opts.on("", "--suffixed", "If --currency should be used as a suffix. Defaults to false.") do |e|
-          options[:suffixed] = e
-        end
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-
-        opts.on_tail("--version", "Show version") do
-          puts VERSION
-          exit
-        end
-
-        opts.parse!(args)
-      end
-
-      if options[:file] == '-'
-        unless options[:unattended]
-          raise "--unattended is required to use STDIN as CSV source."
-        end
-
-        puts "Reading csv from STDIN"
-        options[:string] = stdin.read
-      end
-
-      unless options[:file]
-        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
-          exit
-        end
-      end
-
-      unless options[:bank_account]
-        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
-          q.validate = /^.{2,}$/
-          q.default = "Assets:Bank:Checking"
-        end
-      end
-
-      options
+      print_transaction(rows, fh)
     end
   end
 end