support using a function to adjust data properties for methods that deal with multiple entries such as bulk and directory.

Author: ctalkington

README.md

@@ -62,10 +62,16 @@ The `data` property can be set (per src-dest mapping) to define data for matched
 ```js
 archive.bulk([
   { src: ['mydir/**'], data: { date: new Date() } },
+  { src: ['mydir/**'], data: function(data) {
+    data.date = new Date();
+    return data;
+  }},
   { expand: true, cwd: 'mydir', src: ['**'], dest: 'newdir' }
 ]);
 ```
 
+As of v0.15, the `data` property can also be a function that receives data for each matched entry and is expected to return it after making any desired adjustments.
+
 For more detail on this feature, please see [BULK.md](https://github.com/archiverjs/node-archiver/blob/master/BULK.md).
 
 #### directory(dirpath[, destpath, data])
@@ -81,8 +87,14 @@ archive.directory('mydir', 'abc');
 
 // mydir/ -> archive.ext/
 archive.directory('mydir', false, { date: new Date() });
+archive.directory('mydir', false, function(data) {
+  data.date = new Date();
+  return data;
+});
 ```
 
+As of v0.15, the `data` property can also be a function that receives data for each entry and is expected to return it after making any desired adjustments.
+
 #### file(filepath, data)
 
 Appends a file given its filepath using a [lazystream](https://github.com/jpommerening/node-lazystream) wrapper to prevent issues with open file limits. When the instance has received, processed, and emitted the file, the `entry` event is fired.

lib/core.js

@@ -378,17 +378,28 @@ Archiver.prototype.bulk = function(mappings) {
 
   files.forEach(function(file){
     var isExpandedPair = file.orig.expand || false;
-    var fileData = file.data || {};
+    var data = {};
+    var dataFunction = false;
+
+    if (typeof file.data === 'function') {
+      dataFunction = file.data;
+    } else if (typeof file.data === 'object') {
+      data = file.data;
+    }
 
     file.src.forEach(function(filepath) {
-      var data = util._.extend({}, fileData);
-      data.name = isExpandedPair ? util.unixifyPath(file.dest) : util.unixifyPath(file.dest || '', filepath);
+      var entryData = util._.extend({}, data);
+      entryData.name = isExpandedPair ? util.unixifyPath(file.dest) : util.unixifyPath(file.dest || '', filepath);
 
-      if (data.name === '.') {
+      if (entryData.name === '.') {
         return;
       }
 
-      self._append(filepath, data);
+      try {
+        entryData = dataFunction(entryData) || entryData;
+      } catch(e) {}
+
+      self._append(filepath, entryData);
     });
   });
 
@@ -414,7 +425,13 @@ Archiver.prototype.directory = function(dirpath, destpath, data) {
     destpath = dirpath;
   }
 
-  if (typeof data !== 'object') {
+  var dataFunction = false;
+  if (typeof data === 'function') {
+    dataFunction = data;
+    data = {};
+  } else if (typeof data === 'object') {
+    data = data;
+  } else {
     data = {};
   }
 
@@ -429,6 +446,10 @@ Archiver.prototype.directory = function(dirpath, destpath, data) {
         entryData.name = util.sanitizePath(destpath, file.relative);
         entryData.stats = file.stats;
 
+        try {
+          entryData = dataFunction(entryData) || entryData;
+        } catch(e) {}
+
         self._append(file.path, entryData);
       });
     }

test/archiver.js

@@ -145,7 +145,10 @@ describe('archiver', function() {
 
         archive
           .directory('test/fixtures/directory', null, { date: testDate })
-          .directory('test/fixtures/directory', 'directory')
+          .directory('test/fixtures/directory', 'directory', function(data) {
+            data.funcProp = true;
+            return data;
+          })
           .finalize();
       });
 
@@ -166,6 +169,10 @@ describe('archiver', function() {
         assert.property(entries, 'directory/subdir/subsub/');
         assert.property(entries, 'directory/subdir/subsub/level2.txt');
       });
+
+      it('should support setting data properties via function', function() {
+        assert.propertyVal(entries['directory/level0.txt'], 'funcProp', true);
+      });
     });
 
     describe('#file', function() {
@@ -245,27 +252,41 @@ describe('archiver', function() {
 
         archive
           .bulk([
-            { expand: true, cwd: 'test/fixtures/directory/', src: '**', data: { prop: 'value' } }
+            { expand: true, cwd: 'test/fixtures/directory/', src: '**', data: { prop: 'value' } },
+            { expand: true, cwd: 'test/fixtures/directory/', src: '**', dest: 'directory/', data: function(data) {
+              data.funcProp = true;
+              return data;
+            }},
           ])
           .finalize();
       });
 
       it('should append multiple entries', function() {
         assert.isArray(actual);
-        assert.lengthOf(actual, 5);
 
         assert.property(entries, 'level0.txt');
         assert.property(entries, 'subdir/');
         assert.property(entries, 'subdir/level1.txt');
         assert.property(entries, 'subdir/subsub/');
         assert.property(entries, 'subdir/subsub/level2.txt');
+
+        assert.property(entries, 'directory/level0.txt');
+        assert.property(entries, 'directory/subdir/');
+        assert.property(entries, 'directory/subdir/level1.txt');
+        assert.property(entries, 'directory/subdir/subsub/');
+        assert.property(entries, 'directory/subdir/subsub/level2.txt');
       });
 
-      it('should support passing data properties', function() {
+      it('should support setting data properties', function() {
         assert.property(entries, 'level0.txt');
         assert.propertyVal(entries['level0.txt'], 'prop', 'value');
       });
 
+      it('should support setting data properties via function', function() {
+        assert.property(entries, 'directory/level0.txt');
+        assert.propertyVal(entries['directory/level0.txt'], 'funcProp', true);
+      });
+
       it('should retain directory permissions', function() {
         assert.propertyVal(entries['subdir/'], 'mode', win32 ? 438 : 493);
       });