Merge pull request #26 from pikinier20/scaladoc/new-ui-fixes3

pikinier20 · web-flow · commit d75c77f993d8 · 2022-07-01T12:47:36.000+02:00
Repair tests. Few css fixes
diff --git a/.github/workflows/scaladoc.yaml b/.github/workflows/scaladoc.yaml
@@ -42,14 +42,13 @@ jobs:
       - name: Compile and test scala3doc-js
         run: ./project/scripts/sbt scaladoc-js-main/test
 
-      # - name: Compile and test
-      #   run: |
-      #     ./project/scripts/sbt scaladoc/test
-      #     ./project/scripts/cmdScaladocTests
-      #     Temporarily turn off testing to be able to publish test documentation without tests passing
-
-      # - name: Locally publish self
-      #   run: ./project/scripts/sbt scaladoc/publishLocal
+      - name: Compile and test
+        run: |
+          ./project/scripts/sbt scaladoc/test
+          ./project/scripts/cmdScaladocTests
+
+      - name: Locally publish self
+        run: ./project/scripts/sbt scaladoc/publishLocal
 
       - name: Generate self documentation
         run: ./project/scripts/sbt scaladoc/generateSelfDocumentation
diff --git a/scaladoc/resources/dotty_res/styles/theme/components/api-filters.css b/scaladoc/resources/dotty_res/styles/theme/components/api-filters.css
@@ -1,7 +1,7 @@
 #content .documentableFilter {
   display: flex;
   flex-wrap: wrap;
-  z-index: 2;
+  z-index: 1;
   row-gap: calc(2 * var(--base-spacing));
   position: relative;
   margin-bottom: calc(6 * var(--base-spacing));
diff --git a/scaladoc/resources/dotty_res/styles/theme/components/subtypes.css b/scaladoc/resources/dotty_res/styles/theme/components/subtypes.css
@@ -14,6 +14,7 @@
 
 .subtypes > div {
   display: none;
+  margin-bottom: 6px;
 }
 
 .subtypes > div:nth-child(2),
@@ -22,7 +23,6 @@
 .subtypes > div:nth-child(5),
 .subtypes > div:nth-child(6) {
   display: block;
-  margin-bottom: 6px;
 }
 
 .subtypes.collapsed > div {
diff --git a/scaladoc/resources/dotty_res/styles/theme/components/supertypes.css b/scaladoc/resources/dotty_res/styles/theme/components/supertypes.css
@@ -14,6 +14,7 @@
 
 .supertypes > div {
   display: none;
+  margin-bottom: 6px;
 }
 
 .supertypes > div:nth-child(2),
@@ -22,7 +23,6 @@
 .supertypes > div:nth-child(5),
 .supertypes > div:nth-child(6) {
   display: block;
-  margin-bottom: 6px;
 }
 
 .supertypes.collapsed > div {
diff --git a/scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala b/scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala
@@ -376,7 +376,13 @@ trait ClassLikeSupport:
       val overriddenSyms = methodSymbol.allOverriddenSymbols.map(_.owner)
       Origin.Overrides(overriddenSyms.map(s => Overridden(s.name, s.dri)).toSeq)
 
-    mkMember(methodSymbol, methodKind, method.returnTpt.tpe.asSignature)(origin = origin, deprecated = methodSymbol.isDeprecated())
+    val modifiers = methodKind match
+      case _: Kind.Given => methodSymbol
+        .getExtraModifiers()
+        .filterNot(m => m == Modifier.Lazy || m == Modifier.Final)
+      case _ => methodSymbol.getExtraModifiers()
+
+    mkMember(methodSymbol, methodKind, method.returnTpt.tpe.asSignature)(modifiers = modifiers, origin = origin, deprecated = methodSymbol.isDeprecated())
 
   def mkParameter(
     argument: ValDef,
@@ -456,7 +462,13 @@ trait ClassLikeSupport:
       else if valDef.symbol.flags.is(Flags.Enum) then Kind.EnumCase(Kind.Val)
       else defaultKind
 
-    mkMember(valDef.symbol, kind, memberInfo.res.asSignature)(deprecated = valDef.symbol.isDeprecated())
+    val modifiers = kind match
+      case _: Kind.Given => valDef.symbol
+        .getExtraModifiers()
+        .filterNot(m => m == Modifier.Lazy || m == Modifier.Final)
+      case _ => valDef.symbol.getExtraModifiers()
+
+    mkMember(valDef.symbol, kind, memberInfo.res.asSignature)(modifiers = modifiers, deprecated = valDef.symbol.isDeprecated())
 
   def mkMember(symbol: Symbol, kind: Kind, signature: DSignature)(
     modifiers: Seq[Modifier] = symbol.getExtraModifiers(),
diff --git a/scaladoc/src/dotty/tools/scaladoc/translators/ScalaSignatureProvider.scala b/scaladoc/src/dotty/tools/scaladoc/translators/ScalaSignatureProvider.scala
@@ -37,7 +37,7 @@ class ScalaSignatureProvider:
       case trt: Kind.Trait =>
         traitSignature(documentable, trt)
       case Kind.Val | Kind.Var | Kind.Implicit(Kind.Val, _) =>
-        fieldSignature(documentable, kind.name)
+        fieldSignature(documentable, kind)
       case tpe: Kind.Type =>
         typeSignature(tpe, documentable)
       case Kind.Package =>
@@ -52,10 +52,10 @@ class ScalaSignatureProvider:
       case Kind.Unknown =>
         ???
 
-  private def classLikeSignature(member: Member, kind: Classlike): MemberSignature =
+  private def classLikeSignature(member: Member, kind: Kind & Classlike)(showKind: Kind = kind): MemberSignature =
     MemberSignature(
       builder.modifiersAndVisibility(member),
-      builder.kind(member),
+      builder.kind(showKind),
       builder.name(member.name, member.dri),
       builder
         .generics(kind.typeParams)
@@ -65,7 +65,7 @@ class ScalaSignatureProvider:
 
 
   private def enumEntrySignature(member: Member, cls: Kind.Class): MemberSignature =
-    classLikeSignature(member, cls)
+    classLikeSignature(member, cls)()
 
   private def enumPropertySignature(entry: Member): MemberSignature =
     val modifiedType = entry.signature.map {
@@ -75,35 +75,35 @@ class ScalaSignatureProvider:
 
     MemberSignature(
       builder.modifiersAndVisibility(entry),
-      builder.kind(entry),
+      builder.kind(entry.kind),
       builder.name(entry.name, entry.dri),
       builder.keyword(" extends ").signature(modifiedType)
     )
 
   private def givenClassSignature(member: Member, cls: Kind.Class): MemberSignature =
-    val initialSignature = classLikeSignature(member, cls)
+    val initialSignature = classLikeSignature(member, cls)(member.kind)
 
     member.kind match
       case Kind.Given(_, Some(instance), _) => initialSignature
         .copy(suffix = initialSignature.suffix ++ builder.plain(": ").signature(instance))
       case _ => initialSignature
 
   private def classSignature(clazz: Member, cls: Kind.Class): MemberSignature =
-    classLikeSignature(clazz, cls)
+    classLikeSignature(clazz, cls)()
 
   private def objectSignature(clazz: Member): MemberSignature =
-    classLikeSignature(clazz, Kind.Object)
+    classLikeSignature(clazz, Kind.Object)()
 
   private def traitSignature(clazz: Member, cls: Kind.Trait): MemberSignature =
-    classLikeSignature(clazz, cls)
+    classLikeSignature(clazz, cls)()
 
   private def enumSignature(clazz: Member, cls: Kind.Enum): MemberSignature =
-    classLikeSignature(clazz, cls)
+    classLikeSignature(clazz, cls)()
 
-  private def methodLikeSignature(method: Member, kind: Kind.Def, instance: Option[Signature] = None): MemberSignature =
+  private def methodLikeSignature(method: Member, kind: Kind.Def, instance: Option[Signature] = None)(showKind: Kind = kind): MemberSignature =
     MemberSignature(
       builder.modifiersAndVisibility(method),
-      builder.kind(method),
+      builder.kind(showKind),
       builder.name(method.name, method.dri),
       builder
         .generics(kind.typeParams)
@@ -115,41 +115,41 @@ class ScalaSignatureProvider:
 
   private def methodSignature(method: Member, cls: Kind.Def): MemberSignature =
     method.kind match {
-      case _: Kind.Constructor => methodLikeSignature(method, cls, None)
-      case _ => methodLikeSignature(method, cls, Some(method.signature))
+      case _: Kind.Constructor => methodLikeSignature(method, cls, None)()
+      case _ => methodLikeSignature(method, cls, Some(method.signature))()
     }
 
   private def extensionSignature(extension: Member, fun: Kind.Def): MemberSignature =
-    methodLikeSignature(extension, fun, Some(extension.signature))
+    methodLikeSignature(extension, fun, Some(extension.signature))()
 
   private def givenMethodSignature(method: Member, body: Kind.Def): MemberSignature = method.kind match
     case Kind.Given(_, iOpt @ Some(instance), _) =>
-      methodLikeSignature(method, body, iOpt)
+      methodLikeSignature(method, body, iOpt)(method.kind)
     case _ =>
-      methodLikeSignature(method, body)
+      methodLikeSignature(method, body)(method.kind)
 
-  private def fieldLikeSignature(member: Member, instance: Option[Signature] = None): MemberSignature =
+  private def fieldLikeSignature(member: Member, kind: Kind, instance: Option[Signature] = None): MemberSignature =
     MemberSignature(
       builder.modifiersAndVisibility(member),
-      builder.kind(member),
+      builder.kind(kind),
       builder.name(member.name, member.dri),
       instance.fold(builder)(i => builder.plain(": ").signature(i))
     )
 
 
-  private def fieldSignature(member: Member, kind: String): MemberSignature =
-    fieldLikeSignature(member, Some(member.signature))
+  private def fieldSignature(member: Member, kind: Kind): MemberSignature =
+    fieldLikeSignature(member, kind, Some(member.signature))
 
   private def givenValSignature(field: Member): MemberSignature = field.kind match
     case Kind.Given(_, iOpt @ Some(instance), _) =>
-      fieldLikeSignature(field, iOpt)
+      fieldLikeSignature(field, field.kind, iOpt)
     case _ =>
-      fieldLikeSignature(field, None)
+      fieldLikeSignature(field, field.kind, None)
 
   private def typeSignature(tpe: Kind.Type, typeDef: Member): MemberSignature =
     MemberSignature(
       builder.modifiersAndVisibility(typeDef),
-      builder.kind(typeDef),
+      builder.kind(tpe),
       builder.name(typeDef.name, typeDef.dri),
       builder.generics(tpe.typeParams).pipe { bdr =>
         if (!tpe.opaque) {
diff --git a/scaladoc/src/dotty/tools/scaladoc/translators/ScalaSignatureUtils.scala b/scaladoc/src/dotty/tools/scaladoc/translators/ScalaSignatureUtils.scala
@@ -71,8 +71,8 @@ case class SignatureBuilder(content: Signature = Nil) extends ScalaSignatureUtil
     val filtered = all.filter(_.trim.nonEmpty)
     if filtered.nonEmpty then keyword(filtered.toSignatureString()) else this
 
-  def kind(t: Member) =
-    keyword(t.kind.name + " ")
+  def kind(k: Kind) =
+    keyword(k.name + " ")
 
   def generics(on: Seq[TypeParameter]) = list(on.toList, List(Plain("[")), List(Plain("]"))){ (bdr, e) =>
     bdr.annotationsInline(e).keyword(e.variance).tpe(e.name, Some(e.dri)).signature(e.signature)
diff --git a/scaladoc/test/dotty/tools/scaladoc/BaseHtmlTest.scala b/scaladoc/test/dotty/tools/scaladoc/BaseHtmlTest.scala
@@ -12,7 +12,7 @@ import dotty.tools.scaladoc.test.BuildInfo
 import util.IO
 
 class BaseHtmlTest:
-  val unresolvedLinkSelector = ".documentableBrief span[data-unresolved-link], .cover span[data-unresolved-link]"
+  val unresolvedLinkSelector = ".doc span[data-unresolved-link]"
 
   def projectName = "Test Project Name"
   def  projectVersion = "1.0.1-M1"
diff --git a/scaladoc/test/dotty/tools/scaladoc/site/NavigationTest.scala b/scaladoc/test/dotty/tools/scaladoc/site/NavigationTest.scala
@@ -7,42 +7,42 @@ class NavigationTest extends BaseHtmlTest:
 
   case class NavMenuTestEntry( name: String, link: String, nested: Seq[NavMenuTestEntry])
 
-  def testNavMenu(page: String, topLevel: NavMenuTestEntry)(using ProjectContext): Unit =
+  def testNavMenu(page: String, topLevel: Seq[NavMenuTestEntry])(using ProjectContext): Unit =
     withHtmlFile(page){ content  =>
 
       def test(query: String, el: Seq[NavMenuTestEntry]) =
         content.assertTextsIn(query, el.map(_.name):_*)
         content.assertAttr(query,"href", el.map(_.link):_*)
 
-      test("#sideMenu2>div>span>a", topLevel :: Nil)
-      test("#sideMenu2>div>div>span>a", topLevel.nested)
-      test("#sideMenu2>div>div>div>span>a", topLevel.nested.flatMap(_.nested))
-      test("#sideMenu2>div>div>div>div>span>a", topLevel.nested.flatMap(_.nested.flatMap(_.nested)))
+      test(".side-menu>div>span>a", topLevel)
+      test(".side-menu>div>div>span>a", topLevel.flatMap(_.nested))
     }
 
 
   @Test
   def testBasicNavigation() = withGeneratedSite(testDocPath.resolve("basic")) {
-    val topLevelNav = NavMenuTestEntry(projectName, "index.html", Seq(
+    val docsNav = Seq(
       NavMenuTestEntry("A directory", "dir/index.html", Seq(
         NavMenuTestEntry("Nested in a directory", "dir/nested.html", Nil)
       )),
-      NavMenuTestEntry("Adoc", "Adoc.html", Seq()),
-      NavMenuTestEntry("API", "../index.html", Seq(
-        NavMenuTestEntry("tests.site", "../tests/site.html", Seq(
-          NavMenuTestEntry("BrokenLink", "../tests/site/BrokenLink.html", Nil),
-          NavMenuTestEntry("BrokenLinkWiki", "../tests/site/BrokenLinkWiki.html", Nil),
-          NavMenuTestEntry("OtherPackageLink", "../tests/site/OtherPackageLink.html", Nil),
-          NavMenuTestEntry("OtherPackageLinkWiki", "../tests/site/OtherPackageLinkWiki.html", Nil),
-          NavMenuTestEntry("SamePackageLink", "../tests/site/SamePackageLink.html", Nil),
-          NavMenuTestEntry("SamePackageLinkWiki", "../tests/site/SamePackageLinkWiki.html", Nil),
-          NavMenuTestEntry("SomeClass", "../tests/site/SomeClass.html", Nil)
-        )),
-        NavMenuTestEntry("tests.site.some.other", "../tests/site/some/other.html", Seq(
-          NavMenuTestEntry("SomeOtherPackage", "../tests/site/some/other/SomeOtherPackage.html", Nil),
-        ))
+      NavMenuTestEntry("Adoc", "Adoc.html", Seq())
+    )
+
+    val apiNav = Seq(
+      NavMenuTestEntry("tests.site", "site.html", Seq(
+        NavMenuTestEntry("BrokenLink", "site/BrokenLink.html", Nil),
+        NavMenuTestEntry("BrokenLinkWiki", "site/BrokenLinkWiki.html", Nil),
+        NavMenuTestEntry("OtherPackageLink", "site/OtherPackageLink.html", Nil),
+        NavMenuTestEntry("OtherPackageLinkWiki", "site/OtherPackageLinkWiki.html", Nil),
+        NavMenuTestEntry("SamePackageLink", "site/SamePackageLink.html", Nil),
+        NavMenuTestEntry("SamePackageLinkWiki", "site/SamePackageLinkWiki.html", Nil),
+        NavMenuTestEntry("SomeClass", "site/SomeClass.html", Nil)
       )),
-    ))
+      NavMenuTestEntry("tests.site.some.other", "site/some/other.html", Seq(
+        NavMenuTestEntry("SomeOtherPackage", "site/some/other/SomeOtherPackage.html", Nil),
+      ))
+    )
 
-    testNavMenu("docs/Adoc.html", topLevelNav)
+    testNavMenu("docs/Adoc.html", docsNav)
+    testNavMenu("tests/site.html", apiNav)
   }
diff --git a/scaladoc/test/dotty/tools/scaladoc/site/SiteGeneratationTest.scala b/scaladoc/test/dotty/tools/scaladoc/site/SiteGeneratationTest.scala
@@ -23,7 +23,7 @@ class SiteGeneratationTest extends BaseHtmlTest:
     parents: Seq[String] = Nil,
     checks: DocumentContext => Unit = _ => ())(using ProjectContext) =
       withHtmlFile(path){ content  =>
-        content.assertTextsIn(".projectName", projectName)
+        content.assertTextsIn(".project-name", projectName)
         content.assertTextsIn(".projectVersion", projectVersion)
         content.assertTextsIn("h1", header)
         content.assertTextsIn("title", title)
@@ -41,8 +41,8 @@ class SiteGeneratationTest extends BaseHtmlTest:
     checkFile("docs/index.html")(title = projectName, header = s"$projectName in header")
 
   def testApiPages(
-    mainTitle: String = "API",
-    parents: Seq[String] = Seq(projectName),
+    mainTitle: String = projectName,
+    parents: Seq[String] = Seq.empty,
     hasToplevelIndexIndex: Boolean = false)(using ProjectContext) =
       checkFile((if hasToplevelIndexIndex then "api/" else "" )+ "index.html")(
         title = mainTitle,
@@ -72,7 +72,7 @@ class SiteGeneratationTest extends BaseHtmlTest:
 
     withHtmlFile("tests/site/SomeClass.html"){ content  =>
       content.assertAttr(".breadcrumbs a","href",
-        "../../docs/index.html", "../../index.html", "../site.html", "SomeClass.html"
+        "../../index.html", "../site.html", "SomeClass.html"
       )
     }
   }
diff --git a/scaladoc/test/dotty/tools/scaladoc/site/TemplateFileTests.scala b/scaladoc/test/dotty/tools/scaladoc/site/TemplateFileTests.scala
@@ -136,10 +136,10 @@ class TemplateFileTests:
 
     val expected =
       """<div id="root"><section id="test-page">
-        |<h1><a href="#test-page" class="anchor"></a>Test page</h1>
+        |<h1 class="h500"><a href="#test-page" class="anchor"></a>Test page</h1>
         |<p>Hello world!!</p>
         |</section><section id="test-page-end">
-        |<h2><a href="#test-page-end" class="anchor"></a>Test page end</h2>
+        |<h2 class="h300"><a href="#test-page-end" class="anchor"></a>Test page end</h2>
         |</section>
         |</div>""".stripMargin
 
@@ -210,7 +210,7 @@ class TemplateFileTests:
     ) { t =>
       assertEquals(
         """<section id="hello-there">
-        |<h1><a href="#hello-there" class="anchor"></a>Hello there!</h1>
+        |<h1 class="h500"><a href="#hello-there" class="anchor"></a>Hello there!</h1>
         |</section>""".stripMargin,
       t.resolveInner(RenderingContext(Map("msg" -> "there"))).code.trim())
     }
@@ -223,7 +223,7 @@ class TemplateFileTests:
     ) { t =>
       assertEquals(
         """<section id="hello-there">
-        |<h1><a href="#hello-there" class="anchor"></a>Hello there!</h1>
+        |<h1 class="h500"><a href="#hello-there" class="anchor"></a>Hello there!</h1>
         |</section>""".stripMargin,
       t.resolveInner(RenderingContext(Map("msg" -> "there"))).code.trim())
     }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`.subtypes > div {`
`16`	`16`	`display: none;`
	`17`	`+ margin-bottom: 6px;`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`.subtypes > div:nth-child(2),`
`@@ -22,7 +23,6 @@`
`22`	`23`	`.subtypes > div:nth-child(5),`
`23`	`24`	`.subtypes > div:nth-child(6) {`
`24`	`25`	`display: block;`
`25`		`- margin-bottom: 6px;`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`.subtypes.collapsed > div {`