fix(autoRouting): Fixed bug with autoRouting and expanded to allow use without clever-injector

chore(cleanup): Fixed indentation etc

Author: pilsy

controller.js

@@ -3,7 +3,11 @@
 
 var NoActionException = require('./exceptions/NoAction')
   , Class = require( 'uberclass' )
-  , path = require( 'path' );
+  , path = require( 'path' )
+  , util = require( 'util' )
+  , i = require( 'i' )()
+  , debug = require( 'debug' )( 'clever-controller' )
+  , routedControllers = [];
 
 module.exports = Class.extend(
 /* @Static */
@@ -22,57 +26,92 @@ module.exports = Class.extend(
 
     setup: function() {
         var self = this;
-        if ( typeof injector !== 'undefined' && this.autoRouting !== false && this.route !== false ) {
-            injector.inject( function( app ) {
-                self.autoRoute( app );
-            });
+        if ( this.autoRouting !== false && this.route !== false && routedControllers.indexOf( this.route ) === -1 ) {
+            // Do not route multiple times
+            routedControllers.push( this.route );
+            
+            if ( typeof this.app !== 'undefined' ) {
+
+                // app has been provided for us in the Static of this Controller so we can attach our routes to it
+                this.autoRoute( this.app );
+
+            } else if ( typeof injector !== 'undefined' ) {
+                
+                // Use the clever-injector to get the express app so we can attach our routes to it
+                injector.inject( function( app ) {
+                    self.autoRoute( app );
+                });
+
+            }
         }
     },
 
     autoRoute: function( app ) {
-        var middleware = [];
+        var middleware = []
+          , routes = this.route.split( '|' )
+        
+        debug( 'Autorouting for route ' + routes.join( ', ' ) );
 
+        // Check for middleware that we need to put before the actual attach()
         if ( this.autoRouting instanceof Array ) {
+            debug( 'Found middleware for ' + routes.join( ', ' ) + ' - ' + util.inspect( this.autoRouting ).replace( /\n/ig, ' ' )  );
+
             this.autoRouting.forEach(function( mw ) {
                 middleware.push( typeof mw === 'string' ? this.callback( mw ) : mw );
             }.bind( this ));
         }
 
+        // Add our attach() function
         middleware.push( this.attach() );
 
-        app.all.apply( app, [ [ this.route, ':action', ':id?' ].join( '/' ) ].concat( middleware ) ); // /example/:action/:id?
-        app.all.apply( app, [ [ this.route, ':action?' ].join( '/' ) ].concat( middleware ) ); // /example/?:action?
+        // Bind the actual routes
+        routes.forEach(function( route ) {
+            var actionIdRoute = [ route, ':action', ':id?' ].join( '/' )
+              , actionRoute = [ route, ':action?' ].join( '/' );
+
+            debug( 'Attaching route ' + actionIdRoute );
+            app.all.apply( app, [ actionIdRoute ].concat( middleware ) ); // /example/:action/:id?
+            
+            debug( 'Attaching route ' + actionRoute );
+            app.all.apply( app, [ actionRoute ].concat( middleware ) ); // /example/?:action?
+        });
     },
 
     extend: function() {
         var extendingArgs = [].slice.call( arguments )
           , autoRouting = ( extendingArgs.length === 2 )
                 ? extendingArgs[ 0 ].autoRouting !== false
-                : false
+                : this.autoRouting
           , definedRoute = ( extendingArgs.length === 2 )
                 ? extendingArgs[ 0 ].route !== undefined
-                : false;
+                : this.route;
 
+        // Figure out if we are autoRouting and do not have a defined route already
         if ( autoRouting && !definedRoute ) {
             var stack = new Error().stack.split( '\n' )
-              , stack = stack.splice( 1, stack.length - 1)
+              , stack = stack.splice( 1, stack.length - 1 )
               , extendingFilePath = false
               , extendingFileName = false
               , route = null;
 
+            // Walk backwards over the stack to find the filename where this is defined
             while( stack.length > 0 && extendingFilePath === false ) {
                 var file = stack.shift();
                 if ( !/clever-controller/ig.test( file ) && !/uberclass/ig.test( file ) ) {
                     if ( /\(([^\[\:]+).*\)/ig.test( file ) ) {
                         extendingFilePath = RegExp.$1;
-                        extendingFileName = path.basename( extendingFilePath ).replace( /(controller)?.js/ig, '' ).toLowerCase();
+                        extendingFileName = path.basename( extendingFilePath );
                     }
                 }
             }
 
-            if ( [ '', 'controller' ].indexOf( extendingFileName ) === -1 && this.route === false ) {
-                route = [ '/', extendingFileName ].join('');
-                // debug( 'Binding automatic route name??' )
+            // Determine the route names if we have found a file
+            if ( [ '', 'controller.js' ].indexOf( extendingFileName.toLowerCase() ) === -1 ) {
+                var singular = i.singularize( extendingFileName.replace( /(controller)?.js/ig, '' ).toLowerCase() )
+                  , plural = i.pluralize( singular );
+
+                route = [ '/', singular, '|', '/', plural ].join('');
+
                 if ( extendingArgs.length === 2 ) {
                     extendingArgs[ 0 ].route = route;
                 } else {
@@ -81,7 +120,7 @@ module.exports = Class.extend(
             }
         }
 
-        
+        // Call extend on the parent
         return this._super.apply( this, extendingArgs );
     }
 },
@@ -95,115 +134,128 @@ module.exports = Class.extend(
 
     setup: function(req, res, next) {
         try {
-            return this.performanceSafeSetup(req, res, next);
-        } catch(e) {
-            return [e];
+            return this.performanceSafeSetup( req, res, next );
+        } catch( e ) {
+            return [ e ];
         }
     },
 
-    performanceSafeSetup: function(req, res, next) {
-        var method = null,
-            funcName = null;
+    performanceSafeSetup: function( req, res, next ) {
+        var method = null
+          , funcName = null
+          , parts = null;
 
         this.next = next;
         this.req = req;
         this.res = res;
 
         // Override routes where you attach specifically to a single route
-        if (this.Class.actionRouting && /\//.test(this.req.url)) {
-            var parts = this.req.url.split('/');
-            funcName = parts[parts.length-1];
+        if ( this.Class.actionRouting && /\//.test( this.req.url ) ) {
+            parts = this.req.url.split( '/' );
+            funcName = parts[ parts.length - 1 ];
 
             if(/\#|\?/.test(funcName)){
-                funcName = funcName.split(/\#|\?/)[0];
+                funcName = funcName.split( /\#|\?/ )[ 0 ];
             }
 
-            if (isNaN(funcName)) {
+            if ( isNaN( funcName ) ) {
                 funcName = funcName + 'Action';
-                if (typeof this[funcName] == 'function') {
-                    return [null, funcName, next];
+                if ( typeof this[ funcName ] == 'function' ) {
+                    debug( 'actionRouting mapped to ' + funcName );
+
+                    return [ null, funcName, next ];
                 }
             }
         }
 
         // Route based on an action first if we can
-        if (this.Class.actionRouting && typeof this.req.params !== 'undefined' && typeof this.req.params.action !== 'undefined') {
+        if ( this.Class.actionRouting && typeof this.req.params !== 'undefined' && typeof this.req.params.action !== 'undefined' ) {
             // Action Defined Routing
-            if (isNaN(this.req.params.action)) {
+            if ( isNaN( this.req.params.action ) ) {
                 funcName = this.req.params.action + 'Action';
 
-                if (typeof this[funcName] == 'function') {
-                    return [null, funcName, next];
+                if ( typeof this[ funcName ] == 'function' ) {
+                    debug( 'actionRouting mapped to ' + funcName );
+                    return [ null, funcName, next ];
                 } else {
                     throw new NoActionException();
                 }
             } else {
                 // HTTP Method Based Routing
                 method = this.req.method.toLowerCase() + 'Action';
-                if (typeof this[method] == 'function') {
+                if ( typeof this[ method ] == 'function' ) {
+                    debug( 'http method route mapped to ' + method );
 
                     this.req.params.id = this.req.params.action;
                     delete this.req.params.action;
 
-                    return [null, method, next];
+                    return [ null, method, next ];
                 } else {
                     throw new NoActionException();
                 }
             }
         }
 
         // Route based on the HTTP Method, otherwise throw an exception
-        if (this.Class.restfulRouting) {
-            if (this.isGet() && (this.req.params === undefined || this.req.params.id === undefined) && typeof this.listAction === 'function') {
+        if ( this.Class.restfulRouting ) {
+            if ( this.isGet() && ( this.req.params === undefined || this.req.params.id === undefined ) && typeof this.listAction === 'function' ) {
                 method = 'listAction';
+
+                debug( 'restfulRouting mapped to ' + method );
             } else {
                 method = this.req.method.toLowerCase() + 'Action';
-                if (typeof this[method] != 'function') {
+                if ( typeof this[ method ] != 'function' ) {
                     throw new NoActionException();
                 }
+
+                debug( 'restfulRouting mapped to ' + method );
             }
         }
 
         // If we got this far without an action but with a method, then route based on that
-        return [null, method, next];
+        return [ null, method, next ];
     },
 
-    init: function(error, method, next) {
-        if (error && error instanceof NoActionException) {
+    init: function( error, method, next ) {
+        if ( error && error instanceof NoActionException ) {
+            debug( 'No route mapping found, calling next()' );
+
             this.next();
         } else {
             try {
-                if (error)
+                if ( error )
                     throw error;
 
-                if (method !== null) {
+                if ( method !== null ) {
                     this.action = method;
-                    this[method](this.req, this.res);
+
+                    debug( 'calling ' + this.action );
+                    this[ method ]( this.req, this.res );
                 } else {
                     this.next();
                 }
 
-            } catch(e) {
-                this.handleException(e);
+            } catch( e ) {
+                this.handleException( e );
             }
         }
     },
 
-    send: function(content, code, type) {
+    send: function( content, code, type ) {
         var toCall = type || this.resFunc;
-        if (code) {
-            this.res[toCall](code, content);
+        if ( code ) {
+            this.res[ toCall ]( code, content );
         } else {
-            this.res[toCall](content);
+            this.res[ toCall ]( content );
         }
     },
 
-    render: function(template, data) {
-        this.res.render(template, data);
+    render: function( template, data ) {
+        this.res.render( template, data );
     },
 
-    handleException: function(exception) {
-        this.send({ error: 'Unhandled exception: ' + exception, stack: exception.stack }, 500);
+    handleException: function( exception ) {
+        this.send( { error: 'Unhandled exception: ' + exception, stack: exception.stack }, 500 );
     },
 
     isGet: function() {

package.json

@@ -1,30 +1,31 @@
 {
-    "name": "clever-controller",
-    "description": "Lightning-fast flexible controller prototype",
-    "version": "1.1.1",
-    "private": false,
-    "repository":
-    { 
-        "type" : "git", 
-        "url" : "http://github.com/CleverStack/clever-controller.git"
-    },
-    "scripts": {
-        "test": "mocha --require should --reporter spec"
-    },
-    "dependencies": {
-        "uberclass": ""
-    },
-    "devDependencies": {
-        "mocha": "*",
-        "should": "*",
-        "sinon": "*"
-    },
-    "author": {
-        "name": "Richard Gustin (PilsY)",
-        "email": "[email protected]"
-    },
-    "keywords": [
-        "controller",
-        "cleverstack"
-    ]
+  "name": "clever-controller",
+  "description": "Lightning-fast flexible controller prototype",
+  "version": "1.1.2",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "http://github.com/CleverStack/clever-controller.git"
+  },
+  "scripts": {
+    "test": "mocha --require should --reporter spec"
+  },
+  "dependencies": {
+    "debug": "^0.8.1",
+    "i": "^0.3.2",
+    "uberclass": ""
+  },
+  "devDependencies": {
+    "mocha": "*",
+    "should": "*",
+    "sinon": "*"
+  },
+  "author": {
+    "name": "Richard Gustin (PilsY)",
+    "email": "[email protected]"
+  },
+  "keywords": [
+    "controller",
+    "cleverstack"
+  ]
 }