Merge branch '2.1.0-develop' into revert-387-feature/issue-288-add-description-for-template

Vitaliy · web-flow · commit e39096596a1f · 2020-11-21T18:19:36.000+02:00
diff --git a/resources/fileTemplates/code/Magento Module DI Xml Plugin.xml.ft b/resources/fileTemplates/code/Magento Module DI Xml Plugin.xml.ft
@@ -2,7 +2,12 @@
 <type name="${TYPE}">
 #end
 <plugin name="${NAME}"
-            type="${PLUGIN_TYPE}" sortOrder="${SORT_ORDER}" />
+#if (${SORT_ORDER})
+        type="${PLUGIN_TYPE}"
+        sortOrder="${SORT_ORDER}" />
+#else
+        type="${PLUGIN_TYPE}" />
+#end
 #if (${TYPE})
 </type>
 #end
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.form b/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.form
@@ -131,7 +131,6 @@
               </grid>
             </constraints>
             <properties>
-              <text value="10"/>
               <toolTipText value="Plugin sort order in di.xml"/>
             </properties>
             <clientProperties>
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.java
@@ -82,8 +82,6 @@ public class CreateAPluginDialog extends AbstractDialog {
             message = {DirectoryRule.MESSAGE, DIRECTORY})
     private JTextField pluginDirectory;
 
-    @FieldValidation(rule = RuleRegistry.NOT_EMPTY,
-            message = {NotEmptyRule.MESSAGE, SORT_ORDER})
     @FieldValidation(rule = RuleRegistry.NUMERIC,
             message = {NumericRule.MESSAGE, SORT_ORDER})
     private JTextField pluginSortOrder;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/PluginDiXmlGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/PluginDiXmlGenerator.java
@@ -161,6 +161,9 @@ protected void fillAttributes(final Properties attributes) {
         attributes.setProperty("NAME", pluginFileData.getPluginName());
         attributes.setProperty("PLUGIN_TYPE", pluginFileData.getPluginFqn());
         attributes.setProperty("PLUGIN_NAME", pluginFileData.getPluginName());
-        attributes.setProperty("SORT_ORDER", pluginFileData.getSortOrder());
+        final String sortOrder = pluginFileData.getSortOrder();
+        if (!sortOrder.isEmpty()) {
+            attributes.setProperty("SORT_ORDER", sortOrder);
+        }
     }
 }
diff --git a/src/com/magento/idea/magento2plugin/reference/provider/EventNameReferenceProvider.java b/src/com/magento/idea/magento2plugin/reference/provider/EventNameReferenceProvider.java
@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.reference.provider;
 
 import com.intellij.openapi.util.text.StringUtil;
@@ -15,52 +16,63 @@
 import com.intellij.util.indexing.FileBasedIndex;
 import com.jetbrains.php.lang.PhpFileType;
 import com.jetbrains.php.lang.psi.PhpFile;
-import com.magento.idea.magento2plugin.util.php.PhpPatternsHelper;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
 import com.magento.idea.magento2plugin.stubs.indexes.EventNameIndex;
-import org.jetbrains.annotations.NotNull;
-
+import com.magento.idea.magento2plugin.util.php.PhpPatternsHelper;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import org.jetbrains.annotations.NotNull;
 
 public class EventNameReferenceProvider  extends PsiReferenceProvider {
 
     @NotNull
     @Override
-    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
-        String value = StringUtil.unquoteString(element.getText());
-        Collection<VirtualFile> containingFiles = FileBasedIndex.getInstance()
-            .getContainingFiles(EventNameIndex.KEY, value,
-                    GlobalSearchScope.getScopeRestrictedByFileTypes(
-                            GlobalSearchScope.allScope(element.getProject()),
-                            PhpFileType.INSTANCE
-                    )
-            );
+    public PsiReference[] getReferencesByElement(
+            @NotNull final PsiElement element,
+            @NotNull final ProcessingContext context
+    ) {
+        final String value = StringUtil.unquoteString(element.getText());
+        final List<PsiReference> psiReferences = new ArrayList<>();
+        final Collection<VirtualFile> containingFiles = FileBasedIndex.getInstance()
+                .getContainingFiles(
+                        EventNameIndex.KEY,
+                        value,
+                        GlobalSearchScope.getScopeRestrictedByFileTypes(
+                                GlobalSearchScope.allScope(element.getProject()),
+                                PhpFileType.INSTANCE
+                        )
+                );
 
-        PsiManager psiManager = PsiManager.getInstance(element.getProject());
-        for (VirtualFile virtualFile: containingFiles) {
-            PhpFile phpFile = (PhpFile) psiManager.findFile(virtualFile);
+        final PsiManager psiManager = PsiManager.getInstance(element.getProject());
+        final List<PsiElement> psiElements = new ArrayList<>();
+        for (final VirtualFile virtualFile: containingFiles) {
+            final PhpFile phpFile = (PhpFile) psiManager.findFile(virtualFile);
             if (phpFile != null) {
-                List<PsiElement> psiElements = new ArrayList<>();
                 recursiveFill(psiElements, phpFile, value);
-                if (psiElements.size() > 0) {
-                    return new PsiReference[] {new PolyVariantReferenceBase(element, psiElements)};
+                if (!psiElements.isEmpty()) {
+                    psiReferences.add(new PolyVariantReferenceBase(element, psiElements));//NOPMD
+                    break;
                 }
             }
         }
-        return PsiReference.EMPTY_ARRAY;
+
+        return psiReferences.toArray(new PsiReference[0]);
     }
 
-    private void recursiveFill(List<PsiElement> psiElements, PsiElement psiElement, String typeName) {
+    private void recursiveFill(
+            final List<PsiElement> psiElements,
+            final PsiElement psiElement,
+            final String typeName
+    ) {
         if (PhpPatternsHelper.STRING_METHOD_ARGUMENT.accepts(psiElement)) {
             if (StringUtil.unquoteString(psiElement.getText()).equals(typeName)) {
                 psiElements.add(psiElement);
             }
             return;
         }
 
-        for (PsiElement child: psiElement.getChildren()) {
+        for (final PsiElement child: psiElement.getChildren()) {
             recursiveFill(psiElements, child, typeName);
         }
     }
diff --git a/testData/actions/generation/generator/PluginDiXmlGenerator/addTwoPluginsToOneDiXml/di.xml b/testData/actions/generation/generator/PluginDiXmlGenerator/addTwoPluginsToOneDiXml/di.xml
@@ -3,10 +3,12 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <type name="Foo\Bar\Model\PluginTargetClassOne">
         <plugin name="test_plugin_name_1"
-                type="Foo\Bar\Plugin\TestOnePlugin" sortOrder="10"/>
+                type="Foo\Bar\Plugin\TestOnePlugin"
+                sortOrder="10"/>
     </type>
     <type name="Foo\Bar\Model\PluginTargetClassTwo">
         <plugin name="test_plugin_name_2"
-                type="Foo\Bar\Plugin\TestTwoPlugin" sortOrder="20"/>
+                type="Foo\Bar\Plugin\TestTwoPlugin"
+                sortOrder="20"/>
     </type>
 </config>
diff --git a/testData/actions/generation/generator/PluginDiXmlGenerator/addTwoPluginsToOneTargetClass/di.xml b/testData/actions/generation/generator/PluginDiXmlGenerator/addTwoPluginsToOneTargetClass/di.xml
@@ -3,8 +3,10 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <type name="Foo\Bar\Model\PluginTargetClassOne">
         <plugin name="test_plugin_name_1"
-                type="Foo\Bar\Plugin\TestOnePlugin" sortOrder="10"/>
+                type="Foo\Bar\Plugin\TestOnePlugin"
+                sortOrder="10"/>
         <plugin name="test_plugin_name_2"
-                type="Foo\Bar\Plugin\TestTwoPlugin" sortOrder="20"/>
+                type="Foo\Bar\Plugin\TestTwoPlugin"
+                sortOrder="20"/>
     </type>
 </config>
diff --git a/testData/actions/generation/generator/PluginDiXmlGenerator/generatePluginDiXmlFileForAdminhtmlArea/di.xml b/testData/actions/generation/generator/PluginDiXmlGenerator/generatePluginDiXmlFileForAdminhtmlArea/di.xml
@@ -3,6 +3,7 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <type name="Foo\Bar\Model\PluginTargetClassTwo">
         <plugin name="test_plugin_name_2"
-                type="Foo\Bar\Plugin\TestTwoPlugin" sortOrder="20"/>
+                type="Foo\Bar\Plugin\TestTwoPlugin"
+                sortOrder="20"/>
     </type>
 </config>
diff --git a/testData/actions/generation/generator/PluginDiXmlGenerator/generatePluginDiXmlFileForBaseArea/di.xml b/testData/actions/generation/generator/PluginDiXmlGenerator/generatePluginDiXmlFileForBaseArea/di.xml
@@ -3,6 +3,7 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <type name="Foo\Bar\Model\PluginTargetClassOne">
         <plugin name="test_plugin_name_1"
-                type="Foo\Bar\Plugin\TestOnePlugin" sortOrder="10"/>
+                type="Foo\Bar\Plugin\TestOnePlugin"
+                sortOrder="10"/>
     </type>
 </config>
diff --git a/testData/actions/generation/generator/PluginDiXmlGenerator/generatePluginDiXmlFileWithoutSortOrder/di.xml b/testData/actions/generation/generator/PluginDiXmlGenerator/generatePluginDiXmlFileWithoutSortOrder/di.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Foo\Bar\Model\PluginTargetClassOne">
+        <plugin name="test_plugin_name_1"
+                type="Foo\Bar\Plugin\TestOnePlugin"/>
+    </type>
+</config>
diff --git a/testData/completion/xml/ConstructorArgumentCompletionRegistrar/diXmlMustHaveCompletion/di.xml b/testData/completion/xml/ConstructorArgumentCompletionRegistrar/diXmlMustHaveCompletion/di.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config>
+    <type name="Magento\Backend\Model\Source\YesNo">
+        <arguments>
+            <argument name="<caret>" xsi:type="object">Foo\Bar\Model\Logger</argument>
+        </arguments>
+    </type>
+</config>
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustHaveReference/events.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="test_event_in_block<caret>">
+        <observer name="test_observer" instance="Magento\Catalog\Observer\TestObserver" />
+    </event>
+</config>
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustNotHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustNotHaveReference/events.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="invalid_event<caret>">
+        <observer name="test_observer" instance="Magento\Catalog\Observer\TestObserver" />
+    </event>
+</config>
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/observerInstanceMustHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/observerInstanceMustHaveReference/events.xml
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/PluginDiXmlGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/PluginDiXmlGeneratorTest.java
@@ -24,6 +24,31 @@ public class PluginDiXmlGeneratorTest extends BaseGeneratorTestCase {
     private static final String PLUGIN_CLASS_TWO_FNQ = "Foo\\Bar\\Plugin\\TestTwoPlugin";
     private static final String MODULE = "Foo_Bar";
     private static final String MODULE_DIR = "src/app/code/Foo/Bar/";
+    private static final String TEST_PLUGIN_NAME = "test_plugin_name_1";
+
+    /**
+     * Test checks whether di.xml is generated correctly for the base area
+     */
+    public void testGeneratePluginDiXmlFileWithoutSortOrder() {
+        final PsiFile expectedFile = myFixture.configureByFile(
+                this.getFixturePath(ModuleDiXml.FILE_NAME)
+        );
+        final String area = Areas.base.toString();
+
+        final PsiFile diXml = addPluginDiXml(
+                PLUGIN_TARGET_CLASS_ONE_FNQ,
+                area,
+                "",
+                TEST_PLUGIN_NAME,
+                PLUGIN_CLASS_ONE_FNQ
+        );
+
+        assertGeneratedFileIsCorrect(
+                expectedFile,
+                getExpectedDirectory(area),
+                diXml
+        );
+    }
 
     /**
      * Test checks whether di.xml is generated correctly for the base area
@@ -37,7 +62,7 @@ public void testGeneratePluginDiXmlFileForBaseArea() {
                 PLUGIN_TARGET_CLASS_ONE_FNQ,
                 area,
                 "10",
-                "test_plugin_name_1",
+                TEST_PLUGIN_NAME,
                 PLUGIN_CLASS_ONE_FNQ
         );
 
@@ -82,7 +107,7 @@ public void testAddTwoPluginsToOneDiXml() {
                 PLUGIN_TARGET_CLASS_ONE_FNQ,
                 area,
                 "10",
-                "test_plugin_name_1",
+                TEST_PLUGIN_NAME,
                 PLUGIN_CLASS_ONE_FNQ
         );
         final PsiFile diXml = addPluginDiXml(
@@ -111,7 +136,7 @@ public void testAddTwoPluginsToOneTargetClass() {
                 PLUGIN_TARGET_CLASS_ONE_FNQ,
                 area,
                 "10",
-                "test_plugin_name_1",
+                TEST_PLUGIN_NAME,
                 PLUGIN_CLASS_ONE_FNQ
         );
         final PsiFile diXml = addPluginDiXml(
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/ConstructorArgumentCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/ConstructorArgumentCompletionRegistrarTest.java
@@ -0,0 +1,21 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.completion.xml;
+
+import com.magento.idea.magento2plugin.magento.files.ModuleDiXml;
+
+public class ConstructorArgumentCompletionRegistrarTest extends CompletionXmlFixtureTestCase {
+
+    /**
+     * Tests for completion of constructor argument in di.xml.
+     */
+    public void testDiXmlMustHaveCompletion() {
+        final String filePath = this.getFixturePath(ModuleDiXml.FILE_NAME);
+        myFixture.copyFileToProject(filePath);
+
+        assertFileContainsCompletions(filePath, "logger");
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java b/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java
@@ -5,6 +5,7 @@
 
 package com.magento.idea.magento2plugin.reference;
 
+import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiReference;
@@ -15,12 +16,16 @@
 import com.intellij.psi.xml.XmlTag;
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.Parameter;
+import com.jetbrains.php.lang.psi.elements.ParameterList;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.inspections.BaseInspectionsTestCase;
 import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
 import org.jetbrains.annotations.Nullable;
 
+@SuppressWarnings({
+        "PMD.TooManyMethods",
+})
 public abstract class BaseReferenceTestCase extends BaseInspectionsTestCase {
     private static final String testDataFolderPath = "testData" + File.separator//NOPMD
             + "reference" + File.separator;
@@ -204,6 +209,23 @@ protected void assertHasReferenceToClassMethod(
         );
     }
 
+    protected void assertHasReferenceToMethodArgument(final String argument) {
+        final PsiReference[] references = getElementFromCaret().getReferences();
+        final String actualArgument
+                = StringUtil.unquoteString(references[references.length - 1].resolve().getText());
+        final PsiElement parameterList = references[0].resolve().getParent();
+
+        if (!(parameterList instanceof ParameterList)) {
+            fail("Element doesn't have a reference to a method parameter");
+        }
+
+        assertEquals(
+                "Event dispatch argument",
+                argument,
+                actualArgument
+        );
+    }
+
     protected void assertEmptyReference() {
         final PsiElement element = getElementFromCaret();
         assertEmpty(element.getReferences());
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/ObserverReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/ObserverReferenceRegistrarTest.java

Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,9 @@ protected void fillAttributes(final Properties attributes) {`
`161`	`161`	`attributes.setProperty("NAME", pluginFileData.getPluginName());`
`162`	`162`	`attributes.setProperty("PLUGIN_TYPE", pluginFileData.getPluginFqn());`
`163`	`163`	`attributes.setProperty("PLUGIN_NAME", pluginFileData.getPluginName());`
`164`		`- attributes.setProperty("SORT_ORDER", pluginFileData.getSortOrder());`
	`164`	`+ final String sortOrder = pluginFileData.getSortOrder();`
	`165`	`+ if (!sortOrder.isEmpty()) {`
	`166`	`+ attributes.setProperty("SORT_ORDER", sortOrder);`
	`167`	`+ }`
`165`	`168`	`}`
`166`	`169`	`}`