introduce an intention to add @kphp-immutable-class annotation (#67)

Author: vldF

src/main/kotlin/com/vk/kphpstorm/inspections/helpers/PhpDocPsiBuilder.kt

@@ -13,8 +13,10 @@ import com.jetbrains.php.lang.psi.PhpPsiElementFactory
 import com.jetbrains.php.lang.psi.elements.Field
 import com.jetbrains.php.lang.psi.elements.Function
 import com.jetbrains.php.lang.psi.elements.Parameter
+import com.jetbrains.php.lang.psi.elements.PhpClass
 import com.jetbrains.php.lang.psi.elements.PhpNamedElement
 import com.vk.kphpstorm.helpers.parentDocComment
+import com.vk.kphpstorm.kphptags.KphpDocTag
 import com.vk.kphpstorm.kphptags.KphpSerializedFieldDocTag
 
 /**
@@ -68,6 +70,13 @@ object PhpDocPsiBuilder {
         return field.docComment!!.addTag(project, "@var", "type")
     }
 
+    fun addTagToClass(klass: PhpClass, annotation: KphpDocTag): PhpDocTag {
+        val project = klass.project
+        val docComment = klass.docComment ?: createDocComment(project, klass)
+
+        return docComment.transformToMultiline(project).addTag(project, annotation.nameWithAt)
+    }
+
 
     /**
      * Create empty phpdoc and insert it before function/class/field

src/main/kotlin/com/vk/kphpstorm/intentions/AddImmutableClassAnnotationIntention.kt

@@ -0,0 +1,80 @@
+package com.vk.kphpstorm.intentions
+
+import com.intellij.codeInsight.intention.PsiElementBaseIntentionAction
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiElement
+import com.intellij.psi.search.LocalSearchScope
+import com.intellij.psi.search.searches.ReferencesSearch
+import com.intellij.psi.util.findParentInFile
+import com.jetbrains.php.lang.psi.elements.AssignmentExpression
+import com.jetbrains.php.lang.psi.elements.PhpClass
+import com.vk.kphpstorm.inspections.helpers.PhpDocPsiBuilder
+import com.vk.kphpstorm.kphptags.KphpImmutableClassDocTag
+
+class AddImmutableClassAnnotationIntention : PsiElementBaseIntentionAction() {
+    override fun getText(): String = "Add @kphp-immutable-class"
+    override fun getFamilyName(): String = getText()
+
+    override fun isAvailable(project: Project, editor: Editor?, element: PsiElement): Boolean {
+        if (!element.isClassNameNode()) {
+            return false
+        }
+
+        val klass = element.parent as PhpClass
+        if (klass.isAbstract || klass.isInterface || klass.isTrait || klass.isAnonymous) {
+            return false
+        }
+
+        val klassDocNode = klass.docComment
+
+        // do not suggest if already present
+        if (klassDocNode != null && KphpImmutableClassDocTag.existsInDocComment(klassDocNode)) {
+            return false
+        }
+
+        return !isClassLocallyImmutable(klass)
+    }
+
+    /**
+     * Simple local class mutability check. If there is any field mutation in class,
+     * the class is mutable. The only exception is the class constructor
+     */
+    private fun isClassLocallyImmutable(klass: PhpClass): Boolean {
+        val searchScope = LocalSearchScope(klass)
+        for (field in klass.fields) {
+            val hasAnyMutation = ReferencesSearch.search(field, searchScope).any { ref ->
+                val element = ref.element
+
+                isMutatingOp(element) && !isInClassConstructor(klass, element)
+            }
+
+            if (hasAnyMutation) {
+                return true
+            }
+        }
+
+        return false
+    }
+
+    private fun isMutatingOp(psiElement: PsiElement): Boolean {
+        val parent = psiElement.parent
+
+        return parent is AssignmentExpression && parent.variable == psiElement
+    }
+
+    private fun isInClassConstructor(klass: PhpClass, psiElement: PsiElement): Boolean {
+        val classConstructor = klass.constructor
+        return classConstructor != null && psiElement.findParentInFile { e -> e == classConstructor } != null
+    }
+
+    override fun invoke(project: Project, editor: Editor?, element: PsiElement) {
+        val klass = element.parent as PhpClass
+        PhpDocPsiBuilder.addTagToClass(klass, KphpImmutableClassDocTag)
+    }
+
+    private fun PsiElement.isClassNameNode(): Boolean {
+        val klass = this.parent as? PhpClass ?: return false
+        return klass.nameIdentifier == this
+    }
+}

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

@@ -77,7 +77,12 @@
       <language>PHP</language>
       <className>com.vk.kphpstorm.intentions.PrettifyPhpdocBlockIntention</className>
       <category>PHP</category>
-      <descriptionDirectoryName>PrettifyPhpdocBlockIntention</descriptionDirectoryName>
+    </intentionAction>
+
+    <intentionAction>
+      <language>PHP</language>
+      <className>com.vk.kphpstorm.intentions.AddImmutableClassAnnotationIntention</className>
+      <category>PHP</category>
     </intentionAction>
 
     <additionalTextAttributes scheme="Default" file="colorSchemes/KphpAddonsDefault.xml"/>

src/main/resources/intentionDescriptions/AddImmutableClassAnnotationIntention/after.php.template

@@ -0,0 +1,7 @@
+/**
+ * My favorite class
+ * <spot>@kphp-immutable-class</spot>
+ */
+class MyClass {
+    // ...
+}

src/main/resources/intentionDescriptions/AddImmutableClassAnnotationIntention/before.php.template

@@ -0,0 +1,6 @@
+/**
+ * My favorite class
+ */
+class MyClass {
+    // ...
+}

src/main/resources/intentionDescriptions/AddImmutableClassAnnotationIntention/description.html

@@ -0,0 +1 @@
+Add <i>@kphp-immutable-class annotation</i> to the class

src/test/fixtures/kphp_intentions/immutable_class_intention-1.fixture.php

@@ -0,0 +1,5 @@
+<?php
+
+class <caret>C1 {
+    // ...
+}

src/test/fixtures/kphp_intentions/immutable_class_intention-1.qf.php

@@ -0,0 +1,8 @@
+<?php
+
+/**
+ * @kphp-immutable-class
+ */
+class C1 {
+    // ...
+}

src/test/fixtures/kphp_intentions/immutable_class_intention-10.fixture.php

@@ -0,0 +1,7 @@
+<?php
+
+/**
+ * @kphp-serializable
+ * @kphp-color slow-ignore
+*/
+class <caret>C1 { }

src/test/fixtures/kphp_intentions/immutable_class_intention-10.qf.php

@@ -0,0 +1,8 @@
+<?php
+
+/**
+ * @kphp-immutable-class
+ * @kphp-serializable
+ * @kphp-color slow-ignore
+*/
+class <caret>C1 { }