#5 PropertyVisibilityReduced BC break detector

src/Comparator/BackwardsCompatibility/ClassBased/PropertyVisibilityReduced.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\ClassBased;
+
+use Assert\Assert;
+use Roave\ApiCompare\Change;
+use Roave\ApiCompare\Changes;
+use Roave\BetterReflection\Reflection\ReflectionClass;
+use Roave\BetterReflection\Reflection\ReflectionProperty;
+
+final class PropertyVisibilityReduced implements ClassBased
+{
+    private const VISIBILITY_PRIVATE = 'private';
+
+    private const VISIBILITY_PROTECTED = 'protected';
+
+    private const VISIBILITY_PUBLIC = 'public';
+
+    public function compare(ReflectionClass $fromClass, ReflectionClass $toClass) : Changes
+    {
+        Assert::that($fromClass->getName())->same($toClass->getName());
+
+        $visibilitiesFrom = $this->propertyVisibilities($fromClass);
+        $visibilitiesTo   = $this->propertyVisibilities($toClass);
+
+        $affectedVisibilities = array_filter(
+            array_combine(
+                array_keys(array_intersect_key($visibilitiesFrom, $visibilitiesTo)),
+                array_map(
+                    function (string $visibilityFrom, string $visibilityTo) : array {
+                        return [$visibilityFrom, $visibilityTo];
+                    },
+                    array_intersect_key($visibilitiesFrom, $visibilitiesTo),
+                    array_intersect_key($visibilitiesTo, $visibilitiesFrom)
+                )
+            ),
+            function (array $visibilities) : bool {
+                // Note: works because public, protected and private are (luckily) sortable
+                return $visibilities[0] > $visibilities[1];
+            }
+        );
+
+        return Changes::fromArray(array_values(array_map(function (string $propertyName, array $visibilities) use (
+            $fromClass
+        ) : Change {
+            return Change::removed(
+                sprintf(
+                    'Property %s#%s changed visibility from %s to %s',
+                    $fromClass->getName(),
+                    $propertyName,
+                    $visibilities[0],
+                    $visibilities[1]
+                ),
+                true
+            );
+        }, array_keys($affectedVisibilities), $affectedVisibilities)));
+    }
+
+    /** @return string[] */
+    private function propertyVisibilities(ReflectionClass $class) : array
+    {
+        return array_map(function (ReflectionProperty $property) : string {
+            if ($property->isPublic()) {
+                return self::VISIBILITY_PUBLIC;
+            }
+
+            if ($property->isProtected()) {
+                return self::VISIBILITY_PROTECTED;
+            }
+
+            return self::VISIBILITY_PRIVATE;
+        }, $class->getProperties());
+    }
+}

test/asset/api/new/ClassWithPropertyVisibilitiesBeingChanged.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace RoaveTestAsset;
+
+class ClassWithPropertyVisibilitiesBeingChanged
+{
+    public $publicMaintainedPublic;
+    protected $publicReducedToProtected;
+    private $publicReducedToPrivate;
+    protected $protectedMaintainedProtected;
+    private $protectedReducedToPrivate;
+    public $protectedIncreasedToPublic;
+    private $privateMaintainedPrivate;
+    protected $privateIncreasedToProtected;
+    public $privateIncreasedToPublic;
+}

test/asset/api/old/ClassWithPropertyVisibilitiesBeingChanged.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace RoaveTestAsset;
+
+class ClassWithPropertyVisibilitiesBeingChanged
+{
+    public $publicMaintainedPublic;
+    public $publicReducedToProtected;
+    public $publicReducedToPrivate;
+    protected $protectedMaintainedProtected;
+    protected $protectedReducedToPrivate;
+    protected $protectedIncreasedToPublic;
+    private $privateMaintainedPrivate;
+    private $privateIncreasedToProtected;
+    private $privateIncreasedToPublic;
+}

test/unit/Comparator/BackwardsCompatibility/ClassBased/PropertyVisibilityReducedTest.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RoaveTest\ApiCompare\Comparator\BackwardsCompatibility\ClassBased;
+
+use PHPUnit\Framework\TestCase;
+use Roave\ApiCompare\Change;
+use Roave\ApiCompare\Comparator\BackwardsCompatibility\ClassBased\PropertyVisibilityReduced;
+use Roave\BetterReflection\BetterReflection;
+use Roave\BetterReflection\Reflection\ReflectionClass;
+use Roave\BetterReflection\Reflector\ClassReflector;
+use Roave\BetterReflection\SourceLocator\Type\SingleFileSourceLocator;
+
+final class PropertyVisibilityReducedTest extends TestCase
+{
+    /**
+     * @dataProvider classesToBeTested
+     *
+     * @param string[] $expectedMessages
+     */
+    public function testDiffs(
+        ReflectionClass $fromClass,
+        ReflectionClass $toClass,
+        array $expectedMessages
+    ) : void {
+        $changes = (new PropertyVisibilityReduced())
+            ->compare($fromClass, $toClass);
+
+        self::assertSame(
+            $expectedMessages,
+            array_map(function (Change $change) : string {
+                return $change->__toString();
+            }, iterator_to_array($changes))
+        );
+    }
+
+    /** @return (string[]|ReflectionClass)[][] */
+    public function classesToBeTested() : array
+    {
+        $locator = (new BetterReflection())->astLocator();
+
+        return [
+            'RoaveTestAsset\\ClassWithPropertyVisibilitiesBeingChanged' => [
+                (new ClassReflector(new SingleFileSourceLocator(
+                    __DIR__ . '/../../../../asset/api/old/ClassWithPropertyVisibilitiesBeingChanged.php',
+                    $locator
+                )))->reflect('RoaveTestAsset\\ClassWithPropertyVisibilitiesBeingChanged'),
+                (new ClassReflector(new SingleFileSourceLocator(
+                    __DIR__ . '/../../../../asset/api/new/ClassWithPropertyVisibilitiesBeingChanged.php',
+                    $locator
+                )))->reflect('RoaveTestAsset\\ClassWithPropertyVisibilitiesBeingChanged'),
+                [
+                    '[BC] REMOVED: Property RoaveTestAsset\ClassWithPropertyVisibilitiesBeingChanged#publicReducedToProtected changed visibility from public to protected',
+                    '[BC] REMOVED: Property RoaveTestAsset\ClassWithPropertyVisibilitiesBeingChanged#publicReducedToPrivate changed visibility from public to private',
+                    '[BC] REMOVED: Property RoaveTestAsset\ClassWithPropertyVisibilitiesBeingChanged#protectedReducedToPrivate changed visibility from protected to private',
+                ],
+            ],
+        ];
+    }
+}