New grunt task build-categories creates dist/taxonomies.json from categories xml

Author: rdworth

grunt.js

@@ -5,9 +5,17 @@ var // modules
 	fs = require( "fs" ),
 	path = require( "path" ),
 	spawn = require( "child_process" ).spawn,
+	libxmljs = require( "libxmljs" ),
 
 	// files
-	entryFiles = grunt.file.expandFiles( "entries/*.xml" );
+	entryFiles = grunt.file.expandFiles( "entries/*.xml" ),
+	categoryFiles = grunt.file.expandFiles( "categories/*.xml" ),
+	
+	xmlFiles = [].concat( entryFiles, categoryFiles );
+	
+function pathSlug( fileName ) {
+	return path.basename( fileName, path.extname( fileName ) );
+}
 
 grunt.loadNpmTasks( "grunt-wordpress" );
 
@@ -16,15 +24,15 @@ grunt.initConfig({
 		grunt: "grunt.js"
 	},
 	xmllint: {
-		all: entryFiles
+		all: xmlFiles
 	},
 	wordpress: grunt.file.readJSON( "config.json" )
 });
 
 grunt.registerTask( "xmllint", function() {
 	var task = this,
 		taskDone = task.async();
-	grunt.utils.async.forEachSeries( entryFiles, function( fileName, fileDone ) {
+	grunt.utils.async.forEachSeries( xmlFiles, function( fileName, fileDone ) {
 		grunt.verbose.write( "Linting " + fileName + "..." );
 		grunt.utils.spawn({
 			cmd: "xmllint",
@@ -74,17 +82,8 @@ grunt.registerTask( "build-entries", function() {
 			grunt.verbose.ok();
 			targetFileName = targetDir + path.basename( fileName );
 			targetFileName = targetFileName.substr( 0, targetFileName.length - "xml".length ) + "html";
-			grunt.verbose.write( "Writing " + targetFileName + "..." );
-			fs.writeFile( targetFileName, result, function( err ) {
-				if ( err ) {
-					grunt.verbose.error();
-					grunt.log.error( err );
-					fileDone();
-					return;
-				}
-				grunt.verbose.ok();
-				fileDone();				
-			});
+			grunt.file.write( targetFileName, result );
+			fileDone();				
 		});
 	}, function() {
 		if ( task.errorCount ) {
@@ -97,8 +96,110 @@ grunt.registerTask( "build-entries", function() {
 	});
 });
 
+grunt.registerTask( "build-categories", function() {
+	var task = this,
+		taskDone = task.async(),
+		categories = {},
+		outFilename = "dist/taxonomies.json";
+
+	grunt.utils.async.forEachSeries( categoryFiles, function( fileName, fileDone ) {
+		var xml = grunt.file.read( fileName ),
+			xmlDoc = libxmljs.parseXmlString( xml ),
+			id = xmlDoc.get( "//category/@id" ).text(),
+			parent = xmlDoc.get( "//category/@parent" ).text(),
+			name = xmlDoc.get( "//category/@name" ).text(),
+			slug = xmlDoc.get( "//category/@slug" ).text(),
+			desc = xmlDoc.get( "//category/desc" ).text(),
+			fileNameSlug = pathSlug( fileName ),
+			errors = [];
+
+		grunt.verbose.write( "Validating " + fileName + "..." );
+		if ( slug !== fileNameSlug ) {
+			errors.push( "slug attribute (" + slug + ") doesn't match filename slug (" + fileNameSlug + ")" );
+		}
+		if ( errors.length ) {
+			grunt.verbose.error();
+			errors.forEach(function( error ) {
+				grunt.log.error( error );
+			});
+			fileDone();
+			return;
+		}
+		grunt.verbose.ok();
+
+		categories[id] = {
+			id: id,
+			name: name,
+			parent: parent,
+			slug: slug,
+			desc: desc,
+			children: []
+		};
+		
+		fileDone();
+	}, function() {
+		if ( task.errorCount ) {
+			grunt.warn( "Task \"" + task.name + "\" failed." );
+			taskDone();
+			return;
+		}
+
+		var id, category, parent,
+			taxonomies = {
+				"category": [
+					{ "name": "Uncategorized" }
+				]
+			};
+		
+		function catTree( id ) {
+			var category = categories[ id ];
+			var cat = {
+				name: category.name
+			};
+			if ( category.slug.length ) {
+				cat.slug = category.slug;
+			}
+			if ( category.desc.length ) {
+				cat.description = category.desc;
+			}
+			if ( category.children.length ) {
+				cat.children = [];
+				category.children.forEach(function( childId ){
+					cat.children.push( catTree( childId ) );
+				});
+			}
+			return cat;
+		}
+		
+		for ( id in categories ) {
+			category = categories[ id ];
+			parent = categories[ category.parent ];
+			if ( parent ) {
+				grunt.verbose.write( "Making " + category.name + " a child category of " + parent.name + "..." );
+				parent.children.push( id );
+			} else {
+				grunt.verbose.write( "Making " + category.name + " a top-level category..." );
+				category.parent = undefined;
+			}
+			grunt.verbose.ok();
+		}
+		
+		for ( id in categories ) {
+			category = categories[ id ];
+			if ( !category.parent ) {
+				taxonomies.category.push( catTree( id ) );
+			}
+		}
+
+		grunt.file.write( outFilename, JSON.stringify( taxonomies ) );
+		
+		grunt.log.writeln( "Built " + categoryFiles.length + " categories to " + outFilename + "." );
+		taskDone();
+	});
+});
+
 grunt.registerTask( "default", "build" );
-grunt.registerTask( "build", "lint xmllint build-entries" );
+grunt.registerTask( "build", "lint xmllint build-entries build-categories" );
 grunt.registerTask( "deploy", "wordpress-deploy" );
 
 };

package.json

@@ -22,7 +22,8 @@
   ],
   "dependencies": {
     "grunt": "0.3.x",
-    "grunt-wordpress": "0.0.3"
+    "grunt-wordpress": "0.0.3",
+    "libxmljs": "~0.5.4"
   },
   "devDependencies": {},
   "keywords": []