fix translation auto-complete not working in Symfony Flex directory structure #1096

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/stubs/indexes/TranslationStubIndex.java

@@ -25,8 +25,8 @@
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
 public class TranslationStubIndex extends FileBasedIndexExtension<String, Set<String>> {
-
     public static final ID<String, Set<String>> KEY = ID.create("fr.adrienbrault.idea.symfony2plugin.translations");
+    private static final StringSetDataExternalizer DATA_EXTERNALIZER = new StringSetDataExternalizer();
     private final KeyDescriptor<String> myKeyDescriptor = new EnumeratorStringDescriptor();
 
     @NotNull
@@ -43,9 +43,7 @@ public Map<String, Set<String>> map(@NotNull FileContent inputData) {
 
                 String extension = inputData.getFile().getExtension();
                 if("xlf".equalsIgnoreCase(extension) || "xliff".equalsIgnoreCase(extension)) {
-                    Map<String, Set<String>> map = new THashMap<>();
-                    getXlfStringMap(inputData, map);
-                    return map;
+                    return getXlfStringMap(inputData);
                 }
 
                 PsiFile psiFile = inputData.getPsiFile();
@@ -80,48 +78,51 @@ public Map<String, Set<String>> map(@NotNull FileContent inputData) {
                 return map;
             }
 
-            private boolean isValidTranslationFile(FileContent inputData, PsiFile psiFile) {
-
-                // dont index all yaml files; "Resources/translations" should be good for now
+            private boolean isValidTranslationFile(@NotNull FileContent inputData, @NotNull PsiFile psiFile) {
+                // dont index all yaml files; valid:
+                //  - "Resources/translations"
+                //  - "translations/[.../]foo.de.yml"
                 String relativePath = VfsUtil.getRelativePath(inputData.getFile(), psiFile.getProject().getBaseDir(), '/');
                 if(relativePath != null) {
-                    return relativePath.contains("/translations");
+                    return relativePath.contains("/translations") || relativePath.startsWith("translations/");
                 }
 
                 // Resources/translations/messages.de.yml
                 // @TODO: Resources/translations/de/messages.yml
                 String path = inputData.getFile().getPath();
-                if(path.endsWith("/translations/" + inputData.getFileName())) {
-                    return true;
-                }
-
-                return false;
+                return path.endsWith("/translations/" + inputData.getFileName());
             }
 
-            private void getXlfStringMap(FileContent inputData, Map<String, Set<String>> map) {
-
+            @NotNull
+            private Map<String, Set<String>> getXlfStringMap(@NotNull FileContent inputData) {
                 // testing files are not that nice
                 String relativePath = VfsUtil.getRelativePath(inputData.getFile(), inputData.getProject().getBaseDir(), '/');
                 if(relativePath != null && (relativePath.contains("/Test/") || relativePath.contains("/Tests/") || relativePath.contains("/Fixture/") || relativePath.contains("/Fixtures/"))) {
-                    return;
+                    return Collections.emptyMap();
                 }
 
-                String domainName = this.getDomainName(inputData.getFileName());
+                // extract domain name
+                String domainName = getDomainName(inputData.getFileName());
                 if(domainName == null) {
-                    return;
+                    return Collections.emptyMap();
                 }
 
                 InputStream inputStream;
                 try {
                     inputStream = inputData.getFile().getInputStream();
                 } catch (IOException e) {
-                    return;
+                    return Collections.emptyMap();
                 }
 
                 Set<String> set = TranslationUtil.getXliffTranslations(inputStream);
-                if(set.size() > 0) {
-                    map.put(domainName, set);
+                if(set.size() == 0) {
+                    return Collections.emptyMap();
                 }
+
+                // wrap with domain
+                Map<String, Set<String>> map = new THashMap<>();
+                map.put(domainName, set);
+                return map;
             }
 
             @Nullable
@@ -149,7 +150,6 @@ public ID<String, Set<String>> getName() {
         return KEY;
     }
 
-
     @NotNull
     @Override
     public KeyDescriptor<String> getKeyDescriptor() {
@@ -158,7 +158,7 @@ public KeyDescriptor<String> getKeyDescriptor() {
 
     @NotNull
     public DataExternalizer<Set<String>> getValueExternalizer() {
-        return new StringSetDataExternalizer();
+        return DATA_EXTERNALIZER;
     }
 
     @NotNull
@@ -177,5 +177,4 @@ public boolean dependsOnFileContent() {
     public int getVersion() {
         return 6;
     }
-
 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/stubs/indexes/TranslationStubIndexTest.java

@@ -19,17 +19,18 @@ public class TranslationStubIndexTest extends SymfonyLightCodeInsightFixtureTest
 
     public void setUp() throws Exception {
         super.setUp();
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("messages.fr.xlf"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("messages_two.fr.xlf"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("foo.fr.xliff"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("foo.fr.xliff"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("foo.fr.xliff"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("fr.xlf"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("fr.xlf","foo.bar.de.xlf"));
-        myFixture.configureFromExistingVirtualFile(myFixture.copyFileToProject("fr.xlf",".de.xlf"));
+        myFixture.copyFileToProject("messages.fr.xlf");
+        myFixture.copyFileToProject("messages_two.fr.xlf");
+        myFixture.copyFileToProject("foo.fr.xliff");
+        myFixture.copyFileToProject("fr.xlf");
+        myFixture.copyFileToProject("fr.xlf","foo.bar.de.xlf");
+        myFixture.copyFileToProject("fr.xlf",".de.xlf");
+        myFixture.copyFileToProject("fr.xlf", "car_xlf_flex.fr.xlf");
 
         myFixture.copyFileToProject("apple.de.yml", "Resources/translations/apple.de.yml");
         myFixture.copyFileToProject("car.de.yml", "Resources/translations/car.de.yml");
+        myFixture.copyFileToProject("car.de.yml", "translations/car_flex_yml.de.yml");
+        myFixture.copyFileToProject("car.de.yml", "translations/car_flex_yaml.de.yaml");
     }
 
     public String getTestDataPath() {
@@ -84,6 +85,12 @@ public void testThatResnameXliffShouldBeUsedForKey() {
         assertContainsElements(getDomainKeys("messages"), "resname.symfony_is_great");
     }
 
+    public void testThatTranslationsInRootForSymfonyFlexIsInIndex() {
+        assertContainsElements(getDomainKeys("car_flex_yml"), "foo_yaml.symfony.great");
+        assertContainsElements(getDomainKeys("car_flex_yaml"), "foo_yaml.symfony.great");
+        assertContainsElements(getDomainKeys("car_xlf_flex"), "Symfony is great");
+    }
+
     @NotNull
     private Set<String> getDomainKeys(@NotNull String domain) {
         Set<String> uniqueKeySet = new ArrayListSet<String>();