Clean up getters/setters and asserts in messages

Author: pfmooney

lib/assert.js

@@ -0,0 +1,61 @@
+// Copyright 2015 Joyent, Inc.
+
+var assert = require('assert');
+var util = require('util');
+
+var isDN = require('./dn').DN.isDN;
+var isAttribute = require('./attribute').isAttribute;
+
+
+///--- Helpers
+
+// Copied from mcavage/node-assert-plus
+function _assert(arg, type, name) {
+  name = name || type;
+  throw new assert.AssertionError({
+    message: util.format('%s (%s) required', name, type),
+    actual: typeof (arg),
+    expected: type,
+    operator: '===',
+    stackStartFunction: _assert.caller
+  });
+}
+
+
+///--- API
+
+function stringDN(input, name) {
+  if (isDN(input) || typeof (input) === 'string')
+    return;
+  _assert(input, 'DN or string', name);
+}
+
+function optionalStringDN(input, name) {
+  if (input === undefined || isDN(input) || typeof (input) === 'string')
+    return;
+  _assert(input, 'DN or string', name);
+}
+
+function optionalDN(input, name) {
+  if (input !== undefined && !isDN(input))
+    _assert(input, 'DN', name);
+}
+
+function optionalArrayOfAttribute(input, name) {
+  if (input === undefined)
+    return;
+  if (!Array.isArray(input) ||
+      input.some(function (v) { return !isAttribute(v); })) {
+  _assert(input, 'array of Attribute', name);
+  }
+}
+
+
+///--- Exports
+
+module.exports = {
+  stringDN: stringDN,
+  optionalStringDN: optionalStringDN,
+  optionalDN: optionalDN,
+  optionalArrayOfAttribute: optionalArrayOfAttribute
+};

lib/messages/abandon_request.js

@@ -1,35 +1,31 @@
 // Copyright 2011 Mark Cavage, Inc.  All rights reserved.
 
-var assert = require('assert');
+var assert = require('assert-plus');
 var util = require('util');
 
 var LDAPMessage = require('./message');
 var Protocol = require('../protocol');
 
 
-
 ///--- API
 
 function AbandonRequest(options) {
-  if (options) {
-    if (typeof (options) !== 'object')
-      throw new TypeError('options must be an object');
-    if (options.abandonID && typeof (options.abandonID) !== 'number')
-      throw new TypeError('abandonID must be a number');
-  } else {
-    options = {};
-  }
+  options = options || {};
+  assert.object(options);
+  assert.optionalNumber(options.abandonID);
 
   options.protocolOp = Protocol.LDAP_REQ_ABANDON;
   LDAPMessage.call(this, options);
 
   this.abandonID = options.abandonID || 0;
-
-  this.__defineGetter__('type', function () { return 'AbandonRequest'; });
 }
 util.inherits(AbandonRequest, LDAPMessage);
-module.exports = AbandonRequest;
-
+Object.defineProperties(AbandonRequest.prototype, {
+  type: {
+    get: function getType() { return 'AbandonRequest'; },
+    configurable: false
+  }
+});
 
 AbandonRequest.prototype._parse = function (ber, length) {
   assert.ok(ber);
@@ -59,7 +55,6 @@ AbandonRequest.prototype._parse = function (ber, length) {
   return true;
 };
 
-
 AbandonRequest.prototype._toBer = function (ber) {
   assert.ok(ber);
 
@@ -81,11 +76,15 @@ AbandonRequest.prototype._toBer = function (ber) {
   return ber;
 };
 
-
 AbandonRequest.prototype._json = function (j) {
   assert.ok(j);
 
   j.abandonID = this.abandonID;
 
   return j;
 };
+
+
+///--- Exports
+
+module.exports = AbandonRequest;

lib/messages/abandon_response.js

@@ -1,32 +1,36 @@
 // Copyright 2011 Mark Cavage, Inc.  All rights reserved.
 
-var assert = require('assert');
+var assert = require('assert-plus');
 var util = require('util');
 
 var LDAPMessage = require('./result');
 var Protocol = require('../protocol');
 
 
 ///--- API
-// Stub this out
 
 function AbandonResponse(options) {
-  if (!options)
-    options = {};
-  if (typeof (options) !== 'object')
-    throw new TypeError('options must be an object');
+  options = options || {};
+  assert.object(options);
 
   options.protocolOp = 0;
   LDAPMessage.call(this, options);
-  this.__defineGetter__('type', function () { return 'AbandonResponse'; });
 }
 util.inherits(AbandonResponse, LDAPMessage);
-module.exports = AbandonResponse;
-
+Object.defineProperties(AbandonResponse.prototype, {
+  type: {
+    get: function getType() { return 'AbandonResponse'; },
+    configurable: false
+  }
+});
 
 AbandonResponse.prototype.end = function (status) {};
 
-
 AbandonResponse.prototype._json = function (j) {
   return j;
 };
+
+
+///--- Exports
+
+module.exports = AbandonResponse;

lib/messages/add_request.js

@@ -1,55 +1,39 @@
 // Copyright 2011 Mark Cavage, Inc.  All rights reserved.
 
-var assert = require('assert');
+var assert = require('assert-plus');
 var util = require('util');
 
 var LDAPMessage = require('./message');
-var dn = require('../dn');
 var Attribute = require('../attribute');
 var Protocol = require('../protocol');
-
-
-
-///--- Globals
-
-var isDN = dn.DN.isDN;
+var lassert = require('../assert');
 
 
 ///--- API
 
 function AddRequest(options) {
-  if (options) {
-    if (typeof (options) !== 'object')
-      throw new TypeError('options must be an object');
-    if (options.entry &&
-        !(isDN(options.entry) || typeof (options.entry) === 'string')) {
-      throw new TypeError('options.entry must be a DN or string');
-    }
-    if (options.attributes) {
-      if (!Array.isArray(options.attributes))
-        throw new TypeError('options.attributes must be [Attribute]');
-      options.attributes.forEach(function (a) {
-        if (!Attribute.isAttribute(a))
-          throw new TypeError('options.attributes must be [Attribute]');
-      });
-    }
-  } else {
-    options = {};
-  }
+  options = options || {};
+  assert.object(options);
+  lassert.optionalStringDN(options.entry);
+  lassert.optionalArrayOfAttribute(options.attributes);
 
   options.protocolOp = Protocol.LDAP_REQ_ADD;
   LDAPMessage.call(this, options);
 
   this.entry = options.entry || null;
   this.attributes = options.attributes ? options.attributes.slice(0) : [];
-
-  var self = this;
-  this.__defineGetter__('type', function () { return 'AddRequest'; });
-  this.__defineGetter__('_dn', function () { return self.entry; });
 }
 util.inherits(AddRequest, LDAPMessage);
-module.exports = AddRequest;
-
+Object.defineProperties(AddRequest.prototype, {
+  type: {
+    get: function getType() { return 'AddRequest'; },
+    configurable: false
+  },
+  _dn: {
+    get: function getDN() { return this.entry; },
+    configurable: false
+  }
+});
 
 AddRequest.prototype._parse = function (ber) {
   assert.ok(ber);
@@ -74,7 +58,6 @@ AddRequest.prototype._parse = function (ber) {
   return true;
 };
 
-
 AddRequest.prototype._toBer = function (ber) {
   assert.ok(ber);
 
@@ -88,7 +71,6 @@ AddRequest.prototype._toBer = function (ber) {
   return ber;
 };
 
-
 AddRequest.prototype._json = function (j) {
   assert.ok(j);
 
@@ -102,7 +84,6 @@ AddRequest.prototype._json = function (j) {
   return j;
 };
 
-
 AddRequest.prototype.indexOf = function (attr) {
   if (!attr || typeof (attr) !== 'string')
     throw new TypeError('attr (string) required');
@@ -115,7 +96,6 @@ AddRequest.prototype.indexOf = function (attr) {
   return -1;
 };
 
-
 AddRequest.prototype.attributeNames = function () {
   var attrs = [];
 
@@ -125,7 +105,6 @@ AddRequest.prototype.attributeNames = function () {
   return attrs;
 };
 
-
 AddRequest.prototype.getAttribute = function (name) {
   if (!name || typeof (name) !== 'string')
     throw new TypeError('attribute name (string) required');
@@ -140,15 +119,13 @@ AddRequest.prototype.getAttribute = function (name) {
   return null;
 };
 
-
 AddRequest.prototype.addAttribute = function (attr) {
   if (!(attr instanceof Attribute))
     throw new TypeError('attribute (Attribute) required');
 
   return this.attributes.push(attr);
 };
 
-
 /**
  * Returns a "pure" JS representation of this object.
  *
@@ -187,3 +164,8 @@ AddRequest.prototype.toObject = function () {
 
   return obj;
 };
+
+
+///--- Exports
+
+module.exports = AddRequest;

lib/messages/add_response.js

@@ -1,24 +1,24 @@
 // Copyright 2011 Mark Cavage, Inc.  All rights reserved.
 
+var assert = require('assert-plus');
 var util = require('util');
 
 var LDAPResult = require('./result');
 var Protocol = require('../protocol');
 
 
-
 ///--- API
 
 function AddResponse(options) {
-  if (options) {
-    if (typeof (options) !== 'object')
-      throw new TypeError('options must be an object');
-  } else {
-    options = {};
-  }
+  options = options || {};
+  assert.object(options);
 
   options.protocolOp = Protocol.LDAP_REP_ADD;
   LDAPResult.call(this, options);
 }
 util.inherits(AddResponse, LDAPResult);
+
+
+///--- Exports
+
 module.exports = AddResponse;