org.specs2.text.Markdown.scala Maven / Gradle / Ivy
package org.specs2
package text
import org.pegdown._
import ast._
import scala.io.Source
import scala.xml._
import parsing.XhtmlParser
import control.Exceptions._
import Trim._
/**
* This trait can process strings formatted using the Markdown syntax and output html
*/
private[specs2]
trait Markdown {
/**
* @return a Markdown processor
* for now QUOTES and SMARTS are not rendered to avoid characters to appear on html pages
*/
def processor =
new PegDownProcessor(
~Extensions.QUOTES &
~Extensions.SMARTS &
~Extensions.EXTANCHORLINKS,
10000)
/**
* parse the markdown string and return html.
* code tags are prettified and newlines in paragraphs are
* transformed to
tags
*/
def toHtml(text: String, options: MarkdownOptions = MarkdownOptions()) = {
(new Specs2Visitor(text, options)).toHtml(processor.parseMarkdown(text.replace("\\\\n", "\n").toCharArray))
}
/**
* parse the markdown string and return html without the enclosing paragraph
*/
def toHtmlNoPar(text: String, options: MarkdownOptions = MarkdownOptions()) = {
val html = toHtml(text, options)
if (!text.contains("\n") || text.trim.isEmpty) html.removeEnclosingXmlTag("p") else html
}
/**
* parse the markdown string and return xml (unless the arguments deactivate the markdown rendering)
*/
def toXhtml(text: String, options: MarkdownOptions = MarkdownOptions()): NodeSeq = {
val html = toHtmlNoPar(text, options)
parse(html) match {
case Some(f) => f
case None => scala.xml.Text(text)
}
}
private def parse(html: String) = {
tryo(XhtmlParser(Source.fromString(""+html+" ")).head.child)
}
}
private[specs2]
object Markdown extends Markdown
/**
* specialised pegdown visitor to control the rendering of code blocks
*/
case class Specs2Visitor(text: String, options: MarkdownOptions = MarkdownOptions()) extends org.pegdown.ToHtmlSerializer(new LinkRenderer) {
override def visit(node: CodeNode): Unit = {
printCode(node)
}
override def visit(node: ParaNode): Unit = {
super.visit(node)
}
override def visit(node: TextNode): Unit = {
super.visit(node)
}
override def visit(node: SimpleNode): Unit = {
super.visit(node)
if (node.getType == SimpleNode.Type.Linebreak) {
val indent = text.drop(node.getEndIndex).takeWhile(_ == ' ').length
(1 to indent) foreach { i => super.visit(new SimpleNode(SimpleNode.Type.Nbsp)) }
}
}
override def visit(node: VerbatimNode): Unit = {
// render verbatim nodes as simple text if the verbatim option is false
if (!options.verbatim && node.getType.isEmpty && node.getText.contains("\n")) {
val indents = text.split("\n").filter(_.nonEmpty).map(line => line.takeWhile(_ == ' ').length)
val verbatim = node.getText.split("\n").map(line => line.trim)
val lines = (indents zip verbatim).map { case (indent, line) => " "*indent + line }.mkString("
")
super.visit(new TextNode(lines))
}
else super.visit(new VerbatimNode(node.getText, "prettyprint"))
}
private def printCode(node: TextNode): Unit = {
val text = node.getText
if (text.contains("\n"))
printer.print("").
print("""""").
printEncoded(text.removeFirst("\n")).
print("").
print("")
else
printer.
print("""""").
printEncoded(text).
print("")
()
}
}
case class MarkdownOptions(verbatim: Boolean = true)