Merge pull request #10290 from BarkingBad/blogposts

romanowski · web-flow · commit 3f6efd9edb53 · 2020-11-13T16:08:27.000+01:00
Fix handling interpolated properties
diff --git a/docs/docs/reference/contextual/import-implied.md b/docs/docs/reference/contextual/import-implied.md
@@ -1 +1,6 @@
+---
+layout: doc-page
+title: "Import Implied"
+---
+
 The contents of this page have [moved](./given-imports.md).
diff --git a/docs/docs/reference/contextual/inferable-by-name-parameters.md b/docs/docs/reference/contextual/inferable-by-name-parameters.md
@@ -1 +1,6 @@
+---
+layout: doc-page
+title: "Inferable-By-Name Parameters"
+---
+
 The contents of this page have [moved](./by-name-context-parameters.md).
diff --git a/docs/docs/reference/contextual/inferable-params.md b/docs/docs/reference/contextual/inferable-params.md
@@ -1 +1,6 @@
+---
+layout: doc-page
+title: "Inferable Params"
+---
+
 The contents of this page have [moved](./using-clauses.md).
diff --git a/docs/docs/reference/contextual/instance-defs.md b/docs/docs/reference/contextual/instance-defs.md
@@ -1 +1,6 @@
+---
+layout: doc-page
+title: "Givens"
+---
+
 The contents of this page have [moved](./givens.md).
diff --git a/docs/docs/reference/contextual/query-types-spec.md b/docs/docs/reference/contextual/query-types-spec.md
@@ -1 +1,6 @@
+---
+layout: doc-page
+title: "Query Types Spec"
+---
+
 The contents of this page have [moved](./context-functions-spec.md).
diff --git a/docs/docs/reference/contextual/query-types.md b/docs/docs/reference/contextual/query-types.md
@@ -1 +1,6 @@
+---
+layout: doc-page
+title: "Query Types"
+---
+
 The contents of this page have [moved](./context-functions.md).
diff --git a/scala3doc/src/dotty/dokka/compat.scala b/scala3doc/src/dotty/dokka/compat.scala
@@ -22,10 +22,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
diff --git a/scala3doc/src/dotty/dokka/site/SidebarParser.scala b/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)
diff --git a/scala3doc/src/dotty/dokka/site/StaticPageNode.scala b/scala3doc/src/dotty/dokka/site/StaticPageNode.scala
@@ -22,8 +22,8 @@ case class StaticPageNode(
                          ) extends ContentPage:
   override def getDocumentable: Documentable = null
 
-  def title(): String = template.title()
-  def hasFrame(): Boolean = template.hasFrame()
+  def title(): String = template.title
+  def hasFrame(): Boolean = template.hasFrame
 
   override def modified(
     name: String,
@@ -38,4 +38,4 @@ case class StaticPageNode(
 
   def resources(): List[String] = getContent match
     case p: PartiallyRenderedContent => p.resolved.resources
-    case _ => Nil
+    case _ => Nil
diff --git a/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala b/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala
@@ -32,7 +32,7 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
   lazy val layouts: Map[String, TemplateFile] =
     val layoutRoot = new File(root, "_layouts")
     val dirs: Array[File] = Option(layoutRoot.listFiles()).getOrElse(Array())
-    dirs.map { it => loadTemplateFile(it) }.map { it => it.name() -> it }.toMap
+    dirs.map { it => loadTemplateFile(it) }.map { it => it.name -> it }.toMap
 
   lazy val sideBarConfig =
     val sidebarFile = root.toPath.resolve("sidebar.yml")
@@ -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}"
@@ -111,11 +111,11 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
       val path = if isBlog then "blog" else url.stripSuffix(".html") + ".md"
       val file = root.toPath.resolve(path) // Add support for .html files!
       val LoadedTemplate(template, children, tFile) = loadTemplate(file.toFile, isBlog).get // Add proper logging if file does not exisits
-      LoadedTemplate(template.copy(settings = template.settings + ("title" -> List(title))), children, tFile)
+      LoadedTemplate(template.copy(settings = template.settings + ("title" -> title)), children, tFile) 
     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)
@@ -141,9 +141,9 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
     )
     StaticPageNode(
       myTemplate.templateFile,
-      myTemplate.templateFile.title(),
+      myTemplate.templateFile.title,
       content,
       JSet(dri),
       JList(),
       (myTemplate.children.map(templateToPage)).asJava
-    )
+    )
diff --git a/scala3doc/src/dotty/dokka/site/common.scala b/scala3doc/src/dotty/dokka/site/common.scala
@@ -40,7 +40,17 @@ val defaultMarkdownOptions: DataHolder =
       "https://github.global.ssl.fastly.net/images/icons/emoji/"
     )
 
-def emptyTemplate(file: File): TemplateFile = TemplateFile(file, isHtml = true, "", Map())
+def emptyTemplate(file: File, title: String): TemplateFile = TemplateFile(
+  file = file,
+  isHtml = true,
+  rawCode = "",
+  settings = Map.empty,
+  name = file.getName.stripSuffix(".html"),
+  title = title,
+  hasFrame = true,
+  resources = List.empty,
+  layout = None
+)
 
 final val ConfigSeparator = "---"
 final val LineSeparator = "\n"
@@ -61,11 +71,43 @@ def loadTemplateFile(file: File): TemplateFile = {
   val yamlCollector = new AbstractYamlFrontMatterVisitor()
   yamlCollector.visit(configParsed)
 
+  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", "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,
-    file.getName.endsWith(".html"),
+    isHtml = isHtml,
     rawCode = content.mkString(LineSeparator),
-    settings = yamlCollector.getData.asScala.toMap.transform((_, v) => v.asScala.toList)
+    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")
   )
 }
 
diff --git a/scala3doc/src/dotty/dokka/site/processors.scala b/scala3doc/src/dotty/dokka/site/processors.scala
@@ -44,7 +44,7 @@ class SiteResourceManager(ctx: Option[StaticSiteContext]) extends BaseStaticSite
     val modified = input.transformContentPagesTree {
       case it: StaticPageNode =>
         it.copy(getEmbeddedResources =
-          if it.template.hasFrame() then it.getEmbeddedResources ++ it.resources().asJava
+          if it.template.hasFrame then it.getEmbeddedResources ++ it.resources().asJava
           else it.resources().asJava
         )
       case it => it
diff --git a/scala3doc/src/dotty/dokka/site/templates.scala b/scala3doc/src/dotty/dokka/site/templates.scala
@@ -15,16 +15,16 @@ 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 scala.collection.JavaConverters._
+
 import scala.io.Source
 
 case class RenderingContext(
-                             properties: Map[String, Object],
-                             layouts: Map[String, TemplateFile] = Map(),
-                             resolving: Set[String] = Set(),
-                             resources: List[String] = Nil
-                           ):
+  properties: Map[String, Object],
+  layouts: Map[String, TemplateFile] = Map(),
+  resolving: Set[String] = Set(),
+  resources: List[String] = Nil
+):
 
   def nest(code: String, file: File, resources: List[String]) =
     copy(
@@ -33,8 +33,7 @@ case class RenderingContext(
       resources = this.resources ++ resources
     )
 
-case class ResolvedPage(val code: String, val resources: List[String] = Nil)
-
+case class ResolvedPage(code: String, resources: List[String] = Nil)
 /**
  * case class for the template files.
  * Template file is a file `.md` or `.html` handling settings.
@@ -44,52 +43,42 @@ case class ResolvedPage(val code: String, val resources: List[String] = Nil)
  * @param settings The config defined in the begging of the file, between the pair of `---` (e.g. layout: basic).
  */
 case class TemplateFile(
-                         val file: File,
-                         val isHtml: Boolean,
-                         val rawCode: String,
-                         val settings: Map[String, List[String]]
-                       ):
-
-  private def stringSetting(name: String): Option[String] =
-    settings.get(name) map {
-      case List(single) => single.stripPrefix("\"").stripSuffix("\"")
-      case nonSingle =>
-        throw new RuntimeException(s"Setting $name is a not a singlel-ement list but $nonSingle")
-    }
-
-
-  private def listSetting(name: String): List[String] = settings.getOrElse(name, Nil)
-
-  def name(): String = stringSetting("name").getOrElse(file.getName.stripSuffix(if (isHtml) ".html" else ".md"))
-
-  def title(): String = stringSetting("title").getOrElse(name())
-
-  def layout(): Option[String] = stringSetting("layout")
-
-  def hasFrame(): Boolean = !stringSetting("hasFrame").contains("false")
-
+  file: File,
+  isHtml: Boolean,
+  rawCode: String,
+  settings: Map[String, Object],
+  name: String,
+  title: String,
+  hasFrame: Boolean,
+  resources: List[String],
+  layout: Option[String],
+):
   def isIndexPage() = file.isFile && (file.getName == "index.md" || file.getName == "index.html")
 
-  def resolveToHtml(ctx: StaticSiteContext): ResolvedPage =
-    val props = Map("page" -> JMap("title" -> title()))
-    resolveInner(RenderingContext(props, ctx.layouts))
+  def resolveToHtml(ctx: StaticSiteContext): ResolvedPage = resolveInner(RenderingContext(settings, ctx.layouts))
 
   private[site] def resolveInner(ctx: RenderingContext): ResolvedPage =
     if (ctx.resolving.contains(file.getAbsolutePath))
       throw new RuntimeException(s"Cycle in templates involving $file: ${ctx.resolving}")
 
-    val layoutTemplate = layout().map(name =>
+    val layoutTemplate = layout.map(name =>
       ctx.layouts.getOrElse(name, throw new RuntimeException(s"No layouts named $name in ${ctx.layouts}")))
 
+    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 java.util.HashMap[String, Object](ctx.properties.asJava)
+    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
       val parser: Parser = Parser.builder().build()
       HtmlRenderer.builder(defaultMarkdownOptions).build().render(parser.parse(rendered))
 
-    val resources = listSetting("extraCSS") ++ listSetting("extraJS")
     layoutTemplate match
       case None => ResolvedPage(code, resources ++ ctx.resources)
       case Some(layoutTemplate) =>
diff --git a/scala3doc/src/dotty/renderers/ScalaHtmlRenderer.scala b/scala3doc/src/dotty/renderers/ScalaHtmlRenderer.scala
@@ -265,7 +265,7 @@ class ScalaHtmlRenderer(ctx: DokkaContext) extends HtmlRenderer(ctx) {
   override def buildHtml(page: PageNode, resources: JList[String], kotlinxContent: FlowContentConsumer): String =
     val (pageTitle, noFrame) = page match
       case static: StaticPageNode =>
-        (static.template.title(), !static.hasFrame())
+        (static.template.title, !static.hasFrame())
       case _ =>
         (page.getName, false)
 
diff --git a/scala3doc/test/dotty/dokka/site/TemplateFileTests.scala b/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"))
