Merge branch 'cheeseng-module-projects' into 3.1.x

Author: bvenners

build.sbt

@@ -47,3 +47,16 @@ lazy val genEmptyTests = ScalatestBuild.genEmptyTests
 lazy val gentests = ScalatestBuild.gentests
 lazy val examples = ScalatestBuild.examples
 lazy val examplesJS = ScalatestBuild.examplesJS
+lazy val scalatestCompatible = ScalatestBuild.scalatestCompatible
+lazy val scalatestCore = ScalatestBuild.scalatestCore
+lazy val scalatestFeatureSpec = ScalatestBuild.scalatestFeatureSpec
+lazy val scalatestFlatSpec = ScalatestBuild.scalatestFlatSpec
+lazy val scalatestFreeSpec = ScalatestBuild.scalatestFreeSpec
+lazy val scalatestFunSuite = ScalatestBuild.scalatestFunSuite
+lazy val scalatestPropSpec = ScalatestBuild.scalatestPropSpec
+lazy val scalatestRefSpec = ScalatestBuild.scalatestRefSpec
+lazy val scalatestWordSpec = ScalatestBuild.scalatestWordSpec
+lazy val scalatestDiagrams = ScalatestBuild.scalatestDiagrams
+lazy val scalatestMatchersCore = ScalatestBuild.scalatestMatchersCore
+lazy val scalatestShouldMatchers = ScalatestBuild.scalatestShouldMatchers
+lazy val scalatestMustMatchers = ScalatestBuild.scalatestMustMatchers

modules/scalatest-core/src/main/scala/org/scalatest/fixture/package.scala

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2001-2018 Artima, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.scalatest
+
+/**
+ * Classes and traits supporting ScalaTest's "fixture" style traits, which
+ * allow you to pass fixture objects into tests.
+ *
+ * This package is released as part of the `scalatest-core` module.
+ */
+package object fixture

modules/scalatest-core/src/main/scala/org/scalatest/package.scala

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2001-2013 Artima, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org
+
+/**
+ * ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.
+ */
+package object scalatest {
+
+   // SKIP-SCALATESTJS,NATIVE-START
+  private val defaultShell = ShellImpl()
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>colorPassed</code> configuration parameter set to <code>true</code>.
+   */
+  lazy val color: Shell = defaultShell.color
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>durationsPassed</code> configuration parameter set to <code>true</code>.
+   */
+  lazy val durations: Shell = defaultShell.durations
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>shortStacksPassed</code> configuration parameter set to <code>true</code>.
+   */
+  lazy val shortstacks: Shell = defaultShell.shortstacks
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>fullStacksPassed</code> configuration parameter set to <code>true</code>.
+   */
+  lazy val fullstacks: Shell = defaultShell.fullstacks
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>statsPassed</code> configuration parameter set to <code>true</code>.
+   */
+  lazy val stats: Shell = defaultShell.stats
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>colorPassed</code> configuration parameter set to <code>false</code>.
+   */
+  lazy val nocolor: Shell = defaultShell.nocolor
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>durationsPassed</code> configuration parameter set to <code>false</code>.
+   */
+  lazy val nodurations: Shell = defaultShell.nodurations
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>shortStacksPassed</code> configuration parameter set to <code>false</code>.
+   */
+  lazy val nostacks: Shell = defaultShell.nostacks
+
+  /**
+   * Returns a copy of this <code>Shell</code> with <code>statsPassed</code> configuration parameter set to <code>false</code>.
+   */
+  lazy val nostats: Shell = defaultShell.nostats
+  // SKIP-SCALATESTJS,NATIVE-END
+
+  /**
+   * The version number of ScalaTest.
+   *
+   * @return the ScalaTest version number.
+   */
+  val ScalaTestVersion: String = ScalaTestVersions.ScalaTestVersion
+
+  private[scalatest] type Expectation = Fact
+
+  /**
+   * Marker trait that serves as the result type of <code>assert</code>, <code>assume</code>, and <code>pending</code> methods of
+   * trait <code>Assertions</code>, which return its only instance, the <code>Succeeded</code> singleton, or throw
+   * an exception that indicates a failed, canceled, or pending test.
+   */
+  type Assertion = compatible.Assertion
+}

project/BuildCommons.scala

@@ -0,0 +1,134 @@
+import sbt._
+import Keys._
+import java.io.PrintWriter
+import scala.io.Source
+
+trait BuildCommons {
+
+  lazy val supportedScalaVersions = List("2.13.0", "2.12.8", "2.11.12", "2.10.7")
+
+  val releaseVersion = "3.1.0-SNAP13"
+
+  val previousReleaseVersion = "3.0.5"
+
+  def rootProject: Project
+
+  def scalaXmlDependency(theScalaVersion: String): Seq[ModuleID]
+
+  def scalatestLibraryDependencies: Seq[ModuleID]
+
+  def scalaLibraries(theScalaVersion: String): Seq[ModuleID]
+
+  def sharedSettings: Seq[Setting[_]]
+
+  def scalacticDocSettings: Seq[Setting[_]]
+
+  def scalatestDocSettings: Seq[Setting[_]]
+
+  def scalatestJSDocTaskSetting: Setting[_]
+
+  def crossBuildTestLibraryDependencies: sbt.Def.Initialize[Seq[sbt.ModuleID]]
+
+  def scalatestTestOptions: Seq[sbt.TestOption]
+
+  lazy val projectTitle = settingKey[String]("Name of project to display in doc titles")
+
+  val javaSourceManaged: SettingKey[java.io.File] = sbt.SettingKey[java.io.File]("javaSourceManaged")  
+
+  //
+  // Prepares source files for running scaladoc.
+  //
+  def genDocSources(srcFiles: Seq[File],
+                    srcDirs: Seq[File],
+                    docsrcDir: File): Seq[File] =
+  {
+    val scalaFiles =
+      for {
+        srcFile <- srcFiles
+        if srcFile.name.endsWith(".scala")
+      } yield {
+        val srcPath = srcFile.getPath
+        val maybeSourceFile = srcDirs.flatMap(srcFile.relativeTo).headOption
+        maybeSourceFile match {
+          case Some(docsrcFile) => copyDocFile(srcFile, new File(docsrcDir.asFile, docsrcFile.getPath))
+          case None             =>
+             throw new RuntimeException("unexpected source path ["+ srcPath +"] not relative to " + srcDirs.mkString("[", ", ", "]"))
+        }
+      }
+
+    val javaSources = srcFiles.filter(_.name.endsWith(".java")).toSet
+    val javaTagFiles = JavaTagDocumenter.docJavaTags(javaSources)
+
+    scalaFiles ++ javaTagFiles
+  }
+
+  //
+  // Copies a file, doing a little filtering along the way to make
+  // destination file suitable for use in generating scaladocs.
+  //
+  // Returns destination file.
+  //
+  private def copyDocFile(srcFile: File, destFile: File): File = {
+    if (!destFile.exists || (destFile.lastModified < srcFile.lastModified)) {
+      IO.createDirectory(file(destFile.getParent))
+
+      val writer = new PrintWriter(destFile)
+
+      try {
+        for (line <- Source.fromFile(srcFile).getLines)
+          writer.println(line.replaceFirst("@Finders(.*)", ""))
+      }
+      finally { writer.close }
+    }
+    destFile
+  }
+
+  //
+  // Adds customization to scaladocs.
+  //
+  // Appends additional css to template.css file and copies
+  // additional gifs into lib directory.
+  //
+  // Note: found that adding new gifs into lib directory causes
+  // doc task to rebuild scaladocs from scratch each time.
+  // Without that it only rebuilds if needed.
+  //
+  def docTask(docDir: File, resDir: File, projectName: String): File = {
+    val docLibDir = docDir / "lib"
+    val htmlSrcDir = resDir / "html"
+    val cssFile = docLibDir / "template.css"
+    val addlCssFile = htmlSrcDir / "addl.css"
+
+    val css = Source.fromFile(cssFile).mkString
+    val addlCss = Source.fromFile(addlCssFile).mkString
+
+    if (!css.contains("pre.stHighlighted")) {
+      val writer = new PrintWriter(cssFile)
+
+      try {
+        writer.println(css)
+        writer.println(addlCss)
+      }
+      finally { writer.close }
+    }
+
+    if (projectName.contains("scalatest")) {
+      (htmlSrcDir * "*.gif").get.foreach { gif =>
+        IO.copyFile(gif, docLibDir / gif.name)
+      }
+    }
+    docDir
+  }
+
+  lazy val docsrcDir =
+    settingKey[File](
+      "Directory to hold processed source files for generating scaladocs")
+
+  val docsrcDirSetting =
+     docsrcDir := target.value / "docsrc"
+
+  val docTaskSetting =
+    doc in Compile := docTask((doc in Compile).value,
+                              (sourceDirectory in Compile).value,
+                              name.value)
+}