Merge pull request #157 from vasilii-b/wrong-dependency-in-composer-while-creating-a-module

Wrong dependency declared in composer JSON when creating a module

Author: Vitaliy

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModuleDialog.java

@@ -21,17 +21,21 @@
 import com.magento.idea.magento2plugin.actions.generation.generator.util.FileFromTemplateGenerator;
 import com.magento.idea.magento2plugin.actions.generation.util.NavigateToCreatedFile;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
+import com.magento.idea.magento2plugin.magento.files.ComposerJson;
 import com.magento.idea.magento2plugin.magento.packages.Package;
 import com.magento.idea.magento2plugin.project.Settings;
 import com.magento.idea.magento2plugin.util.CamelCaseToHyphen;
+import org.apache.commons.lang.ArrayUtils;
 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.event.*;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Vector;
+import java.util.stream.IntStream;
 
 public class NewModuleDialog extends AbstractDialog implements ListSelectionListener {
     @NotNull
@@ -254,7 +258,8 @@ private void setLicenses() {
 
     private void setModuleDependencies() {
         List<String> moduleNames = moduleIndex.getModuleNames();
-        Vector<String> licenseNames = new Vector<>(moduleNames.size());
+        Vector<String> licenseNames = new Vector<>(moduleNames.size() + 1);
+        licenseNames.add(ComposerJson.NO_DEPENDENCY_LABEL);
         for (String name : moduleNames) {
             licenseNames.add(name);
         }
@@ -263,7 +268,7 @@ private void setModuleDependencies() {
         moduleDependencies.addListSelectionListener(this);
     }
 
-    private void handleModuleCustomLicenseInputVisibility () {
+    private void handleModuleCustomLicenseInputVisibility() {
         boolean isCustomLicenseSelected = false;
 
         for (Object value: moduleLicense.getSelectedValuesList()) {
@@ -278,8 +283,18 @@ private void handleModuleCustomLicenseInputVisibility () {
         moduleLicenseCustom.setEditable(isCustomLicenseSelected);
     }
 
+    private void handleModuleSelectedDependencies() {
+        // unselect the "None" dependency when others are selected
+        int[] selectedDependencies = moduleDependencies.getSelectedIndices();
+        if (moduleDependencies.getSelectedIndices().length > 1 && moduleDependencies.isSelectedIndex(0)) {
+            selectedDependencies = ArrayUtils.remove(selectedDependencies, 0);
+            moduleDependencies.setSelectedIndices(selectedDependencies);
+        }
+    }
+
     @Override
     public void valueChanged(ListSelectionEvent listSelectionEvent) {
         handleModuleCustomLicenseInputVisibility();
+        handleModuleSelectedDependencies();
     }
 }

src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleComposerJsonGenerator.java

@@ -16,6 +16,7 @@
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.ComposerJson;
 import com.magento.idea.magento2plugin.util.CamelCaseToHyphen;
+import com.intellij.openapi.util.Pair;
 import org.jetbrains.annotations.NotNull;
 import java.io.FileNotFoundException;
 import java.io.FileReader;
@@ -82,20 +83,24 @@ private String getDependenciesString(List dependenciesList) {
         String result = "";
         Object[] dependencies = dependenciesList.toArray();
         result = result.concat(ComposerJson.DEFAULT_DEPENDENCY);
-        if (dependencies.length == 0) {
+        boolean noDependency = dependencies.length == 1 && dependencies[0].equals(ComposerJson.NO_DEPENDENCY_LABEL);
+        if (dependencies.length == 0 || noDependency) {
             result = result.concat("\n");
         } else {
             result = result.concat(",\n");
         }
 
+        if (noDependency) {
+            return result;
+        }
+
         for (int i = 0; i < dependencies.length; i++) {
             String dependency = dependencies[i].toString();
+            Pair<String, String> dependencyData = getDependencyData(dependency);
             result = result.concat("\"");
-            result = result.concat(
-                    camelCaseToHyphen.convert(dependency).replace("_-", "/")
-            );
+            result = result.concat(dependencyData.getFirst());
             result = result.concat("\"");
-            result = result.concat(": \"" + getDependencyVersion(dependency) + "\"");
+            result = result.concat(": \"" + dependencyData.getSecond() + "\"");
 
             if (dependencies.length != (i + 1)) {
                 result = result.concat(",");
@@ -107,26 +112,32 @@ private String getDependenciesString(List dependenciesList) {
         return result;
     }
 
-    private String getDependencyVersion(String dependency) {
+    private Pair<String, String> getDependencyData(String dependency) {
         String version = "*";
+        String moduleName = camelCaseToHyphen.convert(dependency).replace("_-", "/");
         try {
             VirtualFile virtualFile = moduleIndex.getModuleDirectoryByModuleName(dependency)
                     .findFile(ComposerJson.FILE_NAME)
                     .getVirtualFile();
             if (virtualFile.exists()) {
                 JsonElement jsonElement = new JsonParser().parse(new FileReader(virtualFile.getPath()));
                 JsonElement versionJsonElement = jsonElement.getAsJsonObject().get("version");
+                JsonElement nameJsonElement = jsonElement.getAsJsonObject().get("name");
                 if (versionJsonElement != null) {
                     version = versionJsonElement.getAsString();
                     int minorVersionSeparator = version.lastIndexOf(".");
                     version = new StringBuilder(version)
                             .replace(minorVersionSeparator + 1, version.length(),"*")
                             .toString();
                 }
+                if (nameJsonElement != null) {
+                    moduleName = nameJsonElement.getAsString();
+                }
             }
         } catch (FileNotFoundException e) {
             // It's fine
         }
-        return version;
+
+        return Pair.create(moduleName, version);
     }
 }

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

@@ -11,6 +11,7 @@ public class ComposerJson implements ModuleFileInterface {
     public static String FILE_NAME = "composer.json";
     public static String TEMPLATE = "Magento Module Composer";
     public static String DEFAULT_DEPENDENCY = "\"magento/framework\": \"*\"";
+    public static String NO_DEPENDENCY_LABEL = "None";
     private static ComposerJson INSTANCE = null;
 
     public static ComposerJson getInstance() {