967: Code refactoring after code review

Author: bohdan-harniuk

resources/fileTemplates/internal/Magento Layout XML.xml.ft

@@ -1,5 +1,10 @@
 <?xml version="1.0"?>
 #parse("XML File Header.xml")
-<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" #if (${IS_ADMIN})layout="admin-1column"#end
+#if (${IS_ADMIN} == "true")
+    #set ($isAdmin = true)
+#else
+    #set ($isAdmin = false)
+#end
+<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" #if ($isAdmin)layout="admin-1column"#end
       xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
 </page>

src/com/magento/idea/magento2plugin/actions/context/xml/NewLayoutXmlAction.java

@@ -12,8 +12,10 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
 import com.magento.idea.magento2plugin.MagentoIcons;
 import com.magento.idea.magento2plugin.actions.generation.dialog.NewLayoutTemplateDialog;
+import com.magento.idea.magento2plugin.magento.files.LayoutXml;
 import com.magento.idea.magento2plugin.magento.packages.Areas;
 import com.magento.idea.magento2plugin.magento.packages.ComponentType;
 import com.magento.idea.magento2plugin.magento.packages.Package;
@@ -22,6 +24,7 @@
 import java.util.Arrays;
 import java.util.List;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 public class NewLayoutXmlAction extends AnAction {
 
@@ -47,11 +50,11 @@ public void update(final @NotNull AnActionEvent event) {
         }
         final DataContext context = event.getDataContext();
         final PsiElement targetElement = LangDataKeys.PSI_ELEMENT.getData(context);
+        final PsiDirectory targetDirectoryCandidate = resolveTargetDirectory(targetElement);
 
-        if (!(targetElement instanceof PsiDirectory)) {
+        if (targetDirectoryCandidate == null) {
             return;
         }
-        final PsiDirectory targetDirectoryCandidate = (PsiDirectory) targetElement;
         final GetMagentoModuleUtil.MagentoModuleData moduleData = GetMagentoModuleUtil
                 .getByContext(targetDirectoryCandidate, project);
 
@@ -104,4 +107,31 @@ private void setIsAvailableForEvent(
         event.getPresentation().setVisible(isAvailable);
         event.getPresentation().setEnabled(isAvailable);
     }
+
+    /**
+     * Resolve target directory.
+     *
+     * @param targetElement PsiElement
+     *
+     * @return PsiDirectory
+     */
+    private @Nullable PsiDirectory resolveTargetDirectory(final PsiElement targetElement) {
+        PsiDirectory target = null;
+
+        if (targetElement instanceof PsiDirectory) {
+            target = (PsiDirectory) targetElement;
+        } else if (targetElement instanceof PsiFile) {
+            target = ((PsiFile) targetElement).getContainingDirectory();
+        }
+
+        if (target == null) {
+            return null;
+        }
+
+        if (LayoutXml.PARENT_DIR.equals(target.getName())) {
+            target = target.getParentDirectory();
+        }
+
+        return target;
+    }
 }

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

@@ -168,7 +168,7 @@ private void autoSelectCurrentArea() {
     }
 
     /**
-     * Get parts of inserted layout name
+     * Get parts of inserted layout name.
      *
      * @return String[]
      */
@@ -187,6 +187,7 @@ private String[] getLayoutNameParts() {
             controllerName = layoutNameParts[1];
             actionName = layoutNameParts[2];
         }
+
         return new String[]{routeName, controllerName, actionName};
     }
 

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

@@ -14,8 +14,6 @@
 import com.intellij.psi.xml.XmlTag;
 import com.magento.idea.magento2plugin.actions.generation.data.LayoutXmlData;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.FindOrCreateLayoutXml;
-import com.magento.idea.magento2plugin.magento.packages.Areas;
-import java.util.Objects;
 import java.util.Properties;
 import org.jetbrains.annotations.NotNull;
 
@@ -38,8 +36,7 @@ public LayoutXmlTemplateGenerator(
         super(project);
         this.layoutXmlData = layoutXmlData;
         this.project = project;
-        final Properties attributes = getAttributes();
-        this.findOrCreateLayoutXml = new FindOrCreateLayoutXml(project, attributes);
+        this.findOrCreateLayoutXml = new FindOrCreateLayoutXml(project);
     }
 
     /**
@@ -83,11 +80,6 @@ public PsiFile generate(final @NotNull String actionName) {
     }
 
     @Override
-    protected void fillAttributes(final Properties attributes) {
-        if (Objects.equals(layoutXmlData.getArea(), Areas.adminhtml.toString())) {
-            attributes.setProperty("IS_ADMIN", Boolean.TRUE.toString());
-        } else {
-            attributes.setProperty("IS_ADMIN", Boolean.FALSE.toString());
-        }
-    }
+    @SuppressWarnings("PMD.UncommentedEmptyMethodBody")
+    protected void fillAttributes(final Properties attributes) {}
 }

src/com/magento/idea/magento2plugin/actions/generation/generator/util/FindOrCreateLayoutXml.java

@@ -15,6 +15,7 @@
 import com.magento.idea.magento2plugin.util.magento.FileBasedIndexUtil;
 import java.util.ArrayList;
 import java.util.Properties;
+import org.jetbrains.annotations.NotNull;
 
 public final class FindOrCreateLayoutXml {
 
@@ -23,12 +24,7 @@ public final class FindOrCreateLayoutXml {
 
     public FindOrCreateLayoutXml(final Project project) {
         this.project = project;
-        this.properties = new Properties();
-    }
-
-    public FindOrCreateLayoutXml(final Project project, Properties properties) {
-        this.project = project;
-        this.properties = properties;
+        properties = new Properties();
     }
 
     /**
@@ -82,9 +78,10 @@ public PsiFile execute(
                 LayoutXml.PARENT_DIR
         );
         if (layoutXmlFile == null) {
+            fillDefaultAttributes(area, properties);
             layoutXmlFile = fileFromTemplateGenerator.generate(
                     layoutXml,
-                    this.properties,
+                    properties,
                     parentDirectory,
                     actionName
             );
@@ -95,4 +92,15 @@ public PsiFile execute(
     private Areas getArea(final String area) {
         return Areas.getAreaByString(area);
     }
+
+    private void fillDefaultAttributes(
+            final @NotNull String area,
+            final @NotNull Properties properties
+    ) {
+        if (Areas.adminhtml.toString().equals(area)) {
+            properties.setProperty("IS_ADMIN", Boolean.TRUE.toString());
+        } else {
+            properties.setProperty("IS_ADMIN", Boolean.FALSE.toString());
+        }
+    }
 }