Small refacto

Author: alexarchambault

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

@@ -68,7 +68,8 @@ object Build {
         else
           Left(
             new SeveralMainClassesFoundError(
-              ::(foundMainClasses0.head, foundMainClasses0.tail.toList)
+              ::(foundMainClasses0.head, foundMainClasses0.tail.toList),
+              Nil
             )
           )
 

modules/build/src/main/scala/scala/build/errors/MainClassError.scala

@@ -1,3 +1,8 @@
 package scala.build.errors
 
-abstract class MainClassError(message: String) extends BuildException(message)
+import scala.build.Position
+
+abstract class MainClassError(
+  message: String,
+  positions: Seq[Position]
+) extends BuildException(message, positions = positions)

modules/build/src/main/scala/scala/build/errors/NoMainClassFoundError.scala

@@ -1,3 +1,3 @@
 package scala.build.errors
 
-final class NoMainClassFoundError extends MainClassError("No main class found")
+final class NoMainClassFoundError extends MainClassError("No main class found", Nil)

modules/build/src/main/scala/scala/build/errors/NoValueProvidedError.scala

@@ -0,0 +1,12 @@
+package scala.build.errors
+
+import scala.build.preprocessing.directives.StrictDirective
+
+final class NoValueProvidedError(
+  val directive: StrictDirective
+) extends BuildException(
+      s"Expected a value for directive ${directive.key}",
+      positions = Nil // I wish using_directives provided the key position…
+    ) {
+  assert(directive.numericalOrStringValuesCount == 0)
+}

modules/build/src/main/scala/scala/build/errors/SeveralMainClassesFoundError.scala

@@ -1,4 +1,11 @@
 package scala.build.errors
 
-final class SeveralMainClassesFoundError(mainClasses: ::[String])
-    extends MainClassError(s"Found several main classes: ${mainClasses.mkString(", ")}")
+import scala.build.Position
+
+final class SeveralMainClassesFoundError(
+  mainClasses: ::[String],
+  positions: Seq[Position]
+) extends MainClassError(
+      s"Found several main classes: ${mainClasses.mkString(", ")}",
+      positions = positions
+    )

modules/build/src/main/scala/scala/build/errors/SingleValueExpectedError.scala

@@ -0,0 +1,14 @@
+package scala.build.errors
+
+import scala.build.preprocessing.directives.{DirectiveUtil, StrictDirective}
+
+final class SingleValueExpectedError(
+  val directive: StrictDirective,
+  val path: Either[String, os.Path]
+) extends BuildException(
+      s"Expected a single value for directive ${directive.key} " +
+        s"(got ${directive.values.length} values: ${directive.values.map(_.get().toString).mkString(", ")})",
+      positions = DirectiveUtil.positions(directive.values, path)
+    ) {
+  assert(directive.numericalOrStringValuesCount > 1)
+}

modules/build/src/main/scala/scala/build/preprocessing/ScalaPreprocessor.scala

@@ -15,7 +15,12 @@ import java.nio.charset.StandardCharsets
 
 import scala.build.EitherCps.{either, value}
 import scala.build.Ops._
-import scala.build.errors.{BuildException, CompositeBuildException, DependencyFormatError}
+import scala.build.errors.{
+  BuildException,
+  CompositeBuildException,
+  DependencyFormatError,
+  UnusedDirectiveError
+}
 import scala.build.internal.{AmmUtil, Util}
 import scala.build.options.{BuildOptions, BuildRequirements, ClassPathOptions, ShadowingSeq}
 import scala.build.preprocessing.directives._
@@ -301,7 +306,7 @@ case object ScalaPreprocessor extends Preprocessor {
       )
     }
 
-    val directives2 = updatedRequirements.unused
+    val unusedDirectives = updatedRequirements.unused
 
     val updatedContentOpt =
       if (codeOffset > 0) {
@@ -318,24 +323,35 @@ case object ScalaPreprocessor extends Preprocessor {
       else None
 
     value {
-      if (directives2.nonEmpty) {
-        val errors = directives2.map(d =>
-          new DefaultDirectiveHandler[Nothing].handleValues(d, path, cwd, logger)
-        ).collect {
-          case Left(e) => e
-        }
-        Left(CompositeBuildException(errors))
+      unusedDirectives match {
+        case Seq() =>
+          Right(StrictDirectivesProcessingOutput(
+            updatedRequirements.global,
+            updatedOptions.global,
+            updatedRequirements.scoped,
+            updatedContentOpt
+          ))
+        case Seq(h, t @ _*) =>
+          val errors = ::(
+            handleUnusedValues(h, path, cwd),
+            t.map(d => handleUnusedValues(d, path, cwd)).toList
+          )
+          Left(CompositeBuildException(errors))
       }
-      else
-        Right(StrictDirectivesProcessingOutput(
-          updatedRequirements.global,
-          updatedOptions.global,
-          updatedRequirements.scoped,
-          updatedContentOpt
-        ))
     }
   }
 
+  private def handleUnusedValues(
+    directive: StrictDirective,
+    path: Either[String, os.Path],
+    cwd: ScopePath
+  ): BuildException = {
+    val values =
+      DirectiveUtil.stringValues(directive.values, path, cwd) ++
+        DirectiveUtil.numericValues(directive.values, path, cwd)
+    new UnusedDirectiveError(directive.key, values.map(_._1.value), values.flatMap(_._1.positions))
+  }
+
   case class ExtractedDirectives(offset: Int, directives: Seq[StrictDirective])
 
   val changeToSpecialCommentMsg =
@@ -383,7 +399,7 @@ case object ScalaPreprocessor extends Preprocessor {
     val usedDirectives =
       if (!codeDirectives.getFlattenedMap().isEmpty()) {
         val msg =
-          s"This using directive is ignored. File contains directives outside comments and those has higher precedence."
+          "This using directive is ignored. File contains directives outside comments and those have higher precedence."
         reportWarning(
           msg,
           getDirectives(plainCommentDirectives) ++ getDirectives(specialCommentDirectives)

modules/build/src/main/scala/scala/build/preprocessing/directives/DefaultDirectiveHandler.scala

@@ -2,9 +2,7 @@ package scala.build.preprocessing.directives
 
 import scala.build.Logger
 import scala.build.errors.BuildException
-import scala.build.preprocessing.{ScopePath, Scoped}
-
-case class ProcessedDirective[T](global: Option[T], scoped: Seq[Scoped[T]])
+import scala.build.preprocessing.ScopePath
 
 trait DirectiveHandler[T] {
   def name: String
@@ -14,7 +12,6 @@ trait DirectiveHandler[T] {
   def usageMd: String       = s"`$usage`"
   def examples: Seq[String] = Nil
 
-  // Strict / using_directives-based directives
   def keys: Seq[String]
 
   def handleValues(

modules/build/src/main/scala/scala/build/preprocessing/directives/DirectiveHandler.scala

@@ -2,43 +2,49 @@ package scala.build.preprocessing.directives
 
 import com.virtuslab.using_directives.custom.model.{NumericValue, StringValue, Value}
 
-import scala.build.Position
 import scala.build.preprocessing.ScopePath
+import scala.build.{Position, Positioned}
 
 object DirectiveUtil {
   def stringValues(
     values: Seq[Value[_]],
     path: Either[String, os.Path],
     cwd: ScopePath
-  ): Seq[(String, Position, Option[ScopePath])] =
-    values
-      .collect {
-        case v: StringValue =>
-          val line   = v.getRelatedASTNode.getPosition.getLine
-          val column = v.getRelatedASTNode.getPosition.getColumn + 1 // Using directives are 0 based
-          Seq((
-            v.get,
-            Position.File(path, (line, column), (line, column)),
-            Option(v.getScope).map((p: String) => cwd / os.RelPath(p))
-          ))
-      }
-      .flatten
+  ): Seq[(Positioned[String], Option[ScopePath])] =
+    values.collect {
+      case v: StringValue =>
+        val line   = v.getRelatedASTNode.getPosition.getLine
+        val column = v.getRelatedASTNode.getPosition.getColumn + 1 // Using directives are 0 based
+        val pos    = Position.File(path, (line, column), (line, column))
+        (
+          Positioned(pos, v.get),
+          Option(v.getScope).map((p: String) => cwd / os.RelPath(p))
+        )
+    }
 
   def numericValues(
     values: Seq[Value[_]],
     path: Either[String, os.Path],
     cwd: ScopePath
-  ): Seq[(String, Position, Option[ScopePath])] =
-    values
-      .collect {
-        case v: NumericValue =>
-          val line   = v.getRelatedASTNode.getPosition.getLine
-          val column = v.getRelatedASTNode.getPosition.getColumn
-          Seq((
-            v.get,
-            Position.File(path, (line, column), (line, column)),
-            Option(v.getScope).map((p: String) => cwd / os.RelPath(p))
-          ))
-      }
-      .flatten
+  ): Seq[(Positioned[String], Option[ScopePath])] =
+    values.collect {
+      case v: NumericValue =>
+        val line   = v.getRelatedASTNode.getPosition.getLine
+        val column = v.getRelatedASTNode.getPosition.getColumn
+        val pos    = Position.File(path, (line, column), (line, column))
+        (
+          Positioned(pos, v.get),
+          Option(v.getScope).map((p: String) => cwd / os.RelPath(p))
+        )
+    }
+
+  def positions(
+    values: Seq[Value[_]],
+    path: Either[String, os.Path]
+  ): Seq[Position] =
+    values.map { v =>
+      val line   = v.getRelatedASTNode.getPosition.getLine
+      val column = v.getRelatedASTNode.getPosition.getColumn
+      Position.File(path, (line, column), (line, column))
+    }
 }