pax_global_header00006660000000000000000000000064130036522270014512gustar00rootroot0000000000000052 comment=9d887ebaec81a5f59593b6d7b69c3c522bf5d425
cloneable-readable-1.0.0/000077500000000000000000000000001300365222700151715ustar00rootroot00000000000000cloneable-readable-1.0.0/.gitignore000066400000000000000000000010211300365222700171530ustar00rootroot00000000000000# Logs
logs
*.log
npm-debug.log*
# Runtime data
pids
*.pid
*.seed
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# node-waf configuration
.lock-wscript
# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
# Dependency directory
node_modules
# Optional npm cache directory
.npm
# Optional REPL history
.node_repl_history
cloneable-readable-1.0.0/.travis.yml000066400000000000000000000001251300365222700173000ustar00rootroot00000000000000language: node_js
sudo: false
node_js:
- "0.10"
- "0.12"
- "4"
- "5"
- "6"
cloneable-readable-1.0.0/LICENSE000066400000000000000000000020711300365222700161760ustar00rootroot00000000000000The MIT License (MIT)
Copyright (c) 2016 Matteo Collina
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.
cloneable-readable-1.0.0/README.md000066400000000000000000000024311300365222700164500ustar00rootroot00000000000000# cloneable-readable
[](https://travis-ci.org/mcollina/cloneable-readable)
Clone a Readable stream, safely.
```js
'use strict'
var cloneable = require('cloneable-readable')
var fs = require('fs')
var pump = require('pump')
var stream = cloneable(fs.createReadStream('./package.json'))
pump(stream.clone(), fs.createWriteStream('./out1'))
// simulate some asynchronicity
setImmediate(function () {
pump(stream, fs.createWriteStream('./out2'))
})
```
**cloneable-readable** automatically handles `objectMode: true`.
This module comes out of an healthy discussion on the 'right' way to
clone a Readable in https://github.com/gulpjs/vinyl/issues/85
and https://github.com/nodejs/readable-stream/issues/202. This is my take.
**YOU MUST PIPE ALL CLONES TO START THE FLOW**
You can also attach `'data'` and `'readable'` events to them.
## API
### cloneable(stream)
Create a `Cloneable` stream.
A Cloneable has a `clone()` method to create more clones.
All clones must be resumed/piped to start the flow.
### cloneable.isCloneable(stream)
Check if `stream` needs to be wrapped in a `Cloneable` or not.
## Acknowledgements
This project was kindly sponsored by [nearForm](http://nearform.com).
## License
MIT
cloneable-readable-1.0.0/example.js000066400000000000000000000005011300365222700171560ustar00rootroot00000000000000'use strict'
var cloneable = require('./')
var fs = require('fs')
var pump = require('pump')
var stream = cloneable(fs.createReadStream('./package.json'))
pump(stream.clone(), fs.createWriteStream('./out1'))
// simulate some asynchronicity
setImmediate(function () {
pump(stream, fs.createWriteStream('./out2'))
})
cloneable-readable-1.0.0/index.js000066400000000000000000000044701300365222700166430ustar00rootroot00000000000000'use strict'
var through2 = require('through2')
var inherits = require('inherits')
var nextTick = require('process-nextick-args')
var Ctor = through2.ctor()
function Cloneable (stream, opts) {
if (!(this instanceof Cloneable)) {
return new Cloneable(stream, opts)
}
var objectMode = stream._readableState.objectMode
this._original = stream
this._clonesCount = 1
opts = opts || {}
opts.objectMode = objectMode
Ctor.call(this, opts)
forwardDestroy(stream, this)
this.on('newListener', onData)
}
inherits(Cloneable, Ctor)
function onData (event, listener) {
if (event === 'data' || event === 'readable') {
this.removeListener('newListener', onData)
nextTick(clonePiped, this)
}
}
Cloneable.prototype.clone = function () {
if (!this._original) {
throw new Error('already started')
}
this._clonesCount++
// the events added by the clone should not count
// for starting the flow
this.removeListener('newListener', onData)
var clone = new Clone(this)
this.on('newListener', onData)
return clone
}
function forwardDestroy (src, dest) {
src.on('error', destroy)
src.on('close', destroy)
function destroy (err) {
dest.destroy(err)
}
}
function clonePiped (that) {
if (--that._clonesCount === 0 && !that._destroyed) {
that._original.pipe(that)
that._original = undefined
}
}
function Clone (parent, opts) {
if (!(this instanceof Clone)) {
return new Clone(parent, opts)
}
var objectMode = parent._readableState.objectMode
opts = opts || {}
opts.objectMode = objectMode
this.parent = parent
Ctor.call(this, opts)
forwardDestroy(this.parent, this)
parent.pipe(this)
// the events added by the clone should not count
// for starting the flow
// so we add the newListener handle after we are done
this.on('newListener', onDataClone)
}
function onDataClone (event, listener) {
// We start the flow once all clones are piped or destroyed
if (event === 'data' || event === 'readable' || event === 'close') {
nextTick(clonePiped, this.parent)
this.removeListener('newListener', onDataClone)
}
}
inherits(Clone, Ctor)
Clone.prototype.clone = function () {
return this.parent.clone()
}
Cloneable.isCloneable = function (stream) {
return stream instanceof Cloneable || stream instanceof Clone
}
module.exports = Cloneable
cloneable-readable-1.0.0/package.json000066400000000000000000000017031300365222700174600ustar00rootroot00000000000000{
"name": "cloneable-readable",
"version": "1.0.0",
"description": "Clone a Readable stream, safely",
"main": "index.js",
"scripts": {
"test": "standard && tape test.js | tap-spec"
},
"precommit": "test",
"repository": {
"type": "git",
"url": "git+https://github.com/mcollina/cloneable-readable.git"
},
"keywords": [
"readable",
"stream",
"clone"
],
"author": "Matteo Collina ",
"license": "MIT",
"bugs": {
"url": "https://github.com/mcollina/cloneable-readable/issues"
},
"homepage": "https://github.com/mcollina/cloneable-readable#readme",
"devDependencies": {
"flush-write-stream": "^1.0.0",
"from2": "^2.1.1",
"pre-commit": "^1.1.2",
"readable-stream": "^2.1.0",
"standard": "^8.0.0",
"tap-spec": "^4.1.1",
"tape": "^4.6.0"
},
"dependencies": {
"inherits": "^2.0.1",
"process-nextick-args": "^1.0.6",
"through2": "^2.0.1"
}
}
cloneable-readable-1.0.0/test.js000066400000000000000000000271351300365222700165160ustar00rootroot00000000000000'use strict'
var test = require('tape').test
var from = require('from2')
var sink = require('flush-write-stream')
var cloneable = require('./')
test('basic passthrough', function (t) {
t.plan(2)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
})
test('clone sync', function (t) {
t.plan(4)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
var cloned = instance.clone()
t.notOk(read, 'stream not started')
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
cloned.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
})
test('clone async', function (t) {
t.plan(4)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
var cloned = instance.clone()
t.notOk(read, 'stream not started')
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
setImmediate(function () {
cloned.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
})
})
test('basic passthrough in obj mode', function (t) {
t.plan(2)
var read = false
var source = from.obj(function (size, next) {
if (read) {
return this.push(null)
} else {
read = true
this.push({ hello: 'world' })
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
instance.pipe(sink.obj(function (chunk, enc, cb) {
t.deepEqual(chunk, { hello: 'world' }, 'chunk matches')
cb()
}))
})
test('multiple clone in object mode', function (t) {
t.plan(4)
var read = false
var source = from.obj(function (size, next) {
if (read) {
return this.push(null)
} else {
read = true
this.push({ hello: 'world' })
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
var cloned = instance.clone()
t.notOk(read, 'stream not started')
instance.pipe(sink.obj(function (chunk, enc, cb) {
t.deepEqual(chunk, { hello: 'world' }, 'chunk matches')
cb()
}))
setImmediate(function () {
cloned.pipe(sink.obj(function (chunk, enc, cb) {
t.deepEqual(chunk, { hello: 'world' }, 'chunk matches')
cb()
}))
})
})
test('basic passthrough with data event', function (t) {
t.plan(2)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
var data = ''
instance.on('data', function (chunk) {
data += chunk.toString()
})
instance.on('end', function () {
t.equal(data, 'hello world', 'chunk matches')
})
})
test('basic passthrough with data event on clone', function (t) {
t.plan(3)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
var cloned = instance.clone()
t.notOk(read, 'stream not started')
var data = ''
cloned.on('data', function (chunk) {
data += chunk.toString()
})
cloned.on('end', function () {
t.equal(data, 'hello world', 'chunk matches in clone')
})
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches in instance')
cb()
}))
})
test('errors if cloned after start', function (t) {
t.plan(2)
var source = from(function (size, next) {
this.push('hello world')
this.push(null)
next()
})
var instance = cloneable(source)
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
t.throws(function () {
instance.clone()
}, 'throws if cloned after start')
cb()
}))
})
test('basic passthrough with readable event', function (t) {
t.plan(2)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
var data = ''
instance.on('readable', function () {
var chunk
while ((chunk = this.read()) !== null) {
data += chunk.toString()
}
})
instance.on('end', function () {
t.equal(data, 'hello world', 'chunk matches')
})
})
test('basic passthrough with readable event on clone', function (t) {
t.plan(3)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
var cloned = instance.clone()
t.notOk(read, 'stream not started')
var data = ''
cloned.on('readable', function () {
var chunk
while ((chunk = this.read()) !== null) {
data += chunk.toString()
}
})
cloned.on('end', function () {
t.equal(data, 'hello world', 'chunk matches in clone')
})
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches in instance')
cb()
}))
})
test('source error destroys all', function (t) {
t.plan(5)
var source = from()
var instance = cloneable(source)
var clone = instance.clone()
source.on('error', function (err) {
t.ok(err, 'source errors')
instance.on('error', function (err2) {
t.ok(err === err2, 'instance receives same error')
})
instance.on('close', function () {
t.pass('instance is closed')
})
clone.on('error', function (err3) {
t.ok(err === err3, 'clone receives same error')
})
clone.on('close', function () {
t.pass('clone is closed')
})
})
source.emit('error', new Error())
})
test('source destroy destroys all', function (t) {
t.plan(2)
var source = from()
var instance = cloneable(source)
var clone = instance.clone()
instance.on('close', function () {
t.pass('instance is closed')
})
clone.on('close', function () {
t.pass('clone is closed')
})
source.destroy()
})
test('instance error destroys all but the source', function (t) {
t.plan(4)
var source = from()
var instance = cloneable(source)
var clone = instance.clone()
source.on('close', function () {
t.fail('source should not be closed')
})
instance.on('error', function (err) {
t.is(err.message, 'beep', 'instance errors')
instance.on('close', function () {
t.pass('instance is closed')
})
clone.on('error', function (err3) {
t.ok(err === err3, 'clone receives same error')
})
clone.on('close', function () {
t.pass('clone is closed')
})
})
instance.destroy(new Error('beep'))
})
test('instance destroy destroys all but the source', function (t) {
t.plan(2)
var source = from()
var instance = cloneable(source)
var clone = instance.clone()
source.on('close', function () {
t.fail('source should not be closed')
})
instance.on('close', function () {
t.pass('instance is closed')
})
clone.on('close', function () {
t.pass('clone is closed')
})
instance.destroy()
})
test('clone destroy does not affect other clones, cloneable or source', function (t) {
t.plan(1)
var source = from()
var instance = cloneable(source)
var clone = instance.clone()
var other = instance.clone()
source.on('close', function () {
t.fail('source should not be closed')
})
instance.on('close', function () {
t.fail('instance should not be closed')
})
other.on('close', function () {
t.fail('other clone should not be closed')
})
clone.on('close', function () {
t.pass('clone is closed')
})
clone.destroy()
})
test('clone remains readable if other is destroyed', function (t) {
t.plan(3)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello')
}
next()
})
var instance = cloneable(source)
var clone = instance.clone()
var other = instance.clone()
instance.pipe(sink.obj(function (chunk, enc, cb) {
t.deepEqual(chunk.toString(), 'hello', 'instance chunk matches')
cb()
}))
clone.pipe(sink.obj(function (chunk, enc, cb) {
t.deepEqual(chunk.toString(), 'hello', 'clone chunk matches')
cb()
}))
clone.on('close', function () {
t.fail('clone should not be closed')
})
instance.on('close', function () {
t.fail('instance should not be closed')
})
other.on('close', function () {
t.pass('other is closed')
})
other.destroy()
})
test('clone of clone', function (t) {
t.plan(6)
var read = false
var source = from(function (size, next) {
if (read) {
this.push(null)
} else {
read = true
this.push('hello world')
}
next()
})
var instance = cloneable(source)
t.notOk(read, 'stream not started')
var cloned = instance.clone()
t.notOk(read, 'stream not started')
var replica = cloned.clone()
t.notOk(read, 'stream not started')
instance.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
cloned.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
replica.pipe(sink(function (chunk, enc, cb) {
t.equal(chunk.toString(), 'hello world', 'chunk matches')
cb()
}))
})
test('from vinyl', function (t) {
t.plan(3)
var source = from(['wa', 'dup'])
var instance = cloneable(source)
var clone = instance.clone()
var data = ''
var data2 = ''
var ends = 2
function latch () {
if (--ends === 0) {
t.equal(data, data2)
}
}
instance.on('data', function (chunk) {
data += chunk.toString()
})
process.nextTick(function () {
t.equal('', data, 'nothing was written yet')
t.equal('', data2, 'nothing was written yet')
clone.on('data', function (chunk) {
data2 += chunk.toString()
})
})
instance.on('end', latch)
clone.on('end', latch)
})
test('waits till all are flowing', function (t) {
t.plan(1)
var source = from(['wa', 'dup'])
var instance = cloneable(source)
// we create a clone
instance.clone()
instance.on('data', function (chunk) {
t.fail('this should never happen')
})
process.nextTick(function () {
t.pass('wait till nextTick')
})
})
test('isCloneable', function (t) {
t.plan(4)
var source = from(['hello', ' ', 'world'])
t.notOk(cloneable.isCloneable(source), 'a generic readable is not cloneable')
var instance = cloneable(source)
t.ok(cloneable.isCloneable(instance), 'a cloneable is cloneable')
var clone = instance.clone()
t.ok(cloneable.isCloneable(clone), 'a clone is cloneable')
var cloneClone = clone.clone()
t.ok(cloneable.isCloneable(cloneClone), 'a clone of a clone is cloneable')
})