UCT-704: Refactored messages

bohdan-harniuk · bohdan-harniuk · commit 891a3fd5e464 · 2021-11-17T14:29:03.000+01:00
diff --git a/resources/uct/bundle/inspection.properties b/resources/uct/bundle/inspection.properties
@@ -34,20 +34,12 @@ customCode.warnings.deprecated.1338=[1338] Implemented @deprecated interface ''{
 customCode.warnings.deprecated.1439=[1439] Call @deprecated method ''{0}''
 customCode.warnings.deprecated.1534=[1534] Using @deprecated property ''{0}''
 customCode.warnings.deprecated.1535=[1535] Overriding @deprecated property ''{0}''
-customCode.critical.existence.1112=[1112] Imported non-existent class ''{0}''
-customCode.critical.existence.1112.changelog=[1112] Imported class ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1312=[1312] Imported non-existent interface ''{0}''
-customCode.critical.existence.1312.changelog=[1312] Imported interface ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1317=[1317] Inherited non-existent interface ''{0}''
-customCode.critical.existence.1317.changelog=[1317] Inherited interface ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1318=[1318] Implemented non-existent interface ''{0}''
-customCode.critical.existence.1318.changelog=[1318] Implemented interface ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1111=[1111] Extended non-existent class ''{0}''
-customCode.critical.existence.1111.changelog=[1111] Extended class ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1215=[1215] Overridden non-existent constant ''{0}''
-customCode.critical.existence.1215.changelog=[1215] Overridden constant ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1515=[1515] Overridden non-existent property ''{0}''
-customCode.critical.existence.1515.changelog=[1515] Overridden property ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1410=[1410] Called non-existent method ''{0}''
-customCode.critical.existence.1410.changelog=[1410] Called method ''{0}'' that is removed in the ''{1}''
-customCode.critical.existence.1110.changelog=[1110] Used type ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1112=[1112] Imported class ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1312=[1312] Imported interface ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1317=[1317] Inherited interface ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1318=[1318] Implemented interface ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1111=[1111] Extended class ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1215=[1215] Overridden constant ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1515=[1515] Overridden property ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1410=[1410] Called method ''{0}'' that is removed in the ''{1}''
+customCode.critical.existence.1110=[1110] Used type ''{0}'' that is removed in the ''{1}''
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/CalledNonExistentMethod.java b/src/com/magento/idea/magento2uct/inspections/php/existence/CalledNonExistentMethod.java
@@ -31,11 +31,10 @@ protected void execute(
         if (VersionStateManager.getInstance(project).isExists(type)) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.CALLED_NON_EXISTENT_METHOD.getMessage(type)
-                : SupportedIssue.CALLED_NON_EXISTENT_METHOD.getChangelogMessage(
-                type, removedIn);
+        final String message = SupportedIssue.CALLED_NON_EXISTENT_METHOD.getMessage(
+                type,
+                VersionStateManager.getInstance(project).getRemovedInVersion(type)
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/ExtendedNonExistentClass.java b/src/com/magento/idea/magento2uct/inspections/php/existence/ExtendedNonExistentClass.java
@@ -32,11 +32,10 @@ protected void execute(
         if (VersionStateManager.getInstance(project).isExists(parentFqn)) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.EXTENDED_NON_EXISTENT_CLASS.getMessage(parentFqn)
-                : SupportedIssue.EXTENDED_NON_EXISTENT_CLASS.getChangelogMessage(
-                parentFqn, removedIn);
+        final String message = SupportedIssue.EXTENDED_NON_EXISTENT_CLASS.getMessage(
+                parentFqn,
+                VersionStateManager.getInstance(project).getRemovedInVersion(parentFqn)
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/ImplementedNonExistentInterface.java b/src/com/magento/idea/magento2uct/inspections/php/existence/ImplementedNonExistentInterface.java
@@ -28,11 +28,10 @@ protected void execute(
         if (VersionStateManager.getInstance(project).isExists(interfaceFqn)) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.IMPLEMENTED_NON_EXISTENT_INTERFACE.getMessage(interfaceFqn)
-                : SupportedIssue.IMPLEMENTED_NON_EXISTENT_INTERFACE.getChangelogMessage(
-                interfaceFqn, removedIn);
+        final String message = SupportedIssue.IMPLEMENTED_NON_EXISTENT_INTERFACE.getMessage(
+                interfaceFqn,
+                VersionStateManager.getInstance(project).getRemovedInVersion(interfaceFqn)
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/ImportingNonExistentClass.java b/src/com/magento/idea/magento2uct/inspections/php/existence/ImportingNonExistentClass.java
@@ -28,11 +28,10 @@ protected void execute(
         if (isInterface || VersionStateManager.getInstance(project).isExists(use.getFQN())) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getMessage(use.getFQN())
-                : SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getChangelogMessage(
-                        use.getFQN(), removedIn);
+        final String message = SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getMessage(
+                use.getFQN(),
+                VersionStateManager.getInstance(project).getRemovedInVersion(use.getFQN())
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/ImportingNonExistentInterface.java b/src/com/magento/idea/magento2uct/inspections/php/existence/ImportingNonExistentInterface.java
@@ -28,11 +28,10 @@ protected void execute(
         if (!isInterface || VersionStateManager.getInstance(project).isExists(use.getFQN())) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.IMPORTED_NON_EXISTENT_INTERFACE.getMessage(use.getFQN())
-                : SupportedIssue.IMPORTED_NON_EXISTENT_INTERFACE.getChangelogMessage(
-                use.getFQN(), removedIn);
+        final String message = SupportedIssue.IMPORTED_NON_EXISTENT_INTERFACE.getMessage(
+                use.getFQN(),
+                VersionStateManager.getInstance(project).getRemovedInVersion(use.getFQN())
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/InheritedNonExistentInterface.java b/src/com/magento/idea/magento2uct/inspections/php/existence/InheritedNonExistentInterface.java
@@ -28,11 +28,10 @@ protected void execute(
         if (VersionStateManager.getInstance(project).isExists(interfaceFqn)) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.INHERITED_NON_EXISTENT_INTERFACE.getMessage(interfaceFqn)
-                : SupportedIssue.INHERITED_NON_EXISTENT_INTERFACE.getChangelogMessage(
-                interfaceFqn, removedIn);
+        final String message = SupportedIssue.INHERITED_NON_EXISTENT_INTERFACE.getMessage(
+                interfaceFqn,
+                VersionStateManager.getInstance(project).getRemovedInVersion(interfaceFqn)
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/OverriddenNonExistentConstant.java b/src/com/magento/idea/magento2uct/inspections/php/existence/OverriddenNonExistentConstant.java
@@ -36,11 +36,10 @@ protected void execute(
                 .concat("::")
                 .concat(overriddenField.getName());
 
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.OVERRIDDEN_NON_EXISTENT_CONSTANT.getMessage(messageArg)
-                : SupportedIssue.OVERRIDDEN_NON_EXISTENT_CONSTANT.getChangelogMessage(
-                messageArg, removedIn);
+        final String message = SupportedIssue.OVERRIDDEN_NON_EXISTENT_CONSTANT.getMessage(
+                messageArg,
+                VersionStateManager.getInstance(project).getRemovedInVersion(messageArg)
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/OverriddenNonExistentProperty.java b/src/com/magento/idea/magento2uct/inspections/php/existence/OverriddenNonExistentProperty.java
@@ -36,11 +36,10 @@ protected void execute(
                 .concat("::")
                 .concat(overriddenProperty.getName());
 
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
-        final String message = removedIn.isEmpty()
-                ? SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getMessage(messageArg)
-                : SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getChangelogMessage(
-                messageArg, removedIn);
+        final String message = SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getMessage(
+                messageArg,
+                VersionStateManager.getInstance(project).getRemovedInVersion(messageArg)
+        );
 
         if (problemsHolder instanceof UctProblemsHolder) {
             ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/UsedNonExistentType.java b/src/com/magento/idea/magento2uct/inspections/php/existence/UsedNonExistentType.java
@@ -29,10 +29,9 @@ protected void execute(
         if (VersionStateManager.getInstance(project).isExists(phpClass.getFQN())) {
             return;
         }
-        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
         final String message = SupportedIssue.USED_NON_EXISTENT_TYPE.getMessage(
                 phpClass.getFQN(),
-                removedIn
+                VersionStateManager.getInstance(project).getRemovedInVersion(phpClass.getFQN())
         );
 
         if (problemsHolder instanceof UctProblemsHolder) {
diff --git a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java
@@ -29,11 +29,10 @@
 import com.magento.idea.magento2uct.inspections.php.existence.InheritedNonExistentInterface;
 import com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentConstant;
 import com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentProperty;
+import com.magento.idea.magento2uct.inspections.php.existence.UsedNonExistentType;
 import java.lang.reflect.InvocationTargetException;
 import java.util.LinkedList;
 import java.util.List;
-
-import com.magento.idea.magento2uct.inspections.php.existence.UsedNonExistentType;
 import org.jetbrains.annotations.Nullable;
 
 public enum SupportedIssue {
@@ -114,70 +113,60 @@ public enum SupportedIssue {
             1112,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1112",
-            ImportingNonExistentClass.class,
-            "customCode.critical.existence.1112.changelog"
+            ImportingNonExistentClass.class
     ),
     IMPORTED_NON_EXISTENT_INTERFACE(
             1312,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1312",
-            ImportingNonExistentInterface.class,
-            "customCode.critical.existence.1312.changelog"
+            ImportingNonExistentInterface.class
     ),
     INHERITED_NON_EXISTENT_INTERFACE(
             1317,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1317",
-            InheritedNonExistentInterface.class,
-            "customCode.critical.existence.1317.changelog"
+            InheritedNonExistentInterface.class
     ),
     IMPLEMENTED_NON_EXISTENT_INTERFACE(
             1318,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1318",
-            ImplementedNonExistentInterface.class,
-            "customCode.critical.existence.1318.changelog"
+            ImplementedNonExistentInterface.class
     ),
     EXTENDED_NON_EXISTENT_CLASS(
             1111,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1111",
-            ExtendedNonExistentClass.class,
-            "customCode.critical.existence.1111.changelog"
+            ExtendedNonExistentClass.class
     ),
     OVERRIDDEN_NON_EXISTENT_CONSTANT(
             1215,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1215",
-            OverriddenNonExistentConstant.class,
-            "customCode.critical.existence.1215.changelog"
+            OverriddenNonExistentConstant.class
     ),
     OVERRIDDEN_NON_EXISTENT_PROPERTY(
             1515,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1515",
-            OverriddenNonExistentProperty.class,
-            "customCode.critical.existence.1515.changelog"
+            OverriddenNonExistentProperty.class
     ),
     CALLED_NON_EXISTENT_METHOD(
             1410,
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1410",
-            CalledNonExistentMethod.class,
-            "customCode.critical.existence.1410.changelog"
+            CalledNonExistentMethod.class
     ),
     USED_NON_EXISTENT_TYPE(
             1110,
             IssueSeverityLevel.CRITICAL,
-            "customCode.critical.existence.1110.changelog",
-            UsedNonExistentType.class,
-            "customCode.critical.existence.1110.changelog"
+            "customCode.critical.existence.1110",
+            UsedNonExistentType.class
     );
 
     private final int code;
     private final IssueSeverityLevel level;
     private final String message;
-    private final String changelogMessage;
     private final Class<? extends LocalInspectionTool> inspectionClass;
     private static final UctInspectionBundle BUNDLE = new UctInspectionBundle();
 
@@ -194,31 +183,11 @@ public enum SupportedIssue {
             final IssueSeverityLevel level,
             final String message,
             final Class<? extends LocalInspectionTool> inspectionClass
-    ) {
-        this(code, level, message, inspectionClass, null);
-    }
-
-    /**
-     * Known issue ENUM.
-     *
-     * @param code IssueSeverityLevel
-     * @param level IssueSeverityLevel
-     * @param message String
-     * @param inspectionClass Class
-     * @param changelogMessage String
-     */
-    SupportedIssue(
-            final int code,
-            final IssueSeverityLevel level,
-            final String message,
-            final Class<? extends LocalInspectionTool> inspectionClass,
-            final String changelogMessage
     ) {
         this.code = code;
         this.level = level;
         this.message = message;
         this.inspectionClass = inspectionClass;
-        this.changelogMessage = changelogMessage;
     }
 
     /**
@@ -250,21 +219,6 @@ public String getMessage(final Object... args) {
         return BUNDLE.message(message, args);
     }
 
-    /**
-     * Get bundle message for the issue (including changelog arguments).
-     *
-     * @param args Object
-     *
-     * @return String
-     */
-    public String getChangelogMessage(final Object... args) {
-        if (changelogMessage == null) {
-            return getMessage(args);
-        }
-
-        return BUNDLE.message(changelogMessage, args);
-    }
-
     /**
      * Get registered inspection class.
      *
diff --git a/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java b/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java
@@ -73,10 +73,12 @@ public boolean isExists(final @NotNull String fqn) {
     /**
      * Get removed in version for the last checked FQN.
      *
+     * @param fqn String
+     *
      * @return String
      */
-    public String getRemovedInVersion() {
-        return existenceStateIndex.getVersion();
+    public String getRemovedInVersion(final @NotNull String fqn) {
+        return existenceStateIndex.getVersion(fqn);
     }
 
     /**
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java
@@ -29,7 +29,6 @@ public class ExistenceStateIndex implements VersionStateIndex {
     private final Map<String, Boolean> targetVersionData;
     private final Map<String, String> changelog;
     private String projectBasePath;
-    private String version;
 
     /**
      * Existence state index constructor.
@@ -59,27 +58,25 @@ public void setProjectBasePath(final @NotNull String projectBasePath) {
     @SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
     public synchronized boolean has(final @NotNull String fqn) {
         groupLoadedData();
-        version = "";
 
         if (targetVersionData.containsKey(fqn)) {
             return true;
         }
 
-        if (changelog.containsKey(fqn)) {
-            version = changelog.get(fqn);
-            return false;
-        }
-
-        return true;
+        return !changelog.containsKey(fqn);
     }
 
     /**
-     * Get version state after lookup.
+     * Get version for specified FQN from prepared changelog.
+     *
+     * @param fqn String
      *
      * @return String
      */
-    public String getVersion() {
-        return version;
+    public String getVersion(final @NotNull String fqn) {
+        final String version = changelog.get(fqn);
+
+        return version == null ? "some" : version;
     }
 
     /**
