provide a line marker to navigate to a related test classes, based on the naming Haehnchen#16

Author: Haehnchen

src/main/java/de/espend/idea/php/phpunit/linemarker/RelatedTestCaseLineMarkerProvider.java

@@ -0,0 +1,109 @@
+package de.espend.idea.php.phpunit.linemarker;
+
+import com.intellij.codeInsight.daemon.LineMarkerInfo;
+import com.intellij.codeInsight.daemon.LineMarkerProvider;
+import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
+import com.intellij.psi.PsiElement;
+import com.jetbrains.php.PhpIcons;
+import com.jetbrains.php.PhpIndex;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.php.phpunit.PhpUnitUtil;
+import de.espend.idea.php.phpunit.utils.PhpElementsUtil;
+import org.apache.commons.lang.StringUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.*;
+
+/**
+ * Attach a test class to a given class name
+ *
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ */
+public class RelatedTestCaseLineMarkerProvider implements LineMarkerProvider {
+ @Nullable
+ @Override
+ public LineMarkerInfo getLineMarkerInfo(@NotNull PsiElement element) {
+ return null;
+ }
+
+ @Override
+ public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNull Collection<LineMarkerInfo> result) {
+ // we need project element; so get it from first item
+ if(psiElements.size() == 0) {
+ return;
+ }
+
+ for(PsiElement psiElement: psiElements) {
+ if (PhpElementsUtil.getClassNamePattern().accepts(psiElement)) {
+ result.addAll(visitClassName(psiElement));
+ }
+ }
+ }
+
+ private Collection<LineMarkerInfo> visitClassName(@NotNull PsiElement psiElement) {
+ PsiElement phpClass = psiElement.getContext();
+ if (!(phpClass instanceof PhpClass) || PhpUnitUtil.isTestClass((PhpClass) phpClass)) {
+ return Collections.emptyList();
+ }
+
+ String className = StringUtils.stripStart(((PhpClass) phpClass).getPresentableFQN(), "\\");
+
+ Collection<String> testClasses = getTestClassesViaPath(className);
+ if (testClasses.size() == 0) {
+ return Collections.emptyList();
+ }
+
+ PhpIndex instance = PhpIndex.getInstance(psiElement.getProject());
+
+ Set<PhpClass> phpClasses = new HashSet<>();
+ for (String testClass : testClasses) {
+ Collection<PhpClass> anyByFQN = instance.getAnyByFQN("\\" + testClass);
+ for (PhpClass aClass : anyByFQN) {
+ if (PhpUnitUtil.isTestClass(aClass)) {
+ phpClasses.add(aClass);
+ }
+ }
+ }
+
+ if (phpClasses.size() == 0) {
+ return Collections.emptyList();
+ }
+
+ NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.PHP_TEST_CLASS)
+ .setTargets(phpClasses)
+ .setTooltipText("Navigate to Test Class");
+
+ return Collections.singletonList(builder.createLineMarkerInfo(psiElement));
+ }
+
+ /**
+ * Try you find a test class which based on the class namespace
+ *
+ * Extend class name with a test namespace in between:
+ * - App\Foobar => App\FoobarTest
+ * - App\Foobar => App\Test\FoobarTest
+ * - App\Foobar => App\Tests\FoobarTest
+ * - App\Foobar => Test\App\FoobarTest
+ */
+ @NotNull
+ private static Collection<String> getTestClassesViaPath(@NotNull String className) {
+ List<String> classNameParts = Arrays.asList(className.split("\\\\"));
+
+ classNameParts.set(classNameParts.size() - 1, classNameParts.get(classNameParts.size() - 1) + "Test");
+
+ Collection<String> testClasses = new HashSet<>();
+ testClasses.add(className + "Test");
+ for (int i = 0; i < classNameParts.size(); i++) {
+ List<String> strings = new ArrayList<>(classNameParts);
+ strings.add(i, "Test");
+ testClasses.add(StringUtils.join(strings, "\\"));
+
+ List<String> strings2 = new ArrayList<>(classNameParts);
+ strings2.add(i, "Tests");
+ testClasses.add(StringUtils.join(strings2, "\\"));
+ }
+
+ return testClasses;
+ }
+}

src/main/java/de/espend/idea/php/phpunit/utils/PhpElementsUtil.java

@@ -1,10 +1,15 @@
 package de.espend.idea.php.phpunit.utils;
 
+import com.intellij.patterns.PlatformPatterns;
+import com.intellij.patterns.PsiElementPattern;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiReference;
+import com.intellij.psi.PsiWhiteSpace;
 import com.intellij.psi.ResolveResult;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.codeInsight.PhpCodeInsightUtil;
+import com.jetbrains.php.lang.PhpLanguage;
+import com.jetbrains.php.lang.lexer.PhpTokenTypes;
 import com.jetbrains.php.lang.psi.elements.*;
 import com.jetbrains.php.lang.psi.resolve.types.PhpType;
 import com.jetbrains.php.refactoring.PhpAliasImporter;
@@ -181,4 +186,18 @@ public static String insertUseIfNecessary(@NotNull PsiElement scope, @NotNull St
 
  return null;
  }
+
+ /**
+ * class "Foo" extends
+ */
+ static public PsiElementPattern.Capture<PsiElement> getClassNamePattern() {
+ return PlatformPatterns
+ .psiElement(PhpTokenTypes.IDENTIFIER)
+ .afterLeafSkipping(
+ PlatformPatterns.psiElement(PsiWhiteSpace.class),
+ PlatformPatterns.psiElement(PhpTokenTypes.kwCLASS)
+ )
+ .withParent(PhpClass.class)
+ .withLanguage(PhpLanguage.INSTANCE);
+ }
 }

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

@@ -65,6 +65,8 @@
 
  <psi.referenceContributor language="PHP" implementation="com.phpuaca.reference.StringReferenceContributor"/>
 
+ <codeInsight.lineMarkerProvider language="PHP" implementationClass="de.espend.idea.php.phpunit.linemarker.RelatedTestCaseLineMarkerProvider"/>
+
  <intentionAction>
  <className>de.espend.idea.php.phpunit.intention.TestRunIntentionAction</className>
  <category>PHPUnit</category>

src/test/java/de/espend/idea/php/phpunit/tests/PhpUnitLightCodeInsightFixtureTestCase.java

@@ -52,7 +52,7 @@ public void assertLineMarker(@NotNull PsiElement psiElement, @NotNull LineMarker
 
  final List<PsiElement> elements = collectPsiElementsRecursive(psiElement);
 
- for (LineMarkerProvider lineMarkerProvider : LineMarkerProviders.INSTANCE.allForLanguage(psiElement.getLanguage())) {
+ for (LineMarkerProvider lineMarkerProvider : LineMarkerProviders.getInstance().allForLanguage(psiElement.getLanguage())) {
  Collection<LineMarkerInfo> lineMarkerInfos = new ArrayList<LineMarkerInfo>();
  lineMarkerProvider.collectSlowLineMarkers(elements, lineMarkerInfos);
 

src/test/java/de/espend/idea/php/phpunit/tests/linemarker/RelatedTestCaseLineMarkerProviderTest.java

@@ -0,0 +1,29 @@
+package de.espend.idea.php.phpunit.tests.linemarker;
+
+import com.intellij.psi.PsiFile;
+import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
+import de.espend.idea.php.phpunit.tests.PhpUnitLightCodeInsightFixtureTestCase;
+
+/**
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ * @see de.espend.idea.php.phpunit.linemarker.RelatedTestCaseLineMarkerProvider
+ */
+public class RelatedTestCaseLineMarkerProviderTest extends PhpUnitLightCodeInsightFixtureTestCase {
+ public void setUp() throws Exception {
+ super.setUp();
+ myFixture.copyFileToProject("RelatedTestCaseLineMarkerProvider.php");
+ }
+
+ public String getTestDataPath() {
+ return "src/test/java/de/espend/idea/php/phpunit/tests/linemarker/fixtures";
+ }
+
+ public void testThatClassNameProvidesALineMarkerToItsTestCase() {
+ PsiFile psiFileFromText = PhpPsiElementFactory.createPsiFileFromText(getProject(), "<?php\n" +
+ "namespace Foo\\Bar\\Car;\n" +
+ "class Foobar {}\n"
+ );
+
+ assertLineMarker(psiFileFromText, new LineMarker.ToolTipEqualsAssert("Navigate to Test Class"));
+ }
+}

src/test/java/de/espend/idea/php/phpunit/tests/linemarker/fixtures/RelatedTestCaseLineMarkerProvider.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Foo\Test\Bar\Car
+{
+ use PHPUnit\Framework\TestCase;
+
+ class FoobarTest extends TestCase
+ {
+ }
+}
+
+namespace PHPUnit\Framework
+{
+ abstract class TestCase
+ {
+ }
+}