Merge pull request #159 from funivan/add-prohibited-extension-inspection

Add ProhibitedClassExtend inspection

Author: funivan

README.md

@@ -87,6 +87,16 @@ Check if parent property is deprecated.
     protected $name; // <-- Warn about deprecation
   }
 ```
+#### ProhibitedClassExtend
+Classes marked with `@final` doc tag should not be extended
+```php
+/**
+ * @final
+ */
+ class User {};
+
+ class Admin extends User {}; // <- Prohibited extentions of @final class User.
+```
 #### PropertyAnnotation
 Properties that are not initialized in the constructor should be annotated as nullable.
 ```php

src/main/kotlin/com/funivan/idea/phpClean/inspections/prohibitedClassExtend/ProhibitedClassExtendInspection.html

@@ -0,0 +1,10 @@
+Classes marked with `@final` doc tag should not be extended
+<pre>
+/**
+ * @final
+ */
+ class User {};
+
+ class Admin extends User {}; // <- Prohibited extentions of @final class User.
+</pre>
+<!-- main -->

src/main/kotlin/com/funivan/idea/phpClean/inspections/prohibitedClassExtend/ProhibitedClassExtendInspection.kt

@@ -0,0 +1,40 @@
+package com.funivan.idea.phpClean.inspections.classNameCollision
+
+import com.funivan.idea.phpClean.inspections.missingParameterType.ClassesByFqn
+import com.funivan.idea.phpClean.inspections.missingParameterType.Implementations
+import com.funivan.idea.phpClean.spl.PhpCleanInspection
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElementVisitor
+import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment
+import com.jetbrains.php.lang.psi.elements.PhpClass
+import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor
+
+class ProhibitedClassExtendInspection : PhpCleanInspection() {
+    override fun getShortName() = "ProhibitedClassExtendInspection"
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+
+        return object : PhpElementVisitor() {
+            private fun parent(phpClass: PhpClass) = ClassesByFqn(phpClass.project, Implementations(phpClass)).all()
+            private fun hasFinalTag(phpClass: PhpClass): Boolean {
+                val docComment = phpClass.docComment
+                return when (docComment is PhpDocComment) {
+                    true -> docComment.getTagElementsByName("@final").isNotEmpty()
+                    false -> false
+                }
+            }
+
+            override fun visitPhpClass(phpClass: PhpClass) {
+                phpClass.nameIdentifier?.let { name ->
+                    parent(phpClass).forEach { extendClass ->
+                        if (hasFinalTag(extendClass)) {
+                            holder.registerProblem(
+                                name,
+                                "Prohibited extentions of @final class ${extendClass.fqn}"
+                            )
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -124,6 +124,16 @@
                 language="PHP"
                 implementationClass="com.funivan.idea.phpClean.inspections.parentPropertyDeprecated.ParentPropertyDeprecatedInspection"
         />
+        <localInspection
+                groupPath="PHP"
+                shortName="ProhibitedClassExtendInspection"
+                displayName="Prohibited class extend"
+                groupName="PhpClean"
+                enabledByDefault="true"
+                level="WARNING"
+                language="PHP"
+                implementationClass="com.funivan.idea.phpClean.inspections.prohibitedClassExtend.ProhibitedClassExtendInspection"
+        />
         <localInspection
                 groupPath="PHP"
                 shortName="MissingParameterTypeDeclarationInspection"

src/test/kotlin/com/funivan/idea/phpClean/inspections/prohibitedClassExtend/ProhibitedClassExtendInspectionTest.kt

@@ -0,0 +1,37 @@
+package com.funivan.idea.phpClean.inspections.prohibitedClassExtend
+
+import com.funivan.idea.phpClean.BaseInspectionTest
+import com.funivan.idea.phpClean.inspections.classNameCollision.ProhibitedClassExtendInspection
+import kotlin.test.Test
+
+internal class ProhibitedClassExtendInspectionTest : BaseInspectionTest() {
+    @Test
+    fun testProhibitExtend() {
+        assert(
+            ProhibitedClassExtendInspection(),
+            """<?php
+                    /**
+                     * @final
+                     */
+                    class User{}
+                    class <warning descr="Prohibited extentions of @final class \User">Admin</warning> extends User{}
+                """
+        )
+    }
+
+    @Test
+    fun testIgnoreCases() {
+        assert(
+            ProhibitedClassExtendInspection(),
+            """<?php
+                    /**
+                     * final
+                     */
+                    class Fruit{}
+                    class Apple extends Fruit{}
+                    class Id implements Fa{}
+                """
+        )
+    }
+
+}