AnnotationClassLoaderTest.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Routing\Tests\Loader;

class AnnotationClassLoaderTest extends AbstractAnnotationLoaderTest {
  protected $loader;
  protected function setUp() {
    parent::setUp();
    $this->reader = $this
      ->getReader();
    $this->loader = $this
      ->getClassLoader($this->reader);
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testLoadMissingClass() {
    $this->loader
      ->load('MissingClass');
  }

  /**
   * @expectedException \InvalidArgumentException
   */
  public function testLoadAbstractClass() {
    $this->loader
      ->load('Symfony\\Component\\Routing\\Tests\\Fixtures\\AnnotatedClasses\\AbstractClass');
  }

  /**
   * @dataProvider provideTestSupportsChecksResource
   */
  public function testSupportsChecksResource($resource, $expectedSupports) {
    $this
      ->assertSame($expectedSupports, $this->loader
      ->supports($resource), '->supports() returns true if the resource is loadable');
  }
  public function provideTestSupportsChecksResource() {
    return array(
      array(
        'class',
        true,
      ),
      array(
        '\\fully\\qualified\\class\\name',
        true,
      ),
      array(
        'namespaced\\class\\without\\leading\\slash',
        true,
      ),
      array(
        'ÿClassWithLegalSpecialCharacters',
        true,
      ),
      array(
        '5',
        false,
      ),
      array(
        'foo.foo',
        false,
      ),
      array(
        null,
        false,
      ),
    );
  }
  public function testSupportsChecksTypeIfSpecified() {
    $this
      ->assertTrue($this->loader
      ->supports('class', 'annotation'), '->supports() checks the resource type if specified');
    $this
      ->assertFalse($this->loader
      ->supports('class', 'foo'), '->supports() checks the resource type if specified');
  }
  public function getLoadTests() {
    return array(
      array(
        'Symfony\\Component\\Routing\\Tests\\Fixtures\\AnnotatedClasses\\BarClass',
        array(
          'name' => 'route1',
        ),
        array(
          'arg2' => 'defaultValue2',
          'arg3' => 'defaultValue3',
        ),
      ),
      array(
        'Symfony\\Component\\Routing\\Tests\\Fixtures\\AnnotatedClasses\\BarClass',
        array(
          'name' => 'route1',
          'defaults' => array(
            'arg2' => 'foo',
          ),
        ),
        array(
          'arg2' => 'defaultValue2',
          'arg3' => 'defaultValue3',
        ),
      ),
    );
  }

  /**
   * @dataProvider getLoadTests
   */
  public function testLoad($className, $routeDatas = array(), $methodArgs = array()) {
    $routeDatas = array_replace(array(
      'name' => 'route',
      'path' => '/',
      'requirements' => array(),
      'options' => array(),
      'defaults' => array(),
      'schemes' => array(),
      'methods' => array(),
    ), $routeDatas);
    $this->reader
      ->expects($this
      ->once())
      ->method('getMethodAnnotations')
      ->will($this
      ->returnValue(array(
      $this
        ->getAnnotatedRoute($routeDatas),
    )));
    $routeCollection = $this->loader
      ->load($className);
    $route = $routeCollection
      ->get($routeDatas['name']);
    $this
      ->assertSame($routeDatas['path'], $route
      ->getPath(), '->load preserves path annotation');
    $this
      ->assertSame($routeDatas['requirements'], $route
      ->getRequirements(), '->load preserves requirements annotation');
    $this
      ->assertCount(0, array_intersect($route
      ->getOptions(), $routeDatas['options']), '->load preserves options annotation');
    $this
      ->assertSame(array_replace($routeDatas['defaults'], $methodArgs), $route
      ->getDefaults(), '->load preserves defaults annotation');
  }
  private function getAnnotatedRoute($datas) {
    return new \Symfony\Component\Routing\Annotation\Route($datas);
  }

}