[workflows] added output directory option for type-stub generator

.github/workflows/release.yml

@@ -40,11 +40,11 @@ jobs:
       - name: Generate Ruby Types
         run: ./standalone --withLanguageFrontend RUBYSRC 
       - name: Checksum
-        run: sha512sum src/main/resources/ruby/builtin_types.zip > src/main/resources/ruby/builtin_types.zip.sha512
+        run: sha512sum builtin_types/ruby_builtin_types.zip > builtin_types/ruby_builtin_types.zip.sha512
       - name: Rename
         run: |
-          mv src/main/resources/ruby/builtin_types.zip ruby_builtin_types.zip
-          mv src/main/resources/ruby/builtin_types.zip.sha512 ruby_builtin_types.zip.sha512
+          mv builtin_types/ruby_builtin_types.zip ruby_builtin_types.zip
+          mv builtin_types/ruby_builtin_types.zip.sha512 ruby_builtin_types.zip.sha512
       - name: Show SHA512
         run: cat ruby_builtin_types.zip.sha512 
       - name: Set next release version

.gitignore

@@ -5,3 +5,4 @@ target/
 /joern-inst
 /workspace
 src/main/resources/
+builtin_types/

src/main/scala/io/joern/typestubs/Main.scala

@@ -8,7 +8,7 @@ object OutputFormat extends Enumeration {
   val json, mpk, zip = Value
 }
 
-final case class Config(format: OutputFormat.Value = OutputFormat.zip, languageFrontend: String = Frontend.ALL) {
+final case class Config(format: OutputFormat.Value = OutputFormat.zip, languageFrontend: String = Frontend.ALL, outputDirectory: String = "./builtin_types") {
 
   def withFormat(value: OutputFormat.Value): Config = {
     copy(format = value)
@@ -17,6 +17,10 @@ final case class Config(format: OutputFormat.Value = OutputFormat.zip, languageF
   def withLanguageFrontend(value: String): Config = {
     copy(languageFrontend = value)
   }
+
+  def withOutputDirectory(value: String): Config = {
+    copy(outputDirectory = value)
+  }
 }
 
 private object Frontend {
@@ -45,7 +49,10 @@ private object Frontend {
             failure(s"Only available languages are: [${availableFrontendLanguages.mkString(", ")}]")
         }
         .text(s"The Frontend Language to generate builtin types for, defaults to `all`: [${availableFrontendLanguages
-                .mkString(",")}]".stripMargin)
+                .mkString(",")}]".stripMargin),
+      opt[String]("output")
+        .action((x, c) => c.withOutputDirectory(x))
+        .text("Directory for type-stubs output")
     )
   }
 }
@@ -70,7 +77,7 @@ object Main {
 
   def run(config: Config): Unit = {
     if config.languageFrontend == Frontend.ALL || config.languageFrontend == Languages.RUBYSRC then
-      val rubyScraper = BuiltinPackageDownloader(format = config.format)
+      val rubyScraper = BuiltinPackageDownloader(outputDir = config.outputDirectory, format = config.format)
       rubyScraper.run()
   }
 }

src/main/scala/io/joern/typestubs/ruby/BuiltinPackageDownloader.scala

@@ -43,7 +43,7 @@ case class RubyType(name: String, methods: List[RubyMethod], fields: List[RubyFi
   * @param rubyVersion
   *   \- Ruby version to fetch dependencies for
   */
-class BuiltinPackageDownloader(format: OutputFormat.Value = OutputFormat.zip) {
+class BuiltinPackageDownloader(outputDir: String, format: OutputFormat.Value = OutputFormat.zip) {
   private val logger: Logger = LoggerFactory.getLogger(this.getClass)
 
   private val CLASS    = "class"
@@ -52,7 +52,7 @@ class BuiltinPackageDownloader(format: OutputFormat.Value = OutputFormat.zip) {
   private val browser = JsoupBrowser()
   private val baseUrl = s"https://ruby-doc.org/3.3.0"
 
-  private val baseDir = "src/main/resources/ruby/builtin_types"
+  private val baseDir = s"$outputDir/ruby_builtin_types"
 
   // Below unicode value calculated with: println("\\u" + Integer.toHexString('→' | 0x10000).substring(1))
   // taken from: https://stackoverflow.com/questions/2220366/get-unicode-value-of-a-character
@@ -138,8 +138,10 @@ class BuiltinPackageDownloader(format: OutputFormat.Value = OutputFormat.zip) {
     }
 
     logger.debug("[Ruby]: Zipping builtin-type dir")
-    dir.zipTo(destination = File(s"${baseDir}.zip"))
-    dir.delete()
+
+    if format == OutputFormat.zip then
+      dir.zipTo(destination = File(s"${baseDir}.zip"))
+      dir.delete()
   }
 
   /** Write RubyTypes to JSON files for debugging a readable format