Add search page to site structure

Author: felixmulder

doc-tool/resources/_layouts/search.html

@@ -0,0 +1,10 @@
+---
+layout: main
+---
+
+<h1 id="searching-for"></h1>
+
+<script>
+    document.getElementById("searching-for").innerHTML =
+        location.search;
+</script>

doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala

@@ -206,6 +206,18 @@ case class Site(
         genDoc(pkg)
         pkg.children.foreach(genDoc)
       }
+
+      // generate search page:
+      val target = mkdirs(fs.getPath(outDir.getAbsolutePath +  "/api/search.html"))
+      val searchPageParams = defaultParams(target.toFile).withPosts(blogInfo).toMap
+      val searchPage = new HtmlPage("_layouts/search.html", layouts("search").content, searchPageParams, includes)
+      render(searchPage).foreach { rendered =>
+        Files.copy(
+          new ByteArrayInputStream(rendered.getBytes(StandardCharsets.UTF_8)),
+          target,
+          REPLACE_EXISTING
+        )
+      }
     }
 
   /** Generate HTML files from markdown and .html sources */
@@ -338,6 +350,7 @@ case class Site(
 
     val defaultLayouts: Map[String, Layout] = Map(
       "main" -> "/_layouts/main.html",
+      "search" -> "/_layouts/search.html",
       "doc-page" -> "/_layouts/doc-page.html",
       "api-page" -> "/_layouts/api-page.html",
       "blog-page" -> "/_layouts/blog-page.html",

doc-tool/test/SourceFileOps.scala

@@ -11,7 +11,10 @@ import model.Package
 
 trait SourceFileOps {
   import scala.collection.JavaConverters._
-  val site = new Site(new java.io.File("../doc-tool/resources/"), "test-site", "v0.1", Map.empty)
+  val site = new Site(
+    new java.io.File("../doc-tool/resources/"),
+    "test-site", "v0.1", "http://github.com/lampepfl/dotty", Map.empty
+  )
 
   def stringToSource(path: String, sourceCode: String): SourceFile = {
     val virtualFile = new VirtualFile(path, path)

doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala

@@ -10,7 +10,7 @@ class SiteTests extends DottyDocTest with SourceFileOps {
     assert(site.root.exists && site.root.isDirectory,
            s"'${site.root.getName}' is not a directory")
 
-    val expectedLayouts = Set("main", "index", "blog-page", "doc-page", "api-page")
+    val expectedLayouts = Set("main", "index", "blog-page", "doc-page", "api-page", "search")
     assert(site.layouts.keys == expectedLayouts,
            s"Incorrect layouts in: ${site.layouts.keys}, expected: $expectedLayouts")
   }
@@ -99,9 +99,12 @@ class SiteTests extends DottyDocTest with SourceFileOps {
       "index.md"
     )
 
+    def printSet(xs: Set[String]): String =
+      xs.toList.sorted.mkString("\n{\n  ", ",\n  ", "\n}")
+
     assert(expectedAssets == assets,
-           s"assets incorrect, found: $assets - expected $expectedAssets")
+           s"assets incorrect, found: ${ printSet(assets) } - expected ${ printSet(expectedAssets) }")
     assert(expectedCompd == compd,
-           s"compilable files incorrect, found: $compd - expected $expectedCompd")
+           s"compilable files incorrect, found: ${ printSet(compd) } - expected ${ printSet(expectedCompd) }")
   }
 }