Skip to content

support global naming for twig method resolving #1921

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
May 7, 2022
Merged

support global naming for twig method resolving #1921

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
130 changes: 79 additions & 51 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 @@ -144,65 +144,93 @@ public static String[] getControllerMethodShortcut(@NotNull Method method) {
return new String[0];
}

String shortcutName = null;
String shortcutNameForOldNotation = null;

SymfonyBundleUtil symfonyBundleUtil = new SymfonyBundleUtil(method.getProject());
SymfonyBundle symfonyBundle = symfonyBundleUtil.getContainingBundle(phpClass);
if(symfonyBundle == null) {
return new String[0];
}

// check if files is in <Bundle>/Controller/*
PhpClass bundleClass = symfonyBundle.getPhpClass();
if(!phpClass.getNamespaceName().startsWith(bundleClass.getNamespaceName() + "Controller\\")) {
return new String[0];
}

// strip the controller folder name
String templateFolderName = phpClass.getNamespaceName().substring(bundleClass.getNamespaceName().length() + 11);
if(symfonyBundle != null) {
// check if files is in <Bundle>/Controller/*
PhpClass bundleClass = symfonyBundle.getPhpClass();
if(!phpClass.getNamespaceName().startsWith(bundleClass.getNamespaceName() + "Controller\\")) {
return new String[0];
}

// strip the controller folder name
String templateFolderName = phpClass.getNamespaceName().substring(bundleClass.getNamespaceName().length() + 11);

// HomeBundle:default:indexes
// HomeBundle:default/Test:indexes
templateFolderName = templateFolderName.replace("\\", "/");

// Foobar without (.html.twig)
String templateName = className.substring(0, className.lastIndexOf("Controller"));

if(methodName.equals("__invoke")) {
// AppBundle::foo_bar.html.twig
shortcutName = String.format(
"%s::%s%s",
symfonyBundle.getName(),
underscore(templateFolderName),
underscore(templateName)
);

// HomeBundle:default:indexes
// HomeBundle:default/Test:indexes
templateFolderName = templateFolderName.replace("\\", "/");
// AppBundle::FooBar.html.twig
shortcutNameForOldNotation = String.format(
"%s::%s%s",
symfonyBundle.getName(),
templateFolderName,
templateName
);
} else {
// FooBundle:foo_bar:foo_bar.html.twig
shortcutName = String.format(
"%s:%s%s:%s",
symfonyBundle.getName(),
underscore(templateFolderName),
underscore(templateName),
underscore(StringUtils.removeEnd(methodName, "Action"))
);

String shortcutName;
String shortcutNameForOldNotation;
// FooBundle:FooBar:fooBar.html.twig
shortcutNameForOldNotation = String.format(
"%s:%s%s:%s",
symfonyBundle.getName(),
templateFolderName,
templateName,
StringUtils.removeEnd(methodName, "Action")
);
}
} else {
// https://github.com/sensiolabs/SensioFrameworkExtraBundle/blob/master/src/Templating/TemplateGuesser.php
String fqn = phpClass.getFQN();
Matcher matcher = Pattern.compile("Controller\\\\(.+)Controller$").matcher(fqn);
if(matcher.find()) {
String domain = matcher.group(1);

String matchController = domain.replaceAll("\\\\", "/");

String matchAction = null;
if (!"__invoke".equals(methodName)) {
matchAction = methodName.replaceAll("Action$", "");
matchAction = matchAction;
}

// Foobar without (.html.twig)
String templateName = className.substring(0, className.lastIndexOf("Controller"));
List<String> parts = new ArrayList<>(
Arrays.asList(matchController.split("/"))
);

if(methodName.equals("__invoke")) {
// AppBundle::foo_bar.html.twig
shortcutName = String.format(
"%s::%s%s",
symfonyBundle.getName(),
underscore(templateFolderName),
underscore(templateName)
);
if (matchAction != null) {
parts.add(matchAction);
}

// AppBundle::FooBar.html.twig
shortcutNameForOldNotation = String.format(
"%s::%s%s",
symfonyBundle.getName(),
templateFolderName,
templateName
);
} else {
// FooBundle:foo_bar:foo_bar.html.twig
shortcutName = String.format(
"%s:%s%s:%s",
symfonyBundle.getName(),
underscore(templateFolderName),
underscore(templateName),
underscore(StringUtils.removeEnd(methodName, "Action"))
);
shortcutNameForOldNotation = String.join("/", parts);
shortcutName = underscore(String.join("/", parts));
}
}

// FooBundle:FooBar:fooBar.html.twig
shortcutNameForOldNotation = String.format(
"%s:%s%s:%s",
symfonyBundle.getName(),
templateFolderName,
templateName,
StringUtils.removeEnd(methodName, "Action")
);
if (shortcutName == null || shortcutNameForOldNotation == null) {
return new String[0];
}

// @TODO: we should support types later on; but nicer
Expand Down
20 changes: 20 additions & 0 deletions .../tests/templating/inspection/TemplateExistsAnnotationPhpAttributeLocalInspectionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
public class TemplateExistsAnnotationPhpAttributeLocalInspectionTest extends SymfonyLightCodeInsightFixtureTestCase {
public void setUp() throws Exception {
super.setUp();

myFixture.copyFileToProject("classes.php");
}

Expand Down Expand Up @@ -139,4 +140,23 @@ public void testThatTemplateCreationForInvokeMethodProvidesQuickfix() {
"Twig: Missing Template"
);
}

public void testThatMissingTemplateForGlobalNamespaceWithoutBundleScopeForController() {
assertLocalInspectionContains("foobar.php", "<?php\n" +
"namespace FoobarApp\\Controller;\n" +
"use Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template;\n" +
"\n" +
"class FoobarController\n" +
"{\n" +
" /**\n" +
" * @Temp<caret>late()\n" +
" */\n" +
" public function fooAction()\n" +
" {\n" +
" }\n" +
"}\n" +
"",
"Twig: Missing Template"
);
}
}
68 changes: 68 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 @@ -471,6 +471,74 @@ public void testGetControllerMethodShortcutForInvokeWithSnakeCase() {
assertContainsElements(strings, "FooBundle::FooBar.text.twig");
}

public void testGetControllerMethodShortcutForInvokeForGlobalNamespace() {
myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
"namespace FoobarUnknownBundle\\Controller;\n" +
"class FooBarController\n" +
"{\n" +
" public function foo<caret>Action() {}\n" +
"" +
"}\n"
);

PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());

List<String> strings = Arrays.asList(TwigUtil.getControllerMethodShortcut((Method) psiElement.getParent()));

assertContainsElements(strings, "foo_bar/foo.html.twig");
assertContainsElements(strings, "foo_bar/foo.json.twig");
assertContainsElements(strings, "foo_bar/foo.xml.twig");
assertContainsElements(strings, "foo_bar/foo.text.twig");

assertContainsElements(strings, "FooBar/foo.html.twig");
assertContainsElements(strings, "FooBar/foo.json.twig");
assertContainsElements(strings, "FooBar/foo.xml.twig");
assertContainsElements(strings, "FooBar/foo.text.twig");
}

public void testGetControllerMethodShortcutForInvokeForGlobalNamespaceInInvoke() {
myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
"namespace FoobarUnknownBundle\\Controller;\n" +
"class FooBarController\n" +
"{\n" +
" public function __inv<caret>oke() {}\n" +
"" +
"}\n"
);

PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());

List<String> strings = Arrays.asList(TwigUtil.getControllerMethodShortcut((Method) psiElement.getParent()));

assertContainsElements(strings, "foo_bar.html.twig");
assertContainsElements(strings, "foo_bar.json.twig");
assertContainsElements(strings, "foo_bar.xml.twig");
assertContainsElements(strings, "foo_bar.text.twig");

assertContainsElements(strings, "FooBar.html.twig");
assertContainsElements(strings, "FooBar.json.twig");
assertContainsElements(strings, "FooBar.xml.twig");
assertContainsElements(strings, "FooBar.text.twig");
}

public void testGetControllerMethodShortcutForInvokeForGlobalNamespaceInInvokeWIthPath() {
myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
"namespace Fixture\\Controller\\MyAdmin;\n" +
"class OutOfBundleController\n" +
"{\n" +
" public function index<caret>Action() {}\n" +
"" +
"}\n"
);

PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());

List<String> strings = Arrays.asList(TwigUtil.getControllerMethodShortcut((Method) psiElement.getParent()));

assertContainsElements(strings, "my_admin/out_of_bundle/index.html.twig");
assertContainsElements(strings, "MyAdmin/OutOfBundle/index.html.twig");
}

public void testFindTwigFileController() {
myFixture.copyFileToProject("bundle.php");

Expand Down