Scala3doc: add cooking tests

Author: abgruszecki

scala3doc-testcases/src/tests/tests.scala

@@ -73,10 +73,7 @@ class A {
     */
   final def myMethod(s: String): String = s
 
-  /** This is a method.
-    *
-    * This is foo: $foo
-    */
+  /** This is foo: $foo */
   def method(s: String): String = s
 
   class AA
@@ -121,10 +118,7 @@ object A
 class B extends A {
   /** @inheritdoc */ override def method(s: String): String = s
 
-  /** This is a method.
-    *
-    * And this is my foo: $foo
-    */
+  /** This is my foo: $foo */
   def otherMethod(s: String): String = s
 
   class BB
@@ -145,7 +139,8 @@ object B {
   val Z: Int = 0
 }
 
-class C {
+/** This is foo: $foo */
+class C extends A {
   object CC
   class CC
 }
@@ -215,6 +210,5 @@ class Methods:
   */
 object O:
 
-  /** This is foo: $foo
-    */
+  /** This is foo: $foo */
   def method(s: String) = s

scala3doc/src/dotty/dokka/tasty/ScalaDocSupport.scala

@@ -22,10 +22,8 @@ trait ScaladocSupport { self: TastyParser =>
 
         // println(s"Expanding comment for sym: ${tree.symbol.show}")
         val sym = tree.symbol.asInstanceOf[dotc.core.Symbols.Symbol]
-        val owner =
-          if tree.symbol.isClassDef then sym else sym.owner
 
-        comments.CommentExpander.cookComment(sym, owner)(using ctx)
+        comments.CommentExpander.cookComment(sym)(using ctx)
           .get.asInstanceOf[Documentation]
       else
         commentPre

scala3doc/src/dotty/dokka/tasty/comments/CommentExpander.scala

@@ -344,6 +344,12 @@ import reporting.ProperDefinitionNotFound
   }
 
 object CommentExpander {
+
+  // TODO: handle package / non-class top-level definitions (possibly just return their comments?)
+  def cookComment(sym: Symbol)(using Context): Option[Comment] =
+    val owner = if sym.isClass then sym else sym.owner
+    cookComment(sym, owner)
+
   def cookComment(sym: Symbol, owner: Symbol)(using Context): Option[Comment] =
     ctx.docCtx.flatMap { docCtx =>
       expand(sym, owner)(using ctx)(using docCtx)

scala3doc/test/dotty/dokka/tasty/comments/CommentExpanderTests.scala

@@ -0,0 +1,52 @@
+package dotty.dokka.tasty.comments
+
+import scala.quoted._
+
+import org.junit.{Test, Rule}
+import org.junit.Assert.{assertSame, assertTrue, assertEquals}
+import dotty.dokka.tasty.util._
+import dotty.dokka.tasty.TastyParser
+
+class CommentExpanderTests {
+  def check(using quoted.Quotes)(): Unit =
+    assertCommentEquals(
+      qr.Symbol.requiredClass("tests.B").method("otherMethod").head,
+      "/** This is my foo: Bar, actually. */",
+    )
+    assertCommentEquals(
+      qr.Symbol.requiredClass("tests.C"),
+      "/** This is foo: Foo expanded. */",
+    )
+    assertCommentEquals(
+      qr.Symbol.requiredModule("tests.O").method("method").head,
+      "/** This is foo: O's foo. */",
+    )
+
+
+  def assertCommentEquals(
+    using quoted.Quotes
+  )(
+    rsym: quotes.reflect.Symbol,
+    str: String
+  ): Unit =
+    import dotty.tools.dotc
+    given ctx as dotc.core.Contexts.Context = quotes.asInstanceOf[scala.quoted.runtime.impl.QuotesImpl].ctx
+    val sym = rsym.asInstanceOf[dotc.core.Symbols.Symbol]
+    val comment = CommentExpander.cookComment(sym).get
+    assertEquals(comment.expanded.get, str)
+
+  @Test
+  def test(): Unit = {
+    import scala.tasty.inspector.TastyInspector
+    class Inspector extends TastyInspector:
+
+      def processCompilationUnit(using quoted.Quotes)(root: quotes.reflect.Tree): Unit = ()
+
+      override def postProcess(using quoted.Quotes): Unit =
+        check()
+
+    Inspector().inspectTastyFiles(TestUtils.listOurClasses())
+  }
+
+  private def qr(using quoted.Quotes): quotes.reflect.type = quotes.reflect
+}

scala3doc/test/dotty/dokka/tasty/comments/MemberLookupTests.scala

@@ -4,7 +4,7 @@ import scala.quoted.Quotes
 
 import org.junit.{Test, Rule}
 import org.junit.Assert.{assertSame, assertTrue}
-import dotty.dokka.BuildInfo
+import dotty.dokka.tasty.util._
 
 class LookupTestCases[Q <: Quotes](val q: Quotes) {
 
@@ -118,27 +118,6 @@ class MemberLookupTests {
         cases.testAll()
       }
 
-    Inspector().inspectTastyFiles(listOurClasses())
-  }
-
-  def listOurClasses(): List[String] = {
-    import java.io.File
-    import scala.collection.mutable.ListBuffer
-
-    val classRoot = new File(BuildInfo.test_testcasesOutputDir)
-
-    def go(bld: ListBuffer[String])(file: File): Unit =
-      file.listFiles.foreach { f =>
-        if f.isFile() then
-          if f.toString.endsWith(".tasty") then bld.append(f.toString)
-        else go(bld)(f)
-      }
-
-    if classRoot.isDirectory then
-      val bld = new ListBuffer[String]
-      go(bld)(classRoot)
-      bld.result
-    else
-      sys.error(s"Class root could not be found: $classRoot")
+    Inspector().inspectTastyFiles(TestUtils.listOurClasses())
   }
 }

scala3doc/test/dotty/dokka/tasty/util/TestUtils.scala

@@ -0,0 +1,26 @@
+package dotty.dokka.tasty.util
+
+import dotty.dokka.BuildInfo
+
+object TestUtils {
+  def listOurClasses(): List[String] = {
+    import java.io.File
+    import scala.collection.mutable.ListBuffer
+
+    val classRoot = new File(BuildInfo.test_testcasesOutputDir)
+
+    def go(bld: ListBuffer[String])(file: File): Unit =
+      file.listFiles.foreach { f =>
+        if f.isFile() then
+          if f.toString.endsWith(".tasty") then bld.append(f.toString)
+        else go(bld)(f)
+      }
+
+    if classRoot.isDirectory then
+      val bld = new ListBuffer[String]
+      go(bld)(classRoot)
+      bld.result
+    else
+      sys.error(s"Class root could not be found: $classRoot")
+  }
+}