SettingsMenuAdaptorTest::provider() - Code Metrics - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

SettingsMenuAdaptorTest::provider() A
last analyzed 2020-11-05 13:23 UTC

↳ Parent: SettingsMenuAdaptorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	26
rs	9.504
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Kunstmaan\AdminBundle\Tests\Helper\Menu;

use Kunstmaan\AdminBundle\Helper\Menu\MenuAdaptorInterface;
use Kunstmaan\AdminBundle\Helper\Menu\MenuBuilder;
use Kunstmaan\AdminBundle\Helper\Menu\MenuItem;
use Kunstmaan\AdminBundle\Helper\Menu\SettingsMenuAdaptor;
use Kunstmaan\AdminBundle\Helper\Menu\TopMenuItem;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;

class SettingsMenuAdaptorTest extends TestCase
{
    /** @var AuthorizationCheckerInterface (mock) */
    private $authorizationCheckerInterface;

    /**
     * @var bool
     */
    private $isEnabledVersionChecker = true;

    public function setUp(): void
    {
        $this->authorizationCheckerInterface = $this->createMock(AuthorizationCheckerInterface::class);

    }

    /**
     * @dataProvider provider
     *
     * @param TopMenuItem|null $parent
     * @param string           $requestRoute
     * @param int              $expectedCount
     * @param string|null      $expectedLabel
     * @param bool             $granted
     */
    public function testAdaptChildren(?TopMenuItem $parent, string $requestRoute, int $expectedCount, ?string $expectedLabel, bool $granted)
    {
        $children = [];
        /** @var MenuBuilder $menuBuilderMock */
        $menuBuilderMock = $this->createMock(MenuBuilder::class);
        /** @var Request $request */
        $request = new Request([], [], ['_route' => $requestRoute]);
        $this->authorizationCheckerInterface

            ->expects($this->any())
            ->method('isGranted')
            ->willReturn($granted);

        $settingsMenuAdaptorMock = $this->setUpSettingsMenuAdaptorMock();
        $settingsMenuAdaptorMock->adaptChildren($menuBuilderMock, $children, $parent, $request);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $this->assertCount($expectedCount, $children);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertContainsOnlyInstancesOf(MenuItem::class, $children);

        if (null !== $expectedLabel) {
            $this->assertEquals($expectedLabel, $children[0]->getLabel());
        }
    }

    /**
     * @return \PHPUnit\Framework\MockObject\MockObject|SettingsMenuAdaptor
     */
    public function setUpSettingsMenuAdaptorMock()
    {
        $simpleMenuAdaptorMock = $this->getMockBuilder(SettingsMenuAdaptor::class)

            ->setConstructorArgs([$this->authorizationCheckerInterface, $this->isEnabledVersionChecker])
            ->setMethods(null)
            ->getMock()
        ;

        return $simpleMenuAdaptorMock;
    }

    public function testHasInterface()
    {
        $settingsMenuAdaptorMock = $this->setUpSettingsMenuAdaptorMock();
        $this->assertInstanceOf(MenuAdaptorInterface::class, $settingsMenuAdaptorMock);
    }

    public function provider()
    {
        /** @var TopMenuItem $parent */
        $parent = $this->createMock(TopMenuItem::class);
        $parent

            ->expects($this->any())
            ->method('getRoute')
            ->willReturn('KunstmaanAdminBundle_settings')
        ;

        /** @var TopMenuItem $parentWithOtherRoute */
        $parentWithOtherRoute = $this->createMock(TopMenuItem::class);
        $parentWithOtherRoute

            ->expects($this->any())
            ->method('getRoute')
            ->willReturn('KunstmaanAdminBundle_other')
        ;

        return [
            'with no parent and no route' => [null, 'KunstmaanAdminBundle_settings', 1, 'settings.title', true],
            'with parent and route is settings but not granted' => [$parent, 'kunstmaanadminbundle_admin_exception', 1, 'settings.exceptions.title', false],
            'with parent and route is settings and first active' => [$parent, 'KunstmaanAdminBundle_settings_bundle_version', 2, 'settings.version.bundle', true],
            'with parent and route is settings and second active' => [$parent, 'kunstmaanadminbundle_admin_exception', 2, 'settings.version.bundle', true],
            'with parent and route is not settings' => [$parentWithOtherRoute, '', 0, null, true],
        ];
    }
}


1			<?php
2
3			namespace Kunstmaan\AdminBundle\Tests\Helper\Menu;
4
5			use Kunstmaan\AdminBundle\Helper\Menu\MenuAdaptorInterface;
6			use Kunstmaan\AdminBundle\Helper\Menu\MenuBuilder;
7			use Kunstmaan\AdminBundle\Helper\Menu\MenuItem;
8			use Kunstmaan\AdminBundle\Helper\Menu\SettingsMenuAdaptor;
9			use Kunstmaan\AdminBundle\Helper\Menu\TopMenuItem;
10			use PHPUnit\Framework\TestCase;
11			use Symfony\Component\HttpFoundation\Request;
12			use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
13
14			class SettingsMenuAdaptorTest extends TestCase
15			{
16			/** @var AuthorizationCheckerInterface (mock) */
17			private $authorizationCheckerInterface;
18
19			/**
20			* @var bool
21			*/
22			private $isEnabledVersionChecker = true;
23
24			public function setUp(): void
25			{
26			$this->authorizationCheckerInterface = $this->createMock(AuthorizationCheckerInterface::class);
			0 ignored issues – show Documentation Bug introduced 2019-02-13 07:46 UTC by Report Bug Copy Issue Report It seems like `$this->createMock(\Symfo...heckerInterface::class)` of type `object<PHPUnit\Framework\MockObject\MockObject>` is incompatible with the declared type `object<Symfony\Component...zationCheckerInterface>` of property `$authorizationCheckerInterface`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
27			}
28
29			/**
30			* @dataProvider provider
31			*
32			* @param TopMenuItem\|null $parent
33			* @param string $requestRoute
34			* @param int $expectedCount
35			* @param string\|null $expectedLabel
36			* @param bool $granted
37			*/
38			public function testAdaptChildren(?TopMenuItem $parent, string $requestRoute, int $expectedCount, ?string $expectedLabel, bool $granted)
39			{
40			$children = [];
41			/** @var MenuBuilder $menuBuilderMock */
42			$menuBuilderMock = $this->createMock(MenuBuilder::class);
43			/** @var Request $request */
44			$request = new Request([], [], ['_route' => $requestRoute]);
45			$this->authorizationCheckerInterface
			0 ignored issues – show Bug introduced 2019-02-13 07:46 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Symfony\Component...zationCheckerInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
46			->expects($this->any())
47			->method('isGranted')
48			->willReturn($granted);
49
50			$settingsMenuAdaptorMock = $this->setUpSettingsMenuAdaptorMock();
51			$settingsMenuAdaptorMock->adaptChildren($menuBuilderMock, $children, $parent, $request);
			0 ignored issues – show Bug introduced 2019-02-12 14:20 UTC by Report Bug Copy Issue Report The method `adaptChildren` does only exist in `Kunstmaan\AdminBundle\He...enu\SettingsMenuAdaptor`, but not in `PHPUnit\Framework\MockObject\MockObject`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
52
53			$this->assertCount($expectedCount, $children);
			0 ignored issues – show Documentation introduced 2019-02-12 14:20 UTC by Report Bug Copy Issue Report `$children` is of type `array`, but the function expects a `object<Countable>\|object...nit\Framework\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
54			$this->assertContainsOnlyInstancesOf(MenuItem::class, $children);
55
56			if (null !== $expectedLabel) {
57			$this->assertEquals($expectedLabel, $children[0]->getLabel());
58			}
59			}
60
61			/**
62			* @return \PHPUnit\Framework\MockObject\MockObject\|SettingsMenuAdaptor
63			*/
64			public function setUpSettingsMenuAdaptorMock()
65			{
66			$simpleMenuAdaptorMock = $this->getMockBuilder(SettingsMenuAdaptor::class)
			0 ignored issues – show Deprecated Code introduced 2020-09-15 09:25 UTC by Report Bug Copy Issue Report The method `PHPUnit\Framework\MockOb...ckBuilder::setMethods()` has been deprecated with message: https://github.com/sebastianbergmann/phpunit/pull/3687 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
67			->setConstructorArgs([$this->authorizationCheckerInterface, $this->isEnabledVersionChecker])
68			->setMethods(null)
69			->getMock()
70			;
71
72			return $simpleMenuAdaptorMock;
73			}
74
75			public function testHasInterface()
76			{
77			$settingsMenuAdaptorMock = $this->setUpSettingsMenuAdaptorMock();
78			$this->assertInstanceOf(MenuAdaptorInterface::class, $settingsMenuAdaptorMock);
79			}
80
81			public function provider()
82			{
83			/** @var TopMenuItem $parent */
84			$parent = $this->createMock(TopMenuItem::class);
85			$parent
			0 ignored issues – show Bug introduced 2019-02-13 07:46 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Kunstmaan\AdminBu...elper\Menu\TopMenuItem>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
86			->expects($this->any())
87			->method('getRoute')
88			->willReturn('KunstmaanAdminBundle_settings')
89			;
90
91			/** @var TopMenuItem $parentWithOtherRoute */
92			$parentWithOtherRoute = $this->createMock(TopMenuItem::class);
93			$parentWithOtherRoute
			0 ignored issues – show Bug introduced 2019-02-12 14:20 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Kunstmaan\AdminBu...elper\Menu\TopMenuItem>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
94			->expects($this->any())
95			->method('getRoute')
96			->willReturn('KunstmaanAdminBundle_other')
97			;
98
99			return [
100			'with no parent and no route' => [null, 'KunstmaanAdminBundle_settings', 1, 'settings.title', true],
101			'with parent and route is settings but not granted' => [$parent, 'kunstmaanadminbundle_admin_exception', 1, 'settings.exceptions.title', false],
102			'with parent and route is settings and first active' => [$parent, 'KunstmaanAdminBundle_settings_bundle_version', 2, 'settings.version.bundle', true],
103			'with parent and route is settings and second active' => [$parent, 'kunstmaanadminbundle_admin_exception', 2, 'settings.version.bundle', true],
104			'with parent and route is not settings' => [$parentWithOtherRoute, '', 0, null, true],
105			];
106			}
107			}
108

Kunstmaan / KunstmaanBundlesCMS

SettingsMenuAdaptorTest::provider() A last analyzed 2020-11-05 13:23 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

SettingsMenuAdaptorTest::provider() A
last analyzed 2020-11-05 13:23 UTC