reckon 0.4.4 → 0.5.4

data/spec/reckon/date_column_spec.rb

@@ -20,23 +20,22 @@ describe Reckon::DateColumn do
   end
   describe "for" do
     it "should detect the date" do
-      Reckon::DateColumn.new( ["13/12/2013"] ).for( 0 ).should ==
-        Time.new( 2013, 12, 13, 12 )
-      Reckon::DateColumn.new( ["01/14/2013"] ).for( 0 ).should ==
-        Time.new( 2013, 01, 14, 12 )
-      Reckon::DateColumn.new( ["13/12/2013", "21/11/2013"] ).for( 1 ).should ==
-        Time.new( 2013, 11, 21, 12 )
-      Reckon::DateColumn.new( ["2013-11-21"] ).for( 0 ).should ==
-        Time.new( 2013, 11, 21, 12 )
+      expect(Reckon::DateColumn.new(%w[13/12/2013]).for(0))
+        .to eq(Date.new(2013, 12, 13))
+      expect(Reckon::DateColumn.new(%w[01/14/2013]).for(0))
+        .to eq(Date.new(2013, 1, 14))
+      expect(Reckon::DateColumn.new(%w[13/12/2013 21/11/2013]).for(1))
+        .to eq(Date.new(2013, 11, 21))
+      expect(Reckon::DateColumn.new( ["2013-11-21"] ).for( 0 ))
+        .to eq(Date.new(2013, 11, 21))
 
     end
 
     it "should correctly use endian_precedence" do
-      Reckon::DateColumn.new( ["01/02/2013", "01/14/2013"] ).for(0).should ==
-        Time.new( 2013, 01, 02, 12 )
-      Reckon::DateColumn.new( ["01/02/2013", "14/01/2013"] ).for(0).should ==
-        Time.new( 2013, 02, 01, 12 )
+      expect(Reckon::DateColumn.new(%w[01/02/2013 01/14/2013]).for(0))
+        .to eq(Date.new(2013, 1, 2))
+      expect(Reckon::DateColumn.new(%w[01/02/2013 14/01/2013]).for(0))
+        .to eq(Date.new(2013, 2, 1))
     end
   end
 end
-

data/spec/reckon/ledger_parser_spec.rb

@@ -1,31 +1,121 @@
 #!/usr/bin/env ruby
 #encoding: utf-8
 
-require "spec_helper"
+require_relative "../spec_helper"
 require 'rubygems'
 require 'reckon'
 require 'pp'
+require 'rantly'
+require 'rantly/rspec_extensions'
+require 'shellwords'
 
 describe Reckon::LedgerParser do
   before do
-    @ledger = Reckon::LedgerParser.new(EXAMPLE_LEDGER)
+    @ledger = Reckon::LedgerParser.new(EXAMPLE_LEDGER, date_format: '%Y/%m/%d')
   end
 
   describe "parse" do
+    it "should match ledger csv output" do
+      # ledger only parses dates with - or / as separator, and separator is required
+      formats = ["%Y/%m/%d", "%Y-%m-%d"]
+      types = [' ! ', ' * ', ' ']
+      delimiters = ["  ", "\t", "\t\t"]
+      comment_chars = ';#%*|'
+      currency_delimiters = delimiters + ['']
+      currencies = ['', '$', '£']
+      property_of do
+        Rantly do
+          description = Proc.new do
+            sized(15){string}.tr(%q{'`:*\\},'').gsub(/\s+/, ' ').gsub(/^[!;<\[( #{comment_chars}]+/, '')
+          end
+          currency = choose(*currencies) # to be consistent within the transaction
+          single_line_comments = ";#|%*".split('').map { |n| "#{n} #{call(description)}" }
+          comments = ['', ';   ', "\t;#{call(description)}", "  ; #{call(description)}"]
+          date = Time.at(range(0, 1_581_389_644)).strftime(choose(*formats))
+          codes = [' ', " (#{string(:alnum).tr('()', '')}) "]
+          account = Proc.new { choose(*delimiters) + call(description) }
+          account_money = Proc.new do
+              sprintf("%.02f", (float * range(5,10) + 1) * choose(1, -1))
+          end
+          account_line = Proc.new do
+            call(account) + \
+            choose(*delimiters) + \
+            currency + \
+            choose(*currency_delimiters) + \
+            call(account_money) + \
+            choose(*comments)
+          end
+          ledger = "#{date}#{choose(*types)}#{choose(*codes)}#{call(description)}\n"
+          range(1,5).times do
+            ledger += "#{call(account_line)}\n"
+          end
+          ledger += "#{call(account)}\n"
+          ledger += choose(*single_line_comments) + "\n"
+          ledger
+        end
+      end.check(1000) do |s|
+        filter_format = lambda { |n| [n['date'], n['desc'], n['name'], sprintf("%.02f", n['amount'])] }
+        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")
+        actual = CSV.parse(lp_csv, headers: headers).map(&filter_format)
+
+        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])
+        end
+      end
+    end
+
+    it 'should filter block comments' do
+      ledger = <<HERE
+1970/11/01 Dinner should show up
+  Assets:Checking  -123.00
+  Expenses:Restaurants
+
+comment
+
+1970/11/01 Lunch should NOT show up
+  Assets:Checking  -12.00
+  Expenses:Restaurants
+
+end comment
+HERE
+      l = Reckon::LedgerParser.new(ledger)
+      expect(l.entries.length).to eq(1)
+      expect(l.entries.first[:desc]).to eq('Dinner should show up')
+
+    end
+
+    it 'should transaction comments' do
+      ledger = <<HERE
+2020-03-27      AMZN Mktp USX999H3203; Shopping; Sale
+    Expenses:Household                                      $82.77
+    Liabilities:ChaseSapphire                                       -$81.77
+    # END FINANCE SCRIPT OUTPUT Thu 02 Apr 2020 12:05:54 PM EDT
+HERE
+      l = Reckon::LedgerParser.new(ledger)
+      expect(l.entries.first[:accounts].map { |n| n[:name] }).to eq(['Expenses:Household', 'Liabilities:ChaseSapphire'])
+      expect(l.entries.first[:accounts].size).to eq(2)
+      expect(l.entries.length).to eq(1)
+    end
+
     it "should ignore non-standard entries" do
       @ledger.entries.length.should == 7
     end
 
     it "should parse entries correctly" do
-      @ledger.entries.first[:desc].should == "* Checking balance"
-      @ledger.entries.first[:date].should == "2004-05-01"
+      @ledger.entries.first[:desc].should == "Checking balance"
+      @ledger.entries.first[:date].should == Date.parse("2004-05-01")
       @ledger.entries.first[:accounts].first[:name].should == "Assets:Bank:Checking"
       @ledger.entries.first[:accounts].first[:amount].should == 1000
       @ledger.entries.first[:accounts].last[:name].should == "Equity:Opening Balances"
       @ledger.entries.first[:accounts].last[:amount].should == -1000
 
-      @ledger.entries.last[:desc].should == "(100) Credit card company"
-      @ledger.entries.last[:date].should == "2004/05/27"
+      @ledger.entries.last[:desc].should == "Credit card company"
+      @ledger.entries.last[:date].should == Date.parse("2004/05/27")
       @ledger.entries.last[:accounts].first[:name].should == "Liabilities:MasterCard"
       @ledger.entries.last[:accounts].first[:amount].should == 20.24
       @ledger.entries.last[:accounts].last[:name].should == "Assets:Bank:Checking"
@@ -35,14 +125,14 @@ describe Reckon::LedgerParser do
 
   describe "balance" do
     it "it should balance out missing account values" do
-      @ledger.balance([
+      @ledger.send(:balance, [
           { :name => "Account1", :amount => 1000 },
           { :name => "Account2", :amount => nil }
       ]).should == [ { :name => "Account1", :amount => 1000 }, { :name => "Account2", :amount => -1000 } ]
     end
 
     it "it should balance out missing account values" do
-      @ledger.balance([
+      @ledger.send(:balance, [
           { :name => "Account1", :amount => 1000 },
           { :name => "Account2", :amount => 100 },
           { :name => "Account3", :amount => -200 },
@@ -56,7 +146,7 @@ describe Reckon::LedgerParser do
     end
 
     it "it should work on normal values too" do
-      @ledger.balance([
+      @ledger.send(:balance, [
           { :name => "Account1", :amount => 1000 },
           { :name => "Account2", :amount => -1000 }
       ]).should == [ { :name => "Account1", :amount => 1000 }, { :name => "Account2", :amount => -1000 } ]

data/spec/reckon/money_spec.rb

@@ -8,79 +8,92 @@ require 'reckon'
 describe Reckon::Money do
   describe "from_s" do
     it "should handle currency indicators" do
-      Reckon::Money::from_s( "$2.00" ).should == 2.00
-      Reckon::Money::from_s( "-$1025.67" ).should == -1025.67 
-      Reckon::Money::from_s( "$-1025.67" ).should == -1025.67 
+      expect(Reckon::Money::from_s( "$2.00" )).to eq(2.00)
+      expect(Reckon::Money::from_s("-$1025.67")).to eq(-1025.67)
+      expect(Reckon::Money::from_s("$-1025.67")).to eq(-1025.67)
     end
 
     it "should handle the comma_separates_cents option correctly" do
-      Reckon::Money::from_s( "$2,00", :comma_separates_cents => true ).should == 2.00
-      Reckon::Money::from_s( "-$1025,67", :comma_separates_cents => true ).should == -1025.67 
-      Reckon::Money::from_s( "$-1025,67", :comma_separates_cents => true ).should == -1025.67 
+      expect(Reckon::Money::from_s("$2,00", :comma_separates_cents => true)).to eq(2.00)
+      expect(Reckon::Money::from_s("-$1025,67", :comma_separates_cents => true )).to eq(-1025.67)
+      expect(Reckon::Money::from_s("$-1025,67", :comma_separates_cents => true )).to eq(-1025.67)
     end
 
     it "should return 0 for an empty string" do
-      Reckon::Money::from_s( "" ).should == 0
+      expect(Reckon::Money::from_s("")).to eq(0)
     end
 
     it "should handle 1000 indicators correctly" do
-      Reckon::Money::from_s( "$2.000,00", :comma_separates_cents => true ).should == 2000.00
-      Reckon::Money::from_s( "-$1,025.67" ).should == -1025.67 
+      expect(Reckon::Money::from_s("$2.000,00", :comma_separates_cents => true)).to eq(2000.00)
+      expect(Reckon::Money::from_s("-$1,025.67")).to eq(-1025.67)
     end
 
     it "should keep numbers together" do
-      Reckon::Money::from_s( "1A1" ).should == 1
+      expect(Reckon::Money::from_s("1A1")).to eq(1)
     end
 
     it "should prefer numbers with precision of two" do
-      Reckon::Money::from_s( "1A2.00" ).should == 2
-      Reckon::Money::from_s( "2.00A1" ).should == 2
+      expect(Reckon::Money::from_s("1A2.00")).to eq(2)
+      expect(Reckon::Money::from_s("2.00A1")).to eq(2)
     end
 
     it "should handle arbitrary prefixes and postfixes" do
-      Reckon::Money::from_s( "AB1.00C" ).should == 1
-      Reckon::Money::from_s( "AB0C" ).should == 0
-      Reckon::Money::from_s( "AB-2.00C" ).should == -2
+      expect(Reckon::Money::from_s("AB1.00C")).to eq(1)
+      expect(Reckon::Money::from_s("AB0C")).to eq(0)
+      expect(Reckon::Money::from_s("AB-2.00C")).to eq(-2)
     end
 
     it "should return nil if no numbers are found" do
-      Reckon::Money::from_s( "BAC" ).should == nil
+      expect(Reckon::Money::from_s("BAC")).to be_nil()
     end
   end
 
   describe "pretty" do
     it "work with negative and positive numbers" do
-      Reckon::Money.new( -20.00 ).pretty.should == "-$20.00"
-      Reckon::Money.new( 1558.52 ).pretty.should == " $1558.52"
+      expect(Reckon::Money.new(-20.00).pretty).to eq("-$20.00")
+      expect(Reckon::Money.new(1558.52).pretty).to eq(" $1558.52")
     end
 
     it "work with other currencies such as €" do
-      Reckon::Money.new( -20.00, :currency => "€", :suffixed => false ).pretty.should == "-€20.00"
-      Reckon::Money.new( 1558.52, :currency => "€", :suffixed => false ).pretty.should == " €1558.52"
+      expect(Reckon::Money.new(-20.00, currency: "€", suffixed: false).pretty).to eq("-€20.00")
+      expect(Reckon::Money.new(1558.52, currency: "€", suffixed: false).pretty).to eq(" €1558.52")
     end
 
     it "work with suffixed currencies such as SEK" do
-      Reckon::Money.new( -20.00, :currency => "SEK", :suffixed => true ).pretty.should == "-20.00 SEK"
-      Reckon::Money.new( 1558.52, :currency => "SEK", :suffixed => true ).pretty.should == " 1558.52 SEK"
+      expect(Reckon::Money.new( -20.00, :currency => "SEK", :suffixed => true ).pretty).to eq("-20.00 SEK")
+      expect(Reckon::Money.new( 1558.52, :currency => "SEK", :suffixed => true ).pretty).to eq(" 1558.52 SEK")
     end
   end
 
   describe "likelihood" do
     it "should return the likelihood that a string represents money" do
-      Reckon::Money::likelihood( "$20.00" ).should == 45
+      expect(Reckon::Money::likelihood( "$20.00" )).to eq(65)
+    end
+
+    it "should return neutral for empty string" do
+      expect(Reckon::Money::likelihood("")).to eq(0)
+    end
+
+    it "should recognize non-us currencies" do
+      expect(Reckon::Money::likelihood("£480.00")).to eq(30)
+      expect(Reckon::Money::likelihood("£1.480,00")).to eq(30)
+    end
+
+    it 'should not identify date columns as money' do
+      expect(Reckon::Money::likelihood("22.01.2014")).to eq(0)
     end
   end
 
   describe "equality" do
     it "should be comparable to other money" do
-      Reckon::Money.new( 2.0 ).should == Reckon::Money.new( 2.0 )
-      Reckon::Money.new( 1.0 ).should <= Reckon::Money.new( 2.0 )
-      Reckon::Money.new( 3.0 ).should > Reckon::Money.new( 2.0 )
+      expect(Reckon::Money.new(2.0)).to eq(Reckon::Money.new(2.0))
+      expect(Reckon::Money.new(1.0)).to be <= Reckon::Money.new(2.0)
+      expect(Reckon::Money.new(3.0)).to be > Reckon::Money.new(2.0)
     end
     it "should be comparable to other float" do
-      Reckon::Money.new( 2.0 ).should == 2.0
-      Reckon::Money.new( 1.0 ).should <= 2.0
-      Reckon::Money.new( 3.0 ).should > 2.0
+      expect(Reckon::Money.new(2.0)).to eq(2.0)
+      expect(Reckon::Money.new(1.0)).to be <= 2.0
+      expect(Reckon::Money.new(3.0)).to be > 2.0
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,4 +3,26 @@ require 'rspec'
 require 'reckon'
 
 RSpec.configure do |config|
+  config.before(:all, &:silence_output)
+  config.after(:all,  &:enable_output)
+  def fixture_path(file)
+    File.expand_path(File.join(File.dirname(__FILE__), "data_fixtures", file))
+  end
+end
+
+public
+
+# Redirects stderr and stout to /dev/null.txt
+def silence_output
+  # Store the original stderr and stdout in order to restore them later
+  @original_stdout = $stdout
+
+  # Redirect stderr and stdout
+  $stdout = File.new(File.join(File.dirname(__FILE__), 'test_log.txt'), 'w')
+end
+
+# Replace stderr and stdout so anything else is output correctly
+def enable_output
+  $stdout = @original_stdout
+  @original_stdout = nil
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: reckon
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.4
 platform: ruby
 authors:
 - Andrew Cantino
 - BlackEdder
+- Ben Prew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -26,19 +27,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.9
 - !ruby/object:Gem::Dependency
-  name: fastercsv
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :runtime
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rantly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !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: 1.5.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +110,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: rchardet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: Reckon automagically converts CSV files for use with the command-line
   accounting tool Ledger.  It also helps you to select the correct accounts associated
   with the CSV data using Bayesian machine learning.
@@ -95,7 +138,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGES.md
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -104,12 +147,43 @@ files:
 - bin/reckon
 - lib/reckon.rb
 - lib/reckon/app.rb
+- lib/reckon/cosine_similarity.rb
 - lib/reckon/csv_parser.rb
+- lib/reckon/date_column.rb
 - lib/reckon/ledger_parser.rb
+- lib/reckon/logger.rb
 - lib/reckon/money.rb
+- lib/reckon/version.rb
 - reckon.gemspec
+- spec/data_fixtures/51-sample.csv
+- spec/data_fixtures/51-tokens.yml
+- spec/data_fixtures/73-sample.csv
+- spec/data_fixtures/73-tokens.yml
+- spec/data_fixtures/73-transactions.ledger
+- spec/data_fixtures/85-date-example.csv
+- spec/data_fixtures/austrian_example.csv
+- spec/data_fixtures/bom_utf8_file.csv
+- spec/data_fixtures/broker_canada_example.csv
+- spec/data_fixtures/chase.csv
+- spec/data_fixtures/danish_kroner_nordea_example.csv
+- spec/data_fixtures/english_date_example.csv
 - spec/data_fixtures/extratofake.csv
+- spec/data_fixtures/french_example.csv
+- spec/data_fixtures/german_date_example.csv
+- spec/data_fixtures/harder_date_example.csv
+- spec/data_fixtures/ing.csv
+- spec/data_fixtures/intuit_mint_example.csv
+- spec/data_fixtures/invalid_header_example.csv
+- spec/data_fixtures/inversed_credit_card.csv
+- spec/data_fixtures/nationwide.csv
+- spec/data_fixtures/simple.csv
+- spec/data_fixtures/some_other.csv
+- spec/data_fixtures/spanish_date_example.csv
+- spec/data_fixtures/suntrust.csv
+- spec/data_fixtures/test_money_column.csv
 - spec/data_fixtures/tokens.yaml
+- spec/data_fixtures/two_money_columns.csv
+- spec/data_fixtures/yyyymmdd_date_example.csv
 - spec/reckon/app_spec.rb
 - spec/reckon/csv_parser_spec.rb
 - spec/reckon/date_column_spec.rb
@@ -119,7 +193,8 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 homepage: https://github.com/cantino/reckon
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -136,20 +211,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Utility for interactively converting and labeling CSV files for the Ledger
   accounting tool.
-test_files:
-- spec/data_fixtures/extratofake.csv
-- spec/data_fixtures/tokens.yaml
-- spec/reckon/app_spec.rb
-- spec/reckon/csv_parser_spec.rb
-- spec/reckon/date_column_spec.rb
-- spec/reckon/ledger_parser_spec.rb
-- spec/reckon/money_column_spec.rb
-- spec/reckon/money_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+test_files: []