[Feature] Add ParamAnnotationIncorrectNullableRector for fixing incor…

…rect null type in @param (#2069) Co-authored-by: Jiří Bok <jiri.bok@protonmail.com>
rectorphp · Apr 14, 2022 · c509923 · c509923
1 parent 1c1732f
commit c509923
Show file tree

Hide file tree

Showing 27 changed files with 959 additions and 2 deletions.
diff --git a/build/target-repository/docs/rector_rules_overview.md b/build/target-repository/docs/rector_rules_overview.md
@@ -1,4 +1,4 @@
-# 510 Rules Overview
+# 511 Rules Overview
 
 <br>
 
@@ -88,7 +88,7 @@
 
 - [Transform](#transform) (36)
 
-- [TypeDeclaration](#typedeclaration) (25)
+- [TypeDeclaration](#typedeclaration) (26)
 
 - [Visibility](#visibility) (3)
 
@@ -11600,6 +11600,30 @@ Change null in argument, that is now not nullable anymore
 
 <br>
 
+### ParamAnnotationIncorrectNullableRector
+
+Add or remove null type from `@param` phpdoc typehint based on php parameter type declaration
+
+- class: [`Rector\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector`](../rules/TypeDeclaration/Rector/ClassMethod/ParamAnnotationIncorrectNullableRector.php)
+
+```diff
+ final class SomeClass
+ {
+     /**
+-     * @param \DateTime[] $dateTimes
++     * @param \DateTime[]|null $dateTimes
+      */
+     public function setDateTimes(?array $dateTimes): self
+     {
+         $this->dateTimes = $dateTimes;
+
+         return $this;
+     }
+ }
+```
+
+<br>
+
 ### ParamTypeByMethodCallTypeRector
 
 Change param type based on passed method call type

diff --git a/...assMethod/ParamAnnotationIncorrectNullableRector/Fixture/param-annotation-complex.php.inc b/...assMethod/ParamAnnotationIncorrectNullableRector/Fixture/param-annotation-complex.php.inc
@@ -0,0 +1,47 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationComplex
+{
+    /**
+     * @Serializer\VirtualProperty
+     * @Serializer\Type("array<DateTime>")
+     * @Assert\All({
+     *     @Assert\NotBlank,
+     *     @AppAssert\Country,
+     * })
+     * @param \DateTime[] $dateTimes
+     */
+    public function setDateTimes(?array $dateTimes): self
+    {
+        $this->dateTimes = $dateTimes;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationComplex
+{
+    /**
+     * @Serializer\VirtualProperty
+     * @Serializer\Type("array<DateTime>")
+     * @Assert\All({
+     *     @Assert\NotBlank,
+     *     @AppAssert\Country,
+     * })
+     * @param \DateTime[]|null $dateTimes
+     */
+    public function setDateTimes(?array $dateTimes): self
+    {
+        $this->dateTimes = $dateTimes;
+
+        return $this;
+    }
+}
+?>
diff --git a/...rectNullableRector/Fixture/param-annotation-incorrectly-includes-null-in-function.php.inc b/...rectNullableRector/Fixture/param-annotation-incorrectly-includes-null-in-function.php.inc
@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+/**
+ * @param \DateTime[]|null $dateTimes
+ */
+function reverseDateTimes(array $dateTimes): array
+{
+    return array_reverse($dateTimes);
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+/**
+ * @param \DateTime[] $dateTimes
+ */
+function reverseDateTimes(array $dateTimes): array
+{
+    return array_reverse($dateTimes);
+}
+
+?>
diff --git a/...orrectNullableRector/Fixture/param-annotation-incorrectly-includes-null-on-scalar.php.inc b/...orrectNullableRector/Fixture/param-annotation-incorrectly-includes-null-on-scalar.php.inc
@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNullOnScalar
+{
+    /**
+     * @param string|null $text
+     */
+    public function setDateTimes(string $text): self
+    {
+        $this->text = $text;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNullOnScalar
+{
+    /**
+     * @param string $text
+     */
+    public function setDateTimes(string $text): self
+    {
+        $this->text = $text;
+
+        return $this;
+    }
+}
+?>
diff --git a/...or/Fixture/param-annotation-incorrectly-includes-null-with-non-null-default-value.php.inc b/...or/Fixture/param-annotation-incorrectly-includes-null-with-non-null-default-value.php.inc
@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNullWithNonNullDefaultValue
+{
+    /**
+     * @param bool|null $flag
+     */
+    public function setFlag(bool $flag = true): self
+    {
+        $this->flag = $flag;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNullWithNonNullDefaultValue
+{
+    /**
+     * @param bool $flag
+     */
+    public function setFlag(bool $flag = true): self
+    {
+        $this->flag = $flag;
+
+        return $this;
+    }
+}
+?>
diff --git a/...ure/param-annotation-incorrectly-includes-null-with-null-default-value-from-const.php.inc b/...ure/param-annotation-incorrectly-includes-null-with-null-default-value-from-const.php.inc
@@ -0,0 +1,39 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNullWithNonNullDefaultValueFromConst
+{
+    private const FLAG_DEFAULT_VALUE = true;
+
+    /**
+     * @param bool|null $flag
+     */
+    public function setFlag(bool $flag = self::FLAG_DEFAULT_VALUE): self
+    {
+        $this->flag = $flag;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNullWithNonNullDefaultValueFromConst
+{
+    private const FLAG_DEFAULT_VALUE = true;
+
+    /**
+     * @param bool $flag
+     */
+    public function setFlag(bool $flag = self::FLAG_DEFAULT_VALUE): self
+    {
+        $this->flag = $flag;
+
+        return $this;
+    }
+}
+?>
diff --git a/...otationIncorrectNullableRector/Fixture/param-annotation-incorrectly-includes-null.php.inc b/...otationIncorrectNullableRector/Fixture/param-annotation-incorrectly-includes-null.php.inc
@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNull
+{
+    /**
+     * @param \DateTime[]|null $dateTimes
+     */
+    public function setDateTimes(array $dateTimes): self
+    {
+        $this->dateTimes = $dateTimes;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIncorrectlyIncludesNull
+{
+    /**
+     * @param \DateTime[] $dateTimes
+     */
+    public function setDateTimes(array $dateTimes): self
+    {
+        $this->dateTimes = $dateTimes;
+
+        return $this;
+    }
+}
+?>
diff --git a/...ationIncorrectNullableRector/Fixture/param-annotation-is-missing-null-in-function.php.inc b/...ationIncorrectNullableRector/Fixture/param-annotation-is-missing-null-in-function.php.inc
@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+/**
+ * @param \DateTime[] $dateTimes
+ */
+function reverseDateTimes(?array $dateTimes): array
+{
+    return array_reverse($dateTimes);
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+/**
+ * @param \DateTime[]|null $dateTimes
+ */
+function reverseDateTimes(?array $dateTimes): array
+{
+    return array_reverse($dateTimes);
+}
+
+?>
diff --git a/...notationIncorrectNullableRector/Fixture/param-annotation-is-missing-null-multiple.php.inc b/...notationIncorrectNullableRector/Fixture/param-annotation-is-missing-null-multiple.php.inc
@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIsMissingNullMultiple
+{
+    /**
+     * @param \DateTime[] $dateTimes
+     * @param array<\DateTimeImmutable> $immutableDateTimes
+     * @param array<\DateTimeInterface>|null $dateTimeInterfaces
+     */
+    public function setDateTimes(?array $dateTimes, ?array $immutableDateTimes, ?array $dateTimeInterfaces): self
+    {
+        $this->dateTimes = $dateTimes;
+        $this->immutableDateTimes = $immutableDateTimes;
+        $this->dateTimeInterfaces = $dateTimeInterfaces;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIsMissingNullMultiple
+{
+    /**
+     * @param \DateTime[]|null $dateTimes
+     * @param \DateTimeImmutable[]|null $immutableDateTimes
+     * @param array<\DateTimeInterface>|null $dateTimeInterfaces
+     */
+    public function setDateTimes(?array $dateTimes, ?array $immutableDateTimes, ?array $dateTimeInterfaces): self
+    {
+        $this->dateTimes = $dateTimes;
+        $this->immutableDateTimes = $immutableDateTimes;
+        $this->dateTimeInterfaces = $dateTimeInterfaces;
+
+        return $this;
+    }
+}
+?>
diff --git a/...ncorrectNullableRector/Fixture/param-annotation-is-missing-null-with-default-null.php.inc b/...ncorrectNullableRector/Fixture/param-annotation-is-missing-null-with-default-null.php.inc
@@ -0,0 +1,35 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIsMissingNullWithDefaultNull
+{
+    /**
+     * @param \DateTime[] $dateTimes
+     */
+    public function setDateTimes(array $dateTimes = null): self
+    {
+        $this->dateTimes = $dateTimes;
+
+        return $this;
+    }
+}
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\ParamAnnotationIncorrectNullableRector\Fixture;
+
+final class ParamAnnotationIsMissingNullWithDefaultNull
+{
+    /**
+     * @param \DateTime[]|null $dateTimes
+     */
+    public function setDateTimes(array $dateTimes = null): self
+    {
+        $this->dateTimes = $dateTimes;
+
+        return $this;
+    }
+}
+?>