Tests for wrapping groups in renderer. Also util for groups

1 files changed, 157 insertions, 0 deletions

diff --git a/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt b/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
new file mode 100644
index 00000000..7fac6450
--- /dev/null
+++ b/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
@@ -0,0 +1,157 @@
+package renderers.html
+
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.renderers.html.HtmlRenderer
+import org.jetbrains.dokka.base.resolvers.DefaultLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.LocationProvider
+import org.jetbrains.dokka.base.resolvers.LocationProviderFactory
+import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
+import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
+import org.jetbrains.dokka.links.DRI
+import org.jetbrains.dokka.model.Documentable
+import org.jetbrains.dokka.model.doc.DocTag
+import org.jetbrains.dokka.pages.*
+import org.jetbrains.dokka.testApi.context.MockContext
+import org.jetbrains.dokka.utilities.DokkaConsoleLogger
+import org.junit.Test
+import utils.TestOutputWriter
+
+class GroupWrappingTest {
+
+    val files = TestOutputWriter()
+    val context = MockContext(
+        DokkaBase().outputWriter to { _ -> files },
+        DokkaBase().locationProviderFactory to ::DefaultLocationProviderFactory
+    )
+
+    @Test
+    fun notWrapped() {
+
+        val page = createPage {
+            group {
+                text("a")
+                text("b")
+            }
+            text("c")
+        }
+
+        HtmlRenderer(context).render(page)
+
+        assert(linesAfterContentTag().contains("abc"))
+    }
+
+    @Test
+    fun paragraphWrapped() {
+
+        val page = createPage {
+            group(styles = setOf(TextStyle.Paragraph)) {
+                text("a")
+                text("b")
+            }
+            text("c")
+        }
+
+        HtmlRenderer(context).render(page)
+
+        assert(linesAfterContentTag().contains("<p>ab</p>c"))
+    }
+
+    @Test
+    fun blockWrapped() {
+
+        val page = createPage {
+            group(styles = setOf(TextStyle.Block)) {
+                text("a")
+                text("b")
+            }
+            text("c")
+        }
+
+        HtmlRenderer(context).render(page)
+
+        assert(linesAfterContentTag().contains("<div>ab</div>c"))
+    }
+
+    @Test
+    fun nested() {
+
+        val page = createPage {
+            group(styles = setOf(TextStyle.Block)) {
+                text("a")
+                group(styles = setOf(TextStyle.Block)) {
+                    group(styles = setOf(TextStyle.Block)) {
+                        text("b")
+                        text("c")
+                    }
+                }
+                text("d")
+            }
+        }
+
+        HtmlRenderer(context).render(page)
+
+        assert(linesAfterContentTag().contains("<div>a<div><div>bc</div></div>d</div>"))
+    }
+
+    private fun linesAfterContentTag() =
+        files.contents.getValue("test-page.html").lines()
+            .dropWhile { !it.contains("""<div id="content">""") }
+            .joinToString(separator = "") { it.trim() }
+}
+
+// TODO: may be useful for other tests, consider extracting
+private fun createPage(
+    callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit
+) = object : RootPageNode(), ContentPage {
+    override val dri: Set<DRI> = setOf(DRI.topLevel)
+    override val documentable: Documentable? = null
+    override val embeddedResources: List<String> = emptyList()
+    override val name: String
+        get() = "testPage"
+    override val children: List<PageNode>
+        get() = emptyList()
+
+    override val content: ContentNode = PageContentBuilder(EmptyCommentConverter, DokkaConsoleLogger).contentFor(
+        DRI.topLevel,
+        emptySet(),
+        block = callback
+    )
+
+    override fun modified(
+        name: String,
+        content: ContentNode,
+        dri: Set<DRI>,
+        embeddedResources: List<String>,
+        children: List<PageNode>
+    ) = this
+
+    override fun modified(name: String, children: List<PageNode>) = this
+}
+
+private object EmptyCommentConverter : CommentsToContentConverter {
+    override fun buildContent(
+        docTag: DocTag,
+        dci: DCI,
+        platforms: Set<PlatformData>,
+        styles: Set<Style>,
+        extras: Set<Extra>
+    ): List<ContentNode> = emptyList()
+}
+
+private object EmptyLocationProviderFactory: LocationProviderFactory {
+    override fun getLocationProvider(pageNode: RootPageNode) = object : LocationProvider {
+        override fun resolve(dri: DRI, platforms: List<PlatformData>, context: PageNode?): String = ""
+
+        override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean): String = node.name
+
+        override fun resolveRoot(node: PageNode): String {
+            TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
+        }
+
+        override fun ancestors(node: PageNode): List<PageNode> {
+            TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
+        }
+
+    }
+
+}
\ No newline at end of file