Initial commit

Author: jeromew

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+

Makefile

@@ -0,0 +1,10 @@
+
+node_modules: package.json
+	@npm install
+
+test:
+	@./node_modules/.bin/mocha \
+		--reporter spec \
+		--timeout 100
+
+.PHONY: test

Readme.md

@@ -0,0 +1,27 @@
+# gulp-buffer
+
+  Some gulp plugins do not support streaming file contents. gulp-buffer and gulp-stream come to the rescue.
+  
+  There are 3 main reasons why a gulp plugin may not support stream :
+
+    * The stream support is on the roadmap but has not been added to the plugin
+    * The underlying library used for the transformation does yet support a streaming API
+    * The content transformation is not very well suited for streaming (think of content.reverse() for example where you need the end of the file first)
+
+  In all these cases, simply add gulp-buffer in front of such a plugin, and it will make sure that the plugin is presented only with buffers.
+
+  When you want to go back to full streaming capabilities, add gulp-stream and it will make sure that all your files are streamed again.
+
+
+[![build status](https://secure.travis-ci.org/jeromew/gulp-buffer.png)](http://travis-ci.org/jeromew/gulp-buffer)
+
+## Installation
+
+```bash
+$ npm install gulp-buffer
+```
+
+# Licence
+
+  MIT
+

index.js

@@ -0,0 +1,46 @@
+var through = require('through2');
+
+// Consts
+const PLUGIN_NAME = 'gulp-buffer';
+
+function gulpBuffer() {
+  var stream = through.obj(function(file, enc, callback) {
+
+    // keep null files as-is
+    if (file.isNull()) {
+      this.push(file);
+      return callback();
+    }
+
+    // keep buffer files as-is
+    if (file.isBuffer()) {
+      this.push(file);
+      return callback();
+    }
+
+    // transform stream files into buffer
+    if (file.isStream()) {
+       var self = this;
+       var c_stream = file.contents;
+       var chunks = [];
+       var onreadable = function() {
+         var chunk;
+         while (null !== (chunk = c_stream.read())) {
+           chunks.push(chunk);
+         }
+       };
+       c_stream.on('readable', onreadable);
+       c_stream.once('end', function() {
+	 c_stream.removeListener('readable', onreadable);
+         file.contents = Buffer.concat(chunks);
+         self.push(file);
+	 callback();
+       });
+       return;
+    }
+  });
+
+  return stream;
+};
+
+module.exports = gulpBuffer;

package.json

@@ -0,0 +1,21 @@
+{
+  "name": "gulp-buffer",
+  "version": "0.0.1",
+  "description": "Make sure all gulp file contents are available as buffer",
+  "repository": "jeromew/gulp-buffer",
+  "licence": "MIT",
+  "author": "Jérôme Wagner",
+  "keywords": [
+    "gulp"
+  ],
+  "dependencies": {
+    "through2": "~0.4.0"
+  },
+  "devDependencies": {
+    "mocha": "~1.17.0",
+    "vinyl": "~0.2.3"
+  },
+  "scripts": {
+    "test": "make test"
+  }
+}

test/gulp-buffer.js

@@ -0,0 +1,92 @@
+var fs = require('fs');
+var File = require('vinyl');
+var buffer = require('..');
+var through = require('through2');
+var assert = require('assert');
+var Stream = require('stream');
+
+describe('gulp-buffer', function() {
+
+  describe('with null contents', function() { 
+    it('should let null files pass through', function(done) {
+      var b = buffer();
+      var n = 0;
+      var _transform = function(file, enc, callback) {
+        assert.equal(file.contents, null);
+        n++;
+	callback();
+      }
+      var _flush = function(callback) {
+        assert.equal(n, 1);
+        done();
+	callback();
+      }
+      var t = through.obj(_transform, _flush);
+      b.pipe(t);
+      b.end(new File({
+        contents: null
+      }));
+    });
+  });
+
+  describe('with buffer contents', function() { 
+    it('should let buffer files pass through', function(done) {
+      var b = buffer();
+      var n = 0;
+      var c = new Buffer("data");
+      var _transform = function(file, enc, callback) {
+        assert.equal(file.contents, c);
+        n++;
+	callback();
+      }
+      var _flush = function(callback) {
+        assert.equal(n, 1);
+        done();
+	callback();
+      }
+      var t = through.obj(_transform, _flush);
+      b.pipe(t);
+      b.end(new File({
+        contents: c
+      }));
+    });
+  });
+
+  describe('with stream contents', function() { 
+    it('should transform stream to buffer', function(done) {
+      var b = buffer();
+      var n = 0;
+      var c = Readable();
+      var _transform = function(file, enc, callback) {
+	assert.equal(file.isBuffer(), true);
+        assert.equal(file.contents.toString(), "data");
+        n++;
+	callback();
+      }
+      var _flush = function(callback) {
+        assert.equal(n, 1);
+        done();
+	callback();
+      }
+      var t = through.obj(_transform, _flush);
+      b.pipe(t);
+      b.end(new File({
+        contents: c
+      }));
+    });
+  });
+
+
+});
+
+function Readable(cb){
+  var readable = new Stream.Readable();
+  readable._read = function() {
+    this.push(new Buffer('data'));
+    this.push(null); // no more data
+  };
+  if (cb) readable.on('end', cb);
+  return readable;
+}
+
+