Skip to content

Repair PhpParser\Node\Stmt\Class_::isAnonymous() #3343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 23, 2024
Merged

Repair PhpParser\Node\Stmt\Class_::isAnonymous() #3343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8a841b
Repair PhpParser\Node\Stmt\Class_::isAnonymous()
tscni Aug 22, 2024
60afe71
Resolve backward compatibility issues with sub nodes
tscni Aug 22, 2024
c8c5359
Keep anonymousClass attribute for backward compatibility
tscni Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/Analyser/NodeScopeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@
use PHPStan\Node\UnreachableStatementNode;
use PHPStan\Node\VariableAssignNode;
use PHPStan\Node\VarTagChangedExpressionTypeNode;
use PHPStan\Parser\AnonymousClassVisitor;
use PHPStan\Parser\ArrowFunctionArgVisitor;
use PHPStan\Parser\ClosureArgVisitor;
use PHPStan\Parser\Parser;
Expand Down Expand Up @@ -856,7 +855,7 @@ private function processStmtNode(
if ($stmt->name === null) {
throw new ShouldNotHappenException();
}
if ($stmt->getAttribute(AnonymousClassVisitor::ATTRIBUTE_ANONYMOUS_CLASS, false) === false) {
if (!$stmt->isAnonymous()) {
$classReflection = $this->reflectionProvider->getClass($stmt->name->toString());
} else {
$classReflection = $this->reflectionProvider->getAnonymousClassReflection($stmt, $scope);
Expand Down
32 changes: 32 additions & 0 deletions src/Node/AnonymousClassNode.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php declare(strict_types = 1);

namespace PHPStan\Node;

use PhpParser\Node\Stmt\Class_;

/**
* The only purpose of this is to fix {@see Class_::isAnonymous()}, broken by us giving anonymous classes a name.
*/
final class AnonymousClassNode extends Class_
{

public static function createFromClassNode(Class_ $node): self
{
$subNodes = [];
foreach ($node->getSubNodeNames() as $subNodeName) {
$subNodes[$subNodeName] = $node->$subNodeName;
}

return new AnonymousClassNode(
$node->name,
$subNodes,
$node->getAttributes(),
);
}

public function isAnonymous(): bool
{
return true;
}

}
9 changes: 5 additions & 4 deletions src/Parser/AnonymousClassVisitor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
use PHPStan\Node\AnonymousClassNode;
use function count;

class AnonymousClassVisitor extends NodeVisitorAbstract
{

public const ATTRIBUTE_ANONYMOUS_CLASS = 'anonymousClass';
public const ATTRIBUTE_LINE_INDEX = 'anonymousClassLineIndex';

/** @var array<int, non-empty-list<Node\Stmt\Class_>> */
/** @var array<int, non-empty-list<AnonymousClassNode>> */
private array $nodesPerLine = [];

public function beforeTraverse(array $nodes): ?array
Expand All @@ -27,10 +27,11 @@ public function enterNode(Node $node): ?Node
return null;
}

$node->setAttribute(self::ATTRIBUTE_ANONYMOUS_CLASS, true);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory this isn't covered by the backward compatibility promise, right?
Even so, the removal of this would cause some breakages (see e.g. mglaman/phpstan-drupal#195)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the attribute but don't use it ourselves anywhere anymore.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I opted against keeping the constant since it's not meant to be reused.

$node = AnonymousClassNode::createFromClassNode($node);
$node->setAttribute('anonymousClass', true); // We keep this for backward compatibility
$this->nodesPerLine[$node->getStartLine()][] = $node;

return null;
return $node;
}

public function afterTraverse(array $nodes): ?array
Expand Down
5 changes: 2 additions & 3 deletions src/Type/FileTypeMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
use PHPStan\BetterReflection\Util\GetLastDocComment;
use PHPStan\Broker\AnonymousClassNameHelper;
use PHPStan\File\FileHelper;
use PHPStan\Parser\AnonymousClassVisitor;
use PHPStan\Parser\Parser;
use PHPStan\PhpDoc\PhpDocNodeResolver;
use PHPStan\PhpDoc\PhpDocStringResolver;
Expand Down Expand Up @@ -261,7 +260,7 @@ function (Node $node) use ($fileName, $lookForTrait, &$traitFound, $traitMethodA
}

$className = $this->anonymousClassNameHelper->getAnonymousClassName($node, $fileName);
} elseif ((bool) $node->getAttribute(AnonymousClassVisitor::ATTRIBUTE_ANONYMOUS_CLASS, false)) {
} elseif ($node instanceof Node\Stmt\Class_ && $node->isAnonymous()) {
$className = $node->name->name;
} else {
if ($traitFound) {
Expand Down Expand Up @@ -452,7 +451,7 @@ function (Node $node) use ($fileName, $lookForTrait, $phpDocNodeMap, &$traitFoun
}

$className = $this->anonymousClassNameHelper->getAnonymousClassName($node, $fileName);
} elseif ((bool) $node->getAttribute(AnonymousClassVisitor::ATTRIBUTE_ANONYMOUS_CLASS, false)) {
} elseif ($node instanceof Node\Stmt\Class_ && $node->isAnonymous()) {
$className = $node->name->name;
} else {
if ($traitFound) {
Expand Down
6 changes: 4 additions & 2 deletions tests/PHPStan/Reflection/AnonymousClassReflectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Analyser\Scope;
use PHPStan\Parser\AnonymousClassVisitor;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Testing\RuleTestCase;
use PHPUnit\Framework\Assert;
use function implode;
use function sprintf;

Expand Down Expand Up @@ -36,10 +36,12 @@ public function getNodeType(): string

public function processNode(Node $node, Scope $scope): array
{
if (!(bool) $node->getAttribute(AnonymousClassVisitor::ATTRIBUTE_ANONYMOUS_CLASS)) {
if (!$node->isAnonymous()) {
return [];
}

Assert::assertTrue($node->getAttribute('anonymousClass'));

$classReflection = $this->reflectionProvider->getAnonymousClassReflection($node, $scope);

return [
Expand Down
Loading