Merge pull request #784 from bohdan-harniuk/uct-inspection-rephrase-messages-for-deprecations

andrewbess · web-flow · commit ef2a056be695 · 2021-11-19T12:30:24.000+01:00
UCT-774: Rephrased messages for deprecations
diff --git a/resources/uct/bundle/inspection.properties b/resources/uct/bundle/inspection.properties
@@ -27,18 +27,18 @@ inspection.displayName.UsedNonExistentConstant=Used non-existent Adobe Commerce
 inspection.displayName.UsedNonExistentProperty=Used non-existent Adobe Commerce property
 inspection.displayName.ImportedNonApiClass=Imported non Adobe Commerce API class
 inspection.displayName.ImportedNonApiInterface=Imported non Adobe Commerce API interface
-customCode.warnings.deprecated.1131=[1131] Extending from @deprecated class ''{0}''
-customCode.warnings.deprecated.1132=[1132] Importing @deprecated class ''{0}''
-customCode.warnings.deprecated.1134=[1134] Using @deprecated class ''{0}''
-customCode.warnings.deprecated.1234=[1234] Using @deprecated constant ''{0}''
-customCode.warnings.deprecated.1235=[1235] Overriding @deprecated constant ''{0}''
-customCode.warnings.deprecated.1332=[1332] Imported @deprecated interface ''{0}''
-customCode.warnings.deprecated.1334=[1334] Used @deprecated interface ''{0}''
-customCode.warnings.deprecated.1337=[1337] Inherited from @deprecated interface ''{0}''
-customCode.warnings.deprecated.1338=[1338] Implemented @deprecated interface ''{0}''
-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.warnings.deprecated.1131=[1131] Extended class ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1132=[1132] Imported class ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1134=[1134] Used class ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1234=[1234] Used constant ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1235=[1235] Overridden constant ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1332=[1332] Imported interface ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1334=[1334] Used interface ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1337=[1337] Inherited from interface ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1338=[1338] Implemented interface ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1439=[1439] Called method ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1534=[1534] Used property ''{0}'' that is @deprecated in the ''{1}''
+customCode.warnings.deprecated.1535=[1535] Overridden property ''{0}'' that is @deprecated 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}''
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/CallingDeprecatedMethod.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/CallingDeprecatedMethod.java
@@ -34,10 +34,14 @@ protected void execute(
                         SupportedIssue.CALLING_DEPRECATED_METHOD.getCode()
                 );
             }
+            final String deprecatedIn = VersionStateManager.getInstance(project)
+                    .getDeprecatedInVersion(type);
+
             problemsHolder.registerProblem(
                     methodReference,
                     SupportedIssue.CALLING_DEPRECATED_METHOD.getMessage(
-                            type.replace(".", "::")
+                            type.replace(".", "::"),
+                            deprecatedIn
                     ),
                     ProblemHighlightType.LIKE_DEPRECATED
             );
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/ExtendingDeprecatedClass.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/ExtendingDeprecatedClass.java
@@ -32,6 +32,9 @@ protected void execute(
         if (!VersionStateManager.getInstance(project).isDeprecated(parentFqn)) {
             return;
         }
+        final String deprecatedIn = VersionStateManager.getInstance(project)
+                .getDeprecatedInVersion(parentFqn);
+
         for (final ClassReference classReference : childExtends.getReferenceElements()) {
             if (parentFqn.equals(classReference.getFQN())) {
                 if (problemsHolder instanceof UctProblemsHolder) {
@@ -42,7 +45,8 @@ protected void execute(
                 problemsHolder.registerProblem(
                         classReference,
                         SupportedIssue.EXTENDING_DEPRECATED_CLASS.getMessage(
-                                parentClass.getFQN()
+                                parentClass.getFQN(),
+                                deprecatedIn
                         ),
                         ProblemHighlightType.LIKE_DEPRECATED
                 );
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImplementedDeprecatedInterface.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImplementedDeprecatedInterface.java
@@ -31,10 +31,14 @@ protected void execute(
                         SupportedIssue.IMPLEMENTED_DEPRECATED_INTERFACE.getCode()
                 );
             }
+            final String deprecatedIn = VersionStateManager.getInstance(project)
+                    .getDeprecatedInVersion(interfaceFqn);
+
             problemsHolder.registerProblem(
                     reference,
                     SupportedIssue.IMPLEMENTED_DEPRECATED_INTERFACE.getMessage(
-                            interfaceFqn
+                            interfaceFqn,
+                            deprecatedIn
                     ),
                     ProblemHighlightType.LIKE_DEPRECATED
             );
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedClass.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedClass.java
@@ -34,9 +34,15 @@ protected void execute(
                         SupportedIssue.IMPORTING_DEPRECATED_CLASS.getCode()
                 );
             }
+            final String deprecatedIn = VersionStateManager.getInstance(project)
+                    .getDeprecatedInVersion(use.getFQN());
+
             problemsHolder.registerProblem(
                     use,
-                    SupportedIssue.IMPORTING_DEPRECATED_CLASS.getMessage(use.getFQN()),
+                    SupportedIssue.IMPORTING_DEPRECATED_CLASS.getMessage(
+                            use.getFQN(),
+                            deprecatedIn
+                    ),
                     ProblemHighlightType.LIKE_DEPRECATED
             );
         }
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedInterface.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedInterface.java
@@ -34,9 +34,15 @@ protected void execute(
                         SupportedIssue.IMPORTING_DEPRECATED_INTERFACE.getCode()
                 );
             }
+            final String deprecatedIn = VersionStateManager.getInstance(project)
+                    .getDeprecatedInVersion(use.getFQN());
+
             problemsHolder.registerProblem(
                     use,
-                    SupportedIssue.IMPORTING_DEPRECATED_INTERFACE.getMessage(use.getFQN()),
+                    SupportedIssue.IMPORTING_DEPRECATED_INTERFACE.getMessage(
+                            use.getFQN(),
+                            deprecatedIn
+                    ),
                     ProblemHighlightType.LIKE_DEPRECATED
             );
         }
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/InheritedDeprecatedInterface.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/InheritedDeprecatedInterface.java
@@ -31,9 +31,15 @@ protected void execute(
                         SupportedIssue.INHERITED_DEPRECATED_INTERFACE.getCode()
                 );
             }
+            final String deprecatedIn = VersionStateManager.getInstance(project)
+                    .getDeprecatedInVersion(interfaceFqn);
+
             problemsHolder.registerProblem(
                     reference,
-                    SupportedIssue.INHERITED_DEPRECATED_INTERFACE.getMessage(interfaceFqn),
+                    SupportedIssue.INHERITED_DEPRECATED_INTERFACE.getMessage(
+                            interfaceFqn,
+                            deprecatedIn
+                    ),
                     ProblemHighlightType.LIKE_DEPRECATED
             );
         }
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedConstant.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedConstant.java
@@ -37,12 +37,16 @@ protected void execute(
                     SupportedIssue.OVERRIDING_DEPRECATED_CONSTANT.getCode()
             );
         }
+        final String deprecatedIn = VersionStateManager.getInstance(project)
+                .getDeprecatedInVersion(overriddenField.getFQN());
+
         problemsHolder.registerProblem(
                 field,
                 SupportedIssue.OVERRIDING_DEPRECATED_CONSTANT.getMessage(
                         parentClass.getFQN()
                                 .concat("::")
-                                .concat(overriddenField.getName())
+                                .concat(overriddenField.getName()),
+                        deprecatedIn
                 ),
                 ProblemHighlightType.LIKE_DEPRECATED
         );
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedProperty.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedProperty.java
@@ -37,12 +37,16 @@ protected void execute(
                     SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getCode()
             );
         }
+        final String deprecatedIn = VersionStateManager.getInstance(project)
+                .getDeprecatedInVersion(overriddenField.getFQN());
+
         problemsHolder.registerProblem(
                 field,
                 SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getMessage(
                         parentClass.getFQN()
                                 .concat("::")
-                                .concat(overriddenField.getName())
+                                .concat(overriddenField.getName()),
+                        deprecatedIn
                 ),
                 ProblemHighlightType.LIKE_DEPRECATED
         );
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedClass.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedClass.java
@@ -35,9 +35,15 @@ protected void execute(
                     SupportedIssue.USING_DEPRECATED_CLASS.getCode()
             );
         }
+        final String deprecatedIn = VersionStateManager.getInstance(project)
+                .getDeprecatedInVersion(phpClass.getFQN());
+
         problemsHolder.registerProblem(
                 reference,
-                SupportedIssue.USING_DEPRECATED_CLASS.getMessage(phpClass.getFQN()),
+                SupportedIssue.USING_DEPRECATED_CLASS.getMessage(
+                        phpClass.getFQN(),
+                        deprecatedIn
+                ),
                 ProblemHighlightType.LIKE_DEPRECATED
         );
     }
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedConstant.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedConstant.java
@@ -55,10 +55,14 @@ protected void execute(
                     SupportedIssue.USING_DEPRECATED_CONSTANT.getCode()
             );
         }
+        final String deprecatedIn = VersionStateManager.getInstance(project)
+                .getDeprecatedInVersion(constantFqn);
+
         problemsHolder.registerProblem(
                 constantReference,
                 SupportedIssue.USING_DEPRECATED_CONSTANT.getMessage(
-                        containingClass.getFQN().concat("::").concat(constant.getName())
+                        containingClass.getFQN().concat("::").concat(constant.getName()),
+                        deprecatedIn
                 ),
                 ProblemHighlightType.LIKE_DEPRECATED
         );
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedInterface.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedInterface.java
@@ -36,9 +36,15 @@ protected void execute(
                     SupportedIssue.USING_DEPRECATED_INTERFACE.getCode()
             );
         }
+        final String deprecatedIn = VersionStateManager.getInstance(project)
+                .getDeprecatedInVersion(phpClass.getFQN());
+
         problemsHolder.registerProblem(
                 reference,
-                SupportedIssue.USING_DEPRECATED_INTERFACE.getMessage(phpClass.getFQN()),
+                SupportedIssue.USING_DEPRECATED_INTERFACE.getMessage(
+                        phpClass.getFQN(),
+                        deprecatedIn
+                ),
                 ProblemHighlightType.LIKE_DEPRECATED
         );
     }
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedProperty.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedProperty.java
@@ -35,10 +35,14 @@ protected void execute(
                         SupportedIssue.USING_DEPRECATED_PROPERTY.getCode()
                 );
             }
+            final String deprecatedIn = VersionStateManager.getInstance(project)
+                    .getDeprecatedInVersion(field.getFQN());
+
             problemsHolder.registerProblem(
                     fieldReference,
                     SupportedIssue.USING_DEPRECATED_PROPERTY.getMessage(
-                            field.getFQN().replace(".", "::")
+                            field.getFQN().replace(".", "::"),
+                            deprecatedIn
                     ),
                     ProblemHighlightType.LIKE_DEPRECATED
             );
@@ -54,10 +58,14 @@ protected void execute(
                             SupportedIssue.USING_DEPRECATED_PROPERTY.getCode()
                     );
                 }
+                final String deprecatedIn = VersionStateManager.getInstance(project)
+                        .getDeprecatedInVersion(containingClass.getFQN());
+
                 problemsHolder.registerProblem(
                         fieldReference,
                         SupportedIssue.USING_DEPRECATED_PROPERTY.getMessage(
-                                field.getFQN().replace(".", "::")
+                                field.getFQN().replace(".", "::"),
+                                deprecatedIn
                         ),
                         ProblemHighlightType.LIKE_DEPRECATED
                 );
diff --git a/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java b/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java
@@ -61,6 +61,17 @@ public boolean isDeprecated(final @NotNull String fqn) {
         return deprecationStateIndex.has(fqn);
     }
 
+    /**
+     * Get deprecated in version for the specified FQN.
+     *
+     * @param fqn String
+     *
+     * @return String
+     */
+    public String getDeprecatedInVersion(final @NotNull String fqn) {
+        return deprecationStateIndex.getVersion(fqn);
+    }
+
     /**
      * Check if specified FQN is exists in the existence index.
      *
@@ -73,7 +84,7 @@ public boolean isExists(final @NotNull String fqn) {
     }
 
     /**
-     * Get removed in version for the last checked FQN.
+     * Get removed in version for the specified FQN.
      *
      * @param fqn String
      *
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java
