Merge pull request #9 from strange-studios/support-activate-pipeline

[WIP] `configure` primes the config with data from the deployment context

Author: Aaron Chambers

index.js

@@ -44,17 +44,14 @@ module.exports = {
         var ui         = deployment.ui;
         var config     = deployment.config[this.name] = deployment.config[this.name] || {};
 
-        return validateConfig(ui, config)
-          .then(function() {
-            ui.write(blue('|    '));
-            ui.writeLine(blue('- config ok'));
-          });
+        return this._resolvePipelineData(config, context)
+          .then(validateConfig.bind(this, ui, config));
       },
 
       didBuild: function(context) {
         var deployment = context.deployment;
         var ui         = deployment.ui;
-        var config     = deployment.config[this.name] || {};
+        var config     = deployment.config[this.name] = deployment.config[this.name] || {};
         var type       = config.type;
 
         var KeyGenerator = generators[type];
@@ -67,9 +64,21 @@ module.exports = {
         .then(keyGenerator.generate.bind(keyGenerator))
           .then(_successMessage.bind(this, ui))
           .then(function(value) {
-            return { revision: value };
+            return { revisionKey: value };
           })
           .catch(_errorMessage.bind(this, ui));
+      },
+
+      _resolvePipelineData: function(config, context) {
+        config.distDir = config.distDir || function(context) {
+          return context.distDir;
+        };
+
+        config.distFiles = config.distFiles || function(context) {
+          return context.distFiles;
+        };
+
+        return Promise.resolve();
       }
     };
   }

lib/key-generators/file-hash.js

@@ -16,8 +16,8 @@ module.exports = CoreObject.extend({
 
   generate: function() {
     var filePattern = this._config.filePattern;
-    var distDir     = this._context.distDir;
-    var distFiles   = this._context.distFiles;
+    var distDir     = this._resolveConfigValue('distDir', this._config, this._context);
+    var distFiles   = this._resolveConfigValue('distFiles', this._config, this._context);
     var fingerprint;
 
     var filePaths = distFiles.filter(minimatch.filter(filePattern, { matchBase: true }));
@@ -33,5 +33,13 @@ module.exports = CoreObject.extend({
         fingerprint = new Fingerprint();
         return fingerprint.hashFn(contents.toString());
       })
+  },
+
+  _resolveConfigValue: function(key, config, context) {
+    if(typeof config[key] === 'function') {
+      return config[key](context);
+    }
+
+    return config[key];
   }
 });

lib/utilities/validate-config.js

@@ -22,5 +22,8 @@ module.exports = function(ui, config) {
     }
   });
 
+  ui.write(blue('|    '));
+  ui.writeLine(blue('- config ok'));
+
   return Promise.resolve();
 }

tests/unit/index-nodetest.js

@@ -2,6 +2,12 @@
 
 var assert = require('ember-cli/tests/helpers/assert');
 
+function hooks(plugin) {
+  return Object.keys(plugin).filter(function(key) {
+    return (key !== 'name') && (key.charAt(0) !== '_') && (typeof plugin[key] === 'function');
+  });
+}
+
 describe('the index', function() {
   var subject;
 
@@ -18,14 +24,15 @@ describe('the index', function() {
   });
 
   it('implements the correct hooks', function() {
-    var result = subject.createDeployPlugin({
+    var plugin = subject.createDeployPlugin({
       name: 'test-plugin'
     });
 
-    assert.equal(typeof result.didBuild, 'function');
+    assert.equal(hooks(plugin).length, 2);
+    assert.sameMembers(hooks(plugin), ['configure', 'didBuild']);
   });
 
-  describe('willDeploy hook', function() {
+  describe('configure hook', function() {
     it('resolves if config is ok', function() {
       var plugin = subject.createDeployPlugin({
         name: 'revision-key'
@@ -48,6 +55,41 @@ describe('the index', function() {
 
       return assert.isFulfilled(plugin.configure.call(plugin, context))
     });
+
+    describe('resolving data from the pipeline', function() {
+      it('resolves the config data from the context', function() {
+        var plugin = subject.createDeployPlugin({
+          name: 'revision-key'
+        });
+
+        var config = {
+          type: 'file-hash',
+          filePattern: 'eeee'
+        };
+        var context = {
+          deployment: {
+            ui: {
+              write: function() {},
+              writeLine: function() {}
+            },
+            config: {
+              'revision-key': config
+            }
+          },
+
+          distDir: 'some-dir',
+          distFiles: ['a.js', 'b.css']
+        };
+
+        return assert.isFulfilled(plugin.configure.call(plugin, context))
+          .then(function() {
+            assert.typeOf(config.distDir, 'function');
+            assert.typeOf(config.distFiles, 'function');
+            assert.equal(config.distDir(context), 'some-dir');
+            assert.sameMembers(config.distFiles(context), ['a.js', 'b.css']);
+          });
+      });
+    });
   });
 
   describe('didBuild hook', function() {
@@ -57,8 +99,6 @@ describe('the index', function() {
       });
 
       var context = {
-        distDir: 'tests/fixtures',
-        distFiles: ['index.html'],
         deployment: {
           ui: {
             write: function() {},
@@ -67,15 +107,17 @@ describe('the index', function() {
           config: {
             'revision-key': {
               type: 'file-hash',
-              filePattern: 'index.html'
+              filePattern: 'index.html',
+              distDir: 'tests/fixtures',
+              distFiles: ['index.html'],
             },
           }
         }
       };
 
       return assert.isFulfilled(plugin.didBuild.call(plugin, context))
         .then(function(result) {
-          assert.equal(result.revision, 'ae1569f72495012cd5e8588e0f2f5d49');
+          assert.equal(result.revisionKey, 'ae1569f72495012cd5e8588e0f2f5d49');
         });
     });
   });

tests/unit/lib/tags/file-hash-nodetest.js renamed to tests/unit/lib/key-generators/file-hash-nodetest.js

@@ -12,12 +12,10 @@ describe('the file-hash key generator', function() {
   describe('#generate', function() {
     it ('generates a hash of the supplied index file', function() {
       var subject = new KeyGenerator({
-        context: {
-          distDir: 'tests/fixtures',
-          distFiles: ['index.html'],
-        },
         config: {
-          filePattern: 'index.html'
+          filePattern: 'index.html',
+          distDir: 'tests/fixtures',
+          distFiles: ['index.html']
         }
       });
 
@@ -29,12 +27,10 @@ describe('the file-hash key generator', function() {
 
     it('rejects when the filePattern doesn\'t exist in distFiles', function() {
       var subject = new KeyGenerator({
-        context: {
+        config: {
+          filePattern: 'some-file-that-does-not-exist',
           distDir: 'tests/fixtures',
           distFiles: ['index.html']
-        },
-        config: {
-          filePattern: 'some-file-that-does-not-exist'
         }
       });
 
@@ -46,12 +42,10 @@ describe('the file-hash key generator', function() {
 
     it('rejects when the file doesn\'t exist', function() {
       var subject = new KeyGenerator({
-        context: {
+        config: {
+          filePattern: 'index.xxx',
           distDir: 'tests/fixtures',
           distFiles: ['index.xxx']
-        },
-        config: {
-          filePattern: 'index.xxx'
         }
       });