eZ\Publish\Core\REST\Common\Tests\Output\ValueObjectVisitorBaseTest

Complexity

Total Complexity

20

Size/Duplication

Total Lines	237
Duplicated Lines	17.3 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getVisitorMock()	19	19	2
A	getResponseMock()	0	8	2
A	getGenerator()	0	10	2
A	assertXPath()	0	13	2
A	getVisitor()	0	9	1
A	getRequestParser()	0	8	2
A	getRouterMock()	0	8	2
A	resetRouterMock()	0	5	1
A	addRouteExpectation()	11	11	1
A	setVisitValueObjectExpectations()	0	14	2
A	getTemplatedRouterMock()	0	8	2
A	addTemplatedRouteExpectation()	11	11	1
	internalGetVisitor()	0	1	?

<?php

/**
 * File containing ValueObjectVisitorBaseTest class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 *
 * @version //autogentag//
 */
namespace eZ\Publish\Core\REST\Common\Tests\Output;

use eZ\Publish\Core\REST\Common\Tests\AssertXmlTagTrait;
use eZ\Publish\Core\REST\Server\Tests;
use eZ\Publish\Core\REST\Common\Output\Generator;
use eZ\Publish\Core\REST\Common\RequestParser as RequestParser;

abstract class ValueObjectVisitorBaseTest extends Tests\BaseTest
{
    use AssertXmlTagTrait;

    /**
     * Visitor mock.
     *
     * @var \eZ\Publish\Core\REST\Common\Output\Visitor
     */
    protected $visitorMock;

    /**
     * Output generator.
     *
     * @var \eZ\Publish\Core\REST\Common\Output\Generator\Xml
     */
    protected $generator;

    /**
     * @var \eZ\Publish\Core\REST\Common\RequestParser
     */
    protected $requestParser;

    /**
     * @var \Symfony\Component\Routing\RouterInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    private $routerMock;

    /**
     * @var \Symfony\Component\Routing\RouterInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    private $templatedRouterMock;

    /** @var int */
    private $routerCallIndex = 0;

    /** @var int */
    private $templatedRouterCallIndex = 0;

    /**
     * Gets the visitor mock.
     *
     * @return \eZ\Publish\Core\REST\Common\Output\Visitor|\PHPUnit_Framework_MockObject_MockObject
     */
    protected function getVisitorMock()
    {
        if (!isset($this->visitorMock)) {
            $this->visitorMock = $this->getMock(
                '\\eZ\\Publish\\Core\\REST\\Common\\Output\\Visitor',
                array(),
                array(),
                '',
                false
            );

            $this->visitorMock
                ->expects($this->any())
                ->method('getResponse')
                ->will($this->returnValue($this->getResponseMock()));
        }

        return $this->visitorMock;
    }

    /**
     * @return \Symfony\Component\HttpFoundation\Response|\PHPUnit_Framework_MockObject_MockObject
     */
    protected function getResponseMock()
    {
        if (!isset($this->responseMock)) {
            $this->responseMock = $this->getMock('Symfony\Component\HttpFoundation\Response');

The property responseMock does not exist. Did you maybe forget to declare it?

        }

        return $this->responseMock;
    }

    /**
     * Gets the output generator.
     *
     * @return \eZ\Publish\Core\REST\Common\Output\Generator\Xml
     */
    protected function getGenerator()
    {
        if (!isset($this->generator)) {
            $this->generator = new Generator\Xml(
                new Generator\Xml\FieldTypeHashGenerator()
            );
        }

        return $this->generator;
    }

    /**
     * Asserts that the given $xpathExpression returns a non empty node set
     * with $domNode as its context.
     *
     * This method asserts that $xpathExpression results in a non-empty node
     * set in context of $domNode, by wrapping the "boolean()" function around
     * it and evaluating it on the document owning $domNode.
     *
     * @param \DOMNode $domNode
     * @param string $xpathExpression
     */
    protected function assertXPath(\DOMNode $domNode, $xpathExpression)
    {
        $ownerDocument = ($domNode instanceof \DOMDOcument
            ? $domNode
            : $domNode->ownerDocument);

        $xpath = new \DOMXPath($ownerDocument);

        $this->assertTrue(
            $xpath->evaluate("boolean({$xpathExpression})", $domNode),
            "XPath expression '{$xpathExpression}' resulted in an empty node set."
        );
    }

    protected function getVisitor()
    {
        $visitor = $this->internalGetVisitor();
        $visitor->setRequestParser($this->getRequestParser());

It seems like $this->getRequestParser() targeting eZ\Publish\Core\REST\Common\Tests\Output\ValueObjectVisitorBaseTest::getRequestParser() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::setRequestParser() does only seem to accept object<eZ\Publish\Core\REST\Common\RequestParser>, maybe add an additional type check?

        $visitor->setRouter($this->getRouterMock());

It seems like $this->getRouterMock() targeting eZ\Publish\Core\REST\Common\Tests\Output\ValueObjectVisitorBaseTest::getRouterMock() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::setRouter() does only seem to accept object<Symfony\Component\Routing\RouterInterface>, maybe add an additional type check?

        $visitor->setTemplateRouter($this->getTemplatedRouterMock());

It seems like $this->getTemplatedRouterMock() targeting eZ\Publish\Core\REST\Common\Tests\Output\ValueObjectVisitorBaseTest::getTemplatedRouterMock() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::setTemplateRouter() does only seem to accept object<Symfony\Component\Routing\RouterInterface>, maybe add an additional type check?

        return $visitor;
    }

    /**
     * @return \eZ\Publish\Core\REST\Common\RequestParser|\PHPUnit_Framework_MockObject_MockObject
     */
    protected function getRequestParser()
    {
        if (!isset($this->requestParser)) {
            $this->requestParser = $this->getMock('eZ\\Publish\\Core\\REST\\Common\\RequestParser');
        }

        return $this->requestParser;
    }

    /**
     * @return \Symfony\Component\Routing\RouterInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    protected function getRouterMock()
    {
        if (!isset($this->routerMock)) {
            $this->routerMock = $this->getMock('Symfony\\Component\\Routing\\RouterInterface');
        }

        return $this->routerMock;
    }

    /**
     * Resets the router mock and its expected calls index & list.
     */
    protected function resetRouterMock()
    {
        $this->routerMock = null;
        $this->routerMockCallIndex = 0;

The property routerMockCallIndex does not seem to exist. Did you mean routerMock?

    }

    /**
     * Adds an expectation to the routerMock. Expectations must be added sequentially.
     *
     * @param string $routeName
     * @param array $arguments
     * @param string $returnValue
     */
    protected function addRouteExpectation($routeName, $arguments, $returnValue)
    {
        $this->getRouterMock()
            ->expects($this->at($this->routerCallIndex++))
            ->method('generate')
            ->with(
                $this->equalTo($routeName),
                $this->equalTo($arguments)
            )
            ->will($this->returnValue($returnValue));
    }

    /**
     * Adds the expectated value object visit calls sequence.
     *
     * @param array $valueObjects Array of visited value object, or of phpunit matcher ($this->instanceOf(), etc...) .
     */
    protected function setVisitValueObjectExpectations(array $valueObjects)
    {
        $consecutiveCalls = [];
        foreach ($valueObjects as $valueObject) {
            $consecutiveCalls = [
                $valueObject,
                $this->getGenerator(),
                $this->getVisitorMock(),
            ];
        }

        $mocker = $this->getVisitorMock()->expects($this->any())->method('visitValueObject');
        call_user_func_array([$mocker, 'withConsecutive'], $consecutiveCalls);
    }

    /**
     * @return \Symfony\Component\Routing\RouterInterface|\PHPUnit_Framework_MockObject_MockObject
     */
    protected function getTemplatedRouterMock()
    {
        if (!isset($this->templatedRouterMock)) {
            $this->templatedRouterMock = $this->getMock('Symfony\\Component\\Routing\\RouterInterface');
        }

        return $this->templatedRouterMock;
    }

    /**
     * Adds an expectation to the templatedRouterMock. Expectations must be added sequentially.
     *
     * @param string $routeName
     * @param array $arguments
     * @param string $returnValue
     */
    protected function addTemplatedRouteExpectation($routeName, $arguments, $returnValue)
    {
        $this->getTemplatedRouterMock()
            ->expects($this->at($this->templatedRouterCallIndex++))
            ->method('generate')
            ->with(
                $this->equalTo($routeName),
                $this->equalTo($arguments)
            )
            ->will($this->returnValue($returnValue));
    }

    /**
     * Must return an instance of the tested visitor object.
     *
     * @return \eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor
     */
    abstract protected function internalGetVisitor();
}