From e8bf72eec654d4fb46d3eca1a255ab3b2ece4c28 Mon Sep 17 00:00:00 2001
From: Junichi Yamamoto <junichi11@apache.org>
Date: Mon, 10 Jul 2023 00:09:29 +0900
Subject: [PATCH] Fix incorrect AbstractClassInstantiationHintError #6119

- https://github.com/apache/netbeans/issues/6119
- Check whether the class name has `$`
- Add unit tests
---
 .../modules/php/editor/CodeUtils.java         |  9 ++++
 .../AbstractClassInstantiationHintError.java  | 12 +++--
 .../AbstractClassInstantiationHint/gh6119.php | 23 +++++++++
 .../gh6119.php.testGH6119.hints               |  1 +
 .../testAbstractClassInstantiationHint.php    |  0
 ...p.testAbstractClassInstantiationHint.hints |  0
 .../testAbstractClassInstantiationHint_02.php |  0
 ...estAbstractClassInstantiationHint_02.hints |  0
 ...stractClassInstantiationHintErrorTest.java | 47 +++++++++++++++++++
 .../php/editor/verification/HintsTest.java    |  8 ----
 10 files changed, 89 insertions(+), 11 deletions(-)
 create mode 100644 php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php.testGH6119.hints
 rename php/php.editor/test/unit/data/testfiles/verification/{ => AbstractClassInstantiationHint}/testAbstractClassInstantiationHint.php (100%)
 rename php/php.editor/test/unit/data/testfiles/verification/{ => AbstractClassInstantiationHint}/testAbstractClassInstantiationHint.php.testAbstractClassInstantiationHint.hints (100%)
 rename php/php.editor/test/unit/data/testfiles/verification/{ => AbstractClassInstantiationHint}/testAbstractClassInstantiationHint_02.php (100%)
 rename php/php.editor/test/unit/data/testfiles/verification/{ => AbstractClassInstantiationHint}/testAbstractClassInstantiationHint_02.php.testAbstractClassInstantiationHint_02.hints (100%)
 create mode 100644 php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintErrorTest.java

diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/CodeUtils.java b/php/php.editor/src/org/netbeans/modules/php/editor/CodeUtils.java
index fcc307ef3106..d87712a33306 100644
--- a/php/php.editor/src/org/netbeans/modules/php/editor/CodeUtils.java
+++ b/php/php.editor/src/org/netbeans/modules/php/editor/CodeUtils.java
@@ -690,6 +690,15 @@ public static boolean isConstructor(MethodDeclaration node) {
         return "__construct".equals(extractMethodName(node)); //NOI18N
     }
 
+    public static boolean isDollaredName(ClassName className) {
+        Expression name = className.getName();
+        if (name instanceof Variable) {
+            Variable variable = (Variable) name;
+            return variable.isDollared();
+        }
+        return false;
+    }
+
     /**
      * Finds common namespace prefixes for the given <b>sorted</b> namespaces.
      * <p>
diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintError.java b/php/php.editor/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintError.java
index f1d3dcc389dc..375807bed5ac 100644
--- a/php/php.editor/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintError.java
+++ b/php/php.editor/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintError.java
@@ -19,11 +19,13 @@
 package org.netbeans.modules.php.editor.verification;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Set;
 import org.netbeans.modules.csl.api.Hint;
 import org.netbeans.modules.csl.api.OffsetRange;
 import org.netbeans.modules.csl.spi.support.CancelSupport;
+import org.netbeans.modules.php.editor.CodeUtils;
 import org.netbeans.modules.php.editor.api.ElementQuery.Index;
 import org.netbeans.modules.php.editor.api.NameKind;
 import org.netbeans.modules.php.editor.api.QualifiedName;
@@ -79,7 +81,7 @@ private CheckVisitor(FileObject fileObject, Index index, Model model) {
         }
 
         public List<Hint> getHints() {
-            return hints;
+            return Collections.unmodifiableList(hints);
         }
 
         @Override
@@ -88,7 +90,12 @@ public List<Hint> getHints() {
             "AbstractClassInstantiationDesc=Abstract class {0} can not be instantiated"
         })
         public void visit(ClassInstanceCreation node) {
-            if (CancelSupport.getDefault().isCancelled()) {
+            if (CancelSupport.getDefault().isCancelled()
+                    || CodeUtils.isDollaredName(node.getClassName())) {
+                // GH-6119
+                // e.g.
+                // abstract class AbstractClass {}
+                // $a = new $abstractClass();
                 return;
             }
             ASTNodeInfo<ClassInstanceCreation> info = ASTNodeInfo.create(node);
@@ -110,7 +117,6 @@ public void visit(ClassInstanceCreation node) {
                 }
             }
         }
-
     }
 
     @Override
diff --git a/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php
new file mode 100644
index 000000000000..105ae28aa97f
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php
@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+abstract class AbstractClass {}
+
+$abstractClass = new $abstractClass();
diff --git a/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php.testGH6119.hints b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php.testGH6119.hints
new file mode 100644
index 000000000000..8b137891791f
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/gh6119.php.testGH6119.hints
@@ -0,0 +1 @@
+
diff --git a/php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint.php b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint.php
similarity index 100%
rename from php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint.php
rename to php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint.php
diff --git a/php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint.php.testAbstractClassInstantiationHint.hints b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint.php.testAbstractClassInstantiationHint.hints
similarity index 100%
rename from php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint.php.testAbstractClassInstantiationHint.hints
rename to php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint.php.testAbstractClassInstantiationHint.hints
diff --git a/php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint_02.php b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint_02.php
similarity index 100%
rename from php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint_02.php
rename to php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint_02.php
diff --git a/php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint_02.php.testAbstractClassInstantiationHint_02.hints b/php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint_02.php.testAbstractClassInstantiationHint_02.hints
similarity index 100%
rename from php/php.editor/test/unit/data/testfiles/verification/testAbstractClassInstantiationHint_02.php.testAbstractClassInstantiationHint_02.hints
rename to php/php.editor/test/unit/data/testfiles/verification/AbstractClassInstantiationHint/testAbstractClassInstantiationHint_02.php.testAbstractClassInstantiationHint_02.hints
diff --git a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintErrorTest.java b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintErrorTest.java
new file mode 100644
index 000000000000..ece8ba50e1a8
--- /dev/null
+++ b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/AbstractClassInstantiationHintErrorTest.java
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.netbeans.modules.php.editor.verification;
+
+public class AbstractClassInstantiationHintErrorTest extends PHPHintsTestBase {
+
+    public AbstractClassInstantiationHintErrorTest(String testName) {
+        super(testName);
+    }
+
+    @Override
+    protected String getTestDirectory() {
+        return TEST_DIRECTORY + "AbstractClassInstantiationHint/";
+    }
+
+    public void testAbstractClassInstantiationHint() throws Exception {
+        checkHints("testAbstractClassInstantiationHint.php");
+    }
+
+    public void testAbstractClassInstantiationHint_02() throws Exception {
+        checkHints("testAbstractClassInstantiationHint_02.php");
+    }
+
+    public void testGH6119() throws Exception {
+        checkHints("gh6119.php");
+    }
+
+    private void checkHints(String fileName) throws Exception {
+        checkHints(new AbstractClassInstantiationHintError(), fileName);
+    }
+}
diff --git a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/HintsTest.java b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/HintsTest.java
index 063fab1c2ce4..3c5cf9c61794 100644
--- a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/HintsTest.java
+++ b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/verification/HintsTest.java
@@ -43,14 +43,6 @@ protected File getDataFile(String relFilePath) {
         return inputFile;
     }
 
-    public void testAbstractClassInstantiationHint() throws Exception {
-        checkHints(new AbstractClassInstantiationHintError(), "testAbstractClassInstantiationHint.php");
-    }
-
-    public void testAbstractClassInstantiationHint_02() throws Exception {
-        checkHints(new AbstractClassInstantiationHintError(), "testAbstractClassInstantiationHint_02.php");
-    }
-
     public void testAmbiguousComparisonHint() throws Exception {
         checkHints(new AmbiguousComparisonHint(), "testAmbiguousComparisonHint.php");
     }