Skip to content

Commit fdee0ec

Browse files
VitaliyBoykoVitaliyBoyko
committed
2490: Refactor and enhance dialog and module handling logic
Replaced inline lambdas with method references for cleaner code, added `NOPMD` annotations to suppress redundant warnings, and improved transient field usage for serialization safety. Extracted logic for module name retrieval into a reusable method for modularity and reduced code duplication.
1 parent f2239a5 commit fdee0ec

File tree

5 files changed

+80
-64
lines changed

5 files changed

+80
-64
lines changed

‎src/main/java/com/magento/idea/magento2plugin/actions/generation/dialog/AbstractDialog.java‎

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,13 @@
3636
/**
3737
* All code generate dialog should extend this class.
3838
*/
39+
@SuppressWarnings({
40+
"PMD.TooManyMethods"
41+
})
3942
public abstract class AbstractDialog extends JDialog {
4043

41-
protected CommonBundle bundle;
42-
protected final ValidatorBundle validatorBundle = new ValidatorBundle();
44+
protected transient CommonBundle bundle;
45+
protected final transient ValidatorBundle validatorBundle = new ValidatorBundle();
4346
protected final List<FieldValidationData> fieldsValidationsList;
4447
private final String errorTitle;
4548
private JTabbedPane tabbedPane;
@@ -80,13 +83,7 @@ protected void exit() {
8083
* Executes onOK within a WriteAction context.
8184
*/
8285
protected final void executeOnOk() {
83-
WriteAction.run(() -> {
84-
try {
85-
onWriteActionOK();
86-
} catch (Exception e) {
87-
handleOnOkException(e);
88-
}
89-
});
86+
WriteAction.run(this::onWriteActionOK);
9087
}
9188

9289
/**
@@ -96,16 +93,6 @@ protected final void executeOnOk() {
9693
*/
9794
protected abstract void onWriteActionOK();
9895

99-
/**
100-
* Handle any exceptions that are thrown during execution of the onOK logic.
101-
* Default implementation logs or shows the exception.
102-
*
103-
* @param e the exception encountered
104-
*/
105-
protected void handleOnOkException(Exception e) {
106-
e.printStackTrace();
107-
}
108-
10996
/**
11097
* Hook executed when the OK button is pressed.
11198
*/
@@ -118,7 +105,11 @@ protected final void onOK() {
118105
*
119106
* @return boolean
120107
*/
121-
@SuppressWarnings({"PMD.CyclomaticComplexity", "PMD.AvoidDeeplyNestedIfStmts"})
108+
@SuppressWarnings({
109+
"PMD.CyclomaticComplexity",
110+
"PMD.AvoidDeeplyNestedIfStmts",
111+
"PMD.CognitiveComplexity"
112+
})
122113
protected boolean validateFormFields() {
123114
boolean dialogHasErrors;
124115
isValidationErrorShown = dialogHasErrors = false;

‎src/main/java/com/magento/idea/magento2plugin/actions/generation/dialog/NewDataModelDialog.java‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55

66
package com.magento.idea.magento2plugin.actions.generation.dialog;
77

8-
import com.intellij.openapi.application.ReadAction;
9-
import com.intellij.openapi.application.WriteAction;
108
import com.intellij.openapi.project.Project;
119
import com.intellij.openapi.ui.ComboBoxTableRenderer;
1210
import com.intellij.psi.PsiDirectory;
13-
import com.intellij.util.RunnableCallable;
14-
import com.intellij.util.concurrency.AppExecutorUtil;
1511
import com.magento.idea.magento2plugin.actions.generation.NewDataModelAction;
1612
import com.magento.idea.magento2plugin.actions.generation.OverrideClassByAPreferenceAction;
1713
import com.magento.idea.magento2plugin.actions.generation.data.DataModelData;
@@ -55,7 +51,8 @@
5551
import org.jetbrains.annotations.NotNull;
5652

5753
@SuppressWarnings({
58-
"PMD.ExcessiveImports"
54+
"PMD.ExcessiveImports",
55+
"PMD.ConstructorCallsOverridableMethod"
5956
})
6057
public class NewDataModelDialog extends AbstractDialog {
6158

@@ -67,13 +64,13 @@ public class NewDataModelDialog extends AbstractDialog {
6764

6865
private final Project project;
6966
private final String moduleName;
70-
private final ValidatorBundle validatorBundle;
71-
private final CommonBundle commonBundle;
67+
private final transient ValidatorBundle validatorBundle;
68+
private final transient CommonBundle commonBundle;
7269
private final List<String> properties;
7370

74-
private JPanel contentPanel;
75-
private JButton buttonOK;
76-
private JButton buttonCancel;
71+
private JPanel contentPanel; //NOPMD
72+
private JButton buttonOK; //NOPMD
73+
private JButton buttonCancel; //NOPMD
7774
private JTable propertyTable;
7875
private JButton addProperty;
7976
private JCheckBox createInterface;
@@ -125,7 +122,9 @@ public void windowClosing(final WindowEvent event) {
125122
JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
126123
);
127124

128-
addComponentListener(new FocusOnAFieldListener(() -> modelName.requestFocusInWindow()));
125+
addComponentListener(new FocusOnAFieldListener(() -> {
126+
modelName.requestFocusInWindow();
127+
}));
129128
}
130129

131130
/**

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public void windowClosing(WindowEvent event) {
101101
JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
102102
);
103103

104-
addComponentListener(new FocusOnAFieldListener(() -> area.requestFocusInWindow()));
104+
addComponentListener(new FocusOnAFieldListener(this::run));
105105
autoSelectCurrentArea();
106106
}
107107

@@ -164,6 +164,9 @@ private void autoSelectCurrentArea() {
164164
}
165165
}
166166

167+
@SuppressWarnings({
168+
"PMD.AvoidLiteralsInIfCondition"
169+
})
167170
private String[] getLayoutNameParts() {
168171
final String[] layoutNameParts = layoutName.getText().trim().split("_");
169172
String routeName = "";
@@ -189,4 +192,8 @@ private String[] getLayoutNameParts() {
189192
private String getArea() {
190193
return area.getSelectedItem().toString();
191194
}
195+
196+
private void run() {
197+
area.requestFocusInWindow();
198+
}
192199
}

‎src/main/java/com/magento/idea/magento2plugin/actions/generation/dialog/NewSetupDataPatchDialog.java‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
import javax.swing.JTextField;
2828
import javax.swing.KeyStroke;
2929

30+
@SuppressWarnings({
31+
"PMD.ConstructorCallsOverridableMethod"
32+
})
3033
public class NewSetupDataPatchDialog extends AbstractDialog {
3134

3235
private static final String CLASS_NAME = "Class Name";
@@ -36,16 +39,16 @@ public class NewSetupDataPatchDialog extends AbstractDialog {
3639
private final String moduleName;
3740
private final String modulePackage;
3841

39-
private JPanel contentPanel;
40-
private JButton buttonOK;
41-
private JButton buttonCancel;
42+
private JPanel contentPanel; //NOPMD
43+
private JButton buttonOK; //NOPMD
44+
private JButton buttonCancel; //NOPMD
4245

4346
@FieldValidation(rule = RuleRegistry.NOT_EMPTY, message = {NotEmptyRule.MESSAGE, CLASS_NAME})
4447
@FieldValidation(rule = RuleRegistry.PHP_CLASS, message = {PhpClassRule.MESSAGE, CLASS_NAME})
4548
private JTextField className;
4649

47-
private JLabel classNameLabel;
48-
private JLabel classNameErrorMessage;
50+
private JLabel classNameLabel; //NOPMD
51+
private JLabel classNameErrorMessage; //NOPMD
4952

5053
/**
5154
* Constructs a new instance of the NewSetupDataPatchDialog.
@@ -56,10 +59,10 @@ public class NewSetupDataPatchDialog extends AbstractDialog {
5659
* @param moduleName The name of the target Magento 2 module.
5760
*/
5861
public NewSetupDataPatchDialog(
59-
Project project,
60-
PsiDirectory directory,
61-
String modulePackage,
62-
String moduleName
62+
final Project project,
63+
final PsiDirectory directory,
64+
final String modulePackage,
65+
final String moduleName
6366
) {
6467
super();
6568

@@ -92,19 +95,21 @@ public void windowClosing(WindowEvent event) {
9295
JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
9396
);
9497

95-
addComponentListener(new FocusOnAFieldListener(() -> className.requestFocusInWindow()));
98+
addComponentListener(new FocusOnAFieldListener(() -> {
99+
className.requestFocusInWindow();
100+
}));
96101
}
97102

98103
/**
99104
* Open dialog.
100105
*/
101106
public static void open(
102-
Project project,
103-
PsiDirectory directory,
104-
String modulePackage,
105-
String moduleName
107+
final Project project,
108+
final PsiDirectory directory,
109+
final String modulePackage,
110+
final String moduleName
106111
) {
107-
NewSetupDataPatchDialog dialog = new NewSetupDataPatchDialog(
112+
final NewSetupDataPatchDialog dialog = new NewSetupDataPatchDialog(
108113
project,
109114
directory,
110115
modulePackage,
@@ -127,13 +132,13 @@ protected void onWriteActionOK() {
127132
}
128133

129134
private void generateFile() {
130-
PsiDirectory directory = DirectoryGenerator.getInstance().findOrCreateSubdirectories(
135+
final PsiDirectory directory = DirectoryGenerator.getInstance().findOrCreateSubdirectories(
131136
baseDir,
132137
NewSetupDataPatchAction.PATCH_DIRECTORY
133138
+ "/"
134139
+ NewSetupDataPatchAction.DATA_DIRECTORY
135140
);
136-
ModuleSetupDataPatchGenerator generator = new ModuleSetupDataPatchGenerator(
141+
final ModuleSetupDataPatchGenerator generator = new ModuleSetupDataPatchGenerator(
137142
new ModuleSetupDataPatchData(
138143
modulePackage,
139144
moduleName,
@@ -151,7 +156,7 @@ public String getClassName() {
151156
}
152157

153158
private boolean validateFields() {
154-
PsiDirectory patchDirectory = baseDir
159+
final PsiDirectory patchDirectory = baseDir
155160
.findSubdirectory(NewSetupDataPatchAction.PATCH_DIRECTORY);
156161
PsiDirectory directory = null;
157162

@@ -160,8 +165,8 @@ private boolean validateFields() {
160165
}
161166

162167
if (directory != null) {
163-
for (PsiFile file : directory.getFiles()) {
164-
String className = ModuleSetupDataPatchFile
168+
for (final PsiFile file : directory.getFiles()) {
169+
final String className = ModuleSetupDataPatchFile
165170
.resolveClassNameFromInput(getClassName());
166171

167172
if (file.getName().equals(className + ModuleSetupDataPatchFile.EXTENSION)) {

‎src/main/java/com/magento/idea/magento2plugin/actions/groups/NewModuleFileGroup.java‎

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
import com.magento.idea.magento2plugin.actions.generation.util.IsClickedDirectoryInsideProject;
2020
import com.magento.idea.magento2plugin.project.Settings;
2121
import com.magento.idea.magento2plugin.stubs.indexes.ModuleNameIndex;
22+
import org.jetbrains.annotations.Nullable;
23+
2224
import java.util.Collection;
2325

2426
public class NewModuleFileGroup extends NonTrivialActionGroup {
@@ -58,15 +60,33 @@ public void update(final AnActionEvent event) {
5860
return;
5961
}
6062

61-
String moduleName = null;
62-
VirtualFile psiDirectoryVirtualFile = ((PsiDirectory) psiElement).getVirtualFile();
63+
final VirtualFile psiDirectoryVirtualFile = ((PsiDirectory) psiElement).getVirtualFile();
64+
final String moduleName = getModuleName(project, psiDirectoryVirtualFile);
65+
if (moduleName != null) {
66+
event.getPresentation().setVisible(true);
67+
return;
68+
}
6369

64-
for (var entry : FileBasedIndex.getInstance().getAllKeys(ModuleNameIndex.KEY, project)) {
65-
Collection<VirtualFile> moduleVfs = FileBasedIndex.getInstance().getContainingFiles(
70+
event.getPresentation().setVisible(false);
71+
}
72+
73+
/**
74+
* Retrieves the module name associated with a given directory within a project.
75+
*
76+
* @param project the project within which the module search is performed
77+
* @param psiDirectoryVirtualFile the virtual file representing the directory being checked
78+
*/
79+
private static @Nullable String getModuleName(
80+
final Project project,
81+
final VirtualFile psiDirectoryVirtualFile
82+
) {
83+
String moduleName = null;
84+
for (final String entry : FileBasedIndex.getInstance().getAllKeys(ModuleNameIndex.KEY, project)) {
85+
final Collection<VirtualFile> moduleVfs = FileBasedIndex.getInstance().getContainingFiles(
6686
ModuleNameIndex.KEY, entry, GlobalSearchScope.projectScope(project)
6787
);
6888

69-
for (VirtualFile moduleFile : moduleVfs) {
89+
for (final VirtualFile moduleFile : moduleVfs) {
7090
if (moduleFile.getParent().getPath().equals(psiDirectoryVirtualFile.getPath())) {
7191
moduleName = entry;
7292
break;
@@ -77,12 +97,6 @@ public void update(final AnActionEvent event) {
7797
break;
7898
}
7999
}
80-
81-
if (moduleName != null) {
82-
event.getPresentation().setVisible(true);
83-
return;
84-
}
85-
86-
event.getPresentation().setVisible(false);
100+
return moduleName;
87101
}
88102
}

0 commit comments

Comments
 (0)