Renamed KeyGenerators to DataGenerators

Author: achambers

README.md

@@ -1,12 +1,13 @@
 # ember-cli-deploy-revision-data
 
-> An ember-cli-deploy plugin to generate a unique revision key based on the current build
+> An ember-cli-deploy plugin to generate data about this deploy revision including a unique revision key based on the current build
 
 <hr/>
 **WARNING: This plugin is only compatible with ember-cli-deploy versions >= 0.5.0**
 <hr/>
 
-This plugin will generate a unique revision key for the current build. The revision key can be used to uniquely identify the particular version of the application.
+This plugin will generate revison data for the current build. This data can be used by other plugins to understand more about the current revision being deployed.
+The revision key included in the revison data can be used to uniquely identify the particular version of the application.
 
 ## What is an ember-cli-deploy plugin?
 
@@ -51,18 +52,28 @@ For detailed information on how configuration of plugins works, please refer to
 
 ### type
 
-The type of [Key Generator](#key-generators) to be used.
+The type of [Data Generator](#data-generators) to be used.
 
 *Default:* `'file-hash'`
 *Alternatives:* `'git-tag-commit'`, `'version-commit'`
 
-## Key Generators
+## Data Generators
 
-Key generators are the strategies used to generate the unique revision key. Currently there is only one Key Generator implementation but we will add more as needed. Some examples of other potential key generators are `GitHash` or `DateTime` generators.
+Data generators are the strategies used to generate information about the revision being deployed. A data generator must return an object which contains a property called `revisionKey` which uniquely identifies the current revision. A generator can add any other data that it deems relevant to the data object that it returns.
 
 ### File Hash generator
 
-This key generator will fingerprint the `index.html` and return an MD5 hash. The generation of the revision key, using this generator, is guaranteed to be idempotent. That is, the same revision key will be generated for the same set of project files. If the project files change in any way, this will be reflected by a change in the revision key.
+This generator contructs a revisionKey from the fingerprint of the `index.html` file.
+
+#### Data fields returned
+
+##### revisionKey
+
+The unique identifier of this build based on the MD5 fingerprint of the `index.html` file. This key is guaranteed to be idempotent. That is, the same revision key will be generated for the same set of project files. If the project files change in any way, this will be reflected by a change in the revision key.
+
+##### timestamp
+
+The timestamp of the current deploy
 
 #### Configuration Options
 
@@ -86,19 +97,41 @@ The list of built project files. This option should be relative to `distDir` and
 
 ### Git Tag Commit generator
 
-Creates a key based on the most recent git tag and the currently checked-out commit. The tag is the tag identifier, followed by a `+` symbol, followed by the first 8 characters of the commit hash.
+Constructs a revision key based on the most recent git tag and the currently checked-out commit.
+
+#### Data fields returned
+
+##### revisionKey
+
+The unique identifier of this build based on the git tag, followed by a `+` symbol, followed by the first 8 characters of the current commit hash.
 
 For example, if your most recent git tag is `v2.0.3`, and the current commit is `0993043d49f9e0[...]`, this generator will return a revision of `v2.0.3+0993043d`.
 
+##### timestamp
+
+The timestamp of the current deploy
+
 ### Version Commit generator
 
-Similar to the Git Tag Commit generator, but uses the `package.json` version string instead of the git tag. The JSON file containing the version string can be configured with the `versionFile` option.
+Similar to the Git Tag Commit generator but uses the `package.json` version string to construct the revision key instead of the git tag.
+
+#### Data fields returned
+
+##### revisionKey
+
+The unique identifier of this build based on the version in the `package.json`, followed by a `+` symbol, followed by the first 8 characters of the current commit hash.
+
+For example, if your package.json version is `v2.0.3`, and the current commit is `0993043d49f9e0[...]`, this generator will return a revision of `v2.0.3+0993043d`.
+
+##### timestamp
+
+The timestamp of the current deploy
 
 #### Configuration Options
 
 ##### versionFile
 
-The file containing your project's version number. Must be a JSON file with a top-level `version` key. Only used by the `version-commit` key generator.
+The file containing your project's version number. Must be a JSON file with a top-level `version` key.
 
 *Default:* `package.json`
 
@@ -119,4 +152,4 @@ The following properties are expected to be present on the deployment `context`
 
 [1]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
 [2]: https://github.com/zapnito/ember-cli-deploy-build "ember-cli-deploy-build"
-[3]: https://github.com/ember-cli/ember-cli-deploy "ember-cli-deploy"
+[3]: https://github.com/ember-cli/ember-cli-deploy "ember-cli-deploy"

index.js

@@ -25,15 +25,15 @@ module.exports = {
       didBuild: function(context) {
         var self = this;
         var type = this.readConfig('type');
-        var KeyGenerator = require('./lib/key-generators')[type];
-        var keyGenerator = new KeyGenerator({
+        var DataGenerator = require('./lib/data-generators')[type];
+        var dataGenerator = new DataGenerator({
           plugin: this
         });
 
-        this.log('creating revision key using `' + type + '`');
-        return keyGenerator.generate()
+        this.log('creating revision data using `' + type + '`');
+        return dataGenerator.generate()
           .then(function(revisionKey) {
-            self.log('generated revision key: `' + revisionKey + '`');
+            self.log('generated revision ata for revision: `' + revisionKey + '`');
             return revisionKey;
           })
           .then(function(revisionKey) {

lib/key-generators/file-hash.js renamed to lib/data-generators/file-hash.js

@@ -31,14 +31,6 @@ module.exports = CoreObject.extend({
       .then(function(contents) {
         return md5Hash(contents.toString());
       })
-  },
-
-  _resolveConfigValue: function(key, config, context) {
-    if(typeof config[key] === 'function') {
-      return config[key](context);
-    }
-
-    return config[key];
   }
 });
 

lib/key-generators/git-tag-commit.js renamed to lib/data-generators/git-tag-commit.js

@@ -1,7 +1,7 @@
 {
   "name": "ember-cli-deploy-revision-data",
   "version": "0.1.0-beta.2",
-  "description": "An ember-cli-plugin to create a unique revision key for the build",
+  "description": "An ember-cli-deploy plugin to generate data about this deploy revision including a unique revision key based on the current build",
   "directories": {
     "doc": "doc",
     "test": "tests"

lib/key-generators/index.js renamed to lib/data-generators/index.js

@@ -2,11 +2,11 @@
 
 var assert = require('ember-cli/tests/helpers/assert');
 
-describe('the file-hash key generator', function() {
-  var KeyGenerator;
+describe('the file-hash data generator', function() {
+  var DataGenerator;
 
   before(function() {
-    KeyGenerator = require('../../../../lib/key-generators/file-hash');
+    DataGenerator = require('../../../../lib/data-generators/file-hash');
   });
 
   describe('#generate', function() {
@@ -20,7 +20,7 @@ describe('the file-hash key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });
 
@@ -40,7 +40,7 @@ describe('the file-hash key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });
 
@@ -60,7 +60,7 @@ describe('the file-hash key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });
 

lib/key-generators/version-commit.js renamed to lib/data-generators/version-commit.js

@@ -3,12 +3,12 @@
 var assert = require('ember-cli/tests/helpers/assert');
 var gitRepoInfo = require('git-repo-info');
 
-describe('the git-tag-commit key generator', function() {
-  var KeyGenerator;
+describe('the git-tag-commit data generator', function() {
+  var DataGenerator;
   var cwd;
 
   before(function() {
-    KeyGenerator = require('../../../../lib/key-generators/git-tag-commit');
+    DataGenerator = require('../../../../lib/data-generators/git-tag-commit');
     gitRepoInfo._changeGitDir('dotgit');
   });
 
@@ -24,7 +24,7 @@ describe('the git-tag-commit key generator', function() {
     it('concatenates the git tag and the git commit hash', function() {
       process.chdir('tests/fixtures/repo');
 
-      var subject = new KeyGenerator();
+      var subject = new DataGenerator();
 
       return assert.isFulfilled(subject.generate())
         .then(function(revision) {
@@ -35,7 +35,7 @@ describe('the git-tag-commit key generator', function() {
     it('rejects if no repository found', function() {
       process.chdir('tests/fixtures/not-a-repo');
 
-      var subject = new KeyGenerator();
+      var subject = new DataGenerator();
 
       return assert.isRejected(subject.generate())
         .then(function(error) {
@@ -46,7 +46,7 @@ describe('the git-tag-commit key generator', function() {
     it('rejects if no git tag found', function() {
       process.chdir('tests/fixtures/tagless-repo');
 
-      var subject = new KeyGenerator();
+      var subject = new DataGenerator();
 
       return assert.isRejected(subject.generate())
         .then(function(error) {

package.json

@@ -3,12 +3,12 @@
 var assert = require('ember-cli/tests/helpers/assert');
 var gitRepoInfo = require('git-repo-info');
 
-describe('the version-commit key generator', function() {
-  var KeyGenerator;
+describe('the version-commit data generator', function() {
+  var DataGenerator;
   var cwd;
 
   before(function() {
-    KeyGenerator = require('../../../../lib/key-generators/version-commit');
+    DataGenerator = require('../../../../lib/data-generators/version-commit');
     gitRepoInfo._changeGitDir('dotgit');
   });
 
@@ -31,7 +31,7 @@ describe('the version-commit key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });
 
@@ -51,7 +51,7 @@ describe('the version-commit key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });
 
@@ -71,7 +71,7 @@ describe('the version-commit key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });
 
@@ -91,7 +91,7 @@ describe('the version-commit key generator', function() {
         readConfig: function(key) { return this.stubConfig[key]; }
       };
 
-      var subject = new KeyGenerator({
+      var subject = new DataGenerator({
         plugin: plugin
       });