HakimCh / Router

src/Tests/RouterTest.php

Indentation +277 added lines, -277 removed lines

@@ -11,338 +11,338 @@
 
 class RouterTest extends PHPUnit_Framework_TestCase
 {
-    /**
-     * @var Router
-     */
-    protected $router;
-    protected $closure;
+	/**
+	 * @var Router
+	 */
+	protected $router;
+	protected $closure;
 
-    /**
-     * Sets up the fixture, for example, opens a network connection.
-     * This method is called before a test is executed.
-     */
-    protected function setUp()
-    {
-        $parser = new RouterParser();
-        $this->router  = new Router($parser, [], '', []);
-        $this->closure = function () {
-        };
-    }
+	/**
+	 * Sets up the fixture, for example, opens a network connection.
+	 * This method is called before a test is executed.
+	 */
+	protected function setUp()
+	{
+		$parser = new RouterParser();
+		$this->router  = new Router($parser, [], '', []);
+		$this->closure = function () {
+		};
+	}
 
-    /**
-     * @covers Router::getRoutes
-     */
-    public function testMapAndGetRoutes()
-    {
-        $route = ['POST', '/[:controller]/[:action]', $this->closure, null];
+	/**
+	 * @covers Router::getRoutes
+	 */
+	public function testMapAndGetRoutes()
+	{
+		$route = ['POST', '/[:controller]/[:action]', $this->closure, null];
 
-        call_user_func_array([$this->router, 'map'], $route);
+		call_user_func_array([$this->router, 'map'], $route);
 
-        $routes = $this->router->getRoutes();
+		$routes = $this->router->getRoutes();
 
-        $this->assertInternalType('array', $routes);
-        $this->assertEquals([$route], $routes);
-    }
+		$this->assertInternalType('array', $routes);
+		$this->assertEquals([$route], $routes);
+	}
 
-    /**
-     * @covers Router::setRoutes
-     */
-    public function testAddRoutesWithArrayArgument()
-    {
-        $route1 = ['POST', '/[:controller]/[:action]', $this->closure, null];
-        $route2 = ['POST', '/[:controller]/[:action]', $this->closure, 'second_route'];
+	/**
+	 * @covers Router::setRoutes
+	 */
+	public function testAddRoutesWithArrayArgument()
+	{
+		$route1 = ['POST', '/[:controller]/[:action]', $this->closure, null];
+		$route2 = ['POST', '/[:controller]/[:action]', $this->closure, 'second_route'];
 
-        $this->router->setRoutes([$route1, $route2]);
+		$this->router->setRoutes([$route1, $route2]);
         
-        $routes = $this->router->getRoutes();
+		$routes = $this->router->getRoutes();
         
-        $this->assertEquals($route1, $routes[0]);
-        $this->assertEquals($route2, $routes[1]);
-    }
+		$this->assertEquals($route1, $routes[0]);
+		$this->assertEquals($route2, $routes[1]);
+	}
 
-    /**
-     * @covers Router::setRoutes
-     */
-    public function testAddRoutesWithTraversableArgument()
-    {
-        $traversable = new SimpleTraversable();
-        $this->router->setRoutes($traversable);
+	/**
+	 * @covers Router::setRoutes
+	 */
+	public function testAddRoutesWithTraversableArgument()
+	{
+		$traversable = new SimpleTraversable();
+		$this->router->setRoutes($traversable);
         
-        $traversable->rewind();
+		$traversable->rewind();
         
-        $first = $traversable->current();
-        $traversable->next();
-        $second = $traversable->current();
+		$first = $traversable->current();
+		$traversable->next();
+		$second = $traversable->current();
         
-        $routes = $this->router->getRoutes();
+		$routes = $this->router->getRoutes();
         
-        $this->assertEquals($first, $routes[0]);
-        $this->assertEquals($second, $routes[1]);
-    }
+		$this->assertEquals($first, $routes[0]);
+		$this->assertEquals($second, $routes[1]);
+	}
 
-    /**
-     * @covers Router::setRoutes
-     */
-    public function testAddRoutesWidthInvalidArgument()
-    {
-        try {
-            $this->router->setRoutes(new stdClass);
-        } catch (RouterException $e) {
-            $this->assertEquals('Routes should be an array or an instance of Iterator', $e->getMessage());
-        }
-    }
+	/**
+	 * @covers Router::setRoutes
+	 */
+	public function testAddRoutesWidthInvalidArgument()
+	{
+		try {
+			$this->router->setRoutes(new stdClass);
+		} catch (RouterException $e) {
+			$this->assertEquals('Routes should be an array or an instance of Iterator', $e->getMessage());
+		}
+	}
 
-    /**
-     * @covers Router::setBasePath
-     */
-    public function testSetBasePath()
-    {
-        $this->router->setBasePath('/some/path');
-        $this->assertEquals('/some/path', $this->router->getBasePath());
-    }
+	/**
+	 * @covers Router::setBasePath
+	 */
+	public function testSetBasePath()
+	{
+		$this->router->setBasePath('/some/path');
+		$this->assertEquals('/some/path', $this->router->getBasePath());
+	}
 
-    /**
-     * @covers Router::map
-     */
-    public function testMapWithName()
-    {
-        $route = ['POST', '/[:controller]/[:action]', $this->closure, 'my_route'];
+	/**
+	 * @covers Router::map
+	 */
+	public function testMapWithName()
+	{
+		$route = ['POST', '/[:controller]/[:action]', $this->closure, 'my_route'];
 
-        call_user_func_array([$this->router, 'map'], $route);
+		call_user_func_array([$this->router, 'map'], $route);
 
-        $routes = $this->router->getRoutes();
-        $namedRoutes = $this->router->getNamedRoutes();
+		$routes = $this->router->getRoutes();
+		$namedRoutes = $this->router->getNamedRoutes();
 
-        $this->assertInternalType('array', $routes);
-        $this->assertEquals($route, $routes[0]);
+		$this->assertInternalType('array', $routes);
+		$this->assertEquals($route, $routes[0]);
 
-        $this->assertInternalType('array', $namedRoutes);
-        $this->assertEquals('/[:controller]/[:action]', $namedRoutes['my_route']);
-    }
+		$this->assertInternalType('array', $namedRoutes);
+		$this->assertEquals('/[:controller]/[:action]', $namedRoutes['my_route']);
+	}
 
-    /**
-     * @covers Router::map
-     */
-    public function testMapWithDuplicatedRouteName()
-    {
-        try {
-            $route = ['POST', '/[:controller]/[:action]', $this->closure, 'my_route'];
-            call_user_func_array([$this->router, 'map'], $route);
-            call_user_func_array([$this->router, 'map'], $route);
-        } catch (Exception $e) {
-            $this->assertEquals("Can not redeclare route 'my_route'", $e->getMessage());
-        }
-    }
+	/**
+	 * @covers Router::map
+	 */
+	public function testMapWithDuplicatedRouteName()
+	{
+		try {
+			$route = ['POST', '/[:controller]/[:action]', $this->closure, 'my_route'];
+			call_user_func_array([$this->router, 'map'], $route);
+			call_user_func_array([$this->router, 'map'], $route);
+		} catch (Exception $e) {
+			$this->assertEquals("Can not redeclare route 'my_route'", $e->getMessage());
+		}
+	}
 
-    /**
-     * @covers Router::generate
-     */
-    public function testGenerate()
-    {
-        $params1 = ['controller' => 'test', 'action' => 'someaction'];
-        $params2 = ['controller' => 'test', 'action' => 'someaction', 'type' => 'json'];
+	/**
+	 * @covers Router::generate
+	 */
+	public function testGenerate()
+	{
+		$params1 = ['controller' => 'test', 'action' => 'someaction'];
+		$params2 = ['controller' => 'test', 'action' => 'someaction', 'type' => 'json'];
 
-        $this->router->map('GET', '/[:controller]/[:action]', $this->closure, 'foo_route');
+		$this->router->map('GET', '/[:controller]/[:action]', $this->closure, 'foo_route');
         
-        $this->assertEquals('/test/someaction', $this->router->generate('foo_route', $params1));
-        $this->assertEquals('/test/someaction', $this->router->generate('foo_route', $params2));
-    }
+		$this->assertEquals('/test/someaction', $this->router->generate('foo_route', $params1));
+		$this->assertEquals('/test/someaction', $this->router->generate('foo_route', $params2));
+	}
 
-    /**
-     * @covers Router::generate
-     */
-    public function testGenerateWithOptionalUrlParts()
-    {
-        $params1 = ['controller' => 'test', 'action' => 'someaction'];
-        $params2 = ['controller' => 'test', 'action' => 'someaction', 'type' => 'json'];
+	/**
+	 * @covers Router::generate
+	 */
+	public function testGenerateWithOptionalUrlParts()
+	{
+		$params1 = ['controller' => 'test', 'action' => 'someaction'];
+		$params2 = ['controller' => 'test', 'action' => 'someaction', 'type' => 'json'];
 
-        $this->router->map('GET', '/[:controller]/[:action].[:type]?', $this->closure, 'bar_route');
+		$this->router->map('GET', '/[:controller]/[:action].[:type]?', $this->closure, 'bar_route');
         
-        $this->assertEquals('/test/someaction', $this->router->generate('bar_route', $params1));
-        $this->assertEquals('/test/someaction.json', $this->router->generate('bar_route', $params2));
-    }
+		$this->assertEquals('/test/someaction', $this->router->generate('bar_route', $params1));
+		$this->assertEquals('/test/someaction.json', $this->router->generate('bar_route', $params2));
+	}
 
-    /**
-     * @covers Router::generate
-     */
-    public function testGenerateWithNonExistingRoute()
-    {
-        try {
-            $this->router->generate('non_existing_route');
-        } catch (Exception $e) {
-            $this->assertEquals("Route 'non_existing_route' does not exist.", $e->getMessage());
-        }
-    }
+	/**
+	 * @covers Router::generate
+	 */
+	public function testGenerateWithNonExistingRoute()
+	{
+		try {
+			$this->router->generate('non_existing_route');
+		} catch (Exception $e) {
+			$this->assertEquals("Route 'non_existing_route' does not exist.", $e->getMessage());
+		}
+	}
     
-    /**
-     * @covers Router::match
-     * @covers Router::compileRoute
-     */
-    public function testMatch()
-    {
-        $params = [
-            'target' => 'foo_action',
-            'params' => ['controller' => 'test', 'action' => 'do'],
-            'name'   => 'foo_route'
-        ];
+	/**
+	 * @covers Router::match
+	 * @covers Router::compileRoute
+	 */
+	public function testMatch()
+	{
+		$params = [
+			'target' => 'foo_action',
+			'params' => ['controller' => 'test', 'action' => 'do'],
+			'name'   => 'foo_route'
+		];
 
-        $this->router->map('GET', '/foo/[:controller]/[:action]', 'foo_action', 'foo_route');
+		$this->router->map('GET', '/foo/[:controller]/[:action]', 'foo_action', 'foo_route');
         
-        $this->assertEquals($params, $this->router->match('/foo/test/do', 'GET'));
-        $this->assertSame(false, $this->router->match('/foo/test/do', 'POST'));
-        $this->assertEquals($params, $this->router->match('/foo/test/do?param=value', 'GET'));
-    }
+		$this->assertEquals($params, $this->router->match('/foo/test/do', 'GET'));
+		$this->assertSame(false, $this->router->match('/foo/test/do', 'POST'));
+		$this->assertEquals($params, $this->router->match('/foo/test/do?param=value', 'GET'));
+	}
     
-    public function testMatchWithFixedParamValues()
-    {
-        $params = [
-            'target' => 'usersController#doAction',
-            'params' => ['id' => 1, 'action' => 'delete'],
-            'name' => 'users_do'
-        ];
+	public function testMatchWithFixedParamValues()
+	{
+		$params = [
+			'target' => 'usersController#doAction',
+			'params' => ['id' => 1, 'action' => 'delete'],
+			'name' => 'users_do'
+		];
 
-        $this->router->map('POST', '/users/[i:id]/[delete|update:action]', 'usersController#doAction', 'users_do');
+		$this->router->map('POST', '/users/[i:id]/[delete|update:action]', 'usersController#doAction', 'users_do');
         
-        $this->assertEquals($params, $this->router->match('/users/1/delete', 'POST'));
-        $this->assertFalse($this->router->match('/users/1/delete', 'GET'));
-        $this->assertFalse($this->router->match('/users/abc/delete', 'POST'));
-        $this->assertFalse($this->router->match('/users/1/create', 'GET'));
-    }
+		$this->assertEquals($params, $this->router->match('/users/1/delete', 'POST'));
+		$this->assertFalse($this->router->match('/users/1/delete', 'GET'));
+		$this->assertFalse($this->router->match('/users/abc/delete', 'POST'));
+		$this->assertFalse($this->router->match('/users/1/create', 'GET'));
+	}
     
-    public function testMatchWithServerVars()
-    {
-        $this->router->map('GET', '/foo/[:controller]/[:action]', 'foo_action', 'foo_route');
+	public function testMatchWithServerVars()
+	{
+		$this->router->map('GET', '/foo/[:controller]/[:action]', 'foo_action', 'foo_route');
         
-        $this->router->setServer([
-            'REQUEST_URI' => '/foo/test/do',
-            'REQUEST_METHOD' => 'GET'
-        ]);
+		$this->router->setServer([
+			'REQUEST_URI' => '/foo/test/do',
+			'REQUEST_METHOD' => 'GET'
+		]);
         
-        $this->assertEquals(array(
-            'target' => 'foo_action',
-            'params' => array(
-                'controller' => 'test',
-                'action' => 'do'
-            ),
-            'name' => 'foo_route'
-        ), $this->router->match());
-    }
+		$this->assertEquals(array(
+			'target' => 'foo_action',
+			'params' => array(
+				'controller' => 'test',
+				'action' => 'do'
+			),
+			'name' => 'foo_route'
+		), $this->router->match());
+	}
     
-    public function testMatchWithOptionalUrlParts()
-    {
-        $this->router->map('GET', '/bar/[:controller]/[:action].[:type]?', 'bar_action', 'bar_route');
+	public function testMatchWithOptionalUrlParts()
+	{
+		$this->router->map('GET', '/bar/[:controller]/[:action].[:type]?', 'bar_action', 'bar_route');
         
-        $this->assertEquals(array(
-            'target' => 'bar_action',
-            'params' => array(
-                'controller' => 'test',
-                'action' => 'do',
-                'type' => 'json'
-            ),
-            'name' => 'bar_route'
-        ), $this->router->match('/bar/test/do.json', 'GET'));
-    }
+		$this->assertEquals(array(
+			'target' => 'bar_action',
+			'params' => array(
+				'controller' => 'test',
+				'action' => 'do',
+				'type' => 'json'
+			),
+			'name' => 'bar_route'
+		), $this->router->match('/bar/test/do.json', 'GET'));
+	}
     
-    public function testMatchWithWildcard()
-    {
-        $this->router->map('GET', '/a', 'foo_action', 'foo_route');
-        $this->router->map('GET', '*', 'bar_action', 'bar_route');
+	public function testMatchWithWildcard()
+	{
+		$this->router->map('GET', '/a', 'foo_action', 'foo_route');
+		$this->router->map('GET', '*', 'bar_action', 'bar_route');
         
-        $this->assertEquals(array(
-            'target' => 'bar_action',
-            'params' => array(),
-            'name' => 'bar_route'
-        ), $this->router->match('/everything', 'GET'));
-    }
+		$this->assertEquals(array(
+			'target' => 'bar_action',
+			'params' => array(),
+			'name' => 'bar_route'
+		), $this->router->match('/everything', 'GET'));
+	}
     
-    public function testMatchWithCustomRegexp()
-    {
-        $this->router->map('GET', '@^/[a-z]*$', 'bar_action', 'bar_route');
+	public function testMatchWithCustomRegexp()
+	{
+		$this->router->map('GET', '@^/[a-z]*$', 'bar_action', 'bar_route');
         
-        $this->assertEquals(array(
-            'target' => 'bar_action',
-            'params' => array(),
-            'name' => 'bar_route'
-        ), $this->router->match('/everything', 'GET'));
+		$this->assertEquals(array(
+			'target' => 'bar_action',
+			'params' => array(),
+			'name' => 'bar_route'
+		), $this->router->match('/everything', 'GET'));
         
-        $this->assertFalse($this->router->match('/some-other-thing', 'GET'));
-    }
+		$this->assertFalse($this->router->match('/some-other-thing', 'GET'));
+	}
 
-    public function testMatchWithUnicodeRegex()
-    {
-        $pattern = '/(?<path>[^';
-        // Arabic characters
-        $pattern .= '\x{0600}-\x{06FF}';
-        $pattern .= '\x{FB50}-\x{FDFD}';
-        $pattern .= '\x{FE70}-\x{FEFF}';
-        $pattern .= '\x{0750}-\x{077F}';
-        // Alphanumeric, /, _, - and space characters
-        $pattern .= 'a-zA-Z0-9\/_\-\s';
-        // 'ZERO WIDTH NON-JOINER'
-        $pattern .= '\x{200C}';
-        $pattern .= ']+)';
+	public function testMatchWithUnicodeRegex()
+	{
+		$pattern = '/(?<path>[^';
+		// Arabic characters
+		$pattern .= '\x{0600}-\x{06FF}';
+		$pattern .= '\x{FB50}-\x{FDFD}';
+		$pattern .= '\x{FE70}-\x{FEFF}';
+		$pattern .= '\x{0750}-\x{077F}';
+		// Alphanumeric, /, _, - and space characters
+		$pattern .= 'a-zA-Z0-9\/_\-\s';
+		// 'ZERO WIDTH NON-JOINER'
+		$pattern .= '\x{200C}';
+		$pattern .= ']+)';
         
-        $this->router->map('GET', '@' . $pattern, 'unicode_action', 'unicode_route');
+		$this->router->map('GET', '@' . $pattern, 'unicode_action', 'unicode_route');
         
-        $this->assertEquals(array(
-            'target' => 'unicode_action',
-            'name' => 'unicode_route',
-            'params' => array(
-                'path' => '大家好'
-            )
-        ), $this->router->match('/大家好', 'GET'));
+		$this->assertEquals(array(
+			'target' => 'unicode_action',
+			'name' => 'unicode_route',
+			'params' => array(
+				'path' => '大家好'
+			)
+		), $this->router->match('/大家好', 'GET'));
         
-        $this->assertFalse($this->router->match('/﷽‎', 'GET'));
-    }
+		$this->assertFalse($this->router->match('/﷽‎', 'GET'));
+	}
 
-    /**
-     * @covers Router::setMatchTypes
-     */
-    public function testMatchWithCustomNamedRegex()
-    {
-        $this->router->getParser()->setMatchTypes(array('cId' => '[a-zA-Z]{2}[0-9](?:_[0-9]++)?'));
-        $this->router->map('GET', '/bar/[cId:customId]', 'bar_action', 'bar_route');
+	/**
+	 * @covers Router::setMatchTypes
+	 */
+	public function testMatchWithCustomNamedRegex()
+	{
+		$this->router->getParser()->setMatchTypes(array('cId' => '[a-zA-Z]{2}[0-9](?:_[0-9]++)?'));
+		$this->router->map('GET', '/bar/[cId:customId]', 'bar_action', 'bar_route');
         
-        $this->assertEquals(array(
-            'target' => 'bar_action',
-            'params' => array(
-                'customId' => 'AB1',
-            ),
-            'name' => 'bar_route'
-        ), $this->router->match('/bar/AB1', 'GET'));
+		$this->assertEquals(array(
+			'target' => 'bar_action',
+			'params' => array(
+				'customId' => 'AB1',
+			),
+			'name' => 'bar_route'
+		), $this->router->match('/bar/AB1', 'GET'));
 
-        $this->assertEquals(array(
-            'target' => 'bar_action',
-            'params' => array(
-                'customId' => 'AB1_0123456789',
-            ),
-            'name' => 'bar_route'
-        ), $this->router->match('/bar/AB1_0123456789', 'GET'));
+		$this->assertEquals(array(
+			'target' => 'bar_action',
+			'params' => array(
+				'customId' => 'AB1_0123456789',
+			),
+			'name' => 'bar_route'
+		), $this->router->match('/bar/AB1_0123456789', 'GET'));
         
-        $this->assertFalse($this->router->match('/some-other-thing', 'GET'));
-    }
+		$this->assertFalse($this->router->match('/some-other-thing', 'GET'));
+	}
 
-    public function testMatchWithCustomNamedUnicodeRegex()
-    {
-        $pattern = '[^';
-        // Arabic characters
-        $pattern .= '\x{0600}-\x{06FF}';
-        $pattern .= '\x{FB50}-\x{FDFD}';
-        $pattern .= '\x{FE70}-\x{FEFF}';
-        $pattern .= '\x{0750}-\x{077F}';
-        $pattern .= ']+';
+	public function testMatchWithCustomNamedUnicodeRegex()
+	{
+		$pattern = '[^';
+		// Arabic characters
+		$pattern .= '\x{0600}-\x{06FF}';
+		$pattern .= '\x{FB50}-\x{FDFD}';
+		$pattern .= '\x{FE70}-\x{FEFF}';
+		$pattern .= '\x{0750}-\x{077F}';
+		$pattern .= ']+';
         
-        $this->router->getParser()->setMatchTypes(array('nonArabic' => $pattern));
-        $this->router->map('GET', '/bar/[nonArabic:string]', 'non_arabic_action', 'non_arabic_route');
+		$this->router->getParser()->setMatchTypes(array('nonArabic' => $pattern));
+		$this->router->map('GET', '/bar/[nonArabic:string]', 'non_arabic_action', 'non_arabic_route');
 
-        $this->assertEquals(array(
-            'target' => 'non_arabic_action',
-            'name'   => 'non_arabic_route',
-            'params' => array(
-                'string' => 'some-path'
-            )
-        ), $this->router->match('/bar/some-path', 'GET'));
+		$this->assertEquals(array(
+			'target' => 'non_arabic_action',
+			'name'   => 'non_arabic_route',
+			'params' => array(
+				'string' => 'some-path'
+			)
+		), $this->router->match('/bar/some-path', 'GET'));
         
-        $this->assertFalse($this->router->match('/﷽‎', 'GET'));
-    }
+		$this->assertFalse($this->router->match('/﷽‎', 'GET'));
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     {
         $parser = new RouterParser();
         $this->router  = new Router($parser, [], '', []);
-        $this->closure = function () {
+        $this->closure = function() {
         };
     }
 

src/Tests/SimpleTraversable.php

Indentation +25 added lines, -25 removed lines

@@ -5,31 +5,31 @@
 
 class SimpleTraversable implements Iterator
 {
-    protected $position = 0;
+	protected $position = 0;
 
-    protected $data = array(
-        array('GET', '/foo', 'foo_action', null),
-        array('POST', '/bar', 'bar_action', 'second_route')
-    );
+	protected $data = array(
+		array('GET', '/foo', 'foo_action', null),
+		array('POST', '/bar', 'bar_action', 'second_route')
+	);
 
-    public function current()
-    {
-        return $this->data[$this->position];
-    }
-    public function key()
-    {
-        return $this->position;
-    }
-    public function next()
-    {
-        ++$this->position;
-    }
-    public function rewind()
-    {
-        $this->position = 0;
-    }
-    public function valid()
-    {
-        return isset($this->data[$this->position]);
-    }
+	public function current()
+	{
+		return $this->data[$this->position];
+	}
+	public function key()
+	{
+		return $this->position;
+	}
+	public function next()
+	{
+		++$this->position;
+	}
+	public function rewind()
+	{
+		$this->position = 0;
+	}
+	public function valid()
+	{
+		return isset($this->data[$this->position]);
+	}
 }

src/RouterParserInterface.php

Indentation +28 added lines, -28 removed lines

@@ -3,34 +3,34 @@
 
 interface RouterParserInterface
 {
-    /**
-     * Get the route parameters
-     *
-     * @return array
-     */
-    public function getParams();
+	/**
+	 * Get the route parameters
+	 *
+	 * @return array
+	 */
+	public function getParams();
 
-    /**
-     * Get the url from a route name
-     *
-     * @param string $basePath
-     * @param string $route
-     * @param array $params
-     *
-     * @return string
-     */
-    public function generateUrl($basePath, $route, array $params);
+	/**
+	 * Get the url from a route name
+	 *
+	 * @param string $basePath
+	 * @param string $route
+	 * @param array $params
+	 *
+	 * @return string
+	 */
+	public function generateUrl($basePath, $route, array $params);
 
-    /**
-     * Check if the request method match the route methods
-     * Update the $params
-     *
-     * @param string $method
-     * @param string $requestMethod
-     * @param string $routeString
-     * @param string $requestUrl
-     *
-     * @return mixed
-     */
-    public function methodMatch($method, $requestMethod, $routeString, $requestUrl);
+	/**
+	 * Check if the request method match the route methods
+	 * Update the $params
+	 *
+	 * @param string $method
+	 * @param string $requestMethod
+	 * @param string $routeString
+	 * @param string $requestUrl
+	 *
+	 * @return mixed
+	 */
+	public function methodMatch($method, $requestMethod, $routeString, $requestUrl);
 }

src/Router.php

Indentation +211 added lines, -211 removed lines

@@ -5,215 +5,215 @@
 
 class Router
 {
-    protected $routes = [];
-    protected $namedRoutes = [];
-    protected $basePath = '';
-    protected $all = ['get', 'post'];
-    protected $server;
-    /**
-     * @var RouterParser
-     */
-    private $parser;
-
-    /**
-     * Create router in one call from config.
-     *
-     * @param RouterParser $parser
-     * @param array $routes
-     * @param string $basePath
-     * @param array|null $server
-     */
-    public function __construct(RouterParser $parser, $routes = [], $basePath = '', $server = null)
-    {
-        $this->setRoutes($routes);
-        $this->setBasePath($basePath);
-        $this->parser = $parser;
-        $this->server = $server;
-    }
-
-    /**
-     * Map a route to a target
-     *
-     * @param string $method One of 5 HTTP Methods, or a pipe-separated list of multiple HTTP Methods (GET|POST|PATCH|PUT|DELETE)
-     * @param string $route The route regex, custom regex must start with an @. You can use multiple pre-set regex filters, like [i:id]
-     * @param mixed $target The target where this route should point to. Can be anything.
-     * @param string $routeName Optional name of this route. Supply if you want to reverse route this url in your application.
-     */
-    public function map($method, $route, $target, $routeName = null)
-    {
-        if (is_string($routeName)) {
-            $this->handleException($routeName, "Can not redeclare route '%s'", true);
-            $this->namedRoutes[$routeName] = $route;
-        }
-
-        $this->routes[] = array($method, $route, $target, $routeName);
-    }
-
-    /**
-     * Reversed routing
-     * Generate the URL for a named route. Replace regexes with supplied parameters
-     *
-     * @param string $routeName The name of the route.
-     * @param array $params Associative array of parameters to replace placeholders with.
-     *
-     * @return string The URL of the route with named parameters in place.
-     */
-    public function generate($routeName, array $params = [])
-    {
-        $this->handleException($routeName, "Route '%s' does not exist.", false);
-
-        $route = $this->namedRoutes[$routeName];
-
-        return $this->parser->generateUrl($this->basePath, $route, $params);
-    }
-
-    /**
-     * Match a given Request Url against stored routes
-     * @param string $requestUrl
-     * @param string $requestMethod
-     *
-     * @return array|boolean Array with route information on success, false on failure (no match).
-     */
-    public function match($requestUrl = null, $requestMethod = null)
-    {
-        $requestUrl = $this->getRequestUrl($requestUrl);
-
-        // set Request Method if it isn't passed as a parameter
-        if (is_null($requestMethod)) {
-            $requestMethod = $this->server['REQUEST_METHOD'];
-        }
-
-        foreach ($this->routes as $handler) {
-            if (!$this->parser->methodMatch($handler[0], $requestMethod, $handler[1], $requestUrl)) {
-                continue;
-            }
-
-            return array(
-                'target' => $handler[2],
-                'params' => array_filter($this->parser->getParams(), function ($k) {
-                    return !is_numeric($k);
-                }, ARRAY_FILTER_USE_KEY),
-                'name'   => $handler[3]
-            );
-        }
-
-        return false;
-    }
-
-    /**
-     * @param $method
-     * @param $arguments
-     *
-     * @throws RouterException
-     */
-    public function __call($method, $arguments)
-    {
-        if (!in_array($method, array('get', 'post', 'delete', 'put', 'patch', 'update', 'all'))) {
-            throw new RouterException($method . ' not exist in the '. __CLASS__);
-        }
-
-        $methods = $method == 'all' ? implode('|', $this->all) : $method;
-
-        $route = array_merge([$methods], $arguments);
-
-        call_user_func_array([$this, 'map'], $route);
-    }
-
-    /**
-     * Retrieves all routes.
-     * Useful if you want to process or display routes.
-     *
-     * @return array All routes.
-     */
-    public function getRoutes()
-    {
-        return $this->routes;
-    }
-
-    /**
-     * Add multiple routes at once from array in the following format:
-     *
-     *   $routes = array(
-     *      array($method, $route, $target, $name)
-     *   );
-     *
-     * @param array|Iterator $routes
-     *
-     * @return void
-     */
-    public function setRoutes($routes)
-    {
-        if (!is_array($routes) && !$routes instanceof Iterator) {
-            throw new RouterException('Routes should be an array or an instance of Iterator');
-        }
-        if (!empty($routes)) {
-            foreach ($routes as $route) {
-                call_user_func_array(array($this, 'map'), $route);
-            }
-        }
-    }
-
-    /**
-     * Set the base path.
-     * Useful if you are running your application from a subdirectory.
-     *
-     * @param $basePath
-     */
-    public function setBasePath($basePath)
-    {
-        $this->basePath = $basePath;
-    }
-
-    /**
-     * @param $routeName
-     * @param $message
-     * @param bool $cmpTo
-     *
-     * @throws RouterException
-     */
-    private function handleException($routeName, $message, $cmpTo)
-    {
-        if (array_key_exists($routeName, $this->namedRoutes) === $cmpTo) {
-            throw new RouterException(sprintf($message, $routeName));
-        }
-    }
-
-    /**
-     * @param $requestUrl
-     *
-     * @return mixed
-     */
-    private function getRequestUrl($requestUrl = null)
-    {
-        // set Request Url if it isn't passed as parameter
-        if (is_null($requestUrl)) {
-            $requestUrl = parse_url($this->server['REQUEST_URI'], PHP_URL_PATH);
-        }
-
-        return str_replace($this->basePath, '', strtok($requestUrl, '?'));
-    }
-
-    /**
-     * @return RouterParser
-     */
-    public function getParser()
-    {
-        return $this->parser;
-    }
-
-
-    public function getNamedRoutes()
-    {
-        return $this->namedRoutes;
-    }
-
-    public function getBasePath()
-    {
-        return $this->basePath;
-    }
-
-    public function setServer($server)
-    {
-        $this->server = $server;
-    }
+	protected $routes = [];
+	protected $namedRoutes = [];
+	protected $basePath = '';
+	protected $all = ['get', 'post'];
+	protected $server;
+	/**
+	 * @var RouterParser
+	 */
+	private $parser;
+
+	/**
+	 * Create router in one call from config.
+	 *
+	 * @param RouterParser $parser
+	 * @param array $routes
+	 * @param string $basePath
+	 * @param array|null $server
+	 */
+	public function __construct(RouterParser $parser, $routes = [], $basePath = '', $server = null)
+	{
+		$this->setRoutes($routes);
+		$this->setBasePath($basePath);
+		$this->parser = $parser;
+		$this->server = $server;
+	}
+
+	/**
+	 * Map a route to a target
+	 *
+	 * @param string $method One of 5 HTTP Methods, or a pipe-separated list of multiple HTTP Methods (GET|POST|PATCH|PUT|DELETE)
+	 * @param string $route The route regex, custom regex must start with an @. You can use multiple pre-set regex filters, like [i:id]
+	 * @param mixed $target The target where this route should point to. Can be anything.
+	 * @param string $routeName Optional name of this route. Supply if you want to reverse route this url in your application.
+	 */
+	public function map($method, $route, $target, $routeName = null)
+	{
+		if (is_string($routeName)) {
+			$this->handleException($routeName, "Can not redeclare route '%s'", true);
+			$this->namedRoutes[$routeName] = $route;
+		}
+
+		$this->routes[] = array($method, $route, $target, $routeName);
+	}
+
+	/**
+	 * Reversed routing
+	 * Generate the URL for a named route. Replace regexes with supplied parameters
+	 *
+	 * @param string $routeName The name of the route.
+	 * @param array $params Associative array of parameters to replace placeholders with.
+	 *
+	 * @return string The URL of the route with named parameters in place.
+	 */
+	public function generate($routeName, array $params = [])
+	{
+		$this->handleException($routeName, "Route '%s' does not exist.", false);
+
+		$route = $this->namedRoutes[$routeName];
+
+		return $this->parser->generateUrl($this->basePath, $route, $params);
+	}
+
+	/**
+	 * Match a given Request Url against stored routes
+	 * @param string $requestUrl
+	 * @param string $requestMethod
+	 *
+	 * @return array|boolean Array with route information on success, false on failure (no match).
+	 */
+	public function match($requestUrl = null, $requestMethod = null)
+	{
+		$requestUrl = $this->getRequestUrl($requestUrl);
+
+		// set Request Method if it isn't passed as a parameter
+		if (is_null($requestMethod)) {
+			$requestMethod = $this->server['REQUEST_METHOD'];
+		}
+
+		foreach ($this->routes as $handler) {
+			if (!$this->parser->methodMatch($handler[0], $requestMethod, $handler[1], $requestUrl)) {
+				continue;
+			}
+
+			return array(
+				'target' => $handler[2],
+				'params' => array_filter($this->parser->getParams(), function ($k) {
+					return !is_numeric($k);
+				}, ARRAY_FILTER_USE_KEY),
+				'name'   => $handler[3]
+			);
+		}
+
+		return false;
+	}
+
+	/**
+	 * @param $method
+	 * @param $arguments
+	 *
+	 * @throws RouterException
+	 */
+	public function __call($method, $arguments)
+	{
+		if (!in_array($method, array('get', 'post', 'delete', 'put', 'patch', 'update', 'all'))) {
+			throw new RouterException($method . ' not exist in the '. __CLASS__);
+		}
+
+		$methods = $method == 'all' ? implode('|', $this->all) : $method;
+
+		$route = array_merge([$methods], $arguments);
+
+		call_user_func_array([$this, 'map'], $route);
+	}
+
+	/**
+	 * Retrieves all routes.
+	 * Useful if you want to process or display routes.
+	 *
+	 * @return array All routes.
+	 */
+	public function getRoutes()
+	{
+		return $this->routes;
+	}
+
+	/**
+	 * Add multiple routes at once from array in the following format:
+	 *
+	 *   $routes = array(
+	 *      array($method, $route, $target, $name)
+	 *   );
+	 *
+	 * @param array|Iterator $routes
+	 *
+	 * @return void
+	 */
+	public function setRoutes($routes)
+	{
+		if (!is_array($routes) && !$routes instanceof Iterator) {
+			throw new RouterException('Routes should be an array or an instance of Iterator');
+		}
+		if (!empty($routes)) {
+			foreach ($routes as $route) {
+				call_user_func_array(array($this, 'map'), $route);
+			}
+		}
+	}
+
+	/**
+	 * Set the base path.
+	 * Useful if you are running your application from a subdirectory.
+	 *
+	 * @param $basePath
+	 */
+	public function setBasePath($basePath)
+	{
+		$this->basePath = $basePath;
+	}
+
+	/**
+	 * @param $routeName
+	 * @param $message
+	 * @param bool $cmpTo
+	 *
+	 * @throws RouterException
+	 */
+	private function handleException($routeName, $message, $cmpTo)
+	{
+		if (array_key_exists($routeName, $this->namedRoutes) === $cmpTo) {
+			throw new RouterException(sprintf($message, $routeName));
+		}
+	}
+
+	/**
+	 * @param $requestUrl
+	 *
+	 * @return mixed
+	 */
+	private function getRequestUrl($requestUrl = null)
+	{
+		// set Request Url if it isn't passed as parameter
+		if (is_null($requestUrl)) {
+			$requestUrl = parse_url($this->server['REQUEST_URI'], PHP_URL_PATH);
+		}
+
+		return str_replace($this->basePath, '', strtok($requestUrl, '?'));
+	}
+
+	/**
+	 * @return RouterParser
+	 */
+	public function getParser()
+	{
+		return $this->parser;
+	}
+
+
+	public function getNamedRoutes()
+	{
+		return $this->namedRoutes;
+	}
+
+	public function getBasePath()
+	{
+		return $this->basePath;
+	}
+
+	public function setServer($server)
+	{
+		$this->server = $server;
+	}
 }

src/RouterParser.php

Indentation +208 added lines, -208 removed lines

@@ -3,212 +3,212 @@
 
 class RouterParser implements RouterParserInterface
 {
-    protected $params = [];
-    protected $matchTypes = [
-        'i'  => '[0-9]++',
-        'a'  => '[0-9A-Za-z]++',
-        'h'  => '[0-9A-Fa-f]++',
-        '*'  => '.+?',
-        '**' => '.++',
-        ''   => '[^/\.]++'
-    ];
-
-    /**
-     * Create router in one call from config.
-     *
-     * @param array $matchTypes
-     */
-    public function __construct($matchTypes = [])
-    {
-        $this->setMatchTypes($matchTypes);
-    }
-
-    /**
-     * Add named match types. It uses array_merge so keys can be overwritten.
-     *
-     * @param array $matchTypes The key is the name and the value is the regex.
-     */
-    public function setMatchTypes($matchTypes)
-    {
-        $this->matchTypes = array_merge($this->matchTypes, $matchTypes);
-    }
-
-    /**
-     * Get the url from a route name
-     *
-     * @param string $basePath
-     * @param string $route
-     * @param array $params
-     *
-     * @return string
-     */
-    public function generateUrl($basePath, $route, array $params)
-    {
-        $url = $basePath . $route;
-
-        if (preg_match_all('`(/|\.|)\[([^:\]]*+)(?::([^:\]]*+))?\](\?|)`', $route, $matches, PREG_SET_ORDER)) {
-            foreach ($matches as $match) {
-                $pre   = $match[1];
-                $param = $match[3];
-                $block = $pre ? substr($match[0], 1) : $match[0];
-
-                if (isset($params[$param])) {
-                    $url = str_replace($block, $params[$param], $url);
-                } elseif ($match[4]) {
-                    $url = str_replace($pre . $block, '', $url);
-                }
-            }
-        }
-
-        return $url;
-    }
-
-    /**
-     * @param string $method
-     * @param string $requestMethod
-     * @param string $routeString
-     * @param string $requestUrl
-     *
-     * @return mixed
-     */
-    public function methodMatch($method, $requestMethod, $routeString, $requestUrl)
-    {
-        $methods = explode('|', $method);
-
-        if (preg_grep("/{$requestMethod}/i", $methods)) {
-            if ($routeString == '*') {
-                return true;
-            } elseif (isset($routeString[0]) && $routeString[0] == '@') {
-                return preg_match('`' . substr($routeString, 1) . '`u', $requestUrl, $this->params);
-            } elseif (($position = strpos($routeString, '[')) === false) {
-                return strcmp($requestUrl, $routeString) === 0;
-            }
-            if (strncmp($requestUrl, $routeString, $position) !== 0) {
-                return false;
-            }
-
-            return preg_match($this->compileRoute($routeString, $requestUrl), $requestUrl, $this->params);
-        }
-
-        return false;
-    }
-
-    /**
-     * Compile the regex for a given route (EXPENSIVE)
-     *
-     * @param $routeString
-     * @param $requestUrl
-     *
-     * @return string
-     */
-    private function compileRoute($routeString, $requestUrl)
-    {
-        $route = $this->getRoute($routeString, $requestUrl);
-
-        if (preg_match_all('`(/|\.|)\[([^:\]]*+)(?::([^:\]]*+))?\](\?|)`', $route, $matches, PREG_SET_ORDER)) {
-            $matchTypes = $this->matchTypes;
-            foreach ($matches as $match) {
-                $pattern = $this->getRoutePattern($matchTypes, $match[1], $match[2], $match[3], $match[4]);
-                $route   = str_replace($match[0], $pattern, $route);
-            }
-        }
-
-        return "`^$route$`u";
-    }
-
-    /**
-     * @param $matchTypes
-     * @param $pre
-     * @param $type
-     * @param $param
-     * @param $optional
-     *
-     * @return string
-     */
-    private function getRoutePattern($matchTypes, $pre, $type, $param, $optional)
-    {
-        if (isset($matchTypes[$type])) {
-            $type = $matchTypes[$type];
-        }
-        if ($pre === '.') {
-            $pre = '\.';
-        }
-
-        //Older versions of PCRE require the 'P' in (?P<named>)
-        return '(?:'
-            . (!empty($pre) ? $pre : null)
-            . '('
-            . (!empty($param) ? "?P<$param>" : null)
-            . $type
-            . '))'
-            . (!empty($optional) ? '?' : null);
-    }
-
-    /**
-     * @param $routeString
-     * @param $requestUrl
-     *
-     * @return bool|string
-     */
-    private function getRoute($routeString, $requestUrl)
-    {
-        $iPointer = $jPointer = 0;
-        $nPointer = isset($routeString[0]) ? $routeString[0] : null;
-        $regex = $route = false;
-
-        // Find the longest non-regex substring and match it against the URI
-        while (true) {
-            if (!isset($routeString[$iPointer])) {
-                break;
-            }
-            if ($regex === false) {
-                if (!$this->isValidRouteRegex($nPointer, $jPointer, $iPointer, $routeString, $requestUrl)) {
-                    continue;
-                }
-                $jPointer++;
-            }
-            $route .= $routeString[$iPointer++];
-        }
-
-        return $route;
-    }
-
-    /**
-     * @param $nPointer
-     * @param $jPointer
-     * @param $iPointer
-     * @param $routeString
-     * @param $requestUrl
-     *
-     * @return bool
-     */
-    private function isValidRouteRegex($nPointer, $jPointer, $iPointer, $routeString, $requestUrl)
-    {
-        $cPointer = $nPointer;
-        $regex = in_array($cPointer, array('[', '(', '.'));
-        if (!$regex && isset($routeString[$iPointer+1])) {
-            $nPointer = $routeString[$iPointer + 1];
-            $regex = in_array($nPointer, array('?', '+', '*', '{'));
-        }
-        if (!$regex && $cPointer !== '/' && (!isset($requestUrl[$jPointer]) || $cPointer !== $requestUrl[$jPointer])) {
-            return false;
-        }
-        return true;
-    }
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->params;
-    }
-
-    /**
-     * @return array
-     */
-    public function getMatchTypes()
-    {
-        return $this->matchTypes;
-    }
+	protected $params = [];
+	protected $matchTypes = [
+		'i'  => '[0-9]++',
+		'a'  => '[0-9A-Za-z]++',
+		'h'  => '[0-9A-Fa-f]++',
+		'*'  => '.+?',
+		'**' => '.++',
+		''   => '[^/\.]++'
+	];
+
+	/**
+	 * Create router in one call from config.
+	 *
+	 * @param array $matchTypes
+	 */
+	public function __construct($matchTypes = [])
+	{
+		$this->setMatchTypes($matchTypes);
+	}
+
+	/**
+	 * Add named match types. It uses array_merge so keys can be overwritten.
+	 *
+	 * @param array $matchTypes The key is the name and the value is the regex.
+	 */
+	public function setMatchTypes($matchTypes)
+	{
+		$this->matchTypes = array_merge($this->matchTypes, $matchTypes);
+	}
+
+	/**
+	 * Get the url from a route name
+	 *
+	 * @param string $basePath
+	 * @param string $route
+	 * @param array $params
+	 *
+	 * @return string
+	 */
+	public function generateUrl($basePath, $route, array $params)
+	{
+		$url = $basePath . $route;
+
+		if (preg_match_all('`(/|\.|)\[([^:\]]*+)(?::([^:\]]*+))?\](\?|)`', $route, $matches, PREG_SET_ORDER)) {
+			foreach ($matches as $match) {
+				$pre   = $match[1];
+				$param = $match[3];
+				$block = $pre ? substr($match[0], 1) : $match[0];
+
+				if (isset($params[$param])) {
+					$url = str_replace($block, $params[$param], $url);
+				} elseif ($match[4]) {
+					$url = str_replace($pre . $block, '', $url);
+				}
+			}
+		}
+
+		return $url;
+	}
+
+	/**
+	 * @param string $method
+	 * @param string $requestMethod
+	 * @param string $routeString
+	 * @param string $requestUrl
+	 *
+	 * @return mixed
+	 */
+	public function methodMatch($method, $requestMethod, $routeString, $requestUrl)
+	{
+		$methods = explode('|', $method);
+
+		if (preg_grep("/{$requestMethod}/i", $methods)) {
+			if ($routeString == '*') {
+				return true;
+			} elseif (isset($routeString[0]) && $routeString[0] == '@') {
+				return preg_match('`' . substr($routeString, 1) . '`u', $requestUrl, $this->params);
+			} elseif (($position = strpos($routeString, '[')) === false) {
+				return strcmp($requestUrl, $routeString) === 0;
+			}
+			if (strncmp($requestUrl, $routeString, $position) !== 0) {
+				return false;
+			}
+
+			return preg_match($this->compileRoute($routeString, $requestUrl), $requestUrl, $this->params);
+		}
+
+		return false;
+	}
+
+	/**
+	 * Compile the regex for a given route (EXPENSIVE)
+	 *
+	 * @param $routeString
+	 * @param $requestUrl
+	 *
+	 * @return string
+	 */
+	private function compileRoute($routeString, $requestUrl)
+	{
+		$route = $this->getRoute($routeString, $requestUrl);
+
+		if (preg_match_all('`(/|\.|)\[([^:\]]*+)(?::([^:\]]*+))?\](\?|)`', $route, $matches, PREG_SET_ORDER)) {
+			$matchTypes = $this->matchTypes;
+			foreach ($matches as $match) {
+				$pattern = $this->getRoutePattern($matchTypes, $match[1], $match[2], $match[3], $match[4]);
+				$route   = str_replace($match[0], $pattern, $route);
+			}
+		}
+
+		return "`^$route$`u";
+	}
+
+	/**
+	 * @param $matchTypes
+	 * @param $pre
+	 * @param $type
+	 * @param $param
+	 * @param $optional
+	 *
+	 * @return string
+	 */
+	private function getRoutePattern($matchTypes, $pre, $type, $param, $optional)
+	{
+		if (isset($matchTypes[$type])) {
+			$type = $matchTypes[$type];
+		}
+		if ($pre === '.') {
+			$pre = '\.';
+		}
+
+		//Older versions of PCRE require the 'P' in (?P<named>)
+		return '(?:'
+			. (!empty($pre) ? $pre : null)
+			. '('
+			. (!empty($param) ? "?P<$param>" : null)
+			. $type
+			. '))'
+			. (!empty($optional) ? '?' : null);
+	}
+
+	/**
+	 * @param $routeString
+	 * @param $requestUrl
+	 *
+	 * @return bool|string
+	 */
+	private function getRoute($routeString, $requestUrl)
+	{
+		$iPointer = $jPointer = 0;
+		$nPointer = isset($routeString[0]) ? $routeString[0] : null;
+		$regex = $route = false;
+
+		// Find the longest non-regex substring and match it against the URI
+		while (true) {
+			if (!isset($routeString[$iPointer])) {
+				break;
+			}
+			if ($regex === false) {
+				if (!$this->isValidRouteRegex($nPointer, $jPointer, $iPointer, $routeString, $requestUrl)) {
+					continue;
+				}
+				$jPointer++;
+			}
+			$route .= $routeString[$iPointer++];
+		}
+
+		return $route;
+	}
+
+	/**
+	 * @param $nPointer
+	 * @param $jPointer
+	 * @param $iPointer
+	 * @param $routeString
+	 * @param $requestUrl
+	 *
+	 * @return bool
+	 */
+	private function isValidRouteRegex($nPointer, $jPointer, $iPointer, $routeString, $requestUrl)
+	{
+		$cPointer = $nPointer;
+		$regex = in_array($cPointer, array('[', '(', '.'));
+		if (!$regex && isset($routeString[$iPointer+1])) {
+			$nPointer = $routeString[$iPointer + 1];
+			$regex = in_array($nPointer, array('?', '+', '*', '{'));
+		}
+		if (!$regex && $cPointer !== '/' && (!isset($requestUrl[$jPointer]) || $cPointer !== $requestUrl[$jPointer])) {
+			return false;
+		}
+		return true;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->params;
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getMatchTypes()
+	{
+		return $this->matchTypes;
+	}
 }