Added index, completion and references for table names, column names …

resources/META-INF/plugin.xml

@@ -7,7 +7,7 @@
 <idea-plugin>
     <id>com.magento.idea.magento2plugin</id>
     <name>Magento PhpStorm</name>
-    <version>2.0.1</version>
+    <version>2.1.0</version>
     <vendor url="https://github.com/magento/magento2-phpstorm-plugin">Magento Inc.</vendor>
 
     <description><![CDATA[
@@ -125,6 +125,7 @@
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.js.MagentoLibJsIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.AclResourceIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.MenuIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.DeclarativeSchemaElementsIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.UIComponentIndex" />
 
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.linemarker.php.PluginLineMarkerProvider"/>

src/com/magento/idea/magento2plugin/completion/provider/ColumnNameCompletionProvider.java

@@ -0,0 +1,115 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.completion.provider;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.impl.source.xml.XmlAttributeImpl;
+import com.intellij.psi.impl.source.xml.XmlTagImpl;
+import com.intellij.psi.xml.XmlTag;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.magento.files.ModuleDbSchemaXml;
+import com.magento.idea.magento2plugin.stubs.indexes.xml.DeclarativeSchemaElementsIndex;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Provides column names for completion.
+ */
+public class ColumnNameCompletionProvider extends CompletionProvider<CompletionParameters> {
+    @Override
+    protected void addCompletions(
+            final @NotNull CompletionParameters parameters,
+            final @NotNull ProcessingContext context,
+            final @NotNull CompletionResultSet result
+    ) {
+        final PsiElement position = parameters.getPosition().getOriginalElement();
+        final String currentAttrName = getCurrentAttributeName(position);
+        if (position == null || currentAttrName == null) {
+            return;
+        }
+        String targetTableAttrName;
+
+        switch (currentAttrName) {
+            case ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_COLUMN_NAME:
+                targetTableAttrName = ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_TABLE_NAME;
+                break;
+            case ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_REFERENCE_COLUMN_NAME:
+                targetTableAttrName = ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_REFERENCE_TABLE_NAME;
+                break;
+            default:
+                return;
+        }
+        final String targetTableName = getTargetTableFromPositionAndAttrName(
+                position,
+                targetTableAttrName
+        );
+
+        if (targetTableName == null) {
+            return;
+        }
+        final Collection<String> tableAndColumnNames = FileBasedIndex.getInstance().getAllKeys(
+                DeclarativeSchemaElementsIndex.KEY, position.getProject()
+        );
+        final List<String> filteredColumnNames = tableAndColumnNames.stream()
+                .filter(name -> name.contains(targetTableName + ".")).collect(Collectors.toList())
+                .stream().map(name -> name.substring(name.indexOf(".") + 1))
+                .collect(Collectors.toList());
+
+        for (final String columnName: filteredColumnNames) {
+            result.addElement(LookupElementBuilder.create(columnName));
+        }
+    }
+
+    /**
+     * Get attribute name from position.
+     *
+     * @param position PsiElement
+     *
+     * @return String
+     */
+    private String getCurrentAttributeName(final PsiElement position) {
+        if (position instanceof XmlAttributeImpl) {
+            return ((XmlAttributeImpl) position).getName();
+        } else {
+            return getCurrentAttributeName(position.getParent());
+        }
+    }
+
+    /**
+     * Get reference table name from current position.
+     *
+     * @param position PsiElement
+     * @param targetTableAttrName String
+     *
+     * @return String
+     */
+    private String getTargetTableFromPositionAndAttrName(
+            final PsiElement position,
+            final String targetTableAttrName
+    ) {
+        if (targetTableAttrName == null) {
+            return null;
+        }
+
+        if (position instanceof XmlTagImpl
+                && ((XmlTag) position).getName().equals(ModuleDbSchemaXml.XML_TAG_CONSTRAINT)) {
+            return ((XmlTag) position)
+                    .getAttributeValue(targetTableAttrName);
+        } else {
+            return getTargetTableFromPositionAndAttrName(
+                    position.getParent(),
+                    targetTableAttrName
+            );
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/provider/TableNameCompletionProvider.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.completion.provider;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.xml.DeclarativeSchemaElementsIndex;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Provides table names for completion.
+ */
+public class TableNameCompletionProvider extends CompletionProvider<CompletionParameters> {
+    @Override
+    protected void addCompletions(
+            final @NotNull CompletionParameters parameters,
+            final @NotNull ProcessingContext context,
+            final @NotNull CompletionResultSet result
+    ) {
+        final PsiElement position = parameters.getPosition().getOriginalElement();
+        if (position == null) {
+            return;
+        }
+
+        final Collection<String> tableNames = FileBasedIndex.getInstance().getAllKeys(
+                DeclarativeSchemaElementsIndex.KEY, position.getProject()
+        );
+        final List<String> filteredTableNames = tableNames.stream()
+                .filter(name -> !name.contains(".")).collect(Collectors.toList());
+
+        for (final String tableName: filteredTableNames) {
+            result.addElement(LookupElementBuilder.create(tableName));
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java

@@ -324,6 +324,64 @@ public XmlCompletionContributor() {
             new MenuCompletionProvider()
         );
 
+        // <table name="completion" /> in db_schema.xml
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute().withName(ModuleDbSchemaXml.XML_ATTR_TABLE_NAME)
+                        .withParent(XmlPatterns.xmlTag().withName(ModuleDbSchemaXml.XML_TAG_TABLE)
+                                .withParent(XmlPatterns.xmlTag()
+                                        .withName(ModuleDbSchemaXml.XML_TAG_SCHEMA))))
+                        .inFile(xmlFile().withName(string().matches(ModuleDbSchemaXml.FILE_NAME))),
+            new TableNameCompletionProvider()
+        );
+
+        // <constraint table="completion" /> in db_schema.xml
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute()
+                        .withName(ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_TABLE_NAME)
+                        .withParent(XmlPatterns.xmlTag()
+                                .withName(ModuleDbSchemaXml.XML_TAG_CONSTRAINT)
+                        .withParent(XmlPatterns.xmlTag()
+                                .withName(ModuleDbSchemaXml.XML_TAG_TABLE))))
+                .inFile(xmlFile().withName(string().matches(ModuleDbSchemaXml.FILE_NAME))),
+                new TableNameCompletionProvider()
+        );
+
+        // <constraint referenceTable="completion" /> in db_schema.xml
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute()
+                        .withName(ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_REFERENCE_TABLE_NAME)
+                        .withParent(XmlPatterns.xmlTag()
+                                .withName(ModuleDbSchemaXml.XML_TAG_CONSTRAINT)
+                                .withParent(XmlPatterns.xmlTag()
+                                        .withName(ModuleDbSchemaXml.XML_TAG_TABLE))))
+                .inFile(xmlFile().withName(string().matches(ModuleDbSchemaXml.FILE_NAME))),
+                new TableNameCompletionProvider()
+        );
+
+        // <constraint column="completion" /> in db_schema.xml
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute()
+                        .withName(ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_COLUMN_NAME)
+                        .withParent(XmlPatterns.xmlTag()
+                                .withName(ModuleDbSchemaXml.XML_TAG_CONSTRAINT)
+                                .withParent(XmlPatterns.xmlTag()
+                                        .withName(ModuleDbSchemaXml.XML_TAG_TABLE))))
+                .inFile(xmlFile().withName(string().matches(ModuleDbSchemaXml.FILE_NAME))),
+                new ColumnNameCompletionProvider()
+        );
+
+        // <constraint referenceColumn="completion" /> in db_schema.xml
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute()
+                        .withName(ModuleDbSchemaXml.XML_ATTR_CONSTRAINT_REFERENCE_COLUMN_NAME)
+                        .withParent(XmlPatterns.xmlTag()
+                                .withName(ModuleDbSchemaXml.XML_TAG_CONSTRAINT)
+                                .withParent(XmlPatterns.xmlTag()
+                                        .withName(ModuleDbSchemaXml.XML_TAG_TABLE))))
+                .inFile(xmlFile().withName(string().matches(ModuleDbSchemaXml.FILE_NAME))),
+                new ColumnNameCompletionProvider()
+        );
+
         registerCompletionsForDifferentNesting();
     }
 

src/com/magento/idea/magento2plugin/indexes/IndexManager.java

@@ -25,6 +25,7 @@
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.SectionIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.TestNameIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.AclResourceIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.xml.DeclarativeSchemaElementsIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.MenuIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.PhpClassNameIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.UIComponentIndex;
@@ -42,6 +43,7 @@ public static void manualReindex() {
             // xml|di configuration
             PluginIndex.KEY,
             VirtualTypeIndex.KEY,
+            DeclarativeSchemaElementsIndex.KEY,
             // layouts
             BlockNameIndex.KEY,
             ContainerNameIndex.KEY,

src/com/magento/idea/magento2plugin/magento/files/ModuleDbSchemaXml.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.magento.files;
+
+import com.intellij.lang.Language;
+import com.intellij.lang.xml.XMLLanguage;
+
+public class ModuleDbSchemaXml implements ModuleFileInterface {
+    private static final ModuleDbSchemaXml INSTANCE = new ModuleDbSchemaXml();
+    public static final String FILE_NAME = "db_schema.xml";
+    public static final String TEMPLATE = "Magento Module Declarative Schema XML";
+
+    //attributes
+    public static final String XML_ATTR_TABLE_NAME = "name";
+    public static final String XML_ATTR_COLUMN_NAME = "name";
+    public static final String XML_ATTR_CONSTRAINT_TABLE_NAME = "table";
+    public static final String XML_ATTR_CONSTRAINT_REFERENCE_TABLE_NAME = "referenceTable";
+    public static final String XML_ATTR_CONSTRAINT_COLUMN_NAME = "column";
+    public static final String XML_ATTR_CONSTRAINT_REFERENCE_COLUMN_NAME = "referenceColumn";
+    //tags
+    public static final String XML_TAG_SCHEMA = "schema";
+    public static final String XML_TAG_TABLE = "table";
+    public static final String XML_TAG_COLUMN = "column";
+    public static final String XML_TAG_CONSTRAINT = "constraint";
+
+    public static ModuleDbSchemaXml getInstance() {
+        return INSTANCE;
+    }
+
+    @Override
+    public String getFileName() {
+        return FILE_NAME;
+    }
+
+    @Override
+    public String getTemplate() {
+        return TEMPLATE;
+    }
+
+    @Override
+    public Language getLanguage() {
+        return XMLLanguage.INSTANCE;
+    }
+}