qif 0.2

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.2 Added documentation
+
+v0.1 First version

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Jeremy Wells
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.

data/Manifest

@@ -0,0 +1,17 @@
+CHANGELOG
+LICENSE
+Manifest
+Rakefile
+lib/qif.rb
+lib/qif/date_format.rb
+lib/qif/reader.rb
+lib/qif/transaction.rb
+lib/qif/writer.rb
+spec/fixtures/3_records_ddmmyyyy.qif
+spec/fixtures/3_records_mmddyyyy.qif
+spec/lib/date_format_spec.rb
+spec/lib/reader_spec.rb
+spec/lib/transaction_spec.rb
+spec/lib/writer_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/Rakefile

@@ -0,0 +1,6 @@
+require 'echoe'
+Echoe.new('qif') do |gem|
+  gem.author = "Jeremy Wells"
+  gem.summary = "A library for reading and writing quicken QIF files."
+  gem.email = "jeremy@boost.co.nz"
+end

data/lib/qif.rb

@@ -0,0 +1,5 @@
+$: << File.dirname(__FILE__)
+
+require 'qif/reader'
+require 'qif/writer'
+require 'qif/transaction'

data/lib/qif/date_format.rb

@@ -0,0 +1,47 @@
+require 'time'
+
+module Qif
+  class DateFormat
+    attr_reader :format
+    
+    def initialize(format = 'dd/mm/yyyy')
+      @format = format
+    end
+    
+    def parse(date)
+      regex = convert_format_to_regex
+      order = date_order
+      
+      if match = regex.match(date)
+        Time.mktime(*%w(y m d).map{|t| match[order.index(t) + 1].to_i })
+      end
+    end
+    
+    def format(date)
+      date.strftime(convert_format_to_strftime)
+    end
+    
+    private
+    
+    def date_order
+      %w(d m y).sort{|a,b| @format.index(a) <=> @format.index(b) }
+    end
+    
+    def convert_format_to_strftime
+      format = @format.dup
+      format.gsub!('dd', '%d')
+      format.gsub!('mm', '%m')
+      format.gsub!('yyyy', '%Y')
+      format
+    end
+    
+    def convert_format_to_regex
+      format = @format.dup
+      format.gsub!('dd', '([0-3][0-9])')
+      format.gsub!('mm', '([0-1][0-9])')
+      format.gsub!('yyyy', '([1-2][0-9]{3})')
+      
+      /#{format}/mi
+    end
+  end
+end

data/lib/qif/reader.rb

@@ -0,0 +1,122 @@
+require 'stringio'
+require 'qif/date_format'
+require 'qif/transaction'
+
+module Qif
+  # The Qif::Reader class reads a qif file and provides access to
+  # the transactions as Qif::Transaction objects.
+  #
+  # Usage:
+  #
+  #   reader = Qif::Reader.new(open('/path/to/qif'), 'dd/mm/yyyy')
+  #   reader.each do |transaction|
+  #     puts transaction.date.strftime('%d/%m/%Y')
+  #     puts transaction.amount.to_s
+  #   end
+  class Reader
+    include Enumerable
+  
+    # 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)
+      @data = data.respond_to?(:read) ? data : StringIO.new(data.to_s)
+      read_header
+      reset
+    end
+    
+    # Return an array of Qif::Transaction objects from the Qif file. This
+    # method reads the whole file before returning, so it may not be suitable
+    # for very large qif files.
+    def transactions
+      read_all_transactions
+      transaction_cache
+    end
+  
+    # Call a block with each Qif::Transaction from the Qif file. This
+    # method yields each transaction as it reads the file so it is better
+    # to use this than #transactions for large qif files.
+    #
+    #   reader.each do |transaction|
+    #     puts transaction.amount
+    #   end
+    def each(&block)    
+      reset
+    
+      while transaction = next_transaction
+        yield transaction
+      end
+    end
+    
+    # Return the number of transactions in the qif file.
+    def size
+      read_all_transactions
+      transaction_cache.size
+    end
+    alias length size
+  
+    private
+  
+    def read_all_transactions
+      while next_transaction; end
+    end
+  
+    def transaction_cache
+      @transaction_cache ||= []
+    end
+  
+    def reset
+      @index = -1
+    end
+  
+    def next_transaction
+      @index += 1
+    
+      if transaction = transaction_cache[@index]
+        transaction
+      else
+        read_transaction
+      end
+    end
+  
+    def read_header
+      @header = read_record
+    end
+  
+    def read_transaction
+      if record = read_record
+        transaction = Transaction.read(record)
+        cache_transaction(transaction) if transaction
+      end
+    end
+  
+    def cache_transaction(transaction)
+      transaction_cache[@index] = transaction
+    end
+
+    def read_record
+      record = {}
+
+      begin
+        line = @data.readline
+        key = line[0,1]
+
+        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
+    end
+  end
+end

data/lib/qif/transaction.rb

@@ -0,0 +1,40 @@
+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
+    
+    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']
+      )
+    end
+    
+    def initialize(attributes = {})
+      @date = attributes[:date]
+      @amount = attributes[:amount]
+      @name = attributes[:name]
+      @description = attributes[:description]
+      @reference = attributes[:reference]
+    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")
+    end
+  end
+end

data/lib/qif/writer.rb

@@ -0,0 +1,80 @@
+require 'qif/date_format'
+require 'qif/transaction'
+
+module Qif
+  # The Qif::Writer class takes Qif::Transaction objects and outputs
+  # a Qif file.
+  #
+  # Usage:
+  #   Qif::Writer.open('/path/to/new/qif') do |writer|
+  #     writer << Qif::Transaction.new(
+  #       :date => Time.now, 
+  #       :amount => 10.0, 
+  #       :name => 'Credit'
+  #     )
+  #   end
+  class Writer
+    attr_accessor :type, :format
+    
+    # Open a qif file for writing and yield a Qif::Writer instance.
+    # For parameters see #new.
+    def self.open(path, type = 'Bank', format = 'dd/mm/yyyy')
+      File.open(path, 'w') do |file|
+        writer = self.new(file, type, format)
+        yield writer
+        writer.write
+      end
+    end
+    
+    # Create a new Qif::Writer. Expects an IO object or a filepath.
+    #
+    # Parameters:
+    #
+    # * <tt>io</tt> - An IO object or filepath
+    # * <tt>type</tt> - Used to write the header, defaults to 'Bank'
+    # * <tt>format</tt> - The format of dates in the qif file, defaults to 'dd/mm/yyyy'. Also accepts 'mm/dd/yyyy'
+    def initialize(io, type = 'Bank', format = 'dd/mm/yyyy')
+      @io = io.respond_to?(:write) ? io : File.open(io, 'w')
+      @type = type
+      @format = format
+      @transactions = []
+    end
+
+    # Add a transaction for writing
+    def <<(transaction)
+      @transactions << transaction
+    end
+    
+    # Write the qif file
+    def write
+      write_header
+      write_transactions
+    end
+    
+    # Close the qif file
+    def close
+      @io.close
+    end
+    
+    private
+    
+    def write_header
+      write_record('!Type:%s' % @type)
+    end
+    
+    def write_transactions
+      @transactions.each do |t|
+        write_transaction(t)
+      end
+    end
+    
+    def write_transaction(transaction)
+      write_record(transaction.to_s(@format))
+    end
+    
+    def write_record(data)
+      @io.write(data)
+      @io.write("\n^\n")
+    end
+  end
+end

data/qif.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{qif}
+  s.version = "0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Wells"]
+  s.date = %q{2010-01-22}
+  s.description = %q{A library for reading and writing quicken QIF files.}
+  s.email = %q{jeremy@boost.co.nz}
+  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"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "Rakefile", "lib/qif.rb", "lib/qif/date_format.rb", "lib/qif/reader.rb", "lib/qif/transaction.rb", "lib/qif/writer.rb", "spec/fixtures/3_records_ddmmyyyy.qif", "spec/fixtures/3_records_mmddyyyy.qif", "spec/lib/date_format_spec.rb", "spec/lib/reader_spec.rb", "spec/lib/transaction_spec.rb", "spec/lib/writer_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "qif.gemspec"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Qif"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{qif}
+  s.rubygems_version = %q{1.3.5}
+  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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/fixtures/3_records_ddmmyyyy.qif

@@ -0,0 +1,20 @@
+!Type:Bank
+^
+D01/01/2010
+T-10.00
+LDebit
+PDescription
+MReference
+^
+D01/06/2010
+T-20.00
+LDebit
+PDescription
+MReference
+^
+D29/12/2010
+T30.00
+LCredit
+PDescription
+MReference
+^

data/spec/fixtures/3_records_mmddyyyy.qif

@@ -0,0 +1,20 @@
+!Type:Bank
+^
+D01/01/2010
+T-10.00
+LDebit
+PDescription
+MReference
+^
+D06/01/2010
+T-20.00
+LDebit
+PDescription
+MReference
+^
+D12/29/2010
+T30.00
+LCredit
+PDescription
+MReference
+^

data/spec/lib/reader_spec.rb

@@ -0,0 +1,60 @@
+require 'spec/spec_helper'
+
+describe Qif::Reader do
+  %w(dd/mm/yyyy mm/dd/yyyy).each do |format|
+    before do
+      @file = 'spec/fixtures/3_records_%s.qif' % format.gsub('/', '')
+      @instance = Qif::Reader.new(open(@file), format)
+    end
+    
+    it 'should have 3 records' do
+      @instance.size.should == 3
+    end
+    
+    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.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.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.amount.should == 30.0
+    end
+    
+    describe '#each' do
+      it 'should yield each transaction' do
+        transactions = []
+        @instance.each do |t|
+          transactions << t
+        end
+        transactions.should == @instance.transactions
+      end
+    end
+  end
+  
+  it 'should initialize with an io object' do
+    @instance = Qif::Reader.new(open('spec/fixtures/3_records_ddmmyyyy.qif'))
+    @instance.size.should == 3
+  end
+  
+  it 'should initialize with data in a string' do
+    @instance = Qif::Reader.new(File.read('spec/fixtures/3_records_ddmmyyyy.qif'))
+    @instance.size.should == 3
+  end
+  
+  it 'should reject transactions whose date does not match the given date format' do
+    @instance = Qif::Reader.new(open('spec/fixtures/3_records_ddmmyyyy.qif'), 'mm/dd/yyyy')
+    @instance.size.should == 2
+  end
+end

data/spec/lib/transaction_spec.rb

@@ -0,0 +1,59 @@
+require 'spec/spec_helper'
+
+describe Qif::Transaction do
+  describe '::read' do
+    it 'should return a new transaction' do
+      date = Time.now
+      t = Qif::Transaction.read(
+        'D' => date,
+        'T' => '10.0',
+        'L' => 'Credit',
+        'M' => 'Supermarket',
+        'P' => 'abcde'
+      )
+      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'
+    end
+    
+    it 'should return nil if the date does not respond to strftime' do
+      Qif::Transaction.read('D' => 'hello').should be_nil
+    end
+  end
+  
+  describe '#to_s' do
+    before do
+      @instance = Qif::Transaction.new(
+        :date => Time.mktime(2010, 1, 2),
+        :amount => -10.0,
+        :name => 'Debit',
+        :description => 'Supermarket',
+        :reference => 'abcde'
+      )
+    end
+    
+    it 'should format the date in the format specified as D' do
+      @instance.to_s('dd/mm/yyyy').should include('D02/01/2010')
+      @instance.to_s('mm/dd/yyyy').should include('D01/02/2010')
+    end
+    
+    it 'should put the amount in T' do
+      @instance.to_s.should include('T-10.00')
+    end
+    
+    it 'should put the name in L' do
+      @instance.to_s.should include('LDebit')
+    end
+    
+    it 'should put the description in M' do
+      @instance.to_s.should include('MSupermarket')
+    end
+    
+    it 'should put the reference in P' do
+      @instance.to_s.should include('Pabcde')
+    end
+  end
+end

data/spec/lib/writer_spec.rb

@@ -0,0 +1,67 @@
+require 'spec/spec_helper'
+require 'stringio'
+
+describe Qif::Writer do
+  before do
+    @buffer = ''
+    @io = StringIO.new(@buffer)
+    @instance = Qif::Writer.new(@io)
+  end
+  
+  describe '::open' do
+    before do
+      @path = '/tmp/test'
+      File.stub!(:open).and_yield @io
+    end
+    
+    it 'should yield a Qif::Writer' do
+      ran = false
+      Qif::Writer.open(@path) do |writer|
+        ran = true
+        writer.should be_a(Qif::Writer)
+      end
+      ran.should be_true
+    end
+    
+    it 'should write the transactions' do
+      date = Time.now
+      
+      Qif::Writer.open(@path) do |writer|
+        writer << Qif::Transaction.new(:date => date, :amount => 10.0, :name => 'Credit')
+      end
+      
+      @buffer.should include('D%s' % date.strftime('%d/%m/%Y'))
+      @buffer.should include('T10.0')
+      @buffer.should include('LCredit')
+    end
+    
+    it 'should perform a File.open on the given path' do
+      File.should_receive(:open).with(@path, 'w')
+      Qif::Writer.open(@path) do |writer|
+      end
+    end
+  end
+  
+  describe '#write' do
+    it 'should write the header' do
+      @instance.write
+      @buffer.should include("!Type:Bank\n^")
+    end
+    
+    it 'should write any pending transactions' do
+      date = Time.now
+      @instance << Qif::Transaction.new(:date => date, :amount => 10.0, :name => 'Credit')
+      
+      @buffer.should_not include('D%s' % date.strftime('%d/%m/%Y'))
+      @instance.write
+      @buffer.should include('D%s' % date.strftime('%d/%m/%Y'))
+    end
+  end
+  
+  describe '#close' do
+    it 'should close the io stream' do
+      @io.should_receive(:close)
+      @instance.close
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--reverse
+--color
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/qif'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: qif
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Jeremy Wells
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-22 00:00:00 +13:00
+default_executable: 
+dependencies: []
+
+description: A library for reading and writing quicken QIF files.
+email: jeremy@boost.co.nz
+executables: []
+
+extensions: []
+
+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
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- Rakefile
+- lib/qif.rb
+- lib/qif/date_format.rb
+- lib/qif/reader.rb
+- lib/qif/transaction.rb
+- lib/qif/writer.rb
+- spec/fixtures/3_records_ddmmyyyy.qif
+- spec/fixtures/3_records_mmddyyyy.qif
+- spec/lib/date_format_spec.rb
+- spec/lib/reader_spec.rb
+- spec/lib/transaction_spec.rb
+- spec/lib/writer_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- qif.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Qif
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: qif
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library for reading and writing quicken QIF files.
+test_files: []
+