Add TestCase methods generators for test*(), setUp(), tearDown()

Author: jiripudil

resources/META-INF/plugin.xml

@@ -64,6 +64,14 @@
       <action id="TesterNewTestCase" class="cz.jiripudil.intellij.nette.tester.codeGeneration.TesterNewTestCaseAction"/>
       <add-to-group group-id="NewGroup" anchor="last"/>
     </group>
+
+    <group id="TesterGenerateGroup">
+      <action id="TesterGenerateTestMethod" class="cz.jiripudil.intellij.nette.tester.codeGeneration.TesterGenerateTestMethodAction"/>
+      <action id="TesterGenerateSetupMethod" class="cz.jiripudil.intellij.nette.tester.codeGeneration.TesterGenerateSetupMethodAction"/>
+      <action id="TesterGenerateTeardownMethod" class="cz.jiripudil.intellij.nette.tester.codeGeneration.TesterGenerateTeardownMethodAction"/>
+      <separator/>
+      <add-to-group group-id="GenerateGroup" anchor="first"/>
+    </group>
   </actions>
 
   <application-components>

src/cz/jiripudil/intellij/nette/tester/codeGeneration/TesterAbstractGenerateMethodAction.java

@@ -0,0 +1,53 @@
+package cz.jiripudil.intellij.nette.tester.codeGeneration;
+
+import com.intellij.codeInsight.CodeInsightActionHandler;
+import com.intellij.codeInsight.actions.CodeInsightAction;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.TextRange;
+import com.intellij.psi.PsiDocumentManager;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
+import com.jetbrains.php.lang.psi.PhpCodeEditUtil;
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import cz.jiripudil.intellij.nette.tester.TesterUtil;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+abstract public class TesterAbstractGenerateMethodAction extends CodeInsightAction implements CodeInsightActionHandler {
+    @NotNull
+    @Override
+    protected CodeInsightActionHandler getHandler() {
+        return this;
+    }
+
+    @Override
+    protected boolean isValidForFile(@NotNull Project project, @NotNull Editor editor, @NotNull PsiFile file) {
+        return findTestClass(editor, file) != null;
+    }
+
+    @Nullable
+    private static PhpClass findTestClass(@NotNull Editor editor, @NotNull PsiFile file) {
+        PhpClass testClass = PhpCodeEditUtil.findClassAtCaret(editor, file);
+        return testClass != null && TesterUtil.isTestClass(testClass) ? testClass : null;
+    }
+
+    @Override
+    public void invoke(@NotNull Project project, @NotNull Editor editor, @NotNull PsiFile psiFile) {
+        PhpClass phpClass = findTestClass(editor, psiFile);
+        Method method = PhpPsiElementFactory.createMethod(project, "public function testFoo(){}");
+
+        assert phpClass != null;
+
+        PsiElement element = PhpCodeEditUtil.insertClassMember(phpClass, method);
+        PsiDocumentManager.getInstance(project).doPostponedOperationsAndUnblockDocument(editor.getDocument());
+        TextRange range = element.getTextRange();
+        editor.getDocument().replaceString(range.getStartOffset(), range.getEndOffset(), "");
+        editor.getCaretModel().moveToOffset(range.getStartOffset());
+        insertMethod(project, editor);
+    }
+
+    abstract protected void insertMethod(@NotNull Project project, @NotNull Editor editor);
+}

src/cz/jiripudil/intellij/nette/tester/codeGeneration/TesterGenerateSetupMethodAction.java

@@ -0,0 +1,27 @@
+package cz.jiripudil.intellij.nette.tester.codeGeneration;
+
+import com.intellij.codeInsight.template.Template;
+import com.intellij.codeInsight.template.TemplateManager;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.openapi.project.Project;
+import org.jetbrains.annotations.NotNull;
+
+public class TesterGenerateSetupMethodAction extends TesterAbstractGenerateMethodAction {
+    public TesterGenerateSetupMethodAction() {
+        getTemplatePresentation().setText("TestCase setUp() method");
+        getTemplatePresentation().setDescription("Creates a Nette Tester setUp() method");
+    }
+
+    @Override
+    protected void insertMethod(@NotNull Project project, @NotNull Editor editor) {
+        Template template = TemplateManager.getInstance(project).createTemplate("", "");
+        template.addTextSegment("protected function setUp()\n{\n");
+        template.addTextSegment("parent::setUp();\n");
+        template.addEndVariable();
+        template.addTextSegment("\n}");
+        template.setToIndent(true);
+        template.setToReformat(true);
+        template.setToShortenLongNames(true);
+        TemplateManager.getInstance(project).startTemplate(editor, template, null);
+    }
+}

src/cz/jiripudil/intellij/nette/tester/codeGeneration/TesterGenerateTeardownMethodAction.java

@@ -0,0 +1,27 @@
+package cz.jiripudil.intellij.nette.tester.codeGeneration;
+
+import com.intellij.codeInsight.template.Template;
+import com.intellij.codeInsight.template.TemplateManager;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.openapi.project.Project;
+import org.jetbrains.annotations.NotNull;
+
+public class TesterGenerateTeardownMethodAction extends TesterAbstractGenerateMethodAction {
+    public TesterGenerateTeardownMethodAction() {
+        getTemplatePresentation().setText("TestCase tearDown() method");
+        getTemplatePresentation().setDescription("Creates a Nette Tester tearDown() method");
+    }
+
+    @Override
+    protected void insertMethod(@NotNull Project project, @NotNull Editor editor) {
+        Template template = TemplateManager.getInstance(project).createTemplate("", "");
+        template.addTextSegment("protected function tearDown()\n{\n");
+        template.addTextSegment("parent::tearDown();\n");
+        template.addEndVariable();
+        template.addTextSegment("\n}");
+        template.setToIndent(true);
+        template.setToReformat(true);
+        template.setToShortenLongNames(true);
+        TemplateManager.getInstance(project).startTemplate(editor, template, null);
+    }
+}

src/cz/jiripudil/intellij/nette/tester/codeGeneration/TesterGenerateTestMethodAction.java

@@ -0,0 +1,42 @@
+package cz.jiripudil.intellij.nette.tester.codeGeneration;
+
+import com.intellij.codeInsight.template.Expression;
+import com.intellij.codeInsight.template.Template;
+import com.intellij.codeInsight.template.TemplateManager;
+import com.intellij.codeInsight.template.impl.ConstantNode;
+import com.intellij.openapi.editor.Editor;
+import com.intellij.openapi.project.Project;
+import com.jetbrains.php.config.PhpLanguageFeature;
+import com.jetbrains.php.config.PhpLanguageLevel;
+import com.jetbrains.php.config.PhpProjectConfigurationFacade;
+import org.jetbrains.annotations.NotNull;
+
+public class TesterGenerateTestMethodAction extends TesterAbstractGenerateMethodAction {
+    public TesterGenerateTestMethodAction() {
+        getTemplatePresentation().setText("TestCase test method");
+        getTemplatePresentation().setDescription("Creates a Nette Tester test method");
+    }
+
+    @Override
+    protected void insertMethod(@NotNull Project project, @NotNull Editor editor) {
+        Template template = TemplateManager.getInstance(project).createTemplate("", "");
+        template.addTextSegment("public function test");
+
+        Expression nameExpr = new ConstantNode("");
+        template.addVariable("name", nameExpr, nameExpr, true);
+        template.addTextSegment("()");
+
+        PhpLanguageLevel languageLevel = PhpProjectConfigurationFacade.getInstance(project).getLanguageLevel();
+        if (languageLevel.hasFeature(PhpLanguageFeature.RETURN_VOID)) {
+            template.addTextSegment(": void");
+        }
+
+        template.addTextSegment("\n{\n");
+        template.addEndVariable();
+        template.addTextSegment("\n}");
+        template.setToIndent(true);
+        template.setToReformat(true);
+        template.setToShortenLongNames(true);
+        TemplateManager.getInstance(project).startTemplate(editor, template, null);
+    }
+}