Fixes SI-5373

And adds basic support for scaladoc model tests (class
partest.ScaladocModelTest)

1 files changed, 155 insertions, 0 deletions

diff --git a/test/scaladoc/scalacheck/CommentFactoryTest.scala b/test/scaladoc/scalacheck/CommentFactoryTest.scala
new file mode 100644
index 0000000000..69c314a64c
--- /dev/null
+++ b/test/scaladoc/scalacheck/CommentFactoryTest.scala
@@ -0,0 +1,155 @@
+import org.scalacheck._
+import org.scalacheck.Prop._
+
+import scala.tools.nsc.Global
+import scala.tools.nsc.doc
+import scala.tools.nsc.doc.model.comment._
+
+class Factory(val g: Global, val s: doc.Settings)
+  extends doc.model.ModelFactory(g, s) {
+  thisFactory: Factory with CommentFactory with doc.model.TreeFactory =>
+
+  def strip(c: Comment): Option[Inline] = {
+    c.body match {
+      case Body(List(Paragraph(Chain(List(Summary(inner)))))) => Some(inner)
+      case _ => None
+    }
+  }
+
+  def parseComment(s: String): Option[Inline] =
+    strip(parse(s, "", scala.tools.nsc.util.NoPosition))
+
+  def createBody(s: String) =
+    parse(s, "", scala.tools.nsc.util.NoPosition).body
+}
+
+object Test extends Properties("CommentFactory") {
+  val factory = {
+    val settings = new doc.Settings((str: String) => {})
+    val reporter = new scala.tools.nsc.reporters.ConsoleReporter(settings)
+    val g = new Global(settings, reporter)
+    (new Factory(g, settings) with CommentFactory with doc.model.TreeFactory)
+  }
+
+  def parse(src: String, dst: Inline) = {
+    factory.parseComment(src) match {
+        case Some(inline) =>
+          inline == dst
+        case _ =>
+          false
+    }
+  }
+
+  property("parse") = parse(
+      "/** One two three */",
+      Text("One two three")
+  )
+  property("parse") = parse(
+    "/** One `two` three */",
+    Chain(List(Text("One "), Monospace(Text("two")), Text(" three")))
+  )
+
+  property("parse") = parse(
+      """
+/** One two
+  * three */""",
+      Text("One two\nthree")
+  )
+  property("parse") = parse(
+      """
+/** One `two`
+  * three */""",
+      Chain(List(Text("One "), Monospace(Text("two")), Text("\n"), Text("three")))
+  )
+
+  property("parse") = parse(
+      """
+/** One `two`
+ *  three */""",
+      Chain(List(Text("One "), Monospace(Text("two")), Text("\n"), Text(" three")))
+  )
+
+  property("parse") = parse(
+      """
+/** One
+  * `two` three */""",
+      Chain(List(Text("One"), Text("\n"), Monospace(Text("two")), Text(" three")))
+  )
+
+  property("Trac #4361 - ^...^") = parse(
+      """
+/**
+ * hello ^world^ */""",
+      Chain(List(Text("hello "), Superscript(Text("world"))))
+  )
+
+  property("Trac #4361 - single ^ symbol") = parse(
+      """
+/**
+ * <pre>
+ * hello ^world
+ * </pre>
+ *
+ */""",
+      Chain(List(Text(""), Text("\n"),
+
+
+                 HtmlTag("<pre>\nhello ^world\n</pre>")))
+  )
+
+  property("Trac #4366 - body") = {
+    val body = factory.createBody(
+      """
+ /**
+  * <strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>
+  */
+      """
+    )
+
+    body == Body(List(Paragraph(Chain(List(
+      Summary(Chain(List(HtmlTag("<strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>"), Text("\n"), Text(""))))
+    )))))
+  }
+
+  property("Trac #4366 - summary") = {
+    val body = factory.createBody(
+      """
+ /**
+  * <strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>
+  */
+      """
+    )
+    body.summary == Some(Chain(List(HtmlTag("<strong><code>foo</code> has been deprecated and will be removed in a future version. Please call <code>bar</code> instead.</strong>"), Text("\n"), Text(""))))
+  }
+
+  property("Trac #4358 - body") = {
+    factory.createBody(
+      """
+ /**
+   * Implicit conversion that invokes the <code>expect</code> method on the <code>EasyMock</code> companion object (<em>i.e.</em>, the
+   * static <code>expect</code> method in Java class <code>org.easymock.EasyMock</code>).
+  */
+      """
+    ) match {
+      case Body(List(Paragraph(Chain(List(Summary(Chain(List(Chain(List(
+        Text("Implicit conversion that invokes the "),
+        HtmlTag("<code>expect</code>"),
+        Text(" method on the "),
+        HtmlTag("<code>EasyMock</code>"),
+        Text(" companion object ("),
+        HtmlTag("<em>i.e.</em>"),
+        Text(", the\nstatic "),
+        HtmlTag("<code>expect</code>"),
+        Text(" method in Java class "),
+        HtmlTag("<code>org.easymock.EasyMock</code>"),
+        Text(")")
+      )), Text(".")))), Text("\n")))))) =>
+        true
+      case other => {
+        println(other)
+        false
+      }
+    }
+  }
+
+}