Adding constants for error messages, testJson2Csv finished, updating old tests so build passes

Author: mrodrig

lib/constants.json

@@ -0,0 +1,21 @@
+{
+  "Errors" : {
+
+    "delimitersMustDiffer": "The field and array delimiters must differ.",
+    "callbackRequired": "A callback is required!",
+    "optionsRequired": "Options were not passed and are required.",
+
+    "json2csv": {
+      "cannotCallJson2CsvOn": "Cannot call json2csv on ",
+      "dataNotArrayOfDocuments": "Data provided was not an array of documents.",
+      "notSameSchema": "Not all documents have the same schema."
+    },
+
+    "csv2json": {
+      "cannotCallCsv2JsonOn": "Cannot call csv2json on ",
+      "csvNotString": "CSV is not a string.",
+      "noDataRetrieveHeading": "No data provided to retrieve heading."
+    }
+
+  }
+}

lib/converter.js

@@ -2,6 +2,7 @@
 
 var json2Csv = require('./json-2-csv'), // Require our json-2-csv code
     csv2Json = require('./csv-2-json'), // Require our csv-2-json code
+    constants = require('./constants'), // Require in constants
     _ = require('underscore'); // Require underscore
 
 /**
@@ -28,7 +29,7 @@ var buildOptions = function (opts, cb) {
     // Note: _.defaults does a shallow default, we need to deep copy the DELIMITER object
     opts.DELIMITER = _.defaults(opts.DELIMITER || {}, defaultOptions.DELIMITER);
     // If the delimiter fields are the same, report an error to the caller
-    if (opts.DELIMITER.FIELD === opts.DELIMITER.ARRAY) { return cb(new Error('The field and array delimiters must differ.')); }
+    if (opts.DELIMITER.FIELD === opts.DELIMITER.ARRAY) { return cb(new Error(constants.Errors.delimitersMustDiffer)); }
     // Otherwise, send the options back
     else { return cb(null, opts); }
 };

lib/csv-2-json.js

@@ -1,13 +1,14 @@
 'use strict';
 
-var _ = require('underscore');
+var _ = require('underscore'),
+    constants = require('./constants');
 
 var options = {}; // Initialize the options - this will be populated when the csv2json function is called.
 
 // Generate the JSON heading from the CSV
 var retrieveHeading = function (lines, callback) {
     if (!lines.length) { // If there are no lines passed in, then throw an error
-        return callback(new Error("No data provided to retrieve heading.")); // Pass an error back to the user
+        return callback(new Error(constants.Errors.csv2json.noDataRetrieveHeading)); // Pass an error back to the user
     }
     var heading = lines[0].split(options.DELIMITER.FIELD); // Grab the top line (header line) and split by the field delimiter
     heading = _.map(heading, function (headerKey, index) {
@@ -97,12 +98,12 @@ module.exports = {
     // Function to export internally
     // Takes options as a document, data as a CSV string, and a callback that will be used to report the results
     csv2json: function (opts, data, callback) {
-        if (!callback) { throw new Error('A callback is required!'); } // If a callback wasn't provided, throw an error
-        if (!opts) { callback(new Error('Options were not passed and are required.')); return null; } // Shouldn't happen, but just in case
+        if (!callback) { throw new Error(constants.Errors.callbackRequired); } // If a callback wasn't provided, throw an error
+        if (!opts) { callback(new Error(constants.Errors.optionsRequired)); return null; } // Shouldn't happen, but just in case
         else { options = opts; } // Options were passed, set the global options value
-        if (!data) { callback(new Error('Cannot call csv2json on ' + data + '.')); return null; } // If we don't receive data, report an error
+        if (!data) { callback(new Error(constants.Errors.csv2json.cannotCallCsv2JsonOn + data + '.')); return null; } // If we don't receive data, report an error
         if (!_.isString(data)) { // The data is not a string
-            callback(new Error("CSV is not a string.")); // Report an error back to the caller
+            callback(new Error(constants.Errors.csv2json.csvNotString)); // Report an error back to the caller
         }
         var lines = data.split(options.EOL); // Split the CSV into lines using the specified EOL option
         var json = convertCSV(lines, callback); // Retrieve the JSON document array

lib/json-2-csv.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var _ = require('underscore'),
+    constants = require('./constants'),
     Promise = require('bluebird');
 
 var options = {}; // Initialize the options - this will be populated when the json2csv function is called.
@@ -28,7 +29,7 @@ var generateHeading = function(data) {
             // If there is a difference between the schemas, throw the inconsistent schema error
             var diff = _.difference(firstDocSchema, _.flatten(keyList));
             if (!_.isEqual(diff, [])) {
-                return reject(new Error('Not all documents have the same schema.'));
+                return reject(new Error(constants.Errors.json2csv.notSameSchema));
             }
         });
         return resolve(_.flatten(keys[0]));
@@ -98,15 +99,15 @@ module.exports = {
     // Function to export internally
     // Takes options as a document, data as a JSON document array, and a callback that will be used to report the results
     json2csv: function (opts, data, callback) {
-        if (!callback) { throw new Error('A callback is required!'); } // If a callback wasn't provided, throw an error
+        if (!callback) { throw new Error(constants.Errors.callbackRequired); } // If a callback wasn't provided, throw an error
 
-        if (!opts) { return callback(new Error('Options were not passed and are required.')); } // Shouldn't happen, but just in case
+        if (!opts) { return callback(new Error(constants.Errors.optionsRequired)); } // Shouldn't happen, but just in case
         else { options = opts; } // Options were passed, set the global options value
 
-        if (!data) { return callback(new Error('Cannot call json2csv on ' + data + '.')); } // If we don't receive data, report an error
+        if (!data) { return callback(new Error(constants.Errors.json2csv.cannotCallJson2CsvOn + data + '.')); } // If we don't receive data, report an error
 
         if (!_.isObject(data)) { // If the data was not a single document or an array of documents
-            return callback(new Error('Data provided was not an array of documents.'));  // Report the error back to the caller
+            return callback(new Error(constants.Errors.json2csv.dataNotArrayOfDocuments));  // Report the error back to the caller
         } else if (_.isObject(data) && !data.length) { // Single document, not an array
             data = [data]; // Convert to an array of the given document
         }
@@ -128,4 +129,4 @@ module.exports = {
             });
     }
 
-};
+};

test/CSV/arrayValueDocs.csv

@@ -1,4 +1,4 @@
 info.name,coursesTaken,year
-Mike,[CS2500/CS2510],Sophomore
-John,[ANTH1101/POL2312/MATH2142/POL3305/LAW2100],Senior
+Mike,[CS2500;CS2510],Sophomore
+John,[ANTH1101;POL2312;MATH2142;POL3305;LAW2100],Senior
 Joe,[],Freshman

test/testComma.js

@@ -86,7 +86,7 @@ var json2csvTests = function () {
 
             it('should parse an array of JSON documents to CSV', function (done) {
                 converter.json2csv(json_arrayValue, function (err, csv) {
-                    csv.should.equal(csv_arrayValue);
+                    csv.should.equal(csv_arrayValue.replace(/;/g, options.DELIMITER.ARRAY));
                     csv.split(options.EOL).length.should.equal(5);
                     done();
                 }, options);
@@ -382,7 +382,7 @@ var json2csvTests = function () {
             it('should parse an array of JSON documents to CSV', function (done) {
                 converter.json2csvAsync(json_arrayValue, options)
                     .then(function (csv) {
-                        csv.should.equal(csv_arrayValue);
+                        csv.should.equal(csv_arrayValue.replace(/;/g, options.DELIMITER.ARRAY));
                         csv.split(options.EOL).length.should.equal(5);
                         done();
                     })
@@ -636,7 +636,7 @@ var csv2jsonTests = function () {
             });
 
             it('should parse a CSV with a nested array to the correct JSON representation', function (done) {
-                converter.csv2json(csv_arrayValue, function (err, json) {
+                converter.csv2json(csv_arrayValue.replace(/;/g, options.DELIMITER.ARRAY), function (err, json) {
                     var isEqual = _.isEqual(json, json_arrayValue);
                     true.should.equal(isEqual);
                     done();
@@ -900,7 +900,7 @@ var csv2jsonTests = function () {
             });
 
             it('should parse a CSV with a nested array to the correct JSON representation', function (done) {
-                converter.csv2jsonAsync(csv_arrayValue, options)
+                converter.csv2jsonAsync(csv_arrayValue.replace(/;/g, options.DELIMITER.ARRAY), options)
                     .then(function (json) {
                         var isEqual = _.isEqual(json, json_arrayValue);
                         true.should.equal(isEqual);