RoaveTest\ApiCompare\Comparator\BackwardsCompatibility\MethodBased\MethodScopeChangedTest

Complexity

Total Complexity

2

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	testDiffs()	0	13	1
B	propertiesToBeTested()	0	96	1

<?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\MethodScopeChanged;
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\MethodScopeChanged
 */
final class MethodScopeChangedTest extends TestCase
{
    /**
     * @dataProvider propertiesToBeTested
     *
     * @param string[] $expectedMessages
     */
    public function testDiffs(
        ReflectionMethod $fromMethod,
        ReflectionMethod $toMethod,
        array $expectedMessages
    ) : void {
        $changes = (new MethodScopeChanged())
            ->compare($fromMethod, $toMethod);

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

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

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

class TheClass {
    public function publicInstanceToStatic() {}
    public static function publicStaticToInstance() {}
    public function publicInstanceToInstance() {}
    public static function publicStaticToStatic() {}
    
    protected function protectedInstanceToStatic() {}
    protected static function protectedStaticToInstance() {}
    protected function protectedInstanceToInstance() {}
    protected static function protectedStaticToStatic() {}
    
    private function privateInstanceToStatic() {}
    private static function privateStaticToInstance() {}
    private function privateInstanceToInstance() {}
    private static function privateStaticToStatic() {}
}
PHP
            ,
            $astLocator
        );

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

class TheClass {
    public static function publicInstanceToStatic() {}
    public function publicStaticToInstance() {}
    public function publicInstanceToInstance() {}
    public static function publicStaticToStatic() {}
    
    protected static function protectedInstanceToStatic() {}
    protected function protectedStaticToInstance() {}
    protected function protectedInstanceToInstance() {}
    protected static function protectedStaticToStatic() {}
    
    private static function privateInstanceToStatic() {}
    private function privateStaticToInstance() {}
    private function privateInstanceToInstance() {}
    private static function privateStaticToStatic() {}
}
PHP
            ,
            $astLocator
        );

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

        $properties = [
            'publicInstanceToStatic'   => [
                '[BC] CHANGED: Method publicInstanceToStatic() of class TheClass changed scope from instance to static',
            ],
            'publicStaticToInstance'   => [
                '[BC] CHANGED: Method publicStaticToInstance() of class TheClass changed scope from static to instance',
            ],
            'publicInstanceToInstance' => [],
            'publicStaticToStatic'     => [],

            'protectedInstanceToStatic'   => [
                '[BC] CHANGED: Method protectedInstanceToStatic() of class TheClass changed scope from instance to static',
            ],
            'protectedStaticToInstance'   => [
                '[BC] CHANGED: Method protectedStaticToInstance() of class TheClass changed scope from static to instance',
            ],
            'protectedInstanceToInstance' => [],
            'protectedStaticToStatic'     => [],

            'privateInstanceToStatic'   => [],
            'privateStaticToInstance'   => [],
            'privateInstanceToInstance' => [],
            'privateStaticToStatic'     => [],
        ];

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