MethodVisibilityReducedTest::propertiesToBeTested() - Code Metrics - Inspection of "Verify method, function, property, constant and in..." - Roave/BackwardCompatibilityCheck - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

by Marco

created 2018-04-18 11:00 UTC

propertiesToBeTested() B

↳ Parent: MethodVisibilityReducedTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	80
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	80
rs	8.8387
c	0
b	0
f	0
cc	1
eloc	38
nc	1
nop	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace RoaveTest\ApiCompare\Comparator\BackwardsCompatibility\MethodBased;

use PHPUnit\Framework\TestCase;
use Roave\ApiCompare\Change;
use Roave\ApiCompare\Comparator\BackwardsCompatibility\MethodBased\MethodVisibilityReduced;
use Roave\BetterReflection\BetterReflection;
use Roave\BetterReflection\Reflection\ReflectionMethod;
use Roave\BetterReflection\Reflector\ClassReflector;
use Roave\BetterReflection\SourceLocator\Type\StringSourceLocator;
use function array_map;
use function iterator_to_array;

/**
 * @covers \Roave\ApiCompare\Comparator\BackwardsCompatibility\MethodBased\MethodVisibilityReduced
 */
final class MethodVisibilityReducedTest extends TestCase
{
    /**
     * @dataProvider propertiesToBeTested
     *
     * @param string[] $expectedMessages
     */
    public function testDiffs(
        ReflectionMethod $fromMethod,
        ReflectionMethod $toMethod,
        array $expectedMessages
    ) : void {
        $changes = (new MethodVisibilityReduced())
            ->compare($fromMethod, $toMethod);

        self::assertSame(
            $expectedMessages,
            array_map(function (Change $change) : string {
                return $change->__toString();
            }, iterator_to_array($changes))
        );
    }

    /** @return (string[]|ReflectionMethod)[][] */
    public function propertiesToBeTested() : array
    {
        $astLocator = (new BetterReflection())->astLocator();

        $fromLocator = new StringSourceLocator(
            <<<'PHP'
<?php

class TheClass {
    public function publicMaintainedPublic() {}
    public function publicReducedToProtected() {}
    public function publicReducedToPrivate() {}
    protected function protectedMaintainedProtected() {}
    protected function protectedReducedToPrivate() {}
    protected function protectedIncreasedToPublic() {}
    private function privateMaintainedPrivate() {}
    private function privateIncreasedToProtected() {}
    private function privateIncreasedToPublic() {}
}
PHP
            ,
            $astLocator
        );

        $toLocator = new StringSourceLocator(
            <<<'PHP'
<?php

class TheClass {
    public function publicMaintainedPublic() {}
    protected function publicReducedToProtected() {}
    private function publicReducedToPrivate() {}
    protected function protectedMaintainedProtected() {}
    private function protectedReducedToPrivate() {}
    public function protectedIncreasedToPublic() {}
    private function privateMaintainedPrivate() {}
    protected function privateIncreasedToProtected() {}
    public function privateIncreasedToPublic() {}
}
PHP
            ,
            $astLocator
        );

        $fromClassReflector = new ClassReflector($fromLocator);
        $toClassReflector   = new ClassReflector($toLocator);
        $fromClass          = $fromClassReflector->reflect('TheClass');
        $toClass            = $toClassReflector->reflect('TheClass');

        $properties = [

            'publicMaintainedPublic'       => [],
            'publicReducedToProtected'     => [
                '[BC] CHANGED: Method publicReducedToProtected() of class TheClass visibility reduced from public to protected',
            ],
            'publicReducedToPrivate'       => [
                '[BC] CHANGED: Method publicReducedToPrivate() of class TheClass visibility reduced from public to private',
            ],
            'protectedMaintainedProtected' => [],
            'protectedReducedToPrivate'    => [
                '[BC] CHANGED: Method protectedReducedToPrivate() of class TheClass visibility reduced from protected to private',
            ],
            'protectedIncreasedToPublic'   => [],
            'privateMaintainedPrivate'     => [],
            'privateIncreasedToProtected'  => [],
            'privateIncreasedToPublic'     => [],
        ];

        return array_combine(
            array_keys($properties),
            array_map(
                function (string $method, array $errorMessages) use ($fromClass, $toClass) : array {
                    return [
                        $fromClass->getMethod($method),
                        $toClass->getMethod($method),
                        $errorMessages,
                    ];
                },
                array_keys($properties),
                $properties
            )
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace RoaveTest\ApiCompare\Comparator\BackwardsCompatibility\MethodBased;
6
7			use PHPUnit\Framework\TestCase;
8			use Roave\ApiCompare\Change;
9			use Roave\ApiCompare\Comparator\BackwardsCompatibility\MethodBased\MethodVisibilityReduced;
10			use Roave\BetterReflection\BetterReflection;
11			use Roave\BetterReflection\Reflection\ReflectionMethod;
12			use Roave\BetterReflection\Reflector\ClassReflector;
13			use Roave\BetterReflection\SourceLocator\Type\StringSourceLocator;
14			use function array_map;
15			use function iterator_to_array;
16
17			/**
18			* @covers \Roave\ApiCompare\Comparator\BackwardsCompatibility\MethodBased\MethodVisibilityReduced
19			*/
20			final class MethodVisibilityReducedTest extends TestCase
21			{
22			/**
23			* @dataProvider propertiesToBeTested
24			*
25			* @param string[] $expectedMessages
26			*/
27			public function testDiffs(
28			ReflectionMethod $fromMethod,
29			ReflectionMethod $toMethod,
30			array $expectedMessages
31			) : void {
32			$changes = (new MethodVisibilityReduced())
33			->compare($fromMethod, $toMethod);
34
35			self::assertSame(
36			$expectedMessages,
37			array_map(function (Change $change) : string {
38			return $change->__toString();
39			}, iterator_to_array($changes))
40			);
41			}
42
43			/** @return (string[]\|ReflectionMethod)[][] */
44			public function propertiesToBeTested() : array
45			{
46			$astLocator = (new BetterReflection())->astLocator();
47
48			$fromLocator = new StringSourceLocator(
49			<<<'PHP'
50			<?php
51
52			class TheClass {
53			public function publicMaintainedPublic() {}
54			public function publicReducedToProtected() {}
55			public function publicReducedToPrivate() {}
56			protected function protectedMaintainedProtected() {}
57			protected function protectedReducedToPrivate() {}
58			protected function protectedIncreasedToPublic() {}
59			private function privateMaintainedPrivate() {}
60			private function privateIncreasedToProtected() {}
61			private function privateIncreasedToPublic() {}
62			}
63			PHP
64			,
65			$astLocator
66			);
67
68			$toLocator = new StringSourceLocator(
69			<<<'PHP'
70			<?php
71
72			class TheClass {
73			public function publicMaintainedPublic() {}
74			protected function publicReducedToProtected() {}
75			private function publicReducedToPrivate() {}
76			protected function protectedMaintainedProtected() {}
77			private function protectedReducedToPrivate() {}
78			public function protectedIncreasedToPublic() {}
79			private function privateMaintainedPrivate() {}
80			protected function privateIncreasedToProtected() {}
81			public function privateIncreasedToPublic() {}
82			}
83			PHP
84			,
85			$astLocator
86			);
87
88			$fromClassReflector = new ClassReflector($fromLocator);
89			$toClassReflector = new ClassReflector($toLocator);
90			$fromClass = $fromClassReflector->reflect('TheClass');
91			$toClass = $toClassReflector->reflect('TheClass');
92
93			$properties = [
94
95			'publicMaintainedPublic' => [],
96			'publicReducedToProtected' => [
97			'[BC] CHANGED: Method publicReducedToProtected() of class TheClass visibility reduced from public to protected',
98			],
99			'publicReducedToPrivate' => [
100			'[BC] CHANGED: Method publicReducedToPrivate() of class TheClass visibility reduced from public to private',
101			],
102			'protectedMaintainedProtected' => [],
103			'protectedReducedToPrivate' => [
104			'[BC] CHANGED: Method protectedReducedToPrivate() of class TheClass visibility reduced from protected to private',
105			],
106			'protectedIncreasedToPublic' => [],
107			'privateMaintainedPrivate' => [],
108			'privateIncreasedToProtected' => [],
109			'privateIncreasedToPublic' => [],
110			];
111
112			return array_combine(
113			array_keys($properties),
114			array_map(
115			function (string $method, array $errorMessages) use ($fromClass, $toClass) : array {
116			return [
117			$fromClass->getMethod($method),
118			$toClass->getMethod($method),
119			$errorMessages,
120			];
121			},
122			array_keys($properties),
123			$properties
124			)
125			);
126			}
127			}
128

Roave / BackwardCompatibilityCheck

Pull Request — master (#38)

propertiesToBeTested() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like