ValueObjectVisitorBaseTest::setVisitValueObjectExpectations() - Code Metrics - Inspection of "Added Vary header X-eZ-Embed-Value to ResourceLink..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp26352-skip_csrf_check_on_re... ( 19f37a )

unknown

created 2016-09-21 12:01 UTC

setVisitValueObjectExpectations() A

↳ Parent: ValueObjectVisitorBaseTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	9
nc	2
nop	1
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0

<?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');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        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());

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

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


        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;

    }

    /**
     * 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();
}


1		<?php
2
3		/**
4		* File containing ValueObjectVisitorBaseTest class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*
9		* @version //autogentag//
10		*/
11		namespace eZ\Publish\Core\REST\Common\Tests\Output;
12
13		use eZ\Publish\Core\REST\Common\Tests\AssertXmlTagTrait;
14		use eZ\Publish\Core\REST\Server\Tests;
15		use eZ\Publish\Core\REST\Common\Output\Generator;
16		use eZ\Publish\Core\REST\Common\RequestParser as RequestParser;
17
18		abstract class ValueObjectVisitorBaseTest extends Tests\BaseTest
19		{
20		use AssertXmlTagTrait;
21
22		/**
23		* Visitor mock.
24		*
25		* @var \eZ\Publish\Core\REST\Common\Output\Visitor
26		*/
27		protected $visitorMock;
28
29		/**
30		* Output generator.
31		*
32		* @var \eZ\Publish\Core\REST\Common\Output\Generator\Xml
33		*/
34		protected $generator;
35
36		/**
37		* @var \eZ\Publish\Core\REST\Common\RequestParser
38		*/
39		protected $requestParser;
40
41		/**
42		* @var \Symfony\Component\Routing\RouterInterface\|\PHPUnit_Framework_MockObject_MockObject
43		*/
44		private $routerMock;
45
46		/**
47		* @var \Symfony\Component\Routing\RouterInterface\|\PHPUnit_Framework_MockObject_MockObject
48		*/
49		private $templatedRouterMock;
50
51		/** @var int */
52		private $routerCallIndex = 0;
53
54		/** @var int */
55		private $templatedRouterCallIndex = 0;
56
57		/**
58		* Gets the visitor mock.
59		*
60		* @return \eZ\Publish\Core\REST\Common\Output\Visitor\|\PHPUnit_Framework_MockObject_MockObject
61		*/
62	View Code Duplication	protected function getVisitorMock()
63		{
64		if (!isset($this->visitorMock)) {
65		$this->visitorMock = $this->getMock(
66		'\\eZ\\Publish\\Core\\REST\\Common\\Output\\Visitor',
67		array(),
68		array(),
69		'',
70		false
71		);
72
73		$this->visitorMock
74		->expects($this->any())
75		->method('getResponse')
76		->will($this->returnValue($this->getResponseMock()));
77		}
78
79		return $this->visitorMock;
80		}
81
82		/**
83		* @return \Symfony\Component\HttpFoundation\Response\|\PHPUnit_Framework_MockObject_MockObject
84		*/
85		protected function getResponseMock()
86		{
87		if (!isset($this->responseMock)) {
88		$this->responseMock = $this->getMock('Symfony\Component\HttpFoundation\Response');
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `responseMock` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
89		}
90
91		return $this->responseMock;
92		}
93
94		/**
95		* Gets the output generator.
96		*
97		* @return \eZ\Publish\Core\REST\Common\Output\Generator\Xml
98		*/
99		protected function getGenerator()
100		{
101		if (!isset($this->generator)) {
102		$this->generator = new Generator\Xml(
103		new Generator\Xml\FieldTypeHashGenerator()
104		);
105		}
106
107		return $this->generator;
108		}
109
110		/**
111		* Asserts that the given $xpathExpression returns a non empty node set
112		* with $domNode as its context.
113		*
114		* This method asserts that $xpathExpression results in a non-empty node
115		* set in context of $domNode, by wrapping the "boolean()" function around
116		* it and evaluating it on the document owning $domNode.
117		*
118		* @param \DOMNode $domNode
119		* @param string $xpathExpression
120		*/
121		protected function assertXPath(\DOMNode $domNode, $xpathExpression)
122		{
123		$ownerDocument = ($domNode instanceof \DOMDOcument
124		? $domNode
125		: $domNode->ownerDocument);
126
127		$xpath = new \DOMXPath($ownerDocument);
128
129		$this->assertTrue(
130		$xpath->evaluate("boolean({$xpathExpression})", $domNode),
131		"XPath expression '{$xpathExpression}' resulted in an empty node set."
132		);
133		}
134
135		protected function getVisitor()
136		{
137		$visitor = $this->internalGetVisitor();
138		$visitor->setRequestParser($this->getRequestParser());
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report It seems like `$this->getRequestParser()` targeting `eZ\Publish\Core\REST\Com...est::getRequestParser()` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `eZ\Publish\Core\REST\Com...tor::setRequestParser()` does only seem to accept `object<eZ\Publish\Core\REST\Common\RequestParser>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
139		$visitor->setRouter($this->getRouterMock());
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report It seems like `$this->getRouterMock()` targeting `eZ\Publish\Core\REST\Com...seTest::getRouterMock()` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `eZ\Publish\Core\REST\Com...ectVisitor::setRouter()` does only seem to accept `object<Symfony\Component\Routing\RouterInterface>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
140		$visitor->setTemplateRouter($this->getTemplatedRouterMock());
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report It seems like `$this->getTemplatedRouterMock()` targeting `eZ\Publish\Core\REST\Com...etTemplatedRouterMock()` can also be of type `object<PHPUnit_Framework_MockObject_MockObject>`; however, `eZ\Publish\Core\REST\Com...or::setTemplateRouter()` does only seem to accept `object<Symfony\Component\Routing\RouterInterface>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
141
142		return $visitor;
143		}
144
145		/**
146		* @return \eZ\Publish\Core\REST\Common\RequestParser\|\PHPUnit_Framework_MockObject_MockObject
147		*/
148		protected function getRequestParser()
149		{
150		if (!isset($this->requestParser)) {
151		$this->requestParser = $this->getMock('eZ\\Publish\\Core\\REST\\Common\\RequestParser');
152		}
153
154		return $this->requestParser;
155		}
156
157		/**
158		* @return \Symfony\Component\Routing\RouterInterface\|\PHPUnit_Framework_MockObject_MockObject
159		*/
160		protected function getRouterMock()
161		{
162		if (!isset($this->routerMock)) {
163		$this->routerMock = $this->getMock('Symfony\\Component\\Routing\\RouterInterface');
164		}
165
166		return $this->routerMock;
167		}
168
169		/**
170		* Resets the router mock and its expected calls index & list.
171		*/
172		protected function resetRouterMock()
173		{
174		$this->routerMock = null;
175		$this->routerMockCallIndex = 0;
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `routerMockCallIndex` does not seem to exist. Did you mean `routerMock`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
176		}
177
178		/**
179		* Adds an expectation to the routerMock. Expectations must be added sequentially.
180		*
181		* @param string $routeName
182		* @param array $arguments
183		* @param string $returnValue
184		*/
185	View Code Duplication	protected function addRouteExpectation($routeName, $arguments, $returnValue)
186		{
187		$this->getRouterMock()
188		->expects($this->at($this->routerCallIndex++))
189		->method('generate')
190		->with(
191		$this->equalTo($routeName),
192		$this->equalTo($arguments)
193		)
194		->will($this->returnValue($returnValue));
195		}
196
197		/**
198		* Adds the expectated value object visit calls sequence.
199		*
200		* @param array $valueObjects Array of visited value object, or of phpunit matcher ($this->instanceOf(), etc...) .
201		*/
202		protected function setVisitValueObjectExpectations(array $valueObjects)
203		{
204		$consecutiveCalls = [];
205		foreach ($valueObjects as $valueObject) {
206		$consecutiveCalls = [
207		$valueObject,
208		$this->getGenerator(),
209		$this->getVisitorMock(),
210		];
211		}
212
213		$mocker = $this->getVisitorMock()->expects($this->any())->method('visitValueObject');
214		call_user_func_array([$mocker, 'withConsecutive'], $consecutiveCalls);
215		}
216
217		/**
218		* @return \Symfony\Component\Routing\RouterInterface\|\PHPUnit_Framework_MockObject_MockObject
219		*/
220		protected function getTemplatedRouterMock()
221		{
222		if (!isset($this->templatedRouterMock)) {
223		$this->templatedRouterMock = $this->getMock('Symfony\\Component\\Routing\\RouterInterface');
224		}
225
226		return $this->templatedRouterMock;
227		}
228
229		/**
230		* Adds an expectation to the templatedRouterMock. Expectations must be added sequentially.
231		*
232		* @param string $routeName
233		* @param array $arguments
234		* @param string $returnValue
235		*/
236	View Code Duplication	protected function addTemplatedRouteExpectation($routeName, $arguments, $returnValue)
237		{
238		$this->getTemplatedRouterMock()
239		->expects($this->at($this->templatedRouterCallIndex++))
240		->method('generate')
241		->with(
242		$this->equalTo($routeName),
243		$this->equalTo($arguments)
244		)
245		->will($this->returnValue($returnValue));
246		}
247
248		/**
249		* Must return an instance of the tested visitor object.
250		*
251		* @return \eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor
252		*/
253		abstract protected function internalGetVisitor();
254		}
255

ezsystems / ezpublish-kernel

Push — ezp26352-skip_csrf_check_on_re... ( 19f37a )

setVisitValueObjectExpectations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like