Merge pull request #3 from dillten/master

mrodrig · mrodrig · commit fac7f7e4b3e5 · 2014-08-20T20:34:30.000-04:00
Pulling in dillten's changes to add wrap capabilities
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,33 @@
+# Created by .gitignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# Commenting this out is preferred by some people, see
+# https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
+node_modules
+
+# Users Environment Variables
+.lock-wscript
+
+.idea
+
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+test/
+.git*
+.travis.yml
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ var converter = require('json-2-csv');
   * `DELIMITER` - Document - Specifies the different types of delimiters
     * `FIELD` - String - Field Delimiter. Default: `','`
     * `ARRAY` - String - Array Value Delimiter. Default: `';'`
+    * `WRAP` - String - Wrap values in the delimiter of choice (e.g. wrap values in quotes). Default: `''`
   * `EOL` - String - End of Line Delimiter. Default: `'\n'`
   * `PARSE_CSV_NUMBERS` - Boolean - Should numbers that are found in the CSV be converted to numbers? Default: `false`
 
diff --git a/lib/converter.js b/lib/converter.js
@@ -8,7 +8,8 @@ var json2Csv = require('./json-2-csv'), // Require our json-2-csv code
 var defaultOptions = {
     DELIMITER         : {
         FIELD  :  ',',
-        ARRAY  :  ';'
+        ARRAY  :  ';',
+        WRAP   :  ''
     },
     EOL               : '\n',
     PARSE_CSV_NUMBERS : false
diff --git a/lib/json-2-csv.js b/lib/json-2-csv.js
@@ -15,7 +15,7 @@ var retrieveSubHeading = function (heading, data) {
         if (typeof data[subKey] === 'object' && data[subKey] !== null && typeof data[subKey].length === 'undefined') { // If we have another nested document
             subKeys[indx] = retrieveSubHeading(newKey, data[subKey]); // Recur on the subdocument to retrieve the full key name
         } else {
-            subKeys[indx] = newKey; // Set the key name since we don't have a sub document
+            subKeys[indx] = (options.DELIMITER.WRAP || '') + (newKey || '') + (options.DELIMITER.WRAP || ''); // Set the key name since we don't have a sub document
         }
     });
     return subKeys.join(options.DELIMITER.FIELD); // Return the headings joined by our field delimiter
@@ -49,9 +49,9 @@ var convertData = function (data, keys) {
             if (typeof value === 'object' && value !== null && typeof value.length === 'undefined') { // If we have an object
                 output.push(convertData(value, _.keys(value))); // Push the recursively generated CSV
             } else if (typeof value === 'object' && value !== null && typeof value.length === 'number') { // We have an array of values
-                output.push('[' + value.join(options.DELIMITER.ARRAY) + ']');
+                output.push((options.DELIMITER.WRAP || '') + '[' + value.join(options.DELIMITER.ARRAY) + ']' + (options.DELIMITER.WRAP || ''));
             } else {
-                output.push(value); // Otherwise push the current value
+                output.push((options.DELIMITER.WRAP || '') + (value || '') + (options.DELIMITER.WRAP || '')); // Otherwise push the current value
             }
         }
     });
diff --git a/test/CSV/withQuotes/arrayValueDocs.csv b/test/CSV/withQuotes/arrayValueDocs.csv
@@ -0,0 +1,4 @@
+"info.name","coursesTaken","year"
+"Mike","[CS2500/CS2510]","Sophomore"
+"John","[ANTH1101/POL2312/MATH2142/POL3305/LAW2100]","Senior"
+"Joe","[]","Freshman"
diff --git a/test/CSV/withQuotes/nestedJson.csv b/test/CSV/withQuotes/nestedJson.csv
@@ -0,0 +1,5 @@
+"carModel","priceRange.min","priceRange.max"
+"Audi","9000","11000"
+"BMW","14000","16000"
+"Mercedes","19000","21000"
+"Porsche","29000","31000"
diff --git a/test/CSV/withQuotes/nestedJson2.csv b/test/CSV/withQuotes/nestedJson2.csv
@@ -0,0 +1,3 @@
+"Make","Model","Year","Specifications.Mileage","Specifications.Trim"
+"Nissan","Murano","2013","7106","S AWD"
+"BMW","X5","2014","3287","M"
diff --git a/test/CSV/withQuotes/nestedQuotes.csv b/test/CSV/withQuotes/nestedQuotes.csv
@@ -0,0 +1,3 @@
+"a string"
+"with a description"
+"with a description and "quotes""
diff --git a/test/CSV/withQuotes/noData.csv b/test/CSV/withQuotes/noData.csv
@@ -0,0 +1,2 @@
+
+
diff --git a/test/CSV/withQuotes/regularJson.csv b/test/CSV/withQuotes/regularJson.csv
@@ -0,0 +1,5 @@
+"carModel","price","color"
+"Audi","10000","blue"
+"BMW","15000","red"
+"Mercedes","20000","yellow"
+"Porsche","30000","green"
diff --git a/test/CSV/withQuotes/singleDoc.csv b/test/CSV/withQuotes/singleDoc.csv
@@ -0,0 +1,2 @@
+"name","email","country","githubUsername"
+"mrodrig","","USA","mrodrig"
diff --git a/test/testQuoted.js b/test/testQuoted.js
@@ -0,0 +1,211 @@
+var should = require('should'),
+  converter = require('.././lib/converter'),
+  fs = require('fs'),
+  _ = require('underscore'),
+  async = require('async');
+
+var options = {
+    DELIMITER         : {
+        FIELD  :  ',',
+        ARRAY  :  '/',
+        WRAP   :  '\"'
+    },
+    EOL               : '\n',
+    PARSE_CSV_NUMBERS : false
+};
+
+var json_regularJson    = require('./JSON/regularJson'),
+    json_nestedJson     = require('./JSON/nestedJson'),
+    json_nestedJson2    = require('./JSON/nestedJson2'),
+    json_nestedQuotes   = require('./JSON/nestedQuotes'),
+    json_noData         = require('./JSON/noData.json'),
+    json_singleDoc      = require('./JSON/singleDoc.json'),
+    json_arrayValue     = require('./JSON/arrayValueDocs.json'),
+    csv_regularJson     = '',
+    csv_nestedJson      = '',
+    csv_nestedJson2     = '',
+    csv_nestedQuotes    = '',
+    csv_noData          = '',
+    csv_singleDoc       = '',
+    csv_arrayValue      = '';
+
+var json2csvTests = function () {
+    describe('json2csv', function (done) {
+        describe('Options Specified', function (done) {
+            it('should convert plain JSON to CSV', function(done) {
+                converter.json2csv(json_regularJson, function(err, csv) {
+                    csv.should.equal(csv_regularJson.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(6);
+                    done();
+                }, options);
+            });
+
+            it('should parse nested JSON to CSV - 1', function(done) {
+                converter.json2csv(json_nestedJson, function(err, csv) {
+                    csv.should.equal(csv_nestedJson.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(6);
+                    done();
+                }, options);
+            });
+
+            it('should parse nested JSON to CSV - 2', function(done) {
+                converter.json2csv(json_nestedJson2, function(err, csv) {
+                    csv.should.equal(csv_nestedJson2.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(4);
+                    done();
+                }, options);
+            });
+
+            it('should parse nested quotes in JSON to have quotes in CSV ', function(done) {
+                converter.json2csv(json_nestedQuotes, function(err, csv) {
+                    csv.should.equal(csv_nestedQuotes.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(4);
+                    done();
+                }, options);
+            });
+
+            it('should parse an empty array to an empty CSV', function(done) {
+                converter.json2csv(json_noData, function(err, csv) {
+                    csv.should.equal(csv_noData.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(3); // Still adds newlines for header, first data row, and end of data
+                    done();
+                }, options);
+            });
+
+            it('should parse a single JSON document to CSV', function (done) {
+                converter.json2csv(json_singleDoc, function (err, csv) {
+                    csv.should.equal(csv_singleDoc.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(3);
+                    done();
+                }, options);
+            });
+
+            it('should parse a single JSON document to CSV', function (done) {
+                converter.json2csv(json_arrayValue, function (err, csv) {
+                    csv.should.equal(csv_arrayValue.replace(/,/g, options.DELIMITER.FIELD));
+                    csv.split(options.EOL).length.should.equal(5);
+                    done();
+                }, options);
+            });
+
+            it('should throw an error about not having been passed data - 1', function (done) {
+                converter.json2csv(null, function (err, csv) {
+                    err.message.should.equal('Cannot call json2csv on null.');
+                    done();
+                }, options);
+            });
+
+            it('should throw an error about not having been passed data - 2', function (done) {
+                converter.json2csv(undefined, function (err, csv) {
+                    err.message.should.equal('Cannot call json2csv on undefined.');
+                    done();
+                }, options);
+            });
+
+            it('should throw an error about not being provided a callback - 1', function (done) {
+                try {
+                    converter.json2csv(undefined, undefined, options);
+                } catch (err) {
+                    err.message.should.equal('A callback is required!');
+                    done();
+                }
+            });
+
+            it('should throw an error about not being provided a callback - 2', function (done) {
+                try {
+                    converter.json2csv(null, undefined, options);
+                } catch (err) {
+                    err.message.should.equal('A callback is required!');
+                    done();
+                }
+            });
+
+            it('should throw an error about not being provided a callback - 3', function (done) {
+                try {
+                    converter.json2csv(null, null, options);
+                } catch (err) {
+                    err.message.should.equal('A callback is required!');
+                    done();
+                }
+            });
+
+            it('should throw an error about not being provided a callback - 4', function (done) {
+                try {
+                    converter.json2csv(undefined, null, options);
+                } catch (err) {
+                    err.message.should.equal('A callback is required!');
+                    done();
+                }
+            });
+        });
+
+    });
+};
+
+module.exports = {
+    runTests: function (callback) {
+        describe('Wrapped in Quotes', function() {
+            before(function(done) {
+                async.parallel([
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/regularJson.csv', function(err, data) {
+                            if (err) callback(err);
+                            csv_regularJson = data.toString();
+                            callback(null);
+                        });
+                    },
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/nestedJson.csv', function(err, data) {
+                            if (err) callback(err);
+                            csv_nestedJson = data.toString();
+                            callback(null);
+                        });
+                    },
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/nestedJson2.csv', function(err, data) {
+                            if (err) callback(err);
+                            csv_nestedJson2 = data.toString();
+                            callback(null);
+                        });
+                    },
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/nestedQuotes.csv', function(err, data) {
+                            if (err) callback(err);
+                            csv_nestedQuotes = data.toString();
+                            callback(null);
+                        });
+                    },
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/noData.csv', function (err, data) {
+                            if (err) callback(err);
+                            csv_noData = data.toString();
+                            callback(null);
+                        });
+                    },
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/singleDoc.csv', function (err, data) {
+                            if (err) callback(err);
+                            csv_singleDoc = data.toString();
+                            callback(null);
+                        });
+                    },
+                    function(callback) {
+                        fs.readFile('test/CSV/withQuotes/arrayValueDocs.csv', function (err, data) {
+                            if (err) callback(err);
+                            csv_arrayValue = data.toString();
+                            callback(null);
+                        });
+                    }
+                ],
+                function(err, results) {
+                    if (err) console.log(err);
+                    done();
+                });
+            });
+
+            // JSON to CSV
+            json2csvTests();
+
+        });
+    }
+};
diff --git a/test/tests.js b/test/tests.js
@@ -1,10 +1,12 @@
 var should = require('should'),
   commaTests = require('./testComma'),
   semiTests = require('./testSemi'),
+  quotedTests = require('./testQuoted'),
   _ = require('underscore'),
   async = require('async');
 
 describe('json-2-csv Module', function() {
     commaTests.runTests();
     semiTests.runTests();
+    quotedTests.runTests();
 });

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+"Make","Model","Year","Specifications.Mileage","Specifications.Trim"`
	`2`	`+"Nissan","Murano","2013","7106","S AWD"`
	`3`	`+"BMW","X5","2014","3287","M"`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+"a string"`
	`2`	`+"with a description"`
	`3`	`+"with a description and "quotes""`