Add tests covering members grouping in scaladoc

Author: BarkingBad

scaladoc-testcases/src/tests/abstractmembersignatures.scala

@@ -0,0 +1,22 @@
+package tests
+package abstractmembersignatures
+
+
+trait TestTrait:
+  def shouldBeAbstract: Int
+  def shouldBeConcrete: Int = 1
+
+class TestClass:
+  def shouldBeConcrete: Int = 1
+
+abstract class AbstractTestClass:
+  def shouldBeAbstract: Int
+  def shouldBeConcrete: Int = 1
+
+object TestObject:
+  abstract class AbstractInnerClass:
+    def shouldBeAbstract: Int
+    def shouldBeConcrete: Int = 1
+
+  class InnerClass:
+    def shouldBeConcrete: Int = 1

scaladoc-testcases/src/tests/traitmethodsgrouping.scala

@@ -28,6 +28,7 @@ enum VisibilityScope:
 
 enum Modifier(val name: String, val prefix: Boolean):
   case Abstract extends Modifier("abstract", true)
+  case Deferred extends Modifier("", true)
   case Final extends Modifier("final", true)
   case Empty extends Modifier("", true)
   case Sealed extends Modifier("sealed", true)

scaladoc/src/dotty/tools/scaladoc/api.scala

@@ -123,7 +123,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     case _ => Nil
   }
 
-  def memberSingnature(member: Member) =
+  def memberSignature(member: Member) =
     val depStyle = if member.deprecated.isEmpty then "" else "deprecated"
     val nameClasses = cls := s"documentableName $depStyle"
 
@@ -164,7 +164,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     div(topLevelAttr:_*)(
       a(href := (if member.needsOwnPage then link(member.dri).getOrElse("#") else s"#${member.dri.anchor}"), cls := "documentableAnchor"),
       div(annotations(member)),
-      div(cls := "header monospace")(memberSingnature(member)),
+      div(cls := "header monospace")(memberSignature(member)),
       div(cls := "docs")(
         span(cls := "modifiers"), // just to have padding on left
         div(
@@ -203,7 +203,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     case g: MGroup => g.members.exists(isInherited)
 
   private def isAbstract(m: Member | MGroup): Boolean = m match
-    case m: Member => m.modifiers.contains(Modifier.Abstract)
+    case m: Member => m.modifiers.exists(Set(Modifier.Abstract, Modifier.Deferred).contains)
     case g: MGroup => g.members.exists(isAbstract)
 
   private type SubGroup = (String, Seq[Member | MGroup])
@@ -375,7 +375,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
           ),
           div(cls := "signature monospace")(
             annotations(m),
-            memberSingnature(m)
+            memberSignature(m)
           )
         )
 

scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala

@@ -65,6 +65,7 @@ class SymOps[Q <: Quotes](val q: Q):
         Flags.Sealed -> Modifier.Sealed,
         Flags.Erased -> Modifier.Erased,
         Flags.Abstract -> Modifier.Abstract,
+        Flags.Deferred -> Modifier.Deferred,
         Flags.Implicit -> Modifier.Implicit,
         Flags.Inline -> Modifier.Inline,
         Flags.Lazy -> Modifier.Lazy,

scaladoc/src/dotty/tools/scaladoc/tasty/SymOps.scala

@@ -0,0 +1,42 @@
+package dotty.tools.scaladoc
+package signatures
+
+import scala.io.Source
+import scala.jdk.CollectionConverters._
+import scala.util.matching.Regex
+import dotty.tools.scaladoc.test.BuildInfo
+import java.nio.file.Path;
+import org.jsoup.Jsoup
+import util.IO
+import org.junit.Assert.assertTrue
+
+class AbstractMembers extends ScaladocTest("abstractmembersignatures"):
+
+  def runTest = {
+    afterRendering {
+      val actualSignatures = signaturesFromDocumentation()
+
+      actualSignatures.foreach { (k, v) => k match
+        case "Abstract methods" => assertTrue(v.forall(_._2 == "shouldBeAbstract"))
+        case "Concrete methods" => assertTrue(v.forall(_._2 == "shouldBeConcrete"))
+        case "Classlikes" => assertTrue(v.forall((m, n) => m.contains("abstract") == n.contains("Abstract")))
+        case _ =>
+      }
+    }
+  }
+
+  private def signaturesFromDocumentation()(using DocContext): Map[String, List[(String, String)]] =
+    val output = summon[DocContext].args.output.toPath.resolve("api")
+    val signatures = List.newBuilder[(String, (String, String))]
+    def processFile(path: Path): Unit =
+      val document = Jsoup.parse(IO.read(path))
+      val content = document.select(".documentableList").forEach { elem =>
+        val group = elem.select(".groupHeader").eachText.asScala.mkString("")
+        elem.select(".documentableElement").forEach { elem =>
+          val modifiers = elem.select(".header .other-modifiers").eachText.asScala.mkString("")
+          val name = elem.select(".header .documentableName").eachText.asScala.mkString("")
+          signatures += group -> (modifiers, name)
+        }
+      }
+    IO.foreachFileIn(output, processFile)
+    signatures.result.groupMap(_._1)(_._2)

scaladoc/test/dotty/tools/scaladoc/signatures/AbstractMemberSignaturesTest.scala

@@ -1,4 +1,5 @@
 package dotty.tools.scaladoc
+package signatures
 
 import scala.io.Source
 import scala.jdk.CollectionConverters._

scaladoc/test/dotty/tools/scaladoc/SignatureTest.scala renamed to scaladoc/test/dotty/tools/scaladoc/signatures/SignatureTest.scala

@@ -1,4 +1,4 @@
-package dotty.tools.scaladoc
+package dotty.tools.scaladoc.signatures
 
 class GenericSignaftures extends SignatureTest("genericSignatures", Seq("class"))