Merge pull request #27 from achambers/use-revision-data-object

Reference revisionKey from new revisionData object

Author: lukemelia

README.md

@@ -113,9 +113,9 @@ The prefix to be used for the Redis key under which file will be uploaded to Red
 
 ### revisionKey
 
-The unique revision number for the version of the file being uploaded to Redis. The Redis key will be a combination of the `keyPrefix` and the `revisionKey`. By default this option will use either the `revisionKey` passed in from the command line or the `revisionKey` property from the deployment context.
+The unique revision number for the version of the file being uploaded to Redis. The Redis key will be a combination of the `keyPrefix` and the `revisionKey`. By default this option will use either the `revisionKey` passed in from the command line or the `revisionData.revisionKey` property from the deployment context.
 
-*Default:* `context.commandLineArgs.revisionKey || context.revisionKey`
+*Default:* `context.commandLineArgs.revisionKey || context.revisionData.revisionKey`
 
 ### allowOverwrite
 
@@ -131,15 +131,15 @@ The Redis client to be used to upload files to the Redis store. By default this
 
 ### didDeployMessage
 
-A message that will be displayed after the file has been successfully uploaded to Redis. By default this message will only display if the revision for `revisionKey` of the deployment context has been activated.
+A message that will be displayed after the file has been successfully uploaded to Redis. By default this message will only display if the revision for `revisionData.revisionKey` of the deployment context has been activated.
 
 *Default:* 
 
 ```javascript
-if (context.revisionKey && !context.activatedRevisionKey) {
-  return "Deployed but did not activate revision " + context.revisionKey + ". "
+if (context.revisionData.revisionKey && !context.revisionData.activatedRevisionKey) {
+  return "Deployed but did not activate revision " + context.revisionData.revisionKey + ". "
        + "To activate, run: "
-       + "ember deploy:activate " + context.revisionKey + " --environment=" + context.deployEnvironment + "\n";
+       + "ember deploy:activate " + context.revisionData.revisionKey + " --environment=" + context.deployEnvironment + "\n";
 }
 ```
 
@@ -213,7 +213,7 @@ The following properties are expected to be present on the deployment `context`
 
 - `distDir`                     (provided by [ember-cli-deploy-build][4])
 - `project.name()`              (provided by [ember-cli-deploy][5])
-- `revisionKey`                 (provided by [ember-cli-deploy-revision-key][6])
+- `revisionData.revisionKey`    (provided by [ember-cli-deploy-revision-data][6])
 - `commandLineArgs.revisionKey` (provided by [ember-cli-deploy][5])
 - `deployEnvironment`           (provided by [ember-cli-deploy][5])
 
@@ -226,4 +226,4 @@ The following properties are expected to be present on the deployment `context`
 [3]: https://www.npmjs.com/package/redis "Redis Client"
 [4]: https://github.com/zapnito/ember-cli-deploy-build "ember-cli-deploy-build"
 [5]: https://github.com/ember-cli/ember-cli-deploy "ember-cli-deploy"
-[6]: https://github.com/zapnito/ember-cli-deploy-revision-key "ember-cli-deploy-revision-key"
+[6]: https://github.com/zapnito/ember-cli-deploy-revision-data "ember-cli-deploy-revision-data"

index.js

@@ -29,14 +29,16 @@ module.exports = {
           return context.project.name() + ':index';
         },
         didDeployMessage: function(context){
-          if (context.revisionKey && !context.activatedRevisionKey) {
-            return "Deployed but did not activate revision " + context.revisionKey + ". "
+          var revisionKey = context.revisionData && context.revisionData.revisionKey;
+          var activatedRevisionKey = context.revisionData && context.revisionData.activatedRevisionKey;
+          if (revisionKey && !activatedRevisionKey) {
+            return "Deployed but did not activate revision " + revisionKey + ". "
                  + "To activate, run: "
-                 + "ember deploy:activate " + context.deployTarget + " --revision=" + context.revisionKey + "\n";
+                 + "ember deploy:activate " + context.deployTarget + " --revision=" + revisionKey + "\n";
           }
         },
         revisionKey: function(context) {
-          return context.commandOptions.revision || context.revisionKey;
+          return context.commandOptions.revision || (context.revisionData && context.revisionData.revisionKey);
         },
         redisDeployClient: function(context) {
           var redisOptions = this.pluginConfig;
@@ -76,15 +78,17 @@ module.exports = {
 
       activate: function(/* context */) {
         var redisDeployClient = this.readConfig('redisDeployClient');
-        var revisionKey = this.readConfig('revisionKey');
-        var keyPrefix = this.readConfig('keyPrefix');
+        var revisionKey       = this.readConfig('revisionKey');
+        var keyPrefix         = this.readConfig('keyPrefix');
 
         this.log('Activating revision `' + revisionKey + '`');
         return Promise.resolve(redisDeployClient.activate(keyPrefix, revisionKey))
           .then(this.log.bind(this, '✔ Activated revision `' + revisionKey + '`', {}))
           .then(function(){
             return {
-              activatedRevisionKey: revisionKey
+              revisionData: {
+                activatedRevisionKey: revisionKey
+              }
             };
           })
           .catch(this._errorMessage.bind(this));

tests/unit/index-nodetest.js

@@ -109,7 +109,9 @@ describe('redis plugin', function() {
           config: {
             redis: config
           },
-          revisionKey: 'something-else'
+          revisionData: {
+            revisionKey: 'something-else'
+          }
         };
 
         plugin.beforeHook(context);
@@ -135,7 +137,9 @@ describe('redis plugin', function() {
           commandOptions: {
             revision: 'abcd'
           },
-          revisionKey: 'something-else'
+          revisionData: {
+            revisionKey: 'something-else'
+          }
         };
 
         plugin.beforeHook(context);
@@ -160,7 +164,9 @@ describe('redis plugin', function() {
             redis: config
           },
           commandOptions: { },
-          revisionKey: 'something-else'
+          revisionData: {
+            revisionKey: 'something-else'
+          }
         };
 
         plugin.beforeHook(context);
@@ -380,7 +386,7 @@ describe('redis plugin', function() {
       return assert.isFulfilled(plugin.activate(context))
         .then(function(result) {
           assert.ok(activateCalled);
-          assert.equal(result.activatedRevisionKey, '123abc');
+          assert.equal(result.revisionData.activatedRevisionKey, '123abc');
         });
     });
 
@@ -438,12 +444,11 @@ describe('redis plugin', function() {
         },
         project: stubProject,
         config: {
-          redis: {
-            revisionKey: '123abc',
-            activatedRevisionKey: null
-          }
+          redis: { }
         },
-        revisionKey: '123abc',
+        revisionData: {
+          revisionKey: '123abc',
+        }
       };
       plugin.beforeHook(context);
       plugin.configure(context);