Merge pull request #9 from bit-docs/refactor

Generate nested TOC based on heading hierarchy

Author: matthewp

.editorconfig

@@ -3,4 +3,8 @@
 end_of_line = LF
 indent_style = tab
 trim_trailing_whitespace = false
-insert_final_newline = true
+insert_final_newline = true
+
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2

.jshintrc

@@ -0,0 +1,27 @@
+{
+	"curly": true,
+	"eqeqeq": true,
+	"freeze": true,
+	"noarg": true,
+	"undef": true,
+	"unused": "vars",
+	"trailing": true,
+	"maxdepth": 4,
+	"boss" : true,
+
+	"esnext": true,
+	"eqnull": true,
+	"evil": true,
+	"loopfunc": true,
+	"smarttabs": true,
+	"maxerr" : 200,
+
+	"browser": true,
+	"phantom": true,
+	"node": true,
+
+	"globals": {
+		"describe": true,
+		"it": true
+	}
+}

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js: node
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

bit-docs.js

@@ -1,8 +1,8 @@
-var path = require("path");
 var tags = require("./tags");
 
-module.exports = function(bitDocs){
+module.exports = function(bitDocs) {
 	var pkg = require("./package.json");
+
 	var dependencies = {};
 	dependencies[pkg.name] = pkg.version;
 
@@ -11,4 +11,4 @@ module.exports = function(bitDocs){
 	});
 
 	bitDocs.register("tags", tags);
-}
+};

make-tree.js

@@ -0,0 +1,89 @@
+module.exports = function makeTree(elements) {
+	var treeData = makeTreeData(elements || []);
+	var rootNode = { level: 0, children: [] };
+
+	var tree = rootNode.children;
+	var lastNode;
+
+	treeData.forEach(function(node) {
+		node.children = [];
+
+		if (!lastNode) {
+			tree.push(node);
+		}
+		else if (node.level === lastNode.level) {
+			findParentNode(lastNode, rootNode).children.push(node);
+		}
+		else if (node.level > lastNode.level) {
+			lastNode.children.push(node);
+		}
+		else {
+			findAncestorOfLevel(node.level, lastNode, rootNode).children.push(node);
+		}
+
+		lastNode = node;
+	});
+
+	return tree;
+};
+
+function findParentNode(needle, haystack) {
+	var parent;
+
+	if (haystack.children.indexOf(needle) !== -1) {
+		return haystack;
+	}
+
+	for (var i = 0; i < haystack.children.length; i += 1) {
+		parent = findParentNode(needle, haystack.children[i]);
+ 		if (parent) { break; }
+	}
+
+	return parent;
+}
+
+function findAncestorOfLevel(level, needle, haystack) {
+	var parent = findParentNode(needle, haystack);
+
+	return (parent.level < level) ?
+		parent :
+		findAncestorOfLevel(level, parent, haystack);
+}
+
+function makeHeadingId(text) {
+	return (text || "")
+		.replace(/\s/g, "-")      // replace spaces with dashes
+		.replace(/[^\w\-]/g, "")  // remove punctuation
+		.toLowerCase();
+}
+
+function makeTreeData(elements) {
+	var ids = {};
+	var map = [].map;
+
+	return map.call(elements, function(element) {
+		var text = element.textContent;
+		var id = makeHeadingId(text);
+		var level = getElementLevel(element);
+
+		// generate unique id for elements with same text
+		var count = ids[id] || 0;
+		var uniq = count > 0 ? id + "-" + count : id;
+		ids[id] = count + 1;
+
+		return { id: uniq, text: text, level: level };
+	});
+}
+
+function getElementLevel(element) {
+	var defaultLevel = 2;
+	var tagName = element.tagName.toLowerCase();
+	var headingTagNames = ["h1", "h2", "h3", "h4", "h5", "h6"];
+
+	if (headingTagNames.indexOf(tagName) !== -1) {
+		return parseInt(tagName.slice(1), 10);
+	}
+
+	// default value if not a heading tag
+	return defaultLevel;
+}

package.json

@@ -4,7 +4,8 @@
   "description": "table of contents bit-docs plugin",
   "main": "toc.js",
   "scripts": {
-    "test": "echo 'testing'",
+    "jshint": "jshint *.js --config .jshintrc",
+    "test": "npm run jshint && mocha --reporter spec",
     "postversion": "git push --tags && git push",
     "release:pre": "npm version prerelease && npm publish",
     "release:patch": "npm version patch && npm publish",
@@ -13,21 +14,23 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bit-docs/bit-docs-prettify.git"
+    "url": "git+https://github.com/bit-docs/bit-docs-html-toc.git"
   },
   "keywords": [
     "bit-docs"
   ],
   "author": "Bitovi",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/bit-docs/bit-docs-prettify/issues"
+    "url": "https://github.com/bit-docs/bit-docs-html-toc/issues"
   },
-  "homepage": "https://github.com/bit-docs/bit-docs-prettify#readme",
+  "homepage": "https://github.com/bit-docs/bit-docs-html-toc#readme",
   "system": {},
   "dependencies": {
     "can-control": "^3.0.0-pre.5",
-    "can-stache": "^3.0.0-pre.11",
-    "can-stache-bindings": "^3.0.0-pre.8"
+    "can-stache": "^3.0.0-pre.11"
+  },
+  "devDependencies": {
+    "mocha": "^3.1.2"
   }
 }

test.js

@@ -0,0 +1,57 @@
+var assert = require("assert");
+var makeTree = require("../make-tree");
+
+describe("makeTree", function() {
+	it("makes flat trees based on heading tag names", function() {
+		var elements = [
+			{ tagName: "h2", textContent: "Usage" },
+			{ tagName: "h2", textContent: "Install" },
+			{ tagName: "h2", textContent: "Configure" },
+			{ tagName: "h2", textContent: "Configure" }
+		];
+
+		assert.deepEqual(makeTree(elements), [
+			{ id: "usage", level: 2, text: "Usage", children: [] },
+			{ id: "install", level: 2, text: "Install", children: [] },
+			{ id: "configure", level: 2, text: "Configure", children: [] },
+			{ id: "configure-1", level: 2, text: "Configure", children: [] }
+		]);
+	});
+
+	it("nests trees based on headings hierarchy", function() {
+		var elements = [
+			{ tagName: "h2", textContent: "Bower" },
+			{ tagName: "h3", textContent: "Install" },
+			{ tagName: "h2", textContent: "NPM" },
+			{ tagName: "h3", textContent: "Install" },
+			{ tagName: "h4", textContent: "Specifying components folder" },
+			{ tagName: "h2", textContent: "Writing Modules" }
+		];
+
+		assert.deepEqual(makeTree(elements), [
+			{ id: "bower",
+				level: 2,
+				text: "Bower",
+				children: [
+					{ id: "install", level: 3, text: "Install", children: [] }
+				]
+			},
+			{ id: "npm",
+				level: 2,
+				text: "NPM",
+				children: [
+					{ id: "install-1", level: 3, text: "Install",
+						children: [
+							{ id: "specifying-components-folder",
+								level: 4,
+								text: "Specifying components folder",
+								children: []
+							}
+						]
+					}
+				]
+			},
+			{ id: "writing-modules", level: 2, text: "Writing Modules", children: [] }
+		]);
+	});
+});