Merge pull request #499 from magento/require-restart-on-plugin-update

Require restart

Author: Vitaliy

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
 
 ## 3.1.3
 
+### Changed
+
+- Require restart on plugin update due to using native libraries
+
 ## 3.1.2
 
 ### Fixed

resources/META-INF/plugin.xml

@@ -4,7 +4,7 @@
  * See COPYING.txt for license details.
  */
 -->
-<idea-plugin>
+<idea-plugin require-restart="true">
     <id>com.magento.idea.magento2plugin</id>
     <name>Magento PhpStorm</name>
     <version>3.1.3</version>

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

@@ -232,7 +232,7 @@ public static void open(
     }
 
     private void createUIComponents() {
-        final List<String> allModulesList = ModuleIndex.getInstance(project)
+        final List<String> allModulesList = new ModuleIndex(project)
                 .getEditableModuleNames();
 
         this.pluginModule = new FilteredComboBox(allModulesList);

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

@@ -192,7 +192,7 @@ public String getObserverModule() {
     }
 
     private void createUIComponents() { //NOPMD
-        final List<String> allModulesList = ModuleIndex.getInstance(project)
+        final List<String> allModulesList = new ModuleIndex(project)
                 .getEditableModuleNames();
 
         this.observerModule = new FilteredComboBox(allModulesList);

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

@@ -123,7 +123,7 @@ public NewModuleDialog(
         this.project = project;
         this.initialBaseDir = initialBaseDir;
         this.camelCaseToHyphen = CamelCaseToHyphen.getInstance();
-        this.moduleIndex = ModuleIndex.getInstance(project);
+        this.moduleIndex = new ModuleIndex(project);
         detectPackageName(initialBaseDir);
         setContentPane(contentPane);
         setModal(true);

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

@@ -235,7 +235,7 @@ public static void open(final @NotNull Project project, final PhpClass targetCla
     }
 
     private void createUIComponents() {
-        final List<String> allModulesList = ModuleIndex.getInstance(project)
+        final List<String> allModulesList = new ModuleIndex(project)
                 .getEditableModuleNames();
 
         this.preferenceModule = new FilteredComboBox(allModulesList);

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

@@ -131,7 +131,7 @@ public static void open(final @NotNull Project project, final PsiFile psiFile) {
     }
 
     private void fillThemeOptions() {
-        final List<String> themeNames = ModuleIndex.getInstance(project).getEditableThemeNames();
+        final List<String> themeNames = new ModuleIndex(project).getEditableThemeNames();
         for (final String themeName: themeNames) {
             theme.addItem(themeName);
         }

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

@@ -48,7 +48,7 @@ public CLICommandClassGenerator(
         this.phpClassData = phpClassData;
 
         this.dirGenerator = DirectoryGenerator.getInstance();
-        this.fileGenerator = FileFromTemplateGenerator.getInstance(project);
+        this.fileGenerator = new FileFromTemplateGenerator(project);
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
     }
@@ -83,7 +83,7 @@ private PhpFile createCLICommandClass(final String actionName) {
     private PsiDirectory getParentDirectory() {
         final String moduleName = this.phpClassData.getModuleName();
         final String[] subDirectories = this.phpClassData.getParentDirectory().split("/");
-        PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
+        PsiDirectory parentDirectory = new ModuleIndex(project)
                 .getModuleDirectoryByModuleName(moduleName);
         for (final String subDirectory : subDirectories) {
             parentDirectory = dirGenerator.findOrCreateSubdirectory(parentDirectory, subDirectory);

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

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation.generator;
 
 import com.intellij.openapi.project.Project;
@@ -14,87 +15,98 @@
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.CronjobTemplate;
-import org.jetbrains.annotations.NotNull;
 import java.util.Properties;
+import org.jetbrains.annotations.NotNull;
 
 public class CronjobClassGenerator extends FileGenerator {
-    private CronjobClassData cronjobClassData;
-    private Project project;
-    private ValidatorBundle validatorBundle;
+    private final CronjobClassData cronjobClassData;
+    private final Project project;
+    private final ValidatorBundle validatorBundle;
     private final DirectoryGenerator directoryGenerator;
     private final FileFromTemplateGenerator fileFromTemplateGenerator;
 
     /**
-     * @param project
-     * @param cronjobClassData
+     * Construct generator.
+     *
+     * @param project Project
+     * @param cronjobClassData CronjobClassData
      */
-    public CronjobClassGenerator(Project project, @NotNull CronjobClassData cronjobClassData) {
+    public CronjobClassGenerator(
+            final Project project,
+            final @NotNull CronjobClassData cronjobClassData
+    ) {
         super(project);
         this.project = project;
         this.cronjobClassData = cronjobClassData;
 
         this.directoryGenerator = DirectoryGenerator.getInstance();
-        this.fileFromTemplateGenerator = FileFromTemplateGenerator.getInstance(project);
+        this.fileFromTemplateGenerator = new FileFromTemplateGenerator(project);
         this.validatorBundle = new ValidatorBundle();
     }
 
     /**
+     * Generate file from code template.
      *
-     * @param actionName
+     * @param actionName String
      *
      * @return void
      */
-    public PsiFile generate(String actionName) {
-        PhpFile cronjobFile = createCronjobClass(actionName);
+    @Override
+    public PsiFile generate(final String actionName) {
+        final PhpFile cronjobFile = createCronjobClass(actionName);
 
         if (cronjobFile == null) {
-            String errorMessage = validatorBundle.message(
-            "validator.file.cantBeCreated",
-            "Cronjob Class"
+            final String errorMessage = validatorBundle.message(
+                    "validator.file.cantBeCreated",
+                    "Cronjob Class"
             );
 
-            throw new RuntimeException(errorMessage);
+            throw new RuntimeException(errorMessage);//NOPMD
         }
 
         return cronjobFile;
     }
 
     /**
+     * Fill template attributes.
      *
-     * @param attributes
+     * @param attributes Properties
      */
-    protected void fillAttributes(Properties attributes) {
-        String cronjobClassName = this.cronjobClassData.getClassName();
-        String cronjobNamespace = this.cronjobClassData.getNamespace();
+    @Override
+    protected void fillAttributes(final Properties attributes) {
+        final String cronjobClassName = this.cronjobClassData.getClassName();
+        final String cronjobNamespace = this.cronjobClassData.getNamespace();
 
         attributes.setProperty("NAME", cronjobClassName);
         attributes.setProperty("NAMESPACE", cronjobNamespace);
     }
 
     /**
-     * Generate Cronjob Class according to data model
+     * Generate Cronjob Class according to data model.
      *
-     * @param actionName
+     * @param actionName String
      *
      * @return PhpFile
      */
-    private PhpFile createCronjobClass(String actionName) {
-        String cronjobClassName = this.cronjobClassData.getClassName();
-        String moduleName = this.cronjobClassData.getModuleName();
-        String[] cronjobSubDirectories = this.cronjobClassData.getDirectory().split("/");
-        PsiDirectory parentDirectory = ModuleIndex.getInstance(project).getModuleDirectoryByModuleName(moduleName);
-
-        for (String cronjobSubDirectory: cronjobSubDirectories) {
-            parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, cronjobSubDirectory);
+    private PhpFile createCronjobClass(final String actionName) {
+        final String cronjobClassName = this.cronjobClassData.getClassName();
+        final String moduleName = this.cronjobClassData.getModuleName();
+        final String[] cronjobSubDirectories = this.cronjobClassData.getDirectory().split("/");
+        PsiDirectory parentDirectory = new ModuleIndex(project)
+                .getModuleDirectoryByModuleName(moduleName);
+
+        for (final String cronjobSubDirectory: cronjobSubDirectories) {
+            parentDirectory = directoryGenerator
+                    .findOrCreateSubdirectory(parentDirectory, cronjobSubDirectory);
         }
 
-        Properties attributes = getAttributes();
+        final Properties attributes = getAttributes();
 
-        PsiFile blockFile = fileFromTemplateGenerator.generate(
-            new CronjobTemplate(cronjobClassName),
-            attributes,
-            parentDirectory,
-            actionName
+        final PsiFile blockFile = fileFromTemplateGenerator.generate(
+                new CronjobTemplate(cronjobClassName),
+                attributes,
+                parentDirectory,
+                actionName
         );
 
         if (blockFile == null) {

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

@@ -44,7 +44,7 @@ public DataModelGenerator(final Project project, final DataModelData modelData)
         this.project = project;
         this.modelData = modelData;
         this.directoryGenerator = DirectoryGenerator.getInstance();
-        this.fileFromTemplateGenerator = FileFromTemplateGenerator.getInstance(project);
+        this.fileFromTemplateGenerator = new FileFromTemplateGenerator(project);
         this.getFirstClassOfFile = GetFirstClassOfFile.getInstance();
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
@@ -122,7 +122,7 @@ private List<String> getUses() {
     }
 
     private PhpClass createModel(final String actionName) {
-        PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
+        PsiDirectory parentDirectory = new ModuleIndex(project)
                 .getModuleDirectoryByModuleName(modelData.getModuleName());
         final PsiFile interfaceFile;
         final Properties attributes = getAttributes();