RouterTest - Code Metrics - KSST/KF - Measure and Improve Code Quality continuously with Scrutinizer

RouterTest A
last analyzed 2017-04-11 14:32 UTC

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	603
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	6
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	0
loc	603
rs	9.991
wmc	20
lcom	1
cbo	6
18 Methods

Rating	Name	Size	Complexity
A	setUp()	13	1
A	tearDown()	4	1
A	testMethodaddRoute()	11	1
A	testMethoddelRoute()	14	1
A	testMethodReset()	12	1
A	testMethodResetResetsTargetRouteToo()	10	1
A	testMethodaddRoutes()	15	1
A	testMethodaddRoutesViaArrayAccess()	13	1
A	testMethodremoveRoutesBySegmentCount()	17	1
A	testMethodprepareRequestURI()	11	1
A	testMethodplaceholdersToRegexp()	12	1
A	testMethodProcessSegmentsRegExp()	21	1
B	testMethodMatchRestRoutes()	184	1
A	testMethodmatch_StaticRoute()	51	1
A	testMethodmatch_throwsExceptionIfNoRoutesFound()	8	1
A	testMethodGenerateURL()	8	1
A	testMethodBuildURLWhenModRewriteOFF()	69	1
A	testMethodBuildURLWhenModRewriteON()	60	3
<?php

namespace KochTest\Router;

use Koch\Config\Config;
use Koch\Http\HttpRequest;
use Koch\Mvc\Mapper;
use Koch\Router\Router;
use Koch\Router\TargetRoute;

class RouterTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var Router
     */
    protected $router;

    /**
     * Sets up the fixture, for example, opens a network connection.
     * This method is called before a test is executed.
     */
    public function setUp()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $_SERVER['REQUEST_URI'] = '';

        $request = new HttpRequest();

        $config = new Config();

        $this->router = new Router($request, $config);


        // set the Fixtures folder with application and module classes for the autoloading
        set_include_path(realpath(__DIR__ . '/Fixtures') . PATH_SEPARATOR . get_include_path());
    }

    /**
     * Tears down the fixture, for example, closes a network connection.
     * This method is called after a test is executed.
     */
    public function tearDown()
    {
        unset($this->router);
    }

    public function testMethodaddRoute()
    {
        $this->router->addRoute('/news/(:id)', ['controller', 'id']);

        $routes = $this->router->getRoutes();

        $this->assertEquals(2, $routes['/news/([0-9]+)']['number_of_segments']);
        $this->assertEquals('#\/news\/?\/([0-9]+)\/?#', $routes['/news/([0-9]+)']['regexp']);

        $this->router->reset();
    }

    public function testMethoddelRoute()
    {
        // static controller with dynamic id
        $this->router->addRoute('/news/(:id)', [':controller', 'id']);

        $this->assertTrue(1 === count($this->router->getRoutes()));

        // @todo this is odd, because the string to delete the route
        // does not match the string, when adding the route,
        // due to preplacing with regexps
        $this->router->delRoute('/news/([0-9]+)');

        $this->assertTrue(0 === count($this->router->getRoutes()));
    }

    public function testMethodReset()
    {
        $this->assertTrue(0 === count($this->router->getRoutes()));

        $this->router->addRoute('/news', [':controller']);

        $this->assertTrue(1 === count($this->router->getRoutes()));

        $this->router->reset();

        $this->assertTrue(0 === count($this->router->getRoutes()));
    }

    public function testMethodResetResetsTargetRouteToo()
    {
        TargetRoute::setAction('testclass');
        $this->assertEquals('testclass', TargetRoute::getAction());
        $this->router->reset();

        // default module action is "list"
        // "list" was formerly "index" (Response Action for GET "/foos")
        $this->assertEquals('list', TargetRoute::getAction());
    }

    public function testMethodaddRoutes()
    {
        $routes = [
            '/news'                  => [':controller'],
            '/news/edit'             => [':controller', ':action', 'id'],
            '/news/edit/(:id)'       => [':controller', ':action', 'id'],
            '/news/admin/edit/(:id)' => [':controller', ':subcontroller', ':action', 'id'],
            '/news/:year/:month'     => [':controller', ':year', ':month'],
            '/news/he-ad-li-ne-SEO'  => [':controller', ':word'],
        ];

        $this->router->addRoutes($routes);

        $this->assertTrue(count($routes) === count($this->router->getRoutes()));
    }

    public function testMethodaddRoutesViaArrayAccess()
    {
        $r = $this->router;

        $r['/news']                  = [':controller'];
        $r['/news/edit']             = [':controller', ':action', 'id'];
        $r['/news/edit/(:id)']       = [':controller', ':action', 'id'];
        $r['/news/admin/edit/(:id)'] = [':controller', ':subcontroller', ':action', 'id'];
        $r['/news/:year/:month']     = [':controller', ':year', ':month'];
        $r['/news/he-ad-li-ne-text'] = [':controller', ':word'];

        $this->assertTrue(6 === count($this->router->getRoutes()));
    }

    public function testMethodremoveRoutesBySegmentCount()
    {
        // adding 3 routes, each with different segment number
        $this->router->addRoute('/news', [':controller']);
        $this->router->addRoute('/news/edit', [':controller', ':action', 'id']);
        $this->router->addRoute('/news/edit/(:id)', [':controller', ':action', 'id']);

        $this->assertTrue(3 === count($this->router->getRoutes()));

        // add only one segment
        $this->router->uriSegments = ['0' => 'news'];

        // this makes all other routes irrelevant for the lookup
        $this->router->reduceRoutesToSegmentCount();

        $this->assertTrue(1 === count($this->router->getRoutes()));
    }

    public function testMethodprepareRequestURI()
    {
        // prepends slash
        $this->assertEquals('/news', $this->router->prepareRequestURI('news'));

        // prepends slash and removes any trailing slashes
        $this->assertEquals('/news', $this->router->prepareRequestURI('news///'));

        // prepends slash
        $this->assertEquals('/news/edit', $this->router->prepareRequestURI('news/edit'));
    }

    public function testMethodplaceholdersToRegexp()
    {
        $this->assertEquals('/route/with/([0-9]+)', $this->router->placeholdersToRegexp('/route/with/(:id)'));
        $this->assertEquals('/route/with/([0-9]+)', $this->router->placeholdersToRegexp('/route/with/(:num)'));
        $this->assertEquals('/route/with/([a-zA-Z]+)', $this->router->placeholdersToRegexp('/route/with/(:alpha)'));
        $this->assertEquals('/route/with/([a-zA-Z0-9]+)', $this->router->placeholdersToRegexp('/route/with/(:alphanum)'));
        $this->assertEquals('/route/with/(.*)', $this->router->placeholdersToRegexp('/route/with/(:any)'));
        $this->assertEquals('/route/with/(\w+)', $this->router->placeholdersToRegexp('/route/with/(:word)'));
        $this->assertEquals('/route/with/([12][0-9]{3})', $this->router->placeholdersToRegexp('/route/with/(:year)'));
        $this->assertEquals('/route/with/(0[1-9]|1[012])', $this->router->placeholdersToRegexp('/route/with/(:month)'));
        $this->assertEquals('/route/with/(0[1-9]|1[012])', $this->router->placeholdersToRegexp('/route/with/(:day)'));
    }

    public function testMethodProcessSegmentsRegExp()
    {
        $segments     = ['news', 'edit', '([0-9]+)'];
        $requirements = ['controller', 'action', ':num'];

        $this->assertSame(
            '#\/news\/?\/edit\/?\/([0-9]+)\/?#',
            $this->router->processSegmentsRegExp($segments, $requirements)
        );

        /*
         * Static Named Route
         */
        $segments     = [':news'];
        $requirements = ['controller'];

        $this->assertSame(
            '#(?P<news>[a-z_-]+)\/?#',
            $this->router->processSegmentsRegExp($segments, $requirements)
        );
    }

    public function testMethodMatchRestRoutes()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $applicationNamespace = '\KochTest\Fixtures\Application';
        Mapper::setApplicationNamespace($applicationNamespace);

        define('MOD_REWRITE_ON', true);
        $_ENV['FORCE_MOD_REWRITE_ON'] = true;

        $this->router->reset(true);

        // http://example.com/news
        // routes to
        // Controller: News
        // Action: actionList()
        // Type: GET [REST Route]

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('/news');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('list', $route->getAction());
        $this->assertEquals('actionList', $route->getMethod());
        $this->assertEquals([], $route->getParameters());
        $this->assertEquals('GET', $route->getRequestMethod());
        $this->router->reset(true);

        // http://example.com/news/42
        // routes to
        // Controller: News
        // Action: actionShow()
        // Id: 42
        // Type: GET [REST Route]

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('/news/42');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionShow', $route->getMethod());
        $this->assertEquals(['id' => '42'], $route->getParameters());
        $this->assertEquals('GET', $route->getRequestMethod());
        $this->router->reset(true);

        // http://example.com/news/new
        // routes to
        // Controller: News
        // Action: actionNew()
        // Type: GET [REST Route]

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('/news/new');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionNew', $route->getMethod());
        $this->assertEquals('GET', $route->getRequestMethod());
        $this->router->reset(true);

        // http://example.com/news/42/edit
        // routes to
        // Controller: News
        // Action: actionEdit()
        // Id: 42
        // Type: GET [REST Route]

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('/news/42/edit');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionEdit', $route->getMethod());
        $this->assertSame(['id' => '42'], $route->getParameters());
        $this->assertEquals('GET', $route->getRequestMethod());
        $this->router->reset(true);

        // same as above with reversed last segements
        // http://example.com/news/edit/42
        // routes to
        // Controller: News
        // Action: actionEdit()
        // Id: 42
        // Type: GET [WEB]

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('/news/edit/42');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionEdit', $route->getMethod());
        $this->assertEquals(['id' => '42'], $route->getParameters());
        $this->assertEquals('GET', $route->getRequestMethod());
        $this->router->reset(true);

        // http://example.com/news/42
        // routes to
        // Controller: News
        // Action: actionUpdate()
        // Id: 42
        // Type: PUT [REST Route]
        // Post_parameters are filled.

        HttpRequest::setRequestMethod('PUT');
        $this->router->prepareRequestURI('/news/42');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionUpdate', $route->getMethod());
        $this->assertEquals(['id' => '42'], $route->getParameters());
        $this->assertEquals('PUT', $route->getRequestMethod());
        $this->router->reset(true);

        // http://example.com/news
        // routes to
        // Controller: News
        // Action: actionInsert()
        // Type: POST [REST Route]
        // Post_parameters are filled.
        // fake incoming env data
        $_POST['id']           = '42';
        $_POST['article_text'] = 'blabla';
        HttpRequest::setRequestMethod('POST');
        $this->router->prepareRequestURI('/news');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionInsert', $route->getMethod());
        $this->assertEquals(['id' => '42', 'article_text' => 'blabla'], $route->getParameters());
        $this->assertEquals('POST', $route->getRequestMethod());
        $this->router->reset(true);

        // http://example.com/news/42
        // routes to
        // Controller: News
        // Action: actionDelete()
        // Id: 42
        // Type: DELETE [REST Route]

        HttpRequest::setRequestMethod('DELETE');
        $this->router->prepareRequestURI('/news/42');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionDelete', $route->getMethod());
        $this->assertEquals(['id' => '42'], $route->getParameters());
        $this->assertEquals('DELETE', $route->getRequestMethod());
        $this->router->reset(true);

        // same as above, web route
        // http://example.com/news/delete/42
        // routes to
        // Controller: News
        // Action: actionDelete()
        // Id: 42
        // Type: DELETE [WEB]

        HttpRequest::setRequestMethod('DELETE');
        $this->router->prepareRequestURI('/news/delete/42');
        $route = $this->router->route();

        $this->assertEquals($applicationNamespace . '\Modules\News\Controller\NewsController', $route->getClassname());
        $this->assertEquals('News', $route->getModule());
        $this->assertEquals('News', $route->getController());
        $this->assertEquals('actionDelete', $route->getMethod());
        $this->assertEquals(['id' => '42'], $route->getParameters());
        $this->assertEquals('DELETE', $route->getRequestMethod());
        $this->router->reset(true);
    }

    public function testMethodmatch_StaticRoute()

    {
        $applicationNamespace = '\KochTest\Router\Fixtures\Application';
        Mapper::setApplicationNamespace($applicationNamespace);

        // http://example.com/login

        $this->router->addRoute('/:controller');
        $this->router->addRoute('/:controller/:action');
        $this->router->addRoute('/:controller/:action/(:id)');

        $r           = $this->router;
        $r['/login'] = ['module' => 'user', 'controller' => 'account', 'action' => 'login'];

        $this->router->setRequestURI('/login');
        HttpRequest::setRequestMethod('GET');
        $route = $this->router->route();

        $this->assertEquals(
            $applicationNamespace . '\Modules\User\Controller\AccountController', $route->getClassname()
        );
        $this->assertEquals('User', $route->getModule());
        $this->assertEquals('Account', $route->getController());
        $this->assertEquals('actionLogin', $route->getMethod());
        $this->assertEquals([], $route->getParameters());
        $this->assertEquals('GET', $route->getRequestMethod());

        unset($route);
        $r->reset(true);

        // http://example.com/about

        $r           = $this->router;
        $r['/about'] = ['module' => 'index', 'controller' => 'index', 'action' => 'about'];

        $r->setRequestURI('/about');
        HttpRequest::setRequestMethod('GET');
        $route = $this->router->route();

        $this->assertEquals(
            $applicationNamespace . '\Modules\Index\Controller\IndexController', $route->getClassname()
        );
        $this->assertEquals('Index', $route->getModule());
        $this->assertEquals('Index', $route->getController());
        $this->assertEquals('actionAbout', $route->getMethod());
        $this->assertEquals([], $route->getParameters());
        $this->assertEquals('GET', $route->getRequestMethod());

        unset($route);
        $r->reset(true);
    }

    /*public function testMethodmatch_CustomActionNames()

    {
        /*
         * Feature Idea:
        $this->router->route('controller_item', '/:controller/<:id>.:format',
            array('defaults' => array(
                'action' => 'view',
                'format' => 'html'),
                'get' => array('action' => 'show'),
                'put' => array('action' => 'update'),
                'delete' => array('action' => 'delete')
            )
        );
         */
    //}

    /* Feature not implemented yet.

    public function testMethodmatch_SEO_Dynamic_Routes()
    {
        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('http://example.com/category/movies/Se7en.htm');
        $route = $this->router->route();

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('http://example.com/feeds/news/atom.xml');
        $route = $this->router->route();

        HttpRequest::setRequestMethod('GET');
        $this->router->prepareRequestURI('http://example.com/news/atom.xml');
        $route = $this->router->route();

        $this->markTestIncomplete('Test not implemented yet.');
    }*/

    /**
     * @expectedException OutOfBoundsException
     */
    public function testMethodmatch_throwsExceptionIfNoRoutesFound()

    {
        $this->router->reset();

        $this->assertTrue(0 === count($this->router->getRoutes()));

        $this->assertTrue($this->router->match());
    }

    public function testMethodGenerateURL()
    {
        /*

        $url = $this->router->generateURL($url_pattern);
        $this->assertEquals('url', $url);
         */
        $this->markTestSkipped('Test not implemented yet.');
    }

    public function testMethodBuildURLWhenModRewriteOFF()
    {
        /*
         * Do not build an URL, if FQDN is passed and mod_rewrite is off,
         * like http://application.com/tests/index.php?mod=news&action=show
         * Just return the URL (pass-through).
         */
        $urlstring    = WWW_ROOT . 'index.php?mod=news&action=show';
        $internal_url = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $url          = $this->router->buildURL($urlstring, false);
        $this->assertEquals(WWW_ROOT . 'index.php?mod=news&action=show', $url);

        $urlstring    = WWW_ROOT . 'index.php?mod=news&action=show';
        $internal_url = true;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news&action=show', $url);

        /*
         * Build FQDN URL from internal slashed URLs, like
         * /news
         * /news/show
         * /news/admin/show/2
         *
         * So internally we use the mod_rewrite style.
         */
        /*
         * Parameter 1 - module
         */
        // removes crappy slashes - test 1
        $urlstring    = '////news///';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news', $url);

        // removes crappy slashes - test 2
        $urlstring    = '/news///';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news', $url);

        // route to module
        $urlstring    = '/news';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news', $url);

        /*
         * Parameter 2 - action or controller
         */
        // route to module/action
        $urlstring    = ['/news/show' => 'module/action'];
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news&action=show', $url);

        // route to module/action/id
        $urlstring    = ['/news/show/42' => 'module/action/id'];
        $internal_url = true;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news&amp;action=show&amp;id=42', $url);

        // STANDARD PARAMETER ROUTING when MODREWRITE is OFF
        // we are not leaving any parameter out, so we don't need an urlstring description array
        // route to module/controller/action/id
        $urlstring    = '/news/admin/edit/1';
        $internal_url = true;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'index.php?mod=news&amp;ctrl=admin&amp;action=edit&amp;id=1', $url);
    }

    public function testMethodBuildURLWhenModRewriteON()
    {
        // precondition
        if (defined('REWRITE_ENGINE_ON') and REWRITE_ENGINE_ON === false) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $this->markTestSkipped('The Test depends on MOD_REWRITE.');
        } else {
            $this->assertTrue(REWRITE_ENGINE_ON);
        }

        /*
         * Build URL from internal slashed URLs, like
         * /news
         * /news/show
         * /news/admin/show/2
         *
         * So internally we use the mod_rewrite style.
         */
        /*
         * Parameter 1 - module
         */
        // removes crappy slashes - test 1
        $urlstring    = '////news///';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'news', $url);

        // removes crappy slashes - test 2
        $urlstring    = '/news///';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'news', $url);

        // removes crappy slashes - test 3
        $urlstring    = '/////news';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'news', $url);

        /*
         * Parameter 2 - action or sub
         */
        $urlstring    = '/news/show';
        $internal_url = false;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'news/show', $url);

        /*
         * Internal URLs (mod_rewrite style)
         * This should by-pass...
         */
        $urlstring    = '/news/show/42';
        $internal_url = true;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'news/show/42', $url);

        $urlstring    = '/news/admin/edit/1';
        $internal_url = true;

        $url          = $this->router->buildURL($urlstring, $internal_url);

        $this->assertEquals(WWW_ROOT . 'news/admin/edit/1', $url);
    }
}

KSST / KF

RouterTest A last analyzed 2017-04-11 14:32 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like

RouterTest A
last analyzed 2017-04-11 14:32 UTC
