Merge pull request #30 from bit-docs/29-create-docmap-hash

#29 create docmap hash file

Author: mickmcgrath13

generate.js

@@ -51,13 +51,17 @@ module.exports = function(docMapPromise, siteConfig){
 	var searchMapPromise = docMapPromise.then(function(docMap){
 		return write.searchMap(docMap, siteConfig);
 	});
+	var searchMapHashPromise = searchMapPromise.then(function(searchMap){
+		return write.docMapHash(searchMap, siteConfig);
+	});
 
 	var docsPromise = Q.all([
 			docMapPromise,
 			build.renderer(buildTemplatesPromise, siteConfig),
 			helpersReadyPromise,
 			mkdirs(siteConfig.dest),
-			searchMapPromise
+			searchMapPromise,
+			searchMapHashPromise
 	]).then(function(results){
 		var docMap = results[0],
 			renderer = results[1];

write/doc_map_hash.js

@@ -0,0 +1,33 @@
+var fs = require('fs'),
+	path = require('path'),
+	Q = require('q'),
+	writeFile = Q.denodeify(fs.writeFile),
+	mkdirs = Q.denodeify(require("fs-extra").mkdirs),
+	md5 = require('md5');
+
+/**
+ * @function bitDocs.generators.html.write.docMapHash
+ * @parent bitDocs.generators.html.write.methods
+ *
+ * Writes out file containing an md5 hash of a docMap-like object
+ *  (docMap or subset of a docMap)
+ *
+ * @signature `.write.docMapHash(docMap, siteConfig)`
+ *
+ * @param {documentjs.process.docMap} docMap
+ * @param {Object} siteConfig
+ * @return {Promise} Resolves when docMapHash has been written.
+ */
+module.exports = function(docMap, siteConfig) {
+	var docMapHashConfig = {
+				hash: md5(JSON.stringify(docMap))
+			},
+			dest = path.join(siteConfig.dest, 'docMapHash.json');
+			
+	return mkdirs(siteConfig.dest).then(function(){
+		return writeFile(dest, JSON.stringify(docMapHashConfig)).then(function(){
+			return docMapHashConfig;
+		});
+	});
+
+};

write/search_map.js

@@ -38,7 +38,9 @@ module.exports = function(docMap, siteConfig) {
 	var dest = path.join(siteConfig.dest, 'searchMap.json');
 
 	return mkdirs(siteConfig.dest).then(function(){
-		return writeFile(dest, JSON.stringify(searchMap));
+		return writeFile(dest, JSON.stringify(searchMap)).then(function(){
+			return searchMap;
+		});
 	});
 
 };

write/write.js

@@ -15,3 +15,4 @@ exports.docMap = require("./doc_map");
 exports.docObject = require("./doc_object");
 exports.staticDist = require("./static_dist");
 exports.searchMap = require("./search_map");
+exports.docMapHash = require("./doc_map_hash");