org.specs2.text.Markdown.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of specs2_2.10.0-M7 Show documentation

specs2

The newest version!

package org.specs2
package text

import org.pegdown.{ PegDownProcessor, Extensions }
import scala.io.Source
import scala.xml._
import parsing.XhtmlParser
import Trim._
import main.Arguments
import control.Exceptions._

/**
 * 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.ALL & ~Extensions.QUOTES & ~Extensions.SMARTS)
  /**
   * parse the markdown string and return html.
   * code tags are prettified and newlines in paragraphs are
   * transformed to 
 tags
   */
  def toHtml(text: String) = {
    processor.markdownToHtml(text.replace("\\", "\\\\")).
      replaceAll("" -> "")
  }

  /**
   * parse the markdown string and return html without the enclosing paragraph
   */
  def toHtmlNoPar(text: String) = {
    val html = toHtml(text)
    if (html.trimNewLines.contains("\n")) html
    else html.removeEnclosingXmlTag("p")
  }

  /**
   * parse the markdown string and return xml (unless the arguments deactivate the markdown rendering)
   */
  def toXhtml(text: String)(implicit args: Arguments = Arguments()): NodeSeq = {
    if (!args.markdown) scala.xml.Text(text)
    else {
      val html = toHtmlNoPar(text)
      parse(html) match {
        case Some(f) => f
        case None => scala.xml.Text(if (args.debugMarkdown) html else text)
      }
    }
  }

  private def parse(html: String)(implicit args: Arguments) = {
    val f = (e: Exception) => if (args.debugMarkdown) e.printStackTrace
    tryo(XhtmlParser(Source.fromString(""+html+"")).head.child)(f)
  }
}
private[specs2]
object Markdown extends Markdown