qif 0.5 → 1.0

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.0 Added account types and fields from QIF specification. [elmatou]
+
 v0.5 Writes qif files without a record separator after the header. [jscipione]
 
 v0.4 Follow QIF specification that an end of entry should not appear under a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Jeremy Wells
+Copyright (c) 2011 Jeremy Wells
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -19,4 +19,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,6 +1,13 @@
 require 'echoe'
+require 'rspec/core/rake_task'
+
 Echoe.new('qif') do |gem|
   gem.author = "Jeremy Wells"
   gem.summary = "A library for reading and writing quicken QIF files."
   gem.email = "jemmyw@gmail.com"
 end
+
+desc "Run specs"
+RSpec::Core::RakeTask.new :spec
+
+task :default => :spec

data/lib/qif/reader.rb

@@ -16,15 +16,26 @@ module Qif
   class Reader
     include Enumerable
   
+    SUPPORTED_ACCOUNTS = {
+      "!Type:Bank" => "Bank account transactions",
+      "!Type:Cash" => "Cash account transactions",
+      "!Type:CCard" => "Credit card account transactions",
+      "!Type:Oth A" => "Asset account transactions",
+      "!Type:Oth L" => "Liability account transactions"
+    }
+
+    class UnknownAccountType < StandardError; end
+    
     # Create a new Qif::Reader object. The data argument must be
     # either an IO object or a String containing the Qif file data.
     #
-    # The format argument specifies the date format in the file. This
-    # defaults to 'dd/mm/yyyy', but also accepts 'mm/dd/yyyy'.
-    def initialize(data, format = 'dd/mm/yyyy')
-      @format = DateFormat.new(format)
+    # The optional format argument specifies the date format in the file. Giving a format will force it, otherwise the format will guissed reading the transactions in the file, this
+    # defaults to 'dd/mm/yyyy' if guessing method fails.
+    def initialize(data, format = nil)
       @data = data.respond_to?(:read) ? data : StringIO.new(data.to_s)
+      @format = DateFormat.new(format || guess_date_format || 'dd/mm/yyyy')
       read_header
+      raise(UnknownAccountType, "Unknown account type. Should be one of followings :\n#{SUPPORTED_ACCOUNTS.keys.inspect}") unless SUPPORTED_ACCOUNTS.keys.collect(&:downcase).include? @header.downcase
       reset
     end
     
@@ -57,7 +68,22 @@ module Qif
       transaction_cache.size
     end
     alias length size
-  
+
+    # Guess the file format of dates, reading the beginning of file, or return nil if no dates are found (?!).
+    def guess_date_format
+      begin
+        line = @data.gets
+        break if line.nil?
+        date = line.strip.scan(/^D(\d{1,2}).(\d{1,2}).(\d{2,4})/).flatten
+        if date.count == 3 
+          guessed_format = date[0].to_i.between?(1, 12) ? (date[1].to_i.between?(1, 12) ? nil : 'mm/dd') : 'dd/mm'
+          guessed_format += '/' + 'y'*date[2].length if guessed_format
+        end
+      end until guessed_format
+      @data.rewind
+      guessed_format
+    end
+
     private
   
     def read_all_transactions
@@ -90,7 +116,7 @@ module Qif
         @data.readline
       end
     end
-  
+
     def read_header
       headers = []
       begin
@@ -99,7 +125,7 @@ module Qif
       end until line !~ /^!/
 
       @header = headers.shift
-      @options = headers.map{|h| h.split(':').last }
+      @options = headers.map{|h| h.split(':') }.last
       
       unless line =~ /^\^/
         rewind_to @data.lineno - 1
@@ -119,24 +145,21 @@ module Qif
 
     def read_record
       record = {}
-
       begin
         line = @data.readline
         key = line[0,1]
+        record[key] = record.key?(key) ? record[key] + "\n" + line[1..-1].strip : line[1..-1].strip
+
+        record[key].sub!(',','') if %w(T U $).include? key
+        record[key] = @format.parse(record[key]) if %w(D).include? key
 
-        record[key] = line[1..-1].strip
-        
-        if date = @format.parse(record[key])
-          record[key] = date
-        end
       end until line =~ /^\^/
-      
       record
-    rescue EOFError => e
-      @data.close
-      nil
-    rescue Exception => e
-      nil
+      rescue EOFError => e
+        @data.close
+        nil
+      rescue Exception => e
+        nil
     end
   end
 end

data/lib/qif/transaction.rb

@@ -3,38 +3,65 @@ require 'qif/date_format'
 module Qif
   # The Qif::Transaction class represents transactions in a qif file.
   class Transaction
-    attr_accessor :date, :amount, :name, :description, :reference
-    
+    SUPPORTED_FIELDS = {
+      :date           => {"D" => "Date"},
+      :amount         => {"T" => "Amount"},
+      :status         => {"C" => "Cleared status"},
+      :number         => {"N" => "Num (check or reference number)"},
+      :payee          => {"P" => "Payee"},
+      :memo           => {"M" => "Memo"},
+      :adress         => {"A" => "Address (up to five lines; the sixth line is an optional message)"},
+      :category       => {"L" => "Category (Category/Subcategory/Transfer/Class)"},
+      :split_category => {"S" => "Category in split (Category/Transfer/Class)"},
+      :split_memo     => {"E" => "Memo in split"},
+      :split_amount   => {"$" => "Dollar amount of split"},
+      :end            => {"^" => "End of entry"}
+    }
+    DEPRECATION_FIELDS = {
+      :reference   => :payee,
+      :name        => :category,
+      :description => :memo
+    }
+    SUPPORTED_FIELDS.keys.each{|s| attr_accessor s}
+
     def self.read(record) #::nodoc
       return nil unless record['D'].respond_to?(:strftime)
-      
-      Transaction.new(
-        :date => record['D'],
-        :amount => record['T'].to_f, 
-        :name => record['L'], 
-        :description => record['M'],
-        :reference => record['P']
-      )
+      SUPPORTED_FIELDS.each{|k,v| record[k] = record.delete(v.keys.first)}
+      record.reject{|k,v| v.nil?}.each{|k,v| record[k] = record[k].to_f if k.to_s.include? "amount"}
+      Transaction.new record
     end
-    
+
     def initialize(attributes = {})
-      @date = attributes[:date]
-      @amount = attributes[:amount]
-      @name = attributes[:name]
-      @description = attributes[:description]
-      @reference = attributes[:reference]
+      deprecate_attributes!(attributes)
+      SUPPORTED_FIELDS.keys.each{|s| instance_variable_set("@#{s.to_s}", attributes[s])}
     end
-    
+
     # Returns a representation of the transaction as it
     # would appear in a qif file.
     def to_s(format = 'dd/mm/yyyy')
-      {
-        'D' => DateFormat.new(format).format(date),
-        'T' => '%.2f' % amount,
-        'L' => name,
-        'M' => description,
-        'P' => reference
-      }.map{|k,v| "#{k}#{v}" }.join("\n")
+      SUPPORTED_FIELDS.collect do |k,v|
+        next unless current = instance_variable_get("@#{k}")
+        field = v.keys
+        case current.class.to_s
+        when "Time"
+          "#{field}#{DateFormat.new(format).format(current)}"
+        when "Float"
+          "#{field}#{'%.2f'%current}"
+        when "String"
+          current.split("\n").collect {|x| "#{field}#{x}" }
+        else
+          "#{field}#{current}"
+        end
+      end.flatten.compact.join("\n")
+    end
+
+    private
+
+    def deprecate_attributes!(attributes = {})
+      attributes.select {|k,v| DEPRECATION_FIELDS.keys.include? k}.each do |key,value|
+        warn("DEPRECATION WARNING : :#{key} HAS BEEN DEPRECATED IN FAVOR OF :#{DEPRECATION_FIELDS[key]} IN ORDER TO COMPLY WITH QIF SPECS.")
+        attributes[DEPRECATION_FIELDS[key]] = attributes.delete(key)
+      end
     end
   end
 end

data/qif.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{qif}
-  s.version = "0.5"
+  s.version = "1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Wells"]
-  s.date = %q{2010-11-24}
+  s.date = %q{2011-02-19}
   s.description = %q{A library for reading and writing quicken QIF files.}
   s.email = %q{jemmyw@gmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "lib/qif.rb", "lib/qif/date_format.rb", "lib/qif/reader.rb", "lib/qif/transaction.rb", "lib/qif/writer.rb"]
@@ -15,11 +15,10 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Qif", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{qif}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.5.0}
   s.summary = %q{A library for reading and writing quicken QIF files.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/spec/lib/reader_spec.rb

@@ -8,21 +8,21 @@ shared_examples_for "3 record files" do
   it 'should have a debit of $10 on the 1st of January 2010' do
     transaction = instance.transactions.detect{|t| t.date == Time.mktime(2010, 1, 1)}
     transaction.should_not be_nil
-    transaction.name.should == 'Debit'
+    transaction.category.should == 'Debit'
     transaction.amount.should == -10.0
   end
 
   it 'should have a debit of $20 on the 1st of June 1020' do
     transaction = instance.transactions.detect{|t| t.date == Time.mktime(2010, 6, 1)}
     transaction.should_not be_nil
-    transaction.name.should == 'Debit'
+    transaction.category.should == 'Debit'
     transaction.amount.should == -20.0
   end
 
   it 'should have a credit of $30 on the 29th of December 2010' do
     transaction = instance.transactions.detect{|t| t.date == Time.mktime(2010, 12, 29)}
     transaction.should_not be_nil
-    transaction.name.should == 'Credit'
+    transaction.category.should == 'Credit'
     transaction.amount.should == 30.0
   end
 
@@ -52,6 +52,38 @@ describe Qif::Reader do
     end
   end
 
+  it 'should reject the wrong account type !Type:Invst and raise an UnknownAccountType exception' do
+    expect{ Qif::Reader.new(open('spec/fixtures/quicken_investment_account.qif')) }.to raise_error(Qif::Reader::UnknownAccountType)
+  end
+
+  it 'should guess the date format dd/mm/yyyy' do
+    @instance = Qif::Reader.new(open('spec/fixtures/3_records_ddmmyyyy.qif'))
+    @instance.guess_date_format.should == 'dd/mm/yyyy'
+  end
+
+  it 'should guess the date format mm/dd/yy' do
+    @instance = Qif::Reader.new(open('spec/fixtures/3_records_mmddyy.qif'))
+    @instance.guess_date_format.should == 'mm/dd/yy'
+  end
+
+  it 'shouldn\t guess the date format because transactions are ambiguious, fall back on default dd/mm/yyyy and fail' do
+    @instance = Qif::Reader.new(open('spec/fixtures/quicken_non_investement_account.qif'))
+    @instance.guess_date_format.should == nil
+    @instance.size.should == 0
+  end
+  
+# TODO Date parser should be more flexible and efficient, probably using Date.strptime(str, format)
+#  it 'should initialize if leading zeros are missing too' do
+#    @instance = Qif::Reader.new(open('spec/fixtures/3_records_dmyy.qif'))
+#    @instance.size.should == 3
+#  end
+
+  it 'should should parse amounts with comma separator too' do
+    @instance = Qif::Reader.new(open('spec/fixtures/3_records_separator.qif'))
+    @instance.size.should == 3
+    @instance.collect(&:amount).should == [-1010.0, -30020.0, 30.0]
+  end
+  
   it 'should initialize with an io object' do
     @instance = Qif::Reader.new(open('spec/fixtures/3_records_ddmmyyyy.qif'))
     @instance.size.should == 3

data/spec/lib/transaction_spec.rb

@@ -2,21 +2,38 @@ require 'spec/spec_helper'
 
 describe Qif::Transaction do
   describe '::read' do
-    it 'should return a new transaction' do
-      date = Time.now
+    it 'should return a new transaction with all attributes set' do
       t = Qif::Transaction.read(
-        'D' => date,
-        'T' => '10.0',
-        'L' => 'Credit',
-        'M' => 'Supermarket',
-        'P' => 'abcde'
+        'D' => Time.parse('06/ 1/94'),
+        'T' => '-1000.00'.to_f,
+        'C' => 'X',
+        'N' => '1005',
+        'P' => 'Bank Of Mortgage',
+        'M' => 'aMemo',
+        'L' => 'aCategory',
+# TODO Support correctly splits with an array of hash
+#        'S' => '[linda]
+#Mort Int',
+#        'E' => 'Cash',
+#        '$' => '-253.64
+#=746.36',
+        'A' => 'P.O. Box 27027
+Tucson, AZ
+85726',
+        '^' => nil
       )
+
       t.should be_a(Qif::Transaction)
-      t.date.should == date
-      t.amount.should == 10.0
-      t.name.should == 'Credit'
-      t.description.should == 'Supermarket'
-      t.reference.should == 'abcde'
+      t.date.should == Time.mktime(1994,6,1)
+      t.amount.should == -1000.00
+      t.status.should == 'X'
+      t.number.should == '1005'
+      t.payee.should == 'Bank Of Mortgage'
+      t.memo.should == 'aMemo'
+      t.category.should == 'aCategory'
+      t.adress.should == 'P.O. Box 27027
+Tucson, AZ
+85726'
     end
     
     it 'should return nil if the date does not respond to strftime' do
@@ -29,9 +46,9 @@ describe Qif::Transaction do
       @instance = Qif::Transaction.new(
         :date => Time.mktime(2010, 1, 2),
         :amount => -10.0,
-        :name => 'Debit',
-        :description => 'Supermarket',
-        :reference => 'abcde'
+        :category => 'Debit',
+        :memo => 'Supermarket',
+        :payee => 'abcde'
       )
     end
     
@@ -44,7 +61,7 @@ describe Qif::Transaction do
       @instance.to_s.should include('T-10.00')
     end
     
-    it 'should put the name in L' do
+    it 'should put the category in L' do
       @instance.to_s.should include('LDebit')
     end
     
@@ -56,4 +73,4 @@ describe Qif::Transaction do
       @instance.to_s.should include('Pabcde')
     end
   end
-end
+end

data/spec/lib/writer_spec.rb

@@ -27,7 +27,7 @@ describe Qif::Writer do
       date = Time.now
       
       Qif::Writer.open(@path) do |writer|
-        writer << Qif::Transaction.new(:date => date, :amount => 10.0, :name => 'Credit')
+        writer << Qif::Transaction.new(:date => date, :amount => 10.0, :category => 'Credit')
       end
       
       @buffer.should include('D%s' % date.strftime('%d/%m/%Y'))
@@ -50,7 +50,7 @@ describe Qif::Writer do
     
     it 'should write any pending transactions' do
       date = Time.now
-      @instance << Qif::Transaction.new(:date => date, :amount => 10.0, :name => 'Credit')
+      @instance << Qif::Transaction.new(:date => date, :amount => 10.0, :category => 'Credit')
       
       @buffer.should_not include('D%s' % date.strftime('%d/%m/%Y'))
       @instance.write

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: qif
 version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 5
-  version: "0.5"
+  version: "1.0"
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 +13:00
+date: 2011-02-19 00:00:00 +13:00
 default_executable: 
 dependencies: []
 
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: qif
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A library for reading and writing quicken QIF files.