SonataAdminBundle/Tests/Route/RouteCollectionTest.php

<?php

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Tests\Route;

use Sonata\AdminBundle\Route\RouteCollection;

class RouteCollectionTest extends \PHPUnit_Framework_TestCase
{
    public function testGetter()
    {
        $routeCollection = new RouteCollection('base.Code.Route', 'baseRouteName', 'baseRoutePattern', 'baseControllerName');

        $this->assertSame('base.Code.Route', $routeCollection->getBaseCodeRoute());
        $this->assertSame('baseRouteName', $routeCollection->getBaseRouteName());
        $this->assertSame('baseRoutePattern', $routeCollection->getBaseRoutePattern());
        $this->assertSame('baseControllerName', $routeCollection->getBaseControllerName());
    }

    public function testActionify()
    {
        $routeCollection = new RouteCollection('base.Code.Route', 'baseRouteName', 'baseRoutePattern', 'BundleName:ControllerName');

        $this->assertSame('fooBar', $routeCollection->actionify('Foo bar'));
        $this->assertSame('bar', $routeCollection->actionify('Foo.bar'));
    }

    public function testActionifyService()
    {
        $routeCollection = new RouteCollection('base.Code.Route', 'baseRouteName', 'baseRoutePattern', 'baseControllerService');

        $this->assertSame('fooBarAction', $routeCollection->actionify('Foo bar'));
        $this->assertSame('barAction', $routeCollection->actionify('Foo.bar'));
    }

    public function testCode()
    {
        $routeCollection = new RouteCollection('base.Code.Route', 'baseRouteName', 'baseRoutePattern', 'baseControllerName');

        $this->assertSame('base.Code.Route.test', $routeCollection->getCode('test'));
        $this->assertSame('base.Code.Route.test', $routeCollection->getCode('base.Code.Route.test'));
    }

    public function testCollection()
    {
        $routeCollection = new RouteCollection('base.Code.Route', 'baseRouteName', 'baseRoutePattern', 'baseControllerName');

        $routeCollection->add('view');
        $this->assertTrue($routeCollection->has('view'));

        $routeCollection->remove('view');
        $this->assertFalse($routeCollection->has('view'));

        $routeCollection->add('create');
        $route = $routeCollection->get('create');

        $this->assertInstanceOf('Symfony\Component\Routing\Route', $route);

        $routeCollection->add('view');
        $routeCollection->add('edit');
        $routeCollection->clear();
        $this->assertFalse($routeCollection->has('create'));
        $this->assertFalse($routeCollection->has('view'));
        $this->assertFalse($routeCollection->has('edit'));

        $routeCollection->add('create');
        $routeCollection->add('view');
        $routeCollection->add('edit');
        $routeCollection->add('list');
        $routeCollection->clearExcept(array('create', 'edit'));
        $this->assertTrue($routeCollection->has('create'));
        $this->assertTrue($routeCollection->has('edit'));
        $this->assertFalse($routeCollection->has('view'));
        $this->assertFalse($routeCollection->has('list'));

        $routeCollection->clearExcept('create');
        $this->assertTrue($routeCollection->has('create'));
        $this->assertFalse($routeCollection->has('edit'));
    }

    public function testGetWithException()
    {
        $this->setExpectedException('\InvalidArgumentException', 'Element "foo" does not exist.');

        $routeCollection = new RouteCollection('base.Code.Route', 'baseRouteName', 'baseRoutePattern', 'baseControllerName');
        $routeCollection->get('foo');
    }

    public function testChildCollection()
    {
        $childCollection = new RouteCollection('baseCodeRouteChild', 'baseRouteNameChild', 'baseRoutePatternChild', 'baseControllerNameChild');
        $childCollection->add('view');
        $childCollection->add('create');

        $parentCollection = new RouteCollection('baseCodeRoute', 'baseRouteName', 'baseRoutePattern', 'baseControllerName');
        $parentCollection->add('view');
        $parentCollection->add('edit');

        $parentCollection->addCollection($childCollection);

        $this->assertTrue($parentCollection->has('view'));
        $this->assertTrue($parentCollection->has('edit'));
        $this->assertFalse($parentCollection->has('create'));

        $this->assertFalse($parentCollection->has('baseCodeRouteChild.edit'));
    }

    public function testRoute()
    {
        $routeCollection = new RouteCollection('baseCodeRoute', 'baseRouteName', 'baseRoutePattern', 'BundleName:ControllerName');

        $routeCollection->add('view');

        $route = $routeCollection->get('view');

        $this->assertSame('BundleName:ControllerName:view', $route->getDefault('_controller'));
        $this->assertSame('baseCodeRoute', $route->getDefault('_sonata_admin'));
        $this->assertSame('baseRouteName_view', $route->getDefault('_sonata_name'));
    }

    public function testRouteWithAllConstructorParameters()
    {
        $baseCodeRoute = 'baseCodeRoute';
        $baseRouteName = 'baseRouteName';
        $baseRoutePattern = 'baseRoutePattern';
        $routeCollection = new RouteCollection($baseCodeRoute, $baseRouteName, $baseRoutePattern, 'BundleName:ControllerName');

        $name = 'view';
        $pattern = 'view';
        $defaults = array(
            '_controller' => 'BundleName:ControllerName:viewAction',
        );
        $requirements = array(
            'page' => '\d+',
        );
        $options = array(
            'debug' => true,
        );
        $host = 'test.local';
        $schemes = array(
            'https',
        );
        $methods = array(
            'GET',
            'POST',
        );
        $condition = "context.getMethod() in ['GET', 'HEAD'] and request.headers.get('User-Agent') matches '/firefox/i'";

        $routeCollection->add($name, $pattern, $defaults, $requirements, $options, $host, $schemes, $methods, $condition);

        $route = $routeCollection->get($name);

        $combinedPattern = '/'.$baseRoutePattern.'/'.($pattern ?: $name);

        $this->assertSame($combinedPattern, $route->getPath());
        $this->assertArrayHasKey('_controller', $route->getDefaults());
        $this->assertArrayHasKey('page', $route->getRequirements());
        $this->assertArrayHasKey('debug', $route->getOptions());
        $this->assertSame($host, $route->getHost());
        $this->assertSame($methods, $route->getMethods());
        if (method_exists($route, 'getCondition')) {
            $this->assertSame($condition, $route->getCondition());
        }
    }

    public function testRouteControllerService()
    {
        $routeCollection = new RouteCollection('baseCodeRoute', 'baseRouteName', 'baseRoutePattern', 'baseControllerServiceName');

        $routeCollection->add('view');

        $route = $routeCollection->get('view');

        $this->assertSame('baseControllerServiceName:viewAction', $route->getDefault('_controller'));
        $this->assertSame('baseCodeRoute', $route->getDefault('_sonata_admin'));
        $this->assertSame('baseRouteName_view', $route->getDefault('_sonata_name'));
    }
}