From d2bf0b1443c094dba2e86d839bb8a1b8b9336eae Mon Sep 17 00:00:00 2001 From: Felix Mulder Date: Tue, 3 Jan 2017 11:42:13 +0100 Subject: Rename `DottyTest` in dottydoc to `DottyDocTest` --- doc-tool/test/BaseTest.scala | 64 ----------------------------------- doc-tool/test/ConstructorTest.scala | 2 +- doc-tool/test/DottyDocTest.scala | 64 +++++++++++++++++++++++++++++++++++ doc-tool/test/PackageStructure.scala | 2 +- doc-tool/test/SimpleComments.scala | 2 +- doc-tool/test/UsecaseTest.scala | 2 +- doc-tool/test/WhitelistedStdLib.scala | 4 +-- 7 files changed, 69 insertions(+), 71 deletions(-) delete mode 100644 doc-tool/test/BaseTest.scala create mode 100644 doc-tool/test/DottyDocTest.scala (limited to 'doc-tool') diff --git a/doc-tool/test/BaseTest.scala b/doc-tool/test/BaseTest.scala deleted file mode 100644 index 835911ca5..000000000 --- a/doc-tool/test/BaseTest.scala +++ /dev/null @@ -1,64 +0,0 @@ -package dotty.tools -package dottydoc - -import dotc.core.Contexts.{ Context, ContextBase, FreshContext } -import dotc.core.Comments.{ ContextDoc, ContextDocstrings } -import dotc.util.SourceFile -import dotc.core.Phases.Phase -import dotc.typer.FrontEnd -import dottydoc.core.{ DocASTPhase, ContextDottydoc } -import model.Package -import dotty.tools.dottydoc.util.syntax._ - -trait DottyTest { - dotty.tools.dotc.parsing.Scanners // initialize keywords - - implicit val ctx: FreshContext = { - val base = new ContextBase - import base.settings._ - val ctx = base.initialCtx.fresh - ctx.setSetting(ctx.settings.language, List("Scala2")) - ctx.setSetting(ctx.settings.YkeepComments, true) - ctx.setSetting(ctx.settings.YnoInline, true) - ctx.setProperty(ContextDoc, new ContextDottydoc) - ctx.setSetting( - ctx.settings.classpath, - "../library/target/scala-2.11/dotty-library_2.11-0.1.1-SNAPSHOT.jar" - ) - base.initialize()(ctx) - ctx - } - - 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(ctx.docbase.packages) - }) :: Nil - - override def phases = - super.phases ++ assertionPhase - } - - 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: 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: Map[String, Package] => Unit): Unit = { - val c = compilerWithChecker(assertion) - c.rootContext(ctx) - val run = c.newRun - run.compileSources(sourceFiles) - } -} diff --git a/doc-tool/test/ConstructorTest.scala b/doc-tool/test/ConstructorTest.scala index 44a05acad..99192985a 100644 --- a/doc-tool/test/ConstructorTest.scala +++ b/doc-tool/test/ConstructorTest.scala @@ -9,7 +9,7 @@ import model._ import model.internal._ import model.references._ -class Constructors extends DottyTest { +class Constructors extends DottyDocTest { @Test def singleClassConstructor = { val source = new SourceFile ( "Class.scala", diff --git a/doc-tool/test/DottyDocTest.scala b/doc-tool/test/DottyDocTest.scala new file mode 100644 index 000000000..67e468f9a --- /dev/null +++ b/doc-tool/test/DottyDocTest.scala @@ -0,0 +1,64 @@ +package dotty.tools +package dottydoc + +import dotc.core.Contexts.{ Context, ContextBase, FreshContext } +import dotc.core.Comments.{ ContextDoc, ContextDocstrings } +import dotc.util.SourceFile +import dotc.core.Phases.Phase +import dotc.typer.FrontEnd +import dottydoc.core.{ DocASTPhase, ContextDottydoc } +import model.Package +import dotty.tools.dottydoc.util.syntax._ + +trait DottyDocTest { + dotty.tools.dotc.parsing.Scanners // initialize keywords + + implicit val ctx: FreshContext = { + val base = new ContextBase + import base.settings._ + val ctx = base.initialCtx.fresh + ctx.setSetting(ctx.settings.language, List("Scala2")) + ctx.setSetting(ctx.settings.YkeepComments, true) + ctx.setSetting(ctx.settings.YnoInline, true) + ctx.setProperty(ContextDoc, new ContextDottydoc) + ctx.setSetting( + ctx.settings.classpath, + "../library/target/scala-2.11/dotty-library_2.11-0.1.1-SNAPSHOT.jar" + ) + base.initialize()(ctx) + ctx + } + + 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(ctx.docbase.packages) + }) :: Nil + + override def phases = + super.phases ++ assertionPhase + } + + 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: 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: Map[String, Package] => Unit): Unit = { + val c = compilerWithChecker(assertion) + c.rootContext(ctx) + val run = c.newRun + run.compileSources(sourceFiles) + } +} diff --git a/doc-tool/test/PackageStructure.scala b/doc-tool/test/PackageStructure.scala index 4e7006bfe..54ff1b9e7 100644 --- a/doc-tool/test/PackageStructure.scala +++ b/doc-tool/test/PackageStructure.scala @@ -7,7 +7,7 @@ import org.junit.Assert._ import dotc.util.SourceFile import model.internal._ -class PackageStructure extends DottyTest { +class PackageStructure extends DottyDocTest { @Test def multipleCompilationUnits = { val source1 = new SourceFile( "TraitA.scala", diff --git a/doc-tool/test/SimpleComments.scala b/doc-tool/test/SimpleComments.scala index 959eb1745..eb9abca22 100644 --- a/doc-tool/test/SimpleComments.scala +++ b/doc-tool/test/SimpleComments.scala @@ -4,7 +4,7 @@ package dottydoc import org.junit.Test import org.junit.Assert._ -class TestSimpleComments extends DottyTest { +class TestSimpleComments extends DottyDocTest { @Test def simpleComment = { val source = diff --git a/doc-tool/test/UsecaseTest.scala b/doc-tool/test/UsecaseTest.scala index 113d54aad..2a5ae4602 100644 --- a/doc-tool/test/UsecaseTest.scala +++ b/doc-tool/test/UsecaseTest.scala @@ -10,7 +10,7 @@ import model.internal._ import model.references._ import util.syntax._ -class UsecaseTest extends DottyTest { +class UsecaseTest extends DottyDocTest { @Test def simpleUsecase = { val source = new SourceFile( "DefWithUseCase.scala", diff --git a/doc-tool/test/WhitelistedStdLib.scala b/doc-tool/test/WhitelistedStdLib.scala index 634070e8e..3139498de 100644 --- a/doc-tool/test/WhitelistedStdLib.scala +++ b/doc-tool/test/WhitelistedStdLib.scala @@ -4,9 +4,7 @@ package dottydoc import org.junit.Test import org.junit.Assert._ -class WhitelistedStdLib extends DottyTest { - val files: List[String] = - StdLibSources.whitelisted.filterNot(_.endsWith("package.scala")) +class TestWhitelistedCollections extends DottyDocTest { @Test def arrayHasDocumentation = checkFiles(TestWhitelistedCollections.files) { packages => -- cgit v1.2.3