From 7cc8751a0e3e14015da449ff23000ea2b836c251 Mon Sep 17 00:00:00 2001
From: Joe Nievelt <jnievelt@twitter.com>
Date: Wed, 10 Jul 2013 16:36:30 -0700
Subject: [PATCH] tests for scaffold.Document

---
 .../com/twitter/scaffold/main.scala.html      | 22 ++---
 src/test/resources/markdown/empty.md          |  0
 .../resources/markdown/heading_with_lead.md   |  3 +
 .../resources/markdown/multiple_headings.md   | 19 +++++
 src/test/resources/markdown/no_heading.md     |  1 +
 src/test/resources/markdown/only_heading.md   |  1 +
 src/test/resources/markdown/with_code.md      |  7 ++
 .../com/twitter/scaffold/DocumentSpec.scala   | 68 ++++++++++++++++
 .../scaffold/DocumentSpecHelpers.scala        | 81 +++++++++++++++++++
 9 files changed, 191 insertions(+), 11 deletions(-)
 create mode 100644 src/test/resources/markdown/empty.md
 create mode 100644 src/test/resources/markdown/heading_with_lead.md
 create mode 100644 src/test/resources/markdown/multiple_headings.md
 create mode 100644 src/test/resources/markdown/no_heading.md
 create mode 100644 src/test/resources/markdown/only_heading.md
 create mode 100644 src/test/resources/markdown/with_code.md
 create mode 100644 src/test/scala/com/twitter/scaffold/DocumentSpec.scala
 create mode 100644 src/test/scala/com/twitter/scaffold/DocumentSpecHelpers.scala
diff --git a/src/main/twirl/com/twitter/scaffold/main.scala.html b/src/main/twirl/com/twitter/scaffold/main.scala.html
index ba4f803..278f62c 100644
--- a/src/main/twirl/com/twitter/scaffold/main.scala.html
+++ b/src/main/twirl/com/twitter/scaffold/main.scala.html
@@ -3,19 +3,19 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8">
+    <meta charset="utf-8"/>
     <title>@title</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="description" content="">
-    <meta name="author" content="">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+    <meta name="description" content=""/>
+    <meta name="author" content=""/>
 
-    <link href="/assets/bootstrap/2.3.2/css/bootstrap.min.css" rel="stylesheet">
-    <link href="/assets/bootstrap/2.3.2/css/bootstrap-responsive.min.css" rel="stylesheet">
+    <link href="/assets/bootstrap/2.3.2/css/bootstrap.min.css" rel="stylesheet"/>
+    <link href="/assets/bootstrap/2.3.2/css/bootstrap-responsive.min.css" rel="stylesheet"/>
 
-    <link href="/assets/codemirror/3.14/lib/codemirror.css" rel="stylesheet">
-    <link href="/assets/codemirror/3.14/theme/solarized.css" rel="stylesheet">
-    <link href="/assets/scaffold.css" rel="stylesheet">
-	<link href="/assets/show-hint.css" rel="stylesheet">
+    <link href="/assets/codemirror/3.14/lib/codemirror.css" rel="stylesheet"/>
+    <link href="/assets/codemirror/3.14/theme/solarized.css" rel="stylesheet"/>
+    <link href="/assets/scaffold.css" rel="stylesheet"/>
+	<link href="/assets/show-hint.css" rel="stylesheet"/>
 
     <!--[if lt IE 9]>
       <script src="/assets/html5shiv/3.6.2/html5shiv.min.js"></script>
@@ -32,7 +32,7 @@
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>
           </button>
-          <a class="brand" href="/"><img src="/assets/img/twitter-bird-dark-bgs.png"> Scala School 2</a>
+          <a class="brand" href="/"><img src="/assets/img/twitter-bird-dark-bgs.png"/> Scala School 2</a>
           <div class="nav-collapse collapse">
             <ul class="nav">
               <li class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Data and Control Flow <b class="caret"></b></a>
diff --git a/src/test/resources/markdown/empty.md b/src/test/resources/markdown/empty.md
new file mode 100644
index 0000000..e69de29
diff --git a/src/test/resources/markdown/heading_with_lead.md b/src/test/resources/markdown/heading_with_lead.md
new file mode 100644
index 0000000..c277632
--- /dev/null
+++ b/src/test/resources/markdown/heading_with_lead.md
@@ -0,0 +1,3 @@
+# the heading
+
+And the lead
diff --git a/src/test/resources/markdown/multiple_headings.md b/src/test/resources/markdown/multiple_headings.md
new file mode 100644
index 0000000..71c94d7
--- /dev/null
+++ b/src/test/resources/markdown/multiple_headings.md
@@ -0,0 +1,19 @@
+# first/title
+
+LEAD
+
+
+
+# section 1
+Body1
+# Sec B
+
+
+
+Second body
+
+
+# Part III
+
+A section
+be here
diff --git a/src/test/resources/markdown/no_heading.md b/src/test/resources/markdown/no_heading.md
new file mode 100644
index 0000000..ddfc39d
--- /dev/null
+++ b/src/test/resources/markdown/no_heading.md
@@ -0,0 +1 @@
+no heading
\ No newline at end of file
diff --git a/src/test/resources/markdown/only_heading.md b/src/test/resources/markdown/only_heading.md
new file mode 100644
index 0000000..31d137a
--- /dev/null
+++ b/src/test/resources/markdown/only_heading.md
@@ -0,0 +1 @@
+# only heading
\ No newline at end of file
diff --git a/src/test/resources/markdown/with_code.md b/src/test/resources/markdown/with_code.md
new file mode 100644
index 0000000..2bcfec7
--- /dev/null
+++ b/src/test/resources/markdown/with_code.md
@@ -0,0 +1,7 @@
+# With some code
+
+# code section
+
+Code preface
+
+    var actual_code = 0
diff --git a/src/test/scala/com/twitter/scaffold/DocumentSpec.scala b/src/test/scala/com/twitter/scaffold/DocumentSpec.scala
new file mode 100644
index 0000000..a6e0e6d
--- /dev/null
+++ b/src/test/scala/com/twitter/scaffold/DocumentSpec.scala
@@ -0,0 +1,68 @@
+package com.twitter.scaffold
+
+import org.scalatest.WordSpec
+import org.scalatest.matchers.MustMatchers
+import com.twitter.scaffold.Document
+import DocumentSpecHelpers._
+
+class DocumentSpec extends WordSpec with MustMatchers {
+  def render(name: String) = Document.render(name)
+  def getHtml(name: String): String = render(name).get.toString
+
+  "Document.render" should {
+    "return None for non-existent data file" in {
+      render("not_a_file") must equal (None)
+    }
+
+    "return None for empty data file" in {
+      render("empty") must equal (None)
+    }
+
+    "return None for a file not starting with a heading" in {
+      render("no_heading") must equal (None)
+    }
+  }
+
+  "Document.render" can {
+    "render a file with only a heading" in {
+      val xml = parse(getHtml("only_heading"))
+      title(xml) must equal ("Scala School 2 - only heading")
+      firstHeading(xml) must equal ("only heading")
+      lead(xml) must equal ("")
+    }
+
+    "render a heading and lead" in {
+      val xml = parse(getHtml("heading_with_lead"))
+      title(xml) must equal ("Scala School 2 - the heading")
+      firstHeading(xml) must equal ("the heading")
+      lead(xml) must equal ("And the lead")
+    }
+
+    "render multiple headings" in {
+      val xml = parse(getHtml("multiple_headings"))
+      title(xml) must equal ("Scala School 2 - first/title")
+      firstHeading(xml) must equal ("first/title")
+      lead(xml) must equal ("LEAD")
+      toc(xml) must equal (
+        List(
+          ("section 1", "#section-1"),
+          ("Sec B", "#sec-b"),
+          ("Part III", "#part-iii")
+        )
+      )
+      sections(xml) must equal (
+        List(
+          ("section-1", "section 1", "<p>Body1</p>"),
+          ("sec-b", "Sec B", "<p>Second body</p>"),
+          ("part-iii", "Part III", "<p>A section<br/>be here</p>")
+        )
+      )
+    }
+
+    "render code segments" in {
+      val xml = parse(getHtml("with_code"))
+      toc(xml).head must equal (("code section", "#code-section"))
+      sections(xml).head must equal (("code-section", "code section", "<p>Code preface</p><textarea>var actual_code = 0\n</textarea>"))
+    }
+  }
+}
diff --git a/src/test/scala/com/twitter/scaffold/DocumentSpecHelpers.scala b/src/test/scala/com/twitter/scaffold/DocumentSpecHelpers.scala
new file mode 100644
index 0000000..3affbde
--- /dev/null
+++ b/src/test/scala/com/twitter/scaffold/DocumentSpecHelpers.scala
@@ -0,0 +1,81 @@
+package com.twitter.scaffold
+
+import scala.xml._
+
+object DocumentSpecHelpers {
+  def parse(html: String) = XML.loadString(html)
+
+  def title(xml: Elem): String = {
+    xml.child.find {
+      _.label == "head"
+    } flatMap {
+      _.child.find(_.label == "title")
+    } map {
+      _.text
+    } getOrElse ""
+  }
+
+  def firstHeading(xml: Elem): String = {
+    xml.child.find {
+      _.label == "body"
+    } flatMap {
+      _.child.find(_.label == "header")
+    } flatMap {
+      _.child.find(_.label == "div")
+    } flatMap {
+      _.child.find(_.label == "h1")
+    } map {
+      _.text
+    } getOrElse ""
+  }
+
+  def lead(xml: Elem): String = {
+    xml.child.find {
+      _.label == "body"
+    } flatMap {
+      _.child.find(_.label == "header")
+    } flatMap {
+      _.child.find(_.label == "div")
+    } flatMap {
+      _.child.find(_.label == "p")
+    } map {
+      _.text
+    } getOrElse ""
+  }
+
+  def toc(xml: Elem): List[(String, String)] = {
+    xml.child.find {
+      _.label == "body"
+    } flatMap {
+      _.child.find { n: Node =>
+        n.label == "div" && n.attributes("class") != null && n.attributes("class").head.text == "span3 scaffold-sidebar"
+      }
+    } flatMap {
+      _.child.find(_.label == "ul")
+    } map {
+      _.child.toList.filter(_.label == "li") map { n: Node =>
+        val c = n.child.find(_.label == "a").get
+        (c.text.tail, c.attributes("href").head.text)
+      }
+    } getOrElse List()
+  }
+
+  def sections(xml: Elem): List[(String, String, String)] = {
+    xml.child.find {
+      _.label == "body"
+    } flatMap {
+      _.child.find { n: Node =>
+        n.label == "div" && n.attributes("class") != null && n.attributes("class").head.text == "container"
+      }
+    } map {
+      _.child(1).child(1)
+    } map {
+      _.child.toList.filter(_.label == "section") map { n: Node =>
+        val link = n.attributes("id").head.text
+        val header = n.child(1).child(0).text
+        val rest = n.child.tail.tail.mkString("").trim
+        (link, header, rest)
+      }
+    } getOrElse List()
+  }
+}
