UCT-722: Extended API coverage index

Author: bohdan-harniuk

src/com/magento/idea/magento2uct/versioning/VersionStateManager.java

@@ -8,6 +8,7 @@
 import com.intellij.openapi.project.Project;
 import com.magento.idea.magento2uct.packages.SupportedVersion;
 import com.magento.idea.magento2uct.settings.UctSettingsService;
+import com.magento.idea.magento2uct.versioning.indexes.data.ApiCoverageStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.DeprecationStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.ExistenceStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.VersionStateIndex;
@@ -20,6 +21,7 @@ public final class VersionStateManager {
     private static VersionStateManager instance;
     private final DeprecationStateIndex deprecationStateIndex;
     private final ExistenceStateIndex existenceStateIndex;
+    private final ApiCoverageStateIndex apiCoverageStateIndex;
     private final Boolean isSetIgnoreFlag;
     private final SupportedVersion currentVersion;
     private final SupportedVersion targetVersion;
@@ -81,6 +83,28 @@ public String getRemovedInVersion(final @NotNull String fqn) {
         return existenceStateIndex.getVersion(fqn);
     }
 
+    /**
+     * Check if specified FQN is marked as API.
+     *
+     * @param fqn String
+     *
+     * @return boolean
+     */
+    public boolean isApi(final @NotNull String fqn) {
+        return apiCoverageStateIndex.has(fqn);
+    }
+
+    /**
+     * Get version in which an FQN was marked as an API.
+     *
+     * @param fqn String
+     *
+     * @return String
+     */
+    public String getMarkedAsApiInVersion(final @NotNull String fqn) {
+        return apiCoverageStateIndex.getVersion(fqn);
+    }
+
     /**
      * Version state manager constructor.
      */
@@ -96,6 +120,9 @@ private VersionStateManager(final @NotNull Project project) {
 
         existenceStateIndex = new ExistenceStateIndex();
         compute(existenceStateIndex);
+
+        apiCoverageStateIndex = new ApiCoverageStateIndex();
+        compute(apiCoverageStateIndex);
     }
 
     /**

src/com/magento/idea/magento2uct/versioning/indexes/data/ApiCoverageStateIndex.java

@@ -25,13 +25,18 @@ public class ApiCoverageStateIndex implements VersionStateIndex {
 
     private static final String RESOURCE_DIR = "api";
 
-    private final Map<String, Map<String, Boolean>> data;
-    private final Map<String, String> changelog = new HashMap<>();//NOPMD
+    private final Map<String, Map<String, Boolean>> versioningData;
+    private final Map<String, Boolean> targetVersionData;
+    private final Map<String, String> changelog;
     private String projectBasePath;
-    private String version;//NOPMD
 
+    /**
+     * Api coverage state index constructor.
+     */
     public ApiCoverageStateIndex() {
-        data = new LinkedHashMap<>();
+        versioningData = new LinkedHashMap<>();
+        targetVersionData = new HashMap<>();
+        changelog = new HashMap<>();
     }
 
     /**
@@ -43,13 +48,31 @@ public void setProjectBasePath(final @NotNull String projectBasePath) {
         this.projectBasePath = projectBasePath;
     }
 
+    /**
+     * Check if the specified FQN exists in the existence index.
+     *
+     * @param fqn String
+     *
+     * @return boolean
+     */
+    @SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
+    public synchronized boolean has(final @NotNull String fqn) {
+        groupLoadedData();
+
+        return targetVersionData.containsKey(fqn);
+    }
+
     /**
      * Get version state after lookup.
      *
+     * @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;
     }
 
     /**
@@ -58,16 +81,9 @@ public String getVersion() {
      * @return Map[String, Boolean]
      */
     public Map<String, Boolean> getIndexData() {
-        final Pair<Map<String, Boolean>, Map<String, String>> gatheredData =
-                VersioningDataOperationsUtil.unionVersionDataWithChangelog(
-                        data,
-                        new ArrayList<>(Collections.singletonList(
-                                SupportedVersion.V230.getVersion()
-                        )),
-                        true
-                );
+        groupLoadedData();
 
-        return gatheredData.getFirst();
+        return targetVersionData;
     }
 
     @Override
@@ -139,7 +155,25 @@ private void putIndexData(
             final Map<String, Boolean> indexData
     ) {
         if (indexData != null) {
-            data.put(version, indexData);
+            versioningData.put(version, indexData);
+        }
+    }
+
+    /**
+     * Group data according to purpose.
+     */
+    private void groupLoadedData() {
+        if (targetVersionData.isEmpty() && !versioningData.isEmpty()) {
+            final Pair<Map<String, Boolean>, Map<String, String>> gatheredData =
+                    VersioningDataOperationsUtil.unionVersionDataWithChangelog(
+                            versioningData,
+                            new ArrayList<>(Collections.singletonList(
+                                    SupportedVersion.V230.getVersion()
+                            )),
+                            true
+                    );
+            targetVersionData.putAll(gatheredData.getFirst());
+            changelog.putAll(gatheredData.getSecond());
         }
     }
 }