phpDocumentor\Transformer\Writer\Xml\PropertyConverterTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	testPropertyXmlElementIsCreated()	0	23	1
A	testNamespaceNameIsTakenFromNamespaceDescriptorIfPresent()	0	16	1
A	prepareParentXMLElement()	0	8	1
A	createPropertyDescriptorMock()	0	13	1
A	createFixture()	0	7	1

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @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\Transformer\Writer\Xml;

use Mockery as m;
use phpDocumentor\Descriptor\DescriptorAbstract;
use phpDocumentor\Descriptor\PropertyDescriptor;

/**
 * Test class for \phpDocumentor\Transformer\Writer\Xml\PropertyConverter.
 *
 * @covers phpDocumentor\Transformer\Writer\Xml\PropertyConverter
 */
class PropertyConverterTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    /**
     * Tests whether the XML Element representing a property is properly created.
     *
     * @covers phpDocumentor\Transformer\Writer\Xml\PropertyConverter::convert
     */
    public function testPropertyXmlElementIsCreated()
    {
        // Arrange
        $property = $this->createPropertyDescriptorMock();
        $propertyConverter = $this->createFixture($property);
        $parent = $this->prepareParentXMLElement();
        $parent->setAttribute('namespace', 'phpDocumentor');

        // Act
        $convertedElement = $propertyConverter->convert($parent, $property);

$property is of type object<Mockery\MockInterface>|object<phpDocumentor\Descriptor\DescriptorAbstract>, but the function expects a object<phpDocumentor\Descriptor\PropertyDescriptor>.

        // Assert
        $this->assertSame('false', $convertedElement->getAttribute('static'));
        $this->assertSame('protected', $convertedElement->getAttribute('visibility'));
        $this->assertSame('100', $convertedElement->getAttribute('line'));
        $this->assertSame('phpDocumentor', $convertedElement->getAttribute('namespace'));
        $this->assertSame('$Property', $convertedElement->getElementsByTagName('name')->item(0)->nodeValue);
        $this->assertSame(
            'phpDocumentor\Class::$Property',
            $convertedElement->getElementsByTagName('full_name')->item(0)->nodeValue
        );
        $this->assertSame('defaultString', $convertedElement->getElementsByTagName('default')->item(0)->nodeValue);
    }

    /**
     * Tests whether the XML Element representing a property is properly created.
     *
     * @covers phpDocumentor\Transformer\Writer\Xml\PropertyConverter::convert
     */
    public function testNamespaceNameIsTakenFromNamespaceDescriptorIfPresent()
    {
        // Arrange
        $parent = $this->prepareParentXMLElement();
        $namespaceDescriptor = m::mock('phpDocumentor\Descriptor\NamespaceDescriptor');
        $namespaceDescriptor->shouldReceive('getFullyQualifiedStructuralElementName')->andReturn('MySpace');

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

        $property = $this->createPropertyDescriptorMock();
        $property->shouldReceive('getNamespace')->andReturn($namespaceDescriptor);

The method shouldReceive does only exist in Mockery\MockInterface, but not in phpDocumentor\Descriptor\DescriptorAbstract.

        $propertyConverter = $this->createFixture($property);

        // Act
        $convertedElement = $propertyConverter->convert($parent, $property);

$property is of type object<Mockery\MockInterface>|object<phpDocumentor\Descriptor\DescriptorAbstract>, but the function expects a object<phpDocumentor\Descriptor\PropertyDescriptor>.

        // Assert
        $this->assertSame('MySpace', $convertedElement->getAttribute('namespace'));
    }

    /**
     * Creates an XML Element that can serve as parent.
     *
     * @return \DOMElement
     */
    protected function prepareParentXMLElement()
    {
        $document = new \DOMDocument();
        $parent = new \DOMElement('class');
        $document->appendChild($parent);

        return $parent;
    }

    /**
     * Creates a mock for the PropertyDescriptor class.
     *
     * @return m\MockInterface|DescriptorAbstract
     */
    protected function createPropertyDescriptorMock()
    {
        $property = m::mock('phpDocumentor\\Descriptor\\PropertyDescriptor');
        $property->shouldReceive('getLine')->andReturn(100);

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

        $property->shouldReceive('isStatic')->andReturn(false);
        $property->shouldReceive('getVisibility')->andReturn('protected');
        $property->shouldReceive('getName')->andReturn('Property');
        $property->shouldReceive('getFullyQualifiedStructuralElementName')->andReturn('phpDocumentor\Class::$Property');
        $property->shouldReceive('getDefault')->andReturn('defaultString');
        $property->shouldIgnoreMissing();

        return $property;
    }

    /**
     * Creates the PropertyConverter fixture with a DocBlock mock.
     *
     * @return PropertyConverter
     */
    protected function createFixture(PropertyDescriptor $property)
    {
        $docBlockConverter = m::mock('phpDocumentor\Transformer\Writer\Xml\DocBlockConverter');
        $docBlockConverter->shouldReceive('convert')->with(m::type('DOMElement'), $property);

        return new PropertyConverter($docBlockConverter);
    }
}