Merge pull request #2 from strange-studios/use-config-before-context

Now we're using user defined config over context

Author: Aaron Chambers

index.js

@@ -1,18 +1,18 @@
 /* jshint node: true */
 'use strict';
 
+var Promise   = require('ember-cli/lib/ext/promise');
 var fs        = require('fs');
-var denodeify = require('rsvp').denodeify;
-var path      = require('path');
-var chalk     = require('chalk');
 
+var chalk     = require('chalk');
 var blue      = chalk.blue;
 var red       = chalk.red;
 
-var Promise   = require('ember-cli/lib/ext/promise');
-
+var denodeify = require('rsvp').denodeify;
 var readFile  = denodeify(fs.readFile);
 
+var validateConfig = require('./lib/utilities/validate-config');
+
 module.exports = {
   name: 'ember-cli-deploy-redis',
 
@@ -27,10 +27,8 @@ module.exports = {
     }
 
     function _beginMessage(ui, indexPath) {
-      var filename = path.basename(indexPath);
-
       ui.write(blue('|      '));
-      ui.write(blue('- Uploading `' + filename + '`\n'));
+      ui.write(blue('- Uploading `' + indexPath + '`\n'));
 
       return Promise.resolve();
     }
@@ -52,6 +50,18 @@ module.exports = {
     return {
       name: options.name,
 
+      willDeploy: function(context) {
+        var deployment = context.deployment;
+        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'));
+          });
+      },
+
       upload: function(context) {
         var deployment = context.deployment;
         var ui         = deployment.ui;
@@ -62,10 +72,10 @@ module.exports = {
         var tag          = context.tag;
         var key          = projectName + ':index';
 
-        var indexPath = context.indexPath;
+        var filePattern  = config.filePattern;
 
-        return _beginMessage(ui, indexPath)
-          .then(_readFileContents.bind(this, indexPath))
+        return _beginMessage(ui, filePattern)
+          .then(_readFileContents.bind(this, filePattern))
           .then(redis.upload.bind(redis, key, tag))
           .then(_successMessage.bind(this, ui))
           .then(function(key) {

lib/redis.js

@@ -3,7 +3,16 @@ var Promise    = require('ember-cli/lib/ext/promise');
 
 module.exports = CoreObject.extend({
   init: function(options) {
-    this._client = options.redisClient || require('then-redis').createClient(options);
+    var redisOptions = {
+      host: options.host,
+      port: options.port
+    };
+
+    if (options.password) {
+      redisOptions.password = options.password;
+    }
+
+    this._client = options.redisClient || require('then-redis').createClient(redisOptions);
 
     this._maxNumberOfRecentUploads = 10;
   },

lib/utilities/validate-config.js

@@ -0,0 +1,27 @@
+var Promise = require('ember-cli/lib/ext/promise');
+
+var chalk  = require('chalk');
+var yellow = chalk.yellow;
+var blue   = chalk.blue;
+
+module.exports = function(ui, config) {
+  ui.write(blue('|    '));
+  ui.writeLine(blue('- validating config'));
+
+  var defaultConfig = {
+    host: 'localhost',
+    port: 6379,
+    filePattern: 'dist/index.html'
+  };
+
+  ['host', 'port', 'filePattern'].forEach(function(prop) {
+    if (!config[prop]) {
+      var value = defaultConfig[prop];
+      config[prop] = value;
+      ui.write(blue('|    '));
+      ui.writeLine(yellow('- Missing config: `' + prop + '`, using default: `' + value + '`'));
+    }
+  });
+
+  return Promise.resolve();
+}

tests/unit/index-nodetest.js

@@ -24,37 +24,72 @@ describe('redis plugin', function() {
       name: 'test-plugin'
     });
 
+    assert.equal(typeof result.willDeploy, 'function');
     assert.equal(typeof result.upload, 'function');
   });
 
-  describe('upload hook', function() {
-    it('uploads the index to redis', function() {
+  describe('willDeploy hook', function() {
+    it('resolves if config is ok', function() {
       var plugin = subject.createDeployPlugin({
-        name: 'test-plugin'
+        name: 'redis'
       });
 
       var context = {
+        deployment: {
+          ui: { write: function() {}, writeLine: function() {} },
+          config: {
+            redis: {
+              host: 'somehost',
+              port: 1234
+            }
+          }
+        }
+      };
+
+      return assert.isFulfilled(plugin.willDeploy.call(plugin, context))
+    });
+  });
+
+  describe('upload hook', function() {
+    var plugin;
+    var context;
+
+    beforeEach(function() {
+      plugin = subject.createDeployPlugin({
+        name: 'redis'
+      });
+
+      context = {
         redisClient: {
           upload: function() {
             return Promise.resolve('redis-key');
           }
         },
         tag: 'some-tag',
-        indexPath: 'tests/index.html',
         deployment: {
           ui: { write: function() {} },
           project: { name: function() { return 'test-project'; } },
-          config: {}
+          config: {
+            redis: {
+              filePattern: 'tests/index.html',
+            }
+          }
         }
       };
+    });
 
+    it('uploads the index to redis', function() {
       return assert.isFulfilled(plugin.upload.call(plugin, context))
         .then(function(result) {
           assert.deepEqual(result, { redisKey: 'redis-key' });
         });
     });
 
     it('returns the uploaded key', function() {
+      return assert.isFulfilled(plugin.upload.call(plugin, context))
+        .then(function(result) {
+          assert.deepEqual(result.redisKey, 'redis-key');
+        });
     });
   });
 });

tests/unit/lib/utilities/validate-config-nodetest.js

@@ -0,0 +1,50 @@
+var assert = require('ember-cli/tests/helpers/assert');
+
+describe('validate-config', function() {
+  var subject;
+  var config;
+  var mockUi;
+
+  before(function() {
+    subject = require('../../../../lib/utilities/validate-config');
+  });
+
+  beforeEach(function() {
+    config = { };
+
+    mockUi = {
+      messages: [],
+      write: function() { },
+      writeLine: function(message) {
+        this.messages.push(message);
+      }
+    };
+  });
+
+  it('warns about missing optional config', function() {
+    return assert.isFulfilled(subject(mockUi, config))
+      .then(function() {
+        var messages = mockUi.messages.reduce(function(previous, current) {
+          if (/- Missing config:\s.*, using default:\s/.test(current)) {
+            previous.push(current);
+          }
+
+          return previous;
+        }, []);
+
+        assert.equal(messages.length, 3);
+      });
+  });
+
+  it('adds default config to the config object', function() {
+    return assert.isFulfilled(subject(mockUi, config))
+      .then(function() {
+        assert.isDefined(config.host);
+        assert.isDefined(config.port);
+      });
+  });
+
+  it('resolves if config is ok', function() {
+    return assert.isFulfilled(subject(mockUi, config));
+  })
+});