[assert] Kick of experimental rule, AddAssertArrayFromClassMethodDocblockRector (#7206)

* add ...

* [assert] Kick of experimental rule, AddAssertArrayFromClassMethodDocblockRector

* [ci-review] Rector Rectify

---------

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

Author: TomasVotruba

rules-tests/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector/AddAssertArrayFromClassMethodDocblockRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddAssertArrayFromClassMethodDocblockRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector/Fixture/multiple_parameters.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\Fixture;
+
+final class MultipleParameters
+{
+    /**
+     * @param array<string, string> $items
+     * @param string[] $names
+     */
+    public function run(array $items, array $names)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\Fixture;
+
+final class MultipleParameters
+{
+    /**
+     * @param array<string, string> $items
+     * @param string[] $names
+     */
+    public function run(array $items, array $names)
+    {
+        \Webmozart\Assert\Assert::allString($items);
+        \Webmozart\Assert\Assert::allString(array_keys($items));
+        \Webmozart\Assert\Assert::allString($names);
+    }
+}
+
+?>

rules-tests/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector/Fixture/simple_array.php.inc

@@ -0,0 +1,32 @@
+<?php
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\Fixture;
+
+final class SimpleArray
+{
+    /**
+     * @param int[] $items
+     */
+    public function run(array $items)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\Fixture;
+
+final class SimpleArray
+{
+    /**
+     * @param int[] $items
+     */
+    public function run(array $items)
+    {
+        \Webmozart\Assert\Assert::allInteger($items);
+    }
+}
+
+?>

rules-tests/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector/Fixture/skip_already_set.php.inc

@@ -0,0 +1,14 @@
+<?php
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\Fixture;
+
+final class SkipAlreadySet
+{
+    /**
+     * @param int[] $items
+     */
+    public function run(array $items)
+    {
+        \Webmozart\Assert\Assert::allInteger($items);
+    }
+}

rules-tests/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector/Fixture/skip_no_array.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector\Fixture;
+
+final class SkipNoArray
+{
+    /**
+     * @param int[] $items
+     */
+    public function run($items)
+    {
+    }
+}

rules-tests/Assert/Rector/ClassMethod/AddAssertArrayFromClassMethodDocblockRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Assert\Rector\ClassMethod\AddAssertArrayFromClassMethodDocblockRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddAssertArrayFromClassMethodDocblockRector::class);
+};

rules/Assert/Enum/AssertClassName.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Assert\Enum;
+
+final class AssertClassName
+{
+    /**
+     * @var string
+     */
+    public const ASSERT = 'Webmozart\Assert\Assert';
+}

rules/Assert/NodeAnalyzer/ExistingAssertStaticCallResolver.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Assert\NodeAnalyzer;
+
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Expression;
+use PhpParser\PrettyPrinter\Standard;
+use Rector\Assert\Enum\AssertClassName;
+
+final class ExistingAssertStaticCallResolver
+{
+    /**
+     * @return string[]
+     */
+    public function resolve(ClassMethod $classMethod): array
+    {
+        if ($classMethod->stmts === null) {
+            return [];
+        }
+
+        $existingAssertCallHashes = [];
+        $standard = new Standard();
+
+        foreach ($classMethod->stmts as $currentStmt) {
+            if (! $currentStmt instanceof Expression) {
+                continue;
+            }
+
+            if (! $currentStmt->expr instanceof StaticCall) {
+                continue;
+            }
+
+            $staticCall = $currentStmt->expr;
+            if (! $staticCall->class instanceof Name) {
+                continue;
+            }
+
+            if ($staticCall->class->toString() !== AssertClassName::ASSERT) {
+                continue;
+            }
+
+            $existingAssertCallHashes[] = $standard->prettyPrintExpr($staticCall);
+        }
+
+        return $existingAssertCallHashes;
+    }
+}