fix reading resources from a jar at compile time (Scala 3) (#101)

* fix reading resources from a jar at compile time (Scala 3)

Author: rolang

.github/workflows/ci.yml

@@ -158,10 +158,14 @@ jobs:
           name: cli-bin-${{ matrix.os }}
           path: modules/cli/native/target/bin/*
 
-      - name: Run example (covers reading resources from a jar)
+      - name: Run example (covers reading resources from a jar at runtime)
         if: matrix.project == 'rootJVM'
         run: sbt 'project ${{ matrix.project }}' '++ ${{ matrix.scala }}' example/run
 
+      - name: Test reading resources from a jar at compile time
+        if: matrix.project == 'rootJVM' && matrix.scala == '3'
+        run: sbt -Dsample_lib_test 'testLib/clean; sampleLib/publishLocal; testLib/run'
+
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
         run: mkdir -p modules/core/native/target modules/core/jvm/target modules/cli/native/target project/target
@@ -397,5 +401,5 @@ jobs:
       - name: Submit Dependencies
         uses: scalacenter/sbt-dependency-submission@v2
         with:
-          modules-ignore: dumbo_3 dumbo_2.13 testsflyway_3 testsflyway_2.13 dumbo_3 dumbo_2.13 dumbo_3 dumbo_2.13 tests_3 tests_2.13 example_3 example_2.13 tests_native0.4_3 tests_native0.4_2.13
+          modules-ignore: sample-lib_3 dumbo_3 dumbo_2.13 testsflyway_3 testsflyway_2.13 dumbo_3 dumbo_2.13 dumbo_3 dumbo_2.13 tests_3 tests_2.13 example_3 example_2.13 sample-lib-test_3 tests_native0.4_3 tests_native0.4_2.13
           configs-ignore: test scala-tool scala-doc-tool test-internal

build.sbt

@@ -191,10 +191,16 @@ ThisBuild / githubWorkflowGeneratedCI := (ThisBuild / githubWorkflowGeneratedCI)
 
 ThisBuild / githubWorkflowBuild += WorkflowStep.Sbt(
   List("example/run"),
-  name = Some("Run example (covers reading resources from a jar)"),
+  name = Some("Run example (covers reading resources from a jar at runtime)"),
   cond = Some("matrix.project == 'rootJVM'"),
 )
 
+ThisBuild / githubWorkflowBuild += WorkflowStep.Run(
+  commands = List("sbt -Dsample_lib_test 'testLib/clean; sampleLib/publishLocal; testLib/run'"),
+  name = Some("Test reading resources from a jar at compile time"),
+  cond = Some("matrix.project == 'rootJVM' && matrix.scala == '3'"),
+)
+
 addCommandAlias("fix", "; +Test/copyResources; +scalafixAll; +scalafmtAll; scalafmtSbt")
 addCommandAlias("check", "; +Test/copyResources; +scalafixAll --check; +scalafmtCheckAll; scalafmtSbtCheck")
 
@@ -369,7 +375,31 @@ lazy val example = project
   .settings(commonSettings)
   .settings(
     Compile / run / fork  := true,
-    publish / skip        := true,
     Compile / headerCheck := Nil,
     scalacOptions -= "-Werror",
   )
+
+lazy val sampleLib = project
+  .in(file("modules/sample-lib"))
+  .enablePlugins((if (!sys.props.contains("sample_lib_test")) Seq(NoPublishPlugin) else Nil) *)
+  .settings(
+    version               := "0.0.1-SNAPSHOT",
+    scalaVersion          := `scala-3`,
+    crossScalaVersions    := Seq(`scala-3`),
+    name                  := "sample-lib",
+    Compile / headerCheck := Nil,
+  )
+
+lazy val testLib = project
+  .in(file("modules/test-lib"))
+  .enablePlugins(NoPublishPlugin)
+  .settings(commonSettings)
+  .dependsOn(core.jvm)
+  .settings(
+    Compile / run / fork                := true,
+    libraryDependencies += "dev.rolang" %% "sample-lib" % "0.0.1-SNAPSHOT",
+    scalaVersion                        := `scala-3`,
+    crossScalaVersions                  := Seq(`scala-3`),
+    name                                := "sample-lib-test",
+    Compile / headerCheck               := Nil,
+  )

modules/core/jvm/src/main/scala-2/dumbo/ResourceFilePath.scala

@@ -65,7 +65,7 @@ object ResourceFilePath {
           .entries()
           .asScala
           .toList
-          .filter(_.getName().startsWith(location))
+          .filter(e => e.getName().startsWith(location) && !e.isDirectory())
           .map(entry => ResourceFilePath(s"/${entry.getName()}"))
       }
     }

modules/core/shared/src/main/scala-3/dumbo/ResourceFilePath.scala

@@ -23,10 +23,25 @@ object ResourceFilePath:
 
     getClass().getClassLoader().getResources(location).asScala.toList match
       case head :: Nil =>
-        val base = Paths.get(head.toURI())
-        val resources =
-          new File(base.toString()).list().map(fileName => s"/$location/$fileName").toList
-        Expr(resources)
+        if head.toString.startsWith("jar:") then
+          val srcUriStr   = head.toURI().toString()
+          val jarFilePath = srcUriStr.slice(srcUriStr.lastIndexOf(":") + 1, srcUriStr.lastIndexOf("!"))
+
+          val resources = scala.util.Using.resource(java.util.zip.ZipFile(jarFilePath)) { fs =>
+            fs
+              .entries()
+              .asScala
+              .toList
+              .filter(e => e.getName().startsWith(location) && !e.isDirectory())
+              .map(entry => s"/${entry.getName()}")
+          }
+
+          Expr(resources)
+        else
+          val base = Paths.get(head.toURI())
+          val resources =
+            new File(base.toString()).list().map(fileName => s"/$location/$fileName").toList
+          Expr(resources)
       case Nil => report.errorAndAbort(s"resource ${location} was not found")
       case multiple =>
         report.errorAndAbort(s"found multiple resource locations for ${location} in:\n${multiple.mkString("\n")}")

modules/sample-lib/src/main/resources/sample_lib/V1__test.sql

@@ -0,0 +1 @@
+CREATE TABLE test_a();

modules/sample-lib/src/main/resources/sample_lib/V2__test_b.sql

@@ -0,0 +1 @@
+CREATE TABLE test_b();

modules/test-lib/src/main/scala/TestLib.scala

@@ -0,0 +1,15 @@
+import dumbo.ResourceFilePath
+
+@main def run(args: String*) =
+  val resources = ResourceFilePath.fromResourcesDir("sample_lib")
+  val expected = List(
+    "/sample_lib/V1__test.sql",
+    "/sample_lib/V2__test_b.sql",
+  )
+
+  if resources == expected then
+    println("Test ok")
+    sys.exit(0)
+  else
+    Console.err.println(s"Expected resources $expected\nbut got $resources")
+    sys.exit(1)