Move classes under the PHP-Parser namespace (#184)

theofidry · web-flow · commit d65fca7e9299 · 2018-03-01T23:13:34.000+01:00
- Move the classes related to PHP-Parser under `Humbug\Scoper\PhpParser`
- Mark those classes as `@private`: they are not part of the public API
- Add code coverage validation
diff --git a/.gitignore b/.gitignore
@@ -7,7 +7,8 @@
 /fixtures/set004/scoper.inc.php
 /fixtures/*/vendor
 /vendor/
-/vendor-bin/box/vendor/
+/vendor-bin/*/vendor/
+/vendor-bin/*/bin/
 /.travis/
 !/.travis/.gitkeep
 !/.travis/secrets.tar.enc
diff --git a/Makefile b/Makefile
@@ -1,7 +1,8 @@
+BLACKFIRE=blackfire
 BOX=vendor-bin/box/vendor/bin/box
-PHPUNIT=vendor/bin/phpunit
+COVERS_VALIDATOR=php -d zend.enable_gc=0 vendor-bin/covers-validator/bin/covers-validator
 PHPSCOPER=bin/php-scoper.phar
-BLACKFIRE=blackfire
+PHPUNIT=vendor/bin/phpunit
 
 
 .DEFAULT_GOAL := help
@@ -54,7 +55,8 @@ tu: vendor/bin/phpunit
 	php -d zend.enable_gc=0 $(PHPUNIT)
 
 tc:		## Run PHPUnit tests with test coverage
-tc: vendor/bin/phpunit
+tc: vendor/bin/phpunit vendor-bin/covers-validator/vendor
+	$(COVERS_VALIDATOR)
 	phpdbg -qrr -d zend.enable_gc=0 $(PHPUNIT) --coverage-html=dist/coverage --coverage-text
 
 tm:		## Run Infection (Mutation Testing)
@@ -193,6 +195,9 @@ vendor/bin/phpunit: composer.lock
 vendor-bin/box/vendor: vendor-bin/box/composer.lock vendor/bamarni
 	composer bin all install
 
+vendor-bin/covers-validator/vendor: vendor-bin/covers-validator/composer.lock vendor/bamarni
+	composer bin covers-validator install
+
 fixtures/set005/vendor: fixtures/set005/composer.lock
 	composer --working-dir=fixtures/set005 install
 
@@ -223,6 +228,9 @@ composer.lock: composer.json
 vendor-bin/box/composer.lock: composer.lock
 	@echo composer.lock is not up to date.
 
+vendor-bin/covers-validator/composer.lock: vendor-bin/covers-validator/composer.json
+	@echo covers-validator composer.lock is not up to date
+
 fixtures/set005/composer.lock: fixtures/set005/composer.json
 	@echo fixtures/set005/composer.lock is not up to date.
 
diff --git a/src/PhpParser/NodeTraverser.php b/src/PhpParser/NodeTraverser.php
@@ -12,10 +12,8 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper;
+namespace Humbug\PhpScoper\PhpParser;
 
-// TODO: re-organise the classes location as this no longer makes sense. Not done here to try to keep the diff humanly
-// readable.
 use PhpParser\Node;
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Declare_;
@@ -26,6 +24,9 @@
 use PhpParser\Node\Stmt\UseUse;
 use PhpParser\NodeTraverser as PhpParserNodeTraverser;
 
+/**
+ * @private
+ */
 final class NodeTraverser extends PhpParserNodeTraverser
 {
     private $prefix;
diff --git a/src/PhpParser/NodeVisitor/AppendParentNode.php b/src/PhpParser/NodeVisitor/AppendParentNode.php
@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use PhpParser\Node;
 use PhpParser\NodeVisitorAbstract;
@@ -21,6 +21,8 @@
  * 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
  */
 final class AppendParentNode extends NodeVisitorAbstract
 {
diff --git a/src/PhpParser/NodeVisitor/Collection/NamespaceStmtCollection.php b/src/PhpParser/NodeVisitor/Collection/NamespaceStmtCollection.php
@@ -12,11 +12,11 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor\Collection;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Collection;
 
 use ArrayIterator;
 use Countable;
-use Humbug\PhpScoper\NodeVisitor\AppendParentNode;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AppendParentNode;
 use IteratorAggregate;
 use PhpParser\Node;
 use PhpParser\Node\Name;
@@ -25,6 +25,8 @@
 /**
  * Utility class collecting all the namespaces for the scoped files allowing to easily find the namespace to which
  * belongs a node.
+ *
+ * @private
  */
 final class NamespaceStmtCollection implements IteratorAggregate, Countable
 {
diff --git a/src/PhpParser/NodeVisitor/Collection/UseStmtCollection.php b/src/PhpParser/NodeVisitor/Collection/UseStmtCollection.php
@@ -12,10 +12,10 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor\Collection;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Collection;
 
 use ArrayIterator;
-use Humbug\PhpScoper\NodeVisitor\AppendParentNode;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AppendParentNode;
 use IteratorAggregate;
 use PhpParser\Node\Expr\ConstFetch;
 use PhpParser\Node\Expr\FuncCall;
@@ -27,6 +27,8 @@
 /**
  * Utility class collecting all the use statements for the scoped files allowing to easily find the use which a node
  * may use.
+ *
+ * @private
  */
 final class UseStmtCollection implements IteratorAggregate
 {
diff --git a/src/PhpParser/NodeVisitor/NameStmtPrefixer.php b/src/PhpParser/NodeVisitor/NameStmtPrefixer.php
@@ -12,9 +12,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
-use Humbug\PhpScoper\NodeVisitor\Resolver\FullyQualifiedNameResolver;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\FullyQualifiedNameResolver;
 use Humbug\PhpScoper\Reflector;
 use PhpParser\Node;
 use PhpParser\Node\Expr\ClassConstFetch;
diff --git a/src/PhpParser/NodeVisitor/NamespaceStmtPrefixer.php b/src/PhpParser/NodeVisitor/NamespaceStmtPrefixer.php
@@ -12,9 +12,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
-use Humbug\PhpScoper\NodeVisitor\Collection\NamespaceStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\NamespaceStmtCollection;
 use PhpParser\Node;
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Class_;
@@ -35,6 +35,8 @@
  * ```
  * namespace Humbug\Foo;
  * ```
+ *
+ * @private
  */
 final class NamespaceStmtPrefixer extends NodeVisitorAbstract
 {
diff --git a/src/PhpParser/NodeVisitor/Resolver/FullyQualifiedNameResolver.php b/src/PhpParser/NodeVisitor/Resolver/FullyQualifiedNameResolver.php
@@ -12,12 +12,12 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor\Resolver;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver;
 
-use Humbug\PhpScoper\NodeVisitor\AppendParentNode;
-use Humbug\PhpScoper\NodeVisitor\Collection\NamespaceStmtCollection;
-use Humbug\PhpScoper\NodeVisitor\Collection\UseStmtCollection;
-use Humbug\PhpScoper\NodeVisitor\NameStmtPrefixer;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AppendParentNode;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\NamespaceStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\UseStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\NameStmtPrefixer;
 use PhpParser\Node\Expr\ConstFetch;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Name;
@@ -27,6 +27,8 @@
 /**
  * Attempts to resolve the node name into a fully qualified node. Returns a valid (non fully-qualified) name node on
  * failure.
+ *
+ * @private
  */
 final class FullyQualifiedNameResolver
 {
diff --git a/src/PhpParser/NodeVisitor/Resolver/ResolvedValue.php b/src/PhpParser/NodeVisitor/Resolver/ResolvedValue.php
@@ -12,10 +12,13 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor\Resolver;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver;
 
 use PhpParser\Node\Name;
 
+/**
+ * @private
+ */
 final class ResolvedValue
 {
     private $name;
diff --git a/src/PhpParser/NodeVisitor/StringScalarPrefixer.php b/src/PhpParser/NodeVisitor/StringScalarPrefixer.php
@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use Humbug\PhpScoper\Reflector;
 use PhpParser\Node;
@@ -42,29 +42,17 @@
  * ```
  * $x = 'Humbug\Foo\Bar';
  * ```
+ *
+ * @private
  */
 final class StringScalarPrefixer extends NodeVisitorAbstract
 {
     private $prefix;
-    private $whitelistedFunctions;
-    private $whitelist;
     private $reflector;
 
-    /**
-     * @param string    $prefix
-     * @param string[]  $whitelistedFunctions
-     * @param string[]  $whitelist
-     * @param Reflector $reflector
-     */
-    public function __construct(
-        string $prefix,
-        array $whitelistedFunctions,
-        array $whitelist,
-        Reflector $reflector
-    ) {
+    public function __construct(string $prefix, Reflector $reflector)
+    {
         $this->prefix = $prefix;
-        $this->whitelistedFunctions = $whitelistedFunctions;
-        $this->whitelist = $whitelist;
         $this->reflector = $reflector;
     }
 
@@ -82,7 +70,7 @@ public function enterNode(Node $node): Node
     private function shouldPrefixScalar(Node $node): bool
     {
         if (false === ($node instanceof String_ && AppendParentNode::hasParent($node) && is_string($node->value))
-            || 1 !== preg_match('/^\\\\*(?:\p{L}+\\\\+)++\p{L}+$/', $node->value)
+            || 1 !== preg_match('/^\\\\*(?:\p{L}+\\\\+)++\p{L}+$/u', $node->value)
         ) {
             return false;
         }
@@ -121,8 +109,8 @@ private function prefixStringScalar(String_ $string): Node
             $newStringName = $stringName;
         // Check if the class can be prefixed: class from the global namespace
         } elseif (
-            $this->reflector->isClassInternal($stringName->toString())
-            || 1 === count($stringName->parts)
+            1 === count($stringName->parts)
+            || $this->reflector->isClassInternal($stringName->toString())
         ) {
             $newStringName = $stringName;
         } else {
diff --git a/src/PhpParser/NodeVisitor/UseStmt/UseStmtCollector.php b/src/PhpParser/NodeVisitor/UseStmt/UseStmtCollector.php
@@ -12,17 +12,19 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor\UseStmt;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt;
 
-use Humbug\PhpScoper\NodeVisitor\Collection\NamespaceStmtCollection;
-use Humbug\PhpScoper\NodeVisitor\Collection\UseStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\NamespaceStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\UseStmtCollection;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Use_;
 use PhpParser\NodeVisitorAbstract;
 
 /**
  * Collects all the use statements. This allows us to resolve a class/constant/function call into a fully-qualified
  * call.
+ *
+ * @private
  */
 final class UseStmtCollector extends NodeVisitorAbstract
 {
diff --git a/src/PhpParser/NodeVisitor/UseStmt/UseStmtPrefixer.php b/src/PhpParser/NodeVisitor/UseStmt/UseStmtPrefixer.php
@@ -12,9 +12,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor\UseStmt;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt;
 
-use Humbug\PhpScoper\NodeVisitor\AppendParentNode;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AppendParentNode;
 use Humbug\PhpScoper\Reflector;
 use PhpParser\Node;
 use PhpParser\Node\Name;
@@ -24,6 +24,8 @@
 
 /**
  * Prefixes the use statements.
+ *
+ * @private
  */
 final class UseStmtPrefixer extends NodeVisitorAbstract
 {
diff --git a/src/PhpParser/NodeVisitor/WhitelistedClassAppender.php b/src/PhpParser/NodeVisitor/WhitelistedClassAppender.php
@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use PhpParser\Node;
 use PhpParser\Node\Arg;
@@ -48,6 +48,8 @@
  *
  * class_alias('Humbug\A\Foo', 'A\Foo', false);
  * ```
+ *
+ * @internal
  */
 final class WhitelistedClassAppender extends NodeVisitorAbstract
 {
diff --git a/src/PhpParser/TraverserFactory.php b/src/PhpParser/TraverserFactory.php
@@ -12,42 +12,26 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\Scoper;
+namespace Humbug\PhpScoper\PhpParser;
 
-use Humbug\PhpScoper\NodeTraverser;
-use Humbug\PhpScoper\NodeVisitor;
-use Humbug\PhpScoper\NodeVisitor\Collection\NamespaceStmtCollection;
-use Humbug\PhpScoper\NodeVisitor\Collection\UseStmtCollection;
-use Humbug\PhpScoper\NodeVisitor\Resolver\FullyQualifiedNameResolver;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\NamespaceStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Collection\UseStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\FullyQualifiedNameResolver;
 use Humbug\PhpScoper\Reflector;
 use PhpParser\NodeTraverserInterface;
 
 /**
- * @final
+ * @private
  */
 class TraverserFactory
 {
-    /**
-     * Functions for which the arguments will be prefixed.
-     */
-    public const WHITELISTED_FUNCTIONS = [
-        'class_exists',
-        'interface_exists',
-    ];
-
     private $reflector;
 
     public function __construct(Reflector $reflector)
     {
         $this->reflector = $reflector;
     }
 
-    /**
-     * @param string   $prefix    Prefix to apply to the files.
-     * @param string[] $whitelist List of classes to exclude from the scoping.
-     *
-     * @return NodeTraverserInterface
-     */
     public function create(string $prefix, array $whitelist): NodeTraverserInterface
     {
         $traverser = new NodeTraverser($prefix);
@@ -65,7 +49,7 @@ public function create(string $prefix, array $whitelist): NodeTraverserInterface
         $traverser->addVisitor(new NodeVisitor\UseStmt\UseStmtPrefixer($prefix, $this->reflector));
 
         $traverser->addVisitor(new NodeVisitor\NameStmtPrefixer($prefix, $nameResolver, $this->reflector));
-        $traverser->addVisitor(new NodeVisitor\StringScalarPrefixer($prefix, self::WHITELISTED_FUNCTIONS, $whitelist, $this->reflector));
+        $traverser->addVisitor(new NodeVisitor\StringScalarPrefixer($prefix, $this->reflector));
 
         $traverser->addVisitor(new NodeVisitor\WhitelistedClassAppender($whitelist));
 
diff --git a/src/Scoper/PhpScoper.php b/src/Scoper/PhpScoper.php
diff --git a/src/functions.php b/src/functions.php
diff --git a/tests/PhpParser/TraverserFactoryTest.php b/tests/PhpParser/TraverserFactoryTest.php
diff --git a/tests/Scoper/PhpScoperTest.php b/tests/Scoper/PhpScoperTest.php
diff --git a/vendor-bin/covers-validator/composer.json b/vendor-bin/covers-validator/composer.json
diff --git a/vendor-bin/covers-validator/composer.lock b/vendor-bin/covers-validator/composer.lock
