Skip to content

provide incomplete named argument complete for yaml with: "tagged_iterator", dotenv, service names and parameters #1972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 22, 2022
Merged

provide incomplete named argument complete for yaml with: "tagged_iterator", dotenv, service names and parameters #1972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 138 additions & 11 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlCompletionContributor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package fr.adrienbrault.idea.symfony2plugin.config.yaml;

import com.intellij.codeInsight.completion.*;
import com.intellij.codeInsight.lookup.LookupElement;
import com.intellij.codeInsight.lookup.LookupElementBuilder;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.vfs.VfsUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.openapi.vfs.VirtualFileVisitor;
Expand All @@ -14,14 +16,19 @@
import com.intellij.util.ProcessingContext;
import com.jetbrains.php.completion.PhpLookupElement;
import com.jetbrains.php.lang.psi.elements.Method;
import com.jetbrains.php.lang.psi.elements.Parameter;
import com.jetbrains.php.lang.psi.elements.ParameterList;
import com.jetbrains.php.lang.psi.elements.PhpClass;
import com.jetbrains.php.lang.psi.resolve.types.PhpType;
import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
import fr.adrienbrault.idea.symfony2plugin.config.component.ParameterLookupElement;
import fr.adrienbrault.idea.symfony2plugin.config.doctrine.DoctrineStaticTypeLookupBuilder;
import fr.adrienbrault.idea.symfony2plugin.config.yaml.completion.ConfigCompletionProvider;
import fr.adrienbrault.idea.symfony2plugin.dic.ContainerParameter;
import fr.adrienbrault.idea.symfony2plugin.dic.ServiceCompletionProvider;
import fr.adrienbrault.idea.symfony2plugin.dic.container.dict.ServiceTypeHint;
import fr.adrienbrault.idea.symfony2plugin.dic.container.suggestion.utils.ServiceSuggestionUtil;
import fr.adrienbrault.idea.symfony2plugin.dic.container.util.DotEnvUtil;
import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
import fr.adrienbrault.idea.symfony2plugin.doctrine.DoctrineYamlAnnotationLookupBuilder;
Expand All @@ -33,6 +40,7 @@
import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
import fr.adrienbrault.idea.symfony2plugin.util.SimilarSuggestionUtil;
import fr.adrienbrault.idea.symfony2plugin.util.SymfonyBundleFileCompletionProvider;
import fr.adrienbrault.idea.symfony2plugin.util.completion.EventCompletionProvider;
import fr.adrienbrault.idea.symfony2plugin.util.completion.PhpClassAndParameterCompletionProvider;
Expand All @@ -48,12 +56,10 @@
import org.jetbrains.yaml.psi.YAMLKeyValue;
import org.jetbrains.yaml.psi.YAMLScalar;

import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

/**
* @author Daniel Espendiller <daniel@espendiller.net>
Expand Down Expand Up @@ -408,22 +414,143 @@ private static class NamedArgumentCompletionProvider extends CompletionProvider<
protected void addCompletions(@NotNull CompletionParameters parameters, @NotNull ProcessingContext context, @NotNull CompletionResultSet result) {
HashSet<String> uniqueParameters = new HashSet<>();

ServiceContainerUtil.visitNamedArguments(parameters.getPosition().getContainingFile(), parameter -> {
String name = parameter.getName();
if (uniqueParameters.contains(name)) {
PsiElement position = parameters.getPosition();
boolean hasEmptyNextElement = position.getNextSibling() == null;

ServiceContainerUtil.visitNamedArguments(position.getContainingFile(), pair -> {
Parameter parameter = pair.getFirst();
String parameterName = parameter.getName();
if (uniqueParameters.contains(parameterName)) {
return;
}

uniqueParameters.add(name);
uniqueParameters.add(parameterName);

// create argument for yaml: $parameter
result.addElement(
LookupElementBuilder.create("$" + name)
.withIcon(parameter.getIcon())
.withTypeText(StringUtils.stripStart(parameter.getType().toString(), "\\"), true)
LookupElementBuilder.create("$" + parameterName)
.withIcon(parameter.getIcon())
.withTypeText(StringUtils.stripStart(parameter.getType().toString(), "\\"))
);

if (hasEmptyNextElement) {
// iterable $handlers => can also provide "!tagged_iterator"
if (parameter.getType().getTypes().stream().anyMatch(s -> s.equalsIgnoreCase(PhpType._ITERABLE))) {
LookupElementBuilder element = LookupElementBuilder.create("$" + parameterName + ": !tagged_iterator")
.withIcon(parameter.getIcon())
.withTypeText(StringUtils.stripStart(parameter.getType().toString(), "\\"), true);

result.addElement(PrioritizedLookupElement.withPriority(element, -1000));
}

if (!parameter.getType().getTypes().stream().allMatch(PhpType::isPrimitiveType)) {
// $foobar: '@service'
result.addAllElements(getServiceSuggestion(position, pair, parameterName, new ContainerCollectionResolver.LazyServiceCollector(position.getProject())));
} else {
String parameterNormalized = parameterName.toLowerCase(Locale.ROOT).replaceAll("[^a-z0-9]", "");
if (parameterNormalized.length() > 5) {
// $projectDir: '%kernel.project_dir%'
result.addAllElements(getParameterSuggestion(parameter, parameterName, parameterNormalized));

// $kernelClass: '%env(KERNEL_CLASS)%'
result.addAllElements(getDotEnvSuggestion(parameter, parameterName, parameterNormalized));
}
}
}
});
}

@NotNull
private Collection<LookupElement> getServiceSuggestion(@NotNull PsiElement position, @NotNull Pair<Parameter, Integer> pair, @NotNull String parameterName, @NotNull ContainerCollectionResolver.LazyServiceCollector lazyServiceCollector) {
Parameter parameter = pair.getFirst();

PsiElement parameterList = parameter.getParent();
if (parameterList instanceof ParameterList) {
PsiElement parent = parameterList.getParent();
if (parent instanceof Method) {
Collection<String> suggestions = new ArrayList<>(ServiceSuggestionUtil.createSuggestions(new ServiceTypeHint(
(Method) parent,
pair.getSecond(),
position
), lazyServiceCollector.getCollector().getServices().values()));

return suggestions.stream()
.limit(3)
.map(service -> {
LookupElementBuilder element = LookupElementBuilder.create(String.format("$%s: '@%s'", parameterName, service))
.withIcon(Symfony2Icons.SERVICE)
.withTypeText(StringUtils.stripStart(parameter.getType().toString(), "\\"), true);

return PrioritizedLookupElement.withPriority(element, -1000);
})
.collect(Collectors.toList());
}
}

return Collections.emptyList();
}

/**
* $projectDir: '%kernel.project_dir%'
*/
private Collection<LookupElement> getParameterSuggestion(@NotNull Parameter parameter, @NotNull String parameterName, @NotNull String parameterNormalized) {
Set<String> values = new HashSet<>();

for (String name : ContainerCollectionResolver.getParameterNames(parameter.getProject())) {
String symfonyParameterNormalized = name.toLowerCase(Locale.ROOT).replaceAll("[^a-z0-9]", "");

if (symfonyParameterNormalized.contains(parameterNormalized)) {
values.add(name);
}
}

// weight items: append all indirect matched, after them in case there they are not similar
List<String> similarString = new ArrayList<>(SimilarSuggestionUtil.findSimilarString(parameterNormalized, values));
similarString.addAll(values);

return similarString.stream()
.distinct()
.limit(3)
.map(service -> {
LookupElementBuilder element = LookupElementBuilder.create("$" + parameterName + ": '%" + service + "%'")
.withIcon(Symfony2Icons.PARAMETER)
.withTypeText(StringUtils.stripStart(parameter.getType().toString(), "\\"), true);

return PrioritizedLookupElement.withPriority(element, -1000);
})
.collect(Collectors.toList());
}

/**
* "$kernelClass: '%env(KERNEL_CLASS)%'"
*/
@NotNull
private Collection<LookupElement> getDotEnvSuggestion(@NotNull Parameter parameter, @NotNull String parameterName, @NotNull String parameterNormalized) {
Set<String> dotEnv = new HashSet<>();
for (String name : DotEnvUtil.getEnvironmentVariables(parameter.getProject())) {
String symfonyParameterNormalized = name.toLowerCase(Locale.ROOT).replaceAll("[^a-z0-9]", "");

if (symfonyParameterNormalized.contains(parameterNormalized)) {
dotEnv.add(name);
}
}

// weight items: append all indirect matched, after them in case there they are not similar
List<String> similarString = new ArrayList<>(SimilarSuggestionUtil.findSimilarString(parameterNormalized, dotEnv));
similarString.addAll(dotEnv);

return similarString.stream()
.distinct()
.limit(3)
.map(service -> {
LookupElementBuilder element = LookupElementBuilder.create("$" + parameterName + ": '%env(" + service + ")%'")
.withIcon(Symfony2Icons.PARAMETER)
.withTypeText(StringUtils.stripStart(parameter.getType().toString(), "\\"), true);

return PrioritizedLookupElement.withPriority(element, -1000);
})
.collect(Collectors.toList());
}
}

/**
Expand Down
3 changes: 2 additions & 1 deletion ...main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToDeclarationHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,8 @@ private Collection<? extends PsiElement> namedDefaultBindArgumentGoto(@NotNull P
Collection<PsiElement> psiElements = new HashSet<>();

String argumentWithoutDollar = parameterName.substring(1);
ServiceContainerUtil.visitNamedArguments(psiElement.getContainingFile(), parameter -> {
ServiceContainerUtil.visitNamedArguments(psiElement.getContainingFile(), pair -> {
Parameter parameter = pair.getFirst();
if (parameter.getName().equals(argumentWithoutDollar)) {
psiElements.add(parameter);
}
Expand Down
17 changes: 13 additions & 4 deletions ...ain/java/fr/adrienbrault/idea/symfony2plugin/dic/container/util/ServiceContainerUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Key;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.vfs.VfsUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.patterns.PlatformPatterns;
Expand Down Expand Up @@ -594,9 +595,9 @@ public static boolean hasMissingYamlNamedArgumentForInspection(@NotNull PsiEleme
* arguments:
* $<caret>
*/
public static void visitNamedArguments(@NotNull PsiFile psiFile, @NotNull Consumer<Parameter> processor) {
public static void visitNamedArguments(@NotNull PsiFile psiFile, @NotNull Consumer<Pair<Parameter, Integer>> processor) {
if (psiFile instanceof YAMLFile) {
Collection<Parameter> parameters = new HashSet<>();
Collection<Pair<Parameter, Integer>> parameters = new HashSet<>();

// direct service definition
for (PhpClass phpClass : YamlHelper.getPhpClassesInYamlFile((YAMLFile) psiFile, new ContainerCollectionResolver.LazyServiceCollector(psiFile.getProject()))) {
Expand All @@ -605,7 +606,10 @@ public static void visitNamedArguments(@NotNull PsiFile psiFile, @NotNull Consum
continue;
}

parameters.addAll(Arrays.asList(constructor.getParameters()));
Parameter @NotNull [] methodParameters = constructor.getParameters();
for (int i = 0, methodParametersLength = methodParameters.length; i < methodParametersLength; i++) {
parameters.add(Pair.create(methodParameters[i], i));
}
}

for (YAMLKeyValue taggedService : YamlHelper.getTaggedServices((YAMLFile) psiFile, "controller.service_arguments")) {
Expand All @@ -627,7 +631,12 @@ public static void visitNamedArguments(@NotNull PsiFile psiFile, @NotNull Consum
// maybe filter actions and public methods in a suitable way?
phpClass.getMethods().stream()
.filter(method -> method.getAccess().isPublic() && !method.getName().startsWith("set"))
.forEach(method -> Collections.addAll(parameters, method.getParameters()));
.forEach(method -> {
Parameter @NotNull [] methodParameters = method.getParameters();
for (int i = 0, methodParametersLength = methodParameters.length; i < methodParametersLength; i++) {
parameters.add(Pair.create(methodParameters[i], i));
}
});
}
}

Expand Down
1 change: 0 additions & 1 deletion src/main/java/fr/adrienbrault/idea/symfony2plugin/ui/MethodSignatureTypeSettingsForm.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.List;

/**
* @author Daniel Espendiller <daniel@espendiller.net>
Expand Down
32 changes: 32 additions & 0 deletions .../fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/YamlCompletionContributorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,5 +316,37 @@ public void testNamedArgumentCompletionForServiceArguments() {
" $<caret>: ~\n",
"$i"
);

assertCompletionContains(YAMLFileType.YML, "" +
"services:\n" +
" Foo\\Car:\n" +
" arguments:\n" +
" $myDateT<caret>ime\n",
"$myDateTime: '@foo'"
);

assertCompletionNotContains(YAMLFileType.YML, "" +
"services:\n" +
" Foo\\Car:\n" +
" arguments:\n" +
" $myDateT<caret>ime: ~\n",
"$myDateTime: '@foo'"
);

assertCompletionContains(YAMLFileType.YML, "" +
"services:\n" +
" Foo\\Car:\n" +
" arguments:\n" +
" $foobarEn<caret>v\n",
"$foobarEnv: '%env(FOOBAR_ENV)%'"
);

assertCompletionContains(YAMLFileType.YML, "" +
"services:\n" +
" Foo\\Car:\n" +
" arguments:\n" +
" $project<caret>Dir\n",
"$projectDir: '%kernel.project_dir%'"
);
}
}
7 changes: 7 additions & 0 deletions src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/fixtures/classes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,11 @@ class Apple
{
function __construct($i, $z = null) { }
}

class Car
{
function __construct(\string $projectDir, \string $foobarEnv, \MyDateTime $myDateTime)
{
}
}
}
1 change: 1 addition & 0 deletions src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/fixtures/services.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<parameters>
<parameter key="foo_parameter">bar</parameter>
<parameter key="kernel.project_dir">project_dir</parameter>
</parameters>

<services>
Expand Down
2 changes: 1 addition & 1 deletion ...r/adrienbrault/idea/symfony2plugin/tests/dic/container/util/ServiceContainerUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ public void testVisitNamedArguments() {
);

Collection<String> arguments = new HashSet<>();
ServiceContainerUtil.visitNamedArguments(psiFile, parameter -> arguments.add(parameter.getName()));
ServiceContainerUtil.visitNamedArguments(psiFile, parameter -> arguments.add(parameter.getFirst().getName()));

assertTrue(arguments.contains("foobar"));

Expand Down