Return revisionData object from generators

Author: achambers

index.js

@@ -32,12 +32,12 @@ module.exports = {
 
         this.log('creating revision data using `' + type + '`');
         return dataGenerator.generate()
-          .then(function(revisionKey) {
-            self.log('generated revision ata for revision: `' + revisionKey + '`');
-            return revisionKey;
+          .then(function(data) {
+            self.log('generated revision data for revision: `' + data.revisionKey + '`');
+            return data;
           })
-          .then(function(revisionKey) {
-            return { revisionKey: revisionKey };
+          .then(function(data) {
+            return { revisionData: data };
           })
           .catch(this._errorMessage.bind(this));
       },

lib/data-generators/file-hash.js

@@ -29,7 +29,10 @@ module.exports = CoreObject.extend({
 
     return readFile(filePath)
       .then(function(contents) {
-        return md5Hash(contents.toString());
+        return {
+          revisionKey: md5Hash(contents.toString()),
+          timestamp: new Date().toISOString()
+        };
       })
   }
 });

lib/data-generators/git-tag-commit.js

@@ -18,6 +18,9 @@ module.exports = CoreObject.extend({
       return Promise.reject('Could not build revision with tag `' + tag + '` and commit hash `' + sha + '`');
     }
 
-    return Promise.resolve(info.tag + '+' + sha);
+    return Promise.resolve({
+      revisionKey: info.tag + '+' + sha,
+      timestamp: new Date().toISOString()
+    });
   }
 });

lib/data-generators/version-commit.js

@@ -31,7 +31,10 @@ module.exports = CoreObject.extend({
           return Promise.reject('Could not build revision with version `' + json.version + '` and commit hash `' + sha + '`');
         }
 
-        return json.version + '+' + sha;
+        return {
+          revisionKey: json.version + '+' + sha,
+          timestamp: new Date().toISOString()
+        };
       });
   }
 });

tests/unit/index-nodetest.js

@@ -102,7 +102,7 @@ describe('the index', function() {
   });
 
   describe('didBuild hook', function() {
-    it('returns the revisionKey', function() {
+    it('returns the revisionData', function() {
       var plugin = subject.createDeployPlugin({
         name: 'revision-data'
       });
@@ -128,7 +128,8 @@ describe('the index', function() {
 
       return assert.isFulfilled(plugin.didBuild(context))
         .then(function(result) {
-          assert.equal(result.revisionKey, 'ae1569f72495012cd5e8588e0f2f5d49');
+          assert.equal(result.revisionData.revisionKey, 'ae1569f72495012cd5e8588e0f2f5d49');
+          assert.isNotNull(result.revisionData.timestamp);
         });
     });
   });

tests/unit/lib/data-generators/file-hash-nodetest.js

@@ -10,24 +10,37 @@ describe('the file-hash data generator', function() {
   });
 
   describe('#generate', function() {
-    it('generates a hash of the supplied index file', function() {
-      var plugin = {
-        stubConfig: {
-          distDir: 'tests/fixtures',
-          distFiles: ['index.html'],
-          filePattern: 'index.html'
-        },
-        readConfig: function(key) { return this.stubConfig[key]; }
-      };
+    describe('revisionData', function() {
+      var subject;
 
-      var subject = new DataGenerator({
-        plugin: plugin
-      });
+      before(function() {
+        var plugin = {
+          stubConfig: {
+            distDir: 'tests/fixtures',
+            distFiles: ['index.html'],
+            filePattern: 'index.html'
+          },
+          readConfig: function(key) { return this.stubConfig[key]; }
+        };
 
-      return assert.isFulfilled(subject.generate())
-        .then(function(hash) {
-          assert.equal(hash, 'ae1569f72495012cd5e8588e0f2f5d49');
+        subject = new DataGenerator({
+          plugin: plugin
         });
+      });
+
+      it('includes the revisonKey', function() {
+        return assert.isFulfilled(subject.generate())
+          .then(function(revisionData) {
+            assert.equal(revisionData.revisionKey, 'ae1569f72495012cd5e8588e0f2f5d49');
+          });
+      });
+
+      it('includes a timestamp', function() {
+        return assert.isFulfilled(subject.generate())
+          .then(function(revisionData) {
+            assert.isNotNull(revisionData.timestamp);
+          });
+      });
     });
 
     it('rejects when the filePattern doesn\'t exist in distFiles', function() {

tests/unit/lib/data-generators/git-tag-commit-nodetest.js

@@ -27,8 +27,19 @@ describe('the git-tag-commit data generator', function() {
       var subject = new DataGenerator();
 
       return assert.isFulfilled(subject.generate())
-        .then(function(revision) {
-          assert.equal(revision, '2.3.4+41d41f08');
+        .then(function(data) {
+          assert.equal(data.revisionKey, '2.3.4+41d41f08');
+        });
+    });
+
+    it('returns a timestamp', function() {
+      process.chdir('tests/fixtures/repo');
+
+      var subject = new DataGenerator();
+
+      return assert.isFulfilled(subject.generate())
+        .then(function(data) {
+          assert.isNotNull(data.timestamp);
         });
     });
 

tests/unit/lib/data-generators/version-commit-nodetest.js

@@ -36,17 +36,17 @@ describe('the version-commit data generator', function() {
       });
 
       return assert.isFulfilled(subject.generate())
-        .then(function(revision) {
-          assert.equal(revision, '3.2.1+41d41f08');
+        .then(function(data) {
+          assert.equal(data.revisionKey, '3.2.1+41d41f08');
         });
     });
 
-    it('rejects if no repository found', function() {
-      process.chdir('tests/fixtures/not-a-repo');
+    it('has version source file option', function() {
+      process.chdir('tests/fixtures/repo');
 
       var plugin = {
         stubConfig: {
-          versionFile: 'package.json'
+          versionFile: 'version.json'
         },
         readConfig: function(key) { return this.stubConfig[key]; }
       };
@@ -55,18 +55,18 @@ describe('the version-commit data generator', function() {
         plugin: plugin
       });
 
-      return assert.isRejected(subject.generate())
-        .then(function(error) {
-          assert.equal(error, 'Could not find git repository');
+      return assert.isFulfilled(subject.generate())
+        .then(function(data) {
+          assert.equal(data.revisionKey, '1.2.3+41d41f08');
         });
     });
 
-    it('has version source file option', function() {
+    it('returns a timestamp', function() {
       process.chdir('tests/fixtures/repo');
 
       var plugin = {
         stubConfig: {
-          versionFile: 'version.json'
+          versionFile: 'package.json'
         },
         readConfig: function(key) { return this.stubConfig[key]; }
       };
@@ -76,8 +76,28 @@ describe('the version-commit data generator', function() {
       });
 
       return assert.isFulfilled(subject.generate())
-        .then(function(revision) {
-          assert.equal(revision, '1.2.3+41d41f08');
+        .then(function(data) {
+          assert.isNotNull(data.timestamp);
+        });
+    });
+
+    it('rejects if no repository found', function() {
+      process.chdir('tests/fixtures/not-a-repo');
+
+      var plugin = {
+        stubConfig: {
+          versionFile: 'package.json'
+        },
+        readConfig: function(key) { return this.stubConfig[key]; }
+      };
+
+      var subject = new DataGenerator({
+        plugin: plugin
+      });
+
+      return assert.isRejected(subject.generate())
+        .then(function(error) {
+          assert.equal(error, 'Could not find git repository');
         });
     });