Add missing emta

Author: theofidry

specs/class/conditional.php

@@ -64,9 +64,9 @@ class A
 }
 
 PHP
-    ,
+    ],
 
-    'Declaration in a namespace: prefix each namespace' => <<<'PHP'
+    'Declaration in a namespace' => <<<'PHP'
 <?php
 
 namespace Foo;
@@ -86,7 +86,7 @@ class A
 }
 
 PHP
-    ],
+    ,
 
     'Declaration of a whitelisted class' => [
         'whitelist' => ['Foo\A'],
@@ -110,7 +110,7 @@ class A
 }
 
 PHP
-        ],
+    ],
 
     'Multiple declarations in different namespaces' => <<<'PHP'
 <?php

specs/func-declaration/global.php

@@ -92,6 +92,9 @@ function foo()
 
     'Function declaration in the global namespace' => [
         'whitelist' => ['X\Y', 'BAR_CONST'],
+        'registered-functions' => [
+            ['foo', 'Humbug\foo'],
+        ],
         'payload' => <<<'PHP'
 <?php
 
@@ -156,6 +159,9 @@ function foo(\Humbug\Foo $arg0, \Humbug\Foo $arg1, \Humbug\Foo\Bar $arg2, \Humbu
 
     'Function declaration in the global namespace with globally whitelisted constants' => [
         'whitelist-global-constants' => true,
+        'registered-functions' => [
+            ['foo', 'Humbug\foo'],
+        ],
         'payload' => <<<'PHP'
 <?php
 
@@ -174,6 +180,9 @@ function foo(string $foo = \FOO_CONST)
 
     'Function declaration in the global namespace with use statements' => [
         'whitelist' => ['X\Y'],
+        'registered-functions' => [
+            ['foo', 'Humbug\foo'],
+        ],
         'payload' => <<<'PHP'
 <?php
 
@@ -259,6 +268,9 @@ function foo(string $arg0, ?string $arg1, ?string $arg2 = null, \Humbug\Foo $arg
 
     'Function declarations with return types in the global namespace with use statements' => [
         'whitelist' => ['X\Y'],
+        'registered-functions' => [
+            ['foo', 'Humbug\foo'],
+        ],
         'payload' => <<<'PHP'
 <?php
 

specs/func-declaration/namespace.php

@@ -45,6 +45,9 @@ function foo()
 
     'Simple whitelisted function' => [
         'whitelist' => ['Acme\foo'],
+        'registered-functions' => [
+            ['Acme\foo', 'Humbug\Acme\foo'],
+        ],
         'payload' => <<<'PHP'
 <?php
 
@@ -61,26 +64,6 @@ function foo()
 {
 }
 
-PHP
-    ],
-
-    'Simple whitelisted function with global functions non whitelisted' => [
-        'whitelist-global-functions' => false,
-        'whitelist' => ['foo'],
-        'payload' => <<<'PHP'
-<?php
-
-function foo() {}
-
-----
-<?php
-
-namespace Humbug;
-
-function foo()
-{
-}
-
 PHP
     ],
 

specs/function/global-scope-single-part-namespaced-func-with-single-level-use.php

@@ -70,6 +70,9 @@ class Foo
 
     'Whitelisted namespaced function call imported with a partial use statement in the global scope' => [
         'whitelist' => ['Foo\main'],
+        'registered-functions' => [
+            ['Foo\main', 'Humbug\Foo\main'],
+        ],
         'payload' => <<<'PHP'
 <?php
 

src/PhpParser/Node/NamedIdentifier.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Humbug\PhpScoper\PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Name;
+
+/**
+ * Small wrapper to treat an identifier as a name node.
+ */
+final class NamedIdentifier extends Name
+{
+    private $originalNode;
+
+    public static function create(Identifier $node): self
+    {
+        $instance = new self($node->name, $node->getAttributes());
+        $instance->originalNode = $node;
+
+        return $instance;
+    }
+
+    public function getOriginalNode(): Identifier
+    {
+        return $this->originalNode;
+    }
+}

src/PhpParser/NodeVisitor/Collection/UseStmtCollection.php

@@ -15,12 +15,16 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Collection;
 
 use ArrayIterator;
+use function count;
+use Humbug\PhpScoper\PhpParser\Node\NamedIdentifier;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
 use IteratorAggregate;
+use PhpParser\Node;
 use PhpParser\Node\Expr\ConstFetch;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\ClassLike;
+use PhpParser\Node\Stmt\Function_;
 use PhpParser\Node\Stmt\Use_;
 use PhpParser\Node\Stmt\UseUse;
 use function Humbug\PhpScoper\clone_node;
@@ -68,8 +72,8 @@ public function findStatementForNode(?Name $namespaceName, Name $node): ?Name
         $parentNode = ParentNodeAppender::findParent($node);
 
         if ($parentNode instanceof ClassLike
-            && $node->hasAttribute('original_node')
-            && $node->getAttribute('original_node') === $parentNode->name
+            && $node instanceof NamedIdentifier
+            && $node->getOriginalNode() === $parentNode->name
         ) {
             // The current node can either be the class like name or one of its elements, e.g. extends or implements.
             // In the first case, the node was original an Identifier.
@@ -86,7 +90,7 @@ public function findStatementForNode(?Name $namespaceName, Name $node): ?Name
                 }
 
                 if ($name === $useStatement->getAlias()->toLowerString()) {
-                    if ($parentNode instanceof FuncCall && 1 === count($node->parts)) {
+                    if ($this->isFunctionName($node, $parentNode)) {
                         if (Use_::TYPE_FUNCTION === $use_->type) {
                             return $useStatement->name;
                         }
@@ -122,4 +126,22 @@ public function getIterator(): iterable
     {
         return new ArrayIterator($this->nodes);
     }
+
+    private function isFunctionName(Name $node, ?Node $parentNode): bool
+    {
+        if (null === $parentNode || 1 !== count($node->parts)) {
+            return false;
+        }
+
+        if ($parentNode instanceof FuncCall) {
+            return true;
+        }
+
+        if (false === ($parentNode instanceof Function_)) {
+            return false;
+        }
+        /** @var Function_ $parentNode */
+
+        return $node instanceof NamedIdentifier && $node->getOriginalNode() === $parentNode->name;
+    }
 }

src/PhpParser/NodeVisitor/FunctionIdentifierRecorder.php

@@ -54,7 +54,7 @@ public function enterNode(Node $node): Node
 
         $parent = ParentNodeAppender::getParent($node);
 
-        if (false === ($parent instanceof Function_)) {
+        if (false === ($parent instanceof Function_) || $node === $parent->returnType) {
             return $node;
         }
 

src/PhpParser/NodeVisitor/Resolver/FullyQualifiedNameResolver.php

@@ -14,6 +14,7 @@
 
 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\NameStmtPrefixer;
@@ -53,10 +54,7 @@ public function resolveName(Node $node): ResolvedValue
         }
 
         if ($node instanceof Identifier) {
-            $attributes = $node->getAttributes();
-            $attributes['original_node'] = $node;
-
-            $node = new Name($node->name, $attributes);
+            $node = NamedIdentifier::create($node);
         }
 
         $namespaceName = $this->namespaceStatements->findNamespaceForNode($node);

tests/Scoper/PhpScoperSpecTest.php

@@ -14,6 +14,8 @@
 
 namespace Humbug\PhpScoper\Scoper;
 
+use function array_diff;
+use function array_keys;
 use function array_map;
 use function current;
 use Generator;
@@ -22,6 +24,7 @@
 use Humbug\PhpScoper\Reflector;
 use Humbug\PhpScoper\Scoper;
 use Humbug\PhpScoper\Whitelist;
+use function is_array;
 use LogicException;
 use const PHP_EOL;
 use PhpParser\Error as PhpParserError;
@@ -50,6 +53,26 @@ class PhpScoperSpecTest extends TestCase
     private const SPECS_PATH = __DIR__.'/../../specs';
     private const SECONDARY_SPECS_PATH = __DIR__.'/../../_specs';
 
+    private const SPECS_META_KEYS = [
+        'title',
+        'prefix',
+        'whitelist',
+        'whitelist-global-constants',
+        'whitelist-global-functions',
+        'registered-classes',
+        'registered-functions',
+    ];
+
+    private const SPECS_SPEC_KEYS = [
+        'prefix',
+        'whitelist',
+        'whitelist-global-constants',
+        'whitelist-global-functions',
+        'registered-classes',
+        'registered-functions',
+        'payload',
+    ];
+
     /**
      * This test is to ensure no file is left in _specs for the CI. It is fine otherwise for this test to fail locally
      * when developing something.
@@ -196,6 +219,32 @@ private function parseSpecFile(array $meta, $fixtureTitle, $fixtureSet): Generat
 
         $payloadParts = preg_split("/\n----(?:\n|$)/", $payload);
 
+        $this->assertSame(
+            [],
+            $diff = array_diff(
+                array_keys($meta),
+                self::SPECS_META_KEYS
+            ),
+            sprintf(
+                'Expected the keys found in the meta section to be known keys, unknown keys: "%s"',
+                implode('", "', $diff)
+            )
+        );
+
+        if (is_array($fixtureSet)) {
+            $this->assertSame(
+                [],
+                $diff = array_diff(
+                    array_keys($fixtureSet),
+                    self::SPECS_SPEC_KEYS
+                ),
+                sprintf(
+                    'Expected the keys found in the spec section to be known keys, unknown keys: "%s"',
+                    implode('", "', $diff)
+                )
+            );
+        }
+
         yield [
             $spec,
             $payloadParts[0],   // Input