Merge pull request #20 from mrodrig/refactor-tests

Refactoring Tests

Author: mrodrig

README.md

@@ -137,6 +137,19 @@ $ npm test
 
 _Note_: This requires `mocha`, `should`, `async`, and `underscore`.
 
+To see test coverage, please run:
+```bash
+$ npm run coverage
+```
+
+Current Coverage is:
+```
+Statements   : 93.63% ( 147/157 )
+Branches     : 87.91% ( 80/91 )
+Functions    : 100% ( 36/36 )
+Lines        : 95.86% ( 139/145 )
+```
+
 ## Features
 
 - Header Generation (per document keys)

lib/constants.json

@@ -0,0 +1,32 @@
+{
+  "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."
+    }
+
+  },
+
+  "DefaultOptions" : {
+    "DELIMITER" : {
+      "FIELD" : ",",
+      "ARRAY" : ";",
+      "WRAP" : ""
+    },
+    "EOL" : "\n",
+    "PARSE_CSV_NUMBERS" : false,
+    "KEYS" : null
+  }
+}

lib/converter.js

@@ -2,21 +2,13 @@
 
 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
 
 /**
  * Default options
  */
-var defaultOptions = {
-    DELIMITER         : {
-        FIELD  :  ',',
-        ARRAY  :  ';',
-        WRAP   :  ''
-    },
-    EOL               : '\n',
-    PARSE_CSV_NUMBERS : false,
-    KEYS              : null
-};
+var defaultOptions = constants.DefaultOptions;
 
 /**
  * Build the options to be passed to the appropriate function
@@ -28,9 +20,9 @@ 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); }
+    return cb(null, opts);
 };
 
 // Export the following functions that will be client accessible

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) { return 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) { return 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
+            return 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 = {
             });
     }
 
-};
+};

package.json

@@ -9,7 +9,8 @@
     },
     "main": "./lib/converter.js",
     "scripts": {
-        "test": "./node_modules/.bin/mocha --reporter spec"
+        "test": "./node_modules/.bin/mocha test/tests.js",
+        "coverage": "./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- -R spec"
     },
     "keywords": [
         "json",
@@ -28,6 +29,7 @@
     },
     "devDependencies": {
         "mocha": "~2.2.4",
+        "istanbul": "~0.3.13",
         "should": "~5.2.0",
         "async": "~0.9.0"
     },