From 70c88027db5c5d586d689d310572f8f34d10b285 Mon Sep 17 00:00:00 2001
From: Bernhard Posselt <dev@bernhard-posselt.com>
Date: Wed, 9 Apr 2014 21:57:32 +0200
Subject: [PATCH] add requirements to routing

---
 .../appframework/routing/routeconfig.php      | 10 ++++++-
 .../lib/appframework/routing/RoutingTest.php  | 26 ++++++++++++++++---
 2 files changed, 31 insertions(+), 5 deletions(-)

diff --git a/lib/private/appframework/routing/routeconfig.php b/lib/private/appframework/routing/routeconfig.php
index 35bee75cc4..a3bbde6af5 100644
--- a/lib/private/appframework/routing/routeconfig.php
+++ b/lib/private/appframework/routing/routeconfig.php
@@ -84,7 +84,15 @@ class RouteConfig {
 
 			// register the route
 			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
-			$this->router->create($this->appName.'.'.$controller.'.'.$action, $url)->method($verb)->action($handler);
+			$router = $this->router->create($this->appName.'.'.$controller.'.'.$action, $url)
+							->method($verb)
+							->action($handler);
+
+			// optionally register requirements for route. This is used to 
+			// tell the route parser how url parameters should be matched
+			if(array_key_exists('requirements', $simpleRoute)) {
+				$router->requirements($simpleRoute['requirements']);
+			}
 		}
 	}
 
diff --git a/tests/lib/appframework/routing/RoutingTest.php b/tests/lib/appframework/routing/RoutingTest.php
index 735dd7cef4..261ab0b26a 100644
--- a/tests/lib/appframework/routing/RoutingTest.php
+++ b/tests/lib/appframework/routing/RoutingTest.php
@@ -36,6 +36,16 @@ class RouteConfigTest extends \PHPUnit_Framework_TestCase
 		$this->assertSimpleRoute($routes, 'folders.open', 'DELETE', '/folders/{folderId}/open', 'FoldersController', 'open');
 	}
 
+	public function testSimpleRouteWithRequirements()
+	{
+		$routes = array('routes' => array(
+			array('name' => 'folders#open', 'url' => '/folders/{folderId}/open', 'verb' => 'delete', 'requirements' => array('something'))
+		));
+
+		$this->assertSimpleRoute($routes, 'folders.open', 'DELETE', '/folders/{folderId}/open', 'FoldersController', 'open', array('something'));
+	}
+
+
 	/**
 	 * @expectedException \UnexpectedValueException
 	 */
@@ -85,10 +95,10 @@ class RouteConfigTest extends \PHPUnit_Framework_TestCase
 	 * @param string $controllerName
 	 * @param string $actionName
 	 */
-	private function assertSimpleRoute($routes, $name, $verb, $url, $controllerName, $actionName)
+	private function assertSimpleRoute($routes, $name, $verb, $url, $controllerName, $actionName, array $requirements=array())
 	{
 		// route mocks
-		$route = $this->mockRoute($verb, $controllerName, $actionName);
+		$route = $this->mockRoute($verb, $controllerName, $actionName, $requirements);
 
 		// router mock
 		$router = $this->getMock("\OC\Route\Router", array('create'));
@@ -171,10 +181,10 @@ class RouteConfigTest extends \PHPUnit_Framework_TestCase
 	 * @param string $actionName
 	 * @return \PHPUnit_Framework_MockObject_MockObject
 	 */
-	private function mockRoute($verb, $controllerName, $actionName)
+	private function mockRoute($verb, $controllerName, $actionName, array $requirements=array())
 	{
 		$container = new DIContainer('app1');
-		$route = $this->getMock("\OC\Route\Route", array('method', 'action'), array(), '', false);
+		$route = $this->getMock("\OC\Route\Route", array('method', 'action', 'requirements'), array(), '', false);
 		$route
 			->expects($this->exactly(1))
 			->method('method')
@@ -186,6 +196,14 @@ class RouteConfigTest extends \PHPUnit_Framework_TestCase
 			->method('action')
 			->with($this->equalTo(new RouteActionHandler($container, $controllerName, $actionName)))
 			->will($this->returnValue($route));
+
+		if(count($requirements) > 0) {
+			$route
+				->expects($this->exactly(1))
+				->method('requirements')
+				->with($this->equalTo($requirements))
+				->will($this->returnValue($route));
+		}
 		return $route;
 	}