Support keys with '.' characters in them (#194)

* Add support for keys with nested dots.

Through modifications to `doc-path` and `deeks` dependency underlying
code, I've worked to add support for the keys with nested dots in the
JSON key path and conversion back to CSV. This was achieved through the
`deeks` module's new `escapeNestedDots` option which will now be set to
`true`. Additionally, support for this escaping was added to `doc-path`
so that the correct values are retrieved and can also be correctly set
for csv2json. This commit adds the option specification for the `deeks`
module and the updated versions of the dependency modules in
package.json.

Fixes #184

lib/json2csv.js

@@ -12,7 +12,8 @@ const Json2Csv = function(options) {
         expandingWithoutUnwinding = options.expandArrayObjects && !options.unwindArrays,
         deeksOptions = {
             expandArrayObjects: expandingWithoutUnwinding,
-            ignoreEmptyArraysWhenExpanding: expandingWithoutUnwinding
+            ignoreEmptyArraysWhenExpanding: expandingWithoutUnwinding,
+            escapeNestedDots: true
         };
 
     /** HEADER FIELD FUNCTIONS **/

package.json

@@ -39,8 +39,8 @@
         "cli"
     ],
     "dependencies": {
-        "deeks": "2.3.0",
-        "doc-path": "2.3.0"
+        "deeks": "2.4.1",
+        "doc-path": "3.0.0"
     },
     "devDependencies": {
         "babel-eslint": "10.1.0",

test/config/testCsvFilesList.js

@@ -40,7 +40,10 @@ const fs = require('fs'),
         {key: 'emptyLastFieldValue', file: '../data/csv/emptyLastFieldValue.csv'},
         {key: 'emptyLastFieldValueNoEol', file: '../data/csv/emptyLastFieldValueNoEol.csv'},
         {key: 'lastCharFieldDelimiter', file: '../data/csv/lastCharFieldDelimiter.csv'},
-        {key: 'nativeMapMethod', file: '../data/csv/nativeMapMethod.csv'}
+        {key: 'nativeMapMethod', file: '../data/csv/nativeMapMethod.csv'},
+        {key: 'nestedDotKeys', file: '../data/csv/nestedDotKeys.csv'},
+        {key: 'nestedDotKeysWithArray', file: '../data/csv/nestedDotKeysWithArray.csv'},
+        {key: 'nestedDotKeysWithArrayExpandedUnwound', file: '../data/csv/nestedDotKeysWithArrayExpandedUnwound.csv'}
     ];
 
 function readCsvFile(filePath) {

test/config/testJsonFilesList.js

@@ -30,5 +30,8 @@ module.exports = {
     firstColumnWrapCRLF: require('../data/json/firstColumnWrapCRLF.json'),
     emptyLastFieldValue: require('../data/json/emptyLastFieldValue.json'),
     emptyLastFieldValueNoEol: require('../data/json/emptyLastFieldValueNoEol.json'),
-    nativeMapMethod: require('../data/json/nativeMapMethod.json')
+    nativeMapMethod: require('../data/json/nativeMapMethod.json'),
+    nestedDotKeys: require('../data/json/nestedDotKeys.json'),
+    nestedDotKeysWithArray: require('../data/json/nestedDotKeysWithArray.json'),
+    nestedDotKeysWithArrayExpandedUnwound: require('../data/json/nestedDotKeysWithArrayExpandedUnwound.json')
 };

test/csv2json.js

@@ -198,6 +198,33 @@ function runTests(jsonTestData, csvTestData) {
                     done();
                 });
             });
+
+            // Test case for #184
+            it('should properly convert keys with escaped/nested dots in them', (done) => {
+                converter.csv2json(csvTestData.nestedDotKeys, (err, json) => {
+                    if (err) done(err);
+                    json.should.deepEqual(jsonTestData.nestedDotKeys);
+                    done();
+                });
+            });
+
+            // Test case for #184
+            it('should properly convert keys with escaped/nested dots in them even when they appear in an array', (done) => {
+                converter.csv2json(csvTestData.nestedDotKeysWithArray, (err, json) => {
+                    if (err) done(err);
+                    json.should.deepEqual(jsonTestData.nestedDotKeysWithArray);
+                    done();
+                });
+            });
+
+            // Test case for #184
+            it('should properly convert keys with escaped/nested dots in them even when they appear in an expanded, unwound array', (done) => {
+                converter.csv2json(csvTestData.nestedDotKeysWithArrayExpandedUnwound, (err, json) => {
+                    if (err) done(err);
+                    json.should.deepEqual(jsonTestData.nestedDotKeysWithArrayExpandedUnwound);
+                    done();
+                });
+            });
         });
 
         describe('Error Handling', () => {

test/data/csv/nestedDotKeys.csv

@@ -0,0 +1,2 @@
+a\.a,a\.b.c\.d,a\.b.c,a\.b.c\.f,a.a,a.b,a.b\.c\.d,a.f.g\.h,a.f.g\.h\.k,a.f.h.l\.m\.n\.o\.p
+a,4,5,6,1,2,32,3,5,qrstuv

test/data/csv/nestedDotKeysWithArray.csv

@@ -0,0 +1,2 @@
+a\.a,a\.b.c\.d,a\.b.c,a\.b.c\.f,a.a,a.b,a.b\.c\.d,a.f.g\.h,a.f.g\.h\.k,a.f.h.l\.m\.n\.o\.p,c
+a,4,5,6,1,2,32,3,5,qrstuv,"[{""d.e"":103,""f"":2},{""d.e"":105,""f"":5}]"

test/data/csv/nestedDotKeysWithArrayExpandedUnwound.csv

@@ -0,0 +1,3 @@
+a\.a,a\.b.c\.d,a\.b.c,a\.b.c\.f,a.a,a.b,a.b\.c\.d,a.f.g\.h,a.f.g\.h\.k,a.f.h.l\.m\.n\.o\.p,c.d\.e,c.f
+a,4,5,6,1,2,32,3,5,qrstuv,103,2
+a,4,5,6,1,2,32,3,5,qrstuv,105,5

test/data/json/nestedDotKeys.json

@@ -0,0 +1,22 @@
+[
+    {
+        "a.a": "a",
+        "a.b": {
+            "c.d": 4,
+            "c": 5,
+            "c.f": 6
+        },
+        "a": {
+            "a": 1,
+            "b": 2,
+            "b.c.d": 32,
+            "f": {
+                "g.h": 3,
+                "g.h.k": 5,
+                "h": {
+                    "l.m.n.o.p": "qrstuv"
+                }
+            }
+        }
+    }
+]

test/data/json/nestedDotKeysWithArray.json

@@ -0,0 +1,26 @@
+[
+    {
+        "a.a": "a",
+        "a.b": {
+            "c.d": 4,
+            "c": 5,
+            "c.f": 6
+        },
+        "a": {
+            "a": 1,
+            "b": 2,
+            "b.c.d": 32,
+            "f": {
+                "g.h": 3,
+                "g.h.k": 5,
+                "h": {
+                    "l.m.n.o.p": "qrstuv"
+                }
+            }
+        },
+        "c": [
+            { "d.e" : 103, "f": 2 },
+            { "d.e" : 105, "f": 5 }
+        ]
+    }
+]

test/data/json/nestedDotKeysWithArrayExpandedUnwound.json

@@ -0,0 +1,44 @@
+[
+    {
+        "a.a": "a",
+        "a.b": {
+            "c.d": 4,
+            "c": 5,
+            "c.f": 6
+        },
+        "a": {
+            "a": 1,
+            "b": 2,
+            "b.c.d": 32,
+            "f": {
+                "g.h": 3,
+                "g.h.k": 5,
+                "h": {
+                    "l.m.n.o.p": "qrstuv"
+                }
+            }
+        },
+        "c": { "d.e" : 103, "f": 2 }
+    },
+    {
+        "a.a": "a",
+        "a.b": {
+            "c.d": 4,
+            "c": 5,
+            "c.f": 6
+        },
+        "a": {
+            "a": 1,
+            "b": 2,
+            "b.c.d": 32,
+            "f": {
+                "g.h": 3,
+                "g.h.k": 5,
+                "h": {
+                    "l.m.n.o.p": "qrstuv"
+                }
+            }
+        },
+        "c": { "d.e" : 105, "f": 5 }
+    }
+]

test/json2csv.js

@@ -145,6 +145,24 @@ function runTests(jsonTestData, csvTestData) {
                     done();
                 });
             });
+
+            // Test case for #184
+            it('should properly handle keys with nested dots in them', (done) => {
+                converter.json2csv(jsonTestData.nestedDotKeys, (err, csv) => {
+                    if (err) done(err);
+                    csv.should.equal(csvTestData.nestedDotKeys);
+                    done();
+                });
+            });
+
+            // Test case for #184
+            it('should properly handle keys with nested dots in them even when they appear in array fields', (done) => {
+                converter.json2csv(jsonTestData.nestedDotKeysWithArray, (err, csv) => {
+                    if (err) done(err);
+                    csv.should.equal(csvTestData.nestedDotKeysWithArray);
+                    done();
+                });
+            });
         });
 
         describe('Error Handling', () => {
@@ -637,6 +655,22 @@ function runTests(jsonTestData, csvTestData) {
                     wrapBooleans: true
                 });
             });
+
+            // Test case for #184
+            it('should handle keys with nested dots when expanding and unwinding arrays', (done) => {
+                converter.json2csv(jsonTestData.nestedDotKeysWithArrayExpandedUnwound, (err, csv) => {
+                    if (err) done(err);
+
+                    // Replace raw boolean values with quoted versions
+                    let expectedCsv = csvTestData.nestedDotKeysWithArrayExpandedUnwound;
+
+                    csv.should.equal(expectedCsv);
+                    done();
+                }, {
+                    expandArrayObjects: true,
+                    unwindArrays: true
+                });
+            });
         });
     });