Introduce a Printer abstraction (#655)

Author: theofidry

src/Container.php

@@ -17,12 +17,15 @@
 use Humbug\PhpScoper\Configuration\ConfigurationFactory;
 use Humbug\PhpScoper\Configuration\RegexChecker;
 use Humbug\PhpScoper\Configuration\SymbolsConfigurationFactory;
+use Humbug\PhpScoper\PhpParser\Printer\Printer;
+use Humbug\PhpScoper\PhpParser\Printer\StandardPrinter;
 use Humbug\PhpScoper\Scoper\ScoperFactory;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
 use Humbug\PhpScoper\Symbol\Reflector;
 use PhpParser\Lexer;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
+use PhpParser\PrettyPrinter\Standard;
 use Symfony\Component\Filesystem\Filesystem;
 
 final class Container
@@ -33,6 +36,7 @@ final class Container
     private Reflector $reflector;
     private ScoperFactory $scoperFactory;
     private EnrichedReflectorFactory $enrichedReflectorFactory;
+    private Printer $printer;
 
     public function getFileSystem(): Filesystem
     {
@@ -63,6 +67,7 @@ public function getScoperFactory(): ScoperFactory
             $this->scoperFactory = new ScoperFactory(
                 $this->getParser(),
                 $this->getEnrichedReflectorFactory(),
+                $this->getPrinter(),
             );
         }
 
@@ -97,4 +102,15 @@ public function getEnrichedReflectorFactory(): EnrichedReflectorFactory
 
         return $this->enrichedReflectorFactory;
     }
+
+    public function getPrinter(): Printer
+    {
+        if (!isset($this->printer)) {
+            $this->printer = new StandardPrinter(
+                new Standard(),
+            );
+        }
+
+        return $this->printer;
+    }
 }

src/PhpParser/Printer/Printer.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Humbug\PhpScoper\PhpParser\Printer;
+
+use PhpParser\Node;
+
+interface Printer
+{
+    /**
+     * @param Node[] $statements
+     */
+    public function print(array $statements): string;
+}

src/PhpParser/Printer/StandardPrinter.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Humbug\PhpScoper\PhpParser\Printer;
+
+use PhpParser\PrettyPrinterAbstract;
+
+final class StandardPrinter implements Printer
+{
+    private PrettyPrinterAbstract $decoratedPrinter;
+
+    public function __construct(
+        PrettyPrinterAbstract $decoratedPrinter
+    ) {
+
+        $this->decoratedPrinter = $decoratedPrinter;
+    }
+
+    public function print(array $statements): string
+    {
+        return $this->decoratedPrinter->prettyPrintFile($statements)."\n";
+    }
+}

src/Scoper/PhpScoper.php

@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\Scoper;
 
+use Humbug\PhpScoper\PhpParser\Printer\Printer;
 use Humbug\PhpScoper\PhpParser\TraverserFactory;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
 use PhpParser\Error as PhpParserError;
@@ -34,15 +35,18 @@ final class PhpScoper implements Scoper
     private Parser $parser;
     private Scoper $decoratedScoper;
     private TraverserFactory $traverserFactory;
+    private Printer $printer;
 
     public function __construct(
         Parser $parser,
         Scoper $decoratedScoper,
-        TraverserFactory $traverserFactory
+        TraverserFactory $traverserFactory,
+        Printer $printer
     ) {
         $this->parser = $parser;
         $this->decoratedScoper = $decoratedScoper;
         $this->traverserFactory = $traverserFactory;
+        $this->printer = $printer;
     }
 
     /**
@@ -67,9 +71,7 @@ public function scopePhp(string $php): string
             ->create($this)
             ->traverse($statements);
 
-        $prettyPrinter = new Standard();
-
-        return $prettyPrinter->prettyPrintFile($scopedStatements)."\n";
+        return $this->printer->print($scopedStatements);
     }
 
     private static function isPhpFile(string $filePath, string $contents): bool

src/Scoper/ScoperFactory.php

@@ -15,6 +15,7 @@
 namespace Humbug\PhpScoper\Scoper;
 
 use Humbug\PhpScoper\Configuration\Configuration;
+use Humbug\PhpScoper\PhpParser\Printer\Printer;
 use Humbug\PhpScoper\PhpParser\TraverserFactory;
 use Humbug\PhpScoper\Scoper\Composer\AutoloadPrefixer;
 use Humbug\PhpScoper\Scoper\Composer\InstalledPackagesScoper;
@@ -30,11 +31,16 @@ class ScoperFactory
 {
     private Parser $parser;
     private EnrichedReflectorFactory $enrichedReflectorFactory;
+    private Printer $printer;
 
-    public function __construct(Parser $parser, EnrichedReflectorFactory $enrichedReflectorFactory)
-    {
+    public function __construct(
+        Parser $parser,
+        EnrichedReflectorFactory $enrichedReflectorFactory,
+        Printer $printer
+    ) {
         $this->parser = $parser;
         $this->enrichedReflectorFactory = $enrichedReflectorFactory;
+        $this->printer = $printer;
     }
 
     public function createScoper(
@@ -71,6 +77,7 @@ public function createScoper(
                     $prefix,
                     $symbolsRegistry,
                 ),
+                $this->printer,
             ),
             $prefix,
             $configuration->getPatcher(),

tests/Console/Command/AddPrefixCommandTest.php

@@ -25,6 +25,7 @@
 use Humbug\PhpScoper\Container;
 use Humbug\PhpScoper\FileSystemTestCase;
 use Humbug\PhpScoper\PhpParser\FakeParser;
+use Humbug\PhpScoper\PhpParser\FakePrinter;
 use Humbug\PhpScoper\Scoper\Scoper;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
 use Humbug\PhpScoper\Symbol\Reflector;
@@ -587,6 +588,7 @@ private function createAppTester(): ApplicationTester
                         new EnrichedReflectorFactory(
                             Reflector::createEmpty(),
                         ),
+                        new FakePrinter(),
                         $scoper,
                     ),
                     $innerApp,

tests/Console/Command/AppIntegrationTest.php

@@ -25,6 +25,7 @@
 use Humbug\PhpScoper\Container;
 use Humbug\PhpScoper\FileSystemTestCase;
 use Humbug\PhpScoper\PhpParser\FakeParser;
+use Humbug\PhpScoper\PhpParser\FakePrinter;
 use Humbug\PhpScoper\Scoper\Scoper;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
 use Humbug\PhpScoper\Symbol\Reflector;
@@ -157,6 +158,7 @@ private function createAppTester(): ApplicationTester
                     new DummyScoperFactory(
                         new FakeParser(),
                         new EnrichedReflectorFactory(Reflector::createEmpty()),
+                        new FakePrinter(),
                         $scoper,
                     ),
                     $innerApp,

tests/Console/Command/DummyScoperFactory.php

@@ -5,6 +5,7 @@
 namespace Humbug\PhpScoper\Console\Command;
 
 use Humbug\PhpScoper\Configuration\Configuration;
+use Humbug\PhpScoper\PhpParser\Printer\Printer;
 use Humbug\PhpScoper\Scoper\Scoper;
 use Humbug\PhpScoper\Scoper\ScoperFactory;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
@@ -15,9 +16,13 @@ final class DummyScoperFactory extends ScoperFactory
 {
     private Scoper $scoper;
 
-    public function __construct(Parser $parser, EnrichedReflectorFactory $enrichedReflectorFactory, Scoper $scoper)
-    {
-        parent::__construct($parser, $enrichedReflectorFactory);
+    public function __construct(
+        Parser $parser,
+        EnrichedReflectorFactory $enrichedReflectorFactory,
+        Printer $printer,
+        Scoper $scoper
+    ) {
+        parent::__construct($parser, $enrichedReflectorFactory, $printer);
 
         $this->scoper = $scoper;
     }

tests/PhpParser/FakePrinter.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Humbug\PhpScoper\PhpParser;
+
+use Humbug\PhpScoper\PhpParser\Printer\Printer;
+use LogicException;
+use PhpParser\Node;
+
+final class FakePrinter implements Printer
+{
+    public function print(array $statements): string
+    {
+        throw new LogicException();
+    }
+}

tests/PhpParser/TraverserFactoryTest.php

@@ -35,6 +35,7 @@ public function test_creates_a_new_traverser_at_each_call(): void
             new FakeParser(),
             new FakeScoper(),
             (new ReflectionClass(TraverserFactory::class))->newInstanceWithoutConstructor(),
+            new FakePrinter(),
         );
         $symbolsRegistry = new SymbolsRegistry();
 

tests/Scoper/PhpScoperSpecTest.php

@@ -19,6 +19,7 @@
 use Humbug\PhpScoper\Configuration\RegexChecker;
 use Humbug\PhpScoper\Configuration\SymbolsConfiguration;
 use Humbug\PhpScoper\Configuration\SymbolsConfigurationFactory;
+use Humbug\PhpScoper\Container;
 use Humbug\PhpScoper\PhpParser\TraverserFactory;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
 use Humbug\PhpScoper\Symbol\NamespaceRegistry;
@@ -275,7 +276,7 @@ private static function createScoper(
         SymbolsRegistry $symbolsRegistry
     ): Scoper
     {
-        $phpParser = create_parser();
+        $container = new Container();
 
         $reflector = Reflector
             ::createWithPhpStormStubs()
@@ -291,13 +292,14 @@ private static function createScoper(
         );
 
         return new PhpScoper(
-            $phpParser,
+            $container->getParser(),
             new FakeScoper(),
             new TraverserFactory(
                 $enrichedReflector,
                 $prefix,
                 $symbolsRegistry,
             ),
+            $container->getPrinter(),
         );
     }
 

tests/Scoper/PhpScoperTest.php

@@ -16,6 +16,9 @@
 
 use Humbug\PhpScoper\Configuration\SymbolsConfiguration;
 use Humbug\PhpScoper\PhpParser\FakeParser;
+use Humbug\PhpScoper\PhpParser\FakePrinter;
+use Humbug\PhpScoper\PhpParser\Printer\Printer;
+use Humbug\PhpScoper\PhpParser\Printer\StandardPrinter;
 use Humbug\PhpScoper\PhpParser\TraverserFactory;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
 use Humbug\PhpScoper\Symbol\Reflector;
@@ -25,6 +28,7 @@
 use PhpParser\Node\Name;
 use PhpParser\NodeTraverserInterface;
 use PhpParser\Parser;
+use PhpParser\PrettyPrinter\Standard;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -63,6 +67,8 @@ class PhpScoperTest extends TestCase
 
     private SymbolsRegistry $symbolsRegistry;
 
+    private Printer $printer;
+
     protected function setUp(): void
     {
         $this->decoratedScoperProphecy = $this->prophesize(Scoper::class);
@@ -75,6 +81,7 @@ protected function setUp(): void
         $this->parser = $this->parserProphecy->reveal();
 
         $this->symbolsRegistry = new SymbolsRegistry();
+        $this->printer = new StandardPrinter(new Standard());
 
         $this->scoper = new PhpScoper(
             create_parser(),
@@ -87,6 +94,7 @@ protected function setUp(): void
                 self::PREFIX,
                 $this->symbolsRegistry,
             ),
+            $this->printer,
         );
     }
 
@@ -138,6 +146,7 @@ public function test_does_not_scope_file_if_is_not_a_PHP_file(): void
             new FakeParser(),
             $this->decoratedScoper,
             $this->traverserFactory,
+            new FakePrinter(),
         );
 
         $actual = $scoper->scope($filePath, $fileContents);
@@ -224,6 +233,7 @@ public function test_does_not_scope_a_non_PHP_executable_files(): void
             new FakeParser(),
             $this->decoratedScoper,
             $this->traverserFactory,
+            new FakePrinter(),
         );
 
         $actual = $scoper->scope($filePath, $contents);
@@ -321,6 +331,7 @@ static function () use (&$i): bool {
             $this->parser,
             new FakeScoper(),
             $this->traverserFactory,
+            $this->printer,
         );
 
         foreach ($files as $file => $contents) {

tests/Scoper/ScoperFactoryTest.php

@@ -8,6 +8,7 @@
 use Humbug\PhpScoper\Configuration\SymbolsConfiguration;
 use Humbug\PhpScoper\Patcher\FakePatcher;
 use Humbug\PhpScoper\PhpParser\FakeParser;
+use Humbug\PhpScoper\PhpParser\FakePrinter;
 use Humbug\PhpScoper\Symbol\EnrichedReflectorFactory;
 use Humbug\PhpScoper\Symbol\Reflector;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
@@ -25,6 +26,7 @@ public function test_it_can_create_a_scoper(): void
             new EnrichedReflectorFactory(
                 Reflector::createEmpty(),
             ),
+            new FakePrinter(),
         );
 
         $factory->createScoper(