Add phase to deal with constructors

5 files changed, 242 insertions, 31 deletions

diff --git a/dottydoc/test/BaseTest.scala b/dottydoc/test/BaseTest.scala
index 7f077d27b..2233d03c8 100644
--- a/dottydoc/test/BaseTest.scala
+++ b/dottydoc/test/BaseTest.scala
@@ -7,6 +7,7 @@ import dotc.util.SourceFile
 import dotc.core.Phases.Phase
 import dotc.typer.FrontEnd
 import dottydoc.core.DocASTPhase
+import model.Package
 
 trait DottyTest {
   dotty.tools.dotc.parsing.Scanners // initialize keywords
@@ -21,34 +22,33 @@ trait DottyTest {
     ctx
   }
 
-  private def compilerWithChecker(assertion: DocASTPhase => Unit) = new DocCompiler {
-    private[this] val docPhase = new DocASTPhase
-
-    override def phases =
-      List(new FrontEnd) ::
-      List(docPhase) ::
+  private def compilerWithChecker(assertion: Map[String, Package] => Unit) = new DocCompiler {
+    private[this] val assertionPhase: List[List[Phase]] =
       List(new Phase {
         def phaseName = "assertionPhase"
-        override def run(implicit ctx: Context): Unit = assertion(docPhase)
-      }) ::
-      Nil
+        override def run(implicit ctx: Context): Unit =
+          assertion(ctx.docbase.packages[Package].toMap)
+      }) :: Nil
+
+    override def phases =
+      super.phases ++ assertionPhase
   }
 
-  def checkSource(source: String)(assertion: DocASTPhase => Unit): Unit = {
+  def checkSource(source: String)(assertion: Map[String, Package] => Unit): Unit = {
     val c = compilerWithChecker(assertion)
     c.rootContext(ctx)
     val run = c.newRun
     run.compile(source)
   }
 
-  def checkFiles(sources: List[String])(assertion: DocASTPhase => Unit): Unit = {
+  def checkFiles(sources: List[String])(assertion: Map[String, Package] => Unit): Unit = {
     val c = compilerWithChecker(assertion)
     c.rootContext(ctx)
     val run = c.newRun
     run.compile(sources)
   }
 
-  def checkSources(sourceFiles: List[SourceFile])(assertion: DocASTPhase => Unit): Unit = {
+  def checkSources(sourceFiles: List[SourceFile])(assertion: Map[String, Package] => Unit): Unit = {
     val c = compilerWithChecker(assertion)
     c.rootContext(ctx)
     val run = c.newRun
diff --git a/dottydoc/test/ConstructorTest.scala b/dottydoc/test/ConstructorTest.scala
new file mode 100644
index 000000000..8aa883022
--- /dev/null
+++ b/dottydoc/test/ConstructorTest.scala
@@ -0,0 +1,211 @@
+package dotty.tools
+package dottydoc
+
+import org.junit.Test
+import org.junit.Assert._
+
+import dotc.util.SourceFile
+import model._
+import model.internal._
+import model.references._
+
+class Constructors extends DottyTest {
+  @Test def singleClassConstructor = {
+    val source = new SourceFile (
+      "Class.scala",
+      """
+      |package scala
+      |
+      |class Class(val str: String)
+      """.stripMargin
+    )
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(cls: Class), _, _) =>
+          cls.constructors.headOption match {
+            case Some(ParamListImpl(NamedReference("str", _,  false, false) :: Nil, false) :: Nil) =>
+              // success!
+            case _ => assert(false, s"Incorrect constructor found: ${cls.constructors}")
+          }
+      }
+    }
+  }
+
+  @Test def constructorPlusImplicitArgList = {
+    val source = new SourceFile (
+      "Class.scala",
+      """
+      |package scala
+      |
+      |class Class(val str1: String)(implicit str2: String)
+      """.stripMargin
+    )
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(cls: Class), _, _) =>
+          cls.constructors match {
+            case (
+              ParamListImpl(NamedReference("str1", _,  false, false) :: Nil, false) ::
+              ParamListImpl(NamedReference("str2", _, false, false) :: Nil, true) :: Nil
+            ) :: Nil =>
+              // success!
+            case _ => assert(false, s"Incorrect constructor found: ${cls.constructors}")
+          }
+      }
+    }
+  }
+
+  @Test def multipleArgumentListsForConstructor = {
+    val source = new SourceFile (
+      "Class.scala",
+      """
+      |package scala
+      |
+      |class Class(val str1: String)(val str2: String)(implicit str3: String)
+      """.stripMargin
+    )
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(cls: Class), _, _) =>
+          cls.constructors match {
+            case (
+              ParamListImpl(NamedReference("str1", _,  false, false) :: Nil, false) ::
+              ParamListImpl(NamedReference("str2", _, false, false) :: Nil, false) ::
+              ParamListImpl(NamedReference("str3", _, false, false) :: Nil, true) :: Nil
+            ) :: Nil =>
+              // success!
+            case _ => assert(false, s"Incorrect constructor found: ${cls.constructors}")
+          }
+      }
+    }
+  }
+
+  @Test def multipleConstructors = {
+    val source = new SourceFile (
+      "Class.scala",
+      """
+      |package scala
+      |
+      |class Class(val main: String) {
+      |  def this(alt1: Int) =
+      |    this("String")
+      |
+      |  def this(alt2: List[String]) =
+      |    this(alt2.head)
+      |}
+      """.stripMargin
+    )
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(cls: Class), _, _) =>
+          cls.constructors match {
+            case (
+              ParamListImpl(NamedReference("main", _,  false, false) :: Nil, false) :: Nil
+            ) :: (
+              ParamListImpl(NamedReference("alt1", _, false, false) :: Nil, false) :: Nil
+            ) :: (
+              ParamListImpl(NamedReference("alt2", _, false, false) :: Nil, false) :: Nil
+            ) :: Nil =>
+              // success!
+            case _ =>
+              assert(
+                false,
+                s"""Incorrect constructor found:\n${cls.constructors.mkString("\n")}"""
+              )
+          }
+      }
+    }
+  }
+
+  @Test def multipleConstructorsCC = {
+    val source = new SourceFile (
+      "Class.scala",
+      """
+      |package scala
+      |
+      |case class Class(val main: String) {
+      |  def this(alt1: Int) =
+      |    this("String")
+      |
+      |  def this(alt2: List[String]) =
+      |    this(alt2.head)
+      |}
+      """.stripMargin
+    )
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(cls: CaseClass, obj: Object), _, _) =>
+          cls.constructors match {
+            case (
+              ParamListImpl(NamedReference("main", _,  false, false) :: Nil, false) :: Nil
+            ) :: (
+              ParamListImpl(NamedReference("alt1", _, false, false) :: Nil, false) :: Nil
+            ) :: (
+              ParamListImpl(NamedReference("alt2", _, false, false) :: Nil, false) :: Nil
+            ) :: Nil =>
+              // success!
+            case _ =>
+              println(obj.members.map(x => x.kind + " " + x.name))
+              assert(
+                false,
+                s"""Incorrect constructor found:\n${cls.constructors.mkString("\n")}"""
+              )
+          }
+      }
+    }
+  }
+
+  @Test def traitParameters = {
+    val source = new SourceFile (
+      "Trait.scala",
+      """
+      |package scala
+      |
+      |trait Trait(val main: String)
+      """.stripMargin
+    )
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(trt: Trait), _, _) =>
+          trt.traitParams match {
+            case ParamListImpl(NamedReference("main", _,  false, false) :: Nil, false) :: Nil =>
+            case _ =>
+              assert(
+                false,
+                s"""Incorrect constructor found:\n${trt.traitParams.mkString("\n")}"""
+              )
+          }
+      }
+    }
+  }
+
+  @Test def testJson = {
+    val actualSource =
+      """
+      |package scala
+      |
+      |trait Trait(val main: String)
+      |class Class(val main: String)
+      |case class CaseClass(main: String)
+      """.stripMargin
+
+    val source = new SourceFile ("JsonTest.scala", actualSource)
+
+    checkSources(source :: Nil) { packages =>
+      packages("scala") match {
+        case PackageImpl(_, List(cc: CaseClass, _, cls: Class, trt: Trait), _, _) =>
+          import model.json._
+          lazy val incorrectJson = s"The json generated for:\n$actualSource\n\nIs not correct"
+          assert(cc.json.contains(s""""constructors":[[{"list":[{"title":"main""""), incorrectJson)
+          assert(cls.json.contains(s""""constructors":[[{"list":[{"title":"main""""), incorrectJson)
+          assert(trt.json.contains(s""""traitParams":[{"list":[{"title":"main""""), incorrectJson)
+      }
+    }
+  }
+}
diff --git a/dottydoc/test/PackageStructure.scala b/dottydoc/test/PackageStructure.scala
index af6e52184..00caaa2c0 100644
--- a/dottydoc/test/PackageStructure.scala
+++ b/dottydoc/test/PackageStructure.scala
@@ -10,7 +10,7 @@ import model.internal._
 class PackageStructure extends DottyTest {
   @Test def multipleCompilationUnits = {
     val source1 = new SourceFile(
-      "<test>",
+      "TraitA.scala",
       """
       |package scala
       |
@@ -19,7 +19,7 @@ class PackageStructure extends DottyTest {
     )
 
     val source2 = new SourceFile(
-      "<test>",
+      "TraitB.scala",
       """
       |package scala
       |
@@ -27,8 +27,8 @@ class PackageStructure extends DottyTest {
       """.stripMargin
     )
 
-    checkSources(source1 :: source2 :: Nil) { doc =>
-      doc.packages("scala") match {
+    checkSources(source1 :: source2 :: Nil) { packages =>
+      packages("scala") match {
         case PackageImpl(_, List(tA, tB), _, _) =>
           assert(
             tA.name == "A" && tB.name == "B",
@@ -42,7 +42,7 @@ class PackageStructure extends DottyTest {
 
   @Test def multiplePackages = {
     val source1 = new SourceFile(
-      "<test>",
+      "TraitA.scala",
       """
       |package scala
       |package collection
@@ -51,7 +51,7 @@ class PackageStructure extends DottyTest {
       """.stripMargin)
 
     val source2 = new SourceFile(
-      "<test>",
+      "TraitB.scala",
       """
       |package scala
       |package collection
@@ -59,8 +59,8 @@ class PackageStructure extends DottyTest {
       |trait B
       """.stripMargin)
 
-    checkSources(source1 :: source2 :: Nil) { doc =>
-      doc.packages("scala") match {
+    checkSources(source1 :: source2 :: Nil) { packages =>
+      packages("scala") match {
         case PackageImpl(
           "scala",
           List(PackageImpl("scala.collection", List(tA, tB), _, _)),
@@ -72,10 +72,10 @@ class PackageStructure extends DottyTest {
           )
 
         case _ =>
-          fail(s"""Incorrect package structure for 'scala' package: ${doc.packages("scala")}""")
+          fail(s"""Incorrect package structure for 'scala' package: ${packages("scala")}""")
       }
 
-      doc.packages("scala.collection") match {
+      packages("scala.collection") match {
         case PackageImpl("scala.collection", List(tA, tB), _, _) =>
           assert(
             tA.name == "A" && tB.name == "B",
diff --git a/dottydoc/test/SimpleComments.scala b/dottydoc/test/SimpleComments.scala
index ad9b7b1a6..959eb1745 100644
--- a/dottydoc/test/SimpleComments.scala
+++ b/dottydoc/test/SimpleComments.scala
@@ -15,9 +15,9 @@ class TestSimpleComments extends DottyTest {
       |trait HelloWorld
       """.stripMargin
 
-    checkSource(source) { doc =>
-      val traitCmt = doc
-        .packages("scala")
+    checkSource(source) { packages =>
+      val traitCmt =
+        packages("scala")
         .children.find(_.path.mkString(".") == "scala.HelloWorld")
         .flatMap(_.comment.map(_.body))
         .get
diff --git a/dottydoc/test/WhitelistedStdLib.scala b/dottydoc/test/WhitelistedStdLib.scala
index 0225ba218..48697ea7f 100644
--- a/dottydoc/test/WhitelistedStdLib.scala
+++ b/dottydoc/test/WhitelistedStdLib.scala
@@ -19,9 +19,9 @@ class TestWhitelistedCollections extends DottyTest {
   }
 
   @Test def arrayHasDocumentation =
-    checkFiles(files) { doc =>
-      val array = doc
-        .packages("scala")
+    checkFiles(files) { packages =>
+      val array =
+        packages("scala")
         .children.find(_.path.mkString(".") == "scala.Array")
         .get
 
@@ -29,9 +29,9 @@ class TestWhitelistedCollections extends DottyTest {
     }
 
   @Test def traitImmutableHasDocumentation =
-    checkFiles(files) { doc =>
-      val imm = doc
-        .packages("scala")
+    checkFiles(files) { packages =>
+      val imm =
+        packages("scala")
         .children.find(_.path.mkString(".") == "scala.Immutable")
         .get