From a945617725e8df084270aacd5af76da2b911111e Mon Sep 17 00:00:00 2001
From: Paweł Marks <pmarks@virtuslab.com>
Date: Mon, 25 Nov 2019 15:34:47 +0100
Subject: Interface segregation in plugins api

---
 core/src/main/kotlin/plugability/DokkaContext.kt | 82 +++++++++++++++---------
 1 file changed, 51 insertions(+), 31 deletions(-)

(limited to 'core/src/main/kotlin/plugability/DokkaContext.kt')

diff --git a/core/src/main/kotlin/plugability/DokkaContext.kt b/core/src/main/kotlin/plugability/DokkaContext.kt
index dcd3398e..7727329c 100644
--- a/core/src/main/kotlin/plugability/DokkaContext.kt
+++ b/core/src/main/kotlin/plugability/DokkaContext.kt
@@ -1,55 +1,75 @@
 package org.jetbrains.dokka.plugability
 
+import org.jetbrains.dokka.DokkaLogger
 import java.io.File
 import java.net.URLClassLoader
 import java.util.*
 import kotlin.reflect.KClass
 
+interface DokkaContext {
+    operator fun <T : Any, E : ExtensionPoint<T>> get(point: E): List<Extension<T>>
 
-class DokkaContext private constructor() {
+    fun <T : DokkaPlugin> plugin(kclass: KClass<T>): T?
+
+    val logger: DokkaLogger
+
+    companion object {
+        fun create(pluginsClasspath: Iterable<File>, logger: DokkaLogger): DokkaContext =
+            DokkaContextConfigurationImpl(logger).apply {
+                pluginsClasspath.map { it.relativeTo(File(".").absoluteFile).toURI().toURL() }
+                    .toTypedArray()
+                    .let { URLClassLoader(it, this.javaClass.classLoader) }
+                    .also { checkClasspath(it) }
+                    .let { ServiceLoader.load(DokkaPlugin::class.java, it) }
+                    .forEach { install(it) }
+            }.also { it.logInitialisationInfo() }
+    }
+}
+
+interface DokkaContextConfiguration {
+    fun addExtension(extension: Extension<*>)
+}
+
+private class DokkaContextConfigurationImpl(
+    override val logger: DokkaLogger
+) : DokkaContext, DokkaContextConfiguration {
     private val plugins = mutableMapOf<KClass<*>, DokkaPlugin>()
 
     internal val extensions = mutableMapOf<ExtensionPoint<*>, MutableList<Extension<*>>>()
 
     @Suppress("UNCHECKED_CAST")
-    operator fun <T: Any, E: ExtensionPoint<T>> get(point: E) = extensions[point] as List<Extension<T>>
-
-    @PublishedApi
-    internal fun plugin(kclass: KClass<*>) = plugins[kclass]
-
-    val pluginNames: List<String>
-        get() = plugins.values.map { it::class.qualifiedName.toString() }
+    override operator fun <T : Any, E : ExtensionPoint<T>> get(point: E) = extensions[point] as List<Extension<T>>
 
-    val loadedListForDebug
-        get() = extensions.run { keys + values.flatten() }.toList()
-            .joinToString(prefix = "[\n", separator = ",\n", postfix = "\n]") { "\t$it" }
+    @Suppress("UNCHECKED_CAST")
+    override fun <T : DokkaPlugin> plugin(kclass: KClass<T>) = plugins[kclass] as T
 
-    private fun install(plugin: DokkaPlugin) {
+    fun install(plugin: DokkaPlugin) {
         plugins[plugin::class] = plugin
+        plugin.context = this
         plugin.internalInstall(this)
     }
 
-    companion object {
-        fun from(pluginsClasspath: Iterable<File>) = DokkaContext().apply {
-            pluginsClasspath.map { it.relativeTo(File(".").absoluteFile).toURI().toURL() }
-                .toTypedArray()
-                .let { URLClassLoader(it, this.javaClass.classLoader) }
-                .also { checkClasspath(it) }
-                .let { ServiceLoader.load(DokkaPlugin::class.java, it) }
-                .forEach { install(it) }
-        }
+    override fun addExtension(extension: Extension<*>) {
+        extensions.getOrPut(extension.extensionPoint, ::mutableListOf) += extension
     }
 
-    private fun checkClasspath(classLoader: URLClassLoader) {
-        classLoader.findResource(javaClass.name.replace('.', '/') + ".class")?.also {
-            throw AssertionError(
-                "Dokka API found on plugins classpath. This will lead to subtle bugs. " +
-                        "Please fix your plugins dependencies or exclude dokka api artifact from plugin classpath"
-            )
-        }
-    }
+    fun logInitialisationInfo() {
+        val pluginNames: List<String> = plugins.values.map { it::class.qualifiedName.toString() }
+
+        val loadedListForDebug = extensions.run { keys + values.flatten() }.toList()
+            .joinToString(prefix = "[\n", separator = ",\n", postfix = "\n]") { "\t$it" }
+
+        logger.progress("Loaded plugins: ${pluginNames}")
+        logger.progress("Loaded: ${loadedListForDebug}")
 
-    internal fun addExtension(it: Extension<*>) {
-        extensions.getOrPut(it.extensionPoint, ::mutableListOf) += it
     }
 }
+
+private fun checkClasspath(classLoader: URLClassLoader) {
+    classLoader.findResource(DokkaContext::class.java.name.replace('.', '/') + ".class")?.also {
+        throw AssertionError(
+            "Dokka API found on plugins classpath. This will lead to subtle bugs. " +
+                    "Please fix your plugins dependencies or exclude dokka api artifact from plugin classpath"
+        )
+    }
+}
\ No newline at end of file
-- 
cgit