Add file icon provider for Symfony commands

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/Symfony2Icons.java

@@ -79,6 +79,7 @@ public class Symfony2Icons {
     public static final Icon SYMFONY_AI = IconLoader.getIcon("/icons/symfony_ai.png", Symfony2Icons.class);
     public static final Icon SYMFONY_AI_OPACITY = IconLoader.getIcon("/icons/symfony_ai_opacity.png", Symfony2Icons.class);
     public static final Icon SYMFONY_ATTRIBUTE = IconLoader.getIcon("/icons/symfony_attribute.svg", Symfony2Icons.class);
+    public static final Icon SYMFONY_COMMAND_FILE = IconLoader.getIcon("/icons/symfony_command_file.svg", Symfony2Icons.class);
 
     public static Image getImage(Icon icon) {
 
@@ -94,4 +95,3 @@ public static Image getImage(Icon icon) {
         return image;
     }
 }
-

src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/command/SymfonyCommandFileIconProvider.kt

@@ -0,0 +1,64 @@
+package fr.adrienbrault.idea.symfony2plugin.dic.command
+
+import com.intellij.ide.FileIconProvider
+import com.intellij.openapi.fileTypes.FileTypeRegistry
+import com.intellij.openapi.project.DumbService
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.text.StringUtil
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiManager
+import com.intellij.psi.impl.ElementBase
+import com.intellij.ui.IconManager
+import com.intellij.ui.LayeredIcon
+import com.jetbrains.php.lang.PhpFileType
+import com.jetbrains.php.lang.psi.PhpFile
+import com.jetbrains.php.lang.psi.elements.PhpClass
+import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent
+import javax.swing.Icon
+import javax.swing.SwingConstants
+
+private const val AS_COMMAND_ATTRIBUTE = "\\Symfony\\Component\\Console\\Attribute\\AsCommand"
+
+/**
+ * WIP: decorate Symfony attribute command PHP file icons while keeping PHP's own class icon as the base.
+ */
+class SymfonyCommandFileIconProvider : FileIconProvider {
+
+    override fun getIcon(virtualFile: VirtualFile, flags: Int, project: Project?): Icon? {
+        if (project == null ||
+            !Symfony2ProjectComponent.isEnabled(project) ||
+            DumbService.getInstance(project).isDumb ||
+            !FileTypeRegistry.getInstance().isFileOfType(virtualFile, PhpFileType.INSTANCE)
+        ) {
+            return null
+        }
+
+        val psiFile = PsiManager.getInstance(project).findFile(virtualFile) as? PhpFile ?: return null
+        val phpClass = extractOnlyClass(psiFile) ?: return null
+        if (phpClass.getAttributes(AS_COMMAND_ATTRIBUTE).isEmpty()) {
+            return null
+        }
+
+        val icon = createSymfonyCommandFileIcon(phpClass.icon)
+        return IconManager.getInstance().createLayeredIcon(psiFile, icon, ElementBase.transformFlags(psiFile, flags))
+    }
+
+    private fun extractOnlyClass(file: PhpFile): PhpClass? {
+        val classes = file.topLevelDefs.values().filterIsInstance<PhpClass>()
+        if (classes.size != 1) {
+            return null
+        }
+
+        val phpClass = classes.first()
+        return if (StringUtil.containsIgnoreCase(file.name, phpClass.name)) phpClass else null
+    }
+
+}
+
+internal fun createSymfonyCommandFileIcon(baseIcon: Icon): Icon {
+    val badgeIcon = Symfony2Icons.SYMFONY_COMMAND_FILE
+    return LayeredIcon.layeredIcon(arrayOf(baseIcon, badgeIcon)).also {
+        it.setIcon(badgeIcon, 1, SwingConstants.SOUTH_EAST)
+    }
+}

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

@@ -341,6 +341,8 @@
         <codeInsight.inlayProvider language="Twig" implementationClass="fr.adrienbrault.idea.symfony2plugin.templating.inlay.TwigVariablesInlayHintsProvider"/>
 
         <multiHostInjector implementation="fr.adrienbrault.idea.symfony2plugin.lang.ParameterLanguageInjector"/>
+        <fileIconProvider implementation="fr.adrienbrault.idea.symfony2plugin.dic.command.SymfonyCommandFileIconProvider"
+                          order="before PhpFileIconProvider"/>
         <iconProvider implementation="fr.adrienbrault.idea.symfony2plugin.twig.icon.TwigIconProvider"/>
 
         <statusBarWidgetFactory implementation="fr.adrienbrault.idea.symfony2plugin.ui.SymfonyStatusbarWidgetFactory" id="symfony.status.bar"/>

src/main/resources/icons/symfony_command_file.svg

@@ -0,0 +1,91 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.dic.command
+
+import com.intellij.psi.PsiDocumentManager
+import com.intellij.psi.PsiFile
+import com.intellij.ui.LayeredIcon
+import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons
+import fr.adrienbrault.idea.symfony2plugin.dic.command.SymfonyCommandFileIconProvider
+import fr.adrienbrault.idea.symfony2plugin.dic.command.createSymfonyCommandFileIcon
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase
+import javax.swing.Icon
+
+/**
+ * @see SymfonyCommandFileIconProvider
+ */
+class SymfonyCommandFileIconProviderTest : SymfonyLightCodeInsightFixtureTestCase() {
+
+    fun testAsCommandAttributeShowsSymfonyBadge() {
+        val commandFile = myFixture.addFileToProject(
+            "src/Command/FooCommand.php",
+            """
+            <?php
+
+            namespace App\Command;
+
+            use Symfony\Component\Console\Attribute\AsCommand;
+
+            #[AsCommand(name: 'app:foo')]
+            class FooCommand
+            {
+            }
+            """.trimIndent()
+        )
+
+        val icon = getIconFromProvider(commandFile)
+        assertNotNull("Icon should not be null for AsCommand class", icon)
+    }
+
+    fun testSymfonyCommandBadgeIconIsLayered() {
+        val icon: Icon = createSymfonyCommandFileIcon(Symfony2Icons.SYMFONY)
+
+        assertTrue("Badge icon should be a LayeredIcon", icon is LayeredIcon)
+        assertTrue("Command badge should be loaded", Symfony2Icons.SYMFONY_COMMAND_FILE.iconWidth > 0)
+        assertTrue("Badge icon should keep a visible size", icon.iconWidth > 0 && icon.iconHeight > 0)
+    }
+
+    fun testRegularPhpClassFallsBackToPhpProvider() {
+        val regularFile = myFixture.addFileToProject(
+            "src/Command/FooService.php",
+            """
+            <?php
+
+            namespace App\Command;
+
+            class FooService
+            {
+            }
+            """.trimIndent()
+        )
+
+        assertNull("Provider should not handle regular PHP classes", getIconFromProvider(regularFile))
+    }
+
+    fun testMultipleClassesFallBackToPhpProvider() {
+        val multipleClassesFile = myFixture.addFileToProject(
+            "src/Command/FooCommand.php",
+            """
+            <?php
+
+            namespace App\Command;
+
+            use Symfony\Component\Console\Attribute\AsCommand;
+
+            #[AsCommand(name: 'app:foo')]
+            class FooCommand
+            {
+            }
+
+            class Helper
+            {
+            }
+            """.trimIndent()
+        )
+
+        assertNull("Provider should not handle PHP files with multiple classes", getIconFromProvider(multipleClassesFile))
+    }
+
+    private fun getIconFromProvider(psiFile: PsiFile): Icon? {
+        PsiDocumentManager.getInstance(project).commitAllDocuments()
+        return SymfonyCommandFileIconProvider().getIcon(psiFile.virtualFile!!, 0, project)
+    }
+}