plist 0.4.2 → 1.1.0

package/.jshintrc

@@ -0,0 +1,4 @@
+{
+  "laxbreak": true,
+  "laxcomma": true
+}

package/.travis.yml

@@ -0,0 +1,32 @@
+language: node_js
+node_js:
+- '0.10'
+- '0.11'
+env:
+  global:
+  - secure: xlLmWO7akYQjmDgrv6/b/ZMGILF8FReD+k6A/u8pYRD2JW29hhwvRwIQGcKp9+zmJdn4i5M4D1/qJkCeI3pdhAYBDHvzHOHSEwLJz1ESB2Crv6fa69CtpIufQkWvIxmZoU49tCaLpMBaIroGihJ4DAXdIVOIz6Ur9vXLDhGsE4c=
+  - secure: aQ46RdxL10xR5ZJJTMUKdH5k4tdrzgZ87nlwHC+pTr6bfRw3UKYC+6Rm7yQpg9wq0Io9O9dYCP007gQGSWstbjr1+jXNu/ubtNG+q5cpWBQZZZ013VHh9QJTf1MnetsZxbv8Yhrjg590s6vruT0oqesOnB2CizO/BsKxnY37Nos=
+matrix:
+  include:
+  - node_js: '0.10'
+    env: BROWSER_NAME=chrome BROWSER_VERSION=latest
+  - node_js: '0.10'
+    env: BROWSER_NAME=chrome BROWSER_VERSION=29
+  - node_js: '0.10'
+    env: BROWSER_NAME=firefox BROWSER_VERSION=latest
+  - node_js: '0.10'
+    env: BROWSER_NAME=opera BROWSER_VERSION=latest
+  - node_js: '0.10'
+    env: BROWSER_NAME=safari BROWSER_VERSION=latest
+  - node_js: '0.10'
+    env: BROWSER_NAME=safari BROWSER_VERSION=7
+  - node_js: '0.10'
+    env: BROWSER_NAME=safari BROWSER_VERSION=6
+  - node_js: '0.10'
+    env: BROWSER_NAME=safari BROWSER_VERSION=5
+  - node_js: '0.10'
+    env: BROWSER_NAME=ie BROWSER_VERSION=11
+  - node_js: '0.10'
+    env: BROWSER_NAME=ie BROWSER_VERSION=10
+  - node_js: '0.10'
+    env: BROWSER_NAME=ie BROWSER_VERSION=9

package/History.md

@@ -0,0 +1,112 @@
+
+1.1.0 / 2014-08-27
+==================
+
+ * package: update "browserify" to v5.10.1
+ * package: update "zuul" to v1.10.2
+ * README: add "Sauce Test Status" build badge
+ * travis: use new "plistjs" sauce credentials
+ * travis: set up zuul saucelabs automated testing
+
+1.0.1 / 2014-06-25
+==================
+
+  * add .zuul.yml file for browser testing
+  * remove Testling stuff
+  * build: fix global variable `val` leak
+  * package: use --check-leaks when running mocha tests
+  * README: update examples to use preferred API
+  * package: add "browser" keyword
+
+1.0.0 / 2014-05-20
+==================
+
+  * package: remove "android-browser"
+  * test: add <dict> build() test
+  * test: re-add the empty string build() test
+  * test: remove "fixtures" and legacy "tests" dir
+  * test: add some more build() tests
+  * test: add a parse() CDATA test
+  * test: starting on build() tests
+  * test: more parse() tests
+  * package: attempt to fix "android-browser" testling
+  * parse: better <data> with newline handling
+  * README: add Testling badge
+  * test: add <data> node tests
+  * test: add a <date> parse() test
+  * travis: don't test node v0.6 or v0.8
+  * test: some more parse() tests
+  * test: add simple <string> parsing test
+  * build: add support for an optional "opts" object
+  * package: test mobile devices
+  * test: use multiline to inline the XML
+  * package: beautify
+  * package: fix "mocha" harness
+  * package: more testling browsers
+  * build: add the "version=1.0" attribute
+  * beginnings of "mocha" tests
+  * build: more JSDocs
+  * tests: add test that ensures that empty string conversion works
+  * build: update "xmlbuilder" to v2.2.1
+  * parse: ignore comment and cdata nodes
+  * tests: make the "Newlines" test actually contain a newline
+  * parse: lint
+  * test travis
+  * README: add Travis CI badge
+  * add .travis.yml file
+  * build: updated DTD to reflect name change
+  * parse: return falsey values in an Array plist
+  * build: fix encoding a typed array in the browser
+  * build: add support for Typed Arrays and ArrayBuffers
+  * build: more lint
+  * build: slight cleanup and optimizations
+  * build: use .txt() for the "date" value
+  * parse: always return a Buffer for <data> nodes
+  * build: don't interpret Strings as base64
+  * dist: commit prebuilt plist*.js files
+  * parse: fix typo in deprecate message
+  * parse: fix parse() return value
+  * parse: add jsdoc comments for the deprecated APIs
+  * parse: add `parse()` function
+  * node, parse: use `util-deprecate` module
+  * re-implemented parseFile to be asynchronous
+  * node: fix jsdoc comment
+  * Makefile: fix "node" require stubbing
+  * examples: add "browser" example
+  * package: tweak "main"
+  * package: remove "engines" field
+  * Makefile: fix --exclude command for browserify
+  * package: update "description"
+  * lib: more styling
+  * Makefile: add -build.js and -parse.js dist files
+  * lib: separate out the parse and build logic into their own files
+  * Makefile: add makefile with browserify build rules
+  * package: add "browserify" as a dev dependency
+  * plist: tabs to spaces (again)
+  * add a .jshintrc file
+  * LICENSE: update
+  * node-webkit support
+  * Ignore tests/ in .npmignore file
+  * Remove duplicate devDependencies key
+  * Remove trailing whitespace
+  * adding recent contributors. Bumping npm package number (patch release)
+  * Fixed node.js string handling
+  * bumping version number
+  * Fixed global variable plist leak
+  * patch release 0.4.1
+  * removed temporary debug output file
+  * flipping the cases for writing data and string elements in build(). removed the 125 length check. Added validation of base64 encoding for data fields when parsing. added unit tests.
+  * fixed syntax errors in README examples (issue #20)
+  * added Sync versions of calls. added deprecation warnings for old method calls. updated documentation. If the resulting object from parseStringSync is an array with 1 element, return just the element. If a plist string or file doesnt have a <plist> tag as the document root element, fail noisily (issue #15)
+  * incrementing package version
+  * added cross platform base64 encode/decode for data elements (issue #17.) Comments and hygiene.
+  * refactored the code to use a DOM parser instead of SAX. closes issues #5 and #16
+  * rolling up package version
+  * updated base64 detection regexp. updated README. hygiene.
+  * refactored the build function. Fixes issue #14
+  * refactored tests. Modified tests from issue #9. thanks @sylvinus
+  * upgrade xmlbuilder package version. this is why .end() was needed in last commit; breaking change to xmlbuilder lib. :/
+  * bug fix in build function, forgot to call .end() Refactored tests to use nodeunit
+  * Implemented support for real, identity tests
+  * Refactored base64 detection - still sloppy, fixed date building. Passing tests OK.
+  * Implemented basic plist builder that turns an existing JS object into plist XML. date, real and data types still need to be implemented.

package/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2010-2011- Nathan Rajlich
+(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

package/Makefile

@@ -0,0 +1,76 @@
+
+# get Makefile directory name: http://stackoverflow.com/a/5982798/376773
+THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
+THIS_DIR:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)
+
+# BIN directory
+BIN := $(THIS_DIR)/node_modules/.bin
+
+# applications
+NODE ?= node
+NPM ?= $(NODE) $(shell which npm)
+BROWSERIFY ?= $(NODE) $(BIN)/browserify
+MOCHA ?= $(NODE) $(BIN)/mocha
+ZUUL ?= $(NODE) $(BIN)/zuul
+
+REPORTER ?= spec
+
+all: dist/plist.js dist/plist-build.js dist/plist-parse.js
+
+install: node_modules
+
+clean:
+	@rm -rf node_modules dist
+
+dist:
+	@mkdir -p $@
+
+dist/plist-build.js: node_modules lib/build.js dist
+	@$(BROWSERIFY) \
+		--standalone plist \
+		lib/build.js > $@
+
+dist/plist-parse.js: node_modules lib/parse.js dist
+	@$(BROWSERIFY) \
+		--standalone plist \
+		lib/parse.js > $@
+
+dist/plist.js: node_modules lib/*.js dist
+	@$(BROWSERIFY) \
+		--standalone plist \
+		--ignore lib/node.js \
+		lib/plist.js > $@
+
+node_modules: package.json
+	@NODE_ENV= $(NPM) install
+	@touch node_modules
+
+test:
+	@if [ "x$(BROWSER_NAME)" = "x" ]; then \
+		$(MAKE) test-node; \
+		else \
+		$(MAKE) test-zuul; \
+	fi
+
+test-node:
+	@$(MOCHA) \
+		--reporter $(REPORTER) \
+		test/*.js
+
+test-zuul:
+	@if [ "x$(BROWSER_PLATFORM)" = "x" ]; then \
+		$(ZUUL) \
+		--ui mocha-bdd \
+		--browser-name $(BROWSER_NAME) \
+		--browser-version $(BROWSER_VERSION) \
+		test/*.js; \
+		else \
+		$(ZUUL) \
+		--ui mocha-bdd \
+		--browser-name $(BROWSER_NAME) \
+		--browser-version $(BROWSER_VERSION) \
+		--browser-platform "$(BROWSER_PLATFORM)" \
+		test/*.js; \
+	fi
+
+.PHONY: all install clean test test-node test-zuul

package/README.md

@@ -1,62 +1,113 @@
-# node-plist
+plist.js
+========
+### Mac OS X Plist parser/builder for Node.js and browsers
 
-Provides facilities for reading and writing Mac OS X Plist (property list) files. These are often used in programming OS X and iOS applications, as well as the iTunes
-configuration XML file.
+[![Sauce Test Status](https://saucelabs.com/browser-matrix/plistjs.svg)](https://saucelabs.com/u/plistjs)
+
+[![Build Status](https://travis-ci.org/TooTallNate/plist.js.svg?branch=master)](https://travis-ci.org/TooTallNate/plist.js)
+
+Provides facilities for reading and writing Mac OS X Plist (property list)
+files. These are often used in programming OS X and iOS applications, as
+well as the iTunes configuration XML file.
 
 Plist files represent stored programming "object"s. They are very similar
-to JSON. A valid Plist file is representable as a native JavaScript Object and vice-versa.
+to JSON. A valid Plist file is representable as a native JavaScript Object
+and vice-versa.
 
-## Tests
-`npm test`
 
 ## Usage
-Parsing a plist from filename
-``` javascript
-var plist = require('plist');
 
-var obj = plist.parseFileSync('myPlist.plist');
-console.log(JSON.stringify(obj));
+### Node.js
+
+Install using `npm`:
+
+``` bash
+$ npm install --save plist
 ```
 
-Parsing a plist from string payload
-``` javascript
+Then `require()` the _plist_ module in your file:
+
+``` js
 var plist = require('plist');
 
-var obj = plist.parseStringSync('<plist><string>Hello World!</string></plist>');
-console.log(obj);  // Hello World!
+// now use the `parse()` and `build()` functions
+var val = plist.parse('<plist><string>Hello World!</string></plist>');
+console.log(val);  // "Hello World!"
 ```
 
-Given an existing JavaScript Object, you can turn it into an XML document that complies with the plist DTD
 
-``` javascript
-var plist = require('plist');
+### Browser
 
-console.log(plist.build({'foo' : 'bar'}).toString());
+Include the `dist/plist.js` in a `<script>` tag in your HTML file:
+
+``` html
+<script src="plist.js"></script>
+<script>
+  // now use the `parse()` and `build()` functions
+  var val = plist.parse('<plist><string>Hello World!</string></plist>');
+  console.log(val);  // "Hello World!"
+</script>
 ```
 
 
+## API
+
+### Parsing
 
-### Deprecated methods
-These functions work, but may be removed in a future release. version 0.4.x added Sync versions of these functions.
+Parsing a plist from filename:
 
-Parsing a plist from filename
 ``` javascript
+var fs = require('fs');
 var plist = require('plist');
 
-plist.parseFile('myPlist.plist', function(err, obj) {
-  if (err) throw err;
-
-  console.log(JSON.stringify(obj));
-});
+var obj = plist.parse(fs.readFileSync('myPlist.plist', 'utf8'));
+console.log(JSON.stringify(obj));
 ```
 
-Parsing a plist from string payload
+Parsing a plist from string payload:
+
 ``` javascript
 var plist = require('plist');
 
-plist.parseString('<plist><string>Hello World!</string></plist>', function(err, obj) {
-  if (err) throw err;
+var obj = plist.parse('<plist><string>Hello World!</string></plist>');
+console.log(obj);  // Hello World!
+```
+
+### Building
+
+Given an existing JavaScript Object, you can turn it into an XML document
+that complies with the plist DTD:
+
+``` javascript
+var plist = require('plist');
 
-  console.log(obj[0]);  // Hello World!
-});
+console.log(plist.build({ foo: 'bar' }));
 ```
+
+
+## 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.