Bring better performances (#329)

- Remove the deprecated `Humbug\PhpScoper\Console\Configuration` and make the parent `Humbug\PhpScoper\Configuration` final
- Replace usage of `uniqid` by `bin2hex(random_bytes())`
- Move namespace related `PhpParser` classes under `PhpParser\NamespaceStmt`
- Similar change as namespaces for use statements
- Introduce `NamespaceManipulator` and `UseStmtManipulator` in order to add the original name of the statement as an attribute and leverage this instead of (deep) cloning the whole node; this avoid to have to rely on heavy `serialize`/`unserialize` calls
- Heavily simplify the `Reflector` class by leveraging the phpstorm stub maps (which is generated by BetterReflection at the moment) instead of requiring to retrieve the whole reflection class for a given symbol

Closes #321

Author: theofidry

src/Configuration.php

@@ -36,11 +36,7 @@
 use function realpath;
 use function sprintf;
 
-/**
- * @final
- * TODO: make this class as final as soon as the underlying deprecated class is removed.
- */
-class Configuration
+final class Configuration
 {
     private const PREFIX_KEYWORD = 'prefix';
     private const WHITELISTED_FILES_KEYWORD = 'files-whitelist';

src/Console/Command/AddPrefixCommand.php

@@ -478,6 +478,6 @@ private function makeAbsolutePath(string $path): string
 
     private function generateRandomPrefix(): string
     {
-        return uniqid('_PhpScoper', false);
+        return '_PhpScoper'.bin2hex(random_bytes(6));
     }
 }

src/Console/Configuration.php

@@ -23,21 +23,11 @@
 use Humbug\PhpScoper\Scoper\SymfonyScoper;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
-use Roave\BetterReflection\Reflector\ClassReflector;
-use Roave\BetterReflection\Reflector\ConstantReflector;
-use Roave\BetterReflection\Reflector\FunctionReflector;
-use Roave\BetterReflection\SourceLocator\Ast\Locator;
-use Roave\BetterReflection\SourceLocator\SourceStubber\AggregateSourceStubber;
-use Roave\BetterReflection\SourceLocator\SourceStubber\PhpStormStubsSourceStubber;
-use Roave\BetterReflection\SourceLocator\SourceStubber\ReflectionSourceStubber;
-use Roave\BetterReflection\SourceLocator\Type\MemoizingSourceLocator;
-use Roave\BetterReflection\SourceLocator\Type\PhpInternalSourceLocator;
 
 final class Container
 {
     private $parser;
     private $reflector;
-    private $functionReflector;
     private $scoper;
 
     public function getScoper(): Scoper
@@ -73,34 +63,7 @@ public function getParser(): Parser
     public function getReflector(): Reflector
     {
         if (null === $this->reflector) {
-            $phpParser = $this->getParser();
-
-            $astLocator = new Locator(
-                $phpParser,
-                function (): FunctionReflector {
-                    return $this->functionReflector;
-                }
-            );
-
-            $sourceLocator = new MemoizingSourceLocator(
-                new PhpInternalSourceLocator(
-                    $astLocator,
-                    new AggregateSourceStubber(
-                        new PhpStormStubsSourceStubber($phpParser),
-                        new ReflectionSourceStubber()
-                    )
-                )
-            );
-
-            $classReflector = new ClassReflector($sourceLocator);
-
-            $this->functionReflector = new FunctionReflector($sourceLocator, $classReflector);
-
-            $this->reflector = new Reflector(
-                $classReflector,
-                $this->functionReflector,
-                new ConstantReflector($sourceLocator, $classReflector)
-            );
+            $this->reflector = new Reflector();
         }
 
         return $this->reflector;

src/Container.php

@@ -12,8 +12,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt;
 
+use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\FullyQualifiedNameResolver;
 use Humbug\PhpScoper\Reflector;
 use Humbug\PhpScoper\Whitelist;

src/PhpParser/NodeVisitor/FunctionIdentifierRecorder.php renamed to src/PhpParser/NodeVisitor/NamespaceStmt/FunctionIdentifierRecorder.php

@@ -0,0 +1,50 @@
+<?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.
+ */
+
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt;
+
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Namespace_;
+use PhpParser\NodeVisitorAbstract;
+
+/**
+ * @private
+ */
+final class NamespaceManipulator extends NodeVisitorAbstract
+{
+    private const ORIGINAL_NAME_ATTRIBUTE = 'originalName';
+
+    public static function hasOriginalName(Namespace_ $namespace): bool
+    {
+        return $namespace->hasAttribute(self::ORIGINAL_NAME_ATTRIBUTE);
+    }
+
+    public static function getOriginalName(Namespace_ $namespace): ?Name
+    {
+        if (false === self::hasOriginalName($namespace)) {
+            return $namespace->name;
+        }
+
+        return $namespace->getAttribute(self::ORIGINAL_NAME_ATTRIBUTE);
+    }
+
+    public static function setOriginalName(Namespace_ $namespace, ?Name $originalName): void
+    {
+        $namespace->setAttribute(self::ORIGINAL_NAME_ATTRIBUTE, $originalName);
+    }
+
+    private function __construct()
+    {
+    }
+}

src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceManipulator.php

@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Collection;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt;
 
 use ArrayIterator;
 use Countable;
@@ -43,14 +43,13 @@ final class NamespaceStmtCollection implements IteratorAggregate, Countable
     private $mapping = [];
 
     /**
-     * @param Namespace_ $node         New namespace, may have been prefixed.
-     * @param Namespace_ $originalName Original unchanged namespace.
+     * @param Namespace_ $namespace New namespace, may have been prefixed.
      */
-    public function add(Namespace_ $node, Namespace_ $originalName): void
+    public function add(Namespace_ $namespace): void
     {
-        $this->nodes[] = $originalName;
+        $this->nodes[] = $namespace;
 
-        $this->mapping[(string) $node->name] = $originalName->name;
+        $this->mapping[(string) $namespace->name] = NamespaceManipulator::getOriginalName($namespace);
     }
 
     public function findNamespaceForNode(Node $node): ?Name
@@ -61,16 +60,16 @@ public function findNamespaceForNode(Node $node): ?Name
 
         // Shortcut if there is only one namespace
         if (1 === count($this->nodes)) {
-            return $this->nodes[0]->name;
+            return NamespaceManipulator::getOriginalName($this->nodes[0]);
         }
 
-        return $this->getNodeNamespace($node);
+        return $this->getNodeNamespaceName($node);
     }
 
     public function findNamespaceByName(string $name): ?Name
     {
         foreach ($this->nodes as $node) {
-            if ((string) $node->name === $name) {
+            if ((string) NamespaceManipulator::getOriginalName($node) === $name) {
                 return $node->name;
             }
         }
@@ -82,7 +81,7 @@ public function getCurrentNamespaceName(): ?Name
     {
         $lastNode = end($this->nodes);
 
-        return false === $lastNode ? null : $lastNode->name;
+        return false === $lastNode ? null : NamespaceManipulator::getOriginalName($lastNode);
     }
 
     /**
@@ -93,7 +92,7 @@ public function count(): int
         return count($this->nodes);
     }
 
-    private function getNodeNamespace(Node $node): ?Name
+    private function getNodeNamespaceName(Node $node): ?Name
     {
         if (false === ParentNodeAppender::hasParent($node)) {
             return null;
@@ -105,7 +104,7 @@ private function getNodeNamespace(Node $node): ?Name
             return $this->mapping[(string) $parentNode->name];
         }
 
-        return $this->getNodeNamespace($parentNode);
+        return $this->getNodeNamespaceName($parentNode);
     }
 
     /**

src/PhpParser/NodeVisitor/Collection/NamespaceStmtCollection.php renamed to src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceStmtCollection.php

@@ -12,15 +12,13 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt;
 
-use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\NamespaceStmtCollection;
 use Humbug\PhpScoper\Whitelist;
 use PhpParser\Node;
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Namespace_;
 use PhpParser\NodeVisitorAbstract;
-use function Humbug\PhpScoper\clone_node;
 
 /**
  * Prefixes the relevant namespaces.
@@ -63,15 +61,15 @@ public function enterNode(Node $node): Node
 
     private function prefixNamespaceStmt(Namespace_ $namespace): Node
     {
-        $originalNamespace = $namespace;
-
         if ($this->shouldPrefixStmt($namespace)) {
-            $originalNamespace = clone_node($namespace);
+            $originalName = $namespace->name;
 
             $namespace->name = Name::concat($this->prefix, $namespace->name);
+
+            NamespaceManipulator::setOriginalName($namespace, $originalName);
         }
 
-        $this->namespaceStatements->add($namespace, $originalNamespace);
+        $this->namespaceStatements->add($namespace);
 
         return $namespace;
     }

src/PhpParser/NodeVisitor/NamespaceStmtPrefixer.php renamed to src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceStmtPrefixer.php

@@ -21,7 +21,6 @@
 /**
  * Appends the parent node as an attribute to each node. This allows to have more context in the other visitors when
  * inspecting a node.
- * TODO: rename to ParentNodeAppender.
  *
  * @private
  */

src/PhpParser/NodeVisitor/ParentNodeAppender.php

@@ -15,10 +15,10 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver;
 
 use Humbug\PhpScoper\PhpParser\Node\NamedIdentifier;
-use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\NamespaceStmtCollection;
-use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\UseStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt\NamespaceStmtCollection;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\NameStmtPrefixer;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt\UseStmtCollection;
 use PhpParser\Node;
 use PhpParser\Node\Expr\ConstFetch;
 use PhpParser\Node\Expr\FuncCall;