Merge pull request #8 from bit-docs/add-search-map

Add searchMap for a more efficient search object

Author: garrettreed

generate.js

@@ -48,12 +48,16 @@ module.exports = function(docMapPromise, siteConfig){
 	var helpersReadyPromise = docMapPromise.then(function(docMap){
 		return build.helpers(buildTemplatesPromise, docMap, siteConfig, getCurrent);
 	});
+	var searchMapPromise = docMapPromise.then(function(docMap){
+		return write.searchMap(docMap, siteConfig);
+	});
 
 	var docsPromise = Q.all([
 			docMapPromise,
 			build.renderer(buildTemplatesPromise, siteConfig),
 			helpersReadyPromise,
-			mkdirs(siteConfig.dest)
+			mkdirs(siteConfig.dest),
+			searchMapPromise
 	]).then(function(results){
 		var docMap = results[0],
 			renderer = results[1];

write/search_map.js

@@ -0,0 +1,39 @@
+var fs = require('fs'),
+	path = require('path'),
+	filename = require("./filename"),
+	Q = require('q'),
+	writeFile = Q.denodeify(fs.writeFile);
+
+/**
+ * @function bitDocs.generators.html.write.searchMap
+ * @parent bitDocs.generators.html.write.methods
+ *
+ * Writes out a simplified [documentjs.process.docMap docMap] to be used for searching.
+ *
+ * @signature `.write.searchMap(docMap, siteConfig)`
+ *
+ * @param {documentjs.process.docMap} docMap
+ * @param {Object} siteConfig
+ * @return {Promise} Resolves when searchMap has been written.
+ */
+module.exports = function(docMap, siteConfig) {
+	var searchMap = {},
+		name;
+
+	for (name in docMap) {
+		if (docMap.hasOwnProperty(name)) {
+			var docObj = docMap[name];
+			var searchObj = {
+				name: docObj.name,
+				title: docObj.title,
+				description: docObj.description,
+				url: filename(docObj, siteConfig)
+			};
+			searchMap[name] = searchObj;
+		}
+	}
+
+	var dest = path.join(siteConfig.dest, 'searchMap.json');
+
+	return writeFile(dest, JSON.stringify(searchMap));
+};

write/write.js

@@ -1,16 +1,17 @@
 /**
  * @property {{}} documentjs.generators.html.write
  * @parent documentjs.generators.html.properties
- * 
+ *
  * @group documentjs.generators.html.write.methods 0 methods
- * 
+ *
  * A collection of helpers used to write out docObject and docMaps
  * using the structures produced by [documentjs.generators.html.build].
- * 
+ *
  * @body
- * 
+ *
  */
 
 exports.docMap = require("./doc_map");
 exports.docObject = require("./doc_object");
-exports.staticDist = require("./static_dist");
+exports.staticDist = require("./static_dist");
+exports.searchMap = require("./search_map");