Merge branch 'dev-0.11.0'

4 files changed, 132 insertions, 0 deletions

diff --git a/plugins/mathjax/build.gradle.kts b/plugins/mathjax/build.gradle.kts
new file mode 100644
index 00000000..e570de46
--- /dev/null
+++ b/plugins/mathjax/build.gradle.kts
@@ -0,0 +1,14 @@
+import org.jetbrains.registerDokkaArtifactPublication
+
+dependencies {
+    testImplementation("org.jsoup:jsoup:1.12.1")
+    testImplementation(project(":plugins:base"))
+    testImplementation(project(":plugins:base:test-utils"))
+    testImplementation(project(":test-tools"))
+    testImplementation(kotlin("test-junit"))
+    testImplementation(project(":kotlin-analysis"))
+}
+
+registerDokkaArtifactPublication("mathjaxPlugin") {
+    artifactId = "mathjax-plugin"
+}
diff --git a/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt b/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt
new file mode 100644
index 00000000..63699585
--- /dev/null
+++ b/plugins/mathjax/src/main/kotlin/MathjaxPlugin.kt
@@ -0,0 +1,32 @@
+package  org.jetbrains.dokka.mathjax
+
+
+import org.jetbrains.dokka.CoreExtensions
+import org.jetbrains.dokka.model.doc.CustomTagWrapper
+import org.jetbrains.dokka.pages.ContentPage
+import org.jetbrains.dokka.pages.RootPageNode
+import org.jetbrains.dokka.plugability.DokkaPlugin
+import org.jetbrains.dokka.transformers.pages.PageTransformer
+
+class MathjaxPlugin : DokkaPlugin() {
+    val transformer by extending {
+        CoreExtensions.pageTransformer with MathjaxTransformer
+    }
+}
+
+private const val ANNOTATION = "usesMathJax"
+internal const val LIB_PATH = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-AMS_SVG&latest"
+
+object MathjaxTransformer : PageTransformer {
+    override fun invoke(input: RootPageNode) = input.transformContentPagesTree {
+        it.modified(
+            embeddedResources = it.embeddedResources + if (it.isNeedingMathjax) listOf(LIB_PATH) else emptyList()
+        )
+    }
+
+    private val ContentPage.isNeedingMathjax
+        get() = documentable?.documentation?.values
+            ?.flatMap { it.children }
+            .orEmpty()
+            .any { (it as? CustomTagWrapper)?.name == ANNOTATION }
+}
\ No newline at end of file
diff --git a/plugins/mathjax/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/plugins/mathjax/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
new file mode 100644
index 00000000..9f9736f3
--- /dev/null
+++ b/plugins/mathjax/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
@@ -0,0 +1 @@
+org.jetbrains.dokka.mathjax.MathjaxPlugin
diff --git a/plugins/mathjax/src/test/kotlin/MathjaxPluginTest.kt b/plugins/mathjax/src/test/kotlin/MathjaxPluginTest.kt
new file mode 100644
index 00000000..4a4ada23
--- /dev/null
+++ b/plugins/mathjax/src/test/kotlin/MathjaxPluginTest.kt
@@ -0,0 +1,85 @@
+package mathjaxTest
+
+import org.jetbrains.dokka.mathjax.LIB_PATH
+import org.jetbrains.dokka.mathjax.MathjaxPlugin
+import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
+import org.jsoup.Jsoup
+import org.junit.jupiter.api.Test
+import utils.TestOutputWriterPlugin
+
+class MathjaxPluginTest : AbstractCoreTest() {
+    @Test
+    fun noMathjaxTest() {
+        val configuration = dokkaConfiguration {
+            sourceSets {
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/test/Test.kt")
+                }
+            }
+        }
+        val source =
+            """
+            |/src/main/kotlin/test/Test.kt
+            |package example
+            | /**
+            | * Just a regular kdoc
+            | */
+            | fun test(): String = ""
+            """.trimIndent()
+        val writerPlugin = TestOutputWriterPlugin()
+        testInline(
+            source,
+            configuration,
+            pluginOverrides = listOf(writerPlugin, MathjaxPlugin())
+        ) {
+            renderingStage = {
+                    _, _ -> Jsoup
+                .parse(writerPlugin.writer.contents["root/example/test.html"])
+                .head()
+                .select("link, script")
+                .let {
+                    assert(!it.`is`("[href=$LIB_PATH], [src=$LIB_PATH]"))
+                }
+            }
+        }
+    }
+
+    @Test
+    fun usingMathjaxTest() {
+        val configuration = dokkaConfiguration {
+            sourceSets {
+                sourceSet {
+                    sourceRoots = listOf("src/main/kotlin/test/Test.kt")
+                }
+            }
+        }
+        val source =
+            """
+            |/src/main/kotlin/test/Test.kt
+            |package example
+            | /**
+            | * @usesMathJax
+            | *
+            | * \(\alpha_{out} = \alpha_{dst}\)
+            | * \(C_{out} = C_{dst}\)
+            | */
+            | fun test(): String = ""
+            """.trimIndent()
+        val writerPlugin = TestOutputWriterPlugin()
+        testInline(
+            source,
+            configuration,
+            pluginOverrides = listOf(writerPlugin, MathjaxPlugin())
+        ) {
+            renderingStage = {
+                    _, _ -> Jsoup
+                .parse(writerPlugin.writer.contents["root/example/test.html"])
+                .head()
+                .select("link, script")
+                .let {
+                    assert(it.`is`("[href=$LIB_PATH], [src=$LIB_PATH]"))
+                }
+            }
+        }
+    }
+}