Merge pull request #1133 from makzef/1111-context-action-readme-generation

1111: Add context dependent action for generation of README.md

Author: bohdan-harniuk

resources/META-INF/plugin.xml

@@ -77,6 +77,7 @@
             <action id="MagentoCreateWebapiFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewWebapiXmlAction"/>
             <action id="MagentoCreateWidgetFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewWidgetXmlAction"/>
             <action id="MagentoCreateLayoutFile" class="com.magento.idea.magento2plugin.actions.context.xml.NewLayoutXmlAction"/>
+            <action id="MagentoCreateReadmeFile" class="com.magento.idea.magento2plugin.actions.context.md.NewReadmeMdAction"/>
             <!-- Context dependent actions -->
             <separator/>
             <add-to-group group-id="NewGroup" anchor="before" relative-to-action="NewXml"/>

src/com/magento/idea/magento2plugin/actions/context/md/NewReadmeMdAction.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.context.md;
+
+import com.intellij.ide.fileTemplates.actions.AttributesDefaults;
+import com.intellij.psi.PsiDirectory;
+import com.intellij.psi.PsiFile;
+import com.magento.idea.magento2plugin.actions.context.AbstractContextAction;
+import com.magento.idea.magento2plugin.indexes.ModuleIndex;
+import com.magento.idea.magento2plugin.magento.files.ModuleReadmeMdFile;
+import com.magento.idea.magento2plugin.magento.packages.ComponentType;
+import com.magento.idea.magento2plugin.magento.packages.Package;
+import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil;
+import org.jetbrains.annotations.NotNull;
+
+public class NewReadmeMdAction extends AbstractContextAction {
+
+    public static final String ACTION_NAME = "Magento 2 README File";
+    public static final String ACTION_DESCRIPTION = "Create a new Magento 2 README file";
+
+    public NewReadmeMdAction() {
+        super(ACTION_NAME, ACTION_DESCRIPTION, new ModuleReadmeMdFile());
+    }
+
+    @Override
+    protected boolean isVisible(
+            final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
+            final PsiDirectory targetDirectory,
+            final PsiFile targetFile
+    ) {
+        if (!moduleData.getType().equals(ComponentType.module)) {
+            return false;
+        }
+        final PsiDirectory moduleDirectory = new ModuleIndex(targetDirectory.getProject())
+                .getModuleDirectoryByModuleName(moduleData.getName());
+        final String magentoModuleName = moduleData
+                .getName()
+                .split(Package.vendorModuleNameSeparator)[1];
+
+        return targetDirectory.getName().equals(magentoModuleName)
+                && targetDirectory.equals(moduleDirectory);
+    }
+
+    @Override
+    protected AttributesDefaults getProperties(
+            final @NotNull AttributesDefaults defaults,
+            final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData,
+            final PsiDirectory targetDirectory,
+            final PsiFile targetFile
+    ) {
+        final String[] templateData = moduleData.getName().split(Package.vendorModuleNameSeparator);
+        defaults.addPredefined("PACKAGE", templateData[0]);
+        defaults.addPredefined("MODULE_NAME", templateData[1]);
+
+        return defaults;
+    }
+}