Allow opt-in use of zopfli for compression

See https://en.wikipedia.org/wiki/Zopfli

Author: lukemelia

README.md

@@ -36,6 +36,14 @@ The Array of built assets.
 
 _Default:_ the `distFiles` property of the deployment context
 
+### zopfli
+
+Use node-zopfli for compression (better than regular gzip
+compression, but slower). If you set this to `true`, you
+will need to `npm install node-zopfli --save-dev` in your app.
+
+_Default:_ false
+
 ## 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.

index.js

@@ -15,13 +15,13 @@ module.exports = {
   name: 'ember-cli-deploy-gzip',
 
   createDeployPlugin: function(options) {
-    var zlib = require('zlib');
     var fs = require('fs');
 
     var DeployPlugin = DeployPluginBase.extend({
       name: options.name,
       defaultConfig: {
         filePattern: '**/*.{js,css,png,gif,jpg,map,xml,txt,svg,eot,ttf,woff,woff2}',
+        zopfli: false,
         distDir: function(context){
           return context.distDir;
         },
@@ -30,6 +30,16 @@ module.exports = {
         }
       },
 
+      configure: function(context) {
+        this._super.configure.call(this, context);
+        if (this.readConfig('zopfli')) {
+          this.log("Using zopfli for compression")
+          this.gzipLibrary = this.project.require('node-zopfli');
+        } else {
+          this.gzipLibrary = require('zlib');
+        }
+      },
+
       willUpload: function(context) {
         var self = this;
 
@@ -45,15 +55,15 @@ module.exports = {
           })
           .catch(this._errorMessage.bind(this));
       },
-      _gzipFiles: function(distDir, distFiles, filePattern) {
+      _gzipFiles: function(distDir, distFiles, filePattern, gzipLibrary) {
         var filesToGzip = distFiles.filter(minimatch.filter(filePattern, { matchBase: true }));
         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 gzip = self.gzipLibrary.createGzip({ format: 'gzip' });
           var inp = fs.createReadStream(fullPath);
           var out = fs.createWriteStream(fullPath + '.gz');
 

tests/unit/index-nodetest.js

@@ -61,21 +61,23 @@ describe('gzip plugin', function() {
           return previous;
         }, []);
 
-        assert.equal(messages.length, 3);
+        assert.equal(messages.length, 4);
       });
 
       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);
+        assert.isDefined(config.gzip.zopfli);
       });
     });
-    describe('with a filePattern, distDir, and distFiles provided', function () {
+    describe('with a filePattern, zopfli, distDir, and distFiles provided', function () {
       beforeEach(function() {
         config = {
           gzip: {
             filePattern: '**/*.*',
+            zopfli: false,
             distDir: 'tmp/dist-deploy',
             distFiles: []
           }
@@ -87,6 +89,7 @@ describe('gzip plugin', function() {
           ui: mockUi,
           config: config
         };
+        debugger;
         plugin.beforeHook(context);
       });
       it('does not warn about missing optional config', function() {
@@ -98,6 +101,7 @@ describe('gzip plugin', function() {
 
           return previous;
         }, []);
+        console.log(messages);
         assert.equal(messages.length, 0);
       });
     });
@@ -134,6 +138,7 @@ describe('gzip plugin', function() {
       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);
+      plugin.gzipLibrary = require('zlib');
     });
 
     afterEach(function(){