phpDocumentor / phpDocumentor

tests/unit/phpDocumentor/Compiler/Pass/MarkerFromTagsExtractorTest.php

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Compiler\Pass;

use phpDocumentor\Descriptor\ClassDescriptor;
use phpDocumentor\Descriptor\Collection;
use phpDocumentor\Descriptor\DescriptorAbstract;
use phpDocumentor\Descriptor\FileDescriptor;
use phpDocumentor\Descriptor\ProjectDescriptor;
use phpDocumentor\Descriptor\TagDescriptor;

class MarkerFromTagsExtractorTest extends \PHPUnit_Framework_TestCase
{
    /** @var MarkerFromTagsExtractor */
    protected $fixture;

    /** @var ProjectDescriptor */
    protected $project;

    /**
     * Initialize the fixture for this test.
     */
    protected function setUp()
    {
        $this->fixture = new MarkerFromTagsExtractor();
        $this->project = new ProjectDescriptor('MyProject');
    }

    /**
     * @covers phpDocumentor\Compiler\Pass\MarkerFromTagsExtractor::getDescription
     */
    public function testDescriptionReturnsCorrectString()
    {
        $this->assertSame('Collect all markers embedded in tags', $this->fixture->getDescription());
    }

    /**
     * @covers phpDocumentor\Compiler\Pass\MarkerFromTagsExtractor::execute
     * @covers phpDocumentor\Compiler\Pass\MarkerFromTagsExtractor::getFileDescriptor
     * @covers phpDocumentor\Compiler\Pass\MarkerFromTagsExtractor::addTodoMarkerToFile
     */
    public function testAddTodoMarkerForEachTodoTagInAnyElement()
    {
        $fileDescriptor = $this->givenProjectHasFileDescriptor();
        $fileDescriptor->setLine(10);
        $this->givenDescriptorHasTodoTagWithDescription($fileDescriptor, '123');
        $this->givenDescriptorHasTodoTagWithDescription($fileDescriptor, '456');
        $classDescriptor = $this->givenProjectHasClassDescriptorAssociatedWithFile($fileDescriptor);
        $classDescriptor->setLine(20);
        $this->givenDescriptorHasTodoTagWithDescription($classDescriptor, '789');

        $this->fixture->execute($this->project);

        $this->assertCount(2, $fileDescriptor->getTags()->get('todo'));
        $this->assertCount(1, $classDescriptor->getTags()->get('todo'));
        $this->assertCount(3, $fileDescriptor->getMarkers());
        $this->assertSame(
            array('type' => 'TODO', 'message' => '123', 'line' => 10),
            $fileDescriptor->getMarkers()->get(0)
        );
        $this->assertSame(
            array('type' => 'TODO', 'message' => '456', 'line' => 10),
            $fileDescriptor->getMarkers()->get(1)
        );
        $this->assertSame(
            array('type' => 'TODO', 'message' => '789', 'line' => 20),
            $fileDescriptor->getMarkers()->get(2)
        );
    }

    /**
     * @covers phpDocumentor\Compiler\Pass\MarkerFromTagsExtractor::execute
     * @covers phpDocumentor\Compiler\Pass\MarkerFromTagsExtractor::getFileDescriptor
     */
    public function testExceptionShouldBeThrownIfElementHasNoFileAssociated()
    {
        $classDescriptor = $this->givenProjectHasClassDescriptorAssociatedWithFile(null);
        $this->givenDescriptorHasTodoTagWithDescription($classDescriptor, '789');

        $this->setExpectedException(

The method PHPUnit_Framework_TestCase::setExpectedException() has been deprecated with message: Method deprecated since Release 5.2.0; use expectException() instead

            'UnexpectedValueException',
            'An element should always have a file associated with it'
        );

        $this->fixture->execute($this->project);
    }

    /**
     * @return FileDescriptor
     */
    protected function givenProjectHasFileDescriptor()
    {
        $fileDescriptor1 = new FileDescriptor('123');
        $elementIndex = $this->project->getIndexes()->get('elements', new Collection());
        $elementIndex->add($fileDescriptor1);
        return $fileDescriptor1;
    }

    /**
     * @param DescriptorAbstract $descriptor
     * @param string             $description
     */
    protected function givenDescriptorHasTodoTagWithDescription($descriptor, $description)
    {
        $todoTag = new TagDescriptor('todo');
        $todoTag->setDescription($description);

        $todoTags = $descriptor->getTags()->get('todo', array());
        $todoTags[] = $todoTag;
        $descriptor->getTags()->set('todo', $todoTags);
    }

    /**
     * Adds a class descriptor to the project's elements and add a parent file.
     *
     * @param FileDescriptor $fileDescriptor
     *
     * @return ClassDescriptor
     */
    protected function givenProjectHasClassDescriptorAssociatedWithFile($fileDescriptor)
    {
        $classDescriptor = new ClassDescriptor();
        if ($fileDescriptor) {
            $classDescriptor->setFile($fileDescriptor);
        }
        $elementIndex = $this->project->getIndexes()->get('elements', new Collection());
        $elementIndex->add($classDescriptor);
        return $classDescriptor;
    }
}