Skip to content

smarter public asset folder, fix twig form linemarker psi pattern, remove symfony check from notication window #1672

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
Jul 9, 2021
Merged

smarter public asset folder, fix twig form linemarker psi pattern, remove symfony check from notication window #1672

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
78 changes: 41 additions & 37 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/asset/AssetDirectoryReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,11 @@
import fr.adrienbrault.idea.symfony2plugin.util.dict.SymfonyBundle;
import org.apache.commons.lang.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
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 All @@ -41,30 +38,40 @@ public AssetDirectoryReader(@NotNull String[] filterExtension, boolean includeBu
this.filterExtension.addAll(Arrays.asList(filterExtension));
}

@Nullable
private static VirtualFile getProjectAssetRoot(@NotNull Project project) {
String webDirectoryName = Settings.getInstance(project).directoryToWeb;
return VfsUtil.findRelativeFile(ProjectUtil.getProjectDir(project), webDirectoryName.split("/"));
@NotNull
private static Collection<VirtualFile> getProjectAssetRoot(@NotNull Project project) {
Set<String> paths = new HashSet<>();

// custom config
String directoryToWeb = Settings.getInstance(project).directoryToWeb;
if (StringUtils.isNotBlank(directoryToWeb)) {
paths.add(directoryToWeb);
}

paths.add("public"); // latest Symfony structure
paths.add("web"); // old Symfony structure

return paths.stream()
.map(path -> VfsUtil.findRelativeFile(ProjectUtil.getProjectDir(project), path.split("/")))
.filter(Objects::nonNull)
.collect(Collectors.toSet());
}

@NotNull
public Collection<AssetFile> getAssetFiles(@NotNull Project project) {
Collection<AssetFile> files = new ArrayList<>();

VirtualFile webDirectory = getProjectAssetRoot(project);
if (null == webDirectory) {
return files;
}

VfsUtil.visitChildrenRecursively(webDirectory, new VirtualFileVisitor() {
@Override
public boolean visitFile(@NotNull VirtualFile virtualFile) {
if(isValidFile(virtualFile)) {
files.add(new AssetFile(virtualFile, AssetEnum.Position.Web, webDirectory));
for (VirtualFile webDirectory : getProjectAssetRoot(project)) {
VfsUtil.visitChildrenRecursively(webDirectory, new VirtualFileVisitor<VirtualFile>() {
@Override
public boolean visitFile(@NotNull VirtualFile virtualFile) {
if(isValidFile(virtualFile)) {
files.add(new AssetFile(virtualFile, AssetEnum.Position.Web, webDirectory));
}
return super.visitFile(virtualFile);
}
return super.visitFile(virtualFile);
}
});
});
}

if(!this.includeBundleDir) {
return files;
Expand All @@ -81,7 +88,7 @@ public boolean visitFile(@NotNull VirtualFile virtualFile) {
VirtualFile resourceDirectory = VfsUtil.findRelativeFile(bundleDirectoryVirtual, "Resources");

if (null != resourceDirectory) {
VfsUtil.visitChildrenRecursively(resourceDirectory, new VirtualFileVisitor() {
VfsUtil.visitChildrenRecursively(resourceDirectory, new VirtualFileVisitor<VirtualFile>() {
@Override
public boolean visitFile(@NotNull VirtualFile virtualFile) {
if(isValidFile(virtualFile)) {
Expand Down Expand Up @@ -139,21 +146,18 @@ public Collection<VirtualFile> resolveAssetFile(@NotNull Project project, @NotNu

Collection<VirtualFile> files = new ArrayList<>();

VirtualFile webDirectory = getProjectAssetRoot(project);
if (null == webDirectory) {
return files;
}

Matcher matcher = Pattern.compile("^(.*[/\\\\])\\*([.\\w+]*)$").matcher(assetName);
if (!matcher.find()) {
VirtualFile assetFile = VfsUtil.findRelativeFile(webDirectory, assetName.split("/"));
if(assetFile != null) {
files.add(assetFile);
for (VirtualFile webDirectory : getProjectAssetRoot(project)) {
Matcher matcher = Pattern.compile("^(.*[/\\\\])\\*([.\\w+]*)$").matcher(assetName);
if (!matcher.find()) {
VirtualFile assetFile = VfsUtil.findRelativeFile(webDirectory, assetName.split("/"));
if(assetFile != null) {
files.add(assetFile);
}
} else {
// "/*"
// "/*.js"
files.addAll(collectWildcardDirectories(matcher, webDirectory));
}
} else {
// "/*"
// "/*.js"
files.addAll(collectWildcardDirectories(matcher, webDirectory));
}

return files;
Expand Down
20 changes: 10 additions & 10 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigLineMarkerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import com.intellij.psi.PsiManager;
import com.intellij.psi.presentation.java.SymbolPresentationUtil;
import com.intellij.psi.search.GlobalSearchScope;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.util.ConstantFunction;
import com.intellij.util.indexing.FileBasedIndex;
import com.jetbrains.php.PhpIcons;
Expand All @@ -26,6 +27,9 @@
import com.jetbrains.twig.TwigFileType;
import com.jetbrains.twig.TwigTokenTypes;
import com.jetbrains.twig.elements.TwigElementTypes;
import com.jetbrains.twig.elements.TwigFieldReference;
import com.jetbrains.twig.elements.TwigPsiReference;
import com.jetbrains.twig.elements.TwigVariableReference;
import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
import fr.adrienbrault.idea.symfony2plugin.dic.RelatedPopupGotoLineMarker;
Expand Down Expand Up @@ -105,7 +109,7 @@ public void collectSlowLineMarkers(@NotNull List<? extends PsiElement> psiElemen
if(lineOverwrites != null) {
results.add(lineOverwrites);
}
} else if(TwigPattern.getFunctionPattern("form_start", "form").accepts(psiElement)) {
} else if(TwigPattern.getFunctionPattern("form_start", "form", "form_end", "form_rest").accepts(psiElement)) {
LineMarkerInfo<?> lineOverwrites = attachFormType(psiElement);
if(lineOverwrites != null) {
results.add(lineOverwrites);
Expand Down Expand Up @@ -307,17 +311,13 @@ private LineMarkerInfo<?> attachBlockOverwrites(@NotNull PsiElement psiElement,

@Nullable
private LineMarkerInfo<?> attachFormType(@NotNull PsiElement psiElement) {
PsiElement firstChild = psiElement.getFirstChild();
if (firstChild == null) {
// form(theform);
PsiElement twigFunctionParameterIdentifierPsi = TwigUtil.getTwigFunctionParameterIdentifierPsi(psiElement);
if (twigFunctionParameterIdentifierPsi == null) {
return null;
}

PsiElement nextSiblingOfType = PsiElementUtils.getNextSiblingOfType(firstChild, PlatformPatterns.psiElement().withElementType(TwigTokenTypes.IDENTIFIER).afterLeaf(PlatformPatterns.psiElement(TwigTokenTypes.LBRACE)));
if (nextSiblingOfType == null) {
return null;
}

Collection<TwigTypeContainer> twigTypeContainers = TwigTypeResolveUtil.resolveTwigMethodName(nextSiblingOfType, TwigTypeResolveUtil.formatPsiTypeNameWithCurrent(nextSiblingOfType));
Collection<TwigTypeContainer> twigTypeContainers = TwigTypeResolveUtil.resolveTwigMethodName(twigFunctionParameterIdentifierPsi, TwigTypeResolveUtil.formatPsiTypeNameWithCurrent(twigFunctionParameterIdentifierPsi));

Collection<PhpClass> phpClasses = new HashSet<>();

Expand All @@ -337,7 +337,7 @@ private LineMarkerInfo<?> attachFormType(@NotNull PsiElement psiElement) {
.setTooltipText("Navigate to Form")
.setCellRenderer(new MyBlockListCellRenderer());

return builder.createLineMarkerInfo(firstChild);
return builder.createLineMarkerInfo(psiElement.getFirstChild());
}

@Nullable
Expand Down
23 changes: 23 additions & 0 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,29 @@ public void visitElement(PsiElement element) {
return null;
}

/**
* "form(form.name)" => "form"
*/
@Nullable
public static PsiElement getTwigFunctionParameterIdentifierPsi(@NotNull PsiElement psiElement) {
// "form(form.name)" => "form"
TwigFieldReference childOfType = PsiTreeUtil.findChildOfType(psiElement, TwigFieldReference.class);
if (childOfType != null) {
TwigPsiReference owner = childOfType.getOwner();
if (owner != null) {
return owner.getFirstChild();
}
}

// "form(form)" => "form"
TwigVariableReference childOfType1 = PsiTreeUtil.findChildOfType(psiElement, TwigVariableReference.class);
if (childOfType1 != null) {
return childOfType1.getFirstChild();
}

return null;
}

/**
* Search Twig element to find use trans_default_domain and returns given string parameter
*/
Expand Down
25 changes: 21 additions & 4 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/webpack/SymfonyWebpackUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.util.io.StreamUtil;
import com.intellij.openapi.vfs.VfsUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.search.FilenameIndex;
import com.intellij.psi.search.GlobalSearchScope;
import fr.adrienbrault.idea.symfony2plugin.util.ProjectUtil;
import org.jetbrains.annotations.NotNull;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
Expand All @@ -27,11 +29,15 @@ public class SymfonyWebpackUtil {
*/
public static void visitAllEntryFileTypes(@NotNull Project project, @NotNull Consumer<Pair<VirtualFile, String>> consumer) {
for (VirtualFile virtualFile : FilenameIndex.getVirtualFilesByName(project, "webpack.config.js", GlobalSearchScope.allScope(project))) {
visitWebpackConfiguration(virtualFile, consumer);
if (!isTestFile(project, virtualFile)) {
visitWebpackConfiguration(virtualFile, consumer);
}
}

for (VirtualFile virtualFile : FilenameIndex.getVirtualFilesByName(project, "entrypoints.json", GlobalSearchScope.allScope(project))) {
visitEntryPointJson(virtualFile, consumer);
if (!isTestFile(project, virtualFile)) {
visitEntryPointJson(virtualFile, consumer);
}
}
}

Expand Down Expand Up @@ -94,9 +100,20 @@ private static void visitWebpackConfiguration(@NotNull VirtualFile virtualFile,
}

// if adding "javascript" plugin; would resolve better but not for now
Matcher matcher = Pattern.compile("addEntry\\s*\\(\\s*['\"]([^'\"]+)['\"]").matcher(s);
Matcher matcher = Pattern.compile("(addEntry|addStyleEntry)\\s*\\(\\s*['\"]([^'\"]+)['\"]").matcher(s);
while(matcher.find()){
consumer.accept(Pair.create(virtualFile, matcher.group(1)));
consumer.accept(Pair.create(virtualFile, matcher.group(2)));
}
}

private static boolean isTestFile(@NotNull Project project, @NotNull VirtualFile virtualFile) {
// ignore: "vendor/symonfy/.../tests/fixtures/build/entrypoints.json"
String path = VfsUtil.getRelativePath(virtualFile, ProjectUtil.getProjectDir(project), '/');
if (path != null) {
String lowerCase = path.toLowerCase();
return lowerCase.contains("/test/") || lowerCase.contains("/tests/");
}

return false;
}
}
10 changes: 0 additions & 10 deletions ...enbrault/idea/symfony2plugin/templating/webpack/WebpackEncoreGotoCompletionRegistrar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,6 @@ public Collection<PsiElement> getPsiTargets(PsiElement element) {
public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments) {
SymfonyWebpackUtil.visitAllEntryFileTypes(getProject(), pair ->
{
// ignore: "vendor/symonfy/.../tests/fixtures/build/entrypoints.json"
String path = VfsUtil.getRelativePath(pair.first, ProjectUtil.getProjectDir(getElement()), '/');
if (path != null) {
String lowerCase = path.toLowerCase();

if (lowerCase.contains("/test/") || lowerCase.contains("/tests/")) {
return;
}
}

LookupElementBuilder lookupElement = LookupElementBuilder.create(pair.getSecond())
.withIcon(Symfony2Icons.SYMFONY)
.withTypeText(pair.first.getName());
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/fr/adrienbrault/idea/symfony2plugin/util/IdeHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import java.net.URISyntaxException;
import java.util.*;
import java.util.List;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
Expand Down Expand Up @@ -161,10 +160,12 @@ public static Collection<String> enablePluginAndConfigure(@NotNull Project proje

Collection<String> messages = new ArrayList<>();

/* Remove version info; prevent index issues
Set<String> versions = SymfonyUtil.getVersions(project);
if (!versions.isEmpty()) {
messages.add("Symfony Version: " + versions.iterator().next());
}
*/

// Symfony 3.0 structure
if (VfsUtil.findRelativeFile(ProjectUtil.getProjectDir(project), "var", "cache") != null) {
Expand All @@ -180,10 +181,12 @@ public static Collection<String> enablePluginAndConfigure(@NotNull Project proje

// There no clean version when "FooBar:Foo:foo.html.twig" was dropped or deprecated
// So we disable it in the 4 branch by default; following with a default switch to "false" soon
/* Remove version info; prevent index issues
if (SymfonyUtil.isVersionGreaterThenEquals(project, "4.0")) {
Settings.getInstance(project).twigBundleNamespaceSupport = false;
messages.add("Twig: Bundle names disabled");
}
*/

return messages;
}
Expand Down
14 changes: 14 additions & 0 deletions src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,6 +875,20 @@ public void testGetBlocksForFile() {
assertDoesntContain(blocks, "foobar_2");
}

public void testGetTwigFunctionParameterIdentifierPsi() {
PsiElement psiElement = TwigElementFactory.createPsiElement(getProject(), "{{ form(form.name) }}", TwigElementTypes.FUNCTION_CALL);
PsiElement twigFunctionParameter = TwigUtil.getTwigFunctionParameterIdentifierPsi(psiElement);

assertEquals("form", twigFunctionParameter.getText());
assertEquals(TwigTokenTypes.IDENTIFIER, twigFunctionParameter.getNode().getElementType());

psiElement = TwigElementFactory.createPsiElement(getProject(), "{{ form_start(\n form, {attr: {'novalidate': 'novalidate'}}) }}", TwigElementTypes.FUNCTION_CALL);
twigFunctionParameter = TwigUtil.getTwigFunctionParameterIdentifierPsi(psiElement);

assertEquals("form", twigFunctionParameter.getText());
assertEquals(TwigTokenTypes.IDENTIFIER, twigFunctionParameter.getNode().getElementType());
}

public void testGetBlockLookupElements() {
PsiFile psiFile = myFixture.configureByText("foo.html.twig", "{% block name %}{% endblock %}");
PsiFile psiFile2 = myFixture.configureByText("foo_2.html.twig", "{% block foobar %}{% endblock %}");
Expand Down
2 changes: 1 addition & 1 deletion .../fr/adrienbrault/idea/symfony2plugin/tests/templating/webpack/SymfonyWebpackUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ public void testVisitEntries() {
Set<String> entries = new HashSet<>();

SymfonyWebpackUtil.visitAllEntryFileTypes(myFixture.getProject(), pair -> entries.add(pair.second));
assertContainsElements(entries, "foo", "foobar", "entry_foobar_2");
assertContainsElements(entries, "foo", "foobar", "entry_foobar_2", "addStyleEntryFoobar");
}
}
1 change: 1 addition & 0 deletions ...a/fr/adrienbrault/idea/symfony2plugin/tests/templating/webpack/fixtures/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Encore
*/
.addEntry('foobar', './assets/app.js')
.addEntry("foo")
.addStyleEntry('addStyleEntryFoobar')

.enableVueLoader(() => {}, { runtimeCompilerBuild: false })

Expand Down