Skip to content

Commit

Permalink
[Naming] @param doc should follow variable renamed on RenamePropertyT…
Browse files Browse the repository at this point in the history
…oMatchTypeRector (#170)
  • Loading branch information
samsonasik committed Jun 8, 2021
1 parent ca8f75f commit bc84def
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

namespace Rector\Tests\Naming\Rector\Class_\RenamePropertyToMatchTypeRector\FixturePhp80;

use Rector\Core\NodeAnalyzer\ClassAnalyzer;

final class RenameParamDoc
{
/**
* @param ClassAnalyzer $analyzer
*/
public function __construct(
private ClassAnalyzer $analyzer
) {
}

public function getAnalyzer(): ClassAnalyzer
{
return $this->analyzer;
}
}

?>
-----
<?php

namespace Rector\Tests\Naming\Rector\Class_\RenamePropertyToMatchTypeRector\FixturePhp80;

use Rector\Core\NodeAnalyzer\ClassAnalyzer;

final class RenameParamDoc
{
/**
* @param ClassAnalyzer $classAnalyzer
*/
public function __construct(
private ClassAnalyzer $classAnalyzer
) {
}

public function getAnalyzer(): ClassAnalyzer
{
return $this->classAnalyzer;
}
}

?>
47 changes: 42 additions & 5 deletions rules/Naming/Rector/Class_/RenamePropertyToMatchTypeRector.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,19 @@
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Interface_;
use PhpParser\Node\Stmt\Property;
use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\MethodName;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\Naming\ExpectedNameResolver\MatchParamTypeExpectedNameResolver;
use Rector\Naming\ExpectedNameResolver\MatchPropertyTypeExpectedNameResolver;
use Rector\Naming\ParamRenamer\ParamRenamer;
use Rector\Naming\PropertyRenamer\MatchTypePropertyRenamer;
use Rector\Naming\PropertyRenamer\PropertyFetchRenamer;
use Rector\Naming\ValueObject\ParamRename;
use Rector\Naming\ValueObject\PropertyRename;
use Rector\Naming\ValueObjectFactory\ParamRenameFactory;
use Rector\Naming\ValueObjectFactory\PropertyRenameFactory;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
Expand All @@ -35,7 +40,9 @@ public function __construct(
private PropertyRenameFactory $propertyRenameFactory,
private MatchPropertyTypeExpectedNameResolver $matchPropertyTypeExpectedNameResolver,
private MatchParamTypeExpectedNameResolver $matchParamTypeExpectedNameResolver,
private PropertyFetchRenamer $propertyFetchRenamer
private PropertyFetchRenamer $propertyFetchRenamer,
private ParamRenameFactory $paramRenameFactory,
private ParamRenamer $paramRenamer
) {
}

Expand Down Expand Up @@ -154,16 +161,21 @@ private function renamePropertyPromotion(ClassLike $classLike): void
$desiredPropertyNames[$key] = $desiredPropertyName;
}

$this->renameParamVarName($classLike, $constructClassMethod->params, $desiredPropertyNames);
$this->renameParamVarName($classLike, $constructClassMethod, $desiredPropertyNames);
}

/**
* @param Param[] $params
* @param string[] $desiredPropertyNames
*/
private function renameParamVarName(ClassLike $classLike, array $params, array $desiredPropertyNames): void
{
private function renameParamVarName(
ClassLike $classLike,
ClassMethod $constructClassMethod,
array $desiredPropertyNames
): void {
$keys = array_keys($desiredPropertyNames);
$params = $constructClassMethod->params;
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($constructClassMethod);

foreach ($params as $key => $param) {
if (in_array($key, $keys, true)) {
$currentName = $this->getName($param);
Expand All @@ -173,8 +185,33 @@ private function renameParamVarName(ClassLike $classLike, array $params, array $
$currentName,
$desiredPropertyName
);

/** @var string $paramVarName */
$paramVarName = $param->var->name;
$this->renameParamDoc($phpDocInfo, $param, $paramVarName, $desiredPropertyName);
$param->var->name = $desiredPropertyName;
}
}
}

private function renameParamDoc(
PhpDocInfo $phpDocInfo,
Param $param,
string $paramVarName,
string $desiredPropertyName
): void
{
$paramTagValueNode = $phpDocInfo->getParamTagValueNodeByName($paramVarName);

if (! $paramTagValueNode instanceof ParamTagValueNode) {
return;
}

$paramRename = $this->paramRenameFactory->createFromResolvedExpectedName($param, $desiredPropertyName);
if (! $paramRename instanceof ParamRename) {
return;
}

$this->paramRenamer->rename($paramRename);
}
}

0 comments on commit bc84def

Please sign in to comment.