bson 1.0.0 → 1.0.4

package/HISTORY.md

@@ -1,3 +1,23 @@
+1.0.4 2016-01-11
+----------------
+- #204 remove Buffer.from as it's partially broken in early 4.x.x. series of node releases.
+
+1.0.3 2016-01-03
+----------------
+- Fixed toString for ObjectId so it will work with inspect.
+
+1.0.2 2016-01-02
+----------------
+- Minor optimizations for ObjectID to use Buffer.from where available.
+
+1.0.1 2016-12-06
+----------------
+- Reverse behavior for undefined to be serialized as NULL. MongoDB 3.4 does not allow for undefined comparisons.
+
+1.0.0 2016-12-06
+----------------
+- Introduced new BSON API and documentation.
+
 0.5.7 2016-11-18
 -----------------
 - NODE-848 BSON Regex flags must be alphabetically ordered.

package/README.md

@@ -57,7 +57,7 @@ console.log('doc_2:', doc_2)
 
 ## Installation
 
-`npm install bson-ext`
+`npm install bson`
 
 ## API
 

package/lib/bson/objectid.js

@@ -10,6 +10,12 @@ var MACHINE_ID = parseInt(Math.random() * 0xFFFFFF, 10);
 
 // Regular expression that checks for hex value
 var checkForHexRegExp = new RegExp("^[0-9a-fA-F]{24}$");
+var hasBufferType = false;
+
+// Check if buffer exists
+try {
+  if(Buffer && Buffer.from) hasBufferType = true;
+} catch(err) {};
 
 /**
 * Create a new ObjectID instance
@@ -26,17 +32,26 @@ var ObjectID = function ObjectID(id) {
 
   this._bsontype = 'ObjectID';
 
-  var __id = null;
+  // The most common usecase (blank id, new objectId instance)
+  if(id == null || typeof id == 'number') {
+    // Generate a new id
+    this.id = this.generate(id);
+    // If we are caching the hex string
+    if(ObjectID.cacheHexString) this.__id = this.toString('hex');
+    // Return the object
+    return;
+  }
+
+  // Check if the passed in id is valid
   var valid = ObjectID.isValid(id);
 
   // Throw an error if it's not a valid setup
   if(!valid && id != null){
     throw new Error("Argument passed in must be a single String of 12 bytes or a string of 24 hex characters");
+  } else if(valid && typeof id == 'string' && id.length == 24 && hasBufferType) {
+    return new ObjectID(new Buffer(id, 'hex'));
   } else if(valid && typeof id == 'string' && id.length == 24) {
     return ObjectID.createFromHexString(id);
-  } else if(id == null || typeof id == 'number') {
-    // convert to 12 byte binary string
-    this.id = this.generate(id);
   } else if(id != null && id.length === 12) {
     // assume 12 byte string
     this.id = id;
@@ -47,7 +62,7 @@ var ObjectID = function ObjectID(id) {
     throw new Error("Argument passed in must be a single String of 12 bytes or a string of 24 hex characters");
   }
 
-  if(ObjectID.cacheHexString) this.__id = this.toHexString();
+  if(ObjectID.cacheHexString) this.__id = this.toString('hex');
 };
 
 // Allow usage of ObjectId as well as ObjectID
@@ -149,10 +164,17 @@ ObjectID.prototype.generate = function(time) {
 /**
 * Converts the id into a 24 byte hex string for printing
 *
+* @param {String} format The Buffer toString format parameter.
 * @return {String} return the 24 byte hex string representation.
 * @ignore
 */
-ObjectID.prototype.toString = function() {
+ObjectID.prototype.toString = function(format) {
+  // Is the id a buffer then use the buffer toString method to return the format
+  if(this.id && this.id.copy) {
+    return this.id.toString(typeof format === 'string' ? format : 'hex');
+  }
+
+  // if(this.buffer )
   return this.toHexString();
 };
 
@@ -263,22 +285,19 @@ var convertToHex = function(bytes) {
 */
 ObjectID.createFromHexString = function createFromHexString (string) {
   // Throw an error if it's not a valid setup
-  if(typeof string === 'undefined' || string != null && string.length != 24)
+  if(typeof string === 'undefined' || string != null && string.length != 24) {
     throw new Error("Argument passed in must be a single String of 12 bytes or a string of 24 hex characters");
-
-  var length = string.length;
-
-  if(length > 12*2) {
-    throw new Error('Id cannot be longer than 12 bytes');
   }
 
+  // Use Buffer.from method if available
+  if(hasBufferType) return new ObjectID(new Buffer(string, 'hex'));
+
   // Calculate lengths
-  var sizeof = length >> 1;
-  var array = new _Buffer(sizeof);
+  var array = new _Buffer(12);
   var n = 0;
   var i = 0;
 
-  while (i < length) {
+  while (i < 24) {
     array[n++] = decodeLookup[string.charCodeAt(i++)] << 4 | decodeLookup[string.charCodeAt(i++)]
   }
 

package/lib/bson/parser/serializer.js

@@ -125,17 +125,6 @@ var serializeNumber = function(buffer, key, value, index, isArray) {
   return index;
 }
 
-var serializeUndefined = function(buffer, key, value, index, isArray) {
-  // Set long type
-  buffer[index++] = BSON.BSON_DATA_UNDEFINED;
-  // Number of written bytes
-  var numberOfWrittenBytes = !isArray ? buffer.write(key, index, 'utf8') : buffer.write(key, index, 'ascii');
-  // Encode the name
-  index = index + numberOfWrittenBytes;
-  buffer[index++] = 0;
-  return index;
-}
-
 var serializeNull = function(buffer, key, value, index, isArray) {
   // Set long type
   buffer[index++] = BSON.BSON_DATA_NULL;
@@ -695,9 +684,7 @@ var serializeInto = function serializeInto(buffer, object, checkKeys, startingIn
       } else if(value instanceof Date || isDate(value)) {
         index = serializeDate(buffer, key, value, index);
       } else if(value === undefined && ignoreUndefined == true) {
-      } else if(value === undefined) {
-        index = serializeUndefined(buffer, key, value, index);
-      } else if(value === null) {
+      } else if(value === null || value === undefined) {
         index = serializeNull(buffer, key, value, index);
       } else if(value['_bsontype'] == 'ObjectID') {
         index = serializeObjectId(buffer, key, value, index);
@@ -777,9 +764,7 @@ var serializeInto = function serializeInto(buffer, object, checkKeys, startingIn
       } else if(value instanceof Date || isDate(value)) {
         index = serializeDate(buffer, key, value, index);
       } else if(value === undefined && ignoreUndefined == true) {
-      } else if(value === undefined) {
-        index = serializeUndefined(buffer, key, value, index);
-      } else if(value === null) {
+      } else if(value === null || value === undefined) {
         index = serializeNull(buffer, key, value, index);
       } else if(value['_bsontype'] == 'ObjectID') {
         index = serializeObjectId(buffer, key, value, index);

package/package.json

@@ -12,7 +12,7 @@
     "browser_build",
     "bower.json"
   ],
-  "version": "1.0.0",
+  "version": "1.0.4",
   "author": "Christian Amor Kvalheim <christkv@gmail.com>",
   "contributors": [],
   "repository": "mongodb/js-bson",