BaseURLServiceTest::assertUsagesSearchResultItems() - Code Metrics - Inspection of "EZP-28480: As a Developer I want API to manage ext..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cfe8d7...fcc746 )

by André

created 2017-12-14 17:40 UTC

assertUsagesSearchResultItems() A

↳ Parent: BaseURLServiceTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	2
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\API\Repository\Tests;

use eZ\Publish\API\Repository\Values\URL\SearchResult;
use eZ\Publish\API\Repository\Values\URL\URLQuery;
use eZ\Publish\API\Repository\Values\URL\UsageSearchResult;

/**
 * Base class for URLService tests.
 */
abstract class BaseURLServiceTest extends BaseTest
{
    protected function doTestFindUrls(URLQuery $query, array $expectedUrls, $exectedTotalCount = null, $ignoreOrder = true)
    {
        $repository = $this->getRepository();

        /* BEGIN: Use Case */
        $searchResult = $repository->getURLService()->findUrls($query);
        /* END: Use Case */

        if ($exectedTotalCount === null) {
            $exectedTotalCount = count($expectedUrls);
        }

        $this->assertInstanceOf(SearchResult::class, $searchResult);
        $this->assertEquals($exectedTotalCount, $searchResult->totalCount);
        $this->assertSearchResultItems($searchResult, $expectedUrls, $ignoreOrder);
    }

    protected function assertSearchResultItems(SearchResult $searchResult, array $expectedUrls, $ignoreOrder)
    {
        $this->assertCount(count($expectedUrls), $searchResult->items);

        foreach ($searchResult->items as $i => $item) {
            if ($ignoreOrder) {
                $this->assertContains($item->url, $expectedUrls);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            } else {
                $this->assertEquals($expectedUrls[$i], $item->url);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            }
        }
    }

    protected function assertUsagesSearchResultItems(UsageSearchResult $searchResult, array $expectedContentInfoIds)
    {
        $this->assertCount(count($expectedContentInfoIds), $searchResult->items);
        foreach ($searchResult->items as $contentInfo) {
            $this->assertContains($contentInfo->id, $expectedContentInfoIds);
        }
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5			* @license For full copyright and license information view LICENSE file distributed with this source code.
6			*/
7			namespace eZ\Publish\API\Repository\Tests;
8
9			use eZ\Publish\API\Repository\Values\URL\SearchResult;
10			use eZ\Publish\API\Repository\Values\URL\URLQuery;
11			use eZ\Publish\API\Repository\Values\URL\UsageSearchResult;
12
13			/**
14			* Base class for URLService tests.
15			*/
16			abstract class BaseURLServiceTest extends BaseTest
17			{
18			protected function doTestFindUrls(URLQuery $query, array $expectedUrls, $exectedTotalCount = null, $ignoreOrder = true)
19			{
20			$repository = $this->getRepository();
21
22			/* BEGIN: Use Case */
23			$searchResult = $repository->getURLService()->findUrls($query);
24			/* END: Use Case */
25
26			if ($exectedTotalCount === null) {
27			$exectedTotalCount = count($expectedUrls);
28			}
29
30			$this->assertInstanceOf(SearchResult::class, $searchResult);
31			$this->assertEquals($exectedTotalCount, $searchResult->totalCount);
32			$this->assertSearchResultItems($searchResult, $expectedUrls, $ignoreOrder);
33			}
34
35			protected function assertSearchResultItems(SearchResult $searchResult, array $expectedUrls, $ignoreOrder)
36			{
37			$this->assertCount(count($expectedUrls), $searchResult->items);
38
39			foreach ($searchResult->items as $i => $item) {
40			if ($ignoreOrder) {
41			$this->assertContains($item->url, $expectedUrls);
			0 ignored issues – show Documentation introduced 2017-12-14 17:59 UTC by Report Bug Copy Issue Report The property `$url` is declared protected in `eZ\Publish\API\Repository\Values\URL\URL`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
42			} else {
43			$this->assertEquals($expectedUrls[$i], $item->url);
			0 ignored issues – show Documentation introduced 2017-12-14 17:59 UTC by Report Bug Copy Issue Report The property `$url` is declared protected in `eZ\Publish\API\Repository\Values\URL\URL`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
44			}
45			}
46			}
47
48			protected function assertUsagesSearchResultItems(UsageSearchResult $searchResult, array $expectedContentInfoIds)
49			{
50			$this->assertCount(count($expectedContentInfoIds), $searchResult->items);
51			foreach ($searchResult->items as $contentInfo) {
52			$this->assertContains($contentInfo->id, $expectedContentInfoIds);
53			}
54			}
55			}
56

ezsystems / ezpublish-kernel

Push — master ( cfe8d7...fcc746 )

assertUsagesSearchResultItems() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like