Initial commit of xml-element string

Author: mcous

.eslintrc

@@ -0,0 +1,41 @@
+{
+  "rules": {
+    "indent": [2, 2, {"SwitchCase": 1}],
+    "quotes": [2, "single", "avoid-escape"],
+    "linebreak-style": [2, "unix"],
+    "semi": [2, "never"],
+    "eqeqeq": [2, "allow-null"],
+    "no-extend-native": 2,
+    "curly": [2, "all"],
+    "strict": [2, "global"],
+    "space-before-function-paren": [2, "never"],
+    "space-unary-ops": [2, {"words": true, "nonwords": false}],
+    "space-infix-ops": [2, {"int32Hint": false}],
+    "keyword-spacing": 2,
+    "spaced-comment": [2, "always", { "exceptions": ["-", "+"] }],
+    "no-inline-comments": 2,
+    "func-style": [2, "expression"],
+    "callback-return": [2, ["done", "next"]],
+    "no-path-concat": 2,
+    "no-use-before-define": 2,
+    "array-bracket-spacing": [2, "never"],
+    "object-curly-spacing": [2, "never"],
+    "key-spacing": [2, {"beforeColon": false, "afterColon": true}],
+    "comma-spacing": [2, {"before": false, "after": true}],
+    "brace-style": [2, "stroustrup", {"allowSingleLine": true}],
+    "handle-callback-err": [2, "^(e|err|error)$" ],
+    "one-var": [2, "never"],
+    "one-var-declaration-per-line": [2, "always"],
+    "newline-after-var": 2,
+    "newline-before-return": 2,
+    "no-else-return": 2,
+    "no-unexpected-multiline": 2,
+    "eol-last": 2
+  },
+  "env": {
+    "node": true,
+    "browser": true,
+    "mocha": true
+  },
+  "extends": "eslint:recommended"
+}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+coverage

.travis.yml

@@ -0,0 +1,26 @@
+sudo: false
+language: node_js
+node_js:
+- '0.10'
+- '4'
+- node
+matrix:
+  include:
+  - node_js: node
+    env: TEST_BROWSERS=true
+script: npm run-script ci
+deploy:
+  provider: npm
+  email: mike@cousins.io
+  api_key:
+    secure: uyly+k9h9qabINIwG6n24bbxVuY7LBPSFueXTo9KGUDRekENcP9dyJj3sGGYGF88DCUVujNWtD643pQSfGYW7FVjjjcuSYzDVikMn5NmKeVSVTc4fWi0Jc/IhgU7N2V2X9reqlcjbeoFcVJK7DtD3u5bMtyQbfpmPAAISDWajdaaP0jUN08Gz9MuZP0+xde59T1ZktuCwym9HISpdVNOQgo3ZCMHKprp/+KKJ4rQvxoT7qi0gHtLHMCdEnr6LHAArFz6/ou4TZQb2/SdMutNSPee2+1V24Bbnh8Tnc0oMgESydtH/X2oa65fazp8Z7yTK/E5zIBOz6YWr6W0NDR278bw7oqAN7+FTLb+NR/e0VVrSe0PGGeW1oo/2D2evCF6cd9KNWL+V2w0KeYVfHNwQbK7vQqZzDtzP3R09J+6r0ZTzwhURufdwQgk0O+AAWVWmuhnfE8152Sq4yk7R7DzaNR5228hHSdRVBWX6qbToa59Vjnk9yrFGgnhn3a/c9q5iP+XEPLdeVrQR5EF0EeqP9uxF22kdIWX2eNbEM+4uYTU7k21zWYRL5Q5cM/EIHrFZlDJU3blWMxtcB9SIIdU3oEawOqN0T0tA2prKM5Y3dlZgDHAmL34RBJOnTqATmsIyY0h3v2hPxvoihZ8CvpDMkTQwfzYhu547xshmYqjEz0=
+  on:
+    node: node
+    condition: "$TEST_BROWSERS = true"
+    tags: true
+    all_branches: true
+    repo: tracespace/xml-element-string
+env:
+  global:
+  - secure: I/DCMfAXP1IREo636jjGGESXci3Fqk9Wv4Pj0l3u4eo/j/ep+EU/eUbJ6y0QfbPMg1aHSCRKLW7LUmSvNpqF16ePpFUv0cRKlrQ1Cv30s2gvK0CxZCNdi4UtKsBaGkvXaYrB/CsMY/1jlBKyvrlR0cy5vRalf+Q+dRW7yMZdks6bk6hokO65nnsRz67nGdZujPqrAV+Qkp+ygyV/us564mgY+PIRL5GSKdh+zvX3JLVSFFp73cHW8wSbUEeEUBerml+DPJVB/KYV3taRVM6ZLWB9+Go8+nF5naD7/qieE47ct+2wj1KlfOOoHCTu4u0s8DS+kLlHxkv/jpVQ2S+rxHU19HeX5YNCf2HF7TUVPLjw5tdFUOxMQxbLhc6aNAJvbQ3hhrVlJdJrZJDZBClGVOPJOwG1v5tme5xouSZ6ewP8leHuMrtb/NceosP3TUS/UnvwkrL+Y6rF8SlQsbuusNnltEEYmc6ON845BkhSHsk9oMFLcG1vWvss2NYecKrcN2Jf/1zUahAZsMgITrB1Vfgh2twAgBOtiZUMWJFWRV45Q5UfXKR7qOk5rGm+Sc4YdFnivt5i5Cy9KuenKSRaeEeLl6VgOpYdwolBmireryJRN6dQApsHZQT/ZOcLep1HcVFZTq6fcvUIBXqzXib9WAQPsRvr+kObx8+i+mxpWJk=
+  - secure: iPGaRlo5IUMPaEsBw7Cw86Tec/lFJpZEFeZQ5YTmy+th1hxaE2W2eBAirSeSNA8XSAmvtpzVqERkVlbbKOnVMq+87+PNJfOEl/BClO4FRr3JLd6BBjaKHiqSvy0qtcgqXqG8bbgFJLU2CPSFEWJyY8VM2u1JHprqTvAjWyabuj3w4xgM8C8QFjHPquepuELVE+damNfLWAOaei1xVdsCs8Mn6aM7fcFE/FN6EYWsknl8NQsAuYnVgXa8W5W6GyP3vwta99fpdT0o9BtVTCsK/SD8JguqOS3xnwKIxCbpZama0iUW3DzPc1zi3CFjFAGDOAAiVi0tM7vm5js/rYu61uye64/AoaY+XONy5Lkk1CsOoMYuBJK5bBAdw2QiAUU0IVvtCJ45amQhI6HFE8L0vltPfK44Yy9kYjoPmAMo+Q72GIfGiJNP8et7U6ABmgLH0Tc9T0KGYdr80cHlzIiM+6tzFWOTMYsL/e7Dm42zyOmc7UYlEQS+okViylDJxecImbNaTs//STnUuRwzUvBlB4IZdWQzan6lIkGjxE/+dd1HdIb0Mp1croZBZHW/h8/axY+gxq71sblEWgw74rzG+cMBdqzj3dle+IC5R9bczQEZGtK/HIgtxZe4DW4jmD9idYx105lG7L3vs1GSGjAmVsVelPuwzyYo5XCjbxzINOE=

.zuul.yml

@@ -0,0 +1,12 @@
+ui: mocha-bdd
+browsers:
+  - name: chrome
+    version: -1..latest
+  - name: safari
+    version: -1..latest
+  - name: firefox
+    version: -1..latest
+  - name: ie
+    version: -1..latest
+  - name: microsoftedge
+    version: latest

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2015 by Mike Cousins (mike@cousins.io) and contributors, shared under the terms of the MIT License.
+
+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.

README.md

@@ -0,0 +1,66 @@
+# xml element string
+
+[![npm](https://img.shields.io/npm/v/xml-element-string.svg?style=flat-square)](https://www.npmjs.com/package/xml-element-string)
+[![Travis](https://img.shields.io/travis/tracespace/xml-element-string.svg?style=flat-square)](https://travis-ci.org/tracespace/xml-element-string)
+[![Coveralls](https://img.shields.io/coveralls/tracespace/xml-element-string.svg?style=flat-square)](https://coveralls.io/github/tracespace/xml-element-string)
+[![David](https://img.shields.io/david/tracespace/xml-element-string.svg?style=flat-square)](https://david-dm.org/tracespace/xml-element-string)
+[![David](https://img.shields.io/david/dev/tracespace/xml-element-string.svg?style=flat-square)](https://david-dm.org/tracespace/xml-element-string#info=devDependencies)
+
+Takes a tag-name, attributes object, and an array of children and turns them into an xml string.
+
+## usage
+
+```
+$ npm install --save xml-element-string
+```
+
+then
+
+``` js
+var createElement = require('xml-element-string')
+var element = createElement(tagName, optionalAttributesObject, optionalChildArray)
+```
+
+## example
+
+``` js
+var createElement = require('xml-element-string')
+
+var element = createElement('hello', {from: 'the'}, [
+  createElement('other', {side: 'I'}),
+  createElement('must', {have: 'called'}, [
+    createElement('a', {thousand: 'times'})
+  ])
+])
+
+console.log(element)
+// logs
+// <hello from="the"><other side="I"/><must have="called"><a thousand="times"/></must></hello>
+```
+
+## features
+
+Not much going on here, but this module will:
+
+* Close or self-close the nodes as necessary
+* Ignore attributes that resolve to `null` or `undefined`
+* Escape html characters in the tag, attribute names, and attribute values by way of [escape-html](https://github.com/component/escape-html)
+
+## developing and contributing
+
+Clone and then `$ npm install`. Please accompany all PRs with applicable tests. Please test your code in browsers, as Travis CI cannot run browser tests for PRs.
+
+### unit testing
+
+This module uses [Mocha](http://mochajs.org/) and [Chai](http://chaijs.com/) for unit testing, [Istanbul](https://github.com/gotwarlost/istanbul) for coverage, and [ESLint](http://eslint.org/) for linting.
+
+* `$ npm test` - run the tests, calculate coverage, and lint
+* `$ npm run test:watch` - run the tests on code changes (does not lint nor cover)
+* `$ npm run lint` - lint the code (will be run as a pre-commit script)
+
+### browser testing
+
+Browser tests are run with [Zuul](https://github.com/defunctzombie/zuul) and [Sauce Labs](https://saucelabs.com/opensauce/) on the last two versions of Chrome, Firefox, Safari, and Internet Explorer as well as the latest version of Edge.
+
+* `$ npm run test:browser` - run the unit tests in a local browser
+* `$ npm run test:sauce` - run the units tests in several browsers using Open Sauce (Sauce Labs account and local [.zuulrc](https://github.com/defunctzombie/zuul/wiki/Zuulrc) required)

index.js

@@ -0,0 +1,26 @@
+// create an xml element string
+'use strict'
+
+var escapeHtml = require('escape-html')
+
+module.exports = function createXmlString(tag, attributes, children) {
+  attributes = attributes || {}
+  children = children || []
+
+  var start = '<' + escapeHtml(tag)
+
+  var middle = Object.keys(attributes).reduce(function(result, key) {
+    var value = attributes[key]
+    var attr = (value != null)
+      ? (' ' + escapeHtml(key) + '="' + escapeHtml(value) + '"')
+      : ''
+
+    return result + attr
+  }, '')
+
+  var end = (children.length)
+    ? '>' + children.join('') + '</' + tag + '>'
+    : '/>'
+
+  return start + middle + end
+}

package.json

@@ -0,0 +1,39 @@
+{
+  "name": "xml-element-string",
+  "version": "0.0.0",
+  "description": "Takes a tag-name, attributes object, and an array of children and turns them into an xml string",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha",
+    "lint": "eslint *.js",
+    "test": "istanbul cover _mocha",
+    "posttest": "npm run lint",
+    "test:watch": "mocha --reporter dot --watch",
+    "test:browser": "zuul --local -- test.js",
+    "test:sauce": "zuul -- test.js",
+    "ci": "npm test && if [ \"${TEST_BROWSERS}\" = \"true\" ]; then npm run ci:browser; fi",
+    "ci:browser": "if [ \"${TRAVIS_PULL_REQUEST}\" = \"false\" ]; then npm run test:sauce; fi",
+    "postci": "coveralls < ./coverage/lcov.info"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tracespace/xml-element-string.git"
+  },
+  "keywords": [
+    "xml",
+    "svg"
+  ],
+  "author": "Mike Cousins <mike@cousins.io> (http://cousins.io)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tracespace/xml-element-string/issues"
+  },
+  "homepage": "https://github.com/tracespace/xml-element-string#readme",
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "eslint": "^2.12.0",
+    "istanbul": "^0.4.3",
+    "mocha": "^2.5.3",
+    "zuul": "^3.10.1"
+  }
+}

test.js

@@ -0,0 +1,57 @@
+// test suite for the xml element string function
+'use strict'
+
+var expect = require('chai').expect
+
+var element = require('./')
+
+describe('xml element string function', function() {
+  it('should be able to create a node', function() {
+    var result = element('node')
+    var expected = '<node/>'
+
+    expect(result).to.equal(expected)
+  })
+
+  it('should be able to create a node with attributes', function() {
+    var result = element('foo', {bar: 'baz', quux: 'hello'})
+    var expected = '<foo bar="baz" quux="hello"/>'
+
+    expect(result).to.equal(expected)
+  })
+
+  it('should not write null attributes', function() {
+    var result = element('foo', {bar: undefined, baz: 'quux', nope: null})
+    var expected = '<foo baz="quux"/>'
+
+    expect(result).to.equal(expected)
+  })
+
+  it('should escape html characters in the tag', function() {
+    var result = element('foo/>danger')
+    var expected = '<foo/&gt;danger/>'
+
+    expect(result).to.equal(expected)
+  })
+
+  it('should escape html characters in the attribute names', function() {
+    var result = element('foo', {'/>danger': 'bar'})
+    var expected = '<foo /&gt;danger="bar"/>'
+
+    expect(result).to.equal(expected)
+  })
+
+  it('should escape html characters in the attribute values', function() {
+    var result = element('foo', {bar: '"/>danger'})
+    var expected = '<foo bar="&quot;/&gt;danger"/>'
+
+    expect(result).to.equal(expected)
+  })
+
+  it('should handle an array of children', function() {
+    var result = element('node', {}, ['<child/>', '<child/>'])
+    var expected = '<node><child/><child/></node>'
+
+    expect(result).to.equal(expected)
+  })
+})