Skip to content

Write class names added by fixes relative to namespace and uses #6924

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
ondrejmirtes merged 1 commit into from
Nov 3, 2026
Merged

Write class names added by fixes relative to namespace and uses #6924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 0 deletions conf/config.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,9 @@ parameters:
errorFormat: null
sysGetTempDir: ::sys_get_temp_dir()
sourceLocatorPlaygroundMode: false
fixer:
importNames: true
preferSelf: false
pro:
dnsServers:
- '1.1.1.2'
Expand Down
4 changes: 4 additions & 0 deletions conf/parametersSchema.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,10 @@ parametersSchema:
editorUrl: schema(string(), nullable())
editorUrlTitle: schema(string(), nullable())
errorFormat: schema(string(), nullable())
fixer: structure([
importNames: bool(),
preferSelf: bool()
])
pro: structure([
dnsServers: schema(listOf(string()), min(1)),
tmpDir: string()
Expand Down
14 changes: 14 additions & 0 deletions src/Analyser/RuleErrorTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,19 @@

namespace PHPStan\Analyser;

use PhpParser\ErrorHandler\Collecting;
use PhpParser\Internal\TokenStream;
use PhpParser\Node;
use PhpParser\Node\Stmt;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\CloningVisitor;
use PhpParser\NodeVisitor\NameResolver;
use PhpParser\Parser;
use PhpParser\Token;
use PHPStan\DependencyInjection\AutowiredParameter;
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\File\FileReader;
use PHPStan\Fixable\NewClassNamesVisitor;
use PHPStan\Fixable\PhpPrinter;
use PHPStan\Fixable\PhpPrinterIndentationDetectorVisitor;
use PHPStan\Fixable\ReplacingNodeVisitor;
Expand Down Expand Up @@ -68,6 +71,10 @@ public function __construct(
private Parser $parser,
#[AutowiredParameter(ref: '@defaultAnalysisParser')]
private AnalysisParser $analysisParser,
#[AutowiredParameter(ref: '%fixer.importNames%')]
private bool $importNames,
#[AutowiredParameter(ref: '%fixer.preferSelf%')]
private bool $preferSelf,
)
{
$this->diffOutputBuilder = new UnifiedDiffOutputBuilder('', addLineNumbers: true);
Expand Down Expand Up @@ -239,6 +246,13 @@ private function fix(string $fixingFile, array $fileNodes, array $fixes): ?Fixed
return null;
}

$nameResolver = new NameResolver(new Collecting(), ['replaceNodes' => false]);
/** @var Stmt[] $newStmts */
$newStmts = (new NodeTraverser(
$nameResolver,
new NewClassNamesVisitor($nameResolver->getNameContext(), $this->importNames, $this->preferSelf),
))->traverse($newStmts);

$newCode = $this->getPrinter($indent)->printFormatPreserving($newStmts, $fileNodes, $parsedFile['tokens']);
if ($parsedFile['code'] === $newCode) {
return null;
Expand Down
120 changes: 0 additions & 120 deletions src/Command/Neon2Attributes/ImportScope.php
View file
Open in desktop

This file was deleted.

84 changes: 30 additions & 54 deletions src/Command/Neon2Attributes/PhpClassAttributesWriter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@

namespace PHPStan\Command\Neon2Attributes;

use PhpParser\ErrorHandler\Collecting;
use PhpParser\Internal\TokenStream;
use PhpParser\Node;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\CloningVisitor;
use PhpParser\NodeVisitor\NameResolver;
use PhpParser\ParserFactory;
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\File\FileReader;
use PHPStan\Fixable\NewClassNamesVisitor;
use PHPStan\Fixable\PhpPrinter;
use PHPStan\Fixable\PhpPrinterIndentationDetectorVisitor;
use PHPStan\ShouldNotHappenException;
use function array_is_list;
use function array_key_exists;
use function count;
use function is_array;
use function is_bool;
Expand All @@ -24,9 +26,6 @@
use function str_contains;
use function str_repeat;
use function strcasecmp;
use function strrpos;
use function strtolower;
use function substr;

/**
* Adds attributes to classes and their constructor parameters, keeping the rest of the file as it was.
Expand Down Expand Up @@ -62,28 +61,35 @@ public function write(string $file, array $edits): string
$this->addAttributes($file, $newStmts, $edit);
}

$nameResolver = new NameResolver(new Collecting(), ['replaceNodes' => false]);
/** @var list<Node\Stmt> $newStmts */
$newStmts = (new NodeTraverser(
$nameResolver,
new NewClassNamesVisitor($nameResolver->getNameContext(), importNames: true, preferSelf: false),
))->traverse($newStmts);

return (new AttributesPrinter(['indent' => $indent]))->printFormatPreserving($newStmts, $oldStmts, $tokens);
}

/**
* @param list<Node\Stmt> $stmts
*/
private function addAttributes(string $file, array &$stmts, ClassAttributes $edit): void
private function addAttributes(string $file, array $stmts, ClassAttributes $edit): void
{
$className = $edit->reflection->getName();
$namespace = $edit->reflection->getNamespaceName();
$shortName = $edit->reflection->getShortName();

if ($namespace === '') {
$this->addAttributesInScope($stmts, '', $shortName, $edit);
$this->addAttributesInScope($stmts, $shortName, $edit);
return;
}

foreach ($stmts as $stmt) {
if (!$stmt instanceof Node\Stmt\Namespace_ || $stmt->name === null || strcasecmp($stmt->name->toString(), $namespace) !== 0) {
continue;
}
if ($this->addAttributesInScope($stmt->stmts, $namespace, $shortName, $edit)) {
if ($this->addAttributesInScope($stmt->stmts, $shortName, $edit)) {
return;
}
}
Expand All @@ -94,7 +100,7 @@ private function addAttributes(string $file, array &$stmts, ClassAttributes $edi
/**
* @param list<Node\Stmt> $stmts statements of a namespace, or of a file without one
*/
private function addAttributesInScope(array &$stmts, string $namespace, string $shortName, ClassAttributes $edit): bool
private function addAttributesInScope(array $stmts, string $shortName, ClassAttributes $edit): bool
{
$class = null;
foreach ($stmts as $stmt) {
Expand All @@ -109,8 +115,7 @@ private function addAttributesInScope(array &$stmts, string $namespace, string $
return false;
}

$scope = new ImportScope($namespace, $stmts);
$class->attrGroups[] = new Node\AttributeGroup([$this->createAttribute($scope, $edit->attribute)]);
$class->attrGroups[] = new Node\AttributeGroup([$this->createAttribute($edit->attribute)]);

$constructor = $class->getMethod('__construct');
$isOneLine = $constructor !== null
Expand All @@ -125,41 +130,44 @@ private function addAttributesInScope(array &$stmts, string $namespace, string $
continue;
}

$param->attrGroups[] = new Node\AttributeGroup([$this->createAttribute($scope, $attribute)]);
$param->attrGroups[] = new Node\AttributeGroup([$this->createAttribute($attribute)]);
$param->setAttribute(AttributesPrinter::INLINE_ATTRIBUTES, $isOneLine);
}
}

$stmts = $scope->stmts;

return true;
}

private function createAttribute(ImportScope $scope, AttributeSpec $attribute): Node\Attribute
private function createAttribute(AttributeSpec $attribute): Node\Attribute
{
return new Node\Attribute($this->createName($scope, self::DI_NAMESPACE . $attribute->name), $this->createArgs($scope, $attribute));
return new Node\Attribute(new Node\Name\FullyQualified(self::DI_NAMESPACE . $attribute->name), $this->createArgs($attribute));
}

/**
* @return list<Node\Arg>
*/
private function createArgs(ImportScope $scope, AttributeSpec $attribute): array
private function createArgs(AttributeSpec $attribute): array
{
$args = [];
foreach ($attribute->arguments as $name => $value) {
$args[] = new Node\Arg($this->createExpr($scope, $value), name: new Node\Identifier($name));
$args[] = new Node\Arg($this->createExpr($value), name: new Node\Identifier($name));
}

return $args;
}

private function createExpr(ImportScope $scope, mixed $value): Node\Expr
private function createExpr(mixed $value): Node\Expr
{
if ($value instanceof AttributeSpec) {
return new Node\Expr\New_($this->createName($scope, self::DI_NAMESPACE . $value->name), $this->createArgs($scope, $value));
return new Node\Expr\New_(new Node\Name\FullyQualified(self::DI_NAMESPACE . $value->name), $this->createArgs($value));
}
if ($value instanceof ClassReference) {
return new Node\Expr\ClassConstFetch($this->createName($scope, $value->className), 'class');
$className = ltrim($value->className, '\\');
if ($className === '') {
throw new ShouldNotHappenException('Empty class name.');
}

return new Node\Expr\ClassConstFetch(new Node\Name\FullyQualified($className), 'class');
}
if (is_string($value)) {
return new Node\Scalar\String_($value);
Expand All @@ -175,8 +183,8 @@ private function createExpr(ImportScope $scope, mixed $value): Node\Expr
$isList = array_is_list($value);
foreach ($value as $key => $item) {
$items[] = new Node\ArrayItem(
$this->createExpr($scope, $item),
$isList ? null : $this->createExpr($scope, $key),
$this->createExpr($item),
$isList ? null : $this->createExpr($key),
);
}

Expand All @@ -186,36 +194,4 @@ private function createExpr(ImportScope $scope, mixed $value): Node\Expr
throw new ShouldNotHappenException();
}

/**
* Uses the short name and adds a use statement unless the short name already means another class in the file.
*/
private function createName(ImportScope $scope, string $className): Node\Name
{
$className = ltrim($className, '\\');
$position = strrpos($className, '\\');
$shortName = $position === false ? $className : substr($className, $position + 1);
if ($className === '' || $shortName === '') {
throw new ShouldNotHappenException(sprintf('Invalid class name %s.', $className));
}
$lowerShortName = strtolower($shortName);

if (array_key_exists($lowerShortName, $scope->uses)) {
return strcasecmp($scope->uses[$lowerShortName], $className) === 0
? new Node\Name($shortName)
: new Node\Name\FullyQualified($className);
}

$localName = $scope->namespace === '' ? $shortName : $scope->namespace . '\\' . $shortName;
if (strcasecmp($localName, $className) === 0) {
return new Node\Name($shortName);
}
if (array_key_exists($lowerShortName, $scope->unqualifiedNames)) {
return new Node\Name\FullyQualified($className);
}

$scope->addUse($className, $lowerShortName);

return new Node\Name($shortName);
}

}
Loading
Loading