Add a few more mischievous test cases for literal identifiers and slightly improved SignatureTests

Author: Kordyjan

scala3doc-testcases/src/tests/complexNames.scala

@@ -6,7 +6,21 @@ abstract class A:
   def ++(other: A): A
   def +:(other: Int): A
   def :+(other: Int): A
+
   // scala3doc has problems with names in backticks
   // def `multi word name`: Int
   // def `*** name with arbitrary chars ^%`: Int
+  // def `mischievous(param:Int)`(otherParam: Int): String
+  // def withMischievousParams(`param: String, param2`: String): String
+
   def complexName_^*(param: String): A
+
+  def `completelyUnnecessaryBackticks`: Int //expected: def completelyUnnecessaryBackticks: Int
+  def `+++:`(other: Int): A //expected: def +++:(other: Int): A
+  def `:+++`(other: Int): A //expected: def :+++(other: Int): A
+
+  def `abc_^^_&&`: A //expected: def abc_^^_&&: A
+  def `abc_def`: A //expected: def abc_def: A
+  def `abc_def_++`: A //expected: def abc_def_++: A
+  // def `++_abc`: A
+  // def `abc_++_--`: A

scala3doc/test/dotty/dokka/ScaladocTest.scala

@@ -34,7 +34,10 @@ abstract class ScaladocTest(val name: String):
     )
 
   private def tastyFiles =
-    def collectFiles(dir: File): List[String] = dir.listFiles.toList.flatMap {
+    def listFilesSafe(dir: File) = Option(dir.listFiles).getOrElse {
+      throw AssertionError(s"$dir not found. The test name is incorrect or scala3doc-testcases were not recompiled.")
+    }
+    def collectFiles(dir: File): List[String] = listFilesSafe(dir).toList.flatMap {
         case f if f.isDirectory => collectFiles(f)
         case f if f.getName endsWith ".tasty" => f.getAbsolutePath :: Nil
         case _ => Nil
@@ -57,12 +60,14 @@ abstract class ScaladocTest(val name: String):
 
 end ScaladocTest
 
+type Validator = () => Unit
+
 /**
  * Those assertions map 1-1 to their dokka counterparts. Some of them may be irrelevant in scala3doc.
  */
 enum Assertion:
   case AfterPluginSetup(fn: DokkaContext => Unit)
-  case DuringValidation(fn: (() => Unit) => Unit)
+  case DuringValidation(fn: Validator => Unit)
   case AfterDocumentablesCreation(fn: Seq[DModule] => Unit)
   case AfterPreMergeDocumentablesTransformation(fn: Seq[DModule] => Unit)
   case AfterDocumentablesMerge(fn: DModule => Unit)

scala3doc/test/dotty/dokka/SignatureTest.scala

@@ -29,15 +29,15 @@ abstract class SignatureTest(
       .flatMap(signaturesFromSources(_, signatureKinds))
       .toList
     val expectedFromSources: Map[String, List[String]] = allSignaturesFromSources
-      .collect { case Expected(name, signature) => name -> signature }
-      .groupMap(_._1)(_._2)
+      .collect { case e: Expected => e }
+      .groupMap(_.name)(_.signature)
     val unexpectedFromSources: Set[String] = allSignaturesFromSources.collect { case Unexpected(name) => name }.toSet
 
     val actualSignatures: Map[String, Seq[String]] = signaturesFromDocumentation(root).flatMap { signature =>
       findName(signature, signatureKinds).map(_ -> signature)
     }.groupMap(_._1)(_._2)
 
-    val unexpected = unexpectedFromSources.flatMap(actualSignatures.getOrElse(_, Nil))
+    val unexpected = unexpectedFromSources.flatMap(actualSignatures.get)
     val expectedButNotFound = expectedFromSources.flatMap {
       case (k, v) => findMissingSingatures(v, actualSignatures.getOrElse(k, Nil))
     }