Skip to content

Commit d74e650

Browse files
VitaliyBoykoVitaliyBoyko
committed
Refactor and improve code readability across multiple classes
Simplified imports, added Javadoc comments, adjusted annotations, and improved variable usage for clarity and maintainability. Minor structural changes include adding final and transient where applicable and enhancing formatting consistency.
1 parent f73d170 commit d74e650

5 files changed

Lines changed: 63 additions & 29 deletions

File tree

‎src/main/java/com/magento/idea/magento2plugin/actions/content/root/MarkDirectoryAsMagentoContentRot.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77

88
import com.intellij.ide.projectView.ProjectView;
99
import com.intellij.ide.projectView.actions.MarkRootActionBase;
10-
import com.intellij.openapi.actionSystem.*;
10+
import com.intellij.openapi.actionSystem.AnActionEvent;
11+
import com.intellij.openapi.actionSystem.DataContext;
12+
import com.intellij.openapi.actionSystem.LangDataKeys;
13+
import com.intellij.openapi.actionSystem.PlatformCoreDataKeys;
14+
import com.intellij.openapi.actionSystem.Presentation;
1115
import com.intellij.openapi.module.Module;
1216
import com.intellij.openapi.project.Project;
1317
import com.intellij.openapi.roots.ContentEntry;
@@ -18,9 +22,9 @@
1822
import com.magento.idea.magento2plugin.MagentoIcons;
1923
import com.magento.idea.magento2plugin.project.Settings;
2024
import com.magento.idea.magento2plugin.util.magento.MagentoPathUrlUtil;
21-
import org.jetbrains.annotations.NotNull;
2225
import java.net.MalformedURLException;
2326
import java.net.URL;
27+
import org.jetbrains.annotations.NotNull;
2428

2529
public class MarkDirectoryAsMagentoContentRot extends MarkRootActionBase {
2630
private Project project;

‎src/main/java/com/magento/idea/magento2plugin/actions/content/root/UnmarkDirectoryAsMagentoContentRot.java‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77

88
import com.intellij.ide.projectView.ProjectView;
99
import com.intellij.ide.projectView.actions.MarkRootActionBase;
10-
import com.intellij.openapi.actionSystem.*;
10+
import com.intellij.openapi.actionSystem.AnActionEvent;
11+
import com.intellij.openapi.actionSystem.DataContext;
12+
import com.intellij.openapi.actionSystem.LangDataKeys;
13+
import com.intellij.openapi.actionSystem.PlatformCoreDataKeys;
1114
import com.intellij.openapi.module.Module;
1215
import com.intellij.openapi.project.Project;
1316
import com.intellij.openapi.roots.ContentEntry;
@@ -17,25 +20,21 @@
1720
import com.intellij.psi.PsiElement;
1821
import com.magento.idea.magento2plugin.project.Settings;
1922
import com.magento.idea.magento2plugin.util.magento.MagentoPathUrlUtil;
20-
import org.jetbrains.annotations.NotNull;
2123
import java.net.MalformedURLException;
2224
import java.net.URL;
25+
import org.jetbrains.annotations.NotNull;
2326

2427
public class UnmarkDirectoryAsMagentoContentRot extends MarkRootActionBase {
2528
private Project project;
2629

27-
public UnmarkDirectoryAsMagentoContentRot() {
28-
super();
29-
}
30-
3130
@Override
32-
protected void modifyRoots(VirtualFile virtualFile, ContentEntry contentEntry) {
31+
protected void modifyRoots(final VirtualFile virtualFile, ContentEntry contentEntry) {
3332
if (project != null) {
34-
Settings settings = Settings.getInstance(project);
33+
final Settings settings = Settings.getInstance(project);
3534
Settings.getInstance(project).removeMagentoFolder(virtualFile.getUrl());
3635
if (settings.getMagentoFolders() != null) {
3736
settings.getMagentoFolders().removeIf(folder -> {
38-
VirtualFile file = null;
37+
final VirtualFile file;
3938
try {
4039
file = VfsUtil.findFileByURL(new URL(folder));
4140
} catch (MalformedURLException e) {
@@ -50,18 +49,18 @@ protected void modifyRoots(VirtualFile virtualFile, ContentEntry contentEntry) {
5049
}
5150

5251
@Override
53-
public void update(@NotNull AnActionEvent event) {
52+
public void update(@NotNull final AnActionEvent event) {
5453
final DataContext context = event.getDataContext();
5554
final PsiElement targetElement = LangDataKeys.PSI_ELEMENT.getData(context);
56-
Module module = event.getData(PlatformCoreDataKeys.MODULE);
55+
final Module module = event.getData(PlatformCoreDataKeys.MODULE);
5756
if (module != null) {
5857
project = module.getProject();
5958
}
6059

6160
if (targetElement instanceof PsiDirectory && project != null) {
62-
Settings settings = Settings.getInstance(project);
63-
String magentoPathUrl = MagentoPathUrlUtil.execute(project);
64-
String directoryUrl = ((PsiDirectory) targetElement).getVirtualFile().getUrl();
61+
final Settings settings = Settings.getInstance(project);
62+
final String magentoPathUrl = MagentoPathUrlUtil.execute(project);
63+
final String directoryUrl = ((PsiDirectory) targetElement).getVirtualFile().getUrl();
6564
if (magentoPathUrl != null && magentoPathUrl.equals(directoryUrl)) {
6665
event.getPresentation().setEnabledAndVisible(false);
6766
return;

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,13 @@
5151
import org.apache.commons.lang3.ArrayUtils;
5252
import org.jetbrains.annotations.NotNull;
5353

54-
@SuppressWarnings({"PMD.TooManyFields", "PMD.DataClass", "PMD.UnusedPrivateMethod"})
54+
@SuppressWarnings({
55+
"PMD.TooManyFields",
56+
"PMD.DataClass",
57+
"PMD.UnusedPrivateMethod",
58+
"PMD.ConstructorCallsOverridableMethod",
59+
"PMD.SingularField"
60+
})
5561
public class NewModuleDialog extends AbstractDialog implements ListSelectionListener { //NOPMD
5662
private static final String MODULE_DESCRIPTION = "module description";
5763
private static final String MODULE_VERSION = "module version";
@@ -111,8 +117,8 @@ public class NewModuleDialog extends AbstractDialog implements ListSelectionList
111117
@NotNull
112118
private final PsiDirectory initialBaseDir;
113119
private String detectedPackageName;
114-
private final ModuleIndex moduleIndex;
115-
private final CamelCaseToHyphen camelCaseToHyphen;
120+
private final transient ModuleIndex moduleIndex;
121+
private final transient CamelCaseToHyphen camelCaseToHyphen;
116122

117123
/**
118124
* Constructor.
@@ -178,8 +184,10 @@ private void detectPackageName(final @NotNull PsiDirectory initialBaseDir) {
178184
}
179185
}
180186

187+
@Override
181188
protected void onWriteActionOK() {
182189
generateFiles();
190+
exit();
183191
}
184192

185193
private void generateFiles() {

‎src/main/java/com/magento/idea/magento2plugin/project/Settings.java‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ public State() {//NOPMD
202202
* @param myDoNotAskContentConfigAgain boolean
203203
* @param magentoVersion String
204204
* @param magentoEdition String
205-
* @param myMagentoFolders List<PsiDirectory>
205+
* @param myMagentoFolders List
206206
*/
207207
public State(
208208
final boolean pluginEnabled,
@@ -264,6 +264,11 @@ public List<String> getMagentoFolders() {
264264
return this.myMagentoFolders;
265265
}
266266

267+
/**
268+
* Adds a Magento folder to the list of tracked Magento folders.
269+
*
270+
* @param magentoFolders the name of the Magento folder to be added
271+
*/
267272
@Tag("magentoFolders")
268273
public void addMagentoFolder(final String magentoFolders) {
269274
if (this.myMagentoFolders == null) {
@@ -272,6 +277,11 @@ public void addMagentoFolder(final String magentoFolders) {
272277
this.myMagentoFolders.add(magentoFolders);
273278
}
274279

280+
/**
281+
* Removes a specified Magento folder from the list of tracked Magento folders.
282+
*
283+
* @param magentoFolders the name of the Magento folder to be removed
284+
*/
275285
public void removeMagentoFolder(final String magentoFolders) {
276286
if (this.myMagentoFolders != null) {
277287
this.myMagentoFolders.remove(magentoFolders);
@@ -356,8 +366,9 @@ public int hashCode() {
356366
result = 31 * result + (this.isDoNotAskContentConfigAgain() ? 1 : 0);
357367
result = 31 * result + (
358368
this.defaultLicenseName != null ? this.defaultLicenseName.hashCode() : 0
359-
);
360-
result = 31 * result + (this.myMagentoFolders != null ? this.myMagentoFolders.hashCode() : 0);
369+
);
370+
result = 31 * result
371+
+ (this.myMagentoFolders != null ? this.myMagentoFolders.hashCode() : 0);
361372
return result;
362373
}
363374
}

‎src/test/kotlin/com/magento/idea/magento2plugin/actions/content/MarkDirectoryAsMagentoRootTest.kt‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ package com.magento.idea.magento2plugin.actions.content
77

88
import com.automation.remarks.junit5.Video
99
import com.intellij.openapi.util.io.NioFiles.createDirectories
10-
import org.assertj.swing.core.MouseButton
1110
import com.intellij.remoterobot.RemoteRobot
1211
import com.intellij.remoterobot.fixtures.ContainerFixture
1312
import com.intellij.remoterobot.search.locators.byXpath
@@ -19,15 +18,20 @@ import com.intellij.remoterobot.utils.waitForIgnoringError
1918
import com.magento.idea.magento2plugin.pages.*
2019
import com.magento.idea.magento2plugin.utils.RemoteRobotExtension
2120
import com.magento.idea.magento2plugin.utils.StepsLogger
22-
import org.junit.jupiter.api.AfterEach
23-
import org.junit.jupiter.api.BeforeEach
24-
import org.junit.jupiter.api.Test
25-
import org.junit.jupiter.api.extension.ExtendWith
26-
import java.awt.event.KeyEvent.*
21+
import java.awt.event.KeyEvent.VK_1
22+
import java.awt.event.KeyEvent.VK_A
23+
import java.awt.event.KeyEvent.VK_ALT
24+
import java.awt.event.KeyEvent.VK_CONTROL
25+
import java.awt.event.KeyEvent.VK_DELETE
2726
import java.io.File
2827
import java.io.IOException
2928
import java.nio.file.Paths
3029
import java.time.Duration.ofMinutes
30+
import org.assertj.swing.core.MouseButton
31+
import org.junit.jupiter.api.AfterEach
32+
import org.junit.jupiter.api.BeforeEach
33+
import org.junit.jupiter.api.Test
34+
import org.junit.jupiter.api.extension.ExtendWith
3135

3236
@ExtendWith(RemoteRobotExtension::class)
3337
class MarkDirectoryAsMagentoRootTest {
@@ -201,6 +205,9 @@ class MarkDirectoryAsMagentoRootTest {
201205
}
202206
}
203207

208+
/**
209+
* Closes the browser by terminating its process based on the operating system.
210+
*/
204211
fun closeBrowser() {
205212
val os = System.getProperty("os.name").lowercase()
206213

@@ -220,7 +227,12 @@ class MarkDirectoryAsMagentoRootTest {
220227
}
221228
}
222229

223-
230+
/**
231+
* Creates a new plugin in a project without marking the target module as a Magento code root.
232+
*
233+
* @param ideaFrame
234+
* @param remoteRobot
235+
*/
224236
private fun createAPluginWithoutMagentoRootInVendor(
225237
ideaFrame: IdeaFrame,
226238
remoteRobot1: RemoteRobot

0 commit comments

Comments
 (0)