Merge pull request #17 from CleverStack/feature/auto-routing

feature(autoRouting): Added ability to have auto routing and middleware when using autoRouting

Author: pilsy

controller.js

@@ -1,18 +1,78 @@
 /* jshint node: true */
 'use strict';
 
-var NoActionException = require('./exceptions/NoAction'),
-    Class = require('uberclass');
+var NoActionException = require('./exceptions/NoAction')
+  , Class = require( 'uberclass' )
+  , path = require( 'path' );
 
 module.exports = Class.extend(
 /* @Static */
 {
-    actionsEnabled: true,
+    route: false,
 
-    httpMethodsEnabled: true,
+    autoRouting: true,
+
+    actionRouting: true,
+
+    restfulRouting: true,
 
     attach: function() {
-        return this.callback('newInstance');
+        return this.callback( 'newInstance' );
+    },
+
+    setup: function() {
+        var self = this;
+        if ( typeof injector !== 'undefined' && this.autoRouting !== false && this.route !== false ) {
+            injector.inject( function( app ) {
+                self.autoRoute( app );
+            });
+        }
+    },
+
+    autoRoute: function( app ) {
+        var middleware = [];
+
+        if ( this.autoRouting instanceof Array ) {
+            this.autoRouting.forEach(function( mw ) {
+                middleware.push( typeof mw === 'string' ? this.callback( mw ) : mw );
+            }.bind( this ));
+        }
+
+        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?
+    },
+
+    extend: function() {
+        var extendingArgs = [].slice.call( arguments )
+          , stack = new Error().stack.split( '\n' )
+          , stack = stack.splice( 1, stack.length - 1)
+          , extendingFilePath = false
+          , extendingFileName = false
+          , route = null;
+
+        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();
+                }
+            }
+        }
+
+        if ( [ '', 'controller' ].indexOf( extendingFileName ) === -1 && this.route === false ) {
+            route = [ '/', extendingFileName ].join('');
+            // debug( 'Binding automatic route name??' )
+            if ( extendingArgs.length === 2 ) {
+                extendingArgs[ 0 ].route = route;
+            } else {
+                extendingArgs.unshift({ route: route  });
+            }
+        }
+        
+        return this._super.apply( this, extendingArgs );
     }
 },
 /* @Prototype */
@@ -40,7 +100,7 @@ module.exports = Class.extend(
         this.res = res;
 
         // Override routes where you attach specifically to a single route
-        if (this.Class.actionsEnabled && /\//.test(this.req.url)) {
+        if (this.Class.actionRouting && /\//.test(this.req.url)) {
             var parts = this.req.url.split('/');
             funcName = parts[parts.length-1];
 
@@ -57,7 +117,7 @@ module.exports = Class.extend(
         }
 
         // Route based on an action first if we can
-        if (this.Class.actionsEnabled && 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)) {
                 funcName = this.req.params.action + 'Action';
@@ -83,7 +143,7 @@ module.exports = Class.extend(
         }
 
         // Route based on the HTTP Method, otherwise throw an exception
-        if (this.Class.httpMethodsEnabled) {
+        if (this.Class.restfulRouting) {
             if (this.isGet() && (this.req.params === undefined || this.req.params.id === undefined) && typeof this.listAction === 'function') {
                 method = 'listAction';
             } else {

package.json

@@ -1,7 +1,7 @@
 {
     "name": "clever-controller",
     "description": "Lightning-fast flexible controller prototype",
-    "version": "1.0.4",
+    "version": "1.1.0",
     "private": false,
     "repository":
     { 

test/controller.test.js

@@ -131,9 +131,9 @@ describe('Controller', function () {
       c.action.should.equal('removeAction');
     });
 
-    it('should not call action by req.params.action if .actionsEnabled is false', function () {
+    it('should not call action by req.params.action if .actionRouting is false', function () {
       var Ctrl = Controller.extend({
-        actionsEnabled: false
+        actionRouting: false
       }, {
         getAction: null,
         removeAction: sinon.spy()
@@ -152,9 +152,9 @@ describe('Controller', function () {
       next.called.should.be.true;
     });
 
-    it('should not call action by HTTP method if .httpMethodsEnabled is false', function () {
+    it('should not call action by HTTP method if .restfulRouting is false', function () {
       var Ctrl = Controller.extend({
-        httpMethodsEnabled: false
+        restfulRouting: false
       }, {
         getAction: sinon.spy()
       });
@@ -177,7 +177,7 @@ describe('Controller', function () {
 
   it('should call .action if parses URL with query string', function(){
     var Ctrl = Controller.extend({
-       actionsEnabled: true
+       actionRouting: true
     },{ 
       profileAction: sinon.spy()
     });