phpDocumentor / phpDocumentor

tests/unit/phpDocumentor/Transformer/Writer/Xml/TraitConverterTest.php

<?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\MethodDescriptor;
use phpDocumentor\Descriptor\PropertyDescriptor;
use phpDocumentor\Descriptor\TraitDescriptor;

/**
 * Test class for \phpDocumentor\Transformer\Writer\Xml\TraitConverter.
 *
 * @covers \phpDocumentor\Transformer\Writer\Xml\TraitConverter
 */
class TraitConverterTest extends \Mockery\Adapter\Phpunit\MockeryTestCase
{
    /**
     * Tests whether the XML Element representing a trait is properly created.
     *
     * @covers \phpDocumentor\Transformer\Writer\Xml\TraitConverter::convert
     */
    public function testTraitXmlElementIsCreated()
    {
        // Arrange
        $methodDescriptor = m::mock('phpDocumentor\Descriptor\MethodDescriptor');
        $propertyDescriptor = m::mock('phpDocumentor\Descriptor\PropertyDescriptor');
        $namespaceDescriptor = m::mock('phpDocumentor\Descriptor\NamespaceDescriptor');
        $namespaceDescriptor->shouldReceive('getFullyQualifiedStructuralElementName')->andReturn('phpDocumentor');

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

        $trait = $this->createTraitDescriptorMock();
        $trait->shouldReceive('getMethods')->andReturn([$methodDescriptor]);

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

        $trait->shouldReceive('getProperties')->andReturn([$propertyDescriptor]);
        $trait->shouldReceive('getNamespace')->andReturn($namespaceDescriptor);
        $parent = $this->prepareParentXMLElement();
        $traitConverter = $this->createFixture($trait, $methodDescriptor, $propertyDescriptor);

        // Act
        $convertedElement = $traitConverter->convert($parent, $trait);

        // Assert
        $this->assertSame('100', $convertedElement->getAttribute('line'));
        $this->assertSame('phpDocumentor', $convertedElement->getAttribute('namespace'));
        $this->assertSame('Trait', $convertedElement->getElementsByTagName('name')->item(0)->nodeValue);
        $this->assertSame(
            'phpDocumentor\Trait',
            $convertedElement->getElementsByTagName('full_name')->item(0)->nodeValue
        );
    }

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

        return $parent;
    }

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

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

        $trait->shouldReceive('getName')->andReturn('Trait');
        $trait->shouldReceive('getFullyQualifiedStructuralElementName')->andReturn('phpDocumentor\Trait');
        $trait->shouldIgnoreMissing();

        return $trait;
    }

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

        $methodConverter = m::mock('phpDocumentor\Transformer\Writer\Xml\MethodConverter');
        $methodConverter->shouldReceive('convert')->with(m::type('DOMElement'), $method);

        $propertyConverter = m::mock('phpDocumentor\Transformer\Writer\Xml\PropertyConverter');
        $propertyConverter->shouldReceive('convert')->with(m::type('DOMElement'), $property);

        return new TraitConverter($docBlockConverter, $methodConverter, $propertyConverter);
    }
}