Merge pull request Haehnchen#1496 from Haehnchen/feature/autowrite-constructor-linemarker

provide linemarker for a constructor which supports autowire

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/config/ServiceLineMarkerProvider.java

@@ -4,6 +4,7 @@
 import com.intellij.codeInsight.daemon.LineMarkerProvider;
 import com.intellij.codeInsight.daemon.RelatedItemLineMarkerInfo;
 import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
+import com.intellij.icons.AllIcons;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.NotNullLazyValue;
 import com.intellij.openapi.util.Pair;
@@ -76,6 +77,10 @@ public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNu
  this.constraintValidatorClassMarker(psiElement, results);
  }
 
+ if(PhpElementsUtil.getClassMethodNamePattern().accepts(psiElement)) {
+ this.autowireConstructorMarker(psiElement, results);
+ }
+
  if(psiElement instanceof PhpFile) {
  routeAnnotationFileResource((PhpFile) psiElement, results);
  }
@@ -307,10 +312,70 @@ private void constraintValidatorClassMarker(PsiElement psiElement, Collection<Li
  results.add(builder.createLineMarkerInfo(psiElement));
  }
 
+ private void autowireConstructorMarker(PsiElement psiElement, Collection<LineMarkerInfo> results) {
+ PsiElement method = psiElement.getParent();
+ if (!(method instanceof Method)) {
+ return;
+ }
+
+ if (!"__construct".equals(((Method) method).getName())) {
+ return;
+ }
+
+ PhpClass phpClass = ((Method) method).getContainingClass();
+ if (phpClass == null) {
+ return;
+ }
+
+ boolean isAutowire = false;
+
+ Pair<ClassServiceDefinitionTargetLazyValue, Collection<ContainerService>> serviceDefinitionsOfResource = ServiceIndexUtil.findServiceDefinitionsOfResourceLazy(phpClass);
+ if (serviceDefinitionsOfResource != null) {
+ for (ContainerService containerService : serviceDefinitionsOfResource.getSecond()) {
+ ServiceInterface service = containerService.getService();
+ if (service == null) {
+ continue;
+ }
+
+ if (service.isAutowire()) {
+ isAutowire = true;
+ break;
+ }
+ }
+ }
+
+ // direct service
+ if (!isAutowire) {
+ ContainerCollectionResolver.ServiceCollector serviceCollector = ContainerCollectionResolver.ServiceCollector.create(phpClass.getProject());
+ for (String convertClassNameToService : serviceCollector.convertClassNameToServices(phpClass.getFQN())) {
+ ContainerService containerService = serviceCollector.getServices().get(convertClassNameToService);
+ if (containerService == null) {
+ continue;
+ }
+
+ ServiceInterface service = containerService.getService();
+ if (service != null && service.isAutowire()) {
+ isAutowire = true;
+ break;
+ }
+ }
+ }
+
+ if (!isAutowire) {
+ return;
+ }
+
+ NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(AllIcons.Nodes.Plugin)
+ .setTargets(new MyCollectionNotNullLazyValue(Collections.emptyList()))
+ .setTooltipText("Symfony: <a href=\"https://symfony.com/doc/current/service_container/autowiring.html\">Autowire available</a>");
+
+ results.add(builder.createLineMarkerInfo(psiElement));
+ }
+
  private static class MyCollectionNotNullLazyValue extends NotNullLazyValue<Collection<? extends PsiElement>> {
  private final Collection<ClassServiceDefinitionTargetLazyValue> targets;
 
- public MyCollectionNotNullLazyValue(Collection<ClassServiceDefinitionTargetLazyValue> targets) {
+ public MyCollectionNotNullLazyValue(@NotNull Collection<ClassServiceDefinitionTargetLazyValue> targets) {
  this.targets = targets;
  }
 

src/main/java/fr/adrienbrault/idea/symfony2plugin/util/PhpElementsUtil.java

@@ -351,6 +351,20 @@ static public PsiElementPattern.Capture<PsiElement> getClassNamePattern() {
  .withLanguage(PhpLanguage.INSTANCE);
  }
 
+ /**
+ * class Foo { function "test" {} }
+ */
+ static public PsiElementPattern.Capture<PsiElement> getClassMethodNamePattern() {
+ return PlatformPatterns
+ .psiElement(PhpTokenTypes.IDENTIFIER)
+ .afterLeafSkipping(
+ PlatformPatterns.psiElement(PsiWhiteSpace.class),
+ PlatformPatterns.psiElement(PhpTokenTypes.kwFUNCTION)
+ )
+ .withParent(Method.class)
+ .withLanguage(PhpLanguage.INSTANCE);
+ }
+
  /**
  * return 'value' inside class method
  */

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/config/ServiceLineMarkerProviderTest.java

@@ -207,4 +207,36 @@ public void testConstraintAndValidateClassLineMarker() {
  "}"
  ), new LineMarker.ToolTipEqualsAssert("Navigate to constraint"));
  }
+
+ public void testThatAutowireConstructorIsGivenALineMarker() {
+ myFixture.configureByText(YAMLFileType.YML,
+ "services:\n" +
+ " Service\\YamlBar: " +
+ " autowire: true\n\n"
+ );
+
+ assertLineMarker(PhpPsiElementFactory.createPsiFileFromText(getProject(), "<?php\n" +
+ "namespace Service {\n" +
+ " class YamlBar {\n" +
+ " function __construct() {}\n" +
+ " }\n" +
+ "}"
+ ), markerInfo -> markerInfo.getLineMarkerTooltip() != null && markerInfo.getLineMarkerTooltip().toLowerCase().contains("autowire"));
+
+ myFixture.configureByText(YAMLFileType.YML,
+ "services:\n" +
+ " _defaults:\n" +
+ " autowire: true\n" +
+ "" +
+ " Service\\YamlBarDefault: ~\n"
+ );
+
+ assertLineMarker(PhpPsiElementFactory.createPsiFileFromText(getProject(), "<?php\n" +
+ "namespace Service {\n" +
+ " class YamlBarDefault {\n" +
+ " function __construct() {}\n" +
+ " }\n" +
+ "}"
+ ), markerInfo -> markerInfo.getLineMarkerTooltip() != null && markerInfo.getLineMarkerTooltip().toLowerCase().contains("autowire"));
+ }
 }