[Pkg-javascript-commits] [node-lazystream] 01/06: Imported Upstream version 0.1.0
Andrew Kelley
andrewrk-guest at moszumanska.debian.org
Sat Jun 28 05:57:39 UTC 2014
This is an automated email from the git hooks/post-receive script.
andrewrk-guest pushed a commit to branch master
in repository node-lazystream.
commit 573b630655422c60b217eb22da4efb79f5afffa6
Author: Andrew Kelley <superjoe30 at gmail.com>
Date: Sat Jun 28 05:42:49 2014 +0000
Imported Upstream version 0.1.0
---
.gitignore | 3 ++
.travis.yml | 5 +++
LICENSE-MIT | 23 ++++++++++++
README.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++++++
lib/lazystream.js | 52 ++++++++++++++++++++++++++
package.json | 39 ++++++++++++++++++++
test/data.md | 13 +++++++
test/fs_test.js | 69 ++++++++++++++++++++++++++++++++++
test/helper.js | 39 ++++++++++++++++++++
test/pipe_test.js | 36 ++++++++++++++++++
test/readable_test.js | 88 ++++++++++++++++++++++++++++++++++++++++++++
test/writable_test.js | 59 +++++++++++++++++++++++++++++
12 files changed, 526 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..8030a49
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+npm-debug.log
+node_modules/
+test/tmp/
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..5c11909
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+ - "0.10"
+ - "0.8"
+# - "0.6"
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..982db13
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,23 @@
+Copyright (c) 2013 J. Pommerening, contributors.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3af9caf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,100 @@
+# Lazy Streams
+
+> *Create streams lazily when they are read from or written to.*
+> `lazystream: 0.0.2` [](https://travis-ci.org/jpommerening/node-lazystream)
+
+## Why?
+
+Sometimes you feel the itch to open *all the files* at once. You want to pass a bunch of streams around, so the consumer does not need to worry where the data comes from.
+From a software design point-of-view this sounds entirely reasonable. Then there is that neat little function `fs.createReadStream()` that opens a file and gives you a nice `fs.ReadStream` to pass around, so you use what the mighty creator deities of node bestowed upon you.
+
+> `Error: EMFILE, too many open files`
+> ─ *node*
+
+This package provides two classes based on the node's new streams API (or `readable-stream` if you are using node a node version earlier than 0.10):
+
+## Class: lazystream.Readable
+
+A wrapper for readable streams. Extends [`stream.PassThrough`](http://nodejs.org/api/stream.html#stream_class_stream_passthrough).
+
+### new lazystream.Readable(fn [, options])
+
+* `fn` *{Function}*
+ The function that the lazy stream will call to obtain the stream to actually read from.
+* `options` *{Object}*
+ Options for the underlying `PassThrough` stream, accessible by `fn`.
+
+Creates a new readable stream. Once the stream is accessed (for example when you call its `read()` method, or attach a `data`-event listener) the `fn` function is called with the outer `lazystream.Readable` instance bound to `this`.
+
+If you pass an `options` object to the constuctor, you can access it in your `fn` function.
+
+```javascript
+new lazystream.Readable(function (options) {
+ return fs.createReadStream('/dev/urandom');
+});
+```
+
+## Class: lazystream.Writable
+
+A wrapper for writable streams. Extends [`stream.PassThrough`](http://nodejs.org/api/stream.html#stream_class_stream_passthrough).
+
+### new lazystream.Writable(fn [, options])
+
+* `fn` *{Function}*
+ The function that the lazy stream will call to obtain the stream to actually write to.
+* `options` *{Object}*
+ Options for the underlying `PassThrough` stream, accessible by `fn`.
+
+Creates a new writable stream. Just like the one above but for writable streams.
+
+```javascript
+new lazystream.Writable(function () {
+ return fs.createWriteStream('/dev/null');
+});
+```
+
+## Install
+
+```console
+$ npm install lazystream --save
+npm http GET https://registry.npmjs.org/readable-stream
+npm http 200 https://registry.npmjs.org/readable-stream
+npm http GET https://registry.npmjs.org/readable-stream/-/readable-stream-1.0.2.tgz
+npm http 200 https://registry.npmjs.org/readable-stream/-/readable-stream-1.0.2.tgz
+lazystream at 0.0.2 node_modules/lazystream
+└── readable-stream at 1.0.2
+```
+
+## Contributing
+
+Fork it, branch it, send me a pull request. We'll work out the rest together.
+
+## Credits
+
+[Chris Talkington](https://github.com/ctalkington) and his [node-archiver](https://github.com/ctalkington/node-archiver) for providing a use-case.
+
+## [License](LICENSE-MIT)
+
+Copyright (c) 2013 J. Pommerening, contributors.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
diff --git a/lib/lazystream.js b/lib/lazystream.js
new file mode 100644
index 0000000..c6fbb39
--- /dev/null
+++ b/lib/lazystream.js
@@ -0,0 +1,52 @@
+
+var util = require('util');
+var PassThrough = require('stream').PassThrough || require('readable-stream/passthrough');
+
+module.exports = {
+ Readable: Readable,
+ Writable: Writable
+};
+
+util.inherits(Readable, PassThrough);
+util.inherits(Writable, PassThrough);
+
+// Patch the given method of instance so that the callback
+// is executed once, before the actual method is called the
+// first time.
+function beforeFirstCall(instance, method, callback) {
+ instance[method] = function() {
+ delete instance[method];
+ callback.apply(this, arguments);
+ return this[method].apply(this, arguments);
+ };
+}
+
+function Readable(fn, options) {
+ if (!(this instanceof Readable))
+ return new Readable(fn, options);
+
+ PassThrough.call(this, options);
+
+ beforeFirstCall(this, '_read', function() {
+ var source = fn.call(this, options);
+ var that = this;
+ source.pipe(this);
+ });
+
+ this.emit('readable');
+}
+
+function Writable(fn, options) {
+ if (!(this instanceof Writable))
+ return new Writable(fn, options);
+
+ PassThrough.call(this, options);
+
+ beforeFirstCall(this, '_write', function() {
+ var destination = fn.call(this, options);
+ this.pipe(destination);
+ });
+
+ this.emit('writable');
+}
+
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..215732c
--- /dev/null
+++ b/package.json
@@ -0,0 +1,39 @@
+{
+ "name": "lazystream",
+ "version": "0.1.0",
+ "description": "Open Node Streams on demand.",
+ "homepage": "https://github.com/jpommerening/node-lazystream",
+ "author": {
+ "name": "J. Pommerening"
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/jpommerening/node-lazystream.git"
+ },
+ "bugs": {
+ "url": "https://github.com/jpommerening/node-lazystream/issues"
+ },
+ "licenses": [
+ {
+ "type": "MIT",
+ "url": "https://github.com/jpommerening/node-lazystream/blob/master/LICENSE-MIT"
+ }
+ ],
+ "main": "lib/lazystream.js",
+ "engines": {
+ "node": ">= 0.6.3"
+ },
+ "scripts": {
+ "test": "nodeunit test/readable_test.js test/writable_test.js test/pipe_test.js test/fs_test.js"
+ },
+ "dependencies": {
+ "readable-stream": "~1.0.2"
+ },
+ "devDependencies": {
+ "nodeunit": "~0.7.4"
+ },
+ "keywords": [
+ "streams",
+ "stream"
+ ]
+}
diff --git a/test/data.md b/test/data.md
new file mode 100644
index 0000000..fc48222
--- /dev/null
+++ b/test/data.md
@@ -0,0 +1,13 @@
+> Never mind, hey, this is really exciting, so much to find out about, so much to
+> look forward to, I'm quite dizzy with anticipation . . . Or is it the wind?
+>
+> There really is a lot of that now, isn't there? And wow! Hey! What's this thing
+> suddenly coming toward me very fast? Very, very fast. So big and flat and round,
+> it needs a big wide-sounding name like . . . ow . . . ound . . . round . . .
+> ground! That's it! That's a good name- ground!
+>
+> I wonder if it will be friends with me?
+>
+> Hello Ground!
+
+And the rest, after a sudden wet thud, was silence.
diff --git a/test/fs_test.js b/test/fs_test.js
new file mode 100644
index 0000000..149b1c4
--- /dev/null
+++ b/test/fs_test.js
@@ -0,0 +1,69 @@
+
+var stream = require('../lib/lazystream');
+var fs = require('fs');
+var tmpDir = 'test/tmp/';
+var readFile = 'test/data.md';
+var writeFile = tmpDir + 'data.md';
+
+exports.fs = {
+ readwrite: function(test) {
+ var readfd, writefd;
+
+ var readable = new stream.Readable(function() {
+ return fs.createReadStream(readFile)
+ .on('open', function(fd) {
+ readfd = fd;
+ })
+ .on('close', function() {
+ readfd = undefined;
+ step();
+ });
+ });
+
+ var writable = new stream.Writable(function() {
+ return fs.createWriteStream(writeFile)
+ .on('open', function(fd) {
+ writefd = fd;
+ })
+ .on('close', function() {
+ writefd = undefined;
+ step();
+ });
+ });
+
+ test.expect(3);
+
+ test.equal(readfd, undefined, 'Input file should not be opened until read');
+ test.equal(writefd, undefined, 'Output file should not be opened until write');
+
+ if (!fs.existsSync(tmpDir)) {
+ fs.mkdirSync(tmpDir);
+ }
+ if (fs.existsSync(writeFile)) {
+ fs.unlinkSync(writeFile);
+ }
+
+ readable.on('end', function() { step(); });
+ writable.on('end', function() { step(); });
+
+ var steps = 0;
+ function step() {
+ steps += 1;
+ if (steps == 4) {
+ var input = fs.readFileSync(readFile);
+ var output = fs.readFileSync(writeFile);
+
+ test.ok(input >= output && input <= output, 'Should be equal');
+
+ fs.unlinkSync(writeFile);
+ fs.rmdirSync(tmpDir);
+
+ test.done();
+ }
+ };
+
+ readable.pipe(writable);
+ }
+};
+
+
diff --git a/test/helper.js b/test/helper.js
new file mode 100644
index 0000000..9d41191
--- /dev/null
+++ b/test/helper.js
@@ -0,0 +1,39 @@
+
+var _Readable = require('readable-stream/readable');
+var _Writable = require('readable-stream/writable');
+var util = require('util');
+
+module.exports = {
+ DummyReadable: DummyReadable,
+ DummyWritable: DummyWritable
+};
+
+function DummyReadable(strings) {
+ _Readable.call(this);
+ this.strings = strings;
+ this.emit('readable');
+}
+
+util.inherits(DummyReadable, _Readable);
+
+DummyReadable.prototype._read = function _read(n) {
+ if (this.strings.length) {
+ this.push(new Buffer(this.strings.shift()));
+ } else {
+ this.push(null);
+ }
+};
+
+function DummyWritable(strings) {
+ _Writable.call(this);
+ this.strings = strings;
+ this.emit('writable');
+}
+
+util.inherits(DummyWritable, _Writable);
+
+DummyWritable.prototype._write = function _write(chunk, encoding, callback) {
+ this.strings.push(chunk.toString());
+ if (callback) callback();
+};
+
diff --git a/test/pipe_test.js b/test/pipe_test.js
new file mode 100644
index 0000000..7129e35
--- /dev/null
+++ b/test/pipe_test.js
@@ -0,0 +1,36 @@
+
+var stream = require('../lib/lazystream');
+var helper = require('./helper');
+
+exports.pipe = {
+ readwrite: function(test) {
+ var expected = [ 'line1\n', 'line2\n' ];
+ var actual = [];
+ var readableInstantiated = false;
+ var writableInstantiated = false;
+
+ test.expect(3);
+
+ var readable = new stream.Readable(function() {
+ readableInstantiated = true;
+ return new helper.DummyReadable([].concat(expected));
+ });
+
+ var writable = new stream.Writable(function() {
+ writableInstantiated = true;
+ return new helper.DummyWritable(actual);
+ });
+
+ test.equal(readableInstantiated, false, 'DummyReadable should only be instantiated when it is needed');
+ test.equal(writableInstantiated, false, 'DummyWritable should only be instantiated when it is needed');
+
+ writable.on('end', function() {
+ test.equal(actual.join(''), expected.join(''), 'Piping on demand streams should keep data intact');
+ test.done();
+ });
+
+ readable.pipe(writable);
+ }
+};
+
+
diff --git a/test/readable_test.js b/test/readable_test.js
new file mode 100644
index 0000000..12eb05a
--- /dev/null
+++ b/test/readable_test.js
@@ -0,0 +1,88 @@
+
+var Readable = require('../lib/lazystream').Readable;
+var DummyReadable = require('./helper').DummyReadable;
+
+exports.readable = {
+ dummy: function(test) {
+ var expected = [ 'line1\n', 'line2\n' ];
+ var actual = [];
+
+ test.expect(1);
+
+ new DummyReadable([].concat(expected))
+ .on('data', function(chunk) {
+ actual.push(chunk.toString());
+ })
+ .on('end', function() {
+ test.equal(actual.join(''), expected.join(''), 'DummyReadable should produce the data it was created with');
+ test.done();
+ });
+ },
+ options: function(test) {
+ test.expect(3);
+
+ var readable = new Readable(function(options) {
+ test.ok(this instanceof Readable, "Readable should bind itself to callback's this");
+ test.equal(options.encoding, "utf-8", "Readable should make options accessible to callback");
+ this.ok = true;
+ return new DummyReadable(["test"]);
+ }, {encoding: "utf-8"});
+
+ readable.read(4);
+
+ test.ok(readable.ok);
+
+ test.done();
+ },
+ streams2: function(test) {
+ var expected = [ 'line1\n', 'line2\n' ];
+ var actual = [];
+ var instantiated = false;
+
+ test.expect(2);
+
+ var readable = new Readable(function() {
+ instantiated = true;
+ return new DummyReadable([].concat(expected));
+ });
+
+ test.equal(instantiated, false, 'DummyReadable should only be instantiated when it is needed');
+
+ readable.on('readable', function() {
+ var chunk = readable.read();
+ actual.push(chunk.toString());
+ });
+ readable.on('end', function() {
+ test.equal(actual.join(''), expected.join(''), 'Readable should not change the data of the underlying stream');
+ test.done();
+ });
+
+ readable.read(0);
+ },
+ resume: function(test) {
+ var expected = [ 'line1\n', 'line2\n' ];
+ var actual = [];
+ var instantiated = false;
+
+ test.expect(2);
+
+ var readable = new Readable(function() {
+ instantiated = true;
+ return new DummyReadable([].concat(expected));
+ });
+
+ readable.pause();
+
+ readable.on('data', function(chunk) {
+ actual.push(chunk.toString());
+ });
+ readable.on('end', function() {
+ test.equal(actual.join(''), expected.join(''), 'Readable should not change the data of the underlying stream');
+ test.done();
+ });
+
+ test.equal(instantiated, false, 'DummyReadable should only be instantiated when it is needed');
+
+ readable.resume();
+ }
+};
diff --git a/test/writable_test.js b/test/writable_test.js
new file mode 100644
index 0000000..a663845
--- /dev/null
+++ b/test/writable_test.js
@@ -0,0 +1,59 @@
+
+var Writable = require('../lib/lazystream').Writable;
+var DummyWritable = require('./helper').DummyWritable;
+
+exports.writable = {
+ options: function(test) {
+ test.expect(3);
+
+ var writable = new Writable(function(options) {
+ test.ok(this instanceof Writable, "Writable should bind itself to callback's this");
+ test.equal(options.encoding, "utf-8", "Writable should make options accessible to callback");
+ this.ok = true;
+ return new DummyWritable([]);
+ }, {encoding: "utf-8"});
+
+ writable.write("test");
+
+ test.ok(writable.ok);
+
+ test.done();
+ },
+ dummy: function(test) {
+ var expected = [ 'line1\n', 'line2\n' ];
+ var actual = [];
+
+ test.expect(0);
+
+ var dummy = new DummyWritable(actual);
+
+ expected.forEach(function(item) {
+ dummy.write(new Buffer(item));
+ });
+ test.done();
+ },
+ streams2: function(test) {
+ var expected = [ 'line1\n', 'line2\n' ];
+ var actual = [];
+ var instantiated = false;
+
+ test.expect(2);
+
+ var writable = new Writable(function() {
+ instantiated = true;
+ return new DummyWritable(actual);
+ });
+
+ test.equal(instantiated, false, 'DummyWritable should only be instantiated when it is needed');
+
+ writable.on('end', function() {
+ test.equal(actual.join(''), expected.join(''), 'Writable should not change the data of the underlying stream');
+ test.done();
+ });
+
+ expected.forEach(function(item) {
+ writable.write(new Buffer(item));
+ });
+ writable.end();
+ }
+};
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-lazystream.git
More information about the Pkg-javascript-commits
mailing list