fix: Handle symbols dependencies

.makefile/e2e.file

@@ -449,6 +449,24 @@ e2e_040: $(PHP_SCOPER_PHAR_BIN)
 
 	diff fixtures/set040-polyfills/expected-output build/set040/output
 
+.PHONY: e2e_041
+m: # Runs end-to-end tests for the fixture set e2e_041 — Codebase using a polyfill
+e2e_041: $(PHP_SCOPER_PHAR_BIN)
+	rm -rf fixtures/set041-exposed-symbols-hierarchy/vendor || true
+	composer --working-dir=fixtures/set041-exposed-symbols-hierarchy dump-autoload
+
+	$(PHP_SCOPER_PHAR) add-prefix . \
+		--working-dir=fixtures/set041-exposed-symbols-hierarchy \
+		--output-dir=../../build/set041 \
+		--force \
+		--no-interaction \
+		--stop-on-failure
+	composer --working-dir=build/set041 dump-autoload
+
+	php build/set041/index.php > build/set041/output || true
+
+	diff fixtures/set041-exposed-symbols-hierarchy/expected-output build/set041/output
+
 
 #
 # Rules from files

_specs/expose-hierarchy.php

@@ -0,0 +1,108 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the humbug/php-scoper package.
+ *
+ * Copyright (c) 2017 Théo FIDRY <[email protected]>,
+ *                    Pádraic Brady <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Humbug\PhpScoper\SpecFramework\Config\Meta;
+use Humbug\PhpScoper\SpecFramework\Config\SpecWithConfig;
+
+return [
+    'meta' => new Meta(
+        title: 'Ensures the exposed symbols follow the required hierarchy.',
+        exposeClasses: ['/.h*/'],
+    ),
+
+    'PHP 8.1 Polyfill (right order)' => SpecWithConfig::create(
+        spec: <<<'PHP'
+            <?php
+
+            interface Stringeable {}
+            class PhpTokens implements Stringeable {}
+
+            ----
+            <?php
+
+            namespace Humbug;
+
+            interface Stringeable
+            {
+            }
+            \class_alias('Humbug\Stringeable', 'Stringeable', \false);
+            class PhpTokens implements \Humbug\Stringeable
+            {
+            }
+            \class_alias('Humbug\PhpTokens', 'PhpTokens', \false);
+
+            PHP,
+        expectedRecordedClasses: [
+            ['Stringeable', 'Humbug\Stringeable'],
+            ['PhpTokens', 'Humbug\PhpTokens'],
+        ],
+    ),
+
+    'PHP 8.1 Polyfill (wrong order)' => SpecWithConfig::create(
+        spec: <<<'PHP'
+            <?php
+
+            class PhpTokens implements Stringeable {}
+            interface Stringeable {}
+
+            ----
+            <?php
+
+            namespace Humbug;
+            
+            class PhpTokens implements \Humbug\Stringeable
+            {
+            }
+            \class_alias('Humbug\PhpTokens', 'PhpTokens', \false);
+            interface Stringeable
+            {
+            }
+            \class_alias('Humbug\Stringeable', 'Stringeable', \false);
+
+            PHP,
+        expectedRecordedClasses: [
+            ['Stringeable', 'Humbug\Stringeable'],
+            ['PhpTokens', 'Humbug\PhpTokens'],
+        ],
+    ),
+
+    'simple case with extend' => SpecWithConfig::create(
+        spec: <<<'PHP'
+            <?php
+
+            class Frame extends Window {}
+            abstract class Window implements ObjectInterface {}
+            interface ObjectInterface {}
+
+            ----
+            <?php
+
+            namespace Humbug;
+            
+            class PhpTokens implements \Humbug\Stringeable
+            {
+            }
+            \class_alias('Humbug\PhpTokens', 'PhpTokens', \false);
+            interface Stringeable
+            {
+            }
+            \class_alias('Humbug\Stringeable', 'Stringeable', \false);
+
+            PHP,
+        expectedRecordedClasses: [
+            ['Stringeable', 'Humbug\Stringeable'],
+            ['PhpTokens', 'Humbug\PhpTokens'],
+        ],
+    ),
+];

fixtures/set041-exposed-symbols-hierarchy/composer.json

@@ -0,0 +1,10 @@
+{
+    "bin": "index.php",
+    "autoload": {
+        "psr-4": {
+            "Set041\\Polyfill\\": "polyfill/",
+            "": "src/"
+        },
+        "classmap": ["stubs"]
+    }
+}

fixtures/set041-exposed-symbols-hierarchy/expected-output

@@ -0,0 +1 @@
+OK.

fixtures/set041-exposed-symbols-hierarchy/index.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+require file_exists(__DIR__.'/vendor/scoper-autoload.php')
+    ? __DIR__.'/vendor/scoper-autoload.php'
+    : __DIR__.'/vendor/autoload.php';
+
+new Frame();
+new Window();
+
+echo "OK.".PHP_EOL;

fixtures/set041-exposed-symbols-hierarchy/polyfill/Polyfill.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Set041\Polyfill;
+
+final class PhpTokenLike implements \StringeableLike
+{
+}

fixtures/set041-exposed-symbols-hierarchy/scoper.inc.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+return [
+    'exclude-files' => [
+        __DIR__.'/index.php',
+    ],
+    'expose-classes' => [
+        'Set041\Polyfill\PhpTokenLike',
+    ],
+    'exclude-classes' => [
+        'StringeableLike',
+    ],
+];

fixtures/set041-exposed-symbols-hierarchy/src/Component.php

@@ -0,0 +1,5 @@
+<?php declare(strict_types=1);
+
+abstract class Component implements ObjectInterface
+{
+}

fixtures/set041-exposed-symbols-hierarchy/src/Frame.php

@@ -0,0 +1,5 @@
+<?php declare(strict_types=1);
+
+class Frame extends Window implements ObjectInterface
+{
+}

fixtures/set041-exposed-symbols-hierarchy/src/ObjectInterface.php

@@ -0,0 +1,5 @@
+<?php declare(strict_types=1);
+
+interface ObjectInterface
+{
+}

fixtures/set041-exposed-symbols-hierarchy/src/Window.php

@@ -0,0 +1,5 @@
+<?php declare(strict_types=1);
+
+class Window extends Component
+{
+}

fixtures/set041-exposed-symbols-hierarchy/stubs/StringeableLike.php

@@ -0,0 +1,7 @@
+<?php
+
+if (\PHP_VERSION_ID < PHP_INT_MIN) {
+    interface StringeableLike
+    {
+    }
+}

specs/misc/expose-hierarchy.php

@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the humbug/php-scoper package.
+ *
+ * Copyright (c) 2017 Théo FIDRY <[email protected]>,
+ *                    Pádraic Brady <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Humbug\PhpScoper\SpecFramework\Config\Meta;
+use Humbug\PhpScoper\SpecFramework\Config\SpecWithConfig;
+
+return [
+    'meta' => new Meta(
+        title: 'Ensures the exposed symbols follow the required hierarchy.',
+        exposeClasses: ['/.h*/'],
+    ),
+
+    'PHP 8.1 Polyfill (right order)' => SpecWithConfig::create(
+        spec: <<<'PHP'
+            <?php
+
+            interface Stringeable {}
+            class PhpTokens implements Stringeable {}
+
+            ----
+            <?php
+
+            namespace Humbug;
+
+            interface Stringeable
+            {
+            }
+            \class_alias('Humbug\Stringeable', 'Stringeable', \false);
+            class PhpTokens implements \Humbug\Stringeable
+            {
+            }
+            \class_alias('Humbug\PhpTokens', 'PhpTokens', \false);
+
+            PHP,
+        expectedRecordedClasses: [
+            ['Stringeable', 'Humbug\Stringeable'],
+            ['PhpTokens', 'Humbug\PhpTokens'],
+        ],
+    ),
+
+    'PHP 8.1 Polyfill (wrong order)' => SpecWithConfig::create(
+        spec: <<<'PHP'
+            <?php
+
+            class PhpTokens implements Stringeable {}
+            interface Stringeable {}
+
+            ----
+            <?php
+
+            namespace Humbug;
+            
+            class PhpTokens implements \Humbug\Stringeable
+            {
+            }
+            \class_alias('Humbug\PhpTokens', 'PhpTokens', \false);
+            interface Stringeable
+            {
+            }
+            \class_alias('Humbug\Stringeable', 'Stringeable', \false);
+
+            PHP,
+        expectedRecordedClasses: [
+            ['Stringeable', 'Humbug\Stringeable'],
+            ['PhpTokens', 'Humbug\PhpTokens'],
+        ],
+    ),
+
+    'simple case with extend' => SpecWithConfig::create(
+        spec: <<<'PHP'
+            <?php
+
+            class Frame extends Window {}
+            abstract class Window implements ObjectInterface {}
+            interface Component extends FrameInterface, ObjectInterface {}
+            interface FrameInterface {}
+            interface ObjectInterface {}
+
+            ----
+            <?php
+
+            namespace Humbug;
+            
+            class PhpTokens implements \Humbug\Stringeable
+            {
+            }
+            \class_alias('Humbug\PhpTokens', 'PhpTokens', \false);
+            interface Stringeable
+            {
+            }
+            \class_alias('Humbug\Stringeable', 'Stringeable', \false);
+
+            PHP,
+        expectedRecordedClasses: [
+            ['Stringeable', 'Humbug\Stringeable'],
+            ['PhpTokens', 'Humbug\PhpTokens'],
+        ],
+    ),
+];

src/PhpParser/NodeVisitor/ClassIdentifierRecorder.php

@@ -26,6 +26,8 @@
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Interface_;
 use PhpParser\NodeVisitorAbstract;
+use function array_filter;
+use function array_merge;
 
 /**
  * Records the classes that need to be aliased.
@@ -70,12 +72,37 @@ public function enterNode(Node $node): Node
             $this->symbolsRegistry->recordClass(
                 $resolvedName,
                 FullyQualifiedFactory::concat($this->prefix, $resolvedName),
+                self::getDependencies($parent),
             );
         }
 
         return $node;
     }
 
+    /**
+     * @return FullyQualified[]
+     */
+    private static function getDependencies(Class_|Interface_ $node): array
+    {
+        return match(true) {
+            $node instanceof Class_ => self::getClassDependencies($node),
+            $node instanceof Interface_ => $node->extends,
+        };
+    }
+
+    private static function getClassDependencies(Class_ $class_): array
+    {
+        $dependencies = [];
+
+        if (null !== $class_->extends) {
+            $dependencies[] = [$class_->extends];
+        }
+
+        $dependencies[] = $class_->implements;
+
+        return [...$dependencies];
+    }
+
     private function shouldBeAliased(string $resolvedName): bool
     {
         if ($this->enrichedReflector->isExposedClass($resolvedName)) {

src/Symbol/SymbolsRegistry.php

@@ -16,6 +16,7 @@
 
 use Countable;
 use PhpParser\Node\Name\FullyQualified;
+use function array_map;
 use function array_values;
 use function count;
 use function serialize;
@@ -35,7 +36,7 @@ final class SymbolsRegistry implements Countable
 
     /**
      * @param array<array{string|FullyQualified, string|FullyQualified}> $functions
-     * @param array<array{string|FullyQualified, string|FullyQualified}> $classes
+     * @param array<array{string|FullyQualified, string|FullyQualified, array<string|FullyQualified>}> $classes
      */
     public static function create(
         array $functions = [],
@@ -50,10 +51,14 @@ public static function create(
             );
         }
 
-        foreach ($classes as [$original, $alias]) {
+        foreach ($classes as [$original, $alias, $dependencies]) {
             $registry->recordClass(
                 $original instanceof FullyQualified ? $original : new FullyQualified($original),
                 $alias instanceof FullyQualified ? $alias : new FullyQualified($alias),
+                array_map(
+                    static fn (string|FullyQualified $name) => $name instanceof FullyQualified ? $name : new FullyQualified($name),
+                    $dependencies ?? [],
+                ),
             );
         }
 
@@ -93,8 +98,8 @@ public function merge(self $symbolsRegistry): void
             $this->recordedFunctions[$original] = [$original, $alias];
         }
 
-        foreach ($symbolsRegistry->getRecordedClasses() as [$original, $alias]) {
-            $this->recordedClasses[$original] = [$original, $alias];
+        foreach ($symbolsRegistry->getRecordedClasses() as [$original, $alias, $dependencies]) {
+            $this->recordedClasses[$original] = [$original, $alias, $dependencies];
         }
     }
 
@@ -111,9 +116,16 @@ public function getRecordedFunctions(): array
         return array_values($this->recordedFunctions);
     }
 
-    public function recordClass(FullyQualified $original, FullyQualified $alias): void
+    /**
+     * @param FullyQualified[] $dependencies
+     */
+    public function recordClass(
+        FullyQualified $original,
+        FullyQualified $alias,
+        array $dependencies = [],
+    ): void
     {
-        $this->recordedClasses[(string) $original] = [(string) $original, (string) $alias];
+        $this->recordedClasses[(string) $original] = [(string) $original, (string) $alias, $dependencies];
     }
 
     /**

tests/Autoload/ScoperAutoloadGeneratorTest.php

@@ -341,7 +341,7 @@ public static function provideRegistry(): iterable
         yield 'classes recorded' => [
             SymbolsRegistry::create(
                 classes: [
-                    ['A\Foo', 'Humbug\A\Foo'],
+                    ['A\Foo', 'Humbug\A\Foo', []],
                 ],
             ),
             [],
@@ -387,8 +387,8 @@ function humbug_phpscoper_expose_class($exposed, $prefixed) {
         yield 'global classes recorded' => [
             SymbolsRegistry::create(
                 classes: [
-                    ['Foo', 'Humbug\Foo'],
-                    ['Bar', 'Humbug\Bar'],
+                    ['Foo', 'Humbug\Foo', []],
+                    ['Bar', 'Humbug\Bar', []],
                 ],
             ),
             [],
@@ -442,7 +442,7 @@ function humbug_phpscoper_expose_class($exposed, $prefixed) {
                     ['Emca\baz', 'Humbug\Emca\baz'],
                 ],
                 [
-                    ['A\Foo', 'Humbug\A\Foo'],
+                    ['A\Foo', 'Humbug\A\Foo', []],
                 ],
             ),
             [],

tests/SpecFramework/SpecScenario.php

@@ -93,8 +93,8 @@ public function assertExpectedResult(
 
         $actualRecordedExposedClasses = $symbolsRegistry->getRecordedClasses();
 
-        self::assertSameRecordedSymbols(
-            $assert,
+        // The order matters for classes
+        $assert->assertSame(
             $this->expectedRegisteredClasses,
             $actualRecordedExposedClasses,
             $specMessage,

tests/SpecFrameworkTest/SpecPrinterTest.php

@@ -350,8 +350,8 @@ public static function scenarioProvider(): iterable
                     ['another_recorded_function', 'Humbug\another_recorded_function'],
                 ],
                 [
-                    ['RecordedClass', 'Humbug\RecordedClass'],
-                    ['AnotherRecordedClass', 'Humbug\AnotherRecordedClass'],
+                    ['RecordedClass', 'Humbug\RecordedClass', []],
+                    ['AnotherRecordedClass', 'Humbug\AnotherRecordedClass', []],
                 ],
             ),
             $actualCode,

tests/Symbol/SymbolsRegistryTest.php

@@ -28,7 +28,7 @@ final class SymbolsRegistryTest extends TestCase
 {
     /**
      * @param array<array{FullyQualified, FullyQualified}> $functions
-     * @param array<array{FullyQualified, FullyQualified}> $classes
+     * @param array<array{FullyQualified, FullyQualified, FullyQualified[]}> $classes
      * @param list<array{FullyQualified, FullyQualified}>  $expectedRecordedFunctions
      * @param list<array{FullyQualified, FullyQualified}>  $expectedRecordedClasses
      */
@@ -52,7 +52,7 @@ public function test_it_records_functions_and_classes(
 
     /**
      * @param array<array{FullyQualified, FullyQualified}> $functions
-     * @param array<array{FullyQualified, FullyQualified}> $classes
+     * @param array<array{FullyQualified, FullyQualified, FullyQualified[]}> $classes
      */
     #[DataProvider('provideRecords')]
     public function test_it_can_be_serialized_and_unserialized(
@@ -179,7 +179,7 @@ public static function provideRegistryToMerge(): iterable
                     [$main, $scopedMain],
                 ],
                 [
-                    [$testCase, $scopedTestCase],
+                    [$testCase, $scopedTestCase, []],
                 ],
             ),
             new SymbolsRegistry(),
@@ -199,7 +199,7 @@ public static function provideRegistryToMerge(): iterable
                     [$main, $scopedMain],
                 ],
                 [
-                    [$testCase, $scopedTestCase],
+                    [$testCase, $scopedTestCase, []],
                 ],
             ),
             [
@@ -217,15 +217,15 @@ public static function provideRegistryToMerge(): iterable
                     [$main, $scopedMain],
                 ],
                 [
-                    [$testCase, $scopedTestCase],
+                    [$testCase, $scopedTestCase, []],
                 ],
             ),
             SymbolsRegistry::create(
                 [
                     [$dump, $scopedDump],
                 ],
                 [
-                    [$finder, $scopedFinder],
+                    [$finder, $scopedFinder, []],
                 ],
             ),
             [
@@ -245,7 +245,7 @@ public static function provideRegistryToMerge(): iterable
                     [$main, $scopedMain],
                 ],
                 [
-                    [$testCase, $scopedTestCase],
+                    [$testCase, $scopedTestCase, []],
                 ],
             ),
             SymbolsRegistry::create(
@@ -254,8 +254,8 @@ public static function provideRegistryToMerge(): iterable
                     [$dump, $scopedDump],
                 ],
                 [
-                    [$testCase, $scopedTestCase],
-                    [$finder, $scopedFinder],
+                    [$testCase, $scopedTestCase, []],
+                    [$finder, $scopedFinder, []],
                 ],
             ),
             [
@@ -276,16 +276,16 @@ public static function provideRegistryToMerge(): iterable
                     [$dump, $scopedDump],
                 ],
                 [
-                    [$testCase, $scopedTestCase],
-                    [$finder, $scopedFinder],
+                    [$testCase, $scopedTestCase, []],
+                    [$finder, $scopedFinder, []],
                 ],
             ),
             SymbolsRegistry::create(
                 [
                     [$dump, $scopedDump],
                 ],
                 [
-                    [$finder, $scopedFinder],
+                    [$finder, $scopedFinder, []],
                 ],
             ),
             [