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-22 12:23 UTC

propertiesToBeTested() A

↳ Parent: MethodVisibilityReducedTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	74
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

Roave / BackwardCompatibilityCheck

Pull Request — master (#38)

propertiesToBeTested() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like