Better HTML title for documentation pages (#268)

So that we can have better SEO for these pages.

Author: marcospereira

app/controllers/documentation/DocumentationController.scala

@@ -1,7 +1,7 @@
 package controllers.documentation
 
 import actors.DocumentationActor
-import actors.DocumentationActor.{ NotFound => DocsNotFound, NotModified => DocsNotModified, _ }
+import actors.DocumentationActor.{NotFound => DocsNotFound, NotModified => DocsNotModified, _}
 import akka.actor.ActorRef
 import akka.pattern.ask
 import akka.util.Timeout
@@ -18,10 +18,11 @@ import play.api.http.HttpEntity
 import play.api.i18n.MessagesApi
 import play.api.i18n.Lang
 import play.api.mvc._
+import utils.HtmlHelpers
+
 import scala.concurrent.ExecutionContext
 import scala.concurrent.Future
 import scala.concurrent.duration._
-
 import scala.reflect.ClassTag
 
 @Singleton
@@ -181,9 +182,10 @@ class DocumentationController @Inject()(
     val linkFuture = canonicalLinkHeader(page)
     val resultFuture = actorRequest(actor, page, RenderPage(lang, version, etag(req), page)) {
       case RenderedPage(html, sidebarHtml, breadcrumbsHtml, source, context, cacheId) =>
+        val pageTitle = HtmlHelpers.friendlyTitle(page)
         val result = Ok(
           views.html.documentation
-            .v2(messages, context, page, Some(html), sidebarHtml, source, breadcrumbs = breadcrumbsHtml),
+            .v2(messages, context, pageTitle, Some(html), sidebarHtml, source, breadcrumbs = breadcrumbsHtml),
         )
         cacheable(withLangHeaders(result, page, context), cacheId)
     }.flatMap { result =>

app/utils/HtmlHelpers.scala

@@ -0,0 +1,9 @@
+package utils
+
+object HtmlHelpers {
+
+  // See https://stackoverflow.com/a/7594052/4600
+  private val splitRegex = "(?<!(^|[A-Z]))(?=[A-Z])|(?<!^)(?=[A-Z][a-z])"
+
+  def friendlyTitle(page: String): String = page.split(splitRegex).mkString(" ").capitalize
+}

test/utils/HtmlHelpersSpec.scala

@@ -0,0 +1,42 @@
+package utils
+
+import org.specs2.mutable.Specification
+
+class HtmlHelpersSpec extends Specification {
+
+  "HtmlHelpers" should {
+    "when rendering title" in {
+      "split the camel case title" in {
+        val input = "ScalaTemplates"
+        HtmlHelpers.friendlyTitle(input) must_== "Scala Templates"
+      }
+
+      "split the camel case title when there is an acronym" in {
+        "at the end of the page name" in {
+          val input = "JavaJPA"
+          HtmlHelpers.friendlyTitle(input) must_== "Java JPA"
+        }
+
+        "at the begging of the page name" in {
+          val input = "CSPFilter"
+          HtmlHelpers.friendlyTitle(input) must_== "CSP Filter"
+        }
+
+        "in the middle of the page name" in {
+          val input = "ScalaSIRDRouter"
+          HtmlHelpers.friendlyTitle(input) must_== "Scala SIRD Router"
+        }
+      }
+
+      "capitalize title's first word" in {
+        val input = "somePageTitle"
+        HtmlHelpers.friendlyTitle(input) must_== "Some Page Title"
+      }
+
+      "do not split when it is a single work" in {
+        val input = "Scala"
+        HtmlHelpers.friendlyTitle(input) must_== "Scala"
+      }
+    }
+  }
+}