org.jetbrains.kotlinx.jupyter.api.libraries.ResourceBuilders.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-jupyter-api Show documentation
API for libraries supporting Kotlin Jupyter notebooks
There is a newer version: 0.12.0-335
package org.jetbrains.kotlinx.jupyter.api.libraries

import org.jetbrains.kotlinx.jupyter.api.KernelLoggerFactory
import org.jetbrains.kotlinx.jupyter.api.getLogger
import java.io.File

/**
 * Build a resource tree using [ResourcesBuilder]. The builder allows to construct `js` and `css` bundles. Each bundle
 * could contain multiple files or urls. Each of those could contain multiple fallback paths (for example if URL not
 * found, local resource is used.
 */
fun JupyterIntegration.Builder.resources(block: ResourcesBuilder.() -> Unit) {
    val resources = ResourcesBuilder(notebook.loggerFactory).apply(block)
    resources.resources.forEach {
        resource(it)
    }
}

class ResourcesBuilder(
    loggerFactory: KernelLoggerFactory,
) {
    private val logger = loggerFactory.getLogger(this::class)
    internal val resources = ArrayList()

    inner class BundleBuilder {
        internal val bundles = ArrayList()

        private fun checkLocalPath(localPath: String) {
            if (!File(localPath).exists()) {
                logger.warn("A resource with local file path '$localPath' not found.")
            }
        }

        /**
         * Create an url resource with optional embedding (governed by [embed] flag) with optional local file fallback
         * and a class-path fallback. If fallbacks are null, they are not used.
         */
        @OptIn(ExperimentalStdlibApi::class)
        fun url(
            url: String,
            localFallBack: String? = null,
            classpathFallBack: String? = null,
            embed: Boolean = false,
        ) {
            val libraryResource =
                ResourceFallbacksBundle(
                    buildList {
                        if (embed) {
                            add(ResourceLocation(url, ResourcePathType.URL_EMBEDDED))
                        } else {
                            add(ResourceLocation(url, ResourcePathType.URL))
                        }
                        localFallBack?.let {
                            checkLocalPath(localFallBack)
                            add(ResourceLocation(localFallBack, ResourcePathType.LOCAL_PATH))
                        }
                        classpathFallBack?.let {
                            add(ResourceLocation(classpathFallBack, ResourcePathType.CLASSPATH_PATH))
                        }
                    },
                )
            bundles.add(libraryResource)
        }

        /**
         * Use local resource from file
         */
        fun local(localPath: String) {
            checkLocalPath(localPath)
            bundles.add(
                ResourceFallbacksBundle(
                    listOf(ResourceLocation(localPath, ResourcePathType.LOCAL_PATH)),
                ),
            )
        }

        /**
         * Use Jar class-path resource
         */
        fun classPath(classPath: String) {
            bundles.add(
                ResourceFallbacksBundle(
                    listOf(ResourceLocation(classPath, ResourcePathType.CLASSPATH_PATH)),
                ),
            )
        }
    }

    /**
     * Create a JS resource bundle
     */
    fun js(
        name: String,
        block: BundleBuilder.() -> Unit,
    ) {
        val bundles = BundleBuilder().apply(block).bundles
        resources.add(
            LibraryResource(
                name = name,
                type = ResourceType.JS,
                bundles = bundles,
            ),
        )
    }

    /**
     * Create a Css resource bundle
     */
    fun css(
        name: String,
        block: BundleBuilder.() -> Unit,
    ) {
        val bundles = BundleBuilder().apply(block).bundles
        resources.add(
            LibraryResource(
                name = name,
                type = ResourceType.CSS,
                bundles = bundles,
            ),
        )
    }
}