postdoc 0.2.0.beta4 → 0.2.0

data/node_modules/fd-slicer/README.md

@@ -1,189 +0,0 @@
-# fd-slicer
-
-[![Build Status](https://travis-ci.org/andrewrk/node-fd-slicer.svg?branch=master)](https://travis-ci.org/andrewrk/node-fd-slicer)
-[![Coverage Status](https://img.shields.io/coveralls/andrewrk/node-fd-slicer.svg)](https://coveralls.io/r/andrewrk/node-fd-slicer)
-
-Safe `fs.ReadStream` and `fs.WriteStream` using the same fd.
-
-Let's say that you want to perform a parallel upload of a file to a remote
-server. To do this, we want to create multiple read streams. The first thing
-you might think of is to use the `{start: 0, end: 0}` API of
-`fs.createReadStream`. This gives you two choices:
-
- 0. Use the same file descriptor for all `fs.ReadStream` objects.
- 0. Open the file multiple times, resulting in a separate file descriptor
-    for each read stream.
-
-Neither of these are acceptable options. The first one is a severe bug,
-because the API docs for `fs.write` state:
-
-> Note that it is unsafe to use `fs.write` multiple times on the same file
-> without waiting for the callback. For this scenario, `fs.createWriteStream`
-> is strongly recommended.
-
-`fs.createWriteStream` will solve the problem if you only create one of them
-for the file descriptor, but it will exhibit this unsafety if you create
-multiple write streams per file descriptor.
-
-The second option suffers from a race condition. For each additional time the
-file is opened after the first, it is possible that the file is modified. So
-in our parallel uploading example, we might upload a corrupt file that never
-existed on the client's computer.
-
-This module solves this problem by providing `createReadStream` and
-`createWriteStream` that operate on a shared file descriptor and provides
-the convenient stream API while still allowing slicing and dicing.
-
-This module also gives you some additional power that the builtin
-`fs.createWriteStream` do not give you. These features are:
-
- * Emitting a 'progress' event on write.
- * Ability to set a maximum size and emit an error if this size is exceeded.
- * Ability to create an `FdSlicer` instance from a `Buffer`. This enables you
-   to provide API for handling files as well as buffers using the same API.
-
-## Usage
-
-```js
-var fdSlicer = require('fd-slicer');
-var fs = require('fs');
-
-fs.open("file.txt", 'r', function(err, fd) {
-  if (err) throw err;
-  var slicer = fdSlicer.createFromFd(fd);
-  var firstPart = slicer.createReadStream({start: 0, end: 100});
-  var secondPart = slicer.createReadStream({start: 100});
-  var firstOut = fs.createWriteStream("first.txt");
-  var secondOut = fs.createWriteStream("second.txt");
-  firstPart.pipe(firstOut);
-  secondPart.pipe(secondOut);
-});
-```
-
-You can also create from a buffer:
-
-```js
-var fdSlicer = require('fd-slicer');
-var slicer = FdSlicer.createFromBuffer(someBuffer);
-var firstPart = slicer.createReadStream({start: 0, end: 100});
-var secondPart = slicer.createReadStream({start: 100});
-var firstOut = fs.createWriteStream("first.txt");
-var secondOut = fs.createWriteStream("second.txt");
-firstPart.pipe(firstOut);
-secondPart.pipe(secondOut);
-```
-
-## API Documentation
-
-### fdSlicer.createFromFd(fd, [options])
-
-```js
-var fdSlicer = require('fd-slicer');
-fs.open("file.txt", 'r', function(err, fd) {
-  if (err) throw err;
-  var slicer = fdSlicer.createFromFd(fd);
-  // ...
-});
-```
-
-Make sure `fd` is a properly initialized file descriptor. If you want to
-use `createReadStream` make sure you open it for reading and if you want
-to use `createWriteStream` make sure you open it for writing.
-
-`options` is an optional object which can contain:
-
- * `autoClose` - if set to `true`, the file descriptor will be automatically
-   closed once the last stream that references it is closed. Defaults to
-   `false`. `ref()` and `unref()` can be used to increase or decrease the
-   reference count, respectively.
-
-### fdSlicer.createFromBuffer(buffer)
-
-```js
-var fdSlicer = require('fd-slicer');
-var slicer = fdSlicer.createFromBuffer(someBuffer);
-// ...
-```
-
-#### Properties
-
-##### fd
-
-The file descriptor passed in. `undefined` if created from a buffer.
-
-#### Methods
-
-##### createReadStream(options)
-
-Available `options`:
-
- * `start` - Number. The offset into the file to start reading from. Defaults
-   to 0.
- * `end` - Number. Exclusive upper bound offset into the file to stop reading
-   from.
- * `highWaterMark` - Number. The maximum number of bytes to store in the
-   internal buffer before ceasing to read from the underlying resource.
-   Defaults to 16 KB.
- * `encoding` - String. If specified, then buffers will be decoded to strings
-   using the specified encoding. Defaults to `null`.
-
-The ReadableStream that this returns has these additional methods:
-
- * `destroy(err)` - stop streaming. `err` is optional and is the error that
-   will be emitted in order to cause the streaming to stop. Defaults to
-   `new Error("stream destroyed")`.
-
-##### createWriteStream(options)
-
-Available `options`:
-
- * `start` - Number. The offset into the file to start writing to. Defaults to
-   0.
- * `end` - Number. Exclusive upper bound offset into the file. If this offset
-   is reached, the write stream will emit an 'error' event and stop functioning.
-   In this situation, `err.code === 'ETOOBIG'`. Defaults to `Infinity`.
- * `highWaterMark` - Number. Buffer level when `write()` starts returning
-   false. Defaults to 16KB.
- * `decodeStrings` - Boolean. Whether or not to decode strings into Buffers
-   before passing them to` _write()`. Defaults to `true`.
-
-The WritableStream that this returns has these additional methods:
-
- * `destroy()` - stop streaming
-
-And these additional properties:
-
- * `bytesWritten` - number of bytes written to the stream
-
-And these additional events:
-
- * 'progress' - emitted when `bytesWritten` changes.
-
-##### read(buffer, offset, length, position, callback)
-
-Equivalent to `fs.read`, but with concurrency protection.
-`callback` must be defined.
-
-##### write(buffer, offset, length, position, callback)
-
-Equivalent to `fs.write`, but with concurrency protection.
-`callback` must be defined.
-
-##### ref()
-
-Increase the `autoClose` reference count by 1.
-
-##### unref()
-
-Decrease the `autoClose` reference count by 1.
-
-#### Events
-
-##### 'error'
-
-Emitted if `fs.close` returns an error when auto closing.
-
-##### 'close'
-
-Emitted when fd-slicer closes the file descriptor due to `autoClose`. Never
-emitted if created from a buffer.

data/node_modules/fd-slicer/index.js

@@ -1,277 +0,0 @@
-var fs = require('fs');
-var util = require('util');
-var stream = require('stream');
-var Readable = stream.Readable;
-var Writable = stream.Writable;
-var PassThrough = stream.PassThrough;
-var Pend = require('pend');
-var EventEmitter = require('events').EventEmitter;
-
-exports.createFromBuffer = createFromBuffer;
-exports.createFromFd = createFromFd;
-exports.BufferSlicer = BufferSlicer;
-exports.FdSlicer = FdSlicer;
-
-util.inherits(FdSlicer, EventEmitter);
-function FdSlicer(fd, options) {
-  options = options || {};
-  EventEmitter.call(this);
-
-  this.fd = fd;
-  this.pend = new Pend();
-  this.pend.max = 1;
-  this.refCount = 0;
-  this.autoClose = !!options.autoClose;
-}
-
-FdSlicer.prototype.read = function(buffer, offset, length, position, callback) {
-  var self = this;
-  self.pend.go(function(cb) {
-    fs.read(self.fd, buffer, offset, length, position, function(err, bytesRead, buffer) {
-      cb();
-      callback(err, bytesRead, buffer);
-    });
-  });
-};
-
-FdSlicer.prototype.write = function(buffer, offset, length, position, callback) {
-  var self = this;
-  self.pend.go(function(cb) {
-    fs.write(self.fd, buffer, offset, length, position, function(err, written, buffer) {
-      cb();
-      callback(err, written, buffer);
-    });
-  });
-};
-
-FdSlicer.prototype.createReadStream = function(options) {
-  return new ReadStream(this, options);
-};
-
-FdSlicer.prototype.createWriteStream = function(options) {
-  return new WriteStream(this, options);
-};
-
-FdSlicer.prototype.ref = function() {
-  this.refCount += 1;
-};
-
-FdSlicer.prototype.unref = function() {
-  var self = this;
-  self.refCount -= 1;
-
-  if (self.refCount > 0) return;
-  if (self.refCount < 0) throw new Error("invalid unref");
-
-  if (self.autoClose) {
-    fs.close(self.fd, onCloseDone);
-  }
-
-  function onCloseDone(err) {
-    if (err) {
-      self.emit('error', err);
-    } else {
-      self.emit('close');
-    }
-  }
-};
-
-util.inherits(ReadStream, Readable);
-function ReadStream(context, options) {
-  options = options || {};
-  Readable.call(this, options);
-
-  this.context = context;
-  this.context.ref();
-
-  this.start = options.start || 0;
-  this.endOffset = options.end;
-  this.pos = this.start;
-  this.destroyed = false;
-}
-
-ReadStream.prototype._read = function(n) {
-  var self = this;
-  if (self.destroyed) return;
-
-  var toRead = Math.min(self._readableState.highWaterMark, n);
-  if (self.endOffset != null) {
-    toRead = Math.min(toRead, self.endOffset - self.pos);
-  }
-  if (toRead <= 0) {
-    self.destroyed = true;
-    self.push(null);
-    self.context.unref();
-    return;
-  }
-  self.context.pend.go(function(cb) {
-    if (self.destroyed) return cb();
-    var buffer = new Buffer(toRead);
-    fs.read(self.context.fd, buffer, 0, toRead, self.pos, function(err, bytesRead) {
-      if (err) {
-        self.destroy(err);
-      } else if (bytesRead === 0) {
-        self.destroyed = true;
-        self.push(null);
-        self.context.unref();
-      } else {
-        self.pos += bytesRead;
-        self.push(buffer.slice(0, bytesRead));
-      }
-      cb();
-    });
-  });
-};
-
-ReadStream.prototype.destroy = function(err) {
-  if (this.destroyed) return;
-  err = err || new Error("stream destroyed");
-  this.destroyed = true;
-  this.emit('error', err);
-  this.context.unref();
-};
-
-util.inherits(WriteStream, Writable);
-function WriteStream(context, options) {
-  options = options || {};
-  Writable.call(this, options);
-
-  this.context = context;
-  this.context.ref();
-
-  this.start = options.start || 0;
-  this.endOffset = (options.end == null) ? Infinity : +options.end;
-  this.bytesWritten = 0;
-  this.pos = this.start;
-  this.destroyed = false;
-
-  this.on('finish', this.destroy.bind(this));
-}
-
-WriteStream.prototype._write = function(buffer, encoding, callback) {
-  var self = this;
-  if (self.destroyed) return;
-
-  if (self.pos + buffer.length > self.endOffset) {
-    var err = new Error("maximum file length exceeded");
-    err.code = 'ETOOBIG';
-    self.destroy();
-    callback(err);
-    return;
-  }
-  self.context.pend.go(function(cb) {
-    if (self.destroyed) return cb();
-    fs.write(self.context.fd, buffer, 0, buffer.length, self.pos, function(err, bytes) {
-      if (err) {
-        self.destroy();
-        cb();
-        callback(err);
-      } else {
-        self.bytesWritten += bytes;
-        self.pos += bytes;
-        self.emit('progress');
-        cb();
-        callback();
-      }
-    });
-  });
-};
-
-WriteStream.prototype.destroy = function() {
-  if (this.destroyed) return;
-  this.destroyed = true;
-  this.context.unref();
-};
-
-util.inherits(BufferSlicer, EventEmitter);
-function BufferSlicer(buffer) {
-  EventEmitter.call(this);
-
-  this.refCount = 0;
-  this.buffer = buffer;
-}
-
-BufferSlicer.prototype.read = function(buffer, offset, length, position, callback) {
-  var end = position + length;
-  var delta = end - this.buffer.length;
-  var written = (delta > 0) ? delta : length;
-  this.buffer.copy(buffer, offset, position, end);
-  setImmediate(function() {
-    callback(null, written);
-  });
-};
-
-BufferSlicer.prototype.write = function(buffer, offset, length, position, callback) {
-  buffer.copy(this.buffer, position, offset, offset + length);
-  setImmediate(function() {
-    callback(null, length, buffer);
-  });
-};
-
-BufferSlicer.prototype.createReadStream = function(options) {
-  options = options || {};
-  var readStream = new PassThrough(options);
-  readStream.start = options.start || 0;
-  readStream.endOffset = options.end;
-  readStream.pos = readStream.endOffset || this.buffer.length; // yep, we're already done
-  readStream.destroyed = false;
-  readStream.write(this.buffer.slice(readStream.start, readStream.pos));
-  readStream.end();
-  readStream.destroy = function() {
-    readStream.destroyed = true;
-  };
-  return readStream;
-};
-
-BufferSlicer.prototype.createWriteStream = function(options) {
-  var bufferSlicer = this;
-  options = options || {};
-  var writeStream = new Writable(options);
-  writeStream.start = options.start || 0;
-  writeStream.endOffset = (options.end == null) ? this.buffer.length : +options.end;
-  writeStream.bytesWritten = 0;
-  writeStream.pos = writeStream.start;
-  writeStream.destroyed = false;
-  writeStream._write = function(buffer, encoding, callback) {
-    if (writeStream.destroyed) return;
-
-    var end = writeStream.pos + buffer.length;
-    if (end > writeStream.endOffset) {
-      var err = new Error("maximum file length exceeded");
-      err.code = 'ETOOBIG';
-      writeStream.destroyed = true;
-      callback(err);
-      return;
-    }
-    buffer.copy(bufferSlicer.buffer, writeStream.pos, 0, buffer.length);
-
-    writeStream.bytesWritten += buffer.length;
-    writeStream.pos = end;
-    writeStream.emit('progress');
-    callback();
-  };
-  writeStream.destroy = function() {
-    writeStream.destroyed = true;
-  };
-  return writeStream;
-};
-
-BufferSlicer.prototype.ref = function() {
-  this.refCount += 1;
-};
-
-BufferSlicer.prototype.unref = function() {
-  this.refCount -= 1;
-
-  if (this.refCount < 0) {
-    throw new Error("invalid unref");
-  }
-};
-
-function createFromBuffer(buffer) {
-  return new BufferSlicer(buffer);
-}
-
-function createFromFd(fd, options) {
-  return new FdSlicer(fd, options);
-}

data/node_modules/fd-slicer/package.json

@@ -1,36 +0,0 @@
-{
-  "name": "fd-slicer",
-  "version": "1.0.1",
-  "description": "safely create multiple ReadStream or WriteStream objects from the same file descriptor",
-  "main": "index.js",
-  "scripts": {
-    "test": "mocha --reporter spec --check-leaks",
-    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/test.js",
-    "test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --timeout 10000 --reporter spec --check-leaks test/test.js"
-  },
-  "author": "Andrew Kelley <superjoe30@gmail.com>",
-  "license": "MIT",
-  "devDependencies": {
-    "istanbul": "~0.3.3",
-    "mocha": "~2.0.1",
-    "stream-equal": "~0.1.5",
-    "streamsink": "~1.2.0"
-  },
-  "dependencies": {
-    "pend": "~1.2.0"
-  },
-  "directories": {
-    "test": "test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/andrewrk/node-fd-slicer.git"
-  },
-  "bugs": {
-    "url": "https://github.com/andrewrk/node-fd-slicer/issues"
-  },
-  "keywords": [
-    "createReadStream",
-    "createWriteStream"
-  ]
-}