#41: Support for proto file renames

Rename refactoring for proto files:

- When one renames proto file, all related import statements should
  be updated.
- When one renames folder where proto files are located, all related
  import statements should be updated.
- When one presses Ctrl+F6 and renames proto file from import
  statement (in-place), file should be renamed.

Fixes #32

Author: kshchepanovskyi

src/main/java/io/protostuff/jetbrains/plugin/ProtoParserDefinition.java

@@ -297,6 +297,12 @@ protected ParseTree parse(Parser parser, IElementType root) {
                 if (root instanceof IFileElementType) {
                     return ((ProtoParser) parser).proto();
                 }
+                if (root instanceof RuleIElementType) {
+                    RuleIElementType type = (RuleIElementType) root;
+                    if (ProtoParserDefinition.rule(ProtoParser.RULE_fileReference).equals(type)) {
+                        return ((ProtoParser) parser).fileReference();
+                    }
+                }
                 // let's hope it's an ID as needed by "rename function"
                 throw new UnsupportedOperationException();
                 // return ((ProtoParser) parser).name();

src/main/java/io/protostuff/jetbrains/plugin/psi/FileReferenceNode.java

@@ -112,4 +112,5 @@ private String getFilename() {
         }
         return Util.removeFirstAndLastChar(text);
     }
+
 }

src/main/java/io/protostuff/jetbrains/plugin/psi/ProtoPsiFileRoot.java

@@ -1,5 +1,6 @@
 package io.protostuff.jetbrains.plugin.psi;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.intellij.extapi.psi.PsiFileBase;
 import com.intellij.openapi.fileTypes.FileType;
 import com.intellij.openapi.vfs.VirtualFile;
@@ -76,7 +77,8 @@ public Collection<ProtoType> getAllTypes() {
         return Collections.emptyList();
     }
 
-    private ProtoRootNode getProtoRoot() {
+    @VisibleForTesting
+    public ProtoRootNode getProtoRoot() {
         return findChildByClass(ProtoRootNode.class);
     }
 

src/main/java/io/protostuff/jetbrains/plugin/psi/manipulator/FileReferenceNodeManipulator.java

@@ -0,0 +1,40 @@
+package io.protostuff.jetbrains.plugin.psi.manipulator;
+
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.TextRange;
+import com.intellij.psi.AbstractElementManipulator;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFileFactory;
+import com.intellij.psi.impl.PsiFileFactoryImpl;
+import com.intellij.util.IncorrectOperationException;
+import io.protostuff.compiler.parser.ProtoParser;
+import io.protostuff.jetbrains.plugin.ProtoLanguage;
+import io.protostuff.jetbrains.plugin.ProtoParserDefinition;
+import io.protostuff.jetbrains.plugin.psi.FileReferenceNode;
+import org.antlr.jetbrains.adapter.lexer.RuleIElementType;
+import org.antlr.jetbrains.adapter.psi.ScopeNode;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * File reference node manipulator. Use for changing text of import nodes when
+ * renaming proto files.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class FileReferenceNodeManipulator extends AbstractElementManipulator<FileReferenceNode> {
+
+    @Override
+    public FileReferenceNode handleContentChange(@NotNull FileReferenceNode fileReferenceNode, @NotNull TextRange range, String newContent) throws IncorrectOperationException {
+        String oldText = fileReferenceNode.getText();
+        String newText = oldText.substring(0, range.getStartOffset()) + newContent + oldText.substring(range.getEndOffset());
+        Project project = fileReferenceNode.getProject();
+        PsiFileFactoryImpl factory = (PsiFileFactoryImpl) PsiFileFactory.getInstance(project);
+        RuleIElementType type = ProtoParserDefinition.rule(ProtoParser.RULE_fileReference);
+        ScopeNode context = fileReferenceNode.getContext();
+        PsiElement newNode = factory.createElementFromText(newText, ProtoLanguage.INSTANCE, type, context);
+        if (newNode == null) {
+            throw new IncorrectOperationException();
+        }
+        return (FileReferenceNode) fileReferenceNode.replace(newNode);
+    }
+}

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

@@ -139,6 +139,10 @@
         <gotoClassContributor
                 implementation="io.protostuff.jetbrains.plugin.GoToClassContributor"/>
 
+        <lang.elementManipulator
+            forClass="io.protostuff.jetbrains.plugin.psi.FileReferenceNode"
+            implementationClass="io.protostuff.jetbrains.plugin.psi.manipulator.FileReferenceNodeManipulator"/>
+
     </extensions>
 
     <actions>

src/test/java/io/protostuff/jetbrains/plugin/rename/RenameImportedProtoTest.java

@@ -0,0 +1,44 @@
+package io.protostuff.jetbrains.plugin.rename;
+
+import com.intellij.openapi.extensions.Extensions;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
+import com.intellij.refactoring.rename.RenameProcessor;
+import com.intellij.refactoring.rename.naming.AutomaticRenamerFactory;
+import com.intellij.testFramework.fixtures.LightCodeInsightFixtureTestCase;
+import io.protostuff.jetbrains.plugin.psi.ProtoPsiFileRoot;
+import org.junit.Assert;
+
+/**
+ * Tests for rename refactoring - proto file rename.
+ *
+ * @author Kostiantyn Shchepanovskyi
+ */
+public class RenameImportedProtoTest extends LightCodeInsightFixtureTestCase {
+
+    @Override
+    protected String getTestDataPath() {
+        return "src/test/resources/";
+    }
+
+    public void testRenameImportedProtoAtCaretPosition() {
+        PsiFile[] files = myFixture.configureByFiles(
+                "rename/import/import.proto",
+                "rename/import/source.proto"
+        );
+
+        PsiElement elementAtCaret = myFixture.getElementAtCaret();
+        Project project = myFixture.getProject();
+        RenameProcessor processor = new RenameProcessor(project, elementAtCaret, "renamed.proto", false, false);
+        for (AutomaticRenamerFactory factory : Extensions.getExtensions(AutomaticRenamerFactory.EP_NAME)) {
+            processor.addRenamerFactory(factory);
+        }
+        processor.run();
+
+        Assert.assertEquals("renamed.proto", files[0].getName());
+        Assert.assertEquals("import \"rename/import/renamed.proto\";",
+                ((ProtoPsiFileRoot) files[1]).getProtoRoot().getImports().get(0).getText());
+    }
+
+}

src/test/resources/rename/import/import.proto

@@ -0,0 +1,3 @@
+syntax = "proto2";
+
+package rename.import;

src/test/resources/rename/import/source.proto

@@ -0,0 +1,5 @@
+syntax = "proto2";
+
+package rename.import;
+
+import "rename/import/impo<caret>rt.proto";