a few more changes - still many more to come

Author: mrodrig

bower.json

@@ -14,7 +14,7 @@
     "tests"
   ],
   "dependencies": {
-    "underscore": "1.6.0",
+    "underscore": "1.8.3",
     "bluebird": "2.9.24"
   }
 }

lib/csv-2-json.js

@@ -15,13 +15,14 @@ var retrieveHeading = function (lines, callback) {
     if (!lines.length) { // If there are no lines passed in, then throw an error
         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) {
-        return {
-            value: headerKey,
-            index: index
-        }
-    });
+
+    var heading = _.map(lines[0].split(options.DELIMITER.FIELD),
+        function (headerKey, index) {
+            return {
+                value: headerKey,
+                index: index
+            };
+        });
     return heading;
 };
 
@@ -52,7 +53,7 @@ var addNestedKey = function (key, value, doc) {
 /**
  * Does the given value represent an array?
  * @param value
- * @returns {*|boolean}
+ * @returns {boolean}
  */
 var isArrayRepresentation = function (value) {
     return (value && value.indexOf('[') === 0 && value.lastIndexOf(']') === value.length-1);
@@ -121,7 +122,7 @@ var convertCSV = function (lines, callback) {
 };
 
 module.exports = {
-    
+
     /**
      * Internally exported csv2json function
      * Takes options as a document, data as a CSV string, and a callback that will be used to report the results

lib/json-2-csv.js

@@ -6,10 +6,16 @@ var _ = require('underscore'),
 
 var options = {}; // Initialize the options - this will be populated when the json2csv function is called.
 
-// Retrieve the headings for all documents and return it.  This checks that all documents have the same schema.
+/**
+ * Retrieve the headings for all documents and return it.
+ * This checks that all documents have the same schema.
+ * @param data
+ * @returns {Promise}
+ */
 var generateHeading = function(data) {
     return new Promise(function (resolve, reject) {
         if (options.KEYS) { resolve(options.KEYS); }
+
         var keys = _.map(_.keys(data), function (key, indx) { // for each key
             if (_.isObject(data[key])) {
                 // if the data at the key is a document, then we retrieve the subHeading starting with an empty string heading and the doc
@@ -36,7 +42,12 @@ var generateHeading = function(data) {
     });
 };
 
-// Takes the parent heading and this doc's data and creates the subdocument headings (string)
+/**
+ * Takes the parent heading and this doc's data and creates the subdocument headings (string)
+ * @param heading
+ * @param data
+ * @returns {Array}
+ */
 var generateSubHeading = function(heading, data) {
     var subKeys, // retrieve the keys from the current document
         newKey = ''; // temporary variable to aid in determining the heading - used to generate the 'nested' headings
@@ -54,7 +65,12 @@ var generateSubHeading = function(heading, data) {
     return subKeys; // Return the headings joined by our field delimiter
 };
 
-// Convert the given data with the given keys
+/**
+ * Convert the given data with the given keys
+ * @param data
+ * @param keys
+ * @returns {Array}
+ */
 var convertData = function (data, keys) {
     var output = [], // Array of CSV representing converted docs
         value; // Temporary variable to store the current data
@@ -73,6 +89,11 @@ var convertData = function (data, keys) {
     return output; // Return the data joined by our field delimiter
 };
 
+/**
+ * Convert the given value to the CSV representation of the value
+ * @param value
+ * @param output
+ */
 var convertField = function (value, output) {
     if (_.isArray(value)) { // We have an array of values
         output.push(options.DELIMITER.WRAP + '[' + value.join(options.DELIMITER.ARRAY) + ']' + options.DELIMITER.WRAP);
@@ -81,12 +102,17 @@ var convertField = function (value, output) {
     } else if (_.isObject(value)) { // If we have an object
         output.push(convertData(value, _.keys(value))); // Push the recursively generated CSV
     } else {
-        value = value === null ? '' : value.toString();
+        value = value ? value.toString() : '';
         output.push(options.DELIMITER.WRAP + value + options.DELIMITER.WRAP); // Otherwise push the current value
     }
 };
 
-// Generate the CSV representing the given data.
+/**
+ * Generate the CSV representing the given data.
+ * @param data
+ * @param headingKeys
+ * @returns {*}
+ */
 var generateCsv = function (data, headingKeys) {
     // Reduce each JSON document in data to a CSV string and append it to the CSV accumulator
     return Promise.resolve([headingKeys, _.reduce(data, function (csv, doc) {
@@ -96,19 +122,30 @@ var generateCsv = function (data, headingKeys) {
 
 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
+    /**
+     * Internally exported json2csv function
+     * Takes options as a document, data as a JSON document array, and a callback that will be used to report the results
+     * @param opts Object options object
+     * @param data String csv string
+     * @param callback Function callback function
+     */
     json2csv: function (opts, data, callback) {
-        if (!callback) { throw new Error(constants.Errors.callbackRequired); } // If a callback wasn't provided, throw an error
+        // If a callback wasn't provided, throw an error
+        if (!callback) { throw new Error(constants.Errors.callbackRequired); }
 
-        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
+        // Shouldn't happen, but just in case
+        if (!opts) { return callback(new Error(constants.Errors.optionsRequired)); }
+        options = opts; // Options were passed, set the global options value
 
-        if (!data) { return callback(new Error(constants.Errors.json2csv.cannotCallJson2CsvOn + data + '.')); } // If we don't receive data, report an error
+        // If we don't receive data, report an error
+        if (!data) { return callback(new Error(constants.Errors.json2csv.cannotCallJson2CsvOn + data + '.')); }
 
-        if (!_.isObject(data)) { // If the data was not a single document or an array of documents
+        // If the data was not a single document or an array of documents
+        if (!_.isObject(data)) {
             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
+        }
+        // Single document, not an array
+        else if (_.isObject(data) && !data.length) {
             data = [data]; // Convert to an array of the given document
         }