Merge pull request #943 from Gedochao/refactor-main-class-override

Refactor the usage of default main class override to only apply to on-disk Scripts

Author: Gedochao

modules/build/src/main/scala/scala/build/Build.scala

@@ -9,14 +9,15 @@ import java.io.File
 import java.nio.file.{FileSystemException, Path}
 import java.util.concurrent.{ScheduledExecutorService, ScheduledFuture}
 
+import scala.annotation.tailrec
 import scala.build.EitherCps.{either, value}
-import scala.build.Ops._
+import scala.build.Ops.*
 import scala.build.compiler.{ScalaCompiler, ScalaCompilerMaker}
-import scala.build.errors._
+import scala.build.errors.*
 import scala.build.internal.{Constants, CustomCodeWrapper, MainClass, Util}
-import scala.build.options._
+import scala.build.options.*
 import scala.build.options.validation.ValidationException
-import scala.build.postprocessing._
+import scala.build.postprocessing.*
 import scala.collection.mutable.ListBuffer
 import scala.concurrent.duration.DurationInt
 import scala.util.Properties
@@ -57,7 +58,7 @@ object Build {
       MainClass.find(output)
     def retainedMainClass: Either[MainClassError, String] = {
       lazy val foundMainClasses0 = foundMainClasses()
-      val defaultMainClassOpt = sources.mainClass
+      val defaultMainClassOpt = sources.defaultMainClass
         .filter(name => foundMainClasses0.contains(name))
       def foundMainClass =
         if (foundMainClasses0.isEmpty) Left(new NoMainClassFoundError)
@@ -329,7 +330,7 @@ object Build {
     builds
   }
 
-  private def copyResourceToClassesDir(build: Build) = build match {
+  private def copyResourceToClassesDir(build: Build): Unit = build match {
     case b: Build.Successful =>
       for {
         resourceDirPath  <- b.sources.resourceDirs.filter(os.exists(_))
@@ -502,7 +503,7 @@ object Build {
     logger: Logger,
     options: BuildOptions
   ): Either[BuildException, Unit] = {
-    val (errors, otherDiagnostics) = options.validate.toSeq.partition(_.severity == Severity.Error)
+    val (errors, otherDiagnostics) = options.validate.partition(_.severity == Severity.Error)
     logger.log(otherDiagnostics)
     if (errors.nonEmpty)
       Left(CompositeBuildException(errors.map(new ValidationException(_))))
@@ -541,7 +542,7 @@ object Build {
       logger
     ))
 
-    def run() = {
+    def run(): Unit = {
       try {
         val res = build(
           inputs,
@@ -940,6 +941,7 @@ object Build {
       def onError(t: Throwable): Unit = {
         // TODO Log that properly
         System.err.println("got error:")
+        @tailrec
         def printEx(t: Throwable): Unit =
           if (t != null) {
             System.err.println(t)
@@ -973,7 +975,7 @@ object Build {
     }
 
     private val lock                  = new Object
-    private var f: ScheduledFuture[_] = null
+    private var f: ScheduledFuture[?] = _
     private val waitFor               = 50.millis
     private val runnable: Runnable = { () =>
       lock.synchronized {
@@ -1080,7 +1082,7 @@ object Build {
         command.iterator.map(_ + System.lineSeparator()).mkString
     )
 
-    new ProcessBuilder(command: _*)
+    new ProcessBuilder(command*)
       .inheritIO()
       .start()
       .waitFor()

modules/build/src/main/scala/scala/build/CrossSources.scala

@@ -1,15 +1,15 @@
 package scala.build
 
 import scala.build.EitherCps.{either, value}
-import scala.build.Ops._
+import scala.build.Ops.*
 import scala.build.errors.{BuildException, CompositeBuildException}
 import scala.build.options.{BuildOptions, BuildRequirements, HasBuildRequirements, Scope}
-import scala.build.preprocessing._
+import scala.build.preprocessing.*
 
 final case class CrossSources(
   paths: Seq[HasBuildRequirements[(os.Path, os.RelPath)]],
   inMemory: Seq[HasBuildRequirements[Sources.InMemory]],
-  mainClass: Option[String],
+  defaultMainClass: Option[String],
   resourceDirs: Seq[HasBuildRequirements[os.Path]],
   buildOptions: Seq[HasBuildRequirements[BuildOptions]]
 ) {
@@ -49,7 +49,7 @@ final case class CrossSources(
         .flatMap(_.withScalaVersion(retainedScalaVersion).toSeq)
         .flatMap(_.withPlatform(platform.value).toSeq)
         .map(_.scopedValue(defaultScope)),
-      mainClass,
+      defaultMainClass,
       resourceDirs
         .flatMap(_.withScalaVersion(retainedScalaVersion).toSeq)
         .flatMap(_.withPlatform(platform.value).toSeq)
@@ -132,11 +132,8 @@ object CrossSources {
       )
     }
 
-    val mainClassOpt = for {
-      mainClassPath <- inputs.mainClassElement.map {
-        case sf: Inputs.SourceFile        => ScopePath.fromPath(sf.path).path
-        case vsf: Inputs.VirtualScalaFile => vsf.scopePath.path
-      }
+    val defaultMainClassOpt = for {
+      mainClassPath      <- inputs.defaultMainClassElement.map(s => ScopePath.fromPath(s.path).path)
       processedMainClass <- preprocessedSources.find(_.scopePath.path == mainClassPath)
       mainClass          <- processedMainClass.mainClassOpt
     } yield mainClass
@@ -165,6 +162,6 @@ object CrossSources {
       HasBuildRequirements(BuildRequirements(), _)
     )
 
-    CrossSources(paths, inMemory, mainClassOpt, resourceDirs, buildOptions)
+    CrossSources(paths, inMemory, defaultMainClassOpt, resourceDirs, buildOptions)
   }
 }

modules/build/src/main/scala/scala/build/Inputs.scala

@@ -16,7 +16,7 @@ import scala.util.matching.Regex
 
 final case class Inputs(
   elements: Seq[Inputs.Element],
-  mainClassElement: Option[Inputs.SingleElement],
+  defaultMainClassElement: Option[Inputs.Script],
   workspace: os.Path,
   baseProjectName: String,
   mayAppendHash: Boolean,
@@ -57,7 +57,7 @@ final case class Inputs(
 
   private lazy val inputsHash: String =
     Inputs.inputsHash(elements)
-  lazy val projectName = {
+  lazy val projectName: String = {
     val needsSuffix = mayAppendHash && (elements match {
       case Seq(d: Inputs.Directory) => d.path != workspace
       case _                        => true
@@ -87,19 +87,18 @@ final case class Inputs(
     if (forbidden.exists(workspace.startsWith)) inHomeDir(directories)
     else this
   def checkAttributes(directories: Directories): Inputs = {
+    @tailrec
     def existingParent(p: os.Path): Option[os.Path] =
       if (os.exists(p)) Some(p)
       else if (p.segmentCount <= 0) None
       else existingParent(p / os.up)
     def reallyOwnedByUser(p: os.Path): Boolean =
       if (Properties.isWin)
-        p.toIO.canWrite() // Wondering if there's a better way to do that…
+        p.toIO.canWrite // Wondering if there's a better way to do that…
       else
         os.owner(p) == os.owner(os.home) &&
-        p.toIO.canWrite()
-    val canWrite = existingParent(workspace)
-      .map(reallyOwnedByUser)
-      .getOrElse(false)
+        p.toIO.canWrite
+    val canWrite = existingParent(workspace).exists(reallyOwnedByUser)
     if (canWrite) this
     else inHomeDir(directories)
   }
@@ -123,7 +122,7 @@ final case class Inputs(
         Iterator(v.content, bytes("\n"))
     }
     val md = MessageDigest.getInstance("SHA-1")
-    it.foreach(md.update(_))
+    it.foreach(md.update)
     val digest        = md.digest()
     val calculatedSum = new BigInteger(1, digest)
     String.format(s"%040x", calculatedSum)
@@ -188,15 +187,15 @@ object Inputs {
 
   final case class Script(base: os.Path, subPath: os.SubPath)
       extends OnDisk with SourceFile with AnyScalaFile with AnyScript {
-    lazy val path = base / subPath
+    lazy val path: os.Path = base / subPath
   }
   final case class ScalaFile(base: os.Path, subPath: os.SubPath)
       extends OnDisk with SourceFile with AnyScalaFile {
-    lazy val path = base / subPath
+    lazy val path: os.Path = base / subPath
   }
   final case class JavaFile(base: os.Path, subPath: os.SubPath)
       extends OnDisk with SourceFile with Compiled {
-    lazy val path = base / subPath
+    lazy val path: os.Path = base / subPath
   }
   final case class Directory(path: os.Path)         extends OnDisk with Compiled
   final case class ResourceDirectory(path: os.Path) extends OnDisk
@@ -226,13 +225,13 @@ object Inputs {
         Iterator(bytes("virtual:"), v.content, bytes("\n"))
     }
     val md = MessageDigest.getInstance("SHA-1")
-    it.foreach(md.update(_))
+    it.foreach(md.update)
     val digest        = md.digest()
     val calculatedSum = new BigInteger(1, digest)
     String.format(s"%040x", calculatedSum).take(10)
   }
 
-  def homeWorkspace(elements: Seq[Element], directories: Directories) = {
+  def homeWorkspace(elements: Seq[Element], directories: Directories): os.Path = {
     val hash0 = inputsHash(elements)
     val dir   = directories.virtualProjectsDir / hash0.take(2) / s"project-${hash0.drop(2)}"
     os.makeDir.all(dir)
@@ -279,14 +278,11 @@ object Inputs {
       case _: ResourceDirectory => true
       case _: Virtual           => true
     }
-    val mainClassElemOpt = validElems
-      .collectFirst {
-        case f: SourceFile         => f
-        case vsf: VirtualScalaFile => vsf
-      }
+    // only on-disk scripts need a main class override
+    val defaultMainClassElemOpt = validElems.collectFirst { case script: Script => script }
     Inputs(
       updatedElems,
-      mainClassElemOpt,
+      defaultMainClassElemOpt,
       workspace,
       baseProjectName,
       mayAppendHash = needsHash,
@@ -295,23 +291,22 @@ object Inputs {
   }
 
   private val githubGistsArchiveRegex: Regex =
-    s""":\\/\\/gist\\.github\\.com\\/[^\\/]*?\\/[^\\/]*$$""".r
-
-  private def resolve(path: String, content: Array[Byte]): Element = {
-    val wrapperPath =
-      os.sub / path.split("/").last
+    s"""://gist\\.github\\.com/[^/]*?/[^/]*$$""".r
 
+  private def resolve(path: String, content: Array[Byte]): Element =
     if (path.endsWith(".scala")) VirtualScalaFile(content, path)
     else if (path.endsWith(".java")) VirtualJavaFile(content, path)
-    else if (path.endsWith(".sc")) VirtualScript(content, path, wrapperPath)
+    else if (path.endsWith(".sc")) {
+      val wrapperPath = os.sub / path.split("/").last
+      VirtualScript(content, path, wrapperPath)
+    }
     else VirtualData(content, path)
-  }
 
   private def resolveZipArchive(content: Array[Byte]): Seq[Element] = {
     val zipInputStream = new ZipInputStream(new ByteArrayInputStream(content))
     @tailrec
     def readArchive(acc: Seq[Element]): Seq[Element] =
-      Option(zipInputStream.getNextEntry()) match {
+      Option(zipInputStream.getNextEntry) match {
         case Some(entry) if entry.isDirectory => readArchive(acc)
         case Some(entry) =>
           val content = zipInputStream.readAllBytes()
@@ -429,7 +424,7 @@ object Inputs {
   def empty(workspace: os.Path): Inputs =
     Inputs(
       elements = Nil,
-      mainClassElement = None,
+      defaultMainClassElement = None,
       workspace = workspace,
       baseProjectName = "project",
       mayAppendHash = true,

modules/build/src/main/scala/scala/build/ScopedSources.scala

@@ -5,15 +5,15 @@ import scala.build.options.{BuildOptions, HasScope, Scope}
 final case class ScopedSources(
   paths: Seq[HasScope[(os.Path, os.RelPath)]],
   inMemory: Seq[HasScope[Sources.InMemory]],
-  mainClass: Option[String],
+  defaultMainClass: Option[String],
   resourceDirs: Seq[HasScope[os.Path]],
   buildOptions: Seq[HasScope[BuildOptions]]
 ) {
   def sources(scope: Scope, baseOptions: BuildOptions): Sources =
     Sources(
       paths.flatMap(_.valueFor(scope).toSeq),
       inMemory.flatMap(_.valueFor(scope).toSeq),
-      mainClass,
+      defaultMainClass,
       resourceDirs.flatMap(_.valueFor(scope).toSeq),
       buildOptions
         .flatMap(_.valueFor(scope).toSeq)

modules/build/src/main/scala/scala/build/Sources.scala

@@ -2,12 +2,12 @@ package scala.build
 
 import scala.build.internal.CodeWrapper
 import scala.build.options.{BuildOptions, Scope}
-import scala.build.preprocessing._
+import scala.build.preprocessing.*
 
 final case class Sources(
   paths: Seq[(os.Path, os.RelPath)],
   inMemory: Seq[Sources.InMemory],
-  mainClass: Option[String],
+  defaultMainClass: Option[String],
   resourceDirs: Seq[os.Path],
   buildOptions: BuildOptions
 ) {

modules/build/src/main/scala/scala/build/internal/NativeBuilderHelper.scala

@@ -49,7 +49,7 @@ object NativeBuilderHelper {
     dest: os.Path,
     nativeWorkDir: os.Path,
     currentProjectSha: String
-  ) = {
+  ): Unit = {
     val projectShaPath = resolveProjectShaPath(nativeWorkDir)
     os.write.over(projectShaPath, currentProjectSha, createFolders = true)