Merge pull request #9 from zckrs/option-deleter-after-encoding

Option delete after encoding

Author: Mehdy Dara

README.md

@@ -9,6 +9,7 @@ Inspired by [grunt-image-embed](https://github.com/ehynds/grunt-image-embed) and
 * Supports local and remote resources.
 * Supports buffer (and stream **WIP**).
 * Ability to define a relative base directory to gulpfile.js. Default is the current directory. [Details](#optionsbasedir)
+* Ability to remove a local resource after encoding. Default is unable. [Details](#optionsdeleteafterencoding)
 * Ability to specify a weight limit. Default is 32kB which is IE8's limit. [Details](#optionsmaxweightresource)
 * Ability to filter on file extensions. Default there is no filter. [Details](#optionsextensionsallowed)
 * Ignore a resource by specifying a directive comment in CSS. [Details](#ignore-a-specific-resource)
@@ -53,8 +54,14 @@ Type: `String`
 
 Default value: ``
 
-Notes: If you have absolute image paths in your stylesheet, the path specified in this option will be used as the base directory. By default plugin used the current directory of gulpfile.js to find local resources.
+Note: If you have absolute image paths in your stylesheet, the path specified in this option will be used as the base directory. By default plugin used the current directory of gulpfile.js to find local resources.
 
+#### options.deleteAfterEncoding
+Type: `Boolean`
+
+Default value: false
+
+Note: Delete a local source file after encoding.
 
 #### options.maxWeightResource
 Type: `Number`

package.json

@@ -1,15 +1,15 @@
 {
   "name": "gulp-css-base64",
   "description": "Gulp's task for transform all resources found in a CSS into base64-encoded data URI strings",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "homepage": "http://github.com/zckrs/gulp-css-base64",
   "repository": {
     "type": "git",
     "url": "http://github.com/zckrs/gulp-css-base64.git"
   },
   "bugs": {
     "url": "http://github.com/zckrs/gulp-css-base64/issues",
-    "email": "project@hostname.com"
+    "email": "mdara@eleven-labs.com"
   },
   "contributors": [
     "Mehdy Dara <[email protected]> (http://eleven-labs.com/)"

src/index.js

@@ -20,6 +20,7 @@ var rImages = /url(?:\(['|"]?)(.*?)(?:['|"]?\))(?!.*\/\*base64:skip\*\/)/ig;
 function gulpCssBase64(opts) {
 
     opts = opts || {};
+    opts.deleteAfterEncoding = opts.deleteAfterEncoding || false;
     opts.maxWeightResource = opts.maxWeightResource || 32768;
     opts.extensionsAllowed = opts.extensionsAllowed || [];
     opts.baseDir = opts.baseDir || '';
@@ -28,6 +29,7 @@ function gulpCssBase64(opts) {
     var stream = through.obj(function (file, enc, callbackStream) {
 
         var currentStream = this;
+        var cache = [];
 
         if (file.isNull()) {
             // Do nothing if no contents
@@ -47,12 +49,19 @@ function gulpCssBase64(opts) {
                     return result !== null;
                 },
                 function (callback) {
-                    encodeResource(result[1], file, opts, function (strRes) {
-                        if (undefined !== strRes) {
-                            src = src.replace(result[1], strRes);
-                        }
+                    if (cache[result[1]]) {
+                        src = src.replace(result[1], cache[result[1]]);
                         callback();
-                    });
+                    } else {
+                        encodeResource(result[1], file, opts, function (strRes) {
+                            if (undefined !== strRes) {
+                                src = src.replace(result[1], strRes);
+                                // Store in cache
+                                cache[result[1]] = strRes;
+                            }
+                            callback();
+                        });
+                    }
                 },
                 function () {
                     file.contents = new Buffer(src);
@@ -110,21 +119,26 @@ function encodeResource(img, file, opts, doneCallback) {
         location = img.charAt(0) === "/" ? (opts.baseDir || "") + img : path.join(path.dirname(file.path), (opts.baseDir || "") + "/" + img);
 
         if (!fs.existsSync(location)) {
-            gutil.log("gulp-css-base64 : Ressource not found " + gutil.colors.black.bgYellow(location));
+            gutil.log("gulp-css-base64 : File not found " + gutil.colors.black.bgYellow(location));
             doneCallback();
             return;
         }
 
         binRes = fs.readFileSync(location);
 
         if (binRes.length > opts.maxWeightResource) {
-            gutil.log("gulp-css-base64 : Resource is too big " + gutil.colors.black.bgYellow(binRes.length + " octets"));
+            gutil.log("gulp-css-base64 : File is too big " + gutil.colors.black.bgYellow(binRes.length + " octets") + " : " + location);
             doneCallback();
             return;
         }
 
         var strRes = "data:" + mime.lookup(location) + ";base64," + binRes.toString("base64");
 
+        if(opts.deleteAfterEncoding) {
+            gutil.log("gulp-css-base64 : Resource delete " + gutil.colors.black.bgYellow(location));
+            fs.unlinkSync(location);
+        }
+
         doneCallback(strRes);
         return;
     }

test/test.js

@@ -1,3 +1,4 @@
+var fs = require('fs');
 var assert = require('assert');
 var es = require('event-stream');
 var gutil = require('gulp-util');
@@ -294,6 +295,67 @@ describe('gulp-css-base64', function () {
             });
         });
 
+        it('should delete local resource source file after encoding', function (done) {
+            fs.writeFileSync('test/fixtures/image/very-very-small_copy.png', fs.readFileSync('test/fixtures/image/very-very-small.png'));
+            // create the fake file
+            var fakeFile = new gutil.File({
+                contents: new Buffer('.button_alert{background:url(test/fixtures/image/very-very-small_copy.png) no-repeat 4px 5px;padding-left:12px;font-size:12px;color:#888;text-decoration:underline}')
+            });
+
+            // Create a css-base64 plugin stream
+            var stream = base64({
+                deleteAfterEncoding : true
+            });
+
+            // write the fake file to it
+            stream.write(fakeFile);
+
+            // wait for the file to come back out
+            stream.once('data', function (file) {
+                // make sure it came out the same way it went in
+                assert(file.isBuffer());
+
+                // check the contents
+                assert.equal(file.contents.toString('utf8'), '.button_alert{background:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAANAQAAAABakNnRAAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAAAEgAAABIAEbJaz4AAAArSURBVAjXY/j/g2H/C4b5Jxj6OxgaOEBoxgmGDg8GIACyuRoYjkowfKgAACBpDLQ2kvRRAAAAAElFTkSuQmCC) no-repeat 4px 5px;padding-left:12px;font-size:12px;color:#888;text-decoration:underline}');
+
+                // check if file is removed
+                assert(!fs.existsSync('test/fixtures/image/very-very-small_copy.png'));
+
+                done();
+            });
+        });
+
+        it('should use cache when css contain duplicate uri resource', function (done) {
+            // example case : css contain two url() with same uri and deleteAfterEncoding is enabled
+            fs.writeFileSync('test/fixtures/image/very-very-small_copy.png', fs.readFileSync('test/fixtures/image/very-very-small.png'));
+            // create the fake file
+            var fakeFile = new gutil.File({
+                contents: new Buffer('.button_alert{background:url(test/fixtures/image/very-very-small_copy.png) no-repeat 4px 5px;padding-left:12px;font-size:12px;color:#888;text-decoration:underline.button_alert{background:url(test/fixtures/image/very-very-small_copy.png) no-repeat 4px 5px;padding-left:12px;font-size:12px;color:#888;text-decoration:underline}')
+            });
+
+            // Create a css-base64 plugin stream
+            var stream = base64({
+                deleteAfterEncoding : true
+            });
+
+            // write the fake file to it
+            stream.write(fakeFile);
+
+            // wait for the file to come back out
+            stream.once('data', function (file) {
+                // make sure it came out the same way it went in
+                assert(file.isBuffer());
+
+                // check the contents
+                assert.equal(file.contents.toString('utf8'), '.button_alert{background:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAANAQAAAABakNnRAAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAAAEgAAABIAEbJaz4AAAArSURBVAjXY/j/g2H/C4b5Jxj6OxgaOEBoxgmGDg8GIACyuRoYjkowfKgAACBpDLQ2kvRRAAAAAElFTkSuQmCC) no-repeat 4px 5px;padding-left:12px;font-size:12px;color:#888;text-decoration:underline.button_alert{background:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAANAQAAAABakNnRAAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAAAEgAAABIAEbJaz4AAAArSURBVAjXY/j/g2H/C4b5Jxj6OxgaOEBoxgmGDg8GIACyuRoYjkowfKgAACBpDLQ2kvRRAAAAAElFTkSuQmCC) no-repeat 4px 5px;padding-left:12px;font-size:12px;color:#888;text-decoration:underline}');
+
+                // check if file is removed
+                assert(!fs.existsSync('test/fixtures/image/very-very-small_copy.png'));
+
+                done();
+            });
+        });
+
         it('should convert if remote resource (http://)', function (done) {
             // create the fake file
             var fakeFile = new gutil.File({