Covered Require js completion and reference

Vitaliy Boyko · Vitaliy Boyko · commit 284b8f628459 · 2020-04-27T17:41:32.000+03:00
diff --git a/src/com/magento/idea/magento2plugin/magento/packages/Package.java b/src/com/magento/idea/magento2plugin/magento/packages/Package.java
@@ -6,6 +6,7 @@
 
 public class Package {
     public static String PACKAGES_ROOT = "app/code";
+    public static String LIB_WEB_ROOT = "lib/web";
     public static String APP = "app";
     public static String VENDOR = "vendor";
     public static String MODULE_BASE_AREA_DIR = "etc";
diff --git a/src/com/magento/idea/magento2plugin/stubs/indexes/js/MagentoLibJsIndex.java b/src/com/magento/idea/magento2plugin/stubs/indexes/js/MagentoLibJsIndex.java
@@ -9,6 +9,9 @@
 import com.intellij.util.indexing.*;
 import com.intellij.util.io.EnumeratorStringDescriptor;
 import com.intellij.util.io.KeyDescriptor;
+import com.magento.idea.magento2plugin.magento.packages.File;
+import com.magento.idea.magento2plugin.magento.packages.Package;
+import com.magento.idea.magento2plugin.project.Settings;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.HashMap;
@@ -29,7 +32,8 @@ public ID<String, Void> getName() {
     public DataIndexer<String, Void, FileContent> getIndexer() {
         return inputData -> {
             Map<String, Void> map = new HashMap<>();
-            String libPath = inputData.getProject().getBasePath() + "/lib/web/";
+            String libPath = Settings.getMagentoPath(inputData.getProject()) +
+                File.separator + Package.LIB_WEB_ROOT + File.separator;
             VirtualFile file = inputData.getFile();
 
             if (!file.getPath().contains(libPath)){
diff --git a/testData/completion/xml/RequireJsCompletionRegistrar/mappedComponentMustHaveCompletion/test_form.xml b/testData/completion/xml/RequireJsCompletionRegistrar/mappedComponentMustHaveCompletion/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testF<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/requirejs-config.js b/testData/project/magento2/app/code/Foo/Bar/view/frontend/requirejs-config.js
@@ -0,0 +1,10 @@
+var config = {
+    map: {
+        '*': {
+            testFile: 'Foo_Bar/js/file',
+        }
+    },
+    paths: {
+        'testFile2': 'Foo_Bar/js/file2'
+    }
+}
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file.js b/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file.js
@@ -0,0 +1,8 @@
+define([
+    'lib'
+], function(lib) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file2.js b/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file2.js
@@ -0,0 +1,8 @@
+define([
+    'lib'
+], function(lib) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/project/magento2/lib/web/testjs.js b/testData/project/magento2/lib/web/testjs.js
@@ -0,0 +1 @@
+var test = 1;
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/fileInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/fileInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'Foo_Bar/js/file<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/libInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/libInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'testjs<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/mappedInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/mappedInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'testFile<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/pathInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/pathInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'testFile2<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/fileComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/fileComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="Foo_Bar/js/file<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/libComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/libComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testjs<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/mappedComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/mappedComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testFile<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/pathComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/pathComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testFile2<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java b/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java
@@ -40,6 +40,7 @@ protected String getTestDataPath() {
 
     protected void enablePluginAndReindex() {
         Settings settings = Settings.getInstance(myFixture.getProject());
+        settings.magentoPath = "/src";
         settings.pluginEnabled = true;
         settings.mftfSupportEnabled = true;
         IndexManager.manualReindex();
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/RequireJsCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/RequireJsCompletionRegistrarTest.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.completion.xml;
+
+public class RequireJsCompletionRegistrarTest extends CompletionXmlFixtureTestCase {
+
+    public void testMappedComponentMustHaveCompletion() {
+        String filePath = this.getFixturePath("test_form.xml");
+        myFixture.copyFileToProject(filePath);
+
+        assertCompletionContains(filePath, new String[] {
+            "testFile",
+            "testFile2"
+        });
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java b/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.reference;
+
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.PsiReference;
+import com.intellij.psi.xml.XmlAttributeValue;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.inspections.BaseInspectionsTestCase;
+import com.magento.idea.magento2plugin.magento.packages.File;
+
+abstract public class BaseReferenceTestCase extends BaseInspectionsTestCase {
+
+    private static final String testDataFolderPath = "testData" + File.separator + "reference" + File.separator;
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.setTestDataPath(testDataFolderPath);
+    }
+
+    protected void assertHasReferenceToXmlAttributeValue(String reference) {
+        PsiElement element = getElementFromCaret();
+        assertEquals(reference, ((XmlAttributeValue) element.getReferences()[0].resolve()).getValue());
+    }
+
+    protected void assertHasReferenceToFile(String reference) {
+        String referenceNotFound = "Failed that element contains reference to the file `%s`";
+
+        PsiElement element = getElementFromCaret();
+        for (PsiReference psiReference: element.getReferences()) {
+            PsiElement resolved = psiReference.resolve();
+            if (!(resolved instanceof PsiFile)) {
+                continue;
+            }
+            if (((PsiFile) resolved).getVirtualFile().getPath().endsWith(reference)) {
+                return;
+            }
+        }
+
+        fail(String.format(referenceNotFound, reference));
+    }
+
+    protected void assertHasReferencePhpClass(String phpClassFqn) {
+        PsiElement element = getElementFromCaret();
+        PsiReference[] references = element.getReferences();
+        assertEquals(
+            phpClassFqn,
+            ((PhpClass) references[references.length -1].resolve())
+                .getPresentableFQN()
+        );
+    }
+
+    protected void assertEmptyReference() {
+        PsiElement element = getElementFromCaret();
+        assertEmpty(element.getReferences());
+    }
+
+    private PsiElement getElementFromCaret() {
+        return myFixture.getFile().findElementAt(myFixture.getCaretOffset()).getParent();
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/js/ReferenceJsFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/js/ReferenceJsFixtureTestCase.java
@@ -0,0 +1,17 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.reference.js;
+
+import com.magento.idea.magento2plugin.magento.packages.File;
+import com.magento.idea.magento2plugin.reference.BaseReferenceTestCase;
+
+abstract public class ReferenceJsFixtureTestCase extends BaseReferenceTestCase {
+
+    private static final String fixturesFolderPath = "js" + File.separator;
+
+    protected String getFixturePath(String fileName) {
+        return prepareFixturePath(fileName, fixturesFolderPath);
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/js/RequireJsReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/js/RequireJsReferenceRegistrarTest.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.reference.js;
+
+public class RequireJsReferenceRegistrarTest extends ReferenceJsFixtureTestCase {
+
+    public void testMappedInjectionParameterMustHaveReference() {
+        String filePath = this.getFixturePath("test.js");
+        myFixture.configureByFile(filePath);
+
+        assertHasReferenceToFile("app/code/Foo/Bar/view/frontend/web/js/file.js");
+    }
+
+    public void testPathInjectionParameterMustHaveReference() {
+        String filePath = this.getFixturePath("test.js");
+        myFixture.configureByFile(filePath);
+
+        assertHasReferenceToFile("app/code/Foo/Bar/view/frontend/web/js/file2.js");
+    }
+
+    public void testFileInjectionParameterMustHaveReference() {
+        String filePath = this.getFixturePath("test.js");
+        myFixture.configureByFile(filePath);
+
+        assertHasReferenceToFile("app/code/Foo/Bar/view/frontend/web/js/file.js");
+    }
+
+    public void testLibInjectionParameterMustHaveReference() {
+        String filePath = this.getFixturePath("test.js");
+        myFixture.configureByFile(filePath);
+
+        assertHasReferenceToFile("/lib/web/testjs.js");
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/php/ReferencePhpFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/php/ReferencePhpFixtureTestCase.java
@@ -4,49 +4,14 @@
  */
 package com.magento.idea.magento2plugin.reference.php;
 
-import com.intellij.psi.PsiElement;
-import com.intellij.psi.PsiReference;
-import com.intellij.psi.impl.source.xml.XmlAttributeValueImpl;
-import com.magento.idea.magento2plugin.BaseProjectTestCase;
-import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+import com.magento.idea.magento2plugin.reference.BaseReferenceTestCase;
 import com.magento.idea.magento2plugin.magento.packages.File;
 
-abstract public class ReferencePhpFixtureTestCase extends BaseProjectTestCase {
+abstract public class ReferencePhpFixtureTestCase extends BaseReferenceTestCase {
 
-    private static final String testDataFolderPath = "testData" + File.separator + "reference" + File.separator;
     private static final String fixturesFolderPath = "php" + File.separator;
 
-    @Override
-    protected void setUp() throws Exception {
-        super.setUp();
-        myFixture.setTestDataPath(testDataFolderPath);
-    }
-
     protected String getFixturePath(String fileName) {
         return prepareFixturePath(fileName, fixturesFolderPath);
     }
-
-    protected void assertHasReferenceToXmlAttributeValue(String attributeValue) {
-        String referenceNotFound = "Failed that documents contains reference to XML attribute with value `%s`";
-
-        PsiElement element = getElementFromCaret();
-        PsiReference[] references = element.getReferences();
-        for (PsiReference reference: references) {
-            if (!(reference instanceof PolyVariantReferenceBase)) {
-                continue;
-            }
-            assertEquals(
-                    attributeValue,
-                    ((XmlAttributeValueImpl) reference.resolve())
-                            .getValue()
-            );
-            return;
-        }
-
-        fail(String.format(referenceNotFound, attributeValue));
-    }
-
-    private PsiElement getElementFromCaret() {
-        return myFixture.getFile().findElementAt(myFixture.getCaretOffset()).getParent();
-    }
 }
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/ReferenceXmlFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/xml/ReferenceXmlFixtureTestCase.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/RequireJsReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/RequireJsReferenceRegistrarTest.java
