qiflib 0.0.6 → 0.1.0

data/html/Qiflib.html

@@ -158,7 +158,12 @@
 		<h1 class="module">Qiflib</h1>
 
 		<div id="description">
-			
+			<p>
+This file, and <a href="Qiflib.html">Qiflib</a> module, define constant
+values used in this library. This include the lists of field names within
+the csv and delimited files.
+</p>
+
 		</div>
 
 		<!-- Constants -->
@@ -177,6 +182,16 @@
 				<dd class="description"></dd>
 				
 			
+				<dt><a name="AUTHOR">AUTHOR</a></dt>
+				
+				<dd class="description"></dd>
+				
+			
+				<dt><a name="EMAIL">EMAIL</a></dt>
+				
+				<dd class="description"></dd>
+				
+			
 				<dt><a name="SOURCE_QUICKEN">SOURCE_QUICKEN</a></dt>
 				
 				<dd class="description"></dd>
@@ -220,10 +235,10 @@
 					<div class="method-source-code"
 						id="csv-category-field-names-source">
 <pre>
-   <span class="ruby-comment cmt"># File lib/qiflib_constants.rb, line 7</span>
-7:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">csv_category_field_names</span>
-8:     <span class="ruby-node">%( id name )</span>
-9:   <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/qiflib_constants.rb, line 14</span>
+14:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">csv_category_field_names</span>
+15:     <span class="ruby-node">%( id name )</span>
+16:   <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -254,39 +269,39 @@
 					<div class="method-source-code"
 						id="csv-transaction-field-names-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/qiflib_constants.rb, line 11</span>
-11:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">csv_transaction_field_names</span>
-12:     <span class="ruby-node">%(
-13:       id
-14:       acct_owner
-15:       acct_name
-16:       acct_type
-17:       date
-18:       amount
-19:       number
-20:       ibank_n
-21:       cleared
-22:       payee
-23:       category
-24:       memo
-25:       split1_amount
-26:       split1_category
-27:       split1_memo
-28:       split2_amount
-29:       split2_category
-30:       split2_memo
-31:       split3_amount
-32:       split3_category
-33:       split3_memo
-34:       address1
-35:       address2
-36:       address3
-37:       address4
-38:       address5
-39:       address6
-40:       eol_ind
-41:     )</span>
-42:   <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/qiflib_constants.rb, line 18</span>
+18:   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">csv_transaction_field_names</span>
+19:     <span class="ruby-node">%(
+20:       id
+21:       acct_owner
+22:       acct_name
+23:       acct_type
+24:       date
+25:       amount
+26:       number
+27:       ibank_n
+28:       cleared
+29:       payee
+30:       category
+31:       memo
+32:       split1_amount
+33:       split1_category
+34:       split1_memo
+35:       split2_amount
+36:       split2_category
+37:       split2_memo
+38:       split3_amount
+39:       split3_category
+40:       split3_memo
+41:       address1
+42:       address2
+43:       address3
+44:       address4
+45:       address5
+46:       address6
+47:       eol_ind
+48:     )</span>
+49:   <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>

data/html/README_rdoc.html

@@ -87,7 +87,8 @@ A ruby library for reading and parsing qif files.
 </p>
 <p>
 Transaction parsing is supported, including address fields, and up to three
-&#8220;splits&#8221; per transaction.
+&#8220;splits&#8221; per transaction.  See the DDL, below, for the list of
+fields for each transaction.
 </p>
 <p>
 Category-name parsing is also supported.
@@ -164,7 +165,7 @@ transactions into a sqlite3 database.
   
   ... write sh_lines to a file; chmod 744; run it.
 </pre>
-<h2>Generated DDL and shell script</h2>
+<h2>Generated DDL</h2>
 <pre>
   # DDL file for sqlite3
 
@@ -211,7 +212,9 @@ transactions into a sqlite3 database.
 
   .import qiflib_transactions.txt transactions
   .import qiflib_categories.txt   categories
-
+</pre>
+<h2>Generated shell script </h2>
+<pre>
   # bash-shell script 
 
   #!/bin/bash

data/html/index.html

@@ -29,7 +29,8 @@ A ruby library for reading and parsing qif files.
 </p>
 <p>
 Transaction parsing is supported, including address fields, and up to three
-&#8220;splits&#8221; per transaction.
+&#8220;splits&#8221; per transaction.  See the DDL, below, for the list of
+fields for each transaction.
 </p>
 <p>
 Category-name parsing is also supported.
@@ -106,7 +107,7 @@ transactions into a sqlite3 database.
   
   ... write sh_lines to a file; chmod 744; run it.
 </pre>
-<h2>Generated DDL and shell script</h2>
+<h2>Generated DDL</h2>
 <pre>
   # DDL file for sqlite3
 
@@ -153,7 +154,9 @@ transactions into a sqlite3 database.
 
   .import qiflib_transactions.txt transactions
   .import qiflib_categories.txt   categories
-
+</pre>
+<h2>Generated shell script </h2>
+<pre>
   # bash-shell script 
 
   #!/bin/bash

data/html/lib/qiflib_constants_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2012-04-08 14:25:28 -0400</dd>
+			<dd class="modified-date">2012-04-08 18:06:47 -0400</dd>
 
 			
 			<dt class="requires">Requires</dt>
@@ -43,7 +43,12 @@
 		
 		<div class="description">
 			<h2>Description</h2>
-			
+			<p>
+This file, and <a href="../Qiflib.html">Qiflib</a> module, define constant
+values used in this library. This include the lists of field names within
+the csv and delimited files.
+</p>
+
 		</div>
 		
 	</div>

data/html/lib/qiflib_date_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2012-04-01 07:21:12 -0400</dd>
+			<dd class="modified-date">2012-04-08 17:58:12 -0400</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/html/lib/qiflib_money_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2012-04-06 06:36:16 -0400</dd>
+			<dd class="modified-date">2012-04-08 17:59:05 -0400</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/html/lib/qiflib_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2012-04-07 08:29:46 -0400</dd>
+			<dd class="modified-date">2012-04-08 17:57:04 -0400</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/html/lib/qiflib_transaction_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2012-04-08 11:15:25 -0400</dd>
+			<dd class="modified-date">2012-04-08 16:59:52 -0400</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/html/lib/qiflib_util_rb.html

@@ -24,7 +24,7 @@
 	<div id="metadata">
 		<dl>
 			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date">2012-04-08 16:11:43 -0400</dd>
+			<dd class="modified-date">2012-04-08 18:06:21 -0400</dd>
 
 			
 			<dt class="requires">Requires</dt>

data/lib/qiflib.rb

@@ -2,7 +2,7 @@
 # standard libraries
 require 'csv'
 
-# third-party libs
+# third-party libs - none
 
 # application code
 require 'qiflib_constants'

data/lib/qiflib_constants.rb

@@ -1,6 +1,13 @@
+
+# This file, and Qiflib module, define constant values used in this library.
+# This include the lists of field names within the csv and delimited files.
+  
 module Qiflib
-  VERSION        = '0.0.6'
+
+  VERSION        = '0.1.0'
   DATE           = '2012-04-08'
+  AUTHOR         = 'Chris Joakim' 
+  EMAIL          = 'cjoakim@bellsouth.net'
   SOURCE_QUICKEN = 'quicken'
   SOURCE_IBANK   = 'ibank'
 

data/lib/qiflib_date.rb

@@ -1,12 +1,9 @@
-=begin rdoc
-
-Instances of this class represent a date from within a qif file,
-such as 'D5/24/94'.
-
-=end
 
 module Qiflib
 
+  # Instances of this class represent a date from within a qif file,
+  # such as 'D5/24/94'.
+  
   class Date
 
     attr_accessor :string_value, :ccyymmdd, :year, :year_mm, :yy, :mm, :dd

data/lib/qiflib_money.rb

@@ -1,6 +1,8 @@
 
 module Qiflib
 
+  # Instances of this class represent a dollar amount values from within a qif file.
+  
   class Money
 
     attr_reader :string_value

data/lib/qiflib_util.rb

@@ -46,6 +46,9 @@ module Qiflib
       csv_lines
     end 
 
+    # Return lines in ^-delimited format which contain the list of categories
+    # within the given Array of filenames.  
+    
     def self.catetory_names_to_delim(files_list)
       delim_lines, csv_lines = [], catetory_names_to_csv(files_list)
       csv_lines.each_with_index { | csv_line, idx |
@@ -61,6 +64,11 @@ module Qiflib
       }
       delim_lines
     end
+
+    # Return lines in CSV format which contain the list of transactions
+    # within the given input_list Array.  Each Hash within the input_list
+    # should contain keys :owner, :filename, and :source.  Specify either 
+    # the value Qiflib::SOURCE_IBANK or Qiflib::SOURCE_QUICKEN for :source.
     
     def self.transactions_to_csv(input_list)
       transactions, csv_lines = [], []
@@ -78,6 +86,11 @@ module Qiflib
       end
       csv_lines
     end 
+
+    # Return lines in ^-delimited format which contain the list of transactions
+    # within the given input_list Array.  Each Hash within the input_list
+    # should contain keys :owner, :filename, and :source.  Specify either 
+    # the value Qiflib::SOURCE_IBANK or Qiflib::SOURCE_QUICKEN for :source.
     
     def self.transactions_to_delim(input_list)
       delim_lines, csv_lines = [], transactions_to_csv(input_list)
@@ -95,6 +108,9 @@ module Qiflib
       delim_lines
     end
     
+    # Return the lines of DDL for a sqlite3 database, with 'categories' and
+    # 'transactions' tables.  The DDL will also import the ^-delimited files.
+    
     def self.generate_sqlite_ddl
       lines = []
       lines << ''
@@ -144,6 +160,9 @@ module Qiflib
       lines << ''  
       lines
     end
+
+    # Return the lines of bash-shell script to load the sqlite3 database via 
+    # the DDL generated in method 'generate_sqlite_ddl'.
     
     def self.generate_sqlite_load_script(db_name='qiflib.db', ddl_name='qiflib.ddl')
       lines = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qiflib
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70146959247960 !ruby/object:Gem::Requirement
+  requirement: &70149979579340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70146959247960
+  version_requirements: *70149979579340
 description: A ruby library for qif file processing.
 email: cjoakim@bellsouth.net
 executables: []