allow to disable Twig bundle namespace and support in autoconfigure

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/Settings.java

@@ -56,6 +56,8 @@ public class Settings implements PersistentStateComponent<Settings> {
     public boolean codeFoldingTwigTemplate = true;
     public boolean codeFoldingTwigConstant = true;
 
+    public boolean twigBundleNamespaceSupport = true;
+
     public boolean dismissEnableNotification = false;
 
     public boolean profilerLocalEnabled = false;

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/path/BundleOverwriteNamespaceExtensions.java

@@ -9,6 +9,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 
 /**
  * "app/Resources/ParentBundle/Resources/views"
@@ -19,6 +20,10 @@ public class BundleOverwriteNamespaceExtensions implements TwigNamespaceExtensio
     @NotNull
     @Override
     public Collection<TwigPath> getNamespaces(@NotNull TwigNamespaceExtensionParameter parameter) {
+        if (!TwigUtil.hasBundleNamespaceSupport(parameter.getProject())) {
+            return Collections.emptyList();
+        }
+
         Collection<TwigPath> twigPaths = new ArrayList<>();
 
         new SymfonyBundleUtil(parameter.getProject()).getParentBundles().forEach((key, virtualFile) -> {

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/path/BundleTwigNamespaceExtension.java

@@ -35,7 +35,9 @@ public Collection<TwigPath> getNamespaces(@NotNull TwigNamespaceExtensionParamet
 
             String bundleName = bundle.getName();
 
-            twigPaths.add(new TwigPath(path, bundleName, TwigUtil.NamespaceType.BUNDLE));
+            if (TwigUtil.hasBundleNamespaceSupport(parameter.getProject())) {
+                twigPaths.add(new TwigPath(path, bundleName, TwigUtil.NamespaceType.BUNDLE));
+            }
 
             // Bundle is stripped from its name on the ending "FooBarBundle" => "FooBarBundle"
             if (bundleName.endsWith("Bundle")) {

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/path/GlobalAppTwigNamespaceExtension.java

@@ -44,7 +44,10 @@ public Collection<TwigPath> getNamespaces(@NotNull TwigNamespaceExtensionParamet
         Collection<TwigPath> paths = new ArrayList<>();
 
         directories.stream().map(VirtualFile::getPath).forEach(path -> {
-            paths.add(new TwigPath(path, TwigUtil.MAIN, TwigUtil.NamespaceType.BUNDLE));
+            if (TwigUtil.hasBundleNamespaceSupport(parameter.getProject())) {
+                paths.add(new TwigPath(path, TwigUtil.MAIN, TwigUtil.NamespaceType.BUNDLE));
+            }
+
             paths.add(new TwigPath(path, TwigUtil.MAIN, TwigUtil.NamespaceType.ADD_PATH));
         });
 

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java

@@ -2562,6 +2562,14 @@ public static void visitTemplateVariables(@NotNull TwigFile scope, @NotNull Cons
         visitTemplateVariables(scope, consumer, 3);
     }
 
+
+    /**
+     * Check if Twig pathes should be filled with the Bundle naming strategy "FooBar:Foo:Test"
+     */
+    public static boolean hasBundleNamespaceSupport(@NotNull Project project) {
+        return Settings.getInstance(project).twigBundleNamespaceSupport;
+    }
+
     /**
      * Proxy to consume every given scope
      */

src/main/java/fr/adrienbrault/idea/symfony2plugin/ui/TwigSettingsForm.form

@@ -2,7 +2,7 @@
 <form xmlns="http://www.intellij.com/uidesigner/form/" version="1" bind-to-class="fr.adrienbrault.idea.symfony2plugin.ui.TwigSettingsForm">
   <grid id="27dc6" binding="panel1" default-binding="true" layout-manager="BorderLayout" hgap="0" vgap="0">
     <constraints>
-      <xy x="20" y="20" width="710" height="400"/>
+      <xy x="20" y="20" width="736" height="400"/>
     </constraints>
     <properties/>
     <border type="none"/>
@@ -18,7 +18,7 @@
         <properties/>
         <border type="none"/>
         <children>
-          <grid id="3c6d1" layout-manager="GridLayoutManager" row-count="1" column-count="4" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+          <grid id="3c6d1" layout-manager="GridLayoutManager" row-count="1" column-count="5" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
             <margin top="0" left="0" bottom="0" right="0"/>
             <constraints border-constraint="North"/>
             <properties/>
@@ -34,15 +34,15 @@
               </component>
               <component id="bead7" class="javax.swing.JButton" binding="resetToDefault">
                 <constraints>
-                  <grid row="0" column="3" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="0" indent="0" use-parent-layout="false"/>
+                  <grid row="0" column="4" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="0" indent="0" use-parent-layout="false"/>
                 </constraints>
                 <properties>
                   <text value="Reset To Default"/>
                 </properties>
               </component>
               <component id="67805" class="javax.swing.JButton" binding="buttonJsonExample">
                 <constraints>
-                  <grid row="0" column="2" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
+                  <grid row="0" column="3" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
                 </constraints>
                 <properties>
                   <text value="JSON Example"/>
@@ -53,6 +53,16 @@
                   <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="1" hsize-policy="6" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
                 </constraints>
               </hspacer>
+              <component id="ec914" class="javax.swing.JCheckBox" binding="chkTwigBundleNamespaceSupport">
+                <constraints>
+                  <grid row="0" column="2" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+                </constraints>
+                <properties>
+                  <selected value="true"/>
+                  <text value="Support Bundle Namespaces"/>
+                  <toolTipText value="Example: Foobar:Bar:Foo.html.twig"/>
+                </properties>
+              </component>
             </children>
           </grid>
         </children>

src/main/java/fr/adrienbrault/idea/symfony2plugin/ui/TwigSettingsForm.java

@@ -4,7 +4,6 @@
 import com.intellij.openapi.options.ConfigurationException;
 import com.intellij.openapi.project.DumbService;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.ui.DialogWrapper;
 import com.intellij.ui.ToolbarDecorator;
 import com.intellij.ui.table.TableView;
 import com.intellij.util.ui.ColumnInfo;
@@ -35,6 +34,7 @@ public class TwigSettingsForm implements Configurable {
     private JPanel panelTableView;
     private JButton resetToDefault;
     private JButton buttonJsonExample;
+    private JCheckBox chkTwigBundleNamespaceSupport;
     private TableView<TwigPath> tableView;
     private Project project;
     private boolean changed = false;
@@ -169,6 +169,7 @@ public void apply() throws ConfigurationException {
             }
         }
 
+        getSettings().twigBundleNamespaceSupport = chkTwigBundleNamespaceSupport.isSelected();
         getSettings().twigNamespaces = twigPaths;
         this.changed = false;
     }
@@ -189,9 +190,14 @@ private void resetList() {
     public void reset() {
         this.resetList();
         this.attachItems();
+        this.updateUIFromSettings();
         this.changed = false;
     }
 
+    private void updateUIFromSettings() {
+        this.chkTwigBundleNamespaceSupport.setSelected(getSettings().twigBundleNamespaceSupport);
+    }
+
     @Override
     public void disposeUIResources() {
         this.resetList();

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

@@ -24,7 +24,10 @@
 import java.awt.*;
 import java.io.IOException;
 import java.net.URISyntaxException;
-import java.util.Arrays;
+import java.util.*;
+import java.util.List;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
@@ -123,16 +126,24 @@ public void run() {
 
     public static void notifyEnableMessage(final Project project) {
 
-        Notification notification = new Notification("Symfony Plugin", "Symfony Plugin", "Enable the Symfony Plugin <a href=\"enable\">with auto configuration now</a>, open <a href=\"config\">Project Settings</a> or <a href=\"dismiss\">dismiss</a> further messages", NotificationType.INFORMATION, (notification1, event) -> {
+        Notification notification = new Notification("Symfony Support", "Symfony", "Enable the Symfony Plugin <a href=\"enable\">with auto configuration now</a>, open <a href=\"config\">Project Settings</a> or <a href=\"dismiss\">dismiss</a> further messages", NotificationType.INFORMATION, (notification1, event) -> {
 
             // handle html click events
             if("config".equals(event.getDescription())) {
 
                 // open settings dialog and show panel
                 SettingsForm.show(project);
             } else if("enable".equals(event.getDescription())) {
-                enablePluginAndConfigure(project);
-                Notifications.Bus.notify(new Notification("Symfony Plugin", "Symfony Plugin", "Plugin enabled", NotificationType.INFORMATION), project);
+                Collection<String> messages = enablePluginAndConfigure(project);
+
+                String message = "Plugin enabled";
+
+                if (!messages.isEmpty()) {
+                    List<String> collect = messages.stream().map(s -> "<br> - " + s).collect(Collectors.toList());
+                    message += StringUtils.join(collect, "");
+                }
+
+                Notifications.Bus.notify(new Notification("Symfony Support", "Symfony", message, NotificationType.INFORMATION), project);
             } else if("dismiss".equals(event.getDescription())) {
 
                 // user doesnt want to show notification again
@@ -145,18 +156,36 @@ public static void notifyEnableMessage(final Project project) {
         Notifications.Bus.notify(notification, project);
     }
 
-    public static void enablePluginAndConfigure(@NotNull Project project) {
+    public static Collection<String> enablePluginAndConfigure(@NotNull Project project) {
         Settings.getInstance(project).pluginEnabled = true;
 
+        Collection<String> messages = new ArrayList<>();
+
+        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) {
+        if (VfsUtil.findRelativeFile(ProjectUtil.getProjectDir(project), "var", "cache") != null) {
             Settings.getInstance(project).pathToTranslation = "var/cache/dev/translations";
+            messages.add("Translations: var/cache/dev/translations");
         }
 
         // Symfony 4.0 structure
-        if(VfsUtil.findRelativeFile(ProjectUtil.getProjectDir(project), "public") != null) {
+        if (VfsUtil.findRelativeFile(ProjectUtil.getProjectDir(project), "public") != null) {
             Settings.getInstance(project).directoryToWeb = "public";
+            messages.add("Web Directory: public");
         }
+
+        // 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
+        if (SymfonyUtil.isVersionGreaterThenEquals(project, "4.0")) {
+            Settings.getInstance(project).twigBundleNamespaceSupport = false;
+            messages.add("Twig: Bundle names disabled");
+        }
+
+        return messages;
     }
 
     public static void navigateToPsiElement(@NotNull PsiElement psiElement) {

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

@@ -43,7 +43,7 @@ private static boolean compare(@NotNull Project project, @NotNull String version
     }
 
     @NotNull
-    private static Set<String> getVersions(@NotNull Project project) {
+    public static Set<String> getVersions(@NotNull Project project) {
         Set<String> versions = new HashSet<>();
 
         for (PhpClass phpClass : PhpElementsUtil.getClassesInterface(project, "Symfony\\Component\\HttpKernel\\Kernel")) {