plist 2.0.1 → 2.1.0

package/History.md

@@ -1,3 +1,11 @@
+2.1.0 / 2017-05-04
+==================
+
+* [[`e4f06669bb`]](https://github.com/TooTallNate/plist.js/commit/e4f06669bb51d2e65654df7c39aab52bc3bf4e8a) - update license (extend copyright term) (Mike Reinstein)
+* [[`edc6e41035`]](https://github.com/TooTallNate/plist.js/commit/edc6e4103546b1d7518a577e7c202c305a8abec0) - update module deps (Mike Reinstein)
+* [[`85d11c48ef`](https://github.com/TooTallNate/plist.js/commit/85d11c48eff02312cbdd67f46fd8e74b0d372ca1)] - Harden test-cases and implementation to align with other implementations (Björn Brauer)
+* [[`7619537eaa`]](https://github.com/TooTallNate/plist.js/commit/7619537eaa9e3e5a80829e759c004d2e017a07d2) review feedback: early returns and constants for nodeTypes (Björn Brauer)
+
 2.0.1 / 2016-08-16
 ==================
 

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2010-2014 Nathan Rajlich <nathan@tootallnate.net>
+Copyright (c) 2010-2017 Nathan Rajlich <nathan@tootallnate.net>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/README.md

@@ -69,7 +69,7 @@ Parsing a plist from string payload:
 ``` javascript
 var plist = require('plist');
 
-var xml = 
+var xml =
   '<?xml version="1.0" encoding="UTF-8"?>' +
   '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' +
   '<plist version="1.0">' +
@@ -138,27 +138,4 @@ console.log(plist.build(json));
 
 ## License
 
-(The MIT License)
-
-Copyright (c) 2010-2014 Nathan Rajlich <nathan@tootallnate.net>
-
-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.
+[(The MIT License)](LICENSE)

package/lib/parse.js

@@ -10,6 +10,11 @@ var DOMParser = require('xmldom').DOMParser;
 
 exports.parse = parse;
 
+var TEXT_NODE = 3;
+var CDATA_NODE = 4;
+var COMMENT_NODE = 8;
+
+
 /**
  * We ignore raw text (usually whitespace), <!-- xml comments -->,
  * and raw CDATA nodes.
@@ -20,9 +25,9 @@ exports.parse = parse;
  */
 
 function shouldIgnoreNode (node) {
-  return node.nodeType === 3 // text
-    || node.nodeType === 8   // comment
-    || node.nodeType === 4;  // cdata
+  return node.nodeType === TEXT_NODE
+    || node.nodeType === COMMENT_NODE
+    || node.nodeType === CDATA_NODE;
 }
 
 /**
@@ -43,6 +48,12 @@ function isEmptyNode(node){
   }
 }
 
+function invariant(test, message) {
+  if (!test) {
+    throw new Error(message);
+  }
+}
+
 /**
  * Parses a Plist XML string. Returns an Object.
  *
@@ -53,9 +64,10 @@ function isEmptyNode(node){
 
 function parse (xml) {
   var doc = new DOMParser().parseFromString(xml);
-  if (doc.documentElement.nodeName !== 'plist') {
-    throw new Error('malformed document. First element should be <plist>');
-  }
+  invariant(
+    doc.documentElement.nodeName === 'plist',
+    'malformed document. First element should be <plist>'
+  );
   var plist = parsePlistXML(doc.documentElement);
 
   // the root <plist> node gets interpreted as an Array,
@@ -74,41 +86,59 @@ function parse (xml) {
  */
 
 function parsePlistXML (node) {
-  var i, new_obj, key, val, new_arr, res, d;
+  var i, new_obj, key, val, new_arr, res, counter, type;
 
   if (!node)
     return null;
 
   if (node.nodeName === 'plist') {
     new_arr = [];
+    if (isEmptyNode(node)) {
+      return new_arr;
+    }
     for (i=0; i < node.childNodes.length; i++) {
-      // ignore comment nodes (text)
       if (!shouldIgnoreNode(node.childNodes[i])) {
         new_arr.push( parsePlistXML(node.childNodes[i]));
       }
     }
     return new_arr;
-
   } else if (node.nodeName === 'dict') {
     new_obj = {};
     key = null;
+    counter = 0;
+    if (isEmptyNode(node)) {
+      return new_obj;
+    }
     for (i=0; i < node.childNodes.length; i++) {
-      // ignore comment nodes (text)
-      if (!shouldIgnoreNode(node.childNodes[i])) {
-        if (key === null) {
-          key = parsePlistXML(node.childNodes[i]);
-        } else {
-          new_obj[key] = parsePlistXML(node.childNodes[i]);
-          key = null;
-        }
+      if (shouldIgnoreNode(node.childNodes[i])) continue;
+      if (counter % 2 === 0) {
+        invariant(
+          node.childNodes[i].nodeName === 'key',
+          'Missing key while parsing <dict/>.'
+        );
+        key = parsePlistXML(node.childNodes[i]);
+      } else {
+        invariant(
+          node.childNodes[i].nodeName !== 'key',
+          'Unexpected key "'
+            + parsePlistXML(node.childNodes[i])
+            + '" while parsing <dict/>.'
+        );
+        new_obj[key] = parsePlistXML(node.childNodes[i]);
       }
+      counter += 1;
+    }
+    if (counter % 2 === 1) {
+      throw new Error('Missing value for "' + key + '" while parsing <dict/>');
     }
     return new_obj;
 
   } else if (node.nodeName === 'array') {
     new_arr = [];
+    if (isEmptyNode(node)) {
+      return new_arr;
+    }
     for (i=0; i < node.childNodes.length; i++) {
-      // ignore comment nodes (text)
       if (!shouldIgnoreNode(node.childNodes[i])) {
         res = parsePlistXML(node.childNodes[i]);
         if (null != res) new_arr.push(res);
@@ -120,45 +150,60 @@ function parsePlistXML (node) {
     // TODO: what should we do with text types? (CDATA sections)
 
   } else if (node.nodeName === 'key') {
-    if(isEmptyNode(node)) return null;
-    res = '';
-    if(node.childNodes[0]) {
-      res = node.childNodes[0].nodeValue;
+    if (isEmptyNode(node)) {
+      return '';
     }
-    return res;
+    return node.childNodes[0].nodeValue;
   } else if (node.nodeName === 'string') {
     res = '';
-    if(isEmptyNode(node)) return null;
-    for (d=0; d < node.childNodes.length; d++) {
-      res += node.childNodes[d].nodeValue;
+    if (isEmptyNode(node)) {
+      return res;
+    }
+    for (i=0; i < node.childNodes.length; i++) {
+      var type = node.childNodes[i].nodeType;
+      if (type === TEXT_NODE || type === CDATA_NODE) {
+        res += node.childNodes[i].nodeValue;
+      }
     }
     return res;
 
   } else if (node.nodeName === 'integer') {
-    // parse as base 10 integer
+    invariant(
+      !isEmptyNode(node),
+      'Cannot parse "" as integer.'
+    );
     return parseInt(node.childNodes[0].nodeValue, 10);
 
   } else if (node.nodeName === 'real') {
+    invariant(
+      !isEmptyNode(node),
+      'Cannot parse "" as real.'
+    );
     res = '';
-    for (d=0; d < node.childNodes.length; d++) {
-      if (node.childNodes[d].nodeType === 3) {
-        res += node.childNodes[d].nodeValue;
+    for (i=0; i < node.childNodes.length; i++) {
+      if (node.childNodes[i].nodeType === TEXT_NODE) {
+        res += node.childNodes[i].nodeValue;
       }
     }
     return parseFloat(res);
 
   } else if (node.nodeName === 'data') {
     res = '';
-    for (d=0; d < node.childNodes.length; d++) {
-      if (node.childNodes[d].nodeType === 3) {
-        res += node.childNodes[d].nodeValue.replace(/\s+/g, '');
+    if (isEmptyNode(node)) {
+      return new Buffer(res, 'base64');
+    }
+    for (i=0; i < node.childNodes.length; i++) {
+      if (node.childNodes[i].nodeType === TEXT_NODE) {
+        res += node.childNodes[i].nodeValue.replace(/\s+/g, '');
       }
     }
-
-    // decode base64 data to a Buffer instance
     return new Buffer(res, 'base64');
 
   } else if (node.nodeName === 'date') {
+    invariant(
+      !isEmptyNode(node),
+      'Cannot parse "" as Date.'
+    )
     return new Date(node.childNodes[0].nodeValue);
 
   } else if (node.nodeName === 'true') {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "plist",
   "description": "Mac OS X Plist parser/builder for Node.js and browsers",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "author": "Nathan Rajlich <nathan@tootallnate.net>",
   "contributors": [
     "Hans Huebner <hans.huebner@gmail.com>",
@@ -25,15 +25,15 @@
   ],
   "main": "index.js",
   "dependencies": {
-    "base64-js": "1.1.2",
+    "base64-js": "1.2.0",
     "xmlbuilder": "8.2.2",
     "xmldom": "0.1.x"
   },
   "devDependencies": {
-    "browserify": "13.0.1",
-    "mocha": "2.4.5",
-    "multiline": "1.0.2",
-    "zuul": "3.10.1"
+    "browserify": "^14.3.0",
+    "mocha": "^3.3.0",
+    "multiline": "^1.0.2",
+    "zuul": "^3.10.1"
   },
   "scripts": {
     "test": "make test"