Added ~95 tests. Fixed bugs in converter. Updated to v0.1.2. Updated README. Allows custom options.

Author: mrodrig

README.md

@@ -20,10 +20,14 @@ var converter = require('json-2-csv');
 
 ### API
 
-#### json2csv(array, callback)
+#### json2csv(array, callback, options)
 
 * `array` - An array of JSON documents
 * `callback` - A function of the form `function (err, csv)`; This function will receive any errors and/or the CSV generated.
+* `options` - (Optional) A JSON document specifying any of {`DELIMITER`, `EOL`, `PARSE_CSV_NUMBERS`}
+** `DELIMITER` - String - Field Delimiter. 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`
 
 ##### json2csv Example:
 
@@ -69,10 +73,14 @@ Nissan,Murano,2013,7106,S AWD
 BMW,X5,2014,3287,M
 ```
 
-#### csv2json(csv, callback)
+#### csv2json(csv, callback, options)
 
 * `csv` - A string of CSV
 * `callback` - A function of the form `function (err, array)`; This function will receive any errors and/or the array of JSON documents generated.
+* `options` - (Optional) A JSON document specifying any of {`DELIMITER`, `EOL`, `PARSE_CSV_NUMBERS`}
+** `DELIMITER` - String - Field Delimiter. 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`
 
 ##### csv2json Example:
 
@@ -108,29 +116,28 @@ object
     Specifications: { Mileage: '3287', Trim: 'M' } } ]
 ```
 
-
 ## Tests
 
 ```bash
 $ npm test
 ```
 
-_Note_: This requires `mocha`, `should`, and `async`.
+_Note_: This requires `mocha`, `should`, `async`, and `underscore`.
 
 ## Features
 
 - Header Generation (per document keys)
 - Verifies all documents have same schema
 - Supports sub-documents natively
 - Custom ordering of columns (see F.A.Q. for more information)
+- Ability to re-generate the JSON documents that were used to generate the CSV (including nested documents)
+- Allows for custom field delimiters, end of line delimiters, etc.
 
 ## F.A.Q.
 
 - Can the order of the keys be changed in the output?
 __Yes.__ Currently, changing the order of the keys in the JSON document will also change the order of the columns. (Node 10.26)
 
 ## TODO
-- Add more tests for both json2csv and csv2json
-- Test errors
 - Add more comments to code
-- Add ability to pass/set options (delimiter, newline, parseInt, etc)
+- Use PARSE_CSV_NUMBERS option to actually convert numbers. Not currently implemented.

bin/json-2-csv

@@ -1,16 +1,40 @@
 'use strict';
 
 var json2Csv = require('./json-2-csv'),
-    csv2Json = require('./csv-2-json');
+    csv2Json = require('./csv-2-json'),
+    _ = require('underscore');
+
+var OPTIONS = function () { // Ensures fields don't change from our defaults
+    return {
+        DELIMITER         : ',',
+        EOL               : '\n',
+        PARSE_CSV_NUMBERS : false
+    };
+}
+
+var buildOptions = function (opts) {
+    var out = _.extend(OPTIONS(), {});
+    if (!opts) { return out; } // If undefined or null, return defaults
+    _.each(_.keys(opts), function (key) {
+        if (out[key]) { // If key is valid, set it
+            out[key] = opts[key];
+        } // Else ignore its value
+    });
+    return out; // Return customized version
+};
 
 module.exports = {
 
-    json2csv: function (data, callback) {
-        json2Csv.json2csv(data, callback);
+    json2csv: function (array, callback, opts) {
+        if (!opts) { opts = OPTIONS(); }
+        else { opts = buildOptions(opts); }
+        json2Csv.json2csv(opts, array, callback);
     },
 
-    csv2json: function (data, callback) {
-        csv2Json.csv2json(data, callback);
+    csv2json: function (csv, callback, opts) {
+        if (!opts) { opts = OPTIONS(); }
+        else { opts = buildOptions(opts); }
+        csv2Json.csv2json(opts, csv, callback);
     }
 
 };

lib/converter.js

@@ -3,15 +3,14 @@
 var _ = require('underscore'),
     async = require('async');
 
-var DELIMITER = ',',
-    EOL = '\n';
+var options = {};
 
 var retrieveHeading = function (lines, callback) {
     if (!lines.length) {
         callback(new Error("No data provided to retrieve heading.")); // Error - no data
     }
     var heading = lines[0]; // Grab the top line (header line)
-    return heading.split(DELIMITER); // Return the heading split by the field delimiter
+    return heading.split(options.DELIMITER); // Return the heading split by the field options.DELIMITER
 };
 
 var addNestedKey = function (key, value, doc) {
@@ -37,17 +36,18 @@ var doesKeyExist = function (key, doc) {
 
 var createDoc = function (keys, line, callback) {
     var doc = {},
-        line = line.trim().split(DELIMITER);
+        val,
+        line = line.trim().split(options.DELIMITER);
     if (line == '') { return false; }
     if (keys.length !== line.length) {
         callback(new Error("Not every line has a correct number of values.")); // This line doesn't have the same # vals as the header
     }
     _.each(keys, function (key, indx) {
-        // TODO: check for case where some or all of nested key path already exists
+        val = line[indx] === '' ? null : line[indx];
         if (key.indexOf('.')) { // Key has '.' representing nested document
-            doc = addNestedKey(key, line[indx], doc); // Update the doc
+            doc = addNestedKey(key, val, doc); // Update the doc
         } else {
-            doc[key] = line[indx];
+            doc[key] = val;
         }
     });
     return doc;
@@ -65,13 +65,15 @@ var convertCSV = function (lines, callback) {
 
 module.exports = {
 
-    csv2json: function (data, callback) {
-        if (!callback) { callback(new Error('A callback is required!')); }
-        if (!data) { callback(new Error('Cannot call csv2json on ' + data)); }
+    csv2json: function (opts, data, callback) {
+        if (!callback) { throw new Error('A callback is required!'); }
+        if (!opts) { callback(new Error('Options were not passed and are required.')); return null; } // Shouldn't happen, but just in case
+        else { options = opts; }
+        if (!data) { callback(new Error('Cannot call csv2json on ' + data)); return null; }
         if (typeof data !== 'string') { // CSV is not a string
             callback(new Error("CSV is not a string"));
         }
-        var lines = data.split(EOL);
+        var lines = data.split(options.EOL);
         var json = convertCSV(lines, callback);
         callback(null, json);
     }

lib/csv-2-json.js

@@ -3,22 +3,21 @@
 var _ = require('underscore'),
     async = require('async');
 
-var DELIMITER = ',',
-    EOL = '\n';
+var options = {};
 
 // Takes the parent heading and this doc's data and creates the subdocument headings (string)
 var retrieveSubHeading = function (heading, data) {
     var subKeys = _.keys(data),
         newKey;
     _.each(subKeys, function (subKey, indx) {
         newKey = heading === '' ? subKey : heading + '.' + subKey;
-        if (typeof data[subKey] === 'object') { // Another nested document
+        if (typeof data[subKey] === 'object' && data[subKey] !== null) { // Another nested document
             subKeys[indx] = retrieveSubHeading(newKey, data[subKey]);
         } else {
             subKeys[indx] = newKey;
         }
     });
-    return subKeys.join(DELIMITER);
+    return subKeys.join(options.DELIMITER);
 };
 
 var retrieveHeading = function (data) {
@@ -31,7 +30,7 @@ var retrieveHeading = function (data) {
         });
         keys = _.uniq(keys);
         if (keys.length > 1) { throw new Error('Not all documents have the same schema.', keys); }
-        cb(null, _.flatten(keys).join(DELIMITER));
+        cb(null, _.flatten(keys).join(options.DELIMITER));
     };
 };
 
@@ -47,26 +46,28 @@ var convertData = function (data, keys) {
             }
         }
     });
-    return output.join(DELIMITER);
+    return output.join(options.DELIMITER);
 };
 
 var generateCsv = function (data) {
     return function (cb) {
-        return cb(null, _.reduce(data, function (csv, doc) { return csv += convertData(doc, _.keys(doc)) + EOL; }, ''));
+        return cb(null, _.reduce(data, function (csv, doc) { return csv += convertData(doc, _.keys(doc)) + options.EOL; }, ''));
     };
 };
 
 module.exports = {
 
-    json2csv: function (data, callback) {
+    json2csv: function (opts, data, callback) {
         if (!callback) { throw new Error('A callback is required!'); }
-        if (!data) { throw new Error('Cannot call json2csv on ' + data); }
+        if (!opts) { callback(new Error('Options were not passed and are required.')); return null; } // Shouldn't happen, but just in case
+        else { options = opts; }
+        if (!data) { callback(new Error('Cannot call json2csv on ' + data)); return null; }
         if (typeof data === 'object' && !data.length) { // Single document, not an array
             data = [data]; // Convert to an array of the given document
         }
         async.parallel([retrieveHeading(data), generateCsv(data)], function (err, res) {
             if (!err) {
-                callback(null, res.join(EOL));
+                callback(null, res.join(options.EOL));
             } else {
                 callback(err, null);
             }

lib/json-2-csv.js

@@ -0,0 +1,12 @@
+var t = require('./converter');
+
+t.json2csv({
+    'name': 'mrodrig',
+    'email': null,
+    'country': 'USA',
+    'githubUsername': 'mrodrig'
+}, function (err, csv) {
+    if (err) throw err;
+    console.log(csv);
+    }
+);

lib/testing.js

@@ -0,0 +1,2 @@
+name,email,country,githubUsername
+mrodrig,,USA,mrodrig

test/CSV/npm-debug.log

@@ -27,4 +27,4 @@
 			"max": "31000"
 		}
 	}
-]
+]