bl 0.6.0 → 0.8.2

package/README.md

@@ -4,6 +4,9 @@
 
 **A Node.js Buffer list collector, reader and streamer thingy.**
 
+[![NPM](https://nodei.co/npm/bl.png?downloads=true)](https://nodei.co/npm/bl/)
+[![NPM](https://nodei.co/npm-dl/bl.png?months=6)](https://nodei.co/npm/bl/)
+
 **bl** is a storage object for collections of Node Buffers, exposing them with the main Buffer readable API. Also works as a duplex stream so you can collect buffers from a stream that emits them and emit buffers to a stream that consumes them!
 
 The original buffers are kept intact and copies are only done as necessary. Any reads that require the use of a single original buffer will return a slice of that buffer only (which references the same memory as the original buffer). Reads that span buffers perform concatenation as required and return the results transparently.
@@ -46,7 +49,7 @@ fs.createReadStream('README.md')
   .pipe(bl(function (err, data) { // note 'new' isn't strictly required
     // `data` is a complete Buffer object containing the full data
     console.log(data.toString())
-  })
+  }))
 ```
 
 Note that when you use the *callback* method like this, the resulting `data` parameter is a concatenation of all `Buffer` objects in the list. If you want to avoid the overhead of this concatenation (in cases of extreme performance consciousness), then avoid the *callback* method and just listen to `'end'` instead, like a standard Stream.

package/bl.js

@@ -1,5 +1,5 @@
-const DuplexStream = require('stream').DuplexStream || require('readable-stream/duplex')
-    , util         = require('util')
+var DuplexStream = require('readable-stream').Duplex
+  , util         = require('util')
 
 function BufferList (callback) {
   if (!(this instanceof BufferList))
@@ -177,6 +177,12 @@ BufferList.prototype.duplicate = function () {
   return copy
 }
 
+BufferList.prototype.destroy = function () {
+  this._bufs.length = 0;
+  this.length = 0;
+  this.push(null);
+}
+
 ;(function () {
   var methods = {
       'readDoubleBE' : 8
@@ -195,11 +201,13 @@ BufferList.prototype.duplicate = function () {
     , 'readUInt8'    : 1
   }
 
-  Object.keys(methods).forEach(function (m) {
-    BufferList.prototype[m] = function (offset) {
-      return this.slice(offset, offset + methods[m])[m](0)
-    }
-  })
+  for (var m in methods) {
+    (function (m) {
+      BufferList.prototype[m] = function (offset) {
+        return this.slice(offset, offset + methods[m])[m](0)
+      }
+    }(m))
+  }
 }())
 
 module.exports = BufferList

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "bl",
-  "version": "0.6.0",
+  "version": "0.8.2",
   "description": "Buffer List: collect buffers and access with a standard readable Buffer interface, streamable too!",
   "main": "bl.js",
   "scripts": {
-    "test": "tape test.js"
+    "test": "node test/test.js | faucet",
+    "test-local": "brtapsauce-local test/basic-test.js"
   },
   "repository": {
     "type": "git",
@@ -23,10 +24,12 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "readable-stream": "~1.0.2"
+    "readable-stream": "~1.0.26"
   },
   "devDependencies": {
-    "tape": "*",
-    "hash_file": "*"
+    "tape": "~2.12.3",
+    "hash_file": "~0.1.1",
+    "faucet": "~0.0.1",
+    "brtapsauce": "~0.3.0"
   }
 }

package/{test.js → test/basic-test.js}

@@ -1,8 +1,12 @@
-const tape       = require('tape')
-    , crypto     = require('crypto')
-    , fs         = require('fs')
-    , hash       = require('hash_file')
-    , BufferList = require('./')
+var tape       = require('tape')
+  , crypto     = require('crypto')
+  , fs         = require('fs')
+  , hash       = require('hash_file')
+  , BufferList = require('../')
+
+  , encodings  =
+      ('hex utf8 utf-8 ascii binary base64'
+          + (process.browser ? '' : ' ucs2 ucs-2 utf16le utf-16le')).split(' ')
 
 tape('single bytes from single buffer', function (t) {
   var bl = new BufferList()
@@ -254,17 +258,15 @@ tape('test toString encoding', function (t) {
   bl.append(new Buffer('j'))
   bl.append(new Buffer('\xff\x00'))
 
-  'hex utf8 utf-8 ascii binary base64 ucs2 ucs-2 utf16le utf-16le'
-    .split(' ')
-    .forEach(function (enc) {
-      t.equal(bl.toString(enc), b.toString(enc))
+  encodings.forEach(function (enc) {
+      t.equal(bl.toString(enc), b.toString(enc), enc)
     })
 
   t.end()
 })
 
-tape('test stream', function (t) {
-  var random = crypto.randomBytes(1024 * 1024)
+!process.browser && tape('test stream', function (t) {
+  var random = crypto.randomBytes(65534)
     , rndhash = hash(random, 'md5')
     , md5sum = crypto.createHash('md5')
     , bl     = new BufferList(function (err, buf) {
@@ -294,9 +296,9 @@ tape('instantiation with Buffer', function (t) {
     , buf2 = crypto.randomBytes(1024)
     , b    = BufferList(buf)
 
-  t.equal(hash(buf, 'md5'), hash(b.slice(), 'md5'), 'same hash!')
+  t.equal(buf.toString('hex'), b.slice().toString('hex'), 'same buffer')
   b = BufferList([ buf, buf2 ])
-  t.equal(hash(b.slice(), 'md5'), hash(Buffer.concat([ buf, buf2 ]), 'md5'), 'same hash!')
+  t.equal(b.slice().toString('hex'), Buffer.concat([ buf, buf2 ]).toString('hex'), 'same buffer')
   t.end()
 })
 
@@ -310,9 +312,7 @@ tape('test String appendage', function (t) {
   bl.append('j')
   bl.append('\xff\x00')
 
-  'hex utf8 utf-8 ascii binary base64 ucs2 ucs-2 utf16le utf-16le'
-    .split(' ')
-    .forEach(function (enc) {
+  encodings.forEach(function (enc) {
       t.equal(bl.toString(enc), b.toString(enc))
     })
 
@@ -345,7 +345,7 @@ tape('unicode string', function (t) {
 tape('should emit finish', function (t) {
   var source = BufferList()
     , dest = BufferList()
- 
+
   source.write('hello')
   source.pipe(dest)
 
@@ -361,7 +361,7 @@ tape('basic copy', function (t) {
     , b    = BufferList(buf)
 
   b.copy(buf2)
-  t.equal(hash(b.slice(), 'md5'), hash(buf2, 'md5'), 'same hash!')
+  t.equal(b.slice().toString('hex'), buf2.toString('hex'), 'same buffer')
   t.end()
 })
 
@@ -372,7 +372,7 @@ tape('copy after many appends', function (t) {
 
   b.append(buf)
   b.copy(buf2)
-  t.equal(hash(b.slice(), 'md5'), hash(buf2, 'md5'), 'same hash!')
+  t.equal(b.slice().toString('hex'), buf2.toString('hex'), 'same buffer')
   t.end()
 })
 
@@ -382,7 +382,7 @@ tape('copy at a precise position', function (t) {
     , b    = BufferList(buf)
 
   b.copy(buf2, 20)
-  t.equal(hash(b.slice(), 'md5'), hash(buf2.slice(20), 'md5'), 'same hash!')
+  t.equal(b.slice().toString('hex'), buf2.slice(20).toString('hex'), 'same buffer')
   t.end()
 })
 
@@ -392,22 +392,20 @@ tape('copy starting from a precise location', function (t) {
     , b    = BufferList(buf)
 
   b.copy(buf2, 0, 5)
-  t.equal(hash(b.slice(5), 'md5'), hash(buf2, 'md5'), 'same hash!')
+  t.equal(b.slice(5).toString('hex'), buf2.toString('hex'), 'same buffer')
   t.end()
 })
 
 tape('copy in an interval', function (t) {
-  var buf      = crypto.randomBytes(10)
-    , buf2     = new Buffer(3)
-    , b        = BufferList(buf)
+  var rnd      = crypto.randomBytes(10)
+    , b        = BufferList(rnd) // put the random bytes there
+    , actual   = new Buffer(3)
     , expected = new Buffer(3)
 
-  // put the same old data there
-  buf2.copy(expected)
-  buf.copy(expected, 0, 5, 7)
+  rnd.copy(expected, 0, 5, 8)
+  b.copy(actual, 0, 5, 8)
 
-  b.copy(buf2, 0, 5, 7)
-  t.equal(hash(expected, 'md5'), hash(buf2, 'md5'), 'same hash!')
+  t.equal(actual.toString('hex'), expected.toString('hex'), 'same buffer')
   t.end()
 })
 
@@ -419,7 +417,7 @@ tape('copy an interval between two buffers', function (t) {
   b.append(buf)
   b.copy(buf2, 0, 5, 15)
 
-  t.equal(hash(b.slice(5, 15), 'md5'), hash(buf2, 'md5'), 'same hash!')
+  t.equal(b.slice(5, 15).toString('hex'), buf2.toString('hex'), 'same buffer')
   t.end()
 })
 
@@ -433,10 +431,94 @@ tape('duplicate', function (t) {
   t.equal(bl.toString('hex'), dup.toString('hex'))
 })
 
-tape('handle error', function (t) {
+tape('destroy no pipe', function (t) {
+  t.plan(2)
+
+  var bl = new BufferList('alsdkfja;lsdkfja;lsdk')
+  bl.destroy()
+
+  t.equal(bl._bufs.length, 0)
+  t.equal(bl.length, 0)
+})
+
+!process.browser && tape('destroy with pipe before read end', function (t) {
+  t.plan(2)
+
+  var bl = new BufferList()
+  fs.createReadStream(__dirname + '/sauce.js')
+    .pipe(bl)
+
+  bl.destroy()
+
+  t.equal(bl._bufs.length, 0)
+  t.equal(bl.length, 0)
+
+})
+
+!process.browser && tape('destroy with pipe before read end with race', function (t) {
+  t.plan(2)
+
+  var bl = new BufferList()
+  fs.createReadStream(__dirname + '/sauce.js')
+    .pipe(bl)
+
+  setTimeout(function () {
+    bl.destroy()
+    setTimeout(function () {
+      t.equal(bl._bufs.length, 0)
+      t.equal(bl.length, 0)
+    }, 500)
+  }, 500)
+})
+
+!process.browser && tape('destroy with pipe after read end', function (t) {
+  t.plan(2)
+
+  var bl = new BufferList()
+  fs.createReadStream(__dirname + '/sauce.js')
+    .on('end', onEnd)
+    .pipe(bl)
+
+  function onEnd () {
+    bl.destroy()
+
+    t.equal(bl._bufs.length, 0)
+    t.equal(bl.length, 0)
+  }
+})
+
+!process.browser && tape('destroy with pipe while writing to a destination', function (t) {
+  t.plan(4)
+
+  var bl = new BufferList()
+    , ds = new BufferList()
+
+  fs.createReadStream(__dirname + '/sauce.js')
+    .on('end', onEnd)
+    .pipe(bl)
+
+  function onEnd () {
+    bl.pipe(ds)
+
+    setTimeout(function () {
+      bl.destroy()
+
+      t.equals(bl._bufs.length, 0)
+      t.equals(bl.length, 0)
+
+      ds.destroy()
+
+      t.equals(bl._bufs.length, 0)
+      t.equals(bl.length, 0)
+
+    }, 100)
+  }
+})
+
+!process.browser && tape('handle error', function (t) {
   t.plan(2)
   fs.createReadStream('/does/not/exist').pipe(BufferList(function (err, data) {
     t.ok(err instanceof Error, 'has error')
     t.notOk(data, 'no data')
   }))
-})
+})

package/test/sauce.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+const user       = process.env.SAUCE_USER
+    , key        = process.env.SAUCE_KEY
+    , path       = require('path')
+    , brtapsauce = require('brtapsauce')
+    , testFile   = path.join(__dirname, 'basic-test.js')
+
+    , capabilities = [
+          { browserName: 'chrome'            , platform: 'Windows XP', version: ''   }
+        , { browserName: 'firefox'           , platform: 'Windows 8' , version: ''   }
+        , { browserName: 'firefox'           , platform: 'Windows XP', version: '4'  }
+        , { browserName: 'internet explorer' , platform: 'Windows 8' , version: '10' }
+        , { browserName: 'internet explorer' , platform: 'Windows 7' , version: '9'  }
+        , { browserName: 'internet explorer' , platform: 'Windows 7' , version: '8'  }
+        , { browserName: 'internet explorer' , platform: 'Windows XP', version: '7'  }
+        , { browserName: 'internet explorer' , platform: 'Windows XP', version: '6'  }
+        , { browserName: 'safari'            , platform: 'Windows 7' , version: '5'  }
+        , { browserName: 'safari'            , platform: 'OS X 10.8' , version: '6'  }
+        , { browserName: 'opera'             , platform: 'Windows 7' , version: ''   }
+        , { browserName: 'opera'             , platform: 'Windows 7' , version: '11' }
+        , { browserName: 'ipad'              , platform: 'OS X 10.8' , version: '6'  }
+        , { browserName: 'android'           , platform: 'Linux'     , version: '4.0', 'device-type': 'tablet' }
+      ]
+
+if (!user)
+  throw new Error('Must set a SAUCE_USER env var')
+if (!key)
+  throw new Error('Must set a SAUCE_KEY env var')
+
+brtapsauce({
+    name         : 'Traversty'
+  , user         : user
+  , key          : key
+  , brsrc        : testFile
+  , capabilities : capabilities
+  , options      : { timeout: 60 * 6 }
+})

package/test/test.js

@@ -0,0 +1,9 @@
+require('./basic-test')
+
+if (!process.env.SAUCE_KEY || !process.env.SAUCE_USER)
+  return console.log('SAUCE_KEY and/or SAUCE_USER not set, not running sauce tests')
+
+if (!/v0\.10/.test(process.version))
+  return console.log('Not Node v0.10.x, not running sauce tests')
+
+require('./sauce.js')