From f4ae48bf72c7c69a91e2bc259665a6179f2ca1cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Ferreira?= Date: Tue, 10 Dec 2024 18:53:23 +0000 Subject: [PATCH] move Mapper from sbt/io --- main-actions/src/main/scala/sbt/Mapper.scala | 81 +++++++++++ .../src/test/scala/sbt/MapperSpec.scala | 130 ++++++++++++++++++ 2 files changed, 211 insertions(+) create mode 100644 main-actions/src/main/scala/sbt/Mapper.scala create mode 100644 main-actions/src/test/scala/sbt/MapperSpec.scala diff --git a/main-actions/src/main/scala/sbt/Mapper.scala b/main-actions/src/main/scala/sbt/Mapper.scala new file mode 100644 index 000000000..01efce99e --- /dev/null +++ b/main-actions/src/main/scala/sbt/Mapper.scala @@ -0,0 +1,81 @@ +package sbt + +import sbt.io.{ AllPassFilter, FileFilter, PathFinder } +import sbt.io.Path.* + +import java.io.File + +object Mapper { + + /** + * Selects all descendants of `base` directory and maps them to a path relative to `base`. + * `base` itself is not included. + */ + def allSubpaths(base: File): Seq[(File, String)] = + selectSubpaths(base, AllPassFilter) + + /** + * Selects descendants of `base` directory matching `filter` and maps them to a path relative to `base`. + * `base` itself is not included. + */ + def selectSubpaths(base: File, filter: FileFilter): Seq[(File, String)] = + PathFinder(base).globRecursive(filter).get().collect { + case f if f != base => f -> base.toPath.relativize(f.toPath).toString + } + + /** + * return a Seq of mappings which effect is to add a whole directory in the generated package + * + * @example In order to create mappings for a static directory "extra" add + * {{{ + * mappings ++= directory(baseDirectory.value / "extra") + * }}} + * + * The resulting mappings sequence will look something like this + * + * {{{ + * File(baseDirectory/extras) -> "extras" + * File(baseDirectory/extras/file1) -> "extras/file1" + * File(baseDirectory/extras/file2) -> "extras/file2" + * ... + * }}} + * + * @param baseDirectory The directory that should be turned into a mappings sequence. + * @return mappings The `baseDirectory` and all of its contents + */ + def directory(baseDirectory: File): Seq[(File, String)] = + Option(baseDirectory.getParentFile) + .map(parent => PathFinder(baseDirectory).allPaths pair relativeTo(parent)) + .getOrElse(PathFinder(baseDirectory).allPaths pair basic) + + /** + * return a Seq of mappings excluding the directory itself. + * + * @example In order to create mappings for a static directory "extra" add + * {{{ + * mappings ++= contentOf(baseDirectory.value / "extra") + * }}} + * + * The resulting mappings sequence will look something like this + * + * {{{ + * File(baseDirectory/extras/file1) -> "file1" + * File(baseDirectory/extras/file2) -> "file2" + * ... + * }}} + * + * @example Add a static directory "extra" and re-map the destination to a different path + * {{{ + * mappings ++= contentOf(baseDirectory.value / "extra").map { + * case (src, destination) => src -> s"new/path/destination" + * } + * }}} + * + * @param baseDirectory The directory that should be turned into a mappings sequence. + * @return mappings - The `basicDirectory`'s contents exlcuding `basicDirectory` itself + */ + def contentOf(baseDirectory: File): Seq[(File, String)] = ( + (PathFinder(baseDirectory).allPaths --- PathFinder(baseDirectory)) + pair relativeTo(baseDirectory) + ) +} diff --git a/main-actions/src/test/scala/sbt/MapperSpec.scala b/main-actions/src/test/scala/sbt/MapperSpec.scala new file mode 100644 index 000000000..cefe59da8 --- /dev/null +++ b/main-actions/src/test/scala/sbt/MapperSpec.scala @@ -0,0 +1,130 @@ +/* + * sbt IO + * Copyright Scala Center, Lightbend, and Mark Harrah + * + * Licensed under Apache License 2.0 + * SPDX-License-Identifier: Apache-2.0 + * + * See the NOTICE file distributed with this work for + * additional information regarding copyright ownership. + */ + +package sbt + +import java.nio.file.{ Files, Path => NioPath } + +import org.scalatest.Outcome +import org.scalatest.flatspec +import org.scalatest.matchers.should.Matchers +import sbt.io.IO +import sbt.io.syntax._ + +class MapperSpec extends flatspec.FixtureAnyFlatSpec with Matchers { + + type FixtureParam = NioPath + + "directory" should "create mappings including the baseDirectory" in { tempDirectory => + val nestedFile1 = Files.createFile(tempDirectory.resolve("file1")).toFile + val nestedFile2 = Files.createFile(tempDirectory.resolve("file2")).toFile + val nestedDir = Files.createDirectory(tempDirectory.resolve("dir1")) + val nestedDirFile = Files.createDirectory(nestedDir.resolve("dir1-file1")).toFile + + IO.touch(nestedFile1) + IO.touch(nestedFile2) + IO.createDirectory(nestedDir.toFile) + IO.touch(nestedDirFile) + + val mappings = Mapper.directory(tempDirectory.toFile).map { case (f, s) => (f, file(s)) } + + mappings should contain theSameElementsAs List( + tempDirectory.toFile -> file(s"${tempDirectory.getFileName}"), + nestedFile1 -> file(s"${tempDirectory.getFileName}/file1"), + nestedFile2 -> file(s"${tempDirectory.getFileName}/file2"), + nestedDir.toFile -> file(s"${tempDirectory.getFileName}/dir1"), + nestedDirFile -> file(s"${tempDirectory.getFileName}/dir1/dir1-file1") + ) + } + + it should "create one mapping entry for an empty directory" in { tempDirectory => + val mappings = Mapper.directory(tempDirectory.toFile) + + mappings should contain theSameElementsAs List[(File, String)]( + tempDirectory.toFile -> s"${tempDirectory.getFileName}" + ) + } + + it should "create an empty mappings sequence for a non-existing directory" in { tempDirectory => + val nonExistingDirectory = tempDirectory.resolve("imaginary") + val mappings = Mapper.directory(nonExistingDirectory.toFile) + + mappings should be(empty) + } + + it should "create one mapping entry if the directory is a file" in { tempDirectory => + val file = tempDirectory.resolve("file").toFile + IO.touch(file) + val mappings = Mapper.directory(file) + + mappings should contain theSameElementsAs List[(File, String)]( + file -> s"${file.getName}" + ) + } + + "contentOf" should "create mappings excluding the baseDirectory" in { tempDirectory => + val nestedFile1 = Files.createFile(tempDirectory.resolve("file1")).toFile + val nestedFile2 = Files.createFile(tempDirectory.resolve("file2")).toFile + val nestedDir = Files.createDirectory(tempDirectory.resolve("dir1")) + val nestedDirFile = Files.createDirectory(nestedDir.resolve("dir1-file1")).toFile + + IO.touch(nestedFile1) + IO.touch(nestedFile2) + IO.createDirectory(nestedDir.toFile) + IO.touch(nestedDirFile) + + val mappings = Mapper.contentOf(tempDirectory.toFile).map { case (f, s) => (f, file(s)) } + + mappings should contain theSameElementsAs List( + nestedFile1 -> file(s"file1"), + nestedFile2 -> file(s"file2"), + nestedDir.toFile -> file(s"dir1"), + nestedDirFile -> file(s"dir1/dir1-file1") + ) + } + + it should "create an empty mappings sequence for an empty directory" in { tempDirectory => + val mappings = Mapper.contentOf(tempDirectory.toFile) + + mappings should be(empty) + } + + it should "create an empty mappings sequence for a non-existing directory" in { tempDirectory => + val nonExistingDirectory = tempDirectory.resolve("imaginary") + val mappings = Mapper.contentOf(nonExistingDirectory.toFile) + + mappings should be(empty) + } + + it should "create an empty mappings sequence if the directory is a file" in { tempDirectory => + val file = tempDirectory.resolve("file").toFile + val mappings = Mapper.contentOf(file) + + mappings should be(empty) + } + + "allSubpaths" should "not include the base directory" in { tempDirectory => + val file = Files.createFile(tempDirectory.resolve("file")) + val paths = Mapper.allSubpaths(tempDirectory.toFile).toVector.map(_._1.toPath).toSet + assert(paths.contains(file)) + assert(!paths.contains(tempDirectory)) + } + + override protected def withFixture(test: OneArgTest): Outcome = { + val tmpDir = Files.createTempDirectory("mappings") + try { + withFixture(test.toNoArgTest(tmpDir)) + } finally { + // cleanup an delete the temp directory + IO.delete(tmpDir.toFile) + } + } +}