Add new action: Use named constructor (#180)

* Add new action: Use named constructor

* Fix readme

* Update intellij plugin

* Use text representation to check method signature

Author: funivan

CHANGELOG.md

@@ -1,9 +1,11 @@
 <!-- Keep a Changelog guide -> https://keepachangelog.com -->
 
 # PhpClean Changelog
-## [2023.02.30]
+## [2023.03.01]
 ### Fixed
  - #162 Skip "use assert" qf before variable declaration
+### Added
+ - Introduce new action - use named constructor
 
 ## [2022.08.30]
 ### Changed

README.md

@@ -14,10 +14,13 @@ Hit `install` button.
 
 ![GitHub commits (since latest release)](https://img.shields.io/github/commits-since/funivan/PhpClean/latest.svg?style=flat-square)
 
+[- Inspections](#Inspections)
 
+[- Actions](#Actions)
 
-## List of inspection:
-<!-- inspections -->
+
+<!-- Autogenerated -->
+## Inspections
 #### AssignMisused
 Detects assignment and comparison operators in one statement.
 ```php
@@ -137,3 +140,22 @@ Use assert to check variable type instead of doc comment.
 /** @var User $user */ // <-- Use assert to check variable type
 assert($user instanceof User);
 ```
+
+## Actions
+#### UseNamedConstructor
+Replace `new ClassName()` with selected named constructor.
+
+```php
+class Text {
+ public function __construct(string $name){ }
+ public static fromName(string $n){}
+}
+```
+Invoke `refactor this` on method name `fromName`
+and all new statements with this class will be changed
+
+```php
+ new Text('User') // old code
+ Text::fromName('User') // new code
+```
+

build.gradle.kts

@@ -1,10 +1,9 @@
-
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
     id("java")
     id("org.jetbrains.kotlin.jvm") version "1.7.10"
-    id("org.jetbrains.intellij") version "1.13.0"
+    id("org.jetbrains.intellij") version "1.13.3"
     id("org.jetbrains.changelog") version "2.0.0"
     // ktlint linter - read more: https://github.com/JLLeitschuh/ktlint-gradle
     // id("org.jlleitschuh.gradle.ktlint") version "10.1.0"
@@ -58,14 +57,15 @@ changelog {
     version.set(pluginVersion)
     headerParserRegex.set("""(\d+\.\d+\.\d+)""".toRegex())
 }
-
 tasks {
-    withType<JavaCompile> {
-        sourceCompatibility = "11"
-        targetCompatibility = "11"
-    }
-    withType<KotlinCompile> {
-        kotlinOptions.jvmTarget = "11"
+    properties("javaVersion").let {
+        withType<JavaCompile> {
+            sourceCompatibility = it
+            targetCompatibility = it
+        }
+        withType<KotlinCompile> {
+            kotlinOptions.jvmTarget = it
+        }
     }
 
     publishPlugin {
@@ -89,10 +89,10 @@ tasks {
 
     register("copyInspections") {
         doLast {
-            blocks().forEach {
+            inspections().forEach {
                 write(
                     File("src/main/resources/inspectionDescriptions/" + it.file().name),
-                    it.full()
+                    it.content()
                 )
             }
         }
@@ -113,7 +113,7 @@ tasks {
         }
     }
 
-    named("test"){
+    named("test") {
         dependsOn("checkReadme")
     }
     named("buildPlugin") {
@@ -138,34 +138,48 @@ fun write(file: File, content: String): Boolean {
     return result
 }
 
-class Block(private val file: File) {
+class Descriptor(
+    private val file: File,
+    private val uid: String
+) {
+    fun uid() = uid
     fun file() = file
-    fun uid() = file.name.replace("Inspection.html", "")
-    fun full() = file.readText()
-    fun short() = full()
+    fun content() = file.readText()
+    fun short() = content()
         .replace(Regex("<!-- main -->(.*)", RegexOption.DOT_MATCHES_ALL), "")
         .trim()
 }
 
-fun blocks() = File("src/main/kotlin/com/funivan/idea/phpClean/inspections")
-    .walkTopDown()
-    .filter { it.name.contains("Inspection.kt") }
-    .map { Block(File(it.path.replace(".kt", ".html"))) }
-
-fun generatedReadmeContent(readme: File): String {
-    var content = readme.readText()
-    content = content.replace(
-        Regex("(<!-- inspections -->)(.+)", RegexOption.DOT_MATCHES_ALL),
-        "$1"
-    )
-    content = content + "\n" + blocks().sortedBy { it.uid() }
-        .map {
-            val description = it.short().replace("<pre>", "```php").replace("</pre>", "```")
-            "#### ${it.uid()}\n$description\n"
-        }
-        .joinToString("")
-    return content
-}
+fun actions() = projectHtmlFiles("Action")
+fun inspections() = projectHtmlFiles("Inspection")
+
+
+fun generatedReadmeContent(readme: File): String =
+    readme.readText().replace(
+        Regex("<!-- Autogenerated -->.+", RegexOption.DOT_MATCHES_ALL), ""
+    ) + "<!-- Autogenerated -->\n" + generateSections()
 
 fun readmeFile() = File("README.md")
+fun projectHtmlFiles(type: String) = File("src/main/kotlin/com/funivan/idea/phpClean")
+    .walkTopDown()
+    .filter { it.name.contains("${type}.html") }
+    .map {
+        Descriptor(
+            File(it.path),
+            it.name.replace("${type}.html", "")
+        )
+    }
 
+fun generateSections() = listOf(
+    Pair("Inspections", inspections()),
+    Pair("Actions", actions()),
+).fold("") { acc, pair ->
+    acc + "## ${pair.first}\n" +
+            pair.second.sortedBy { it.uid() }
+                .map {
+                    val description = it.short().replace("<pre>", "```php").replace("</pre>", "```")
+                    "#### ${it.uid()}\n$description\n"
+                }
+                .joinToString("") +
+            "\n"
+}

gradle.properties

@@ -1,19 +1,18 @@
 pluginGroup = com.funivan.idea.phpClean
 pluginName_ = PhpClean
 name = PhpClean
-pluginVersion = 2022.08.30
-pluginSinceBuild = 211
+pluginVersion = 2023.03.01
+pluginSinceBuild = 221.5080.224
 #pluginUntilBuild = 203.*
 # Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl
 # See https://jb.gg/intellij-platform-builds-list for available build versions
-pluginVerifierIdeVersions = 2020.3.2, 2021.1, 2022.1.4
+pluginVerifierIdeVersions = 2022.3.2
 platformType = IU
-platformVersion = 2022.1.4
+platformVersion = 2022.2.3
 platformDownloadSources = true
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
-# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22
-platformPlugins = com.intellij.java, com.jetbrains.php:221.6008.13, PsiViewer:221-SNAPSHOT
-
+platformPlugins = com.intellij.java, com.jetbrains.php:222.4345.15
+javaVersion = 17
 # Opt-out flag for bundling Kotlin standard library.
 # See https://kotlinlang.org/docs/reference/using-gradle.html#dependency-on-the-standard-library for details.
 kotlin.stdlib.default.dependency = false

src/main/kotlin/com/funivan/idea/phpClean/actions/useNamedConstructor/NamedConstructorUsageViewDescriptor.kt

@@ -0,0 +1,19 @@
+package com.funivan.idea.phpClean.actions.useNamedConstructor
+
+import com.intellij.usageView.UsageViewBundle
+import com.intellij.usageView.UsageViewDescriptor
+import com.jetbrains.php.lang.psi.elements.Method
+
+class NamedConstructorUsageViewDescriptor(
+    val constructor: Method,
+    val target: Method
+) : UsageViewDescriptor {
+    override fun getElements() =
+        arrayOf(constructor)
+
+    override fun getProcessedElementsHeader() =
+        "Use named constructor: " + target.name
+
+    override fun getCodeReferencesText(usagesCount: Int, filesCount: Int) =
+        UsageViewBundle.getReferencesString(usagesCount, filesCount)
+}

src/main/kotlin/com/funivan/idea/phpClean/actions/useNamedConstructor/UseNamedConstructorAction.html

@@ -0,0 +1,15 @@
+Replace `new ClassName()` with selected named constructor.
+
+<pre>
+class Text {
+ public function __construct(string $name){ }
+ public static fromName(string $n){}
+}
+</pre>
+Invoke `refactor this` on method name `fromName`
+and all new statements with this class will be changed
+
+<pre>
+ new Text('User') // old code
+ Text::fromName('User') // new code
+</pre>

src/main/kotlin/com/funivan/idea/phpClean/actions/useNamedConstructor/UseNamedConstructorAction.kt

@@ -0,0 +1,50 @@
+package com.funivan.idea.phpClean.actions.useNamedConstructor
+
+import com.intellij.lang.Language
+import com.intellij.openapi.actionSystem.DataContext
+import com.intellij.openapi.editor.Editor
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.refactoring.RefactoringActionHandler
+import com.intellij.refactoring.actions.BaseRefactoringAction
+import com.jetbrains.php.lang.PhpLanguage
+import com.jetbrains.php.lang.psi.elements.Method
+
+class UseNamedConstructorAction : BaseRefactoringAction() {
+
+    override fun isAvailableInEditorOnly() = false
+
+    override fun isEnabledOnElements(elements: Array<out PsiElement>): Boolean {
+        return elements.map(::isNamedConstructorCandidate).all { it == false }
+    }
+
+    override fun isAvailableOnElementInEditorAndFile(
+        element: PsiElement,
+        editor: Editor,
+        file: PsiFile,
+        context: DataContext
+    ): Boolean {
+        return isNamedConstructorCandidate(element)
+    }
+
+    private fun isNamedConstructorCandidate(element: PsiElement): Boolean {
+        if (element is Method && element.isStatic) {
+            val constructorParameters = element.containingClass?.constructor?.let { it.parameters.map { it.typeDeclaration?.text ?: "" } }
+            val methodParameters = element.parameters.map { it.typeDeclaration?.text ?: "" }
+            return constructorParameters == methodParameters
+        }
+        return false
+    }
+
+    override fun getHandler(dataContext: DataContext): RefactoringActionHandler {
+        return UseNamedConstructorHandler()
+    }
+
+    override fun isAvailableForFile(file: PsiFile): Boolean {
+        return isAvailableForLanguage(file.language)
+    }
+
+    override fun isAvailableForLanguage(language: Language): Boolean {
+        return language.isKindOf(PhpLanguage.INSTANCE)
+    }
+}

src/main/kotlin/com/funivan/idea/phpClean/actions/useNamedConstructor/UseNamedConstructorHandler.kt

@@ -0,0 +1,30 @@
+package com.funivan.idea.phpClean.actions.useNamedConstructor
+
+import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.actionSystem.DataContext
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiFile
+import com.intellij.refactoring.RefactoringActionHandler
+import com.jetbrains.php.lang.psi.elements.Method
+
+class UseNamedConstructorHandler : RefactoringActionHandler {
+    override fun invoke(project: Project, editor: Editor?, file: PsiFile?, dataContext: DataContext?) {
+        if (editor == null) {
+            return
+        }
+        dataContext
+            ?.let { CommonDataKeys.PSI_ELEMENT.getData(it) as Method? }
+            ?.let {
+                val constructor = it.containingClass?.ownConstructor
+                if (constructor != null) {
+                    UseNamedConstructorProcessor(constructor, it).run()
+                }
+            }
+    }
+
+    override fun invoke(project: Project, elements: Array<PsiElement>, dataContext: DataContext?) {
+        // Do nothing. This action can not be triggered in non-editor context
+    }
+}

src/main/kotlin/com/funivan/idea/phpClean/actions/useNamedConstructor/UseNamedConstructorProcessor.kt

@@ -0,0 +1,56 @@
+package com.funivan.idea.phpClean.actions.useNamedConstructor
+
+import com.intellij.psi.search.searches.ReferencesSearch
+import com.intellij.psi.util.parentOfType
+import com.intellij.refactoring.BaseRefactoringProcessor
+import com.intellij.usageView.UsageInfo
+import com.intellij.usageView.UsageViewDescriptor
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory
+import com.jetbrains.php.lang.psi.elements.Method
+import com.jetbrains.php.lang.psi.elements.NewExpression
+
+class UseNamedConstructorProcessor(
+    val constructor: Method,
+    val namedConstructor: Method,
+) : BaseRefactoringProcessor(constructor.project) {
+
+    override fun createUsageViewDescriptor(usages: Array<out UsageInfo>): UsageViewDescriptor {
+        return NamedConstructorUsageViewDescriptor(constructor, namedConstructor)
+    }
+
+    override fun findUsages(): Array<UsageInfo> {
+        return ReferencesSearch.search(constructor)
+            .map { it.element.parent as? NewExpression }
+            .filter {
+                val inMethod = it?.parentOfType(Method::class)
+                if (inMethod is Method) {
+                    val isSameM = inMethod.name == namedConstructor.name
+                    val isSameClass = inMethod.containingClass?.fqn == namedConstructor.containingClass?.fqn
+                    (isSameM && isSameClass) == false
+                } else {
+                    true
+                }
+            }
+            .filterNotNull()
+            .map { UsageInfo(it) }.toTypedArray()
+    }
+
+    override fun performRefactoring(usages: Array<UsageInfo>) {
+        usages.forEach {
+            (it.element as? NewExpression)?.let {
+                val n = it.classReference?.element?.text
+                if (n != null) {
+                    it.replace(
+                        PhpPsiElementFactory.createMethodReference(
+                            it.project,
+                            n + "::" + namedConstructor.name
+                                    + "(" + it.parameterList?.text.orEmpty() + ")"
+                        )
+                    )
+                }
+            }
+        }
+    }
+
+    override fun getCommandName() = "Use named constructor"
+}

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

@@ -177,6 +177,12 @@
     </extensions>
 
     <actions>
-        <!-- Add your actions here -->
+        <action class="com.funivan.idea.phpClean.actions.useNamedConstructor.UseNamedConstructorAction"
+                id="PhpClean.UseNamedConstructor"
+                text="Use named constructor"
+                description="Use named constructor instead of construct method"
+        >
+            <add-to-group group-id="RefactoringMenu" anchor="after" relative-to-action="SafeDelete"/>
+        </action>
     </actions>
 </idea-plugin>