initial commit

Author: HenrikJoreteg

.gitignore

@@ -0,0 +1 @@
+node_modules

.jshintignore

@@ -0,0 +1 @@
+node_modules

.jshintrc

@@ -0,0 +1,12 @@
+{
+  "curly": true,
+  "latedef": true,
+  "quotmark": true,
+  "undef": true,
+  "unused": true,
+  "trailing": true,
+  "predef": [
+    "module",
+    "require"
+  ]
+}

README.md

@@ -0,0 +1,140 @@
+# html-parse-stringify
+
+This is an *experimental lightweight approach* to enable quickly parsing HTML into an AST and stringify'ing it back to the original string.
+
+As it turns out, if you can make a the simplifying assumptions about HTML that all tags must be closed or self-closing. Which is OK for *this* particular application. You can write a super light/fast parser in JS with regex.
+
+"Why on earth would you do this?! Haven't you read: http://stackoverflow.com/questions/1732348/regex-match-open-tags-except-xhtml-self-contained-tags ?!?!"
+
+Why yes, yes I have :)
+
+But the truth is. If you *could* do this in a whopping grand total of ~600 bytes (min+gzip) as this repo shows. It potentially enables DOM diffing based on a HTML strings to be super light and fast in a browser. What is that you say? DOM-diffing?
+
+Yes. 
+
+React.js essentially pioneered the approach. With Reach you render to a "virtual DOM" whenever you want to, and the virtual DOM can then diff against the real DOM (or the last virtual DOM) and then turn that diff into whatever transformations are necessary to get the *real* DOM to match what you rendered as efficiently as possible.
+
+As a result, when you're building a single page app, you don't have to worry so much about bindings. Instead, you simple re-render to the virtual DOM whenever you know something's changed. All of a sudden being able to have `change` events for individual properties becomes less important, instead you can just reference those values in your template whenever you think something changed.
+
+Cool idea, right?!
+
+## So why this? 
+
+Well, there are other things React expects me to do if I use it that I don't like. Such as the custom templating and syntax you have to use. 
+
+If, hypothetically, you could instead diff an HTML string (generated by *whatever* templating language of your choice) against the DOM, then you'd get the same benefit, sans React's impositions. 
+
+This may all turn out to be a bad idea altogether, but initial results seem promising when paired with [virtual-dom](https://github.com/Matt-Esch/virtual-dom).
+
+But you can't just diff HTML strings, as simple strings, very easily, in order to diff two HTML node trees you have to first turn that string into a tree structure of some sort. Typically, the thing you generate from parsing something like this is called an AST (abstract syntax tree).
+
+This lib does exactly that. 
+
+It has two methods:
+
+1. parse
+2. stringify
+
+## `.parse(htmlString, options)`
+
+Takes a sting of HTML and turns it into an AST, the only option you can currently pass is an object of registered `components` whose children will be ignored when generating the AST.
+
+## `.stringify(AST)`
+
+Takes an AST and turns it back into a string of HTML.
+
+## What does the AST look like?
+
+See comments in the following example:
+
+```js
+var HTML = require('html-parse-stringify')
+
+// this html:
+var html = '<div class="oh"><p>hi</p></div>';
+
+// becomes this AST:
+var ast = HTML.parse(html);
+
+
+console.log(ast);
+/*
+{
+    // can be `tag`, `text` or `component`
+    type: 'tag',
+
+    // name of tag if relevant
+    name: 'div',
+    
+    // parsed attribute object
+    attrs: {
+        class: 'oh'
+    },
+
+    // whether this is a self-closing tag
+    // such as <img/>
+    selfClosing: false,
+
+    // an array of child nodes
+    // we see the same structure
+    // repeated in each of these
+    children: [
+        {
+            type: 'tag',
+            name: 'p',
+            attrs: {},
+            selfClosing: false,
+            children: [
+                // this is a text node
+                // it also has a `type`
+                // but nothing other than
+                // a `content` containing
+                // its text.
+                {
+                    type: 'text',
+                    content: 'hi'
+                }
+            ]
+        }
+    ]
+}
+*/
+```
+
+## the AST node types
+
+### 1. tag
+
+properties:
+
+- `type` - will always be `tag` for this type of node
+- `name` - tag name, such as 'div'
+- `attrs` - an object of key/value pairs. If an attribute has multiple space-separated items such as classes, they'll still be in a single string, for example: `class: "class1 class2"`
+- `selfClosing` - `true` or `false`. Whether this tag has a self-closing slash such as: `<img/>`, or `<input/>`
+- `children` - array of child nodes. Note that any continuous string of text is a text node child, see below.
+
+### 2. text
+
+properties:
+
+- `type` - will always be `text` for this type of node
+- `content` - text content of the node
+
+### 3. component
+
+If you pass an object of `components` as part of the `options` object passed as the second argument to `.parse()` then the AST won't keep parsing that branch of the DOM tree when it one of those registered components.
+
+This is so that it's possible to ignore sections of the tree that you may want to handle by another "subview" in your application that handles it's own DOM diffing.
+
+properties:
+
+- `type` - will always be `component` for this type of node
+- `name` - tag name, such as 'div'
+- `attrs` - an object of key/value pairs. If an attribute has multiple space-separated items such as classes, they'll still be in a single string, for example: `class: "class1 class2"`
+- `selfClosing` - `true` or `false`. Whether this tag has a self-closing slash such as: `<img/>`, or `<input/>`
+- `children` - it will still have a `children` array, but it will always be empty.
+
+
+## license
+
+MIT

index.js

@@ -0,0 +1,8 @@
+var parse = require('./lib/parse');
+var stringify = require('./lib/stringify');
+
+
+module.exports = {
+    parse: parse,
+    stringify: stringify
+};

lib/parse-tag.js

@@ -0,0 +1,29 @@
+var attrRE = /([\w-]+)|['"]{1}([^'"]*)['"]{1}/g;
+
+
+module.exports = function (tag) {
+    var i = 0;
+    var key;
+    var res = {
+        selfClosing: tag.slice(-2, -1) === '/',
+        attrs: {},
+        type: 'tag',
+        children: [],
+        name: ''
+    };
+
+    tag.replace(attrRE, function (match) {
+        if (i % 2) {
+            key = match;
+        } else {
+            if (i === 0) {
+                res.name = match;
+            } else {
+                res.attrs[key] = match.replace(/['"]/g, '');
+            }
+        }
+        i++;
+    });
+
+    return res;
+};

lib/parse.js

@@ -0,0 +1,72 @@
+var tagRE = /<(?:"[^"]*"['"]*|'[^']*'['"]*|[^'">])+>/g;
+var parseTag = require('./parse-tag');
+
+
+module.exports = function parse(html, options) {
+    options = options || {};
+    options.components = options.components || {};
+    var result;
+    var current;
+    var previous;
+    var level = -1;
+    var arr = [];
+    var byTag = {};
+    var inComponent = false;
+
+    html.replace(tagRE, function (tag, index) {
+        if (inComponent && tag !== ('</' + current.name + '>')) {
+            return;
+        }
+        var isOpen = tag.charAt(1) !== '/';
+        var start = index + tag.length;
+        var nextChar = html.charAt(start);
+        var parent;
+        
+        previous = current;
+        
+        if (isOpen) {
+            level++;
+            
+            current = parseTag(tag);
+            if (current.type === 'tag' && options.components[current.name]) {
+                current.type = 'component';
+                inComponent = true;
+            }
+
+            if (nextChar !== '<') {
+                current.children.push({
+                    type: 'text',
+                    content: html.slice(start, html.indexOf('<', start))
+                });
+            }
+
+            byTag[current.tagName] = current;
+
+            // this is our base if we don't already have one
+            if (!previous) {
+                result = current;
+            }
+
+            parent = arr[level - 1];
+
+            if (parent) {
+                parent.children.push(current);
+            }
+
+            arr[level] = current;
+        }
+
+        if (!isOpen || current.selfClosing) {
+            level--;
+            if (!inComponent && nextChar !== '<' && nextChar) {
+                // trailing text node
+                arr[level].children.push({
+                    type: 'text',
+                    content: html.slice(start, html.indexOf('<', start))
+                });
+            }
+        }
+    }); 
+
+    return result;
+};

lib/stringify.js

@@ -0,0 +1,27 @@
+function attrString(attrs) {
+    var buff = [];
+    for (var key in attrs) {
+        buff.push(key + '="' + attrs[key] + '"');
+    }
+    if (!buff.length) {
+        return '';
+    }
+    return ' ' + buff.join(' ');
+}
+
+function stringify(buff, doc) {
+    switch (doc.type) {
+    case 'text':
+        return buff + doc.content;
+    case 'tag':
+        buff += '<' + doc.name + (doc.attrs ? attrString(doc.attrs) : '') + (doc.selfClosing ? '/>' : '>');
+        if (doc.selfClosing) {
+            return buff;
+        }
+        return buff + doc.children.reduce(stringify, '') + '</' + doc.name + '>';
+    }
+}
+
+module.exports = function (doc) {
+    return stringify('', doc);
+};

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "html-parse-stringify",
+  "description": "Parses well-formed HTML (meaning all tags closed) into an AST and back. quickly.",
+  "version": "0.0.0",
+  "author": "Henrik Joreteg <[email protected]>",
+  "bugs": {
+    "url": "https://github.com/henrikjoreteg/html-parse-stringify/issues"
+  },
+  "devDependencies": {
+    "jshint": "^2.5.10",
+    "precommit-hook": "^1.0.7",
+    "tape": "^3.0.3"
+  },
+  "homepage": "https://github.com/henrikjoreteg/html-parse-stringify",
+  "keywords": [
+    "html",
+    "parse",
+    "stringify",
+    "ast"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/henrikjoreteg/html-parse-stringify"
+  },
+  "scripts": {
+    "test": "node test/index.js | tap-spec"
+  }
+}

test/index.js

@@ -0,0 +1,2 @@
+require('./parse-tag');
+require('./parse');