update to latest util module code

Add tests copied from node. Also run tests in browser via zuul.

Author: defunctzombie

.zuul.yml

@@ -0,0 +1,10 @@
+ui: mocha-qunit
+browsers:
+  - name: chrome
+    version: 27..latest
+  - name: firefox
+    version: latest
+  - name: safari
+    version: latest
+  - name: ie
+    version: 6..latest

package.json

@@ -15,5 +15,14 @@
     "type": "git",
     "url": "git://github.com/defunctzombie/node-util"
   },
-  "main": "./util.js"
+  "main": "./util.js",
+  "scripts": {
+    "test": "node test/node/*.js && zuul test/*.js"
+  },
+  "devDependencies": {
+    "zuul": "~1.0.3"
+  },
+  "browser": {
+    "./support/isBuffer.js": "./support/isBufferBrowser.js"
+  }
 }

support/isBuffer.js

@@ -0,0 +1,3 @@
+module.exports = function isBuffer(arg) {
+  return arg instanceof Buffer;
+}

support/isBufferBrowser.js

@@ -0,0 +1,7 @@
+module.exports = function isBuffer(arg) {
+  return arg && typeof arg === 'object'
+    && typeof arg.copy === 'function'
+    && typeof arg.fill === 'function'
+    && typeof arg.binarySlice === 'function'
+    ;
+}

test/browser/inspect.js

@@ -0,0 +1,41 @@
+// Copyright Joyent, Inc. and other Node 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.
+
+var assert = require('assert');
+var util = require('../../');
+
+suite('inspect');
+
+test('util.inspect - test for sparse array', function () {
+  var a = ['foo', 'bar', 'baz'];
+  assert.equal(util.inspect(a), '[ \'foo\', \'bar\', \'baz\' ]');
+  delete a[1];
+  assert.equal(util.inspect(a), '[ \'foo\', , \'baz\' ]');
+  assert.equal(util.inspect(a, true), '[ \'foo\', , \'baz\', [length]: 3 ]');
+  assert.equal(util.inspect(new Array(5)), '[ , , , ,  ]');
+});
+
+test('util.inspect -  exceptions should print the error message, not \'{}\'', function () {
+  assert.equal(util.inspect(new Error()), '[Error]');
+  assert.equal(util.inspect(new Error('FAIL')), '[Error: FAIL]');
+  assert.equal(util.inspect(new TypeError('FAIL')), '[TypeError: FAIL]');
+  assert.equal(util.inspect(new SyntaxError('FAIL')), '[SyntaxError: FAIL]');
+});

test/browser/is.js

@@ -0,0 +1,79 @@
+// Copyright Joyent, Inc. and other Node 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.
+
+var assert = require('assert');
+
+var util = require('../../');
+
+suite('is');
+
+test('util.isArray', function () {
+  assert.equal(true, util.isArray([]));
+  assert.equal(true, util.isArray(Array()));
+  assert.equal(true, util.isArray(new Array()));
+  assert.equal(true, util.isArray(new Array(5)));
+  assert.equal(true, util.isArray(new Array('with', 'some', 'entries')));
+  assert.equal(false, util.isArray({}));
+  assert.equal(false, util.isArray({ push: function() {} }));
+  assert.equal(false, util.isArray(/regexp/));
+  assert.equal(false, util.isArray(new Error()));
+  assert.equal(false, util.isArray(Object.create(Array.prototype)));
+});
+
+test('util.isRegExp', function () {
+  assert.equal(true, util.isRegExp(/regexp/));
+  assert.equal(true, util.isRegExp(RegExp()));
+  assert.equal(true, util.isRegExp(new RegExp()));
+  assert.equal(false, util.isRegExp({}));
+  assert.equal(false, util.isRegExp([]));
+  assert.equal(false, util.isRegExp(new Date()));
+  assert.equal(false, util.isRegExp(Object.create(RegExp.prototype)));
+});
+
+test('util.isDate', function () {
+  assert.equal(true, util.isDate(new Date()));
+  assert.equal(true, util.isDate(new Date(0)));
+  assert.equal(false, util.isDate(Date()));
+  assert.equal(false, util.isDate({}));
+  assert.equal(false, util.isDate([]));
+  assert.equal(false, util.isDate(new Error()));
+  assert.equal(false, util.isDate(Object.create(Date.prototype)));
+});
+
+test('util.isError', function () {
+  assert.equal(true, util.isError(new Error()));
+  assert.equal(true, util.isError(new TypeError()));
+  assert.equal(true, util.isError(new SyntaxError()));
+  assert.equal(false, util.isError({}));
+  assert.equal(false, util.isError({ name: 'Error', message: '' }));
+  assert.equal(false, util.isError([]));
+  assert.equal(true, util.isError(Object.create(Error.prototype)));
+});
+
+test('util._extend', function () {
+  assert.deepEqual(util._extend({a:1}),             {a:1});
+  assert.deepEqual(util._extend({a:1}, []),         {a:1});
+  assert.deepEqual(util._extend({a:1}, null),       {a:1});
+  assert.deepEqual(util._extend({a:1}, true),       {a:1});
+  assert.deepEqual(util._extend({a:1}, false),      {a:1});
+  assert.deepEqual(util._extend({a:1}, {b:2}),      {a:1, b:2});
+  assert.deepEqual(util._extend({a:1, b:2}, {b:3}), {a:1, b:3});
+});

test/node/debug.js

@@ -0,0 +1,86 @@
+// Copyright Joyent, Inc. and other Node 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.
+
+var assert = require('assert');
+var util = require('../../');
+
+if (process.argv[2] === 'child')
+  child();
+else
+  parent();
+
+function parent() {
+  test('foo,tud,bar', true);
+  test('foo,tud', true);
+  test('tud,bar', true);
+  test('tud', true);
+  test('foo,bar', false);
+  test('', false);
+}
+
+function test(environ, shouldWrite) {
+  var expectErr = '';
+  if (shouldWrite) {
+    expectErr = 'TUD %PID%: this { is: \'a\' } /debugging/\n' +
+                'TUD %PID%: number=1234 string=asdf obj={"foo":"bar"}\n';
+  }
+  var expectOut = 'ok\n';
+  var didTest = false;
+
+  var spawn = require('child_process').spawn;
+  var child = spawn(process.execPath, [__filename, 'child'], {
+    env: { NODE_DEBUG: environ }
+  });
+
+  expectErr = expectErr.split('%PID%').join(child.pid);
+
+  var err = '';
+  child.stderr.setEncoding('utf8');
+  child.stderr.on('data', function(c) {
+    err += c;
+  });
+
+  var out = '';
+  child.stdout.setEncoding('utf8');
+  child.stdout.on('data', function(c) {
+    out += c;
+  });
+
+  child.on('close', function(c) {
+    assert(!c);
+    assert.equal(err, expectErr);
+    assert.equal(out, expectOut);
+    didTest = true;
+    console.log('ok %j %j', environ, shouldWrite);
+  });
+
+  process.on('exit', function() {
+    assert(didTest);
+  });
+}
+
+
+function child() {
+  var debug = util.debuglog('tud');
+  debug('this', { is: 'a' }, /debugging/);
+  debug('number=%d string=%s obj=%j', 1234, 'asdf', { foo: 'bar' });
+  console.log('ok');
+}

test/node/format.js

@@ -0,0 +1,77 @@
+// Copyright Joyent, Inc. and other Node 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.
+
+
+
+
+var assert = require('assert');
+var util = require('../../');
+
+assert.equal(util.format(), '');
+assert.equal(util.format(''), '');
+assert.equal(util.format([]), '[]');
+assert.equal(util.format({}), '{}');
+assert.equal(util.format(null), 'null');
+assert.equal(util.format(true), 'true');
+assert.equal(util.format(false), 'false');
+assert.equal(util.format('test'), 'test');
+
+// CHECKME this is for console.log() compatibility - but is it *right*?
+assert.equal(util.format('foo', 'bar', 'baz'), 'foo bar baz');
+
+assert.equal(util.format('%d', 42.0), '42');
+assert.equal(util.format('%d', 42), '42');
+assert.equal(util.format('%s', 42), '42');
+assert.equal(util.format('%j', 42), '42');
+
+assert.equal(util.format('%d', '42.0'), '42');
+assert.equal(util.format('%d', '42'), '42');
+assert.equal(util.format('%s', '42'), '42');
+assert.equal(util.format('%j', '42'), '"42"');
+
+assert.equal(util.format('%%s%s', 'foo'), '%sfoo');
+
+assert.equal(util.format('%s'), '%s');
+assert.equal(util.format('%s', undefined), 'undefined');
+assert.equal(util.format('%s', 'foo'), 'foo');
+assert.equal(util.format('%s:%s'), '%s:%s');
+assert.equal(util.format('%s:%s', undefined), 'undefined:%s');
+assert.equal(util.format('%s:%s', 'foo'), 'foo:%s');
+assert.equal(util.format('%s:%s', 'foo', 'bar'), 'foo:bar');
+assert.equal(util.format('%s:%s', 'foo', 'bar', 'baz'), 'foo:bar baz');
+assert.equal(util.format('%%%s%%', 'hi'), '%hi%');
+assert.equal(util.format('%%%s%%%%', 'hi'), '%hi%%');
+
+(function() {
+  var o = {};
+  o.o = o;
+  assert.equal(util.format('%j', o), '[Circular]');
+})();
+
+// Errors
+assert.equal(util.format(new Error('foo')), '[Error: foo]');
+function CustomError(msg) {
+  Error.call(this);
+  Object.defineProperty(this, 'message', { value: msg, enumerable: false });
+  Object.defineProperty(this, 'name', { value: 'CustomError', enumerable: false });
+}
+util.inherits(CustomError, Error);
+assert.equal(util.format(new CustomError('bar')), '[CustomError: bar]');