Add fancy fields option support, zemirco#78

{ fields: [ // Support label -> simple path { label: 'some label', value: 'path.to.something' }, // Support label -> derived value { label: 'some label', // Supporting duplicate labels value: function(row) { return row.path1 + row.path2; } }, // Support pathname -> pathvalue (label optional, keeps backwards compatibility) 'simplepath' 'path.to.value' ] }
azhang · Oct 8, 2015 · 07b2fd3 · 07b2fd3
1 parent b127e85
commit 07b2fd3
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 3 deletions.
diff --git a/lib/json2csv.js b/lib/json2csv.js
@@ -60,7 +60,13 @@ function checkParams(params, callback) {
     return callback(new Error('fieldNames and fields should be of the same length, if fieldNames is provided.'));
   }
 
-  params.fieldNames = params.fieldNames || params.fields;
+  // Get fieldNames from fields
+  params.fieldNames = params.fields.map(function (field, i) {
+    if (params.fieldNames && typeof field === 'string') {
+      return params.fieldNames[i];
+    } 
+    return (typeof field === 'string') ? field : (field.label || field.value);      
+  });
 
   //#check delimiter
   params.del = params.del || ',';
@@ -142,7 +148,14 @@ function createColumnContent(params, str) {
       var eol = params.newLine || os.EOL || '\n';
 
       params.fields.forEach(function (fieldElement) {
-        var val = lodashGet(dataElement, fieldElement, params.defaultValue);
+        var val;
+
+        if (fieldElement && (typeof fieldElement === 'string' || typeof fieldElement.value === 'string')) {
+          var path = (typeof fieldElement === 'string') ? fieldElement : fieldElement.value;
+          val = lodashGet(dataElement, path, params.defaultValue);
+        } else if (fieldElement && typeof fieldElement.value === 'function') {
+          val = fieldElement.value(dataElement);
+        }
 
         if (val !== undefined) {
           var stringifiedElement = JSON.stringify(val);

diff --git a/test/fixtures/csv/fancyfields.csv b/test/fixtures/csv/fancyfields.csv
@@ -0,0 +1,3 @@
+"PATH1","PATH1+PATH2","NEST1","bird.nest2"
+"hello ","hello world!","chirp","cheep"
+"good ","good bye!","meep","meep"
diff --git a/test/helpers/load-fixtures.js b/test/helpers/load-fixtures.js
@@ -16,7 +16,8 @@ var fixtures = [
   'fieldNames',
   'withSimpleQuotes',
   'nested',
-  'defaultValue'
+  'defaultValue',
+  'fancyfields'
 ];
 
 /*eslint-disable no-console*/

diff --git a/test/index.js b/test/index.js
@@ -269,4 +269,43 @@ async.parallel(loadFixtures(csvFixtures), function (err) {
     }
   });
 
+  test('should process fancy fields option', function (t) {
+    json2csv({
+      data: [{
+        path1: 'hello ',
+        path2: 'world!',
+        bird: {
+          nest1: 'chirp',
+          nest2: 'cheep'
+        }
+      }, {
+        path1: 'good ',
+        path2: 'bye!',
+        bird: {
+          nest1: 'meep',
+          nest2: 'meep'
+        }
+      }],
+      fields: [{
+        label: 'PATH1',
+        value: 'path1'
+      }, {
+        label: 'PATH1+PATH2',
+        value: function (row) {
+          return row.path1+row.path2;
+        }
+      }, {
+        label: 'NEST1',
+        value: 'bird.nest1'
+      }, 
+      'bird.nest2'
+      ],
+      defaultValue: 'NULL'
+    }, function (error, csv) {
+      t.error(error);
+      t.equal(csv, csvFixtures.fancyfields);
+      t.end();
+    });
+  });
+
 });