phpDocumentor\Descriptor\Builder\Reflector\ClassAssemblerTest

Complexity

Total Complexity

7

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	5	1
A	testCreateClassDescriptorFromReflector()	0	21	1
A	getClassReflectorDescriptor()	0	28	1
A	getProjectDescriptorBuilderMock()	0	32	4

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @author    Mike van Riel <mike.vanriel@naenius.com>
 * @author    Sven Hagemann <sven@rednose.nl>
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Descriptor\Builder\Reflector;

use Mockery as m;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\Php\Class_;
use phpDocumentor\Reflection\Php\Constant;
use phpDocumentor\Reflection\Php\Method;
use phpDocumentor\Reflection\Php\Property;

/**
 * Test class for \phpDocumentor\Descriptor\Builder
 *
 * @covers \phpDocumentor\Descriptor\Builder\Reflector\ClassAssembler
 */
class ClassAssemblerTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    /** @var ClassAssembler $fixture */
    protected $fixture;

    /**
     * Creates a new fixture to test with.
     */
    protected function setUp()
    {
        $this->fixture = new ClassAssembler();
        $this->fixture->setBuilder($this->getProjectDescriptorBuilderMock());
    }

    /**
     * Creates a Descriptor from a provided class.
     *
     * @covers \phpDocumentor\Descriptor\Builder\Reflector\ClassAssembler::create
     */
    public function testCreateClassDescriptorFromReflector()
    {
        $name = 'ClassName';
        $namespace = 'Namespace';
        $docBlockDescriptionContent = <<<DOCBLOCK
/**
 * This is a example description
 */
DOCBLOCK;

        $classReflectorMock = $this->getClassReflectorDescriptor();

        $descriptor = $this->fixture->create($classReflectorMock);

        $this->assertSame(
            '\\' . $namespace . '\\' . $name,
            (string) $descriptor->getFullyQualifiedStructuralElementName()
        );
        $this->assertSame($name, $descriptor->getName());
        $this->assertSame((string) $descriptor->getDescription(), $docBlockDescriptionContent);
    }

    /**
     * Create a ClassReflector mock
     *
     * @return Class_
     */
    protected function getClassReflectorDescriptor()
    {
        $name = 'ClassName';
        $namespace = 'Namespace';
        $docBlockDescriptionContent = <<<DOCBLOCK
/**
 * This is a example description
 */
DOCBLOCK;
        $docBlockMock = new DocBlock(
            'This is a example description',
            new DocBlock\Description($docBlockDescriptionContent),
            []
        );

        $classFqsen = new Fqsen('\\' . $namespace . '\\' . $name);
        $classReflectorMock = new Class_(
            $classFqsen,
            $docBlockMock
        );

        $classReflectorMock->addConstant(new Constant(new Fqsen($classFqsen . '::Constant')));
        $classReflectorMock->addInterface(new Fqsen('\\TestInterface'));
        $classReflectorMock->addProperty(new Property(new Fqsen($classFqsen . '::$property')));
        $classReflectorMock->addMethod(new Method(new Fqsen($classFqsen . '::method()')));

        return $classReflectorMock;
    }

    /**
     * Create a descriptor builder mock
     *
     * @return m\MockInterface
     */
    protected function getProjectDescriptorBuilderMock()
    {
        $projectDescriptorBuilderMock = m::mock('phpDocumentor\Descriptor\ProjectDescriptorBuilder');
        $projectDescriptorBuilderMock->shouldReceive('getDefaultPackage')->andReturn('\\');

The method andReturn does only exist in Mockery\ExpectationInterface, but not in Mockery\HigherOrderMessage.

        $projectDescriptorBuilderMock->shouldReceive('buildDescriptor')->andReturnUsing(function ($param) {
            $mock = null;

            switch ($param) {
                case 'Properties':
                    $mock = m::mock('phpDocumentor\Descriptor\PropertiesDescriptor');
                    $mock->shouldReceive('getName')->once()->andReturn('Mock');
                    $mock->shouldReceive('setParent')->once()->andReturn();
                    break;

                case 'Method':
                    $mock = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
                    $mock->shouldReceive('getName')->once()->andReturn('Mock');
                    $mock->shouldReceive('setParent')->once()->andReturn();
                    break;

                case 'Constant':
                    $mock = m::mock('phpDocumentor\Descriptor\ConstantDescriptor');
                    $mock->shouldReceive('getName')->once()->andReturn('Mock');
                    $mock->shouldReceive('setParent')->once()->andReturn();
                    break;
            }

            return $mock;
        });

        return $projectDescriptorBuilderMock;
    }
}