Upgrade Paradox (to 0.5.5), Scala (to 2.12.8) and SBT (to 1.2.8) and travis to use scala 2.12.8 #34

Author: Helena Edelson

.travis.yml

@@ -1,6 +1,6 @@
 language: scala
 jdk: oraclejdk8
-scala: 2.12.4
+scala: 2.12.8
 
 jobs:
   include:

build.sbt

@@ -1,4 +1,4 @@
-scalaVersion := "2.12.7"
+scalaVersion := "2.12.8"
 
 sbtPlugin        := true
 crossSbtVersions := List("1.0.0")

project/Dependencies.scala

@@ -3,7 +3,7 @@ import sbt._
 object Version {
   val classgraph = "4.8.41"
   val jtidy      = "r938"
-  val sbtParadox = "0.4.3"
+  val sbtParadox = "0.5.5"
   val scalatest  = "3.0.8"
 }
 

project/build.properties

@@ -1 +1 @@
-sbt.version=1.2.6
+sbt.version=1.2.8

src/test/scala/com.lightbend.paradox/apidoc/ApidocDirectiveSpec.scala

@@ -49,7 +49,7 @@ class ApidocDirectiveSpec extends MarkdownBaseSpec {
   )
 
   override val markdownWriter = new Writer(
-    linkRenderer = Writer.defaultLinks,
+    linkRenderer        = Writer.defaultLinks,
     verbatimSerializers = Writer.defaultVerbatims,
     serializerPlugins = Writer.defaultPlugins(
       Writer.defaultDirectives ++ Seq(
@@ -81,7 +81,6 @@ class ApidocDirectiveSpec extends MarkdownBaseSpec {
       "No matches found for ThereIsNoSuchClass"
   }
 
-
   it should "generate markdown correctly when 2 matches found and their package names include javadsl/scaladsl" in {
     markdown("@apidoc[Flow]") shouldEqual
       html(
@@ -130,12 +129,12 @@ class ApidocDirectiveSpec extends MarkdownBaseSpec {
 
   it should "find a class by partiql fqdn" in {
     markdown("@apidoc[actor.typed.ActorRef]") shouldEqual
-    html(
-      """<p><span class="group-scala">
-        |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/typed/ActorRef.html">ActorRef</a></span><span class="group-java">
-        |<a href="https://doc.akka.io/japi/akka/2.5/?akka/actor/typed/ActorRef.html">ActorRef</a></span>
-        |</p>""".stripMargin
-    )
+      html(
+        """<p><span class="group-scala">
+          |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/typed/ActorRef.html">ActorRef</a></span><span class="group-java">
+          |<a href="https://doc.akka.io/japi/akka/2.5/?akka/actor/typed/ActorRef.html">ActorRef</a></span>
+          |</p>""".stripMargin
+      )
   }
 
   it should "generate markdown correctly for a companion object" in {

src/test/scala/com.lightbend.paradox/apidoc/MarkdownBaseSpec.scala

@@ -30,37 +30,45 @@ abstract class MarkdownBaseSpec extends FlatSpec with Matchers {
   val markdownReader = new Reader
   val markdownWriter = new Writer
 
-  def markdown(text: String)(implicit context: Location[Page] => Writer.Context = writerContext): String = {
+  def markdown(text: String)(implicit context: Location[Page] => Writer.Context = writerContext): String =
     markdownPages("test.md" -> text).getOrElse("test.html", "")
-  }
 
-  def markdownPages(mappings: (String, String)*)(implicit context: Location[Page] => Writer.Context = writerContext): Map[String, String] = {
-    def render(location: Option[Location[Page]], rendered: Seq[(String, String)] = Seq.empty): Seq[(String, String)] = location match {
-      case Some(loc) =>
-        val page = loc.tree.label
-        val html = normalize(markdownWriter.write(page.markdown, context(loc)))
-        render(loc.next, rendered :+ (page.path, html))
-      case None => rendered
-    }
+  def markdownPages(mappings: (String, String)*)(
+      implicit context: Location[Page] => Writer.Context = writerContext): Map[String, String] = {
+    def render(location: Option[Location[Page]], rendered: Seq[(String, String)] = Seq.empty): Seq[(String, String)] =
+      location match {
+        case Some(loc) =>
+          val page = loc.tree.label
+          val html = normalize(markdownWriter.write(page.markdown, context(loc)))
+          render(loc.next, rendered :+ (page.path, html))
+        case None => rendered
+      }
     render(Location.forest(pages(mappings: _*))).toMap
   }
 
-  def layoutPages(mappings: (String, String)*)(templates: (String, String)*)(implicit context: Location[Page] => Writer.Context = writerContext): Map[String, String] = {
+  def layoutPages(mappings: (String, String)*)(templates: (String, String)*)(
+      implicit context: Location[Page] => Writer.Context = writerContext): Map[String, String] = {
     val templateDirectory = Files.createTempDirectory("templates")
     createFileTemplates(templateDirectory, templates)
-    def render(location: Option[Location[Page]], rendered: Seq[(String, String)] = Seq.empty): Seq[(String, String)] = location match {
-      case Some(loc) =>
-        val page = loc.tree.label
-        val html = normalize(markdownWriter.write(page.markdown, context(loc)))
-        val outputFile = new File(page.path)
-        val emptyPageContext = PartialPageContent(page.properties.get, html)
-        val template = new PageTemplate(new File(templateDirectory.toString))
-        template.write(page.properties(Page.Properties.DefaultLayoutMdIndicator, template.defaultName), emptyPageContext, outputFile, new PageTemplate.ErrorLogger(s => println("[error] " + s)))
-        val fileContent = fileToContent(outputFile)
-        outputFile.delete
-        render(loc.next, rendered :+ (page.path, normalize(fileContent)))
-      case None => rendered
-    }
+    def render(location: Option[Location[Page]], rendered: Seq[(String, String)] = Seq.empty): Seq[(String, String)] =
+      location match {
+        case Some(loc) =>
+          val page             = loc.tree.label
+          val html             = normalize(markdownWriter.write(page.markdown, context(loc)))
+          val outputFile       = new File(page.path)
+          val emptyPageContext = PartialPageContent(page.properties.get, html)
+          val template         = new PageTemplate(new File(templateDirectory.toString))
+          template.write(
+            page.properties(Page.Properties.DefaultLayoutMdIndicator, template.defaultName),
+            emptyPageContext,
+            outputFile,
+            new PageTemplate.ErrorLogger(s => println("[error] " + s))
+          )
+          val fileContent = fileToContent(outputFile)
+          outputFile.delete
+          render(loc.next, rendered :+ (page.path, normalize(fileContent)))
+        case None => rendered
+      }
     render(Location.forest(pages(mappings: _*))).toMap
   }
 
@@ -83,40 +91,41 @@ abstract class MarkdownBaseSpec extends FlatSpec with Matchers {
     writerContext(location).copy(properties = properties.toMap)
   }
 
-  def writerContext(location: Location[Page]): Writer.Context = {
+  def writerContext(location: Location[Page]): Writer.Context =
     Writer.Context(
       location,
       Page.allPaths(List(location.root.tree)).toSet,
+      reader = new Reader,
+      writer = new Writer,
       groups = Map("Language" -> Seq("Scala", "Java"))
     )
-  }
 
-  def pages(mappings: (String, String)*): Forest[Page] = {
+  def pages(mappings: (String, String)*): Forest[Page] =
+    pagesWithProperties(Map.empty[String, String], mappings: _*)
+
+  def pagesWithProperties(properties: Map[String, String], mappings: (String, String)*): Forest[Page] = {
     import com.lightbend.paradox.markdown.Path
     val parsed = mappings map {
       case (path, text) =>
         val frontin = Frontin(prepare(text))
         (new File(path), path, markdownReader.read(frontin.body), frontin.header)
     }
-    Page.forest(parsed, Path.replaceSuffix(Writer.DefaultSourceSuffix, Writer.DefaultTargetSuffix))
+    Page.forest(parsed, Path.replaceSuffix(Writer.DefaultSourceSuffix, Writer.DefaultTargetSuffix), properties)
   }
 
-  def html(text: String): String = {
+  def html(text: String): String =
     normalize(prepare(text))
-  }
 
-  def htmlPages(mappings: (String, String)*): Map[String, String] = {
+  def htmlPages(mappings: (String, String)*): Map[String, String] =
     (mappings map { case (path, text) => (path, html(text)) }).toMap
-  }
 
-  def prepare(text: String): String = {
+  def prepare(text: String): String =
     text.stripMargin.trim
-  }
 
   def normalize(html: String) = {
     val reader = new java.io.StringReader(html)
     val writer = new java.io.StringWriter
-    val tidy = new org.w3c.tidy.Tidy
+    val tidy   = new org.w3c.tidy.Tidy
     tidy.setTabsize(2)
     tidy.setPrintBodyOnly(true)
     tidy.setTrimEmptyElements(false)
@@ -129,26 +138,26 @@ abstract class MarkdownBaseSpec extends FlatSpec with Matchers {
   case class PartialPageContent(properties: Map[String, String], content: String) extends PageTemplate.Contents {
     import scala.collection.JavaConverters._
 
-    val getTitle = ""
+    val getTitle   = ""
     val getContent = content
 
-    lazy val getBase = ""
-    lazy val getHome = new EmptyLink()
-    lazy val getPrev = new EmptyLink()
-    lazy val getNext = new EmptyLink()
+    lazy val getBase        = ""
+    lazy val getHome        = new EmptyLink()
+    lazy val getPrev        = new EmptyLink()
+    lazy val getNext        = new EmptyLink()
     lazy val getBreadcrumbs = ""
-    lazy val getNavigation = ""
-    lazy val hasSubheaders = false
-    lazy val getToc = ""
-    lazy val getSource_url = ""
+    lazy val getNavigation  = ""
+    lazy val hasSubheaders  = false
+    lazy val getToc         = ""
+    lazy val getSource_url  = ""
 
     lazy val getProperties = properties.asJava
   }
 
   case class EmptyLink() extends PageTemplate.Link {
-    lazy val getHref: String = ""
-    lazy val getHtml: String = ""
-    lazy val getTitle: String = ""
+    lazy val getHref: String   = ""
+    lazy val getHtml: String   = ""
+    lazy val getTitle: String  = ""
     lazy val isActive: Boolean = false
   }