routey/routey.js

Simple convention over configuration route setup for Express/NodeJS

'use strict';

//
// Params
// 	config				-> Routey configuration.
//
// 		routeConfigPath -> Directory that contains route definitions.
//		urlRoot			-> Route path for route URLs.
//		verbose			-> Enable verbose logging so you can see what is happening.
//	
//	app				-> Express application object for route setup.
//
module.exports = function (config, app) {

    if (!config) {
        throw new Error("config is undefined.");
    }

    if (!config.routeConfigPath) {
        throw new Error("'routeConfigPath' must be defined on config object.");   
    }

    if (!app) {
        throw new Error("Express app is undefined.")
    }

	var path = require('path');
	var RouteInitalizer = require('./route_init');

	var routeInitalizer = new RouteInitalizer(config, app);


    var defaultParentRoute = '/';
    var parentRoute = config.parentRoute || defaultParentRoute;

    var fullPath = path.resolve(config.routeConfigPath);

	var routeConfigDir = {
        name: path.basename(fullPath),
        path: fullPath,
        parentRoute: parentRoute,
        config: {},
        parent: null,
        handlerParams: config.handlerParams || {},
        handlerConfig: config.handlerConfig || {},
    };

    routeInitalizer._processDirectory(routeConfigDir);
};