1030: Extended fqn escaping and references analysis

Author: bohdan-harniuk

src/com/magento/idea/magento2uct/inspections/UctProblemsHolder.java

@@ -74,7 +74,6 @@ public void registerProblem(final @NotNull ProblemDescriptor problemDescriptor)
         // if problem has been added successfully
         if (problemCount != getMyProblems().size()) {
             myProblemCodes.put(problemDescriptor, issue);
-            issue = null;//NOPMD
         }
     }
 

src/com/magento/idea/magento2uct/util/php/FqnValidatorUtil.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.util.php;
+
+import com.intellij.openapi.util.text.StringUtil;
+import org.jetbrains.annotations.NotNull;
+
+public final class MagentoReferenceUtil {
+
+    public static final String PHP_REFERENCE_SEPARATOR = "::";
+
+    private MagentoReferenceUtil() {
+    }
+
+    /**
+     * Check if reference looks like a PHP reference.
+     *
+     * @param referenceCandidate String
+     *
+     * @return boolean
+     */
+    public static boolean isReference(final @NotNull String referenceCandidate) {
+        return referenceCandidate.contains(PHP_REFERENCE_SEPARATOR)
+                && referenceCandidate.split(PHP_REFERENCE_SEPARATOR).length == 2;
+    }
+
+    /**
+     * Check if reference looks like a PHP method reference.
+     *
+     * @param referenceCandidate String
+     *
+     * @return boolean
+     */
+    public static boolean isMethodReference(final @NotNull String referenceCandidate) {
+        if (isReference(referenceCandidate)) {
+            final String referencePart = referenceCandidate.split(PHP_REFERENCE_SEPARATOR)[1];
+
+            return StringUtil.isJavaIdentifier(referencePart);
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if reference looks like a PHP constant reference.
+     *
+     * @param referenceCandidate String
+     *
+     * @return boolean
+     */
+    public static boolean isConstantReference(final @NotNull String referenceCandidate) {
+        if (isReference(referenceCandidate)) {
+            final String referencePart = referenceCandidate.split(PHP_REFERENCE_SEPARATOR)[1];
+
+            return StringUtil.isUpperCase(referencePart);
+        }
+
+        return false;
+    }
+}

src/com/magento/idea/magento2uct/util/php/MagentoReferenceUtil.java

@@ -15,8 +15,7 @@ public final class MagentoTypeEscapeUtil {
             = "(Factory|\\\\Proxy|Factory\\\\Proxy)($|\\.)";
     public static final Pattern FACTORY_PROXY_TYPE_PATTERN
             = Pattern.compile(FACTORY_PROXY_TYPE_REGEX, Pattern.MULTILINE);
-    public static final String PHP_PROPERTY_REFERENCE_SEPARATOR = "::";
-    public static final String JAVA_PROPERTY_REFERENCE_SEPARATOR = ".";
+    public static final String JAVA_REFERENCE_SEPARATOR = ".";
 
     private MagentoTypeEscapeUtil() {
     }
@@ -43,7 +42,7 @@ private MagentoTypeEscapeUtil() {
             result = result.substring(0, begin) + result.substring(end);
         }
 
-        return typeFqn.equals(result) ? typeFqn : result;
+        return typeFqn.equals(result) ? escapeProperty(typeFqn) : escapeProperty(result);
     }
 
     /**
@@ -54,11 +53,10 @@ private MagentoTypeEscapeUtil() {
      * @return String
      */
     public static @NotNull String escapeProperty(final @NotNull String typeFqn) {
-        if (typeFqn.contains(PHP_PROPERTY_REFERENCE_SEPARATOR)
-                && typeFqn.split(PHP_PROPERTY_REFERENCE_SEPARATOR).length == 1) {
+        if (MagentoReferenceUtil.isReference(typeFqn)) {
             return typeFqn.replace(
-                    PHP_PROPERTY_REFERENCE_SEPARATOR,
-                    JAVA_PROPERTY_REFERENCE_SEPARATOR
+                    MagentoReferenceUtil.PHP_REFERENCE_SEPARATOR,
+                    JAVA_REFERENCE_SEPARATOR
             );
         }
 

src/com/magento/idea/magento2uct/util/php/MagentoTypeEscapeUtil.java

@@ -17,6 +17,7 @@
 import java.util.List;
 import org.jetbrains.annotations.NotNull;
 
+@SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
 public final class VersionStateManager {
 
     private static VersionStateManager instance;
@@ -35,7 +36,6 @@ public final class VersionStateManager {
      *
      * @return VersionStateManager
      */
-    @SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
     public static synchronized VersionStateManager getInstance(
             final @NotNull Project project
     ) { //NOPMD
@@ -60,9 +60,7 @@ public static synchronized VersionStateManager getInstance(
      * @return boolean
      */
     public synchronized boolean isPresentInCodebase(final @NotNull String fqn) {
-        String safeFqn = MagentoTypeEscapeUtil.escapeProperty(escapeFqn(fqn));
-
-        return existenceStateIndex.isPresentInCodebase(safeFqn);
+        return existenceStateIndex.isPresentInCodebase(escapeFqn(fqn));
     }
 
     /**

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

@@ -16,18 +16,22 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import org.jetbrains.annotations.NotNull;
 
+@SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
 public class ExistenceStateIndex implements VersionStateIndex {
 
     private static final String RESOURCE_DIR = "existence";
 
     private final Map<String, Map<String, Boolean>> versioningData;
     private final Map<String, Boolean> targetVersionData;
     private final Map<String, String> changelog;
+    private final Set<String> codebase;
     private String projectBasePath;
 
     /**
@@ -37,6 +41,7 @@ public ExistenceStateIndex() {
         versioningData = new LinkedHashMap<>();
         targetVersionData = new HashMap<>();
         changelog = new HashMap<>();
+        codebase = new HashSet<>();
     }
 
     /**
@@ -55,7 +60,6 @@ public void setProjectBasePath(final @NotNull String projectBasePath) {
      *
      * @return boolean
      */
-    @SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
     public synchronized boolean has(final @NotNull String fqn) {
         groupLoadedData();
 
@@ -74,7 +78,7 @@ public synchronized boolean has(final @NotNull String fqn) {
      * @return boolean
      */
     public synchronized boolean isPresentInCodebase(final @NotNull String fqn) {
-        return changelog.containsKey(fqn);
+        return codebase.contains(fqn);
     }
 
     /**
@@ -198,6 +202,7 @@ private void groupLoadedData() {
                     );
             targetVersionData.putAll(gatheredData.getFirst());
             changelog.putAll(gatheredData.getSecond());
+            codebase.addAll(VersioningDataOperationsUtil.unionVersionData(versioningData).keySet());
         }
     }
 }