plist 0.4.2 → 1.1.0

package/lib/plist.js

@@ -1,297 +1,23 @@
-;(function (exports, DOMParser, xmlbuilder) {
-	// Checks if running in a non-browser environment
- 	var inNode = typeof window === 'undefined' ? true : false
- 	  , utf8_to_b64
- 	  , b64_to_utf8;
 
- 	// this library runs in browsers and nodejs, set up functions accordingly
- 	if (inNode) {
- 		exports.parseFile = function (filename, callback) {
- 			console.warn('parseFile is deprecated. Please use parseFileSync instead.');
-    		var fs = require('fs');
-			var inxml = fs.readFileSync(filename, 'utf8');
-			exports.parseString(inxml, callback);
-  		}
+var i;
 
-  		exports.parseFileSync = function (filename) {
-    		var fs = require('fs');
-			var inxml = fs.readFileSync(filename, 'utf8');
-			return exports.parseStringSync(inxml);
-  		}
+/**
+ * Parser functions.
+ */
 
-  		// set up base64 encode/decode functions
-  		utf8_to_b64= function ( str ) {
-  			return new Buffer(str).toString('base64');
-		}
-		b64_to_utf8 = function ( str ) {
-		    return new Buffer(str, 'base64').toString('utf8');
-		}
-  	} else {
-  		// we're in a browser context, find the DOMParser
-		if (typeof window.DOMParser != 'undefined') {
-		    DOMParser = function(xmlStr) {
-		        return ( new window.DOMParser() ).parseFromString(xmlStr, 'text/xml');
-		    };
-		} else if (typeof window.ActiveXObject != 'undefined' &&
-		       new window.ActiveXObject('Microsoft.XMLDOM')) {
-		    DOMParser = function(xmlStr) {
-		        var xmlDoc = new window.ActiveXObject('Microsoft.XMLDOM');
-		        xmlDoc.async = 'false';
-		        xmlDoc.loadXML(xmlStr);
-		        return xmlDoc;
-		    };
-		} else {
-		    throw new Error('No XML parser found');
-		}
+var parserFunctions = require('./parse');
+for (i in parserFunctions) exports[i] = parserFunctions[i];
 
-		// set up base64 encode/decode functions
-		if (typeof window.btoa == 'undefined') {
-			throw new Error('No base64 support found');
-			// TODO: shim btoa and atob if not present (ie < 10)
-			//http://stackoverflow.com/questions/246801/how-can-you-encode-to-base64-using-javascript/247261#247261
-		} else {
-			utf8_to_b64= function ( str ) {
-			    return window.btoa(unescape(encodeURIComponent( str )));
-			}
-			 
-			b64_to_utf8 = function ( str ) {
-			    return decodeURIComponent(escape(window.atob( str )));
-			}
-		}
+/**
+ * Builder functions.
+ */
 
-	}
+var builderFunctions = require('./build');
+for (i in builderFunctions) exports[i] = builderFunctions[i];
 
-	exports.parseString = function (xml, callback) {
-		console.warn('parseString is deprecated. Please use parseStringSync instead.');
-		var doc, error, plist;
-		try {
-			doc = new DOMParser().parseFromString(xml);
-			plist = parsePlistXML(doc.documentElement);
-		} catch(e) {
-			error = e;
-		}
-		callback(error, plist);
-	}
+/**
+ * Add Node.js-specific functions (they're deprecated…).
+ */
 
-	exports.parseStringSync = function (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);
-
-		// if the plist is an array with 1 element, pull it out of the array
-		if(isArray(plist) && plist.length == 1) {
-			plist = plist[0]; 
-		}
-		return plist;
-	}
-
-	/**
-	 * convert an XML based plist document into a JSON representation
-	 * 
-	 * @param object xml_node current XML node in the plist
-	 * @return built up JSON object
-	 */
-	function parsePlistXML(node) {
-		var i, new_obj, key, val, new_arr;
-		if (!node)
-			return null;
-
-		if (node.nodeName === 'plist') {
-			new_arr = [];
-			for (i=0;i < node.childNodes.length;i++) {
-				// ignore comment nodes (text) 
-				if (node.childNodes[i].nodeType !== 3) {
-					new_arr.push( parsePlistXML(node.childNodes[i]));
-				}
-			}
-			return new_arr;
-		}
-		else if(node.nodeName === 'dict') {
-			new_obj = {};
-			key = null;
-			for (i=0;i < node.childNodes.length;i++) {
-				// ignore comment nodes (text) 
-				if (node.childNodes[i].nodeType !== 3) {
-					if (key === null) {
-						key = parsePlistXML(node.childNodes[i]);
-					} else {
-						new_obj[key] = parsePlistXML(node.childNodes[i]);
-						key = null;
-					}
-				}
-			}
-			return new_obj;
-		}
-		else if(node.nodeName === 'array') {
-			new_arr = [];
-			for (i=0;i < node.childNodes.length;i++) {
-				// ignore comment nodes (text) 
-				if (node.childNodes[i].nodeType !== 3) {
-					res = parsePlistXML(node.childNodes[i]);
-					if (res) new_arr.push( res );
-				}
-			}
-			return new_arr;
-		}
-		else if(node.nodeName === '#text') {
-			// TODO: what should we do with text types? (CDATA sections)
-		}
-		else if(node.nodeName === 'key') {
-			return node.childNodes[0].nodeValue;
-		}
-		else if(node.nodeName === 'string') {
-			var res = '';
-			for (var d=0; d < node.childNodes.length; d++)
-			{
-				res += node.childNodes[d].nodeValue;
-			}
-			return res;
-		}
-		else if(node.nodeName === 'integer') {
-			// parse as base 10 integer
-			return parseInt(node.childNodes[0].nodeValue, 10);
-		}
-		else if(node.nodeName === 'real') {
-			var res = '';
-			for (var d=0; d < node.childNodes.length; d++)
-			{
-				if(node.childNodes[d].nodeType === 3) {
-					res += node.childNodes[d].nodeValue;
-				}
-			}
-			return parseFloat(res);
-		}
-		else if(node.nodeName === 'data') {
-			var res = '';
-			for (var d=0; d < node.childNodes.length; d++)
-			{
-				if(node.childNodes[d].nodeType === 3) {
-					res += node.childNodes[d].nodeValue;
-				}
-			}
-		
-			// validate that the string is encoded as base64
-			var base64Matcher = new RegExp("^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$");
-			if (!base64Matcher.test(res.replace(/\s/g,'')) ) {
-				throw new Error('malformed document. <data> element is not base64 encoded');
-			}
-
-			// decode base64 data as utf8 string
-			return b64_to_utf8(res);
-		}
-		else if(node.nodeName === 'date') {
-			return new Date(node.childNodes[0].nodeValue);
-		}
-		else if(node.nodeName === 'true') {
-			return true;
-		}
-		else if(node.nodeName === 'false') {
-			return false;
-		}
-	}
-
-
-  function ISODateString(d){  
-    function pad(n){return n<10 ? '0'+n : n}  
-    return d.getUTCFullYear()+'-'  
-        + pad(d.getUTCMonth()+1)+'-'  
-        + pad(d.getUTCDate())+'T'  
-        + pad(d.getUTCHours())+':'  
-        + pad(d.getUTCMinutes())+':'  
-        + pad(d.getUTCSeconds())+'Z'  
-  }
-
-  // instanceof is horribly unreliable so we use these hackish but safer checks 
-  // http://perfectionkills.com/instanceof-considered-harmful-or-how-to-write-a-robust-isarray
-  function isArray(obj) {
-    return Object.prototype.toString.call(obj) === '[object Array]';
-  }
-
-  function isDate(obj) {
-    return Object.prototype.toString.call(obj) === '[object Date]';
-  }
-
-  function isBoolean(obj) {
-    return (obj === true || obj === false || toString.call(obj) == '[object Boolean]');
-  }
-
-  function isNumber(obj) {
-    return Object.prototype.toString.call(obj) === '[object Number]';
-  }
-
-  function isObject(obj) {
-    return Object.prototype.toString.call(obj) === '[object Object]';
-  }
-
-  function isString(obj) {
-    return Object.prototype.toString.call(obj) === '[object String]';
-  }
-
-  /**
-   * generate an XML plist string from the input object
-   *
-   * @param object obj the object to convert
-   * @return string converted plist
-   */
-  exports.build = function(obj) {
-    var XMLHDR = { 'version': '1.0','encoding': 'UTF-8'}
-        , XMLDTD = { 'ext': 'PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\"'}
-        , doc = xmlbuilder.create()
-        , child = doc.begin('plist', XMLHDR, XMLDTD).att('version', '1.0');
-
-    walk_obj(obj, child);
-    return child.end({pretty: true });
-  }
-
-  // depth first, recursive traversal of a javascript object. when complete,
-  // next_child contains a reference to the build XML object.
-  function walk_obj(next, next_child) {
-    var tag_type, i, prop;
-
-    if(isArray(next)) {
-      next_child = next_child.ele('array');
-      for(i=0 ;i < next.length;i++) {
-        walk_obj(next[i], next_child);
-      }
-    }
-    else if(isObject(next)) {
-      next_child = next_child.ele('dict');
-      for(prop in next) {
-        if(next.hasOwnProperty(prop)) {
-          next_child.ele('key').txt(prop);
-          walk_obj(next[prop], next_child);
-        }
-      }
-    }
-    else if(isNumber(next)) {
-      // detect if this is an integer or real
-      tag_type =(next % 1 === 0) ? 'integer' : 'real';
-      next_child.ele(tag_type).txt(next.toString());
-    }
-    else if(isDate(next)) {
-      next_child.ele('date').raw(ISODateString(new Date(next)));
-    }
-    else if(isBoolean(next)) {
-      val = next ? 'true' : 'false';
-      next_child.ele(val);
-    }
-    else if(isString(next)) {
-      //if (str!=obj || str.indexOf("\n")>=0) str = "<![CDATA["+str+"]]>";
-      var base64Matcher = new RegExp("^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$");
-      if (base64Matcher.test(next.replace(/\s/g,''))) {
-      	// data is base 64 encoded so assume it's a <data> node
-        next_child.ele('data').raw(utf8_to_b64(next));
-      } else {
-      	// it's not base 64 encoded, assume it's a <string> node
-      	next_child.ele('string').raw(next);
-      }
-    }
-  };
-
-})(typeof exports === 'undefined' ? plist = {} : exports, typeof window === 'undefined' ? require('xmldom').DOMParser : null, typeof window === 'undefined' ? require('xmlbuilder') : xmlbuilder)
-// the above line checks for exports (defined in node) and uses it, or creates 
-// a global variable and exports to that. also, if in node, require DOMParser
-// node-style, in browser it should already be present
+var nodeFunctions = require('./node');
+for (i in nodeFunctions) exports[i] = nodeFunctions[i];

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "plist",
-  "description": "Mac OS X Plist parser/builder for NodeJS. Convert a Plist file or string into a native JS object and native JS object into a Plist file.",
-  "version": "0.4.2",
+  "description": "Mac OS X Plist parser/builder for Node.js and browsers",
+  "version": "1.1.0",
   "author": "Nathan Rajlich <nathan@tootallnate.net>",
-  "contributors": [ 
+  "contributors": [
     "Hans Huebner <hans.huebner@gmail.com>",
     "Pierre Metrailler",
-    "Mike Reinstein <reinstein.mike@gmail.com>"
+    "Mike Reinstein <reinstein.mike@gmail.com>",
+    "Vladimir Tsvang",
+    "Mathieu D'Amours"
   ],
   "repository": {
     "type": "git",
@@ -14,24 +16,26 @@
   },
   "keywords": [
     "apple",
+    "browser",
     "mac",
     "plist",
     "parser",
     "xml"
   ],
-  "main": "./lib/plist",
+  "main": "lib/plist.js",
   "dependencies": {
-    "xmlbuilder" : "0.4.x",
-    "xmldom" : "0.1.x"
+    "base64-js": "0.0.6",
+    "xmlbuilder": "2.2.1",
+    "xmldom": "0.1.x",
+    "util-deprecate": "1.0.0"
   },
   "devDependencies": {
-    "nodeunit" : "0.7.x"
+    "browserify": "5.10.1",
+    "mocha": "1.18.2",
+    "multiline": "0.3.4",
+    "zuul": "1.10.2"
   },
   "scripts": {
-    "test": "nodeunit tests"
-  },
-  "engines": {
-    "node": ">= 0.1.100"
-  },
-  "devDependencies": {}
+    "test": "make test"
+  }
 }

package/test/build.js

@@ -0,0 +1,133 @@
+
+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>
+*/}));
+    });
+
+  });
+
+});