Skip to content

UCT-766: Prioritised messages, code refactoring #802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 24, 2021
Merged

UCT-766: Prioritised messages, code refactoring #802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 19 additions & 24 deletions src/com/magento/idea/magento2uct/execution/GenerateUctReportCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@
import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
import com.magento.idea.magento2uct.packages.SupportedIssue;
import com.magento.idea.magento2uct.settings.UctSettingsService;
import com.magento.idea.magento2uct.util.inspection.FilterDescriptorResultsUtil;
import com.magento.idea.magento2uct.util.inspection.SortDescriptorResultsUtil;
import java.nio.file.Paths;
import java.util.List;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

Expand Down Expand Up @@ -128,32 +130,25 @@ public void execute() {
}
outputUtil.printProblemFile(filename);
}
final List<ProblemDescriptor> problems = SortDescriptorResultsUtil.sort(
FilterDescriptorResultsUtil.filter(fileProblemsHolder)
);

for (final ProblemDescriptor descriptor
: SortDescriptorResultsUtil.sort(
fileProblemsHolder.getResults()
)) {
final Integer code = fileProblemsHolder.getErrorCodeForDescriptor(
descriptor
for (final ProblemDescriptor descriptor : problems) {
final SupportedIssue issue = fileProblemsHolder.getIssue(descriptor);

final String errorMessage = descriptor
.getDescriptionTemplate()
.substring(6)
.trim();
summary.addToSummary(issue.getLevel());
reportBuilder.addIssue(
descriptor.getLineNumber() + 1,
filename,
errorMessage,
issue
);
if (code != null) {
final SupportedIssue issue = SupportedIssue.getByCode(code);

if (issue != null) {
final String errorMessage = descriptor
.getDescriptionTemplate()
.substring(6)
.trim();
summary.addToSummary(issue.getLevel());
reportBuilder.addIssue(
descriptor.getLineNumber() + 1,
filename,
errorMessage,
issue
);
}
outputUtil.printIssue(descriptor, code);
}
outputUtil.printIssue(descriptor, issue.getCode());
}
}
}
Expand Down
31 changes: 19 additions & 12 deletions src/com/magento/idea/magento2uct/inspections/UctProblemsHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,19 @@
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.psi.PsiFile;
import com.magento.idea.magento2uct.packages.SupportedIssue;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.InputMismatchException;
import java.util.List;
import java.util.Map;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class UctProblemsHolder extends ProblemsHolder {

private final Map<ProblemDescriptor, Integer> myProblemCodes = new HashMap<>();
private Integer reservedErrorCode;
private final Map<ProblemDescriptor, SupportedIssue> myProblemCodes = new HashMap<>();
private SupportedIssue issue;

/**
* UCT problems holder constructor.
Expand All @@ -38,36 +39,42 @@ public UctProblemsHolder(
}

/**
* Set reserved error code.
* Set reserved issue.
*
* @param errorCode int
* @param issue SupportedIssue
*/
public void setReservedErrorCode(final int errorCode) {
reservedErrorCode = errorCode;
public void setIssue(final @NotNull SupportedIssue issue) {
this.issue = issue;
}

/**
* Get issue code by problem descriptor.
* Get issue by problem descriptor.
*
* @param problemDescriptor ProblemDescriptor
*
* @return Integer
*/
public @Nullable Integer getErrorCodeForDescriptor(
public @NotNull SupportedIssue getIssue(
final @NotNull ProblemDescriptor problemDescriptor
) {
return myProblemCodes.get(problemDescriptor);
}

@Override
public void registerProblem(final @NotNull ProblemDescriptor problemDescriptor) {
if (issue == null) {
throw new InputMismatchException(
"For the UCT CLI inspection it is mandatory to set an issue via "
+ "UctProblemsHolder.setIssue method"
);
}
final int problemCount = getMyProblems().size();
super.registerProblem(problemDescriptor);

// if problem has been added successfully
if (problemCount != getMyProblems().size() && reservedErrorCode != null) {
myProblemCodes.put(problemDescriptor, reservedErrorCode);
reservedErrorCode = null;//NOPMD
if (problemCount != getMyProblems().size()) {
myProblemCodes.put(problemDescriptor, issue);
issue = null;//NOPMD
}
}

Expand Down
4 changes: 1 addition & 3 deletions src/com/magento/idea/magento2uct/inspections/php/api/CalledNonApiMethod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ protected void execute(
final String message = SupportedIssue.CALLED_NON_API_METHOD.getMessage(method.getFQN());

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.CALLED_NON_API_METHOD.getCode()
);
((UctProblemsHolder) problemsHolder).setIssue(SupportedIssue.CALLED_NON_API_METHOD);
}
problemsHolder.registerProblem(methodReference, message, ProblemHighlightType.WARNING);
}
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/CalledNonInterfaceMethod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ protected void execute(
}

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.CALLED_NON_INTERFACE_METHOD.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.CALLED_NON_INTERFACE_METHOD
);
}
problemsHolder.registerProblem(
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/ExtendedNonApiClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ protected void execute(
);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.EXTENDED_NON_API_CLASS.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.EXTENDED_NON_API_CLASS
);
}

Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/ImplementedNonApiInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ protected void execute(
);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.IMPLEMENTED_NON_API_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.IMPLEMENTED_NON_API_INTERFACE
);
}
problemsHolder.registerProblem(reference, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/ImportedNonApiClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ protected void execute(
final String message = SupportedIssue.IMPORTED_NON_API_CLASS.getMessage(use.getFQN());

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.IMPORTED_NON_API_CLASS.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.IMPORTED_NON_API_CLASS
);
}
problemsHolder.registerProblem(use, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/ImportedNonApiInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ protected void execute(
final String message = SupportedIssue.IMPORTED_NON_API_INTERFACE.getMessage(use.getFQN());

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.IMPORTED_NON_API_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.IMPORTED_NON_API_INTERFACE
);
}
problemsHolder.registerProblem(use, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/InheritedNonApiInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ protected void execute(
final String message = SupportedIssue.INHERITED_NON_API_INTERFACE.getMessage(fqn);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.INHERITED_NON_API_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.INHERITED_NON_API_INTERFACE
);
}
problemsHolder.registerProblem(reference, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/OverriddenNonApiConstant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ protected void execute(
);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.OVERRIDDEN_NON_API_CONSTANT.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.OVERRIDDEN_NON_API_CONSTANT
);
}
problemsHolder.registerProblem(field, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/OverriddenNonApiProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ protected void execute(
);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.OVERRIDDEN_NON_API_PROPERTY.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.OVERRIDDEN_NON_API_PROPERTY
);
}
problemsHolder.registerProblem(property, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/PossibleDependencyOnImplDetails.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ protected void execute(
if (VersionStateManager.getInstance(project).isApi(implementedInterface.getFQN())) {

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.POSSIBLE_DEPENDENCY_ON_IMPL_DETAILS.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.POSSIBLE_DEPENDENCY_ON_IMPL_DETAILS
);
}

Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/api/UsedNonApiConstant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ protected void execute(
);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.USED_NON_API_CONSTANT.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.USED_NON_API_CONSTANT
);
}
problemsHolder.registerProblem(constantReference, message, ProblemHighlightType.WARNING);
Expand Down
4 changes: 1 addition & 3 deletions src/com/magento/idea/magento2uct/inspections/php/api/UsedNonApiProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ protected void execute(
);

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.USED_NON_API_PROPERTY.getCode()
);
((UctProblemsHolder) problemsHolder).setIssue(SupportedIssue.USED_NON_API_PROPERTY);
}
problemsHolder.registerProblem(propertyReference, message, ProblemHighlightType.WARNING);
}
Expand Down
4 changes: 1 addition & 3 deletions src/com/magento/idea/magento2uct/inspections/php/api/UsedNonApiType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@ protected void execute(
final String message = SupportedIssue.USED_NON_API_TYPE.getMessage(phpClass.getFQN());

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.USED_NON_API_TYPE.getCode()
);
((UctProblemsHolder) problemsHolder).setIssue(SupportedIssue.USED_NON_API_TYPE);
}
problemsHolder.registerProblem(reference, message, ProblemHighlightType.WARNING);
}
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/deprecation/CallingDeprecatedMethod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ protected void execute(

if (VersionStateManager.getInstance(project).isDeprecated(type)) {
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.CALLING_DEPRECATED_METHOD.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.CALLING_DEPRECATED_METHOD
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/deprecation/ExtendingDeprecatedClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ protected void execute(
for (final ClassReference classReference : childExtends.getReferenceElements()) {
if (parentFqn.equals(classReference.getFQN())) {
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.EXTENDING_DEPRECATED_CLASS.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.EXTENDING_DEPRECATED_CLASS
);
}
problemsHolder.registerProblem(
Expand Down
4 changes: 2 additions & 2 deletions .../magento/idea/magento2uct/inspections/php/deprecation/ImplementedDeprecatedInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ protected void execute(
) {
if (VersionStateManager.getInstance(project).isDeprecated(interfaceFqn)) {
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.IMPLEMENTED_DEPRECATED_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.IMPLEMENTED_DEPRECATED_INTERFACE
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ protected void execute(
return;
}
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.IMPORTING_DEPRECATED_CLASS.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.IMPORTING_DEPRECATED_CLASS
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions ...om/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ protected void execute(
return;
}
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.IMPORTING_DEPRECATED_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.IMPORTING_DEPRECATED_INTERFACE
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions ...om/magento/idea/magento2uct/inspections/php/deprecation/InheritedDeprecatedInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ protected void execute(
) {
if (VersionStateManager.getInstance(project).isDeprecated(interfaceFqn)) {
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.INHERITED_DEPRECATED_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.INHERITED_DEPRECATED_INTERFACE
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions ...om/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedConstant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ protected void execute(
}

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.OVERRIDING_DEPRECATED_CONSTANT.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.OVERRIDING_DEPRECATED_CONSTANT
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions ...om/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ protected void execute(
}

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ protected void execute(
return;
}
if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.USING_DEPRECATED_CLASS.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.USING_DEPRECATED_CLASS
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedConstant.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ protected void execute(
}

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.USING_DEPRECATED_CONSTANT.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.USING_DEPRECATED_CONSTANT
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
4 changes: 2 additions & 2 deletions src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ protected void execute(
}

if (problemsHolder instanceof UctProblemsHolder) {
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
SupportedIssue.USING_DEPRECATED_INTERFACE.getCode()
((UctProblemsHolder) problemsHolder).setIssue(
SupportedIssue.USING_DEPRECATED_INTERFACE
);
}
final String deprecatedIn = VersionStateManager.getInstance(project)
Expand Down
Loading