feat: Update to PHP-Scoper 0.18.5 (#1142)

box-project · Nov 4, 2023 · 1e10a1e · 1e10a1e
1 parent 0c76068
commit 1e10a1e
Show file tree

Hide file tree

Showing 13 changed files with 846 additions and 312 deletions.
diff --git a/composer.json b/composer.json
@@ -28,7 +28,7 @@
         "composer/xdebug-handler": "^3.0.3",
         "fidry/console": "^0.5.3 || ^0.6.0",
         "fidry/filesystem": "^1.1",
-        "humbug/php-scoper": "^0.18.3",
+        "humbug/php-scoper": "^0.18.6",
         "justinrainbow/json-schema": "^5.2.12",
         "laravel/serializable-closure": "^1.2.2",
         "nikic/iter": "^2.2",

diff --git a/composer.lock b/composer.lock
diff --git a/src/Box.php b/src/Box.php
@@ -132,6 +132,7 @@ public function endBuffering(?callable $dumpAutoload): void
                 $dumpAutoload(
                     $this->scoper->getSymbolsRegistry(),
                     $this->scoper->getPrefix(),
+                    $this->scoper->getExcludedFilePaths(),
                 );
             }
 

diff --git a/src/Composer/AutoloadDumper.php b/src/Composer/AutoloadDumper.php
@@ -17,6 +17,11 @@
 use Humbug\PhpScoper\Autoload\ScoperAutoloadGenerator;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
 use KevinGH\Box\NotInstantiable;
+use UnexpectedValueException;
+use function array_map;
+use function explode;
+use function implode;
+use function preg_match;
 use function preg_replace;
 use function str_replace;
 use const PHP_EOL;
@@ -27,38 +32,85 @@ final class AutoloadDumper
 
     public static function generateAutoloadStatements(
         SymbolsRegistry $symbolsRegistry,
+        array $excludedComposerAutoloadFileHashes,
         string $autoloadContents,
     ): string {
         if (0 === $symbolsRegistry->count()) {
             return $autoloadContents;
         }
 
+        $autoloadContents = self::extractInlinedAutoloadContents($autoloadContents);
+        $scoperStatements = self::getOriginalScoperAutoloaderContents(
+            $symbolsRegistry,
+            $excludedComposerAutoloadFileHashes,
+        );
+
+        $indentedAutoloadContents = self::fixInlinedAutoloadIndent(
+            $autoloadContents,
+            self::getLoaderStatementIndent($scoperStatements),
+        );
+
+        $mergedAutoloadContents = preg_replace(
+            '/(\s*\\$loader \= .*autoload\.php.*)/',
+            $indentedAutoloadContents,
+            $scoperStatements,
+        );
+
+        return self::cleanupDuplicateLineReturns($mergedAutoloadContents);
+    }
+
+    private static function extractInlinedAutoloadContents(string $autoloadContents): string
+    {
         $autoloadContents = str_replace('<?php', '', $autoloadContents);
 
-        $autoloadContents = preg_replace(
+        return preg_replace(
             '/return (ComposerAutoloaderInit.+::getLoader\(\));/',
             '\$loader = $1;',
             $autoloadContents,
         );
+    }
 
-        $scoperStatements = (new ScoperAutoloadGenerator($symbolsRegistry))->dump();
+    private static function getOriginalScoperAutoloaderContents(
+        SymbolsRegistry $symbolsRegistry,
+        array $excludedComposerAutoloadFileHashes,
+    ): string {
+        $generator = new ScoperAutoloadGenerator($symbolsRegistry, $excludedComposerAutoloadFileHashes);
+        $scoperStatements = $generator->dump();
 
-        $scoperStatements = preg_replace(
+        return preg_replace(
             '/scoper\-autoload\.php \@generated by PhpScoper/',
             '@generated by Humbug Box',
             $scoperStatements,
         );
+    }
 
-        $scoperStatements = preg_replace(
-            '/(\s*\\$loader \= .*)/',
-            $autoloadContents,
-            $scoperStatements,
+    private static function getLoaderStatementIndent(string $scoperStatements): string
+    {
+        if (1 !== preg_match('/(?<indent> *)\\$loader \= .*autoload\.php.*/', $scoperStatements, $matches)) {
+            throw new UnexpectedValueException('Could not process the scoper autoloader statements');
+        }
+
+        return $matches['indent'];
+    }
+
+    private static function fixInlinedAutoloadIndent(string $autoloadContents, string $indent): string
+    {
+        $lines = explode(PHP_EOL, $autoloadContents);
+
+        $indentedLines = array_map(
+            static fn (string $line) => '' === $line ? $line : $indent.$line,
+            $lines,
         );
 
+        return implode(PHP_EOL, $indentedLines);
+    }
+
+    private static function cleanupDuplicateLineReturns(string $value): string
+    {
         return preg_replace(
             '/\n{2,}/m',
             PHP_EOL.PHP_EOL,
-            $scoperStatements,
+            $value,
         );
     }
 }
diff --git a/src/Composer/ComposerOrchestrator.php b/src/Composer/ComposerOrchestrator.php
@@ -112,6 +112,7 @@ public function dumpAutoload(
         SymbolsRegistry $symbolsRegistry,
         string $prefix,
         bool $excludeDevFiles,
+        array $excludedComposerAutoloadFileHashes,
     ): void {
         $this->dumpAutoloader(true === $excludeDevFiles);
 
@@ -123,6 +124,7 @@ public function dumpAutoload(
 
         $autoloadContents = AutoloadDumper::generateAutoloadStatements(
             $symbolsRegistry,
+            $excludedComposerAutoloadFileHashes,
             $this->fileSystem->getFileContents($autoloadFile),
         );
 

diff --git a/src/Console/Command/Compile.php b/src/Console/Command/Compile.php
@@ -668,10 +668,11 @@ private static function commit(
 
         $box->endBuffering(
             $config->dumpAutoload()
-                ? static fn (SymbolsRegistry $symbolsRegistry, string $prefix) => $composerOrchestrator->dumpAutoload(
+                ? static fn (SymbolsRegistry $symbolsRegistry, string $prefix, array $excludeScoperFiles) => $composerOrchestrator->dumpAutoload(
                     $symbolsRegistry,
                     $prefix,
                     $excludeDevFiles,
+                    $excludeScoperFiles,
                 )
                 : null,
         );

diff --git a/src/PhpScoper/NullScoper.php b/src/PhpScoper/NullScoper.php
@@ -45,4 +45,9 @@ public function getPrefix(): string
     {
         return '';
     }
+
+    public function getExcludedFilePaths(): array
+    {
+        return [];
+    }
 }
diff --git a/src/PhpScoper/SerializableScoper.php b/src/PhpScoper/SerializableScoper.php
@@ -33,7 +33,7 @@ final class SerializableScoper implements Scoper
     /**
      * @var list<string>
      */
-    private array $excludedFilePaths;
+    public array $excludedFilePaths;
 
     public function __construct(
         PhpScoperConfiguration $scoperConfig,
@@ -114,4 +114,9 @@ private function createScoper(): PhpScoperScoper
             ...$this->excludedFilePaths,
         );
     }
+
+    public function getExcludedFilePaths(): array
+    {
+        return $this->excludedFilePaths;
+    }
 }