pbyrne-array-to-csv 1.0.1 → 1.1.0

data/README

@@ -3,11 +3,11 @@ Adds Array#to_csv method that converts the contents of the array to CSV format.
 Examples:
 
     [['a', 'b'], ['c', 'd']].to_csv
-    #=> "a,b\nc,d"
+    #=> "a","b"\n"c","d"
     ['Report on somesuch', 
       ['name', 'value'],
       ['foo', 156],
       ['bar', 24]].to_csv
-    #=> "Report on somesuch\nname,value\nfoo,156\nbar,24"
+    #=> "Report on somesuch"\n"name","value"\n"foo","156"\n"bar","24"
 
 This gem is released under a broad open-source license. See LICENSE for more details.

data/lib/array-to-csv.rb

@@ -4,15 +4,23 @@ class Array
     
     for i in self
       # todo research case syntax, since these elsifs are ugly
+      # todo investigate switching to %Q syntax to make less ugly
+      # todo refactor out the duplicate gsubs
       if i.is_a? Array
-        tmp << i.map{|x| "\"#{x}\""}.join(',')
+        tmp << i.map{|x| "\"#{x.to_s.escape_csv_quotes}\""}.join(',')
       elsif i.is_a? String
-        tmp << "\"#{i}\""
+        tmp << "\"#{i.escape_csv_quotes}\""
       elsif i.is_a? Hash
-        tmp << i.map{|k, v| "\"#{k}: #{v}\""}.join(',')
+        tmp << i.map{|k, v| "\"#{k.to_s.escape_csv_quotes}: #{v.to_s.escape_csv_quotes}\""}.join(',')
       end
     end
     
     tmp.join("\n")
   end
-end
+end
+
+class String
+  def escape_csv_quotes
+    gsub('"','""')
+  end
+end

data/spec/array-to-csv_spec.rb

@@ -1,7 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 # TODO replace the it declarations with more meaningful and descriptive, er, descriptions
-# TODO would heredoc be better and more expressive than a bunch of escaped quotes?
 describe Array do
   context "managing converting itself to CSV format" do
     it "returns '' on an emtpy array" do
@@ -13,25 +12,61 @@ describe Array do
     it "returns 'a\nb\nc' for an array ['a', 'b', 'c']" do
       data = ['a', 'b', 'c']
       
-      data.to_csv.should == "\"a\"\n\"b\"\n\"c\""
+      data.to_csv.should == %Q("a"\n"b"\n"c")
     end
     
     it "returns 'a,b\nc,d' for an array [['a', 'b'], ['c', 'd']]" do
       data = [['a', 'b'], ['c', 'd']]
       
-      data.to_csv.should == "\"a\",\"b\"\n\"c\",\"d\""
+      data.to_csv.should == %Q("a","b"\n"c","d")
     end
     
     it "returns 'a: b\nc: d' for an array [{:a => 'b'}, {:c => 'd'}]" do
       data = [{:a => 'b'}, {:c => 'd'}]
       
-      data.to_csv.should == "\"a: b\"\n\"c: d\""
+      data.to_csv.should == %Q("a: b"\n"c: d")
     end
     
     it "returns 'Patrick,2009-09-13\nAngela,2009-08-17' for an array [['Patrick', Date.new(2009,9,13)], ['Angela', Date.new(2009,8,17)]]" do
       data = [['Patrick', Date.new(2009,9,13)], ['Angela', Date.new(2009,8,17)]]
       
-      data.to_csv.should == "\"Patrick\",\"2009-09-13\"\n\"Angela\",\"2009-08-17\""
+      data.to_csv.should == %Q("Patrick","2009-09-13"\n"Angela","2009-08-17")
+    end
+    
+    context "managing the escaping of double quotes in the cells" do
+      it "correctly escapes double quotes in nested arrays" do
+        data = [["a href=\"foo\"", "div"], ["link rel=\"bar\"","blockquote"]]
+
+        data.to_csv.should == %Q("a href=""foo""","div"\n"link rel=""bar""","blockquote")
+      end
+      
+      it "correctly escapes double quotes in strings" do
+        data = ["a href=\"foo\"", "link rel=\"bar\""]
+        
+        data.to_csv.should == %Q("a href=""foo"""\n"link rel=""bar""")
+      end
+      
+      it "correctly escapes double quotes in hashes" do
+        data = [{ :url => 'a href="foo"', :style => 'link rel="bar"'}]
+        
+        data.to_csv.should == %Q("url: a href=""foo""","style: link rel=""bar""")
+      end
+    end
+  end
+end
+
+describe String do
+  context "handling escaping double quotes in CSV" do
+    it "returns empty string when escaping an empty string" do
+      "".escape_csv_quotes.should == ""
+    end
+    
+    it "returns the origal string if doesn't have any double-quotes" do
+      "foo".escape_csv_quotes.should == "foo"
+    end
+    
+    it "returns two double quotes for every double quote" do
+      'a href="foo"'.escape_csv_quotes.should == 'a href=""foo""'
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pbyrne-array-to-csv
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Patrick Byrne