Add escaping html restricted tokens and unit tests

BarkingBad · BarkingBad · commit b91c1a5d0947 · 2020-10-30T12:17:21.000+01:00
diff --git a/scala3doc/src/dotty/renderers/html.scala b/scala3doc/src/dotty/renderers/html.scala
@@ -25,19 +25,26 @@ object HTML:
         case t: AppliedTag =>
           sb.append(t)
         case s: String =>
-          sb.append(s)  
+          sb.append(s.escapeReservedTokens)  
         case s: Seq[AppliedTag | String] =>
           s.foreach{
             case a: AppliedTag =>
               sb.append(a)
             case s: String =>
-            sb.append(s)
+            sb.append(s.escapeReservedTokens)
           }
       }
       sb.append(s"</$name>")
       sb
     }
 
+  extension (s: String) private def escapeReservedTokens: String =
+    s.replace("&", "&amp;")
+      .replace("<", "&lt;")
+      .replace(">", "&gt;")
+      .replace("\"", "&quot;")
+      .replace("'", "&apos;")
+
   case class Attr(name: String):
     def :=(value: String): AppliedAttr = AppliedAttr(s"""$name="$value"""")
 
@@ -48,6 +55,7 @@ object HTML:
   val div = Tag("div")
   val span = Tag("span")
   val a = Tag("a")
+  val p = Tag("p")
   val h1 = Tag("h1")
   val h2 = Tag("h2")
   val h3 = Tag("h3")
diff --git a/scala3doc/test/dotty/dokka/renderers/HtmlTagsTest.scala b/scala3doc/test/dotty/dokka/renderers/HtmlTagsTest.scala
@@ -0,0 +1,111 @@
+package dotty.dokka.renderers
+
+import org.junit.{Test, Rule}
+import org.junit.Assert.{assertSame, assertTrue, assertEquals}
+import dotty.dokka.HTML._
+
+class HtmlTagsTest {
+
+    @Test
+    def simpleDiv = {
+        val actual = div().toString
+        val expect = "<div></div>"
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def divWithStyles = {
+        val actual = div(style := "some: style;")().toString
+        val expect = """<div style="some: style;"></div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def divWithChildren = {
+        val actual = div(h1(), span()).toString
+        val expect = """<div><h1></h1><span></span></div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def divWithTextInside = {
+        val actual = div(h1(), span("Some text"), "Some more of the text").toString
+        val expect = """<div><h1></h1><span>Some text</span>Some more of the text</div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def escapeAmpersand = {
+        val actual = div("Some & text").toString
+        val expect = """<div>Some &amp; text</div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def escapeLessThan = {
+        val actual = div("Some < text").toString
+        val expect = """<div>Some &lt; text</div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def escapeGreaterThan = {
+        val actual = div("Some > text").toString
+        val expect = """<div>Some &gt; text</div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def escapeQuotationMark = {
+        val actual = div("Some \" text").toString
+        val expect = """<div>Some &quot; text</div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def escapeApostrophe = {
+        val actual = div("Some ' text").toString
+        val expect = """<div>Some &apos; text</div>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def nestedTagsWithAttributes = {
+        val actual = html(
+            head(
+                script(src:="..."),
+                script(raw("alert('Hello World')"))
+            ),
+            body(
+                div(
+                    h1(id:="title")("This is a title"),
+                    p("This is a big paragraph of text")
+                )
+            )
+        ).toString
+        val expect = """<html><head><script src="..."></script><script>alert('Hello World')</script></head><body><div><h1 id="title">This is a title</h1><p>This is a big paragraph of text</p></div></body></html>"""
+        assertEquals(expect, actual)
+    }
+
+    @Test
+    def anotherNestedTagsWithAttributes = {
+        val actual = html(
+            head(
+                script("some script")
+            ),
+            body(
+                h1(style:="background-color: blue; color: red;")("This is my title"),
+                div(style:="background-color: blue; color: red;")(
+                p(cls :="contentpara first")(
+                    "This is my first paragraph"
+                ),
+                a(style:="opacity: 0.9;")(
+                    p(cls := "contentpara")("Goooogle")
+                )
+                )
+            )
+        ).toString
+        val expect = """<html><head><script>some script</script></head><body><h1 style="background-color: blue; color: red;">This is my title</h1><div style="background-color: blue; color: red;"><p class="contentpara first">This is my first paragraph</p><a style="opacity: 0.9;"><p class="contentpara">Goooogle</p></a></div></body></html>"""
+        assertEquals(expect, actual)
+    }
+}
