Adapt printer API to preserve formatting (#652)

Author: theofidry

src/Container.php

@@ -37,6 +37,7 @@ final class Container
     private ScoperFactory $scoperFactory;
     private EnrichedReflectorFactory $enrichedReflectorFactory;
     private Printer $printer;
+    private Lexer $lexer;
 
     public function getFileSystem(): Filesystem
     {
@@ -68,6 +69,7 @@ public function getScoperFactory(): ScoperFactory
                 $this->getParser(),
                 $this->getEnrichedReflectorFactory(),
                 $this->getPrinter(),
+                $this->getLexer(),
             );
         }
 
@@ -77,7 +79,10 @@ public function getScoperFactory(): ScoperFactory
     public function getParser(): Parser
     {
         if (!isset($this->parser)) {
-            $this->parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7, new Lexer());
+            $this->parser = (new ParserFactory())->create(
+                ParserFactory::PREFER_PHP7,
+                $this->getLexer(),
+            );
         }
 
         return $this->parser;
@@ -113,4 +118,13 @@ public function getPrinter(): Printer
 
         return $this->printer;
     }
+
+    public function getLexer(): Lexer
+    {
+        if (!isset($this->lexer)) {
+            $this->lexer = new Lexer();
+        }
+
+        return $this->lexer;
+    }
 }

src/PhpParser/Printer/Printer.php

@@ -9,7 +9,9 @@
 interface Printer
 {
     /**
-     * @param Node[] $statements
+     * @param Node[] $newStmts
+     * @param Node[] $oldStmts
+     * @param array<mixed> $oldTokens
      */
-    public function print(array $statements): string;
+    public function print(array $newStmts, array $oldStmts, array $oldTokens): string;
 }

src/PhpParser/Printer/StandardPrinter.php

@@ -17,8 +17,8 @@ public function __construct(
         $this->decoratedPrinter = $decoratedPrinter;
     }
 
-    public function print(array $statements): string
+    public function print(array $newStmts, array $oldStmts, array $oldTokens): string
     {
-        return $this->decoratedPrinter->prettyPrintFile($statements)."\n";
+        return $this->decoratedPrinter->prettyPrintFile($newStmts)."\n";
     }
 }

src/Scoper/PhpScoper.php

@@ -16,10 +16,9 @@
 
 use Humbug\PhpScoper\PhpParser\Printer\Printer;
 use Humbug\PhpScoper\PhpParser\TraverserFactory;
-use Humbug\PhpScoper\Symbol\SymbolsRegistry;
 use PhpParser\Error as PhpParserError;
+use PhpParser\Lexer;
 use PhpParser\Parser;
-use PhpParser\PrettyPrinter\Standard;
 use function basename;
 use function func_get_args;
 use function ltrim;
@@ -36,17 +35,20 @@ final class PhpScoper implements Scoper
     private Scoper $decoratedScoper;
     private TraverserFactory $traverserFactory;
     private Printer $printer;
+    private Lexer $lexer;
 
     public function __construct(
         Parser $parser,
         Scoper $decoratedScoper,
         TraverserFactory $traverserFactory,
-        Printer $printer
+        Printer $printer,
+        Lexer $lexer
     ) {
         $this->parser = $parser;
         $this->decoratedScoper = $decoratedScoper;
         $this->traverserFactory = $traverserFactory;
         $this->printer = $printer;
+        $this->lexer = $lexer;
     }
 
     /**
@@ -66,12 +68,17 @@ public function scope(string $filePath, string $contents): string
     public function scopePhp(string $php): string
     {
         $statements = $this->parser->parse($php);
+        $oldTokens = $this->lexer->getTokens();
 
         $scopedStatements = $this->traverserFactory
             ->create($this)
             ->traverse($statements);
 
-        return $this->printer->print($scopedStatements);
+        return $this->printer->print(
+            $scopedStatements,
+            $scopedStatements,
+            $oldTokens,
+        );
     }
 
     private static function isPhpFile(string $filePath, string $contents): bool

src/Scoper/ScoperFactory.php

@@ -22,6 +22,7 @@
 use Humbug\PhpScoper\Scoper\Composer\JsonFileScoper;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
+use PhpParser\Lexer;
 use PhpParser\Parser;
 
 /**
@@ -32,15 +33,18 @@ class ScoperFactory
     private Parser $parser;
     private EnrichedReflectorFactory $enrichedReflectorFactory;
     private Printer $printer;
+    private Lexer $lexer;
 
     public function __construct(
         Parser $parser,
         EnrichedReflectorFactory $enrichedReflectorFactory,
-        Printer $printer
+        Printer $printer,
+        Lexer $lexer
     ) {
         $this->parser = $parser;
         $this->enrichedReflectorFactory = $enrichedReflectorFactory;
         $this->printer = $printer;
+        $this->lexer = $lexer;
     }
 
     public function createScoper(
@@ -78,6 +82,7 @@ public function createScoper(
                     $symbolsRegistry,
                 ),
                 $this->printer,
+                $this->lexer,
             ),
             $prefix,
             $configuration->getPatcher(),

tests/Console/Command/DummyScoperFactory.php

@@ -10,6 +10,7 @@
 use Humbug\PhpScoper\Scoper\ScoperFactory;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
+use PhpParser\Lexer;
 use PhpParser\Parser;
 
 final class DummyScoperFactory extends ScoperFactory
@@ -22,7 +23,12 @@ public function __construct(
         Printer $printer,
         Scoper $scoper
     ) {
-        parent::__construct($parser, $enrichedReflectorFactory, $printer);
+        parent::__construct(
+            $parser,
+            $enrichedReflectorFactory,
+            $printer,
+            new Lexer(),
+        );
 
         $this->scoper = $scoper;
     }

tests/PhpParser/FakePrinter.php

@@ -10,7 +10,7 @@
 
 final class FakePrinter implements Printer
 {
-    public function print(array $statements): string
+    public function print(array $newStmts, array $oldStmts, array $oldTokens): string
     {
         throw new LogicException();
     }

tests/PhpParser/TraverserFactoryTest.php

@@ -20,6 +20,7 @@
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
 use Humbug\PhpScoper\Symbol\Reflector;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
+use PhpParser\Lexer;
 use PHPUnit\Framework\TestCase;
 use ReflectionClass;
 
@@ -36,6 +37,7 @@ public function test_creates_a_new_traverser_at_each_call(): void
             new FakeScoper(),
             (new ReflectionClass(TraverserFactory::class))->newInstanceWithoutConstructor(),
             new FakePrinter(),
+            new Lexer(),
         );
         $symbolsRegistry = new SymbolsRegistry();
 

tests/Scoper/PhpScoperSpecTest.php

@@ -300,6 +300,7 @@ private static function createScoper(
                 $symbolsRegistry,
             ),
             $container->getPrinter(),
+            $container->getLexer(),
         );
     }
 

tests/Scoper/PhpScoperTest.php

@@ -25,6 +25,7 @@
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
 use LogicException;
 use PhpParser\Error as PhpParserError;
+use PhpParser\Lexer;
 use PhpParser\Node\Name;
 use PhpParser\NodeTraverserInterface;
 use PhpParser\Parser;
@@ -68,6 +69,8 @@ class PhpScoperTest extends TestCase
     private SymbolsRegistry $symbolsRegistry;
 
     private Printer $printer;
+    
+    private Lexer $lexer;
 
     protected function setUp(): void
     {
@@ -83,6 +86,11 @@ protected function setUp(): void
         $this->symbolsRegistry = new SymbolsRegistry();
         $this->printer = new StandardPrinter(new Standard());
 
+        $lexerProphecy = $this->prophesize(Lexer::class);
+        $lexerProphecy->getTokens()->willReturn([]);
+        
+        $this->lexer = $lexerProphecy->reveal();
+        
         $this->scoper = new PhpScoper(
             create_parser(),
             new FakeScoper(),
@@ -95,6 +103,7 @@ protected function setUp(): void
                 $this->symbolsRegistry,
             ),
             $this->printer,
+            $this->lexer,
         );
     }
 
@@ -147,6 +156,7 @@ public function test_does_not_scope_file_if_is_not_a_PHP_file(): void
             $this->decoratedScoper,
             $this->traverserFactory,
             new FakePrinter(),
+            $this->lexer,
         );
 
         $actual = $scoper->scope($filePath, $fileContents);
@@ -234,6 +244,7 @@ public function test_does_not_scope_a_non_PHP_executable_files(): void
             $this->decoratedScoper,
             $this->traverserFactory,
             new FakePrinter(),
+            $this->lexer,
         );
 
         $actual = $scoper->scope($filePath, $contents);
@@ -332,6 +343,7 @@ static function () use (&$i): bool {
             new FakeScoper(),
             $this->traverserFactory,
             $this->printer,
+            $this->lexer,
         );
 
         foreach ($files as $file => $contents) {