Merge pull request #77 from vasilii-b/new-module-creation-add-license

Vitaliy · web-flow · commit f723a9a46e81 · 2020-04-02T09:27:39.000+03:00
Add license select to the new module
diff --git a/resources/fileTemplates/internal/Magento Module Composer.json.ft b/resources/fileTemplates/internal/Magento Module Composer.json.ft
@@ -9,7 +9,9 @@
   },
   #end
   #if (${LICENSE})
-  ${LICENSE},
+  "license":
+  ${LICENSE}
+  ,
   #end
   "autoload": {
     "files": [
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/ModuleComposerJsonData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/ModuleComposerJsonData.java
@@ -5,6 +5,7 @@
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 import com.intellij.psi.PsiDirectory;
+import java.util.List;
 
 public class ModuleComposerJsonData {
     private final String packageName;
@@ -13,21 +14,24 @@ public class ModuleComposerJsonData {
     private final String moduleDescription;
     private final String composerPackageName;
     private final String moduleVersion;
+    private final List moduleLicense;
 
     public ModuleComposerJsonData(
         String packageName,
         String moduleName,
         PsiDirectory baseDir,
         String moduleDescription,
         String composerPackageName,
-        String moduleVersion
+        String moduleVersion,
+        List moduleLicense
     ) {
         this.packageName = packageName;
         this.moduleName = moduleName;
         this.baseDir = baseDir;
         this.moduleDescription = moduleDescription;
         this.composerPackageName = composerPackageName;
         this.moduleVersion = moduleVersion;
+        this.moduleLicense = moduleLicense;
     }
 
     public String getPackageName() {
@@ -53,4 +57,8 @@ public String getComposerPackageName() {
     public String getModuleVersion() {
         return this.moduleVersion;
     }
+
+    public List getModuleLicense() {
+        return this.moduleLicense;
+    }
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMagentoModuleDialog.form b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMagentoModuleDialog.form
@@ -3,9 +3,11 @@
   <grid id="cbd77" binding="contentPane" layout-manager="GridLayoutManager" row-count="4" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
     <margin top="10" left="10" bottom="10" right="10"/>
     <constraints>
-      <xy x="48" y="54" width="462" height="297"/>
+      <xy x="48" y="54" width="462" height="431"/>
     </constraints>
-    <properties/>
+    <properties>
+      <preferredSize width="350" height="391"/>
+    </properties>
     <border type="none"/>
     <children>
       <grid id="94766" layout-manager="GridLayoutManager" row-count="1" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
@@ -49,7 +51,7 @@
           </grid>
         </children>
       </grid>
-      <grid id="e3588" layout-manager="GridLayoutManager" row-count="3" column-count="4" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+      <grid id="e3588" layout-manager="GridLayoutManager" row-count="5" column-count="3" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
         <margin top="0" left="0" bottom="0" right="0"/>
         <constraints>
           <grid row="0" column="0" row-span="1" col-span="2" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
@@ -59,7 +61,7 @@
         <children>
           <component id="ad3ba" class="javax.swing.JTextField" binding="packageName" default-binding="true">
             <constraints>
-              <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
+              <grid row="0" column="1" row-span="1" col-span="2" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
                 <preferred-size width="150" height="-1"/>
               </grid>
             </constraints>
@@ -78,7 +80,7 @@
           </component>
           <component id="e4858" class="javax.swing.JTextField" binding="moduleName">
             <constraints>
-              <grid row="1" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
+              <grid row="1" column="1" row-span="1" col-span="2" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
                 <preferred-size width="150" height="-1"/>
               </grid>
             </constraints>
@@ -97,7 +99,7 @@
           </component>
           <component id="423dc" class="javax.swing.JTextField" binding="moduleVersion">
             <constraints>
-              <grid row="2" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
+              <grid row="2" column="1" row-span="1" col-span="2" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
                 <preferred-size width="150" height="-1"/>
               </grid>
             </constraints>
@@ -116,6 +118,47 @@
               <text value="Module Version"/>
             </properties>
           </component>
+          <component id="c5925" class="javax.swing.JLabel" binding="moduleLicenseLabel">
+            <constraints>
+              <grid row="3" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="9" fill="0" indent="0" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <text value="License(s)"/>
+            </properties>
+          </component>
+          <component id="26905" class="javax.swing.JTextField" binding="moduleLicenseCustom">
+            <constraints>
+              <grid row="4" column="1" row-span="1" col-span="2" vsize-policy="0" hsize-policy="0" anchor="8" fill="1" indent="0" use-parent-layout="false">
+                <preferred-size width="150" height="-1"/>
+              </grid>
+            </constraints>
+            <properties>
+              <editable value="true"/>
+              <enabled value="true"/>
+              <toolTipText value="Module's Custom License"/>
+            </properties>
+          </component>
+          <scrollpane id="a545e" binding="moduleLicenseScrollPanel">
+            <constraints>
+              <grid row="3" column="1" row-span="1" col-span="2" vsize-policy="6" hsize-policy="6" anchor="0" fill="3" indent="0" use-parent-layout="false">
+                <preferred-size width="150" height="100"/>
+                <maximum-size width="-1" height="100"/>
+              </grid>
+            </constraints>
+            <properties>
+              <enabled value="false"/>
+            </properties>
+            <border type="none"/>
+            <children>
+              <component id="8bae" class="javax.swing.JList" binding="moduleLicense">
+                <constraints/>
+                <properties>
+                  <model/>
+                  <toolTipText value="Module's Lincese"/>
+                </properties>
+              </component>
+            </children>
+          </scrollpane>
         </children>
       </grid>
       <component id="4c5ac" class="javax.swing.JTextArea" binding="moduleDescription">
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMagentoModuleDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMagentoModuleDialog.java
@@ -25,10 +25,14 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import javax.swing.*;
+import javax.swing.event.ListSelectionEvent;
+import javax.swing.event.ListSelectionListener;
 import java.awt.*;
 import java.awt.event.*;
+import java.util.List;
+import java.util.Vector;
 
-public class NewMagentoModuleDialog extends AbstractDialog {
+public class NewMagentoModuleDialog extends AbstractDialog implements ListSelectionListener {
     @NotNull
     private final Project project;
     @NotNull
@@ -55,6 +59,10 @@ public class NewMagentoModuleDialog extends AbstractDialog {
     private JLabel moduleDescriptionLabel;
     private JTextField moduleVersion;
     private JLabel moduleVersionLabel;
+    private JList moduleLicense;
+    private JLabel moduleLicenseLabel;
+    private JTextField moduleLicenseCustom;
+    private JScrollPane moduleLicenseScrollPanel;
     private String detectedPackageName;
 
     public NewMagentoModuleDialog(@NotNull Project project, @NotNull PsiDirectory initialBaseDir, @Nullable PsiFile file, @Nullable IdeView view, @Nullable Editor editor) {
@@ -73,6 +81,10 @@ public NewMagentoModuleDialog(@NotNull Project project, @NotNull PsiDirectory in
         setModal(true);
         getRootPane().setDefaultButton(buttonOK);
         pushToMiddle();
+        setLicenses();
+
+        moduleLicenseCustom.setToolTipText("Custom License Name");
+        moduleLicenseCustom.setText("proprietary");
 
         buttonOK.addActionListener(new ActionListener() {
             public void actionPerformed(ActionEvent e) {
@@ -137,7 +149,8 @@ private PsiFile generateComposerJson() {
                 getBaseDir(),
                 getModuleDescription(),
                 getComposerPackageName(),
-                getModuleVersion()
+                getModuleVersion(),
+                getModuleLicense()
         ), project).generate(NewModuleAction.ACTION_NAME);
     }
 
@@ -180,6 +193,18 @@ public String getModuleVersion() {
         return this.moduleVersion.getText().trim();
     }
 
+    public List getModuleLicense() {
+        List selectedLicenses = this.moduleLicense.getSelectedValuesList();
+        Package.License customLicense = Package.License.CUSTOM;
+
+        if (selectedLicenses.contains(customLicense.getLicenseName())) {
+            selectedLicenses.remove(customLicense.getLicenseName());
+            selectedLicenses.add(moduleLicenseCustom.getText());
+        }
+
+        return selectedLicenses;
+    }
+
     public static void open(@NotNull Project project, @NotNull PsiDirectory initialBaseDir, @Nullable PsiFile file, @Nullable IdeView view, @Nullable Editor editor) {
         NewMagentoModuleDialog dialog = new NewMagentoModuleDialog(project, initialBaseDir, file, view, editor);
         dialog.pack();
@@ -192,4 +217,37 @@ private String getComposerPackageName() {
                 .concat("/")
                 .concat(camelCaseToHyphen.convert(getModuleName()));
     }
+
+    private void setLicenses() {
+        Package.License[] licenses = Package.License.values();
+        Vector<String> licenseNames = new Vector<>(licenses.length);
+
+        for (Package.License license: licenses) {
+            licenseNames.add(license.getLicenseName());
+        }
+
+        moduleLicense.setListData(licenseNames);
+        moduleLicense.setSelectedIndex(0);
+        moduleLicense.addListSelectionListener(this);
+    }
+
+    private void handleModuleCustomLicenseInputVisibility () {
+        boolean isCustomLicenseSelected = false;
+
+        for (Object value: moduleLicense.getSelectedValuesList()) {
+            if (Package.License.CUSTOM.getLicenseName().equals(value.toString())) {
+                isCustomLicenseSelected = true;
+
+                break;
+            }
+        }
+
+        moduleLicenseCustom.setEnabled(isCustomLicenseSelected);
+        moduleLicenseCustom.setEditable(isCustomLicenseSelected);
+    }
+
+    @Override
+    public void valueChanged(ListSelectionEvent listSelectionEvent) {
+        handleModuleCustomLicenseInputVisibility();
+    }
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleComposerJsonGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleComposerJsonGenerator.java
@@ -13,6 +13,7 @@
 import com.magento.idea.magento2plugin.magento.files.ComposerJson;
 import org.jetbrains.annotations.NotNull;
 import java.util.Properties;
+import java.util.List;
 
 public class ModuleComposerJsonGenerator extends FileGenerator {
 
@@ -38,5 +39,25 @@ protected void fillAttributes(Properties attributes) {
         attributes.setProperty("MODULE_DESCRIPTION", moduleComposerJsonData.getModuleDescription());
         attributes.setProperty("COMPOSER_PACKAGE_NAME", moduleComposerJsonData.getComposerPackageName());
         attributes.setProperty("MODULE_VERSION", moduleComposerJsonData.getModuleVersion());
+        attributes.setProperty("LICENSE", this.getLicensesString(moduleComposerJsonData.getModuleLicense()));
+    }
+
+    protected String getLicensesString(List licensesList) {
+        String license = "[\n";
+        Object[] licenses = licensesList.toArray();
+
+        for (int i = 0; i < licenses.length; i++) {
+            license = license.concat("\"");
+            license = license.concat(licenses[i].toString());
+            license = license.concat("\"");
+
+            if (licenses.length != (i + 1)) license = license.concat(",");
+
+            license = license.concat("\n");
+        }
+
+        license = license.concat("\n]");
+
+        return license;
     }
 }
diff --git a/src/com/magento/idea/magento2plugin/magento/packages/Package.java b/src/com/magento/idea/magento2plugin/magento/packages/Package.java
@@ -4,7 +4,7 @@
  */
 package com.magento.idea.magento2plugin.magento.packages;
 
-import com.magento.idea.magento2plugin.magento.files.Plugin;
+import java.util.ArrayList;
 
 public class Package {
     public static String PACKAGES_ROOT = "app/code";
@@ -23,6 +23,28 @@ public static enum Areas {
         graphql
     }
 
+    public static enum License {
+        CUSTOM("Custom License"),
+        OSL("Open Software License (OSL)"),
+        MPL("Mozilla Public License (MPL)"),
+        MITL("Massachusetts Institute of Technology License (MITL)"),
+        LGPL("GNU Lesser General Public License (LGPL)"),
+        GPL("GNU General Public License (GPL)"),
+        BSDL("Berkeley Software Distribution License (BSDL)"),
+        ASL("Apache Software License (ASL)"),
+        AFL("Academic Free License (AFL)");
+
+        private String licenseName;
+
+        License(String name) {
+            this.licenseName = name;
+        }
+
+        public String getLicenseName() {
+            return licenseName;
+        }
+    }
+
     public static Package.Areas getAreaByString(String string)
     {
         for (Package.Areas areas: Package.Areas.values()) {
