Redesign layouts support - add isHtml to ResolvedPage

VirtusLab · Aug 17, 2020 · 902319f · 902319f
1 parent c0082c1
commit 902319f
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 20 deletions.
diff --git a/src/main/kotlin/com/virtuslab/dokka/site/processors.kt b/src/main/kotlin/com/virtuslab/dokka/site/processors.kt
@@ -195,28 +195,25 @@ class SitePagesCreator(cxt: DokkaContext) : BaseStaticSiteProcessor(cxt) {
                 } else from
             )
 
-
             val resolvedPage = try {
-                val context = RenderingContext(emptyMap(), layouts)
+                val context = RenderingContext(mapOf("content" to templateFile.rawCode), layouts)
                 if (from.isDirectory) {
                     children.find { it.isIndexPage }?.resolved ?: EmptyResolvedPage
-                } else if (templateFile.layout() != null ){
-                    templateFile.layout().let { layouts[it] }
-                        ?. resolve(context.nest(templateFile.rawCode, from.absolutePath, emptyList()))
-                        ?: throw Exception("Failed to resolve (layout '${templateFile.layout()}' might not be defined")
-                } else { // no layout
+                } else {
                     templateFile.resolve(context)
                 }
             } catch (e: Throwable) {
                 val msg = "Error rendering $from: ${e.message}"
                 println("ERROR: $msg") // TODO (#14): provide proper error handling
-                ResolvedPage(msg, emptyList())
+                ResolvedPage(msg)
             }
 
-            val parser = HtmlParser()
+            val parser =
+                if (resolvedPage.isHtml) HtmlParser()
+                else MarkdownParser(logger = DokkaConsoleLogger)
 
             val docTag = try {
-                parser.parseStringToDocNode(resolvedPage.html)
+                parser.parseStringToDocNode(resolvedPage.code)
             } catch (e: Throwable) {
                 val msg = "Error rendering $from: ${e.message}"
                 println("ERROR: $msg") // TODO (#14): provide proper error handling

diff --git a/src/main/kotlin/com/virtuslab/dokka/site/renderer.kt b/src/main/kotlin/com/virtuslab/dokka/site/renderer.kt
@@ -49,7 +49,7 @@ class ExternalDocsToolRenderer(context: DokkaContext) : org.jetbrains.dokka.base
                         script { unsafe { +"""var pathToRoot = "${locationProvider.resolveRoot(page)}";""" } }
                     }
                     body {
-                        unsafe { +page.resolved.html }
+                        unsafe { +page.resolved.code }
                     }
                 }
             else ->

diff --git a/src/main/kotlin/com/virtuslab/dokka/site/templates.kt b/src/main/kotlin/com/virtuslab/dokka/site/templates.kt
@@ -14,6 +14,7 @@ import com.vladsch.flexmark.parser.ParserEmulationProfile
 import com.vladsch.flexmark.util.options.DataHolder
 import com.vladsch.flexmark.util.options.MutableDataSet
 import liqp.Template
+import org.jetbrains.dokka.model.doc.DocTag
 import java.io.File
 import java.util.HashMap
 
@@ -43,7 +44,7 @@ data class RenderingContext(
     val markdownOptions: DataHolder = defaultMardownOptions,
     val resources: List<String> = emptyList()
 ) {
-    fun nest(code: String, path: String, resources: List<String>) =
+    internal fun nest(code: String, path: String, resources: List<String>) =
         copy(
             resolving = resolving + path,
             properties = properties + ("content" to code),
@@ -52,11 +53,12 @@ data class RenderingContext(
 }
 
 data class ResolvedPage(
-    val html: String,
+    val code: String,
+    val isHtml: Boolean = true,
     val resources: List<String> = emptyList()
 )
 
-val EmptyResolvedPage = ResolvedPage("")
+val EmptyResolvedPage = ResolvedPage(code = "")
 
 data class TemplateFile(val file: File, val rawCode: String, private val settings: Map<String, List<String>>) {
     private fun stringSetting(name: String): String? {
@@ -81,15 +83,15 @@ data class TemplateFile(val file: File, val rawCode: String, private val setting
             throw java.lang.RuntimeException("Cycle in templates involving $file: ${ctx.resolving}")
 
         val rendered = Template.parse(this.rawCode).render(HashMap(ctx.properties)) // Library requires mutable maps..
-        val code = if (isHtml) rendered else {
+        val code = if (!isHtml) rendered else {
             val parser: Parser = Parser.builder().build()
             HtmlRenderer.builder(ctx.markdownOptions).build().render(parser.parse(rendered))
         }
         val resources = listSetting("extraCSS") + listSetting("extraJS")
         return layout()?.let {
             val layoutTemplate = ctx.layouts[it] ?: throw RuntimeException("No layouts named $it in ${ctx.layouts}")
             layoutTemplate.resolveInner(ctx.nest(code, file.absolutePath, resources))
-        } ?: ResolvedPage(code, resources + ctx.resources)
+        } ?: ResolvedPage(code, isHtml, resources + ctx.resources)
     }
 }
 

diff --git a/src/test/kotlin/headerTests.kt b/src/test/kotlin/headerTests.kt
@@ -75,7 +75,7 @@ class TemplateFileTests {
         ) {
             assertEquals(
                 "<p>Ala <p>ma kota w <strong>paski</strong></p>\n. Hej!</p>",
-                it.layouts["content"]!!.resolve(it).html.trim()
+                it.layouts["content"]!!.resolve(it).code.trim()
             )
         }
     }
@@ -131,7 +131,7 @@ class TemplateFileTests {
         ) {
             assertEquals(
                 expected,
-                it.layouts["content"]!!.resolve(it).html.trim()
+                it.layouts["content"]!!.resolve(it).code.trim()
             )
         }
     }
@@ -144,7 +144,7 @@ class TemplateFileTests {
             """.trimIndent(),
             ext = "md"
         ) {
-            assertEquals("<h1>Hello there!</h1>", resolve(RenderingContext(mapOf("msg" to "there"))).html.trim())
+            assertEquals("<h1>Hello there!</h1>", resolve(RenderingContext(mapOf("msg" to "there"))).code.trim())
         }
     }
 
@@ -156,7 +156,7 @@ class TemplateFileTests {
             """.trimIndent(),
             ext = "md"
         ) {
-            assertEquals("<h1>Hello there!</h1>", resolve(RenderingContext(mapOf("msg" to "there"))).html.trim())
+            assertEquals("<h1>Hello there!</h1>", resolve(RenderingContext(mapOf("msg" to "there"))).code.trim())
         }
     }
 }
-Original file line number
+Diff line change
@@ Expand Up @@
                             script { unsafe { +"""var pathToRoot = "${locationProvider.resolveRoot(page)}";""" } }
                         }
                         body {
-                            unsafe { +page.resolved.html }
+                            unsafe { +page.resolved.code }
                         }
                     }
                 else ->
@@ Expand Down @@