Pleets / dronephp

test/Mvc/RouterTest.php

<?php
/**
 * DronePHP (http://www.dronephp.com)
 *
 * @link      http://github.com/Pleets/DronePHP
 * @copyright Copyright (c) 2016-2018 Pleets. (http://www.pleets.org)
 * @license   http://www.dronephp.com/license
 * @author    Darío Rivera <fermius.us@gmail.com>
 */

namespace DroneTest\Util;

use Drone\Mvc\AbstractController;
use Drone\Mvc\Exception\MethodExecutionNotAllowedException;
use Drone\Mvc\Exception\RouteNotFoundException;
use Drone\Mvc\ModuleFactory;
use Drone\Mvc\Router;
use PHPUnit\Framework\TestCase;

class RouterTest extends TestCase
{
    /**
     * Tests if the router can create an instance of a class
     *
     * @return null
     */
    public function testSimpleRouteMatch()
    {
        $router = new Router();

        $router->addRoute([
            'App1' => [
                'module'     => 'App',
                'controller' => 'Index',
                'view'       => 'home',
            ],
        ]);

        $router->setIdentifiers('App', 'Index', 'home');
        $router->match();

        $ctrl = $router->getController();

        $this->assertEquals("App\Index", get_class($ctrl));
    }

    /**
     * Tests if the router can create an instance of a class when the route does not exists
     *
     * @return null
     */
    public function testSimpleRouteMatchFail()
    {
        $router = new Router();

        $router->addRoute([
            'App1' => [
                'module'     => 'MyApp',
                'controller' => 'IndexController',
                'view'       => 'home',
            ],
        ]);

        $router->setIdentifiers('App', 'Index', 'home');

        $errorObject = null;

        try {
            $router->match();
        } catch (\Exception $e) {
            $errorObject = ($e instanceof RouteNotFoundException);
        } finally {
            $this->assertTrue($errorObject, $e->getMessage());

The variable $e does not seem to be defined for all execution paths leading up to this point.

        }
    }

    /**
     * Tests if the router can create an instance of a class by a default route
     *
     * @return null
     */
    public function testDefaultRouteMatch()
    {
        $router = new Router();

        $router->addRoute([
            'AppRoute1' => [
                'module'     => 'App',
                'controller' => 'Index',
                'view'       => 'home',
            ],
        ]);

        $router->addRoute([
            'AppRoute2' => [
                'module'     => 'App',
                'controller' => 'Index2',
                'view'       => 'home',
            ],
        ]);

        $router->setDefaults('App', 'Index', 'home');
        $router->match();
        $ctrl = $router->getController();

        $this->assertEquals("App\Index", get_class($ctrl));

        $router->setIdentifiers('App', 'Index2', 'home');
        $router->match();
        $ctrl = $router->getController();

        $this->assertEquals("App\Index2", get_class($ctrl));
    }

    /**
     * Tests if the router can create an instance of a class with non-default class name builder
     *
     * @return null
     */
    public function testSimpleRouteMatchWithParticularName()
    {
        $router = new Router();

        $router->addRoute([
            'App3' => [
                'module'     => 'App',
                'controller' => 'Index',
                'view'       => 'about',
            ],
        ]);

        $router->setIdentifiers('App', 'Index', 'about');

        $router->setClassNameBuilder(function ($module, $class) {
            return "\\$module\Controller\\$class";
        });

        $router->match();

        $ctrl = $router->getController();

        $this->assertEquals("App\Controller\Index", get_class($ctrl));
    }

    /**
     * Tests method execution behaviour handled by the a module
     *
     * @return null
     */
    public function testModuleAndControllerComposition()
    {
        $router = new Router();

        $router->addRoute([
            'App4' => [
                'module'     => 'App',
                'controller' => 'Index',
                'view'       => 'about',
            ],
        ]);

        $router->setIdentifiers('App', 'Index', 'about');

        $router->setClassNameBuilder(function ($module, $class) {
            return "\\$module\Controller\\$class";
        });

        $router->match();

        # inject the module dependency to the controller
        $router->getController()->setModule(ModuleFactory::create("App"));

Drone\Mvc\ModuleFactory::create('App') of type null is incompatible with the type Drone\Mvc\AbstractModule expected by parameter $module of Drone\Mvc\AbstractController::setModule().

Are you sure the usage of Drone\Mvc\ModuleFactory::create('App') targeting Drone\Mvc\ModuleFactory::create() seems to always return null.

        $this->assertNotTrue($router->getController()->getModule()->executionIsAllowed());

Are you sure the usage of $router->getController()->getModule()->executionIsAllowed() targeting Drone\Mvc\AbstractModule::executionIsAllowed() seems to always return null.

        $errorObject = null;

        try {
            $router->run();
        } catch (\Exception $e) {
            $errorObject = ($e instanceof MethodExecutionNotAllowedException);
        } finally {
            $this->assertTrue($errorObject, $e->getMessage());

The variable $e does not seem to be defined for all execution paths leading up to this point.

        }

        $router->getController()->getModule()->allowExecution();

        # returns the result of the method execution in the matched controller
        $result = $router->run();

        $expected = ["foo" => "bar"];
        $this->assertSame($expected, $result);
    }
}

/*
|--------------------------------------------------------------------------
| Controller classes
|--------------------------------------------------------------------------
|
| This are simple controllers implementing AbstractController.
|
*/

namespace App;

use Drone\Mvc\AbstractController;

class Index extends AbstractController
{
    public function home()
    {
        return [];
    }
}

class Index2 extends AbstractController
{
    public function home()
    {
        return [];
    }
}

/*
|--------------------------------------------------------------------------
| Another Controller class
|--------------------------------------------------------------------------
|
| This is a simple controller implementing AbstractController. In order to
| build a framework behavior, we need all classes inside Controller namespace.
|
*/

namespace App\Controller;

use Drone\Mvc\AbstractController;

class Index extends AbstractController
{
    public function about()
    {
        return ['foo' => 'bar'];
    }
}

/*
|--------------------------------------------------------------------------
| Module Class
|--------------------------------------------------------------------------
|
| Each module could have a Module class that handles method execution. It's
| useful for execute some code before method execution or for stop it.
|
*/

namespace App;

use Drone\Mvc\AbstractModule;

class Module extends AbstractModule
{
    public function init()
    {
        # disallowing method execution
        $this->disallowExecution();
    }
}