Merge pull request #220 from alexarchambault/develop

Tweak doc and fix relative paths handling in using directives

Author: alexarchambault

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

@@ -88,7 +88,7 @@ object CrossSources {
 
     val scopedRequirements       = preprocessedSources.flatMap(_.scopedRequirements)
     val scopedRequirementsByRoot = scopedRequirements.groupBy(_.path.root)
-    def baseReqs(path: PreprocessedSource.ScopePath): BuildRequirements =
+    def baseReqs(path: ScopePath): BuildRequirements =
       scopedRequirementsByRoot
         .getOrElse(path.root, Nil)
         .flatMap(_.valueFor(path).toSeq)

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

@@ -8,7 +8,7 @@ import java.util.zip.{ZipEntry, ZipInputStream}
 
 import scala.annotation.tailrec
 import scala.build.options.Scope
-import scala.build.preprocessing.PreprocessedSource
+import scala.build.preprocessing.ScopePath
 import scala.util.matching.Regex
 
 final case class Inputs(
@@ -146,8 +146,8 @@ object Inputs {
       os.sub / source.drop(idx + 1)
     }
 
-    def scopePath: PreprocessedSource.ScopePath =
-      PreprocessedSource.ScopePath(source, subPath)
+    def scopePath: ScopePath =
+      ScopePath(Left(source), subPath)
   }
 
   sealed trait SingleFile   extends OnDisk with SingleElement

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

@@ -0,0 +1,11 @@
+package scala.build.errors
+
+import scala.build.Position
+
+final class ForbiddenPathReferenceError(
+  val virtualRoot: String,
+  val positionOpt: Option[Position]
+) extends BuildException(
+      s"Can't reference paths from sources from $virtualRoot",
+      positionOpt.toSeq
+    )

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

@@ -3,6 +3,7 @@ package scala.build.preprocessing
 import com.virtuslab.using_directives.custom.model.{Path, Value}
 
 import scala.build.Ops._
+import scala.build.Position
 import scala.build.errors.{BuildException, CompositeBuildException}
 import scala.build.options.{BuildOptions, ScalaOptions}
 import scala.build.preprocessing.directives.DirectiveHandler
@@ -45,7 +46,8 @@ object DirectivesProcessor {
 
   def process(
     directives: Map[Path, Seq[Value[_]]],
-    handlers: Seq[DirectiveHandler]
+    handlers: Seq[DirectiveHandler],
+    cwd: ScopePath
   ): Either[BuildException, BuildOptions] = {
 
     val values = directives.map {
@@ -63,7 +65,9 @@ object DirectivesProcessor {
       .iterator
       .flatMap {
         case (k, v) =>
-          handlersMap.get(k).iterator.map(_(v))
+          // FIXME using_directives needs to give us positions here
+          val positionOpt = Option.empty[Position]
+          handlersMap.get(k).iterator.map(_(v, cwd, positionOpt))
       }
       .toVector
       .sequence

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

@@ -7,8 +7,8 @@ sealed abstract class PreprocessedSource extends Product with Serializable {
   def requirements: Option[BuildRequirements]
   def mainClassOpt: Option[String]
 
-  def scopedRequirements: Seq[PreprocessedSource.Scoped[BuildRequirements]]
-  def scopePath: PreprocessedSource.ScopePath
+  def scopedRequirements: Seq[Scoped[BuildRequirements]]
+  def scopePath: ScopePath
 }
 
 object PreprocessedSource {
@@ -76,29 +76,4 @@ object PreprocessedSource {
       }
     }
 
-  final case class ScopePath(
-    root: String,
-    path: os.SubPath
-  ) {
-    def /(subPath: os.PathChunk): ScopePath =
-      copy(path = path / subPath)
-  }
-
-  object ScopePath {
-    def fromPath(path: os.Path): ScopePath = {
-      def root(p: os.Path): os.Path =
-        if (p.segmentCount > 0) root(p / os.up) else p
-      val root0 = root(path)
-      ScopePath(root0.toString, path.subRelativeTo(root0))
-    }
-  }
-
-  final case class Scoped[T](path: ScopePath, value: T) {
-    def appliesTo(candidate: ScopePath): Boolean =
-      path.root == candidate.root &&
-      candidate.path.startsWith(path.path)
-    def valueFor(candidate: ScopePath): Option[T] =
-      if (appliesTo(candidate)) Some(value) else None
-  }
-
 }

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

@@ -59,7 +59,7 @@ case object ScalaPreprocessor extends Preprocessor {
         }
         val res = either {
           val content   = value(maybeRead(f.path))
-          val scopePath = PreprocessedSource.ScopePath.fromPath(f.path)
+          val scopePath = ScopePath.fromPath(f.path)
           val source = value(process(content, Right(f.path), scopePath / os.up)) match {
             case None =>
               PreprocessedSource.OnDisk(f.path, None, None, Nil, Some(inferredClsName))
@@ -116,15 +116,15 @@ case object ScalaPreprocessor extends Preprocessor {
   def process(
     content: String,
     path: Either[String, os.Path],
-    scopeRoot: PreprocessedSource.ScopePath
+    scopeRoot: ScopePath
   ): Either[BuildException, Option[(
     BuildRequirements,
-    Seq[PreprocessedSource.Scoped[BuildRequirements]],
+    Seq[Scoped[BuildRequirements]],
     BuildOptions,
     Option[String]
   )]] = either {
 
-    val afterStrictUsing = value(processStrictUsing(content))
+    val afterStrictUsing = value(processStrictUsing(content, scopeRoot))
     val afterUsing = value {
       processUsing(path, afterStrictUsing.map(_._2).getOrElse(content), scopeRoot)
         .sequence
@@ -153,14 +153,16 @@ case object ScalaPreprocessor extends Preprocessor {
     }
   }
 
-  private def directivesBuildOptions(directives: Seq[Directive])
-    : Either[BuildException, BuildOptions] = {
+  private def directivesBuildOptions(
+    directives: Seq[Directive],
+    cwd: ScopePath
+  ): Either[BuildException, BuildOptions] = {
     val results = directives
       .filter(_.tpe == Directive.Using)
       .map { dir =>
         val fromHandlersOpt = usingDirectiveHandlers
           .iterator
-          .flatMap(_.handle(dir).iterator)
+          .flatMap(_.handle(dir, cwd).iterator)
           .take(1)
           .toList
           .headOption
@@ -180,17 +182,17 @@ case object ScalaPreprocessor extends Preprocessor {
 
   private def directivesBuildRequirements(
     directives: Seq[Directive],
-    scopeRoot: PreprocessedSource.ScopePath
+    scopeRoot: ScopePath
   ): Either[
     BuildException,
-    (BuildRequirements, Seq[PreprocessedSource.Scoped[BuildRequirements]])
+    (BuildRequirements, Seq[Scoped[BuildRequirements]])
   ] = {
     val results = directives
       .filter(_.tpe == Directive.Require)
       .map { dir =>
         val fromHandlersOpt = requireDirectiveHandlers
           .iterator
-          .flatMap(_.handle(dir).iterator)
+          .flatMap(_.handle(dir, scopeRoot).iterator)
           .take(1)
           .toList
           .headOption
@@ -203,7 +205,7 @@ case object ScalaPreprocessor extends Preprocessor {
               case None => (reqs, Nil)
               case Some(sc) =>
                 val scopePath = scopeRoot / os.RelPath(sc).asSubPath
-                (BuildRequirements(), Seq(PreprocessedSource.Scoped(scopePath, reqs)))
+                (BuildRequirements(), Seq(Scoped(scopePath, reqs)))
             }
             Right(value)
           case Some(Left(err)) =>
@@ -224,12 +226,12 @@ case object ScalaPreprocessor extends Preprocessor {
   private def processUsing(
     path: Either[String, os.Path],
     content: String,
-    scopeRoot: PreprocessedSource.ScopePath
+    scopeRoot: ScopePath
   ): Option[Either[
     BuildException,
     (
       BuildRequirements,
-      Seq[PreprocessedSource.Scoped[BuildRequirements]],
+      Seq[Scoped[BuildRequirements]],
       BuildOptions,
       Option[String]
     )
@@ -240,7 +242,7 @@ case object ScalaPreprocessor extends Preprocessor {
       case (directives, updatedContentOpt) =>
         val tuple = (
           directivesBuildRequirements(directives, scopeRoot),
-          directivesBuildOptions(directives),
+          directivesBuildOptions(directives, scopeRoot),
           Right(updatedContentOpt)
         )
         tuple
@@ -339,7 +341,8 @@ case object ScalaPreprocessor extends Preprocessor {
   }
 
   private def processStrictUsing(
-    content: String
+    content: String,
+    cwd: ScopePath
   ): Either[BuildException, Option[(BuildOptions, String)]] = either {
 
     val processor = {
@@ -364,7 +367,8 @@ case object ScalaPreprocessor extends Preprocessor {
     val updatedOptions = value {
       DirectivesProcessor.process(
         directives0,
-        usingDirectiveHandlers ++ requireDirectiveHandlers
+        usingDirectiveHandlers ++ requireDirectiveHandlers,
+        cwd
       )
     }
     val codeOffset = directives.getCodeOffset()

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

@@ -0,0 +1,18 @@
+package scala.build.preprocessing
+
+final case class ScopePath(
+  root: Either[String, os.Path],
+  path: os.SubPath
+) {
+  def /(subPath: os.PathChunk): ScopePath =
+    copy(path = path / subPath)
+}
+
+object ScopePath {
+  def fromPath(path: os.Path): ScopePath = {
+    def root(p: os.Path): os.Path =
+      if (p.segmentCount > 0) root(p / os.up) else p
+    val root0 = root(path)
+    ScopePath(Right(root0), path.subRelativeTo(root0))
+  }
+}

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

@@ -0,0 +1,9 @@
+package scala.build.preprocessing
+
+final case class Scoped[T](path: ScopePath, value: T) {
+  def appliesTo(candidate: ScopePath): Boolean =
+    path.root == candidate.root &&
+    candidate.path.startsWith(path.path)
+  def valueFor(candidate: ScopePath): Option[T] =
+    if (appliesTo(candidate)) Some(value) else None
+}

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

@@ -23,7 +23,7 @@ final case class ScriptPreprocessor(codeWrapper: CodeWrapper) extends Preprocess
               content,
               codeWrapper,
               script.subPath,
-              PreprocessedSource.ScopePath.fromPath(script.path)
+              ScopePath.fromPath(script.path)
             )
           }
           preprocessed
@@ -76,7 +76,7 @@ object ScriptPreprocessor {
     content: String,
     codeWrapper: CodeWrapper,
     subPath: os.SubPath,
-    scopePath: PreprocessedSource.ScopePath
+    scopePath: ScopePath
   ): Either[BuildException, List[PreprocessedSource.InMemory]] = either {
 
     val contentIgnoredSheBangLines = ignoreSheBangLines(content)

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

@@ -1,6 +1,8 @@
 package scala.build.preprocessing.directives
 
 import scala.build.Position
+import scala.build.errors.{BuildException, ForbiddenPathReferenceError}
+import scala.build.preprocessing.ScopePath
 
 final case class Directive(
   tpe: Directive.Type,
@@ -14,4 +16,12 @@ object Directive {
   sealed abstract class Type(val name: String) extends Product with Serializable
   case object Using                            extends Type("using")
   case object Require                          extends Type("require")
+
+  def osRoot(cwd: ScopePath, pos: Option[Position]): Either[BuildException, os.Path] =
+    cwd.root match {
+      case Left(virtualRoot) =>
+        Left(new ForbiddenPathReferenceError(virtualRoot, pos))
+      case Right(root) =>
+        Right(root / cwd.path)
+    }
 }