io.javalin.rendering.markdown.Commonmark.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javalin-rendering Show documentation

There is a newer version: 6.4.0

/*
 * Javalin - https://javalin.io
 * Copyright 2017 David Åse
 * Licensed under Apache 2.0: https://github.com/tipsy/javalin/blob/master/LICENSE
 */

package io.javalin.rendering.markdown

import io.javalin.http.Context
import io.javalin.rendering.FileRenderer
import io.javalin.rendering.JavalinRenderer
import io.javalin.rendering.util.RenderingDependency.COMMONMARK
import io.javalin.rendering.util.Util
import org.commonmark.parser.Parser
import org.commonmark.renderer.html.HtmlRenderer

class JavalinCommonmark @JvmOverloads constructor(
    private var renderer: HtmlRenderer = defaultRenderer(),
    private var parser: Parser = defaultParser()
) : FileRenderer {

    override fun render(filePath: String, model: Map, ctx: Context): String {
        val fileContent = JavalinCommonmark::class.java.getResource(filePath).readText()
        return renderer.render(parser.parse(fileContent))
    }

    companion object {
        val extensions = arrayOf(".md", ".markdown")

        @JvmStatic
        @JvmOverloads
        fun init(htmlRenderer: HtmlRenderer? = null, parser: Parser? = null) {
            Util.throwIfNotAvailable(COMMONMARK)
            val fileRenderer = JavalinCommonmark(htmlRenderer ?: defaultRenderer(), parser ?: defaultParser())
            JavalinRenderer.register(fileRenderer, *extensions)
        }

        fun defaultRenderer(): HtmlRenderer = HtmlRenderer.builder().build()
        fun defaultParser(): Parser = Parser.builder().build()
    }

    class Loader : JavalinRenderer.FileRendererLoader {
        override fun load() = if (!JavalinRenderer.hasRenderer(*extensions) && COMMONMARK.exists()) init() else Unit
    }

}