bl 0.4.1 → 0.7.0

package/.travis.yml

@@ -8,4 +8,8 @@ branches:
 notifications:
   email:
     - rod@vagg.org
-script: npm test
+script: npm test
+env:
+  global:
+  - SAUCE_USER=bl-sauce
+  - secure: "EN/BSk+c4E8pgtW/hTSk5dp3iBng6PPtWHc2kxeMyUjMCYTjD4/zgZXm/gPTcuBxWByDlFrHlJ9A6L+aj5r9n/48tBJJLJ6B2WezZMAnzo4HHzl445BmSI6MbqmUbrN3nQ+lmRXIUzatW+pyoP+DWgCcLJpXtdKN7LwgIxIQS2g="

package/README.md

@@ -84,6 +84,8 @@ bl.pipe(fs.createWriteStream('gibberish.txt'))
   * <a href="#append"><code>bl.<b>append(buffer)</b></code></a>
   * <a href="#get"><code>bl.<b>get(index)</b></code></a>
   * <a href="#slice"><code>bl.<b>slice([ start[, end ] ])</b></code></a>
+  * <a href="#copy"><code>bl.<b>copy(dest, [ destStart, [ srcStart [, srcEnd ] ] ])</b></code></a>
+  * <a href="#duplicate"><code>bl.<b>duplicate()</b></code></a>
   * <a href="#consume"><code>bl.<b>consume(bytes)</b></code></a>
   * <a href="#toString"><code>bl.<b>toString([encoding, [ start, [ end ]]])</b></code></a>
   * <a href="#readXX"><code>bl.<b>readDoubleBE()</b></code>, <code>bl.<b>readDoubleLE()</b></code>, <code>bl.<b>readFloatBE()</b></code>, <code>bl.<b>readFloatLE()</b></code>, <code>bl.<b>readInt32BE()</b></code>, <code>bl.<b>readInt32LE()</b></code>, <code>bl.<b>readUInt32BE()</b></code>, <code>bl.<b>readUInt32LE()</b></code>, <code>bl.<b>readInt16BE()</b></code>, <code>bl.<b>readInt16LE()</b></code>, <code>bl.<b>readUInt16BE()</b></code>, <code>bl.<b>readUInt16LE()</b></code>, <code>bl.<b>readInt8()</b></code>, <code>bl.<b>readUInt8()</b></code></a>
@@ -130,6 +132,28 @@ Get the length of the list in bytes. This is the sum of the lengths of all of th
 
 If the requested range spans a single internal buffer then a slice of that buffer will be returned which shares the original memory range of that Buffer. If the range spans multiple buffers then copy operations will likely occur to give you a uniform Buffer.
 
+--------------------------------------------------------
+<a name="copy"></a>
+### bl.copy(dest, [ destStart, [ srcStart [, srcEnd ] ] ])
+`copy()` copies the content of the list in the `dest` buffer, starting from `destStart` and containing the bytes within the range specified with `srcStart` to `srcEnd`. `destStart`, `start` and `end` are optional and will default to the beginning of the `dest` buffer, and the beginning and end of the list respectively.
+
+--------------------------------------------------------
+<a name="duplicate"></a>
+### bl.duplicate()
+`duplicate()` performs a **shallow-copy** of the list. The internal Buffers remains the same, so if you change the underlying Buffers, the change will be reflected in both the original and the duplicate. This method is needed if you want to call `consume()` or `pipe()` and still keep the original list.Example:
+
+```js
+var bl = new BufferList()
+
+bl.append('hello')
+bl.append(' world')
+bl.append('\n')
+
+bl.duplicate().pipe(process.stdout, { end: false })
+
+console.log(bl.toString())
+```
+
 --------------------------------------------------------
 <a name="consume"></a>
 ### bl.consume(bytes)
@@ -153,6 +177,17 @@ See the <b><code>[Buffer](http://nodejs.org/docs/latest/api/buffer.html)</code><
 ### Streams
 **bl** is a Node **[Duplex Stream](http://nodejs.org/docs/latest/api/stream.html#stream_class_stream_duplex)**, so it can be read from and written to like a standard Node stream. You can also `pipe()` to and from a **bl** instance.
 
+--------------------------------------------------------
+
+## Contributors
+
+**bl** is brought to you by the following hackers:
+
+ * [Rod Vagg](https://github.com/rvagg)
+ * [Matteo Collina](https://github.com/mcollina)
+
+=======
+
 ## License
 
-**bl** is Copyright (c) 2013 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.
+**bl** is Copyright (c) 2013 Rod Vagg [@rvagg](https://twitter.com/rvagg) and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

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))
@@ -8,8 +8,23 @@ function BufferList (callback) {
   this._bufs  = []
   this.length = 0
 
-  if (typeof callback == 'function')
+  if (typeof callback == 'function') {
     this._callback = callback
+
+    var piper = function (err) {
+      if (this._callback) {
+        this._callback(err)
+        this._callback = null
+      }
+    }.bind(this)
+
+    this.on('pipe', function (src) {
+      src.on('error', piper)
+    })
+    this.on('unpipe', function (src) {
+      src.removeListener('error', piper)
+    })
+  }
   else if (Buffer.isBuffer(callback))
     this.append(callback)
   else if (Array.isArray(callback)) {
@@ -53,9 +68,13 @@ BufferList.prototype._read = function (size) {
   this.consume(size)
 }
 
-BufferList.prototype.end = function () {
-  if (this._callback)
+BufferList.prototype.end = function (chunk) {
+  DuplexStream.prototype.end.call(this, chunk)
+
+  if (this._callback) {
     this._callback(null, this.slice())
+    this._callback = null
+  }
 }
 
 BufferList.prototype.get = function (index) {
@@ -63,38 +82,59 @@ BufferList.prototype.get = function (index) {
 }
 
 BufferList.prototype.slice = function (start, end) {
-  if (typeof start != 'number' || start < 0)
-    start = 0
-  if (typeof end != 'number' || end > this.length)
-    end = this.length
-  if (start >= this.length)
-    return new Buffer(0)
-  if (end <= 0)
-    return new Buffer(0)
-
-  if (start === 0 && end == this.length)
-    return Buffer.concat(this._bufs)
-
-  var off    = this._offset(start)
-    , len    = end - start
+  return this.copy(null, 0, start, end)
+}
+
+BufferList.prototype.copy = function (dst, dstStart, srcStart, srcEnd) {
+  if (typeof srcStart != 'number' || srcStart < 0)
+    srcStart = 0
+  if (typeof srcEnd != 'number' || srcEnd > this.length)
+    srcEnd = this.length
+  if (srcStart >= this.length)
+    return dst || new Buffer(0)
+  if (srcEnd <= 0)
+    return dst || new Buffer(0)
+
+  var copy   = !!dst
+    , off    = this._offset(srcStart)
+    , len    = srcEnd - srcStart
     , bytes  = len
-    , bufoff = 0
-    , buf, l, i
+    , bufoff = (copy && dstStart) || 0
+    , start  = off[1]
+    , l
+    , i
+
+  // copy/slice everything
+  if (srcStart === 0 && srcEnd == this.length) {
+    if (!copy) // slice, just return a full concat
+      return Buffer.concat(this._bufs)
+
+    // copy, need to copy individual buffers
+    for (i = 0; i < this._bufs.length; i++) {
+      this._bufs[i].copy(dst, bufoff)
+      bufoff += this._bufs[i].length
+    }
 
-  start = off[1]
+    return dst
+  }
 
   // easy, cheap case where it's a subset of one of the buffers
-  if (bytes <= this._bufs[off[0]].length - start)
-    return this._bufs[off[0]].slice(start, start + bytes)
+  if (bytes <= this._bufs[off[0]].length - start) {
+    return copy
+      ? this._bufs[off[0]].copy(dst, dstStart, start, start + bytes)
+      : this._bufs[off[0]].slice(start, start + bytes)
+  }
 
-  buf = new Buffer(len)
+  if (!copy) // a slice, we need something to copy in to
+    dst = new Buffer(len)
 
   for (i = off[0]; i < this._bufs.length; i++) {
     l = this._bufs[i].length - start
+
     if (bytes > l) {
-      this._bufs[i].copy(buf, bufoff, start)
+      this._bufs[i].copy(dst, bufoff, start)
     } else {
-      this._bufs[i].copy(buf, bufoff, start, start + bytes)
+      this._bufs[i].copy(dst, bufoff, start, start + bytes)
       break
     }
 
@@ -105,7 +145,7 @@ BufferList.prototype.slice = function (start, end) {
       start = 0
   }
 
-  return buf
+  return dst
 }
 
 BufferList.prototype.toString = function (encoding, start, end) {
@@ -127,6 +167,16 @@ BufferList.prototype.consume = function (bytes) {
   return this
 }
 
+BufferList.prototype.duplicate = function () {
+  var i = 0
+    , copy = new BufferList()
+
+  for (; i < this._bufs.length; i++)
+    copy.append(this._bufs[i])
+
+  return copy
+}
+
 ;(function () {
   var methods = {
       'readDoubleBE' : 8
@@ -145,11 +195,13 @@ BufferList.prototype.consume = function (bytes) {
     , '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
+module.exports = BufferList

package/package.json

@@ -1,31 +1,42 @@
 {
-    "name"            : "bl"
-  , "version"         : "0.4.1"
-  , "description"     : "Buffer List: collect buffers and access with a standard readable Buffer interface, streamable too!"
-  , "main"            : "bl.js"
-  , "scripts"         : {
-        "test": "tape test.js"
-    }
-  , "repository"      : {
-        "type"            : "git"
-      , "url"             : "https://github.com/rvagg/bl.git"
-    }
-  , "homepage"        : "https://github.com/rvagg/bl"
-  , "authors"         : [
-        "Rod Vagg <rod@vagg.org> (https://github.com/rvagg)"
-    ]
-  , "keywords"        : [
-        "buffer"
-      , "buffers"
-      , "stream"
-      , "awesomesauce"
-    ]
-  , "license"         : "MIT"
-  , "dependencies"    : {
-        "readable-stream" : "~1.0.2"
-    }
-  , "devDependencies" : {
-        "tape"            : "*"
-      , "hash_file"       : "*"
-    }
-}
+  "name": "bl",
+  "version": "0.7.0",
+  "description": "Buffer List: collect buffers and access with a standard readable Buffer interface, streamable too!",
+  "main": "bl.js",
+  "scripts": {
+    "test": "node test/test.js | faucet",
+    "test-local": "brtapsauce-local test/basic-test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rvagg/bl.git"
+  },
+  "homepage": "https://github.com/rvagg/bl",
+  "authors": [
+    "Rod Vagg <rod@vagg.org> (https://github.com/rvagg)",
+    "Matteo Collina <matteo.collina@gmail.com> (https://github.com/mcollina)"
+  ],
+  "keywords": [
+    "buffer",
+    "buffers",
+    "stream",
+    "awesomesauce"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "readable-stream": "~1.0.2"
+  },
+  "peerDependencies": {
+    "stream-browserify": "*"
+  },
+  "devDependencies": {
+    "tape": "~2.3.2",
+    "hash_file": "~0.1.1",
+    "brtapsauce": "~0.3.0",
+    "faucet": "0.0.0",
+    "stream-browserify": "~0.1.2"
+  },
+  "browser": {
+    "readable-stream": "stream-browserify"
+  }
+}

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,11 +312,131 @@ 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))
     })
 
   t.end()
 })
+
+tape('write nothing, should get empty buffer', function (t) {
+  t.plan(3)
+  BufferList(function (err, data) {
+    t.notOk(err, 'no error')
+    t.ok(Buffer.isBuffer(data), 'got a buffer')
+    t.equal(0, data.length, 'got a zero-length buffer')
+    t.end()
+  }).end()
+})
+
+tape('unicode string', function (t) {
+  t.plan(2)
+  var inp1 = '\u2600'
+    , inp2 = '\u2603'
+    , exp = inp1 + ' and ' + inp2
+    , bl = BufferList()
+  bl.write(inp1)
+  bl.write(' and ')
+  bl.write(inp2)
+  t.equal(exp, bl.toString())
+  t.equal(new Buffer(exp).toString('hex'), bl.toString('hex'))
+})
+
+tape('should emit finish', function (t) {
+  var source = BufferList()
+    , dest = BufferList()
+ 
+  source.write('hello')
+  source.pipe(dest)
+
+  dest.on('finish', function () {
+    t.equal(dest.toString('utf8'), 'hello')
+    t.end()
+  })
+})
+
+tape('basic copy', function (t) {
+  var buf  = crypto.randomBytes(1024)
+    , buf2 = new Buffer(1024)
+    , b    = BufferList(buf)
+
+  b.copy(buf2)
+  t.equal(b.slice().toString('hex'), buf2.toString('hex'), 'same buffer')
+  t.end()
+})
+
+tape('copy after many appends', function (t) {
+  var buf  = crypto.randomBytes(512)
+    , buf2 = new Buffer(1024)
+    , b    = BufferList(buf)
+
+  b.append(buf)
+  b.copy(buf2)
+  t.equal(b.slice().toString('hex'), buf2.toString('hex'), 'same buffer')
+  t.end()
+})
+
+tape('copy at a precise position', function (t) {
+  var buf  = crypto.randomBytes(1004)
+    , buf2 = new Buffer(1024)
+    , b    = BufferList(buf)
+
+  b.copy(buf2, 20)
+  t.equal(b.slice().toString('hex'), buf2.slice(20).toString('hex'), 'same buffer')
+  t.end()
+})
+
+tape('copy starting from a precise location', function (t) {
+  var buf  = crypto.randomBytes(10)
+    , buf2 = new Buffer(5)
+    , b    = BufferList(buf)
+
+  b.copy(buf2, 0, 5)
+  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)
+    , expected = new Buffer(3)
+
+  // put the same old data there
+  buf2.copy(expected)
+  buf.copy(expected, 0, 5, 7)
+
+  b.copy(buf2, 0, 5, 7)
+  t.equal(expected.slice().toString('hex'), buf2.toString('hex'), 'same buffer')
+  t.end()
+})
+
+tape('copy an interval between two buffers', function (t) {
+  var buf      = crypto.randomBytes(10)
+    , buf2     = new Buffer(10)
+    , b        = BufferList(buf)
+
+  b.append(buf)
+  b.copy(buf2, 0, 5, 15)
+
+  t.equal(b.slice(5, 15).toString('hex'), buf2.toString('hex'), 'same buffer')
+  t.end()
+})
+
+tape('duplicate', function (t) {
+  t.plan(2)
+
+  var bl = new BufferList('abcdefghij\xff\x00')
+    , dup = bl.duplicate()
+
+  t.equal(bl.prototype, dup.prototype)
+  t.equal(bl.toString('hex'), dup.toString('hex'))
+})
+
+!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')