fixes #162 Skip "use assert" qf before variable declaration (#178)

* fixes #162 Skip "use assert" qf before variable declaration

* Fix changelog release version

* Specify fix section

Author: funivan

CHANGELOG.md

@@ -1,6 +1,10 @@
 <!-- Keep a Changelog guide -> https://keepachangelog.com -->
 
 # PhpClean Changelog
+## [2023.02.30]
+### Fixed
+ - #162 Skip "use assert" qf before variable declaration
+
 ## [2022.08.30]
 ### Changed
  - #163 Skip "final check" for anonymous classes

src/main/kotlin/com/funivan/idea/phpClean/inspections/virtualTypeCheck/UseAssertQF.kt

@@ -32,4 +32,4 @@ class UseAssertQF(
             }
         }
     }
-}
+}

src/main/kotlin/com/funivan/idea/phpClean/inspections/virtualTypeCheck/VirtualTypeCheckInspection.kt

@@ -5,9 +5,11 @@ import com.funivan.idea.phpClean.spl.Pointer
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.psi.PsiElementVisitor
 import com.jetbrains.php.PhpIndex
+import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment
 import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocType
 import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocVariable
 import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag
+import com.jetbrains.php.lang.psi.elements.AssignmentExpression
 import com.jetbrains.php.lang.psi.resolve.types.PhpType
 import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor
 
@@ -26,16 +28,26 @@ class VirtualTypeCheckInspection : PhpCleanInspection() {
                             val plain = type.toStringResolved()
                             if (!PhpType.isPluralType(plain) && !PhpType.isNotExtendablePrimitiveType(plain)) {
                                 val index = PhpIndex.getInstance(variableType.project)
-                                if (index.getClassesByFQN(plain).isNotEmpty() || index.getInterfacesByFQN(plain).isNotEmpty()) {
-                                    holder.registerProblem(
+                                if (index.getClassesByFQN(plain).isNotEmpty() || index.getInterfacesByFQN(plain)
+                                        .isNotEmpty()
+                                ) {
+                                    val nextPsiSibling = (tag.parent as? PhpDocComment)?.nextPsiSibling?.firstChild
+                                    if (nextPsiSibling is AssignmentExpression && nextPsiSibling.variable?.name == variable.name) {
+                                        holder.registerProblem(
+                                            variableType,
+                                            "Use assert to check variable type"
+                                        )
+                                    } else {
+                                        holder.registerProblem(
                                             variableType,
                                             "Use assert to check variable type",
                                             UseAssertQF(
-                                                    Pointer(tag.parent).create(),
-                                                    Pointer(variable).create(),
-                                                    Pointer(variableType).create()
+                                                Pointer(tag.parent).create(),
+                                                Pointer(variable).create(),
+                                                Pointer(variableType).create()
                                             )
-                                    )
+                                        )
+                                    }
                                 }
                             }
                         }

src/test/kotlin/com/funivan/idea/phpClean/inspections/virtualTypeCheck/VirtualTypeCheckInspectionTest.kt

@@ -9,10 +9,16 @@ class VirtualTypeCheckInspectionTest : BaseInspectionTest() {
         assert(
             VirtualTypeCheckInspection(),
             """<?php
-                class User{}
-                /** @var ${'$'}user <warning descr="Use assert to check variable type">User</warning> */;
-                assert(${'$'}user instanceof User); // Valid
-                """
+class User{}
+/** @var <warning descr="Use assert to check variable type">User</warning> ${'$'}user */
+assert(${'$'}user instanceof User); // Valid
+""",
+            """<?php
+class User{}
+
+assert(${'$'}user instanceof User);
+assert(${'$'}user instanceof User); // Valid
+""",
         )
     }
 
@@ -22,7 +28,7 @@ class VirtualTypeCheckInspectionTest : BaseInspectionTest() {
             VirtualTypeCheckInspection(),
             """<?php
                 interface User{}
-                /** @var ${'$'}user <warning descr="Use assert to check variable type">User</warning> */;
+                /** @var <warning descr="Use assert to check variable type">User</warning> ${'$'}user */
                 assert(${'$'}user instanceof User); // Valid
                 """
         )
@@ -33,8 +39,8 @@ class VirtualTypeCheckInspectionTest : BaseInspectionTest() {
         assert(
             VirtualTypeCheckInspection(),
             """<?php
-                /** @var ${'$'}user[] user */;
-                /** @var ${'$'}user stdClass[] */;
+                /** @var ${'$'}user[] user */
+                /** @var ${'$'}user stdClass[] */
                 """
         )
     }
@@ -44,12 +50,12 @@ class VirtualTypeCheckInspectionTest : BaseInspectionTest() {
         assert(
             VirtualTypeCheckInspection(),
             """<?php
-                /** @var ${'$'}user string */;
-                /** @var ${'$'}user int */;
-                /** @var ${'$'}user resource */;
-                /** @var ${'$'}user iterable */;
-                /** @var ${'$'}user array */;
-                /** @var ${'$'}user mixed */;
+                /** @var ${'$'}user string */
+                /** @var ${'$'}user int */
+                /** @var ${'$'}user resource */
+                /** @var ${'$'}user iterable */
+                /** @var ${'$'}user array */
+                /** @var ${'$'}user mixed */
                 """
         )
     }
@@ -106,4 +112,20 @@ class Options{};
         )
     }
 
+    @Test
+    fun testSkipQFOnUninitializedVariable() {
+        assert(
+            VirtualTypeCheckInspection(),
+            """<?php
+                class Letter{}
+                /** @var <warning descr="Use assert to check variable type">Letter</warning> ${'$'}letter */
+                ${'$'}letter = new Letter();
+                """,
+            """<?php
+                class Letter{}
+                /** @var Letter ${'$'}letter */
+                ${'$'}letter = new Letter();
+                """
+        )
+    }
 }