csvgen 1.0.1 → 1.0.2

data/README.markdown

@@ -1,15 +1,14 @@
-# AnyAP Ruby Export Tool
+# CSV generation library
 
-This tool lets us write customer data exports in Ruby instead of XSLT.
+This tool lets us write customer data exports in Ruby instead of
+XSLT. It's publicly hosted just for fun.
 
-Most exports are going to use the `nokogiri` gem.
+Example usage:
 
-Compare:
-
-    <xsl:text disable-output-escaping="yes">,&quot;</xsl:text>
-    <xsl:value-of disable-output-escaping="yes" select="AP_Vendor_no"/>
-    <xsl:text disable-output-escaping="yes">&quot;,</xsl:text>
-
-vs.
-
-    row[3] = invoice.xpath("AP_Vendor_no").text
+    require 'csvgen'
+    doc = CSVDoc.new
+    doc.quote = "'"
+    
+    doc.row { |r| r[0] = "hey"; r[3] = "ho" }
+    doc.row { |r| r[1] = "let's"; r[2] = "go" }
+    puts doc.to_s

data/lib/csvgen.rb

@@ -1,11 +1,14 @@
-# classes to support CSV exports form AnyAP
 
+# Extensions to Date for our export purposes
 class Date
+  # Print date as Month/Day/Year style
   def mdy
     strftime("%m/%d/%y")
   end
 end
 
+# CSV document class. Extend this class to add custom behavior, such
+# as special quoting rules.
 class CSVDoc
   attr_accessor :newline
   attr_accessor :sep
@@ -18,6 +21,9 @@ class CSVDoc
     self.quote = '"'
   end
   
+  # Append a row to the document, using the given fixed length, or
+  # array of headers. Expects a block, which will be passed the new
+  # (empty) row object.
   def row(len_or_headers)
     r = CSVRow.new(self, len_or_headers)
     yield(r)
@@ -29,10 +35,14 @@ class CSVDoc
     @rows.collect { |r| r.to_s }.join(@newline)
   end
   
+  # Override this method if you need to implement special quoting
+  # rules. By default it only quotes data which contains the quote
+  # character itself.
   def needs_quote(val)
     val.include?(quote) || val.include?(sep)
   end
   
+  # Return quoted CSV value string for val.
   def enquote(val)
     val_s = val.to_s
     if needs_quote(val_s) then
@@ -43,6 +53,7 @@ class CSVDoc
   end
 end
 
+# Represents a single CSV row.
 class CSVRow
   def initialize(file, len_or_headers)
     @file = file
@@ -56,12 +67,14 @@ class CSVRow
     end
   end
 
+  # Set the header array
   def headers=(hdrs)
     hdrs.each_with_index do |h, ii|
       @headers[h] = ii
     end
   end
 
+  # Append columns
   def push(*args)
     args.each do |x|
       @cols.push(x)
@@ -69,10 +82,13 @@ class CSVRow
     self
   end
 
+  # Set the fixed column length, for when you don't have headers
   def length=(n)
     @cols = (0..(n - 1)).map { |idx| @cols[idx] || nil }
   end
 
+  # Set value by numeric index or by header (should be a value from
+  # header array)
   def []=(idx, val)
     if idx.is_a? Numeric then
       @cols[idx] = val

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csvgen
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - John Cromartie