[Php80] Add MixedTypeRector (#2701)

* [Php80] Add MixedTypeRector

* fixture

* apply type param

* apply type param

* [ci-review] Rector Rectify

* fix type definition

* [ci-review] Rector Rectify

* identifier

* phpstan

* remove doc only mixed

* doc

* doc & Node

* register

* try check string or object type

* check virtual node

* fix

* update FileCache mixed as skipped in rector.php

* skip no mixed doc param

* [ci-review] Rector Rectify

* [ci-review] Rector Rectify

* [ci-review] Rector Rectify

* implemented with add MakeClassMethodParamMixedTypedGuard

* [ci-review] Rector Rectify

* [ci-review] Rector Rectify

* only make typed with use doc @param mixed

* rollback invalid change

* add fixture for override public method

* fixture for skip has pubilc child method

* rename fixture

* void return for paramTagRemover->removeParamTagsIfUseless()

* implemented check has child or parent method 🎉

* [ci-review] Rector Rectify

Co-authored-by: GitHub Action <action@github.com>

config/set/php80.php

@@ -19,6 +19,7 @@
 use Rector\Php80\Rector\FuncCall\ClassOnObjectRector;
 use Rector\Php80\Rector\FuncCall\Php8ResourceReturnToObjectRector;
 use Rector\Php80\Rector\FuncCall\TokenGetAllToObjectRector;
+use Rector\Php80\Rector\FunctionLike\MixedTypeRector;
 use Rector\Php80\Rector\FunctionLike\UnionTypesRector;
 use Rector\Php80\Rector\Identical\StrEndsWithRector;
 use Rector\Php80\Rector\Identical\StrStartsWithRector;
@@ -105,4 +106,5 @@
 
     $rectorConfig->rule(Php8ResourceReturnToObjectRector::class);
     $rectorConfig->rule(AddParamBasedOnParentClassMethodRector::class);
+    $rectorConfig->rule(MixedTypeRector::class);
 };

packages/BetterPhpDocParser/PhpDocManipulator/PhpDocTagRemover.php

@@ -40,7 +40,7 @@ public function removeTagValueFromNode(PhpDocInfo $phpDocInfo, Node $desiredNode
         $phpDocNode = $phpDocInfo->getPhpDocNode();
 
         $phpDocNodeTraverser = new PhpDocNodeTraverser();
-        $phpDocNodeTraverser->traverseWithCallable($phpDocNode, '', static function ($node) use (
+        $phpDocNodeTraverser->traverseWithCallable($phpDocNode, '', static function (Node $node) use (
             $desiredNode,
             $phpDocInfo
         ): ?int {

packages/BetterPhpDocParser/PhpDocNodeFinder/PhpDocNodeByTypeFinder.php

@@ -24,7 +24,7 @@ public function findByType(PhpDocNode $phpDocNode, string $desiredType): array
 
         $foundNodes = [];
 
-        $phpDocNodeTraverser->traverseWithCallable($phpDocNode, '', static function ($node) use (
+        $phpDocNodeTraverser->traverseWithCallable($phpDocNode, '', static function (Node $node) use (
             &$foundNodes,
             $desiredType
         ): Node {

packages/BetterPhpDocParser/ValueObject/PhpDoc/DoctrineAnnotation/AbstractValuesAwareNode.php

@@ -76,10 +76,7 @@ public function getValue(string | int $key)
         return $this->values[$key];
     }
 
-    /**
-     * @param mixed $value
-     */
-    public function changeValue(string $key, $value): void
+    public function changeValue(string $key, mixed $value): void
     {
         // is quoted?
         if (isset($this->values[$key]) && is_string($this->values[$key]) && StringUtils::isMatch(
@@ -108,10 +105,7 @@ public function getValueWithoutQuotes(string | int $key)
         return $this->removeQuotes($value);
     }
 
-    /**
-     * @param mixed $value
-     */
-    public function changeSilentValue($value): void
+    public function changeSilentValue(mixed $value): void
     {
         // is quoted?
         if (StringUtils::isMatch($this->values[0], self::UNQUOTED_VALUE_REGEX)) {
@@ -232,10 +226,7 @@ protected function printValuesContent(array $values): string
         return $itemContents;
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function stringifyValue($value): string
+    private function stringifyValue(mixed $value): string
     {
         // @todo resolve original casing
         if ($value === false) {

packages/BetterPhpDocParser/ValueObject/PhpDoc/DoctrineAnnotation/CurlyListNode.php

@@ -13,10 +13,7 @@ public function __toString(): string
         return $this->implode($this->values);
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function stringifyValue($value): string
+    private function stringifyValue(mixed $value): string
     {
         if ($value === false) {
             return 'false';

packages/Caching/Cache.php

@@ -21,10 +21,7 @@ public function load(string $key, string $variableKey)
         return $this->cacheStorage->load($key, $variableKey);
     }
 
-    /**
-     * @param mixed $data
-     */
-    public function save(string $key, string $variableKey, $data): void
+    public function save(string $key, string $variableKey, mixed $data): void
     {
         $this->cacheStorage->save($key, $variableKey, $data);
     }

packages/Caching/Contract/ValueObject/Storage/CacheStorageInterface.php

@@ -15,10 +15,7 @@ interface CacheStorageInterface
      */
     public function load(string $key, string $variableKey);
 
-    /**
-     * @param mixed $data
-     */
-    public function save(string $key, string $variableKey, $data): void;
+    public function save(string $key, string $variableKey, mixed $data): void;
 
     public function clean(string $key): void;
 

packages/Caching/ValueObject/CacheItem.php

@@ -10,12 +10,9 @@
  */
 final class CacheItem
 {
-    /**
-     * @param mixed $data
-     */
     public function __construct(
         private readonly string $variableKey,
-        private $data
+        private readonly mixed $data
     ) {
     }
 

packages/Caching/ValueObject/Storage/FileCacheStorage.php

@@ -48,7 +48,7 @@ public function load(string $key, string $variableKey)
         })($key, $variableKey);
     }
 
-    public function save(string $key, string $variableKey, $data): void
+    public function save(string $key, string $variableKey, mixed $data): void
     {
         $cacheFilePaths = $this->getCacheFilePaths($key);
         $this->smartFileSystem->mkdir($cacheFilePaths->getFirstDirectory());

packages/Caching/ValueObject/Storage/MemoryCacheStorage.php

@@ -34,7 +34,7 @@ public function load(string $key, string $variableKey)
         return $item->getData();
     }
 
-    public function save(string $key, string $variableKey, $data): void
+    public function save(string $key, string $variableKey, mixed $data): void
     {
         $this->storage[$key] = new CacheItem($variableKey, $data);
     }

packages/NodeCollector/NodeAnalyzer/ArrayCallableMethodMatcher.php

@@ -117,10 +117,7 @@ private function shouldSkipNullItems(Array_ $array): bool
         return $array->items[1] === null;
     }
 
-    /**
-     * @param mixed $values
-     */
-    private function shouldSkipAssociativeArray($values): bool
+    private function shouldSkipAssociativeArray(mixed $values): bool
     {
         if (! is_array($values)) {
             return false;

packages/NodeNestingScope/ScopeNestingComparator.php

@@ -84,7 +84,7 @@ public function isInBothIfElseBranch(Node $foundParentNode, Expr $seekedExpr): b
 
         $foundIfNode = (bool) $this->betterNodeFinder->findFirst(
             $foundParentNode->stmts,
-            fn ($node): bool => $this->nodeComparator->areNodesEqual($node, $seekedExpr)
+            fn (Node $node): bool => $this->nodeComparator->areNodesEqual($node, $seekedExpr)
         );
 
         if ($foundParentNode->else === null) {
@@ -93,7 +93,7 @@ public function isInBothIfElseBranch(Node $foundParentNode, Expr $seekedExpr): b
 
         $foundElseNode = (bool) $this->betterNodeFinder->findFirst(
             $foundParentNode->else,
-            fn ($node): bool => $this->nodeComparator->areNodesEqual($node, $seekedExpr)
+            fn (Node $node): bool => $this->nodeComparator->areNodesEqual($node, $seekedExpr)
         );
 
         if ($foundIfNode && $foundElseNode) {

packages/PhpAttribute/AnnotationToAttributeMapper/ArrayAnnotationToAttributeMapper.php

@@ -68,10 +68,7 @@ public function map($value): Expr
         return new Array_($arrayItems);
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function isRemoveArrayPlaceholder($value): bool
+    private function isRemoveArrayPlaceholder(mixed $value): bool
     {
         if (! is_array($value)) {
             return false;

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Fixture/fixture.php.inc

@@ -0,0 +1,28 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class Fixture
+{
+    /**
+     * @param mixed $param
+     */
+    public function run($param)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class Fixture
+{
+    public function run(mixed $param)
+    {
+    }
+}
+
+?>

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Fixture/remove_mixed_param_doc.php.inc

@@ -0,0 +1,28 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class RemoveMixedParamDoc
+{
+    /**
+     * @param mixed $param
+     */
+    public function run(mixed $param)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class RemoveMixedParamDoc
+{
+    public function run(mixed $param)
+    {
+    }
+}
+
+?>

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Fixture/skip_already_mixed_type.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class SkipAlreadyMixedType
+{
+    public function run(mixed $param)
+    {
+    }
+}

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Fixture/skip_has_child_method.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class SkipHasChildMethod
+{
+    /**
+     * @param mixed $param
+     */
+    public function run($param)
+    {
+    }
+}
+
+class SomeChild extends SkipHasChildMethod
+{
+    /**
+     * @param int $param
+     */
+    public function run($param)
+    {
+    }
+}

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Fixture/skip_no_mixed_param_doc.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+class NoMixedParamDoc
+{
+    public function run($param)
+    {
+    }
+}

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Fixture/skip_override_parent_method.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Fixture;
+
+use Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Source\SomeParentNotMixedDocParam;
+
+class SkipOverrideParentMethod extends SomeParentNotMixedDocParam
+{
+    /**
+     * @param mixed $param
+     */
+    public function run($param)
+    {
+    }
+}

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/MixedTypeRectorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class MixedTypeRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/Source/SomeParentNotMixedDocParam.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php80\Rector\FunctionLike\MixedTypeRector\Source;
+
+class SomeParentNotMixedDocParam
+{
+    /**
+     * @param int $param
+     */
+    public function run($param)
+    {
+    }
+}

rules-tests/Php80/Rector/FunctionLike/MixedTypeRector/config/configured_rule.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Core\ValueObject\PhpVersionFeature;
+use Rector\Php80\Rector\FunctionLike\MixedTypeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(MixedTypeRector::class);
+
+    $rectorConfig->phpVersion(PhpVersionFeature::MIXED_TYPE);
+};

rules/Arguments/ArgumentDefaultValueReplacer.php

@@ -45,10 +45,7 @@ public function processReplaces(
         return $this->processArgs($node, $replaceArgumentDefaultValue);
     }
 
-    /**
-     * @param mixed $value
-     */
-    public function isDefaultValueMatched(?Expr $expr, $value): bool
+    public function isDefaultValueMatched(?Expr $expr, mixed $value): bool
     {
         // allow any values before, also allow param without default value
         if ($value === ReplaceArgumentDefaultValue::ANY_VALUE_BEFORE) {
@@ -110,18 +107,12 @@ private function processArgs(
         return $expr;
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function normalizeValueToArgument($value): Arg
+    private function normalizeValueToArgument(mixed $value): Arg
     {
         return new Arg($this->normalizeValue($value));
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function normalizeValue($value): ClassConstFetch|Expr
+    private function normalizeValue(mixed $value): ClassConstFetch|Expr
     {
         // class constants → turn string to composite
         if (is_string($value) && \str_contains($value, '::')) {