Skip to content

Scalatags test #10120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 2, 2020
Merged

Scalatags test #10120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b91c1a5
Add escaping html restricted tokens and unit tests
BarkingBad Oct 29, 2020
23a5127
Fix Nil handling for HtmlTags and add some tests to cover that
BarkingBad Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions scala3doc/src/dotty/renderers/html.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ object HTML:
def apply(attrs: AttrArg*)(tags: TagArg*): AppliedTag = {
val sb = StringBuilder()
sb.append(s"<$name")
attrs.foreach{
attrs.filter(_ != Nil).foreach{
case s: Seq[AppliedAttr] =>
s.foreach(sb.append(" ").append)
case e: AppliedAttr =>
Expand All @@ -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"""")

Expand All @@ -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")
Expand Down
197 changes: 197 additions & 0 deletions scala3doc/test/dotty/dokka/renderers/HtmlTagsTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
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)
}

@Test
def appliedTagAndSeqAppliedTag = {
val actual = div(h1("AppliedTag"), Seq(h1("SeqAppliedTag"))).toString
val expect = """<div><h1>AppliedTag</h1><h1>SeqAppliedTag</h1></div>"""
assertEquals(expect, actual)
}

@Test
def stringAndSeqString = {
val actual = div("String", Seq("SeqString")).toString
val expect = """<div>StringSeqString</div>"""
assertEquals(expect, actual)
}

@Test
def mixingAllTagArgs = {
val actual = div("String", Seq("SeqString"), h1("AppliedTag"), Seq(h1("SeqAppliedTag")), Seq("SeqString"), h1("AppliedTag")).toString
val expect = """<div>StringSeqString<h1>AppliedTag</h1><h1>SeqAppliedTag</h1>SeqString<h1>AppliedTag</h1></div>"""
assertEquals(expect, actual)
}

@Test
def appliedAttrAndSeqAppliedAttr = {
val actual = div(cls := "someClass", Seq(style := "some: style;")).toString
val expect = """<div class="someClass" style="some: style;"></div>"""
assertEquals(expect, actual)
}

@Test
def seqAppliedAttrAndAppliedAttr = {
val actual = div(Seq(cls := "someClass"), style := "some: style;").toString
val expect = """<div class="someClass" style="some: style;"></div>"""
assertEquals(expect, actual)
}

@Test
def seqAppliedAttrAndSeqAppliedAttr = {
val actual = div(Seq(cls := "someClass"), Seq(style := "some: style;")).toString
val expect = """<div class="someClass" style="some: style;"></div>"""
assertEquals(expect, actual)
}

@Test
def mixingAllTagArgsAndAllAttrArgs = {
val actual = div(Seq(cls := "someClass"), id := "myId", Seq(style := "some: style;"))("String", Seq("SeqString"), h1("AppliedTag"), Seq(h1("SeqAppliedTag")), Seq("SeqString"), h1("AppliedTag")).toString
val expect = """<div class="someClass" id="myId" style="some: style;">StringSeqString<h1>AppliedTag</h1><h1>SeqAppliedTag</h1>SeqString<h1>AppliedTag</h1></div>"""
assertEquals(expect, actual)
}

@Test
def nilTagArg = {
val nil: TagArg = Nil
val actual = div(nil).toString
val expect = """<div></div>"""
assertEquals(expect, actual)
}

@Test
def nilAttrArg = {
val nil: AttrArg = Nil
val actual = div(nil).toString
val expect = """<div></div>"""
assertEquals(expect, actual)
}

@Test
def nilAmongTags = {
val actual = div("name", Nil, div("ala")).toString
val expect = """<div>name<div>ala</div></div>"""
assertEquals(expect, actual)
}

@Test
def nilAmongArgs = {
val actual = div(cls := "someClass", Nil, style := "some: style;").toString
val expect = """<div class="someClass" style="some: style;"></div>"""
assertEquals(expect, actual)
}

@Test
def nilAmongArgsAndTags = {
val actual = div(cls := "someClass", Nil, style := "some: style;")("name", Nil, div("ala")).toString
val expect = """<div class="someClass" style="some: style;">name<div>ala</div></div>"""
assertEquals(expect, actual)
}
}