Extend methods in PYZ

turbine-kreuzberg · Sep 6, 2024 · affa7ce · affa7ce
1 parent 9f778e9
commit affa7ce
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,13 @@
 <!-- Keep a Changelog guide -> https://keepachangelog.com -->
 # PYZ Plugin Changelog
 
+## [0.9.0] - 2024-09-06
+### Added
+- Extend methods in PYZ
+
 ## [0.8.0] - 2024-09-05
 ### Added
-- Added codeception helper navigation
+- Codeception helper navigation
 
 ## [0.7.8] - 2024-04-25
 ### Fixed

diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ A collection of little helpers that improve your daily work with Spryker.
 - Navigate from OMS XML files to included sub-processes and the definitions of commands/conditions 
 - Navigate from Twig files to included, embedded and extended files and widgets
 - Navigate from transfer object classes and instantiations to XML definitions (and vice versa)
+- Navigate from codeception.yml to helper classes
+- Extend Spryker methods on project level (right-click on method name inside Spryker core class -> Extend in PYZ)
 
 ## How to use
 - To extend files on project level, use the context menu item "Extend in PYZ". It will appear for files located in one of the Spryker vendor directories only.

diff --git a/gradle.properties b/gradle.properties
@@ -3,7 +3,7 @@
 
 pluginGroup = com.github.senordingdong.sprykerideaplugin
 pluginName = PYZ
-pluginVersion = 0.8.0
+pluginVersion = 0.9.0
 
 # See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 # for insight into build numbers and IntelliJ Platform versions.

diff --git a/src/main/java/com/turbinekreuzberg/plugins/actions/ExtendInPyzAction.java b/src/main/java/com/turbinekreuzberg/plugins/actions/ExtendInPyzAction.java
@@ -5,6 +5,7 @@
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.PlatformDataKeys;
 import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.command.WriteCommandAction;
 import com.intellij.openapi.fileEditor.OpenFileDescriptor;
 import com.intellij.openapi.fileTypes.UnknownFileType;
 import com.intellij.openapi.project.Project;
@@ -13,10 +14,14 @@
 import com.intellij.psi.*;
 import com.intellij.psi.impl.file.PsiDirectoryFactory;
 import com.jetbrains.php.lang.PhpFileType;
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.impl.MethodImpl;
 import com.turbinekreuzberg.plugins.settings.AppSettingsState;
 import com.turbinekreuzberg.plugins.utils.SprykerRelativeClassPathCreator;
 import com.turbinekreuzberg.plugins.utils.PhpContentCreator;
 import com.turbinekreuzberg.plugins.utils.GenericContentCreator;
+import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
@@ -37,24 +42,29 @@ public ExtendInPyzAction() {
     public void actionPerformed(@NotNull AnActionEvent actionEvent) {
         Project project = actionEvent.getProject();
 
+        String selectedMethod = "";
+        if (actionEvent.getData(PlatformDataKeys.PSI_ELEMENT) instanceof MethodImpl) {
+            selectedMethod = actionEvent.getData(PlatformDataKeys.PSI_ELEMENT).getText();
+        }
+
         VirtualFile[] selectedVirtualFiles = actionEvent.getData(PlatformDataKeys.VIRTUAL_FILE_ARRAY);
 
         assert selectedVirtualFiles != null;
 
         for (VirtualFile selectedVirtualFile : selectedVirtualFiles) {
-            processFile(project, selectedVirtualFile);
+            processFile(project, selectedVirtualFile, selectedMethod);
         }
     }
 
-    private void processFile(Project project, VirtualFile selectedVirtualFile) {
+    private void processFile(Project project, VirtualFile selectedVirtualFile, String method) {
         String relativeClassPath = sprykerRelativeClassPathCreator.getRelativeClassPath(selectedVirtualFile);
         String targetPath = project.getBasePath() + AppSettingsState.getInstance().pyzDirectory + relativeClassPath;
 
         PsiManager psiManager = PsiManager.getInstance(project);
         PsiFile selectedFile = psiManager.findFile(selectedVirtualFile);
 
-        String renderedContent = getRenderedContent(selectedFile, relativeClassPath);
-        PsiFile pyzFile = createFile(selectedVirtualFile, project, renderedContent);
+        String renderedContent = getRenderedContent(selectedFile, relativeClassPath, method);
+        PsiFile pyzFile = createFile(selectedVirtualFile.getName(), project, renderedContent);
 
         ApplicationManager.getApplication().runWriteAction(() -> {
             VirtualFile virtualPyzDirectory = null;
@@ -66,17 +76,35 @@ private void processFile(Project project, VirtualFile selectedVirtualFile) {
 
             if (virtualPyzDirectory != null) {
                 PsiDirectory pyzDirectory = PsiDirectoryFactory.getInstance(project).createDirectory(virtualPyzDirectory);
-                if (pyzDirectory.findFile(pyzFile.getName()) == null) {
+                PsiFile existingFile = pyzDirectory.findFile(pyzFile.getName());
+                if (existingFile == null) {
                     pyzDirectory.add(pyzFile);
+                } else if (!method.isEmpty()) {
+                    addToFile(project, method, existingFile, pyzDirectory);
                 }
+
                 findFileInDirectoryAndOpenInEditor(project, pyzDirectory, pyzFile.getName());
             }
         });
     }
 
+    private void addToFile(Project project, String method, PsiFile existingFile, PsiDirectory pyzDirectory) {
+        Method phpmethod = PhpPsiElementFactory.createMethod(project, method);
+        if (existingFile.getText().contains("function " + phpmethod.getName())) {
+            return;
+        }
+
+        ApplicationManager.getApplication().invokeLater( () -> {
+            WriteCommandAction.runWriteCommandAction(project, () -> {
+                PsiElement closingBracketPsiElement = existingFile.findElementAt(StringUtils.substringBeforeLast(existingFile.getText(), "}").length());
+                existingFile.addBefore(phpmethod, closingBracketPsiElement);
+            });
+        });
+    }
+
     private void findFileInDirectoryAndOpenInEditor(Project project, PsiDirectory pyzDirectory, String fileName) {
         PsiFile foundFile = pyzDirectory.findFile(fileName);
-        new OpenFileDescriptor(project, foundFile.getVirtualFile()).navigate(true);
+        new OpenFileDescriptor(project, foundFile.getVirtualFile(), foundFile.getFileDocument().getLineCount(), 0).navigate(true);
     }
 
     @Override
@@ -105,16 +133,16 @@ private boolean isNotFileInSprykerVendor(@NotNull VirtualFile vFile) {
     }
 
     @NotNull
-    private PsiFile createFile(@NotNull VirtualFile sourceFile, Project project, String renderedContent) {
+    private PsiFile createFile(@NotNull String fileName, Project project, String renderedContent) {
         final PsiFileFactory factory = PsiFileFactory.getInstance(project);
 
-        return factory.createFileFromText(sourceFile.getName(), PhpFileType.INSTANCE, renderedContent);
+        return factory.createFileFromText(fileName, PhpFileType.INSTANCE, renderedContent);
     }
 
     @NotNull
-    private String getRenderedContent(@NotNull PsiFile file, String relativePath) {
+    private String getRenderedContent(@NotNull PsiFile file, String relativePath, String method) {
         if (file.getFileType() == PhpFileType.INSTANCE) {
-            return new PhpContentCreator().create(file, relativePath);
+            return new PhpContentCreator().create(file, relativePath, method);
         }
 
         return new GenericContentCreator().create(file);

diff --git a/src/main/java/com/turbinekreuzberg/plugins/utils/PhpContentCreator.java b/src/main/java/com/turbinekreuzberg/plugins/utils/PhpContentCreator.java
@@ -10,7 +10,7 @@
 import java.io.InputStream;
 
 public class PhpContentCreator {
-    public String create(PsiFile file, String relativePath) {
+    public String create(PsiFile file, String relativePath, String method) {
         InputStream inputStream = ResourceUtil.getResourceAsStream(getClass().getClassLoader(), "templates", "phpClass.txt");
         String content = null;
         try {
@@ -25,6 +25,7 @@ public String create(PsiFile file, String relativePath) {
 
         contentWithClassName = contentWithClassName.replace("{{type}}", getType(file));
         contentWithClassName = contentWithClassName.replace("{{sprykerNamespace}}", sprykerNamespace);
+        contentWithClassName = contentWithClassName.replace("{{method}}", method);
 
         return contentWithClassName.replace("{{namespace}}", AppSettingsState.getInstance().pyzNamespace + "\\" + namespace);
     }

diff --git a/src/main/java/com/turbinekreuzberg/plugins/utils/PhpContentCreatorTest.java b/src/main/java/com/turbinekreuzberg/plugins/utils/PhpContentCreatorTest.java
@@ -15,7 +15,7 @@ public void testCreatePhpClass(){
         String expectedFileContent = getFileContent("ExpectedExtendedExampleFacade.php");
 
         // Act
-        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example");
+        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example", "");
 
         // Assert
         assertEquals(expectedFileContent, createdFileContent);
@@ -27,7 +27,7 @@ public void testCreatePhpInterface(){
         String expectedFileContent = getFileContent("ExpectedExtendedExampleFacadeInterface.php");
 
         // Act
-        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example");
+        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example", "");
 
         // Assert
         assertEquals(expectedFileContent, createdFileContent);
@@ -39,7 +39,7 @@ public void testCreatePhpTrait(){
         String expectedFileContent = getFileContent("ExpectedExtendedExampleTrait.php");
 
         // Act
-        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example");
+        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example", "");
 
         // Assert
         assertEquals(expectedFileContent, createdFileContent);
@@ -51,7 +51,7 @@ public void testCreatePhpAbstractClass(){
         String expectedFileContent = getFileContent("ExpectedExtendedAbstractExample.php");
 
         // Act
-        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example");
+        String createdFileContent = new PhpContentCreator().create(baseClass, "Zed/Example", "");
 
         // Assert
         assertEquals(expectedFileContent, createdFileContent);

diff --git a/src/main/resources/META-INF/change-notes.html b/src/main/resources/META-INF/change-notes.html
@@ -1,5 +1,6 @@
 <html>
 <ul>
-    <li>Added Navigation to Helper classes in codeception.yml files</li>
+    <li>Navigation to Helper classes in codeception.yml files</li>
+    <li>Extend methods in PYZ</li>
 </ul>
 </html>
diff --git a/src/main/resources/templates/phpClass.txt b/src/main/resources/templates/phpClass.txt
@@ -6,5 +6,5 @@ use {{sprykerNamespace}}\{{className}} as Spryker{{className}};
 
 {{type}} {{className}} extends Spryker{{className}}
 {
-
+    {{method}}
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,5 +6,5 @@ use {{sprykerNamespace}}\{{className}} as Spryker{{className}}; @@
     {{type}} {{className}} extends Spryker{{className}}
     {
+        {{method}}
     }