plist 1.1.0 → 2.1.0

package/index.js

@@ -0,0 +1,13 @@
+/**
+ * Parser functions.
+ */
+
+var parserFunctions = require('./lib/parse');
+Object.keys(parserFunctions).forEach(function (k) { exports[k] = parserFunctions[k]; });
+
+/**
+ * Builder functions.
+ */
+
+var builderFunctions = require('./lib/build');
+Object.keys(builderFunctions).forEach(function (k) { exports[k] = builderFunctions[k]; });

package/lib/build.js

@@ -1,4 +1,3 @@
-
 /**
  * Module dependencies.
  */
@@ -92,7 +91,9 @@ function walk_obj(next, next_child) {
   var tag_type, i, prop;
   var name = type(next);
 
-  if (Array.isArray(next)) {
+  if ('Undefined' == name) {
+    return;
+  } else if (Array.isArray(next)) {
     next_child = next_child.ele('array');
     for (i = 0; i < next.length; i++) {
       walk_obj(next[i], next_child);
@@ -128,7 +129,7 @@ function walk_obj(next, next_child) {
   } else if ('ArrayBuffer' == name) {
     next_child.ele('data').raw(base64.fromByteArray(next));
 
-  } else if (next.buffer && 'ArrayBuffer' == type(next.buffer)) {
+  } else if (next && next.buffer && 'ArrayBuffer' == type(next.buffer)) {
     // a typed array
     next_child.ele('data').raw(base64.fromByteArray(new Uint8Array(next.buffer), next_child));
 

package/lib/parse.js

@@ -1,9 +1,7 @@
-
 /**
  * Module dependencies.
  */
 
-var deprecate = require('util-deprecate');
 var DOMParser = require('xmldom').DOMParser;
 
 /**
@@ -11,10 +9,11 @@ var DOMParser = require('xmldom').DOMParser;
  */
 
 exports.parse = parse;
-exports.parseString = deprecate(parseString, '`parseString()` is deprecated. ' +
-  'It\'s not actually async. Use `parse()` instead.');
-exports.parseStringSync = deprecate(parseStringSync, '`parseStringSync()` is ' +
-  'deprecated. Use `parse()` instead.');
+
+var TEXT_NODE = 3;
+var CDATA_NODE = 4;
+var COMMENT_NODE = 8;
+
 
 /**
  * We ignore raw text (usually whitespace), <!-- xml comments -->,
@@ -26,77 +25,55 @@ exports.parseStringSync = deprecate(parseStringSync, '`parseStringSync()` is ' +
  */
 
 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;
 }
 
-
 /**
- * Parses a Plist XML string. Returns an Object.
+ * Check if the node is empty. Some plist file has such node:
+ * <key />
+ * this node shoud be ignored.
  *
- * @param {String} xml - the XML String to decode
- * @returns {Mixed} the decoded value from the Plist XML
- * @api public
+ * @see https://github.com/TooTallNate/plist.js/issues/66
+ * @param {Element} node
+ * @returns {Boolean}
+ * @api private
  */
-
-function parse (xml) {
-  var doc = new DOMParser().parseFromString(xml);
-  if (doc.documentElement.nodeName !== 'plist') {
-    throw new Error('malformed document. First element should be <plist>');
+function isEmptyNode(node){
+  if(!node.childNodes || node.childNodes.length === 0) {
+    return true;
+  } else {
+    return false;
   }
-  var plist = parsePlistXML(doc.documentElement);
-
-  // the root <plist> node gets interpreted as an Array,
-  // so pull out the inner data first
-  if (plist.length == 1) plist = plist[0];
-
-  return plist;
 }
 
-/**
- * Parses a Plist XML string. Returns an Object. Takes a `callback` function.
- *
- * @param {String} xml - the XML String to decode
- * @param {Function} callback - callback function
- * @returns {Mixed} the decoded value from the Plist XML
- * @api public
- * @deprecated not actually async. use parse() instead
- */
-
-function parseString (xml, callback) {
-  var doc, error, plist;
-  try {
-    doc = new DOMParser().parseFromString(xml);
-    plist = parsePlistXML(doc.documentElement);
-  } catch(e) {
-    error = e;
+function invariant(test, message) {
+  if (!test) {
+    throw new Error(message);
   }
-  callback(error, plist);
 }
 
 /**
  * Parses a Plist XML string. Returns an Object.
  *
  * @param {String} xml - the XML String to decode
- * @param {Function} callback - callback function
  * @returns {Mixed} the decoded value from the Plist XML
  * @api public
- * @deprecated use parse() instead
  */
 
-function parseStringSync (xml) {
+function parse (xml) {
   var doc = new DOMParser().parseFromString(xml);
-  var plist;
-  if (doc.documentElement.nodeName !== 'plist') {
-    throw new Error('malformed document. First element should be <plist>');
-  }
-  plist = parsePlistXML(doc.documentElement);
+  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,
+  // so pull out the inner data first
+  if (plist.length == 1) plist = plist[0];
 
-  // if the plist is an array with 1 element, pull it out of the array
-  if (plist.length == 1) {
-    plist = plist[0];
-  }
   return plist;
 }
 
@@ -109,41 +86,59 @@ function parseStringSync (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);
@@ -155,40 +150,60 @@ function parsePlistXML (node) {
     // TODO: what should we do with text types? (CDATA sections)
 
   } else if (node.nodeName === 'key') {
+    if (isEmptyNode(node)) {
+      return '';
+    }
     return node.childNodes[0].nodeValue;
-
   } else if (node.nodeName === 'string') {
     res = '';
-    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": "1.1.0",
+  "version": "2.1.0",
   "author": "Nathan Rajlich <nathan@tootallnate.net>",
   "contributors": [
     "Hans Huebner <hans.huebner@gmail.com>",
@@ -14,6 +14,7 @@
     "type": "git",
     "url": "git://github.com/TooTallNate/node-plist.git"
   },
+  "license": "MIT",
   "keywords": [
     "apple",
     "browser",
@@ -22,18 +23,17 @@
     "parser",
     "xml"
   ],
-  "main": "lib/plist.js",
+  "main": "index.js",
   "dependencies": {
-    "base64-js": "0.0.6",
-    "xmlbuilder": "2.2.1",
-    "xmldom": "0.1.x",
-    "util-deprecate": "1.0.0"
+    "base64-js": "1.2.0",
+    "xmlbuilder": "8.2.2",
+    "xmldom": "0.1.x"
   },
   "devDependencies": {
-    "browserify": "5.10.1",
-    "mocha": "1.18.2",
-    "multiline": "0.3.4",
-    "zuul": "1.10.2"
+    "browserify": "^14.3.0",
+    "mocha": "^3.3.0",
+    "multiline": "^1.0.2",
+    "zuul": "^3.10.1"
   },
   "scripts": {
     "test": "make test"

package/lib/node.js

@@ -1,49 +0,0 @@
-/**
- * Module dependencies.
- */
-
-var fs = require('fs');
-var parse = require('./parse');
-var deprecate = require('util-deprecate');
-
-/**
- * Module exports.
- */
-
-exports.parseFile = deprecate(parseFile, '`parseFile()` is deprecated. ' +
-  'Use `parseString()` instead.');
-exports.parseFileSync = deprecate(parseFileSync, '`parseFileSync()` is deprecated. ' +
-  'Use `parseStringSync()` instead.');
-
-/**
- * Parses file `filename` as a .plist file.
- * Invokes `fn` callback function when done.
- *
- * @param {String} filename - name of the file to read
- * @param {Function} fn - callback function
- * @api public
- * @deprecated use parseString() instead
- */
-
-function parseFile (filename, fn) {
-  fs.readFile(filename, { encoding: 'utf8' }, onread);
-  function onread (err, inxml) {
-    if (err) return fn(err);
-    parse.parseString(inxml, fn);
-  }
-}
-
-/**
- * Parses file `filename` as a .plist file.
- * Returns a  when done.
- *
- * @param {String} filename - name of the file to read
- * @param {Function} fn - callback function
- * @api public
- * @deprecated use parseStringSync() instead
- */
-
-function parseFileSync (filename) {
-  var inxml = fs.readFileSync(filename, 'utf8');
-  return parse.parseStringSync(inxml);
-}

package/lib/plist.js

@@ -1,23 +0,0 @@
-
-var i;
-
-/**
- * Parser functions.
- */
-
-var parserFunctions = require('./parse');
-for (i in parserFunctions) exports[i] = parserFunctions[i];
-
-/**
- * Builder functions.
- */
-
-var builderFunctions = require('./build');
-for (i in builderFunctions) exports[i] = builderFunctions[i];
-
-/**
- * Add Node.js-specific functions (they're deprecated…).
- */
-
-var nodeFunctions = require('./node');
-for (i in nodeFunctions) exports[i] = nodeFunctions[i];

package/test/build.js

@@ -1,133 +0,0 @@
-
-var assert = require('assert');
-var build = require('../').build;
-var multiline = require('multiline');
-
-describe('plist', function () {
-
-  describe('build()', function () {
-
-    it('should create a plist XML string from a String', function () {
-      var xml = build('test');
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <string>test</string>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML integer from a whole Number', function () {
-      var xml = build(3);
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <integer>3</integer>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML real from a fractional Number', function () {
-      var xml = build(Math.PI);
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <real>3.141592653589793</real>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML date from a Date', function () {
-      var xml = build(new Date('2010-02-08T21:41:23Z'));
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <date>2010-02-08T21:41:23Z</date>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML date from a Buffer', function () {
-      var xml = build(new Buffer('☃'));
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <data>4piD</data>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML true from a `true` Boolean', function () {
-      var xml = build(true);
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <true/>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML false from a `false` Boolean', function () {
-      var xml = build(false);
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <false/>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML dict from an Object', function () {
-      var xml = build({ foo: 'bar' });
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <dict>
-    <key>foo</key>
-    <string>bar</string>
-  </dict>
-</plist>
-*/}));
-    });
-
-    it('should create a plist XML array from an Array', function () {
-      var xml = build([ 1, 'foo', false, new Date(1234) ]);
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <array>
-    <integer>1</integer>
-    <string>foo</string>
-    <false/>
-    <date>1970-01-01T00:00:01Z</date>
-  </array>
-</plist>
-*/}));
-    });
-
-    it('should properly encode an empty string', function () {
-      var xml = build({ a: '' });
-      assert.strictEqual(xml, multiline(function () {/*
-<?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">
-  <dict>
-    <key>a</key>
-    <string></string>
-  </dict>
-</plist>
-*/}));
-    });
-
-  });
-
-});