Message: Rename parentHeader to parent_header

Closes #7
n-riesco · Jul 17, 2015 · b5aca9b · b5aca9b
1 parent a6ddef7
commit b5aca9b
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -8,8 +8,13 @@ Protocol](http://ipython.org/ipython-doc/stable/development/messaging.html) over
 
 ## Anouncements
 
-Version v0.1.0 is backwards-incompatible. `npm` packages depending on the
-initial release of JMP need to update their dependency field:
+- Version v0.2.0 is backwards-incompatible. The attribute `Message#parentHeader`
+  has been renamed to
+  [`Message#parent_header`](http://n-riesco.github.io/jmp/module-jmp-Message.html#parent_header).
+  See [issue #7](https://github.com/n-riesco/jmp/issues/7).
+
+- Version v0.1.0 is backwards-incompatible. `npm` packages depending on the
+  initial release of JMP need to update their dependency field:
 
 ```
 "jmp": "<0.1.0",
@@ -89,7 +94,7 @@ request.header = {
     "msg_type": "kernel_info_request",
     "version": "5.0",
 };
-request.parentHeader = {};
+request.parent_header = {};
 request.metadata = {};
 request.content = {};
 ```

diff --git a/index.js b/index.js
@@ -66,7 +66,7 @@ var zmq = module.exports.zmq;
  * @param          [properties]              Message properties
  * @param {Array}  [properties.idents]       ZMQ identities
  * @param {Object} [properties.header]
- * @param {Object} [properties.parentHeader]
+ * @param {Object} [properties.parent_header]
  * @param {Object} [properties.metadata]
  * @param {Object} [properties.content]
  */
@@ -85,7 +85,7 @@ function Message(properties) {
     /**
      * @member {Object}
      */
-    this.parentHeader = properties && properties.parentHeader || {};
+    this.parent_header = properties && properties.parent_header || {};
 
     /**
      * @member {Object}
@@ -133,7 +133,7 @@ Message.prototype.respond = function(
         response.header.version = protocolVersion;
     }
 
-    response.parentHeader = this.header;
+    response.parent_header = this.header;
     response.content = content || {};
     response.metadata = metadata || {};
 
@@ -201,7 +201,7 @@ Message.prototype._decode = function(messageFrames, scheme, key) {
     }
 
     this.header = toJSON(messageFrames[i + 2]);
-    this.parentHeader = toJSON(messageFrames[i + 3]);
+    this.parent_header = toJSON(messageFrames[i + 3]);
     this.content = toJSON(messageFrames[i + 5]);
     this.metadata = toJSON(messageFrames[i + 4]);
     this.blobs = Array.prototype.slice.apply(messageFrames, [i + 6]);
@@ -222,15 +222,15 @@ Message.prototype._encode = function(scheme, key) {
     var idents = this.idents;
 
     var header = JSON.stringify(this.header);
-    var parentHeader = JSON.stringify(this.parentHeader);
+    var parent_header = JSON.stringify(this.parent_header);
     var metadata = JSON.stringify(this.metadata);
     var content = JSON.stringify(this.content);
 
     var signature = '';
     if (key) {
         var hmac = crypto.createHmac(scheme, key);
         hmac.update(header);
-        hmac.update(parentHeader);
+        hmac.update(parent_header);
         hmac.update(metadata);
         hmac.update(content);
         signature = hmac.digest("hex");
@@ -240,7 +240,7 @@ Message.prototype._encode = function(scheme, key) {
         DELIMITER, // delimiter
         signature, // HMAC signature
         header, // header
-        parentHeader, // parent header
+        parent_header, // parent header
         metadata, // metadata
         content, // content
     ]);

diff --git a/tests/test.js b/tests/test.js
@@ -221,10 +221,10 @@ function testCommunication(context, tests) {
             makeErrorMessage("request.header", message.header, request.header)
         );
         assert.deepEqual(
-            message.parentHeader, request.parentHeader,
+            message.parent_header, request.parent_header,
             makeErrorMessage(
-                "request.parentHeader",
-                message.parentHeader, request.parentHeader
+                "request.parent_header",
+                message.parent_header, request.parent_header
             )
         );
         assert.deepEqual(
@@ -258,9 +258,9 @@ function testCommunication(context, tests) {
             )
         );
         assert.deepEqual(
-            message.parentHeader, request.header,
+            message.parent_header, request.header,
             makeErrorMessage(
-                "response.parentHeader", message.parentHeader, request.header
+                "response.parent_header", message.parent_header, request.header
             )
         );
         assert.deepEqual(