Merge pull request #12 from dschmidt/keep

Add keep option with tests

Author: lukemelia

README.md

@@ -78,6 +78,12 @@ If set to `true`, you will need to `npm install node-zopfli --save-dev` in your
 
 *Default:* `false`
 
+### keep
+
+Keep original file and write compressed data to `originalFile.gz`
+
+*Default:* `false`
+
 ## Prequisites
 
 The following properties are expected to be present on the deployment `context` object:
@@ -97,8 +103,3 @@ The following properties are expected to be present on the deployment `context`
 [1]: http://ember-cli.github.io/ember-cli-deploy/plugins "Plugin Documentation"
 [2]: https://github.com/zapnito/ember-cli-deploy-build "ember-cli-deploy-build"
 [3]: https://github.com/zapnito/ember-cli-deploy-s3 "ember-cli-deploy-s3"
-
-## TODO
-
-Some deployment flows require side-by-side deployment of compressed and uncompressed
-assets. A PR to add this option would be welcome.

index.js

@@ -22,6 +22,7 @@ module.exports = {
       defaultConfig: {
         filePattern: '**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}',
         zopfli: false,
+        keep: false,
         distDir: function(context){
           return context.distDir;
         },
@@ -46,26 +47,28 @@ module.exports = {
         var filePattern  = this.readConfig('filePattern');
         var distDir      = this.readConfig('distDir');
         var distFiles    = this.readConfig('distFiles') || [];
+        var keep         = this.readConfig('keep');
 
         this.log('gzipping `' + filePattern + '`');
-        return this._gzipFiles(distDir, distFiles, filePattern)
+        return this._gzipFiles(distDir, distFiles, filePattern, keep)
           .then(function(gzippedFiles) {
             self.log('gzipped ' + gzippedFiles.length + ' files ok');
             return { gzippedFiles: gzippedFiles };
           })
           .catch(this._errorMessage.bind(this));
       },
-      _gzipFiles: function(distDir, distFiles, filePattern, gzipLibrary) {
+      _gzipFiles: function(distDir, distFiles, filePattern, keep) {
         var filesToGzip = distFiles.filter(minimatch.filter(filePattern, { matchBase: true }));
-        return Promise.map(filesToGzip, this._gzipFileInPlace.bind(this, distDir));
+        return Promise.map(filesToGzip, this._gzipFile.bind(this, distDir, keep));
       },
-      _gzipFileInPlace: function(distDir, filePath) {
+      _gzipFile: function(distDir, keep, filePath) {
         var self = this;
         var fullPath = path.join(distDir, filePath);
+        var outFilePath = fullPath + '.gz';
         return new Promise(function(resolve, reject) {
           var gzip = self.gzipLibrary.createGzip({ format: 'gzip' });
           var inp = fs.createReadStream(fullPath);
-          var out = fs.createWriteStream(fullPath + '.gz');
+          var out = fs.createWriteStream(outFilePath);
 
           inp.pipe(gzip).pipe(out);
           inp.on('error', function(err){
@@ -78,10 +81,17 @@ module.exports = {
             resolve();
           });
         }).then(function(){
-          return renameFile(fullPath + '.gz', fullPath);
-        }).then(function(){
-          self.log('✔  ' + filePath);
-          return filePath;
+          if(!keep) {
+            return renameFile(fullPath + '.gz', fullPath).then(function() {
+              return filePath;
+            });
+          } else {
+            return filePath + '.gz';
+          }
+        }).then(function(outFilePath){
+          self.log('✔  ' + outFilePath);
+
+          return outFilePath;
         });
       },
       _errorMessage: function(error) {

tests/unit/index-nodetest.js

@@ -61,7 +61,7 @@ describe('gzip plugin', function() {
           return previous;
         }, []);
 
-        assert.equal(messages.length, 4);
+        assert.equal(messages.length, 5);
       });
 
       it('adds default config to the config object', function() {
@@ -78,6 +78,7 @@ describe('gzip plugin', function() {
           gzip: {
             filePattern: '**/*.*',
             zopfli: false,
+            keep: false,
             distDir: 'tmp/dist-deploy',
             distFiles: []
           }
@@ -152,5 +153,16 @@ describe('gzip plugin', function() {
           done(reason);
         });
     });
+
+    it('gzips the matching files with .gz suffix when keep is enabled', function(done) {
+      context.config.gzip.keep = true;
+      return assert.isFulfilled(plugin.willUpload(context))
+        .then(function(result) {
+          assert.deepEqual(result, { gzippedFiles: ['assets/foo.js.gz'] });
+          done();
+        }).catch(function(reason){
+          done(reason);
+        });
+    });
   });
 });