diff --git a/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/remove_param_and_return_mixed.php.inc b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/remove_param_and_return_mixed.php.inc new file mode 100644 index 00000000000..ebbe481c7f2 --- /dev/null +++ b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/remove_param_and_return_mixed.php.inc @@ -0,0 +1,31 @@ + +----- + diff --git a/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/remove_param_mixed.php.inc b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/remove_param_mixed.php.inc new file mode 100644 index 00000000000..e44c259ccab --- /dev/null +++ b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/remove_param_mixed.php.inc @@ -0,0 +1,28 @@ + +----- + diff --git a/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/skip_param_no_native_type.php.inc b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/skip_param_no_native_type.php.inc new file mode 100644 index 00000000000..71033417bf3 --- /dev/null +++ b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/Fixture/skip_param_no_native_type.php.inc @@ -0,0 +1,13 @@ +doTestFile($filePath); + } + + public static function provideData(): Iterator + { + return self::yieldFilesFromDirectory(__DIR__ . '/Fixture'); + } + + public function provideConfigFilePath(): string + { + return __DIR__ . '/config/configured_rule.php'; + } +} diff --git a/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/config/configured_rule.php b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/config/configured_rule.php new file mode 100644 index 00000000000..abba6691ade --- /dev/null +++ b/rules-tests/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector/config/configured_rule.php @@ -0,0 +1,9 @@ +withRules([RemoveMixedDocblockOverruledByNativeTypeRector::class]); diff --git a/rules/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector.php b/rules/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector.php new file mode 100644 index 00000000000..dfe79ebd2d4 --- /dev/null +++ b/rules/DeadCode/Rector/ClassMethod/RemoveMixedDocblockOverruledByNativeTypeRector.php @@ -0,0 +1,215 @@ +> + */ + public function getNodeTypes(): array + { + return [ClassMethod::class, Function_::class]; + } + + /** + * @param ClassMethod|Function_ $node + */ + public function refactor(Node $node): ?Node + { + // skip as no comments + if ($node->getComments() === []) { + return null; + } + + $phpDocInfo = $this->phpDocInfoFactory->createFromNode($node); + if (! $phpDocInfo instanceof PhpDocInfo) { + return null; + } + + $hasChanged = $this->removeMixedParamTags($phpDocInfo, $node); + $hasChanged = $this->removeMixedReturnTag($phpDocInfo, $node) || $hasChanged; + + if (! $hasChanged) { + return null; + } + + $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node); + + return $node; + } + + /** + * @param ClassMethod|Function_ $functionLike + */ + private function removeMixedParamTags(PhpDocInfo $phpDocInfo, Node $functionLike): bool + { + $declaredParamNames = $this->resolveDeclaredParamNames($functionLike); + if ($declaredParamNames === []) { + return false; + } + + $hasChanged = false; + + $phpDocNodeTraverser = new PhpDocNodeTraverser(); + $phpDocNodeTraverser->traverseWithCallable($phpDocInfo->getPhpDocNode(), '', function (PhpDocNode $phpDocNode) use ( + $declaredParamNames, + &$hasChanged + ): ?int { + if (! $phpDocNode instanceof PhpDocTagNode) { + return null; + } + + if ($phpDocNode->name !== '@param') { + return null; + } + + if (! $phpDocNode->value instanceof ParamTagValueNode) { + return null; + } + + $paramTagValueNode = $phpDocNode->value; + + // keep description, it is the only useful info on a mixed param + if ($paramTagValueNode->description !== '') { + return null; + } + + if (! $this->isMixedType($paramTagValueNode->type)) { + return null; + } + + $parameterName = ltrim($paramTagValueNode->parameterName, '$'); + if (! in_array($parameterName, $declaredParamNames, true)) { + return null; + } + + $hasChanged = true; + return PhpDocNodeTraverser::NODE_REMOVE; + }); + + return $hasChanged; + } + + /** + * @param ClassMethod|Function_ $functionLike + */ + private function removeMixedReturnTag(PhpDocInfo $phpDocInfo, Node $functionLike): bool + { + if ($functionLike->returnType === null) { + return false; + } + + $returnTagValueNode = $phpDocInfo->getReturnTagValue(); + if (! $returnTagValueNode instanceof ReturnTagValueNode) { + return false; + } + + if ($returnTagValueNode->description !== '') { + return false; + } + + if (! $this->isMixedType($returnTagValueNode->type)) { + return false; + } + + return $phpDocInfo->removeByType(ReturnTagValueNode::class); + } + + /** + * @param ClassMethod|Function_ $functionLike + * @return string[] + */ + private function resolveDeclaredParamNames(Node $functionLike): array + { + $declaredParamNames = []; + foreach ($functionLike->params as $param) { + if (! $param instanceof Param) { + continue; + } + + if (! $param->type instanceof Node) { + continue; + } + + if (! $param->var instanceof Variable) { + continue; + } + + if (! is_string($param->var->name)) { + continue; + } + + $declaredParamNames[] = $param->var->name; + } + + return $declaredParamNames; + } + + private function isMixedType(TypeNode $typeNode): bool + { + return $typeNode instanceof IdentifierTypeNode && $typeNode->name === 'mixed'; + } +} diff --git a/src/Config/Level/DeadCodeLevel.php b/src/Config/Level/DeadCodeLevel.php index 3422b0d49e6..dd68b6c251a 100644 --- a/src/Config/Level/DeadCodeLevel.php +++ b/src/Config/Level/DeadCodeLevel.php @@ -17,6 +17,7 @@ use Rector\DeadCode\Rector\ClassMethod\RemoveArgumentFromDefaultParentCallRector; use Rector\DeadCode\Rector\ClassMethod\RemoveDuplicatedReturnSelfDocblockRector; use Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector; +use Rector\DeadCode\Rector\ClassMethod\RemoveMixedDocblockOverruledByNativeTypeRector; use Rector\DeadCode\Rector\ClassMethod\RemoveNullTagValueNodeRector; use Rector\DeadCode\Rector\ClassMethod\RemoveParentDelegatingConstructorRector; use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector; @@ -118,6 +119,7 @@ final class DeadCodeLevel RemoveUselessParamTagRector::class, RemoveUselessReturnTagRector::class, RemoveDuplicatedReturnSelfDocblockRector::class, + RemoveMixedDocblockOverruledByNativeTypeRector::class, RemoveUselessReadOnlyTagRector::class, RemoveNonExistingVarAnnotationRector::class, RemoveUselessVarTagRector::class,