Merge pull request #5 from hjylewis/master

[redirectTo] new arguments

Author: karlhepler

README.md

@@ -51,126 +51,138 @@ var app = angular.module('app', [
  */
 app.config(['$middlewareProvider',
 function($middlewareProvider)] {
-	
+
 	// If you want middleware,
 	// then you need to map some middleware
 	// functions to names that you can
 	// reference in your routes
 	$middlewareProvider.map({
-	
+
 		/** Don't allow anyone through */
 		'nobody': function nobodyMiddleware() {
 			//
 		},
-		
+
 		/** Let everyone through */
 		'everyone': function everyoneMiddleware() {
 			// In order to resolve the middleware,
 			// you MUST call this.next()
 			this.next();
 		},
-		
+
 		/** Redirect everyone */
 		'redirect-all': function redirectAllMiddleware() {
 			// If you are using ui.router,
 			// then you must choose a state name
 			this.redirectTo('another-state-name');
-			
+
 			// If you are using ngRoute,
 			// then you must actually put in
 			// the new url that you would use in
 			// $location.path()
 			this.redirectTo('/another-path');
+
+			// An object of parameters can also
+			// be provided which will be used to
+			// populate the url query parameters
+			// ex. /another-path?redirectFrom=current-path
+			this.redirectTo('/another-path', {
+				redirectFrom: 'current-path'
+			});
+
+			// If you are using ui.router,
+			// you can also change transitionTo options
+			this.redirectTo('another-state-name', null, { reload: false });
 		},
-		
+
 		/** Continue, but log the parameters */
 		'log': ['$log', function logMiddleware($log) {
 			// Notice that we used dependency injection to get $log.
 			// You have access to the route parameters with this.params
 			$log.debug(this.params);
-			
+
 			// Keep on truckin'
 			this.next();
 		}],
-		
+
 		/** It will wait for async requests too! */
 		'async-auth': ['$http', function asyncAuth($http) {
 			// We'll need access to "this" in a deeper context
 			var request = this;
-			
+
 			// Grab something from the server
 			$http.get('/verify')
-			
+
 			// The server has responded!
 			.then(function success(res) {
 				if ( res.isVerified ) {
 					return request.next();
 				}
-				
+
 				request.redirectTo('another-state-or-path');
 			},
-			
+
 			function fail(err) {
 				request.redirectTo('another-state-or-path');
 			});
 		}]
-		
+
 	});
-	
+
 });
 
 /**
  * Now you're ready to use your middleware!
  * All you have to do is put them in your routes.
  * Each middleware is processed in the order you list them.
- * 
+ *
  * The principle is the same for ui.router and ngRoute.
  * I'll show you both to make sure the dead horse is sufficiently beaten.
  */
- 
+
  /** ui.router */
  app.config(['$stateProvider', function($stateProvider) {
  	$stateProvider
- 	
+
  	// You can have just one middleware,
  	// represented by a string
  	.state('my-state-name', {
  		...
  		middleware: 'a-single-middleware'
  	})
- 	
+
  	// You can have multiple middleware
  	// separated by pipes. aka. |
  	.state('another-state-name', {
  		...
  		middleware: 'one-middleware|another-middleware'
  	})
- 	
+
  	// You can have multiple middleware as an array
  	.state('a-third-state-name', {
  		...
  		middleware: ['one-middleware', 'another-middleware', 'another-nother-middleware']
  	})
  }]);
- 
+
  /** ngRoute */
  app.config(['$routeProvider', function($routeProvider) {
  	$routeProvider
- 	
+
  	// You can have just one middleware,
  	// represented by a string
  	.when('/my-path', {
  		...
  		middleware: 'a-single-middleware'
  	})
- 	
+
  	// You can have multiple middleware
  	// separated by pipes. aka. |
  	.when('/my-other-path', {
  		...
  		middleware: 'one-middleware|another-middleware'
  	})
- 	
+
  	// You can have multiple middleware as an array
  	.when('/my-third-path', {
  		...
@@ -195,6 +207,11 @@ function($middlewareProvider)] {
 
 * `this.next()` **must be called** to resolve the middleware and either go to the next middleware or resolve the route
 
-* `this.redirectTo(<string>)` can be called to immediately redirect to a given path _(ngRoute)_ or state name _(ui.router)_
+* `this.redirectTo(dest [,params [,options]])` can be called to immediately redirect
+	* **dest** (required): A path _(ngRoute)_ or state name _(ui.router)_ to redirect to
+	* **params** (optional): A params object to be used to populate query parameters _(ngRoute)_ or `$stateParams` _(ui.router)_
+	* **options** (optional): An object of  [transitionTo](https://github.com/angular-ui/ui-router/wiki/Quick-Reference#statetransitiontoto-toparams--options) options (only used with ui.router)
+
+* `this.route` is the destination route path
 
 * `this.params` is an object that contains the current route parameters

dist/angular-middleware.js

@@ -13,7 +13,7 @@ var _globalMiddleware = {
 var $middlewareFactory = [
 '$injector', '$q',
 function middlewareFactory($injector, $q) {
-	
+
 	/**
 	 * This object is used to group
 	 * private middleware properties
@@ -49,6 +49,9 @@ function middlewareFactory($injector, $q) {
 		// Store a copy of the route parameters in the request
 		request.params = angular.copy(toParams);
 
+		// Store route name in the request
+		request.route = toRoute.name;
+
 		// Set the middleware index to 0
 		middleware.index = 0;
 
@@ -108,7 +111,7 @@ function middlewareFactory($injector, $q) {
 
 	/**
 	 * Gets the route middleware property
-	 * 
+	 *
 	 * @param   {object} route
 	 * @returns {array|string}
    */
@@ -197,8 +200,13 @@ function middlewareFactory($injector, $q) {
 	 *
 	 * @returns {void}
 	 */
-	function redirectTo(route) {
-		middleware.resolution.reject('redirectTo:' + route);
+	function redirectTo(route, params, options) {
+		middleware.resolution.reject({
+			type: "redirectTo",
+			route: route,
+			params: params,
+			options: options
+		});
 	}
 }];
 
@@ -280,21 +288,19 @@ function handleMiddleware($rootScope, $route, $location, $middleware) {
 	 * Handle redirects from middleware
 	 */
 	$rootScope.$on('$routeChangeError', function handleMiddlewareRedirects(event, current, previous, rejection) {
-		var pattern = /redirectTo\:(.*)/; 
-		var match;
-
-		// Only proceed if there is a match to the pattern
-		if ((match = pattern.exec(rejection)) !== null) {
+		// Only proceed if it is type redirectTo
+		if (rejection.type === "redirectTo") {
 			// Prevent the route change from working normally
 			event.preventDefault();
 
 			// If the redirect route is the same, then just reload
-			if ( current.regexp.test(match[1]) ) {
+			if ( current.regexp.test(rejection.route) ) {
 				return $route.reload();
 			}
 
 			// The path is new, so go there!
-			$location.path(match[1]);
+			$location.path(rejection.route);
+			if (rejection.params) $location.search(rejection.params);
 		}
 	});
 }]);
@@ -329,23 +335,23 @@ function handleMiddleware($rootScope, $state, $middleware) {
 	 * Handle redirects from middleware
 	 */
 	$rootScope.$on('$stateChangeError', function handleMiddlewareRedirects(event, toState, toParams, fromState, fromParams, error) {
-		var pattern = /redirectTo\:(.*)/; 
-		var match;
-
-		// Only proceed if there is a match to the pattern
-		if ((match = pattern.exec(error)) !== null) {
+		// Only proceed if it is type redirectTo
+		if (error.type === "redirectTo") {
 			// Prevent state change error from working normally
 			event.preventDefault();
-			
-			// Redirect, allowing reloading and preventing url param inheritance
-			// https://github.com/angular-ui/ui-router/wiki/Quick-Reference#statetransitiontoto-toparams--options
-			return $state.transitionTo(match[1], null, {
+
+			// Use provided transitionTo options or use default
+			var options = error.options || {
 				location: true,
 				inherit: false,
 				relative: $state.$current,
 				notify: true,
 				reload: true
-			});
+			};
+
+			// Redirect, allowing reloading and preventing url param inheritance
+			// https://github.com/angular-ui/ui-router/wiki/Quick-Reference#statetransitiontoto-toparams--options
+			return $state.transitionTo(error.route, error.params, options);
 		}
 	});
 }]);

dist/angular-middleware.min.js

@@ -10,7 +10,7 @@ var _globalMiddleware = {
 var $middlewareFactory = [
 '$injector', '$q',
 function middlewareFactory($injector, $q) {
-	
+
 	/**
 	 * This object is used to group
 	 * private middleware properties
@@ -46,6 +46,9 @@ function middlewareFactory($injector, $q) {
 		// Store a copy of the route parameters in the request
 		request.params = angular.copy(toParams);
 
+		// Store route name in the request
+		request.route = toRoute.name;
+
 		// Set the middleware index to 0
 		middleware.index = 0;
 
@@ -105,7 +108,7 @@ function middlewareFactory($injector, $q) {
 
 	/**
 	 * Gets the route middleware property
-	 * 
+	 *
 	 * @param   {object} route
 	 * @returns {array|string}
    */
@@ -194,7 +197,12 @@ function middlewareFactory($injector, $q) {
 	 *
 	 * @returns {void}
 	 */
-	function redirectTo(route) {
-		middleware.resolution.reject('redirectTo:' + route);
+	function redirectTo(route, params, options) {
+		middleware.resolution.reject({
+			type: "redirectTo",
+			route: route,
+			params: params,
+			options: options
+		});
 	}
 }];

src/middleware.factory.js

@@ -28,21 +28,19 @@ function handleMiddleware($rootScope, $route, $location, $middleware) {
 	 * Handle redirects from middleware
 	 */
 	$rootScope.$on('$routeChangeError', function handleMiddlewareRedirects(event, current, previous, rejection) {
-		var pattern = /redirectTo\:(.*)/; 
-		var match;
-
-		// Only proceed if there is a match to the pattern
-		if ((match = pattern.exec(rejection)) !== null) {
+		// Only proceed if it is type redirectTo
+		if (rejection.type === "redirectTo") {
 			// Prevent the route change from working normally
 			event.preventDefault();
 
 			// If the redirect route is the same, then just reload
-			if ( current.regexp.test(match[1]) ) {
+			if ( current.regexp.test(rejection.route) ) {
 				return $route.reload();
 			}
 
 			// The path is new, so go there!
-			$location.path(match[1]);
+			$location.path(rejection.route);
+			if (rejection.params) $location.search(rejection.params);
 		}
 	});
 }]);

src/routers/ngRoute.js

@@ -28,23 +28,23 @@ function handleMiddleware($rootScope, $state, $middleware) {
 	 * Handle redirects from middleware
 	 */
 	$rootScope.$on('$stateChangeError', function handleMiddlewareRedirects(event, toState, toParams, fromState, fromParams, error) {
-		var pattern = /redirectTo\:(.*)/; 
-		var match;
-
-		// Only proceed if there is a match to the pattern
-		if ((match = pattern.exec(error)) !== null) {
+		// Only proceed if it is type redirectTo
+		if (error.type === "redirectTo") {
 			// Prevent state change error from working normally
 			event.preventDefault();
-			
-			// Redirect, allowing reloading and preventing url param inheritance
-			// https://github.com/angular-ui/ui-router/wiki/Quick-Reference#statetransitiontoto-toparams--options
-			return $state.transitionTo(match[1], null, {
+
+			// Use provided transitionTo options or use default
+			var options = error.options || {
 				location: true,
 				inherit: false,
 				relative: $state.$current,
 				notify: true,
 				reload: true
-			});
+			};
+
+			// Redirect, allowing reloading and preventing url param inheritance
+			// https://github.com/angular-ui/ui-router/wiki/Quick-Reference#statetransitiontoto-toparams--options
+			return $state.transitionTo(error.route, error.params, options);
 		}
 	});
 }]);