Added examples

Filled phpDoc
Improved tests

Author: plugowski

README.md

@@ -1,4 +1,4 @@
-# PhpRouter
+# PhpRouter PhpRouter ![alt text](https://img.shields.io/badge/licence-BSD--3--Clause-blue.svg "Licence") ![alt text](https://img.shields.io/badge/tests-19%20%2F%2019-brightgreen.svg "Tests") ![alt text](https://img.shields.io/badge/coverage-100%25-green.svg "Coverage")
 PHP router inspired on FatFree, CakePHP and own invention. 
 
 It allows to use anonymous functions as callback as well as OOP classes and methods. 

examples/.htaccess

@@ -0,0 +1,7 @@
+<IfModule mod_rewrite.c>
+    RewriteEngine on
+    RewriteCond %{REQUEST_FILENAME} !-f
+    RewriteCond %{REQUEST_FILENAME} !-d
+    RewriteCond %{REQUEST_FILENAME} !-l
+    RewriteRule .* example.php?url=$1 [QSA,L]
+</IfModule>

examples/example.php

@@ -0,0 +1,44 @@
+<?php
+require __DIR__ . '../vendor/autoload.php';
+
+use PhpRouter\Route;
+use PhpRouter\RouteCollection;
+use PhpRouter\Router;
+use PhpRouter\RouteRequest;
+
+class A
+{
+    function index()
+    {
+        echo "I am the index!";
+    }
+
+    static function showParams($params)
+    {
+        print_r($params);
+    }
+}
+
+$routing = new RouteCollection();
+
+$routing->attach(new Route('GET /', function(){
+    echo 'Hello World';
+}));
+
+$routing->attach(new Route('GET /page', function(){
+    echo 'Some page...';
+}));
+
+$routing->attach(new Route('GET /page/@id', ['id' => '\d+'], function($params){
+    echo 'Page no. ' . $params['id'];
+}));
+
+$routing->attach(new Route('GET /mac/@mac', ['mac' => '..:..:..:..:..:..'], function($params){
+    echo 'Mac Address: ' . $params['mac'];
+}));
+
+$routing->attach(new Route('GET /index', 'A->index'));
+
+$routing->attach(new Route('GET /index/@data', 'A->showParams'));
+
+(new Router(new RouteRequest(), $routing))->run();

src/Route.php

@@ -112,6 +112,8 @@ private function parseRoute($route)
     }
 
     /**
+     * Build regex, required for Router to check if current path mach
+     *
      * @return string
      */
     private function preparePattern()
@@ -155,7 +157,11 @@ public function getPattern()
         return $this->pattern;
     }
 
-
+    /**
+     * Parse named params and build associative array with them
+     *
+     * @param $requestUrl
+     */
     public function parseParams($requestUrl)
     {
         preg_match($this->getPattern(), $requestUrl, $values);
@@ -164,7 +170,7 @@ public function parseParams($requestUrl)
         unset($values[0]);
         $values = array_values($values);
 
-        if (count($values) != count($names['name']) + 1) {
+        if (count($values) == count($names['name'])) {
             foreach ($names['name'] as $key => $name) {
                 $this->namedParams[$name] = $values[$key];
             }
@@ -188,6 +194,8 @@ public function dispatch()
     }
 
     /**
+     * Call class and method defined as callback
+     *
      * @param string $class
      * @param string $method
      * @param array $params

src/RouteCollection.php

@@ -7,6 +7,8 @@
 class RouteCollection extends RouteIterator
 {
     /**
+     * Attach new Route to the collection
+     *
      * @param Route $route
      */
     public function attach(Route $route)

src/RouteRequest.php

@@ -105,6 +105,8 @@ private function setRequestUrl()
     }
 
     /**
+     * Check if request comes from https or http
+     *
      * @return string
      */
     private function getRequestProtocol()

src/Router.php

@@ -28,6 +28,8 @@ public function __construct(RouteRequest $routeRequest, RouteCollection $routeCo
     }
 
     /**
+     * Run Router and dispatch requested Route
+     *
      * @return mixed
      */
     public function run()
@@ -46,6 +48,8 @@ public function run()
     }
 
     /**
+     * Match if current Route match to the request url, method and type
+     *
      * @param Route $route
      * @return bool
      */

tests/RouteTest.php

@@ -4,6 +4,8 @@
 use PhpRouter\Route;
 use PHPUnit_Framework_TestCase;
 
+require 'Test.php';
+
 /**
  * Class RouteTest
  */
@@ -16,94 +18,87 @@ public function shouldCreateCorrectRouteObject()
     {
         $route = new Route('GET /test/page.html', 'A->index');
 
+        $this->assertEquals('|^/test/page.html$|', $route->getPattern());
         $this->assertEquals(['GET'], $route->getMethods());
-        $this->assertEquals('/test/page.html', $route->getUrl());
         $this->assertEquals('sync', $route->getType());
+        $this->assertEquals('/test/page.html', $route->getUrl());
     }
 
     /**
      * @test
      */
-    public function shouldCreateRouteWithDefiniedNamedParam()
+    public function shouldCreateRouteWithNamedParam()
     {
-        $route = new Route('GET|POST /some_page/@id', ['id' => '\d{2}\-\w{4}'], function($param){
-            return $param['id'];
-        });
+        $route = new Route('GET|POST /some_page/@id', 'A->index');
+        $this->assertEquals('|^/some_page/([\w-]+)$|', $route->getPattern());
+    }
 
-        $route->parseParams('/some_page/12-zaqw');
-        $this->assertEquals('12-zaqw', $route->dispatch());
+    /**
+     * @test
+     */
+    public function shouldCreateRouteWithNamedParamMatchToRegex()
+    {
+        $route = new Route('GET|POST /some_page/@id', ['id' => '[a-z]{2}\-[a-z]{4}'], 'A->index');
+        $this->assertEquals('|^/some_page/([a-z]{2}\-[a-z]{4})$|', $route->getPattern());
     }
 
     /**
      * @test
      */
-    public function shouldThrowWrongCallbackException()
+    public function shouldCallAndExecuteAnonymousFunction()
     {
-        $this->setExpectedException('Exception');
-        $route = new Route('GET /test.html', 'nothingSpecial');
-        $route->dispatch();
+        $route = new Route('GET /test/@data.html [ajax]', ['data' => '[a-z]{2}:[a-z]{3}'], function($params){
+            return $params['data'];
+        });
+
+        $route->parseParams('/test/xx:www.html');
+        $this->assertEquals('xx:www', $route->dispatch());
     }
 
     /**
      * @test
      */
-    public function shouldThrowInvalidRouteException()
+    public function shouldCallSpecifiedCallback()
     {
-        $this->setExpectedException('Exception');
-        new Route('/test.html', 'A->index');
+        $route = new Route('GET /test/page/@number.html', '\PhpRouter\Test\Test->page');
+
+        $route->parseParams('/test/page/42.html');
+        $this->assertEquals(42, $route->dispatch());
     }
 
     /**
      * @test
      */
-    public function shouldThrowInvalidTypeException()
+    public function shouldThrowWrongCallbackException()
     {
         $this->setExpectedException('Exception');
-        new Route('GET /test.html [not_exists]', 'A->index');
+        (new Route('GET /test.html', 'nothingSpecial'))->dispatch();
     }
 
     /**
      * @test
      */
-    public function shouldCallAndExecuteAnonymousFunction()
+    public function shouldThrowInvalidRouteException()
     {
-        $route = new Route('GET /test.html [ajax]', function(){
-            echo 'XXX';
-        });
-
-        ob_start();
-        $route->dispatch();
-        $result = ob_get_clean();
-
-        $this->assertEquals('XXX', $result);
+        $this->setExpectedException('Exception');
+        new Route('/test.html', 'A->index');
     }
 
     /**
      * @test
      */
-    public function shouldThrowClasOrMethodNotFoundException()
+    public function shouldThrowInvalidTypeException()
     {
         $this->setExpectedException('Exception');
-        $route = new Route('GET /test/page.html', 'A->test');
-        $route->dispatch();
+        new Route('GET /test.html [not_exists]', 'A->index');
     }
 
     /**
      * @test
      */
-    public function shouldCallSpecifiedCallback()
+    public function shouldThrowClassOrMethodNotFoundException()
     {
-//        $class = $this->getMockBuilder('Test')->setMethods(['login'])->getMock();
-//
-//        $class->expects($this->any())
-//            ->method('login');
-//
-//        $route = new Route('GET /test/page.html', 'Test->login');
-//
-//        ob_start();
-//        $route->dispatch(['someData']);
-//        $result = ob_get_clean();
-//
-//        $this->assertEquals('logged!', $result);
+        $this->setExpectedException('Exception');
+        (new Route('GET /test/page.html', 'A->test'))->dispatch();
     }
 }

tests/RouterTest.php

@@ -16,14 +16,16 @@ class RouterTest extends PHPUnit_Framework_TestCase
 
     public function setUp()
     {
-        parent::setUp();
-
         $this->collection = new RouteCollection();
-        $this->collection->attach(new Route('DELETE /', function(){ return 1; }));
+        $this->collection->attach(new Route('GET /', function(){ return 1; }));
         $this->collection->attach(new Route('GET /about_me', function(){ return 2; }));
-        $this->collection->attach(new Route('GET /contact', function(){ return 3; }));
-        $this->collection->attach(new Route('GET /contact [ajax]', function(){ return 4; }));
-        $this->collection->attach(new Route('POST /contact [ajax]', function(){ return 4; }));
+        $this->collection->attach(new Route('POST /about_me', function(){ return 3; }));
+        $this->collection->attach(new Route('GET /contact/@id', ['id' => '\w{3}\:\w{3}'], function($p){ return 'regex_' . $p['id']; }));
+        $this->collection->attach(new Route('GET /contact/@id', function($p){ return $p['id']; }));
+        $this->collection->attach(new Route('GET /ajax [ajax]', function(){ return 4; }));
+        $this->collection->attach(new Route('GET /nonajax', function(){ return 5; }));
+
+        parent::setUp();
     }
 
     /**
@@ -35,14 +37,19 @@ public function shouldMatchRouteAndDispatch()
         $router = new Router($request, $this->collection);
 
         $this->assertEquals(2, $router->run());
+
+        $request = $this->getRequestMock('POST', '/about_me');
+        $router = new Router($request, $this->collection);
+
+        $this->assertEquals(3, $router->run());
     }
 
     /**
      * @test
      */
-    public function shouldMismatchAjaxRoute()
+    public function shouldCallAjaxRouteWithAjaxFalse()
     {
-        $request = $this->getRequestMock('GET', '/contacts', true);
+        $request = $this->getRequestMock('GET', '/ajax');
         $router = new Router($request, $this->collection);
 
         $this->assertNull($router->run());
@@ -51,14 +58,41 @@ public function shouldMismatchAjaxRoute()
     /**
      * @test
      */
-    public function shouldMatchAjaxRoute()
+    public function shouldCallAjaxRouteWithAjaxTrue()
     {
-        $request = $this->getRequestMock('POST', '/contact', true);
+        $request = $this->getRequestMock('GET', '/ajax', true);
         $router = new Router($request, $this->collection);
 
         $this->assertEquals(4, $router->run());
     }
 
+    /**
+     * @test
+     */
+    public function shouldCallNonAjaxRouteWithAjax()
+    {
+        $request = $this->getRequestMock('GET', '/nonajax', true);
+        $router = new Router($request, $this->collection);
+
+        $this->assertEquals(5, $router->run());
+    }
+
+    /**
+     * @test
+     */
+    public function shouldCallRouteWithParam()
+    {
+        $request = $this->getRequestMock('GET', '/contact/test_123');
+        $router = new Router($request, $this->collection);
+
+        $this->assertEquals('test_123', $router->run());
+
+        $request = $this->getRequestMock('GET', '/contact/xxx:xxx');
+        $router = new Router($request, $this->collection);
+
+        $this->assertEquals('regex_xxx:xxx', $router->run());
+    }
+
     /**
      * @param string $method
      * @param string $url

tests/Test.php

@@ -0,0 +1,14 @@
+<?php
+namespace PhpRouter\Test;
+
+/**
+ * Class Test
+ * @package PhpRouter\Test
+ */
+class Test
+{
+    public function page($params)
+    {
+        return $params['number'];
+    }
+}