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

Now we use user defined config before context values

Author: Aaron Chambers

index.js

@@ -1,72 +1,84 @@
 /* jshint node: true */
 'use strict';
 
-var cheerio   = require('cheerio');
 var path      = require('path');
 var fs        = require('fs');
+var chalk     = require('chalk');
 var RSVP      = require('rsvp');
+var Promise   = RSVP.Promise;
 var denodeify = RSVP.denodeify;
 
 var readFile  = denodeify(fs.readFile);
 var writeFile = denodeify(fs.writeFile);
 
+var blue      = chalk.blue;
+var red       = chalk.red;
+
+var validateConfig = require('./lib/utilities/validate-config');
+var extractConfig  = require('./lib/utilities/extract-index-config');
+
 module.exports = {
   name: 'ember-cli-deploy-json-config',
 
   createDeployPlugin: function(options) {
-    return {
-      name: options.name,
-
-      didBuild: function(context) {
-        var deployment = context.deployment;
-        var project    = deployment.project;
-        var root       = project.root;
-        var indexPath  = path.join(root, (context.indexPath || 'dist/index.html'));
-        var outputPath = path.join(path.dirname(indexPath), 'index.json');
+    function _beginMessage(ui, inputPattern, outputPattern) {
+      ui.write(blue('|      '));
+      ui.writeLine(blue('- generating `' + outputPattern + '` from `' + inputPattern + '`'));
 
-        return readFile(indexPath)
-          .then(this._extractConfig.bind(this), this._handleMissingFile)
-          .then(writeFile.bind(this, outputPath))
-          .then(function() {
-            return { indexPath: outputPath };
-          });
-      }.bind(this)
+      return Promise.resolve();
     }
-  },
 
-  _extractConfig: function(data) {
-    var $ = cheerio.load(data.toString());
-    var json = {
-      base: this._get($, 'base', ['href']),
-      meta: this._get($, 'meta[name*="/config/environment"]', ['name', 'content']),
-      link: this._get($, 'link', ['rel', 'href']),
-      script: this._get($, 'script', ['src'])
-    };
+    function _successMessage(ui, outputPattern) {
+      ui.write(blue('|      '));
+      ui.writeLine(blue('- generated: `' + outputPattern + '`'));
+
+      return Promise.resolve(outputPattern);
+    }
 
-    return RSVP.resolve(JSON.stringify(json));
-  },
+    function _errorMessage(ui, error) {
+      ui.write(blue('|      '));
+      ui.write(red('- ' + error + '`\n'));
 
-  _handleMissingFile: function() {
-    return RSVP.resolve();
-  },
+      return Promise.reject(error);
+    }
 
-  _get: function($, selector, attributes) {
-    attributes = attributes || [];
-    var config = [];
-    var $tags = $(selector);
+    return {
+      name: options.name,
 
-    $tags.each(function() {
-      var $tag = $(this);
+      willDeploy: function(context) {
+        var deployment = context.deployment;
+        var ui         = deployment.ui;
+        var config     = deployment.config[this.name] = deployment.config[this.name] || {};
 
-      var data = attributes.reduce(function(data, attribute) {
-        data[attribute] = $tag.attr(attribute);
+        return validateConfig(ui, config)
+          .then(function() {
+            ui.write(blue('|    '));
+            ui.writeLine(blue('- config ok'));
+          });
+      },
 
-        return data;
-      }, {});
+      didBuild: function(context) {
+        var deployment = context.deployment;
+        var ui         = deployment.ui;
+        var config     = deployment.config[this.name];
+        var project    = deployment.project;
+        var root       = project.root;
 
-      config.push(data);
-    });
+        var fileInputPattern  = config.fileInputPattern;
+        var fileOutputPattern = config.fileOutputPattern;
+        var inputPath         = path.join(root, fileInputPattern);
+        var outputPath        = path.join(root, fileOutputPattern);
 
-    return config;
+        return _beginMessage(ui, fileInputPattern, fileOutputPattern)
+          .then(readFile.bind(readFile, inputPath))
+          .then(extractConfig.bind(this))
+          .then(writeFile.bind(writeFile, outputPath))
+          .then(_successMessage.bind(this, ui, fileOutputPattern))
+          .then(function(outputPattern) {
+            return { distFiles: [outputPattern] };
+          })
+          .catch(_errorMessage.bind(this, ui));
+      }
+    }
   }
 };

lib/utilities/extract-index-config.js

@@ -0,0 +1,34 @@
+var cheerio   = require('cheerio');
+var RSVP      = require('rsvp');
+
+function _get($, selector, attributes) {
+  attributes = attributes || [];
+  var config = [];
+  var $tags = $(selector);
+
+  $tags.each(function() {
+    var $tag = $(this);
+
+    var data = attributes.reduce(function(data, attribute) {
+      data[attribute] = $tag.attr(attribute);
+
+      return data;
+    }, {});
+
+    config.push(data);
+  });
+
+  return config;
+}
+
+module.exports = function(data) {
+  var $ = cheerio.load(data.toString());
+  var json = {
+    base: _get($, 'base', ['href']),
+    meta: _get($, 'meta[name*="/config/environment"]', ['name', 'content']),
+    link: _get($, 'link', ['rel', 'href']),
+    script: _get($, 'script', ['src'])
+  };
+
+  return RSVP.resolve(JSON.stringify(json));
+};

lib/utilities/validate-config.js

@@ -0,0 +1,26 @@
+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 = {
+    fileInputPattern: 'dist/index.html',
+    fileOutputPattern: 'dist/index.json'
+  };
+
+  ['fileInputPattern', 'fileOutputPattern'].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();
+}

package.json

@@ -42,8 +42,9 @@
     "ember-cli-deploy-plugin"
   ],
   "dependencies": {
-    "ember-cli-babel": "^5.0.0",
+    "chalk": "^1.0.0",
     "cheerio": "^0.19.0",
+    "ember-cli-babel": "^5.0.0",
     "rsvp": "^3.0.18"
   },
   "ember-addon": {

tests/unit/index-nodetest.js

@@ -33,23 +33,53 @@ describe('the deploy plugin object', function() {
       name: 'test-plugin'
     });
 
+    assert.equal(typeof result.willDeploy, 'function');
     assert.equal(typeof result.didBuild, 'function');
   });
 
+  describe('willDeploy hook', function() {
+    it('resolves if config is ok', function() {
+      var plugin = subject.createDeployPlugin({
+        name: 'json-config'
+      });
+
+      var context = {
+        deployment: {
+          ui: { write: function() {}, writeLine: function() {} },
+          config: {
+            'json-config': {
+              fileInputPattern: 'dist/index.html',
+              fileOutputPattern: 'dist/index.json'
+            }
+          }
+        }
+      };
+
+      return assert.isFulfilled(plugin.willDeploy.call(plugin, context))
+    });
+  });
+
   describe('didBuild hook', function() {
     it('generates index.json from index.html', function() {
-      var didBuild = subject.createDeployPlugin({
-        name: 'test-plugin'
-      }).didBuild;
+      var plugin = subject.createDeployPlugin({
+        name: 'json-config'
+      });
 
       var context = {
         deployment: {
-          project: { root: fakeRoot }
+          project: { root: fakeRoot },
+          ui: {write: function() {}, writeLine: function() {}},
+          config: {
+            'json-config': {
+              fileInputPattern: 'dist/index.html',
+              fileOutputPattern: 'dist/index.json'
+            }
+          }
         },
         data: {}
       };
 
-      var promise = didBuild(context);
+      var promise = plugin.didBuild.call(plugin, context);
       return assert.isFulfilled(promise)
         .then(function() {
           var json = require(fakeRoot + '/dist/index.json');
@@ -66,22 +96,28 @@ describe('the deploy plugin object', function() {
     });
 
     it ('returns the index.json path', function() {
-      var didBuild = subject.createDeployPlugin({
-        name: 'test-plugin'
-      }).didBuild;
+      var plugin = subject.createDeployPlugin({
+        name: 'json-config'
+      });
 
       var data = {};
       var context = {
-        indexPath: 'dist/index.html',
         deployment: {
-          project: { root: fakeRoot }
+          project: { root: fakeRoot },
+          ui: {write: function() {}, writeLine: function() {}},
+          config: {
+            'json-config': {
+              fileInputPattern: 'dist/index.html',
+              fileOutputPattern: 'dist/index.json'
+            }
+          }
         }
       };
 
-      var promise = didBuild(context);
+      var promise = plugin.didBuild.call(plugin, context);
       return assert.isFulfilled(promise)
         .then(function(result) {
-          assert.equal(result.indexPath, fakeRoot + '/dist/index.json');
+          assert.deepEqual(result.distFiles, ['dist/index.json']);
         });
     });
   });

tests/unit/lib/utilities/extract-index-config-nodetest.js

@@ -0,0 +1,29 @@
+var assert = require('ember-cli/tests/helpers/assert');
+
+var fs = require('fs');
+
+describe('extract-index-config', function() {
+  var subject;
+
+  before(function() {
+    subject = require('../../../../lib/utilities/extract-index-config');
+  });
+
+  it('extracts the correct config', function() {
+    var contents = fs.readFileSync(process.cwd() + '/tests/fixtures/dist/index.html');
+
+    return assert.isFulfilled(subject(contents))
+      .then(function(config) {
+        var json = JSON.parse(config);
+
+        assert.equal(Object.keys(json).length, 4);
+
+        assert.deepEqual(json.base[0], { href: '/' });
+        assert.deepEqual(json.meta[0], { name: 'my-app/config/environment', content: 'some-config-values' });
+        assert.deepEqual(json.link[0], { rel: 'stylesheet', href: 'assets/vendor.css' });
+        assert.deepEqual(json.link[1], { rel: 'stylesheet', href: 'assets/app.css' });
+        assert.deepEqual(json.script[0], { src: 'assets/vendor.js' });
+        assert.deepEqual(json.script[1], { src: 'assets/app.js' });
+      });
+  });
+});

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

@@ -0,0 +1,62 @@
+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 = {
+      fileInputPattern: 'aaaa',
+      fileOutputPattern:'bbbb'
+    };
+
+    mockUi = {
+      messages: [],
+      write: function() { },
+      writeLine: function(message) {
+        this.messages.push(message);
+      }
+    };
+  });
+
+  it('warns about missing optional config', function() {
+    delete config.fileInputPattern;
+    delete config.fileOutputPattern;
+
+    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, 2);
+      });
+  });
+
+  it('adds default config to the config object', function() {
+    delete config.fileInputPattern;
+    delete config.fileOutputPattern;
+
+    assert.isUndefined(config.fileInputPattern);
+    assert.isUndefined(config.fileOutputPattern);
+
+    return assert.isFulfilled(subject(mockUi, config))
+      .then(function() {
+        assert.isDefined(config.fileInputPattern);
+        assert.isDefined(config.fileOutputPattern);
+      });
+  });
+
+  it('resolves if config is ok', function() {
+    return assert.isFulfilled(subject(mockUi, config));
+  })
+});