qif 1.0 → 1.1.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+v1.1.0 Added block version of new method to writer and error checking on
+files. [elmatou]
+
 v1.0 Added account types and fields from QIF specification. [elmatou]
 
 v0.5 Writes qif files without a record separator after the header. [jscipione]

data/Manifest

@@ -1,17 +1,24 @@
 CHANGELOG
 LICENSE
 Manifest
+QIF_references
+README.rdoc
 Rakefile
 lib/qif.rb
 lib/qif/date_format.rb
 lib/qif/reader.rb
 lib/qif/transaction.rb
 lib/qif/writer.rb
-qif.gemspec
 spec/fixtures/3_records_ddmmyy.qif
 spec/fixtures/3_records_ddmmyyyy.qif
+spec/fixtures/3_records_dmyy.qif
+spec/fixtures/3_records_invalid_header.qif
 spec/fixtures/3_records_mmddyy.qif
 spec/fixtures/3_records_mmddyyyy.qif
+spec/fixtures/3_records_separator.qif
+spec/fixtures/not_a_QIF_file.txt
+spec/fixtures/quicken_investment_account.qif
+spec/fixtures/quicken_non_investement_account.qif
 spec/lib/date_format_spec.rb
 spec/lib/reader_spec.rb
 spec/lib/transaction_spec.rb

data/QIF_references

@@ -0,0 +1,728 @@
+Have to check : http://cpansearch.perl.org/src/MMCGILLIS/Finance-QIF-2.04/lib/Finance/QIF.pm
+
+
+Source : http://web.intuit.com/support/quicken/docs/d_qif.html
+Quicken Interchange Format (QIF) files
+
+The Quicken interchange format (QIF) is a specially formatted text (ASCII) file that enables Quicken transactions to be moved from one Quicken account register into another Quicken account register, or to or from other programs that support the QIF format.
+
+Note: For Quicken to translate data from a text file into the Quicken register as transactions, the text file must be in the QIF format.
+
+Required File Formatting
+
+Each transaction must end with a symbol, indicating the end of entry. Each item in the transaction must display on a separate line. When Quicken exports an account register or list, it adds a line to the top of the file that identifies the type of account or list. Listed below are the header lines Quicken adds to the exported files:
+
+Header	            Type of data
+!Type:Bank	        Bank account transactions
+!Type:Cash	        Cash account transactions
+!Type:CCard	        Credit card account transactions
+!Type:Invst	        Investment account transactions
+!Type:Oth A	        Asset account transactions
+!Type:Oth L	        Liability account transactions
+!Account	        Account list or which account follows
+!Type:Cat	        Category list
+!Type:Class	        Class list
+!Type:Memorized	    Memorized transaction list
+
+Quicken can be configured to import all transfers, regardless of whether Ignore Transfers is selected when the file is imported. To do this, add a line to the file being imported into the Quicken account. Use a text editor or word processor to put the following line immediately after the header line at the top of the file:
+
+!Option:AllXfr
+
+
+Items for Non-Investment Accounts
+Each item in a bank, cash, credit card, other liability, or other asset account must begin with a letter that indicates the field in the Quicken
+register. The non-split items can be in any sequence:
+
+Field	Indicator Explanations
+D	Date
+T	Amount
+C	Cleared status
+N	Num (check or reference number)
+P	Payee
+M	Memo
+A	Address (up to five lines; the sixth line is an optional message)
+L	Category (Category/Subcategory/Transfer/Class)
+S	Category in split (Category/Transfer/Class)
+E	Memo in split
+$	Dollar amount of split
+^	End of entry
+Note: Repeat the S, E, and $ lines as many times as needed for additional items in a split. If an item is omitted from the transaction in the QIF file, Quicken treats it as a blank item.
+
+
+Items for Investment Accounts
+Field	Indicator Explanation
+D	Date
+N	Action
+Y	Security
+I	Price
+Q	Quantity (number of shares or split ratio)
+T	Transaction amount
+C	Cleared status
+P	Text in the first line for transfers and reminders
+M	Memo
+O	Commission
+L	Account for the transfer
+$	Amount transferred
+^	End of entry
+
+
+Items for Account Information
+The account header !Account is used in two places, at the start of an account list and the start of a list of transactions to specify to which account they belong.
+Field	Indicator Explanation
+N	Name
+T	Type of account
+D	Description
+L	Credit limit (only for credit card account)
+/	Statement balance date
+$	Statement balance
+^	End of entry
+
+
+Items for a Category List
+Field	Indicator Explanation
+N	Category name:subcategory name
+D	Description
+T	Tax related if included, not tax related if omitted
+I	Income category
+E	Expense category (if category is unspecified, Quicken assumes expense type)
+B	Budget amount (only in a Budget Amounts QIF file)
+R	Tax schedule information
+^	End of entry
+
+
+Items for a Class List
+Field	Indicator Explanation
+N	Class name
+D	Description
+^	End of entry
+ 	 
+Items for a Memorized Transaction List
+
+Immediately preceding the ^ character, each entry must end with one of the following file indicators to specify the transaction type.
+KC, KD, KP, KI, KE
+
+With that exception, memorized transaction entries have the same format as regular transaction entries (non-investment accounts). However, the Date or Num field is included. All items are optional, but if an amortization record is included, all seven amortization lines must also be included.
+
+Field	Indicator Explanation
+KC	Check transaction
+KD	Deposit transaction
+KP	Payment transaction
+KI	Investment transaction
+KE	Electronic payee transaction
+T	Amount
+C	Cleared status
+P	Payee
+M	Memo
+A	Address
+L	Category or Transfer/Class
+S	Category/class in split
+E	Memo in split
+$	Dollar amount of split
+1	Amortization: First payment date
+2	Amortization: Total years for loan
+3	Amortization: Number of payments already made
+4	Amortization: Number of periods per year
+5	Amortization: Interest rate
+6	Amortization: Current loan balance
+7	Amortization: Original loan amount
+^	End of entry
+
+
+Examples of QIF files
+
+Normal Transactions Example
+Transaction Item	Comment (not in file)
+!Type:Bank	Header
+D6/ 1/94	Date
+T-1,000.00	Amount
+N1005	Check number
+PBank Of Mortgage	Payee
+L[linda]	Category
+S[linda]	First category in split
+$-253.64	First amount in split
+SMort Int	Second category in split
+$=746.36	Second amount in split
+^	End of transaction
+D6/ 2/94	Date
+T75.00	Amount
+PDeposit	Payee
+^	End of transaction
+D6/ 3/94	Date
+T-10.00	Amount
+PAnthony Hopkins	Payee
+MFilm	Memo
+LEntertain	Category
+AP.O. Box 27027	Address (line 1)
+ATucson, AZ	Address (line 2)
+A85726	Address (line 3)
+A	Address (line 4)
+A	Address (line 5)
+A	Address (line 6)
+^	End of transaction
+
+Investment Example
+Transaction Item	Comment (not in file)
+!Type:Invst	Header line
+D8/25/93	Date
+NShrsIn	Action (optional)
+Yibm4	Security
+I11.260	Price
+Q88.81	Quantity
+CX	Cleared status
+T1,000.00	Amount
+MOpening	Balance Memo
+^	End of transaction
+D8/25/93	Date
+NBuyX	Action
+Yibm4	Security
+I11.030	Price
+Q9.066	Quantity
+T100.00	Amount
+MEst. price as of 8/25/93	Memo
+L[CHECKING]	Account for transfer
+$100.00	Amount transferred
+^	End of transaction
+
+Memorized List Example
+Transaction Item	Comment (not in file)
+!Type:Memorized	Header line
+T-50.00	Amount
+POakwood Gardens	Payee
+MRent	Memo
+KC	Check transaction
+^	End of transaction
+	 
+
+Source :http://www.beansmart.com/quicken/Converting-Fidelity-CVS-to-QIF-or-OFX-for-Quicken-2007-5296-1.htm
+
+Collected over the years:
+
+ QUICKEN INTERCHANGE FORMAT (QIF)
+
+Overview
+You can export transactions from a Quicken account register to a
+specially formatted text file and import data to a Quicken register
+from the same type of text file.  This text file MUST be formatted
+as a Quicken Interchange Format (QIF) file.  For Quicken to
+translate data from a text file into the Quicken register as
+transactions, the data must be in the QIF format.
+
+Procedure
+Basic Procedures:
+* Each transaction must end with a * symbol
+* Each item in the transaction must appear on a separate line
+* When Quicken exports an account register, it adds a line at the
+ top of the file that identifies the type of account.  Here are
+ the header lines Quicken adds to the exported files:
+
+  !Type:Bank
+  !Type:Cash
+  !Type:CCard
+  !Type:Invst
+  !Type:Oth A
+  !Type:Oth L
+
+* You can add a line to a file to be imported into Quicken account
+ to force Quicken to import all transfers, regardless of whether
+ Ignore Transfers is selected when the file is imported.  Use a
+ test editor or word processor to put the following line right
+ after the header line at the top of the file:
+
+  !Option:AllXfr
+
+
+Items for non-investment accounts
+
+Each item in a bank, cash, credit card, other liability, or other
+asset account must begin with a letter that indicates the field in
+the Quicken register.  The non-split items can be in any sequence:
+
+ D Date
+ T Amount
+ C Cleared status
+ N Number(check or reference number)
+ P Payee
+ A Address (up to five lines; the sixth line is an optional
+  message)
+ L Category (Category/Subcategory/Transfer/Class
+ S Category in split (Category/Transfer/Class)
+ E Memo in split
+ $ Dollar amount of split
+ ^ End of the entry
+
+Items for investment accounts
+ D Date
+ N Action
+ Y Security
+ I Price
+ Q Quantity (Number of shares or split ratio)
+ C Cleared Status
+ P. Text in the first line for transfers and reminders
+ M Memo
+ O Commission
+ L Account for the transfer
+ $ Amount transferred
+ ^ End of the entry
+
+Repeat the S, E, and $ lines as many times as needed for additional
+items in a split.  If an item is omitted from the transaction in the
+QIF file, Quicken treats it as a blank item.
+
+
+
+                              Examples of QIF files
+
+Transaction Item    Comment (not in file)
+!Type:Bank          Header line
+D7/8/93             Date
+T-1000.0            Transaction amount
+CX                  Status in Cleared column
+N255                Check Number
+PFranks Plumbing    Payee
+AFranks Plumbing    Address (first line)
+A1234 Main St.      Address (second line)
+ASan Jose, CA 95123 Address (third line)
+LHome Maint         Category/Subcategory/Transfer/Class
+^      End of the transaction
+D7/8/93             Date
+T-75.46             Transaction amount
+CX                  Status in Cleared column
+N256                Check Number
+PWalts Drug         Payee
+LSupplies           First Category/Subcategory/Class in
+                    the split
+EOffices Supplies   First memo in the split
+$-51.00             First amount in the split
+SMedicine           Second Category/Subcategory/Class in the
+                    split
+EPrescription Drugs Second memo in the split
+$-24.46             Second amount in the split
+^      End of the transaction
+
+Transaction Item    Comment (not in file)
+!Type:Bank          Header line
+D8/25/93            Date
+NShrsIn             Action (optional)
+Yibm4               Security
+I11.260             Price
+Q88.81              Quantity
+CX                  Cleared Status
+T1,000.00           Amount
+MOpening Balance    Memo
+^       End of the transaction
+D8/25/93            Date
+NBuyX               Action
+Yibm4               Security
+I11.030             Price
+Q9.066              Quantity
+T100.00             Amount
+MEst. price as of 8/25/93
+                    Memo
+L[CHECKING]         Account for transfer
+$100.00             Amount transferred
+^       End of the transaction
+
+At Intuit, we highly recommend that you backup your Quicken data
+regularly to protect against loss due to unexpected power failures,
+diskette damage or other mishaps.  If you need further assistance,
+you may contact Intuit Technical Support at (415) 858-6050, Monday
+through Friday between 5 am and 5 pm Pacific time.
+
+--- Another entry of this info ---
+Export headers for QIF files
+
+Export headers in QIF files divide separate groups of items such
+as accounts or transactions. They can also signify options. Export
+headers follow the general format:
+
+!<Header name>:<Export type>
+
+Exportable accounts
+
+The table below lists the types of accounts that can be exported
+and their export headers:
+
+Export Header Type of account
+!Type:Bank       Bank account
+!Type:Cash       Cash account
+!Type:CCard       Credit card account
+!Type:Invst       Investment account
+!Type:Oth A       Asset account
+!Type:Oth L       Liability account
+!Type:Invoice Invoice account (business subtype of Oth A)
+!Type:Tax       Tax account (business subtype of Oth L)
+!Type:Bill       Bill account (business subtype of Oth L)
+An account header is followed by transaction records if there are
+any within the selected date range.
+
+Exportable lists
+
+The table below lists the types of lists that can be exported and
+their export headers:
+
+Export Header Type of list
+!Type:Class       Class list
+!Type:Cat       Category list
+!Type:Memorized Memorized transactions list
+!Type:Security Securities list
+!Type:Prices Security Prices list
+!Type:Budget Budgets list
+!Type:Invitem Invoice items list
+!Type:Template Business templates list
+A list header is followed by records of the selected list type.
+
+Options headers
+
+Below is the option you can use, and its action:
+
+Export Header Meaning
+!Option:AllXfr Forces transfers to be imported, even if Ignore
+Transfers is set.
+Account headers
+
+Export Header     Meaning
+!Option:AutoSwitch    Start of the Accounts list
+!Account           Beginning of accounts list records
+!Clear:AutoSwitch     End of the Accounts list
+!Account is followed by either a list of account records for the
+Accounts list or a single account record for the selected account
+transactions.
+
+Copyright (c) 1999 Intuit, Inc.
+
+
+
+Identifiers for non-investment accounts
+
+Use these letters to identify specific items in a non-investment
+430 No such article
+Howard Kaikow wrote:
+
+Collected over the years:
+
+ QUICKEN INTERCHANGE FORMAT (QIF)
+
+Overview
+You can export transactions from a Quicken account register to a
+specially formatted text file and import data to a Quicken register
+from the same type of text file.  This text file MUST be formatted
+as a Quicken Interchange Format (QIF) file.  For Quicken to
+translate data from a text file into the Quicken register as
+transactions, the data must be in the QIF format.
+
+Procedure
+Basic Procedures:
+* Each transaction must end with a * symbol
+* Each item in the transaction must appear on a separate line
+* When Quicken exports an account register, it adds a line at the
+ top of the file that identifies the type of account.  Here are
+ the header lines Quicken adds to the exported files:
+
+  !Type:Bank
+  !Type:Cash
+  !Type:CCard
+  !Type:Invst
+  !Type:Oth A
+  !Type:Oth L
+
+* You can add a line to a file to be imported into Quicken account
+ to force Quicken to import all transfers, regardless of whether
+ Ignore Transfers is selected when the file is imported.  Use a
+ test editor or word processor to put the following line right
+ after the header line at the top of the file:
+
+  !Option:AllXfr
+
+
+Items for non-investment accounts
+
+Each item in a bank, cash, credit card, other liability, or other
+asset account must begin with a letter that indicates the field in
+the Quicken register.  The non-split items can be in any sequence:
+
+ D Date
+ T Amount
+ C Cleared status
+ N Number(check or reference number)
+ P Payee
+ A Address (up to five lines; the sixth line is an optional
+  message)
+ L Category (Category/Subcategory/Transfer/Class
+ S Category in split (Category/Transfer/Class)
+ E Memo in split
+ $ Dollar amount of split
+ ^ End of the entry
+
+Items for investment accounts
+ D Date
+ N Action
+ Y Security
+ I Price
+ Q Quantity (Number of shares or split ratio)
+ C Cleared Status
+ P. Text in the first line for transfers and reminders
+ M Memo
+ O Commission
+ L Account for the transfer
+ $ Amount transferred
+ ^ End of the entry
+
+Repeat the S, E, and $ lines as many times as needed for additional
+items in a split.  If an item is omitted from the transaction in the
+QIF file, Quicken treats it as a blank item.
+
+
+
+                              Examples of QIF files
+
+Transaction Item    Comment (not in file)
+!Type:Bank          Header line
+D7/8/93             Date
+T-1000.0            Transaction amount
+CX                  Status in Cleared column
+N255                Check Number
+PFranks Plumbing    Payee
+AFranks Plumbing    Address (first line)
+A1234 Main St.      Address (second line)
+ASan Jose, CA 95123 Address (third line)
+LHome Maint         Category/Subcategory/Transfer/Class
+^      End of the transaction
+D7/8/93             Date
+T-75.46             Transaction amount
+CX                  Status in Cleared column
+N256                Check Number
+PWalts Drug         Payee
+LSupplies           First Category/Subcategory/Class in
+                    the split
+EOffices Supplies   First memo in the split
+$-51.00             First amount in the split
+SMedicine           Second Category/Subcategory/Class in the
+                    split
+EPrescription Drugs Second memo in the split
+$-24.46             Second amount in the split
+^      End of the transaction
+
+Transaction Item    Comment (not in file)
+!Type:Bank          Header line
+D8/25/93            Date
+NShrsIn             Action (optional)
+Yibm4               Security
+I11.260             Price
+Q88.81              Quantity
+CX                  Cleared Status
+T1,000.00           Amount
+MOpening Balance    Memo
+^       End of the transaction
+D8/25/93            Date
+NBuyX               Action
+Yibm4               Security
+I11.030             Price
+Q9.066              Quantity
+T100.00             Amount
+MEst. price as of 8/25/93
+                    Memo
+L[CHECKING]         Account for transfer
+$100.00             Amount transferred
+^       End of the transaction
+
+At Intuit, we highly recommend that you backup your Quicken data
+regularly to protect against loss due to unexpected power failures,
+diskette damage or other mishaps.  If you need further assistance,
+you may contact Intuit Technical Support at (415) 858-6050, Monday
+through Friday between 5 am and 5 pm Pacific time.
+
+--- Another entry of this info ---
+Export headers for QIF files
+
+Export headers in QIF files divide separate groups of items such
+as accounts or transactions. They can also signify options. Export
+headers follow the general format:
+
+!<Header name>:<Export type>
+
+Exportable accounts
+
+The table below lists the types of accounts that can be exported
+and their export headers:
+
+Export Header Type of account
+!Type:Bank       Bank account
+!Type:Cash       Cash account
+!Type:CCard       Credit card account
+!Type:Invst       Investment account
+!Type:Oth A       Asset account
+!Type:Oth L       Liability account
+!Type:Invoice Invoice account (business subtype of Oth A)
+!Type:Tax       Tax account (business subtype of Oth L)
+!Type:Bill       Bill account (business subtype of Oth L)
+An account header is followed by transaction records if there are
+any within the selected date range.
+
+Exportable lists
+
+The table below lists the types of lists that can be exported and
+their export headers:
+
+Export Header Type of list
+!Type:Class       Class list
+!Type:Cat       Category list
+!Type:Memorized Memorized transactions list
+!Type:Security Securities list
+!Type:Prices Security Prices list
+!Type:Budget Budgets list
+!Type:Invitem Invoice items list
+!Type:Template Business templates list
+A list header is followed by records of the selected list type.
+
+Options headers
+
+Below is the option you can use, and its action:
+
+Export Header Meaning
+!Option:AllXfr Forces transfers to be imported, even if Ignore
+Transfers is set.
+Account headers
+
+Export Header     Meaning
+!Option:AutoSwitch    Start of the Accounts list
+!Account           Beginning of accounts list records
+!Clear:AutoSwitch     End of the Accounts list
+!Account is followed by either a list of account records for the
+Accounts list or a single account record for the selected account
+transactions.
+
+Copyright (c) 1999 Intuit, Inc.
+
+
+
+Identifiers for non-investment accounts
+
+Use these letters to identify specific items in a non-investment
+account transaction. Each line in the transaction must begin with
+one of these letters:
+
+Letter What it means
+D Date
+T Amount of transaction
+U Amount of transaction (higher possible value than T)
+C Cleared status
+N Number (check or reference)
+P Payee/description
+M Memo
+A Address (up to 5 lines; 6th line is an optional message)
+L Category/class or transfer/class
+S Category in split (category/class or transfer/class)
+E Memo in split
+$ Dollar amount of split
+% Percentage of split if percentages are used
+F Reimbursable business expense flag
+^ End of entry
+Repeat the S, E, % and $ lines as many times as necessary for
+additional items in a split. If an item is omitted from the
+transaction in the QIF file, Quicken treats it as a blank item.
+
+Copyright (c) 1999 Intuit, Inc.
+
+
+Identifiers for investment accounts
+
+Use these letters to identify specific items in an investment
+account transaction. Each line in the transaction must begin with
+one of these letters:
+
+   Letter What it means
+D Date (optional)
+N Action
+Y Security
+I Price
+Q Quantity (# of shares or split ratio)
+C Cleared status
+P 1st line text for transfers/reminders
+M Memo
+O Commission
+L For MiscIncX or MiscExpX actions:Category/class followed by
+|transfer/class of the transaction
+ For MiscInc or MiscExp actions:Category/class of the transaction
+ For all other actions:Transfer/class of the transactions
+T Amount of transaction
+U Amount of transaction (higher possible value than T)
+$ Amount transferred
+^ End of entry
+If an item is omitted from the transaction in the QIF file,
+Quicken treats it as a blank item.
+
+Copyright (c) 1999 Intuit, Inc.
+
+
+
+Identifiers for memorized transaction items
+
+Use these letters to identify specific items in a memorized
+transaction. Each line in the transaction must begin with one of
+these letters or combination of letters:
+
+Memorized transaction identifiers
+
+The table below lists the identifiers for Memorized Transaction
+items and what they mean:
+
+Letter What it means
+   K Transaction type
+   KI Memorized investment transaction
+   KE Memorized regular electronic payment transaction
+   KC Memorized regular write checks transaction
+   KP Memorized regular payment transaction
+   KD Memorized regular deposit transaction
+   Q Quantity (number of new shares for a split)
+   R Quantity (number of old shares for a split)
+You can also use the identifiers for investment and non-investment
+transactions, as necessary. Electronic payments, write checks,
+payments, and deposits are regular transaction types.
+Memorized loan payment also supports the following identifiers:
+
+Letter What it means
+   1 First payment date
+   2 Total years of the loan
+   3 Number of payments made
+   4 Payment periods per year
+   5 Loan rate
+   6 Current balance of the loan
+   7 Original balance of the loan
+
+Copyright (c) 1999 Intuit, Inc.
+
+
+Identifiers for business transaction items (Home & Business)
+
+Use these letters to identify specific business-related items in a
+non-investment account transaction. Each line in the transaction
+must begin with one of these letter combinations:
+
+Letter What it means
+XI Invoice type
+XE Payment due date
+XU Number of payments
+XD Date for a payment
+XY Payment amount
+XC Sales tax Category
+XR Sales tax rate
+XT Sales Tax amount
+XP PO number
+XA Shipping/Vendor address (up to 5 lines)
+XM Customer message
+XK Default split class
+XN Name of invoice item
+X$ Price per item of a split
+X# Number of items in a split
+XS Split item description
+XFT Taxable split item flag
+^ End of entry
+Repeat the XS, XK, X Ft, X# and X$ lines as many times as
+necessary for additional items in a split. If an item is omitted
+from the transaction in the QIF file, Quicken treats it as a blank
+item.
+
+Copyright (c) 1999 Intuit, Inc.
+
+
+

data/README.rdoc

@@ -0,0 +1,45 @@
+= Library for reading Quicken Interchange Format (QIF) files
+
+* http://github.com/jemmyw/Qif
+
+=== INSTALL:
+
+* sudo gem install qif
+
+=== DOCUMENTATION:
+
+* http://rdoc.info/gems/qif/0.2/frames
+
+=== EXAMPLE:
+
+  require 'qif'
+  qif = Qif::Reader.new(open('/path/to/file.qif'))
+  qif.each do |transaction|
+    puts [transaction.name, transaction.description, transaction.amount].join(", ")
+  end
+
+=== LICENSE:
+
+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/lib/qif/reader.rb

@@ -25,16 +25,20 @@ module Qif
     }
 
     class UnknownAccountType < StandardError; end
-    
+    class UnrecognizedData < 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 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.
+    # 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(UnrecognizedData, "Provided data doesn't seems to represent a QIF file") unless @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
@@ -130,6 +134,7 @@ module Qif
       unless line =~ /^\^/
         rewind_to @data.lineno - 1
       end
+      headers
     end
   
     def read_transaction

data/lib/qif/transaction.rb

@@ -4,18 +4,18 @@ module Qif
   # The Qif::Transaction class represents transactions in a qif file.
   class Transaction
     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"}
+      :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,
@@ -43,7 +43,7 @@ module Qif
         next unless current = instance_variable_get("@#{k}")
         field = v.keys
         case current.class.to_s
-        when "Time"
+        when "Time", "Date", "DateTime"
           "#{field}#{DateFormat.new(format).format(current)}"
         when "Float"
           "#{field}#{'%.2f'%current}"

data/lib/qif/writer.rb

@@ -18,26 +18,45 @@ module Qif
     
     # 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')
+    def self.open(path, type = 'Bank', format = 'dd/mm/yyyy', &block)
       File.open(path, 'w') do |file|
-        writer = self.new(file, type, format)
-        yield writer
-        writer.write
+        self.new(file, type, format, &block)
       end
     end
     
     # Create a new Qif::Writer. Expects an IO object or a filepath.
+    # Can optionally take a block which will yield the writer and
+    # automatically call write afterwards.
     #
     # 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'
+    #
+    # Usage:
+    #   buffer = StringIO.new
+    #   writer = Qif::Writer.new(buffer)
+    #   writer << Qif::Transaction.new(:date => Time.now, :amount => 10.0, :name => 'Credit')
+    #   writer.write
+    #   puts buffer
+    #
+    # Usage with block:
+    #   buffer = StringIO.new
+    #   Qif::Writer.new(buffer) do |writer|
+    #     writer << Qif::Transaction.new(:date => Time.now, :amount => 10.0, :name => 'Credit')
+    #   end
+    #   puts buffer
     def initialize(io, type = 'Bank', format = 'dd/mm/yyyy')
       @io = io.respond_to?(:write) ? io : File.open(io, 'w')
       @type = type
       @format = format
       @transactions = []
+      
+      if block_given?
+        yield self
+        self.write
+      end
     end
     
     # Add a transaction for writing

data/qif.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{qif}
-  s.version = "1.0"
+  s.version = "1.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{2011-02-19}
+  s.date = %q{2011-03-07}
   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"]
-  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", "qif.gemspec", "spec/fixtures/3_records_ddmmyy.qif", "spec/fixtures/3_records_ddmmyyyy.qif", "spec/fixtures/3_records_mmddyy.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"]
-  s.homepage = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "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", "QIF_references", "README.rdoc", "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_ddmmyy.qif", "spec/fixtures/3_records_ddmmyyyy.qif", "spec/fixtures/3_records_dmyy.qif", "spec/fixtures/3_records_invalid_header.qif", "spec/fixtures/3_records_mmddyy.qif", "spec/fixtures/3_records_mmddyyyy.qif", "spec/fixtures/3_records_separator.qif", "spec/fixtures/not_a_QIF_file.txt", "spec/fixtures/quicken_investment_account.qif", "spec/fixtures/quicken_non_investement_account.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{http://qif.github.com/qif/}
   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.5.0}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{A library for reading and writing quicken QIF files.}
 
   if s.respond_to? :specification_version then

data/spec/fixtures/3_records_dmyy.qif

@@ -0,0 +1,19 @@
+!Type:Bank
+D1/1/10
+T-10.00
+LDebit
+PDescription
+MReference
+^
+D1/6/10
+T-20.00
+LDebit
+PDescription
+MReference
+^
+D29/12/10
+T30.00
+LCredit
+PDescription
+MReference
+^

data/spec/fixtures/3_records_invalid_header.qif

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

data/spec/fixtures/3_records_separator.qif

@@ -0,0 +1,19 @@
+!Type:Bank
+D01/01/2010
+T-1,010.00
+LDebit
+PDescription
+MReference
+^
+D01/06/2010
+T-30,020.00
+LDebit
+PDescription
+MReference
+^
+D29/12/2010
+T30.00
+LCredit
+PDescription
+MReference
+^

data/spec/fixtures/not_a_QIF_file.txt

@@ -0,0 +1,3 @@
+Tchen tenterait-il de lever la moustiquaire ? Frapperait-il au travers ? L’angoisse lui tordait l’estomac ; il connaissait sa propre fermeté, mais n’était capable en cet instant que d’y songer avec hébétude, fasciné par ce tas de mousseline blanche qui tombait du plafond sur un corps moins visible qu’une ombre, et d’où sortait seulement ce pied à demi incliné par le sommeil, vivant quand même — de la chair d’homme. La seule lumière venait du building voisin : un grand rectangle d’électricité pâle, coupé par les barreaux de la fenêtre dont l’un rayait le lit juste au-dessous du pied comme pour en accentuer le volume et la vie. Quatre ou cinq klaxons grincèrent à la fois. Découvert ? Combattre, combattre des ennemis qui se défendent, des ennemis éveillés  !
+
+Incipit de "La Condition humaine", André Malraux, 1933

data/spec/fixtures/quicken_investment_account.qif

@@ -0,0 +1,20 @@
+!Type:Invst
+D8/25/93
+NShrsIn
+Yibm4
+I11.260
+Q88.81
+CX
+T1,000.00
+MOpening
+^
+D8/25/93
+NBuyX
+Yibm4
+I11.030
+Q9.066
+T100.00
+MEst. price as of 8/25/93
+L[CHECKING]
+$100.00
+^

data/spec/fixtures/quicken_non_investement_account.qif

@@ -0,0 +1,30 @@
+!Type:Bank
+D6/1/94
+T-1,000.00
+CX
+N1005
+PBank Of Mortgage
+MMemo
+L[linda]
+S[linda]
+ECash
+$-253.64
+SMort Int
+$=746.36
+^
+D6/2/94
+T75.00
+PDeposit
+^
+D6/3/94
+T-10.00
+PAnthony Hopkins
+MFilm
+LEntertain
+AP.O. Box 27027
+ATucson, AZ
+A85726
+A
+A
+A
+^

data/spec/lib/reader_spec.rb

@@ -55,7 +55,9 @@ describe Qif::Reader do
   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 reject the wrong file and raise an UnrecognizedData exception' do
+    expect{ Qif::Reader.new(open('spec/fixtures/not_a_QIF_file.txt')) }.to raise_error(Qif::Reader::UnrecognizedData)
+  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'

data/spec/lib/writer_spec.rb

@@ -41,6 +41,38 @@ describe Qif::Writer do
       end
     end
   end
+  describe '::new' do
+    it 'should yield a Qif::Writer' do
+      ran = false
+      Qif::Writer.new(@io) 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.new(@io) do |writer|
+        writer << Qif::Transaction.new(:date => date, :amount => 10.0, :category => '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
@@ -64,4 +96,4 @@ describe Qif::Writer do
       @instance.close
     end
   end
-end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qif
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  version: "1.0"
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jeremy Wells
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-19 00:00:00 +13:00
+date: 2011-03-07 00:00:00 +13:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +28,7 @@ extensions: []
 extra_rdoc_files: 
 - CHANGELOG
 - LICENSE
+- README.rdoc
 - lib/qif.rb
 - lib/qif/date_format.rb
 - lib/qif/reader.rb
@@ -36,25 +38,33 @@ files:
 - CHANGELOG
 - LICENSE
 - Manifest
+- QIF_references
+- README.rdoc
 - Rakefile
 - lib/qif.rb
 - lib/qif/date_format.rb
 - lib/qif/reader.rb
 - lib/qif/transaction.rb
 - lib/qif/writer.rb
-- qif.gemspec
 - spec/fixtures/3_records_ddmmyy.qif
 - spec/fixtures/3_records_ddmmyyyy.qif
+- spec/fixtures/3_records_dmyy.qif
+- spec/fixtures/3_records_invalid_header.qif
 - spec/fixtures/3_records_mmddyy.qif
 - spec/fixtures/3_records_mmddyyyy.qif
+- spec/fixtures/3_records_separator.qif
+- spec/fixtures/not_a_QIF_file.txt
+- spec/fixtures/quicken_investment_account.qif
+- spec/fixtures/quicken_non_investement_account.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: ""
+homepage: http://qif.github.com/qif/
 licenses: []
 
 post_install_message: 
@@ -89,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: qif
-rubygems_version: 1.5.0
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: A library for reading and writing quicken QIF files.