Restructure to be based on ember-cli-deploy-plugin.

lukemelia · lukemelia · commit 078fee1c9659 · 2015-07-12T00:09:54.000-04:00
Also includes a first pass at the README.
diff --git a/README.md b/README.md
@@ -1,25 +1,50 @@
-# Ember-cli-deploy-gzip
+# ember-cli-deploy-gzip
 
-This README outlines the details of collaborating on this Ember addon.
+NOTE: This plugin targets ember-cli-deploy 0.5.0 and later. 0.5.0 is in development at this time.
+
+This ember-cli-deploy plugin compresses files in-place using gzip compression.
+
+This is helpful to prepare for upload to a asset host that expects files to be
+pre-compressed.
 
 ## Installation
 
-* `git clone` this repository
-* `npm install`
-* `bower install`
+* `ember install ember-cli-deploy-gzip`
 
-## Running
+## ember-cli-deploy Hooks Implemented
 
-* `ember server`
-* Visit your app at http://localhost:4200.
+* configure
+* willUpload
 
-## Running Tests
+## Configuration Options
+
+### filePattern
+
+Files matching this pattern will be gzipped.
+
+_Default:_ "\*\*/\*.{js,css,png,gif,jpg,map,xml,txt,svg,eot,ttf,woff,woff2}"
+
+### distDir
+
+Directory where assets have been written to
 
-* `ember test`
-* `ember test --server`
+_Default:_ the `distDir` property of the deployment context
 
-## Building
+### distFiles
 
-* `ember build`
+The Array of built assets.
+
+_Default:_ the `distFiles` property of the deployment context
+
+## Prequisites
+
+The default configuration of this plugin expects the deployment context to have `distDir` and `distFiles` properties. These are conveniently created by the [ember-cli-deploy-build](https://github.com/zapnito/ember-cli-deploy-build) plugin so will work out of the box if you are using that plugin.
+
+## Plugins known to work well with this one
+
+[ember-cli-deploy-build](https://github.com/zapnito/ember-cli-deploy-build)
+[ember-cli-deploy-s3](https://github.com/zapnito/ember-cli-deploy-s3)
+
+## Running Tests
 
-For more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).
+* `npm test`
diff --git a/index.js b/index.js
@@ -6,14 +6,10 @@ var fs        = require('fs');
 var path      = require('path');
 var minimatch = require('minimatch');
 
-var chalk     = require('chalk');
-var blue      = chalk.blue;
-var red       = chalk.red;
-
 var denodeify = require('rsvp').denodeify;
 var renameFile  = denodeify(fs.rename);
 
-var validateConfig = require('./lib/utilities/validate-config');
+var DeployPluginBase = require('ember-cli-deploy-plugin');
 
 module.exports = {
   name: 'ember-cli-deploy-gzip',
@@ -22,88 +18,68 @@ module.exports = {
     var zlib = require('zlib');
     var fs = require('fs');
 
-    function _gzipFileInPlace(ui, distDir, filePath) {
-      var fullPath = path.join(distDir, filePath);
-      return new Promise(function(resolve, reject) {
-        var gzip = zlib.createGzip();
-        var inp = fs.createReadStream(fullPath);
-        var out = fs.createWriteStream(fullPath + '.gz');
-
-        inp.pipe(gzip).pipe(out);
-        inp.on('error', function(err){
-          reject(err);
-        });
-        out.on('error', function(err){
-          reject(err);
-        });
-        out.on('finish', function(){
-          resolve();
-        });
-      }).then(function(){
-        return renameFile(fullPath + '.gz', fullPath);
-      }).then(function(){
-        ui.write(blue('|      '));
-        ui.write(blue('- ✔  ' + filePath + '\n'));
-        return filePath;
-      });
-    }
-
-    function _gzipFiles(distDir, distFiles, filePattern, ui) {
-      var filesToGzip = distFiles.filter(minimatch.filter(filePattern, { matchBase: true }));
-      return Promise.map(filesToGzip, _gzipFileInPlace.bind(this, ui, distDir));
-    }
-
-    function _beginMessage(ui, indexPath) {
-      ui.write(blue('|      '));
-      ui.write(blue('- gzipping `' + indexPath + '`\n'));
-
-      return Promise.resolve();
-    }
-
-    function _successMessage(ui, count) {
-      ui.write(blue('|      '));
-      ui.write(blue('- gzipped ' + count + ' files ok\n'));
-    }
-
-    function _errorMessage(ui, error) {
-      ui.write(blue('|      '));
-      ui.write(red('- ' + error + '`\n'));
-
-      return Promise.reject(error);
-    }
-
-    return {
+    var DeployPlugin = DeployPluginBase.extend({
       name: options.name,
-
-      configure: 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'));
-          });
+      defaultConfig: {
+        filePattern: '**/*.{js,css,png,gif,jpg,map,xml,txt,svg,eot,ttf,woff,woff2}',
+        distDir: function(context){
+          return context.distDir;
+        },
+        distFiles: function(context){
+          return context.distFiles;
+        }
       },
 
       willUpload: function(context) {
-        var deployment = context.deployment;
-        var ui         = deployment.ui;
-        var config     = deployment.config[this.name] || {};
+        var self = this;
 
-        var filePattern  = config.filePattern;
-        var distDir     = context.distDir;
-        var distFiles     = context.distFiles || [];
+        var filePattern  = this.readConfig('filePattern');
+        var distDir      = this.readConfig('distDir');
+        var distFiles    = this.readConfig('distFiles') || [];
 
-        return _beginMessage(ui, filePattern)
-          .then(_gzipFiles.bind(this, distDir, distFiles, filePattern, ui))
+        this.log('gzipping `' + filePattern + '`');
+        return this._gzipFiles(distDir, distFiles, filePattern)
           .then(function(gzippedFiles) {
-            _successMessage(ui, gzippedFiles.length);
+            self.log('gzipped ' + gzippedFiles.length + ' files ok');
             return { gzippedFiles: gzippedFiles };
           })
-          .catch(_errorMessage.bind(this, ui));
+          .catch(this._errorMessage.bind(this));
+      },
+      _gzipFiles: function(distDir, distFiles, filePattern) {
+        var filesToGzip = distFiles.filter(minimatch.filter(filePattern, { matchBase: true }));
+        debugger;
+        return Promise.map(filesToGzip, this._gzipFileInPlace.bind(this, distDir));
+      },
+      _gzipFileInPlace: function(distDir, filePath) {
+        var self = this;
+        var fullPath = path.join(distDir, filePath);
+        return new Promise(function(resolve, reject) {
+          var gzip = zlib.createGzip();
+          var inp = fs.createReadStream(fullPath);
+          var out = fs.createWriteStream(fullPath + '.gz');
+
+          inp.pipe(gzip).pipe(out);
+          inp.on('error', function(err){
+            reject(err);
+          });
+          out.on('error', function(err){
+            reject(err);
+          });
+          out.on('finish', function(){
+            resolve();
+          });
+        }).then(function(){
+          return renameFile(fullPath + '.gz', fullPath);
+        }).then(function(){
+          self.log('✔  ' + filePath);
+          return filePath;
+        });
+      },
+      _errorMessage: function(error) {
+        this.log(error, { color: 'red' });
+        return Promise.reject(error);
       }
-    };
+    });
+    return new DeployPlugin();
   }
 };
diff --git a/lib/utilities/validate-config.js b/lib/utilities/validate-config.js
diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
   "dependencies": {
     "chalk": "^1.0.0",
     "core-object": "^1.1.0",
+    "ember-cli-deploy-plugin": "0.1.1",
     "ember-cli-babel": "^5.0.0",
     "minimatch": "^2.0.8",
     "redis": "^0.12.1",
diff --git a/tests/unit/index-nodetest.js b/tests/unit/index-nodetest.js
@@ -7,10 +7,17 @@ var path  = require('path');
 var rimraf  = Promise.denodeify(require('rimraf'));
 
 describe('gzip plugin', function() {
-  var subject;
+  var subject, mockUi, config;
 
-  before(function() {
+  beforeEach(function() {
     subject = require('../../index');
+    mockUi = {
+      messages: [],
+      write: function() { },
+      writeLine: function(message) {
+        this.messages.push(message);
+      }
+    };
   });
 
   it('has a name', function() {
@@ -31,23 +38,68 @@ describe('gzip plugin', function() {
   });
 
   describe('configure hook', function() {
-    it('resolves if config is ok', function() {
-      var plugin = subject.createDeployPlugin({
-        name: 'gzip'
+    var plugin, context;
+    describe('without providing config', function () {
+      beforeEach(function() {
+        config = { };
+        plugin = subject.createDeployPlugin({
+          name: 'gzip'
+        });
+        context = {
+          ui: mockUi,
+          config: config
+        };
+        plugin.beforeHook(context);
       });
+      it('warns about missing optional config', function() {
+        plugin.configure(context);
+        var messages = mockUi.messages.reduce(function(previous, current) {
+          if (/- Missing config:\s.*, using default:\s/.test(current)) {
+            previous.push(current);
+          }
+
+          return previous;
+        }, []);
 
-      var context = {
-        deployment: {
-          ui: { write: function() {}, writeLine: function() {} },
-          config: {
-            gzip: {
-              filePattern: '**/*.js'
-            }
+        assert.equal(messages.length, 3);
+      });
+
+      it('adds default config to the config object', function() {
+        plugin.configure(context);
+        assert.isDefined(config.gzip.filePattern);
+        assert.isDefined(config.gzip.distDir);
+        assert.isDefined(config.gzip.distFiles);
+      });
+    });
+    describe('with a filePattern, distDir, and distFiles provided', function () {
+      beforeEach(function() {
+        config = {
+          gzip: {
+            filePattern: '**/*.*',
+            distDir: 'tmp/dist-deploy',
+            distFiles: []
+          }
+        };
+        plugin = subject.createDeployPlugin({
+          name: 'gzip'
+        });
+        context = {
+          ui: mockUi,
+          config: config
+        };
+        plugin.beforeHook(context);
+      });
+      it('does not warn about missing optional config', function() {
+        plugin.configure(context);
+        var messages = mockUi.messages.reduce(function(previous, current) {
+          if (/- Missing config:\s.*, using default:\s/.test(current)) {
+            previous.push(current);
           }
-        }
-      };
 
-      return assert.isFulfilled(plugin.configure.call(plugin, context))
+          return previous;
+        }, []);
+        assert.equal(messages.length, 0);
+      });
     });
   });
 
@@ -66,13 +118,13 @@ describe('gzip plugin', function() {
           'assets/foo.js',
           'assets/bar.notjs',
         ],
-        deployment: {
-          ui: { write: function() {} },
-          project: { name: function() { return 'test-project'; } },
-          config: {
-            gzip: {
-              filePattern: '**/*.js'
-            }
+        ui: mockUi,
+        project: { name: function() { return 'test-project'; } },
+        config: {
+          gzip: {
+            filePattern: '**/*.js',
+            distDir: function(context){ return context.distDir; },
+            distFiles: function(context){ return context.distFiles; }
           }
         }
       };
@@ -81,14 +133,15 @@ describe('gzip plugin', function() {
       if (!fs.existsSync(path.join(context.distDir, 'assets'))) { fs.mkdirSync(path.join(context.distDir, 'assets')); }
       fs.writeFileSync(path.join(context.distDir, context.distFiles[0]), 'alert("Hello foo world!");', 'utf8');
       fs.writeFileSync(path.join(context.distDir, context.distFiles[1]), 'alert("Hello bar world!");', 'utf8');
+      plugin.beforeHook(context);
     });
 
     afterEach(function(){
       return rimraf(context.distDir);
     });
 
     it('gzips the matching files', function(done) {
-      return assert.isFulfilled(plugin.willUpload.call(plugin, context))
+      return assert.isFulfilled(plugin.willUpload(context))
         .then(function(result) {
           assert.deepEqual(result, { gzippedFiles: ['assets/foo.js'] });
           done();
diff --git a/tests/unit/lib/utilities/validate-config-nodetest.js b/tests/unit/lib/utilities/validate-config-nodetest.js
