Merge pull request #19 from yaworsw/master

Better RESTful routing
fortrabbit · Jan 8, 2014 · e0109b9 · e0109b9
2 parents 186c951 + 1374b34
commit e0109b9
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 16 deletions.
diff --git a/README.markdown b/README.markdown
@@ -107,6 +107,28 @@ Minimal bootstrap file for this example
 
 ## Configuration
 
+### RESTful Routing
+
+You can define the http method that routes use by adding it to the beginning of the route and separating the http method and the path by a space (or any whitespace char(s) [space, tab, newline]).
+
+    $app->addRoutes(array(
+        '/'               => 'Home:index',
+        'get /posts'      => 'Posts:index',
+        'get /posts/:id'  => 'Posts:show',
+        'post /posts'     => 'Posts:create'
+    ));
+
+Leading spaces in routes are ignored and all spaces in between the http method and the route are ignored so that you can have sexy indenting like this:
+
+    $app->addRoutes(array(
+        '     /'           => 'Home:index',
+        'get  /posts'      => 'Posts:index',
+        'get  /posts/:id'  => 'Posts:show',
+        'post /posts'      => 'Posts:create'
+    ));
+
+If you don't specify an http method then that route will work with any http method.
+
 ### controller.class_prefix
 
 Optional class prefix for controller classes. Will be prepended to routes.
@@ -162,9 +184,8 @@ Defaults to `twig`. Will be appended to template name given in `render()` method
                 error_log("ADDITIONAL MIDDLWARE FOR SINGLE ROUTE");
             }
         ),
-        '/hello/:name' => array(
+        'post /hello/:name' => array(
             'Home:hello',
-            'post',
             function() {
                 error_log("THIS ROUTE IS ONLY POST");
             }

diff --git a/src/SlimController/Slim.php b/src/SlimController/Slim.php
@@ -69,8 +69,17 @@ public function addRoutes(array $routes, $middlewares = null)
         array_shift($args);
         $middlewares = $args;
 
-        foreach ($routes as $path => $routeArgs) {
-            $httpMethod = 'any';
+        foreach ($routes as $p => $routeArgs) {
+            $path       = $p;
+            $httpMethod = null;
+
+            if (preg_match('/^\s*(?P<method>[\S]+)\s+(?P<path>.+)$/', $path, $matches)) {
+                $httpMethod = strtoupper($matches['method']);
+                $path       = $matches['path'];
+                if (!in_array($httpMethod, static::$ALLOWED_HTTP_METHODS)) {
+                    throw new \InvalidArgumentException("Http method '$httpMethod' is not supported.");
+                }
+            }
 
             // simple
             if (!is_array($routeArgs)) {
@@ -79,18 +88,10 @@ public function addRoutes(array $routes, $middlewares = null)
 
             $classRoute = array_shift($routeArgs);
 
-            // specific HTTP method
-            if (count($routeArgs) > 0 && is_string($routeArgs[0])) {
-                $httpMethod = strtoupper(array_shift($routeArgs));
-                if (!in_array($httpMethod, static::$ALLOWED_HTTP_METHODS)) {
-                    throw new \InvalidArgumentException("Http method '$httpMethod' is not supported.");
-                }
-            }
-
             $routeMiddlewares = array_merge($routeArgs, $middlewares);
             $route            = $this->addControllerRoute($path, $classRoute, $routeMiddlewares)->name($classRoute);
 
-            if ('any' === $httpMethod) {
+            if (is_null($httpMethod)) {
                 call_user_func_array(array($route, 'via'), static::$ALLOWED_HTTP_METHODS);
             } else {
                 $route->via($httpMethod);

diff --git a/tests/SlimController/Tests/SlimTest.php b/tests/SlimController/Tests/SlimTest.php
@@ -37,11 +37,22 @@ public function testAddRoutesWithVariables()
         $this->assertEquals(1, count($this->app->router()->getMatchedRoutes($this->req->getMethod(), $this->req->getResourceUri())));
     }
 
-    public function testAddRoutesInExtendedFormat()
+    public function testAddRoutesInRestFormat()
     {
         $this->setUrl('/bla');
         $this->app->addRoutes(array(
-            '/bla' => array('Controller:index', 'get')
+            'get /bla' => 'Controller:index'
+        ));
+        $this->assertEquals(1, count($this->app->router()->getMatchedRoutes($this->req->getMethod(), $this->req->getResourceUri())));
+    }
+
+    public function testAddRoutesInRestFormatWithMultipleWhiteSpaceChars()
+    {
+        $this->setUrl('/bla');
+        $this->app->addRoutes(array(
+            '   get
+
+     		/bla' => 'Controller:index'
         ));
         $this->assertEquals(1, count($this->app->router()->getMatchedRoutes($this->req->getMethod(), $this->req->getResourceUri())));
     }
@@ -124,7 +135,7 @@ public function testFailToAddRouteForUnsupportedHttpMethod()
     {
         $this->setUrl('/bla');
         $this->app->addRoutes(array(
-            '/bla' => array('Controller:index', 'foo')
+            'foo /bla' => 'Controller:index'
         ));
     }