Apply requested changes, remove componion object of TemplateFile

Author: BarkingBad

scala3doc/src/dotty/dokka/compat.scala

@@ -20,10 +20,12 @@ def JList[T](e: T*): JList[T] = e.asJava
 def JSet[T](e: T*): JSet[T] = e.toSet.asJava
 def JMap[K, V](e: (K, V)*): JMap[K, V] = e.toMap.asJava
 def JMap2[K, V](): JMap[K, V] = ??? // e.toMap.asJava
+def newHMap[K, V](m: JMap[K, V]): HMap[K, V] = new HMap[K, V](m)
 
 type JList[T] = java.util.List[T]
 type JSet[T] = java.util.Set[T]
 type JMap[K, V] = java.util.Map[K, V]
+type HMap[K, V] = java.util.HashMap[K, V]
 
 type SourceSetWrapper = DokkaConfiguration$DokkaSourceSet
 type DokkaSourceSet = DokkaConfiguration.DokkaSourceSet

scala3doc/src/dotty/dokka/site/SidebarParser.scala

@@ -32,4 +32,4 @@ object Sidebar:
     val mapper = ObjectMapper(YAMLFactory())
     val raw = mapper.readValue(content, RawTypeRef)
 
-    raw.get("sidebar").asScala.toList.map(toSidebar)
+    raw.get("sidebar").asScala.toList.map(toSidebar)

scala3doc/src/dotty/dokka/site/StaticSiteContext.scala

@@ -82,7 +82,7 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
         def loadIndexPage(): TemplateFile =
           val indexFiles = from.listFiles { file =>file.getName == "index.md" || file.getName == "index.html" }
           indexFiles.size match
-            case 0 => emptyTemplate(from)
+            case 0 => emptyTemplate(from, from.getName)
             case 1 => loadTemplateFile(indexFiles.head).copy(file = from)
             case _ =>
               val msg = s"ERROR: Multiple index pages found under ${from.toPath}"
@@ -115,7 +115,7 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
     case Sidebar.Category(title, nested) =>
       // Add support for index.html/index.md files!
       val fakeFile = new File(root, title)
-      LoadedTemplate(emptyTemplate(fakeFile), nested.map(loadSidebarContent), fakeFile)
+      LoadedTemplate(emptyTemplate(fakeFile, title), nested.map(loadSidebarContent), fakeFile)
 
   private def loadAllFiles() =
     def dir(name: String)= List(new File(root, name)).filter(_.isDirectory)

scala3doc/src/dotty/dokka/site/common.scala

@@ -40,11 +40,16 @@ val defaultMarkdownOptions: DataHolder =
       "https://github.global.ssl.fastly.net/images/icons/emoji/"
     )
 
-def emptyTemplate(file: File): TemplateFile = TemplateFile(
+def emptyTemplate(file: File, title: String): TemplateFile = TemplateFile(
   file = file,
   isHtml = true,
   rawCode = "",
-  settings = Map.empty
+  settings = Map.empty,
+  name = file.getName.stripSuffix(".html"),
+  title = title,
+  hasFrame = true,
+  resources = List.empty,
+  layout = None
 )
 
 final val ConfigSeparator = "---"
@@ -66,19 +71,43 @@ def loadTemplateFile(file: File): TemplateFile = {
   val yamlCollector = new AbstractYamlFrontMatterVisitor()
   yamlCollector.visit(configParsed)
 
-  extension (v: java.util.List[String]) def getSettingValue: String | List[String] =
+  def getSettingValue(k: String, v: JList[String]): String | List[String] =
     if v.size == 1 then v.get(0) else v.asScala.toList
 
-  val globalKeys = Set("extraJS", "extraCSS", "layout", "hasFrame")
-  val (global, inner) = yamlCollector.getData.asScala.toMap.transform((_, v) => v.getSettingValue)
-    .partition((k,_) => globalKeys.contains(k))
-  val settings = global ++ Map("page" -> inner)
- 
+  val globalKeys = Set("extraJS", "extraCSS", "layout", "hasFrame", "name")
+  val allSettings = yamlCollector.getData.asScala.toMap.transform(getSettingValue)
+  val (global, inner) = allSettings.partition((k,_) => globalKeys.contains(k))
+  val settings = Map("page" -> inner)
+
+  def stringSetting(settings: Map[String, Object], name: String): Option[String] = settings.get(name).map {
+    case List(elem: String) => elem
+    case elem: String => elem
+    case other => throw new RuntimeException(s"Expected a string setting for $name in $file but got $other")
+  }.map(_.stripPrefix("\"").stripSuffix("\""))
+  
+  def listSetting(settings: Map[String, Object], name: String): Option[List[String]] = settings.get(name).map {
+    case elems: List[_] => elems.zipWithIndex.map {
+      case (s: String, _) => s
+      case (other, index) => 
+        throw new RuntimeException(s"Expected a string at index $index for $name in $file but got $other")
+    }
+    case elem: String => List(elem)
+    case other => throw new RuntimeException(s"Expected a list of string setting for $name in $file but got $other")
+  }
+
+  val isHtml = file.getName.endsWith(".html")
+  val name = stringSetting(allSettings, "name").getOrElse(file.getName.stripSuffix(if (isHtml) ".html" else ".md"))
+
   TemplateFile(
     file = file,
-    isHtml = file.getName.endsWith(".html"),
+    isHtml = isHtml,
     rawCode = content.mkString(LineSeparator),
     settings = settings,
+    name = name,
+    title = stringSetting(allSettings, "title").getOrElse(name),
+    hasFrame = !stringSetting(allSettings, "hasFrame").contains("false"),
+    resources = (listSetting(allSettings, "extraCSS") ++ listSetting(allSettings, "extraJS")).flatten.toList,
+    layout = stringSetting(allSettings, "layout")
   )
 }
 

scala3doc/src/dotty/dokka/site/templates.scala

@@ -15,13 +15,12 @@ import com.vladsch.flexmark.parser.{Parser, ParserEmulationProfile}
 import com.vladsch.flexmark.util.options.{DataHolder, MutableDataSet}
 import com.vladsch.flexmark.html.HtmlRenderer
 import liqp.Template
-import java.util.{ Map => JMap, HashMap => HMap, ArrayList, Collection }
-
 import scala.collection.JavaConverters._
+
 import scala.io.Source
 
 case class RenderingContext(
-  properties: Map[String, Element],
+  properties: Map[String, Object],
   layouts: Map[String, TemplateFile] = Map(),
   resolving: Set[String] = Set(),
   resources: List[String] = Nil
@@ -35,7 +34,6 @@ case class RenderingContext(
     )
 
 case class ResolvedPage(code: String, resources: List[String] = Nil)
-type Element = String | List[String] | Object // Object represents Map[String, Element] since it is not possible to get circullar dependency
 /**
  * case class for the template files.
  * Template file is a file `.md` or `.html` handling settings.
@@ -48,7 +46,7 @@ case class TemplateFile(
   file: File,
   isHtml: Boolean,
   rawCode: String,
-  settings: Map[String, Element],
+  settings: Map[String, Object],
   name: String,
   title: String,
   hasFrame: Boolean,
@@ -66,13 +64,15 @@ case class TemplateFile(
     val layoutTemplate = layout.map(name =>
       ctx.layouts.getOrElse(name, throw new RuntimeException(s"No layouts named $name in ${ctx.layouts}")))
 
-    def toJava(m: Any): Any = m match 
-      case sm: Map[_, _] => sm.map(kv => (kv._1, toJava(kv._2))).asJava
-      case sl: Iterable[_] => new ArrayList(sl.map( toJava ).asJava.asInstanceOf[Collection[_]])
-      case _ => m
+    def asJavaElement(k: String, v: Object): Object = v match 
+      case m: Map[_, _] => m.transform {
+        case (k: String, v: Object) => asJavaElement(k, v)
+      }.asJava
+      case l: List[_] => l.asJava
+      case other => other
 
     // Library requires mutable maps..
-    val mutableProperties = new HMap[String, Object](toJava(ctx.properties).asInstanceOf[JMap[String, Object]])
+    val mutableProperties = HMap(ctx.properties.transform(asJavaElement).asJava)
     val rendered = Template.parse(this.rawCode).render(mutableProperties)
     // We want to render markdown only if next template is html
     val code = if (isHtml || layoutTemplate.exists(!_.isHtml)) rendered else
@@ -83,38 +83,3 @@ case class TemplateFile(
       case None => ResolvedPage(code, resources ++ ctx.resources)
       case Some(layoutTemplate) =>
         layoutTemplate.resolveInner(ctx.nest(code, file, resources))
-
-object TemplateFile:
-  extension (settings: Map[String, Element]):
-    private def stringSetting(name: String): Option[String] = settings.getOrElse(name, null).match {
-      case List(elem: String) => Some(elem)
-      case elem: String => Some(elem)
-      case _ => None
-    }.map(_.stripPrefix("\"").stripSuffix("\""))
-    
-    private def listSetting(name: String): Option[List[String]] = settings.getOrElse(name, null).match {
-      case elem: List[_] => Some(elem.asInstanceOf[List[String]])
-      case elem: String => Some(List(elem))
-      case _ => None
-    }
-
-  def apply(
-    file: File,
-    isHtml: Boolean,
-    rawCode: String,
-    settings: Map[String, Element],
-  ): TemplateFile = {
-    val name = settings.stringSetting("name").getOrElse(file.getName.stripSuffix(if (isHtml) ".html" else ".md"))
-
-    TemplateFile(
-      file = file,
-      isHtml,
-      rawCode = rawCode,
-      settings = settings,
-      name = name,
-      title = settings.getOrElse("page", settings).asInstanceOf[Map[String, Object]].stringSetting("title").getOrElse(name),
-      hasFrame = !settings.stringSetting("hasFrame").contains("false"),
-      resources = (settings.listSetting("extraCSS") ++ settings.listSetting("extraJS")).flatten.toList,
-      layout = settings.stringSetting("layout")
-    )
-  }

scala3doc/test/dotty/dokka/site/TemplateFileTests.scala

@@ -26,7 +26,7 @@ class TemplateFileTests:
       else
         val (code, ext) = remaining.head
         testTemplate(code, ext) { template =>
-          val newCtx = ctx.copy(layouts = ctx.layouts + (template.name() -> template))
+          val newCtx = ctx.copy(layouts = ctx.layouts + (template.name -> template))
           rec(newCtx, remaining.drop(1))
         }
 
@@ -41,7 +41,7 @@ class TemplateFileTests:
         |code""".stripMargin
     ) { t =>
       assertEquals(t.rawCode, "code")
-      assertEquals(t.title(), "myTitle")
+      assertEquals(t.title, "myTitle")
     }
 
 
@@ -243,4 +243,4 @@ class TemplateFileTests:
     testContent(
       html,
       Map(),
-      List(base -> "html", content -> "html"))
+      List(base -> "html", content -> "html"))