Impl //INCLUDE directive(fixes #34)

Author: holgerbrandl

NEWS.md

@@ -2,6 +2,8 @@
 
 * Reimplemented in kotlin (fixes [#36](https://github.com/holgerbrandl/kscript/issues/36))
 * Added cygwin support (fixes [#39](https://github.com/holgerbrandl/kscript/issues/39))
+* Added `//INCLUDE` directive (fixes [#34](https://github.com/holgerbrandl/kscript/issues/34)
+
 
 ## v1.5.1
 

README.md

@@ -46,7 +46,7 @@ kscript --self-update
 
 #### Installation without `sdkman`
 
-If you have Kotlin and Maven already and you would like to install the latest `kscript` release to your `~/bin` without using `sdkman` you can do so by unzipping the [latest ](https://github.com/holgerbrandl/kscript/releases/latest) binary release.
+If you have Kotlin and Maven already and you would like to install the latest `kscript` release without using `sdkman` you can do so by unzipping the [latest ](https://github.com/holgerbrandl/kscript/releases/latest) binary release. Don't forget to update your `$PATH` accordingly.
 
 
 
@@ -237,9 +237,24 @@ println("Hello from Kotlin with 5g of heap memory running in server mode!")
 
 In order to use cygwin you need to use windows paths to provide your scripts. You can map cygwin paths using `cygpath`. Example
 ```bash
-kscript $(cygpath -w /cygdrive/z/some/path/my_script.kt)
+kscript $(cygpath -w /cygdrive/z/some/path/my_script.kts)
 ```
 
+## Can I include another script with helper functions like `source foo.sh` in bash?
+
+Yes, `kscript` supports an `//INLCUDE` directive. Absolute and relative paths, as well as URLs are supported. Example
+
+```kotlin
+#!/usr/bin/env kscript
+
+//INCLUDE Utils.kt
+//INCLUDE ../other_utils/Utils.kt
+//INCLUDE http://somewhere.com/utils.kt
+
+...
+```
+For an actual example see [here](test/resources/includes/include_variations.kts).
+
 Support
 -------
 

src/main/kotlin/kscript/app/AppHelpers.kt

@@ -55,20 +55,18 @@ object ShellUtils {
 
 }
 
+fun errorMsg(msg: String) {
+    System.err.println("[ERROR] " + msg)
+}
+
 fun errorIf(value: Boolean, lazyMessage: () -> Any) {
     if (value) {
-        System.err.println("[ERROR] " + lazyMessage().toString())
+        errorMsg(lazyMessage().toString())
         quit(1)
     }
 }
 
-
 fun quit(status: Int): Nothing {
     print(if (status == 0) "true" else "false")
     exitProcess(status)
 }
-
-
-internal inline fun warning(value: Boolean, lazyMessage: () -> Any): Unit {
-    if (!value) System.err.println(lazyMessage())
-}

src/main/kotlin/kscript/app/Kscript.kt

@@ -46,7 +46,7 @@ Website   : https://github.com/holgerbrandl/kscript
 """.trim()
 
 val KSCRIPT_CACHE_DIR = File(System.getenv("HOME")!!, ".kscript")
-
+val SCRIPT_TEMP_DIR = createTempDir()
 
 fun main(args: Array<String>) {
     // skip org.docopt for version and help to allow for lazy version-check
@@ -307,6 +307,9 @@ fun prepareScript(scriptResource: String): File {
     }
 
 
+    // support //INCLUDE directive (see https://github.com/holgerbrandl/kscript/issues/34)
+    scriptFile = resolveIncludes(scriptFile)
+
     // just proceed if the script file is a regular file at this point
     errorIf(scriptFile == null || !scriptFile.canRead()) {
         "Could not read script argument '$scriptResource'"
@@ -315,8 +318,9 @@ fun prepareScript(scriptResource: String): File {
     return scriptFile!!
 }
 
-private fun createTmpScript(scriptText: String): File {
-    return File(createTempDir(), "scriptlet.${md5(scriptText)}.kts").apply {
+
+fun createTmpScript(scriptText: String): File {
+    return File(SCRIPT_TEMP_DIR, "scriptlet.${md5(scriptText)}.kts").apply {
         writeText(scriptText)
     }
 }

src/main/kotlin/kscript/app/ResolveIncludes.kt

@@ -0,0 +1,69 @@
+package kscript.app
+
+import java.io.File
+import java.io.FileNotFoundException
+import java.net.URL
+
+/**
+ * @author Holger Brandl
+ */
+
+/** Resolve include declarations in a script file. Resolved script will be put into another temporary script */
+fun resolveIncludes(template: File?): File? {
+    if (template == null) return null
+
+    // recursively replace //INCLUDES
+    return resolveIncludesInternal(template)?.run { resolveIncludes(this) } ?: template
+}
+
+private fun resolveIncludesInternal(template: File): File? {
+    val scriptLines = template.readText().lines()
+
+    // don't do a thing if there's not INCLUDE in the script
+    if (scriptLines.find { it.startsWith("//INCLUDE ") } == null) return null
+
+    val sb = StringBuilder()
+
+    scriptLines.map {
+        if (it.startsWith("//INCLUDE")) {
+            val include = it.split("[ ]+".toRegex()).last()
+
+            val includeURL = when {
+                include.startsWith("http://") -> URL(include)
+                include.startsWith("https://") -> URL(include)
+                include.startsWith("./") || include.startsWith("../") -> File(template.parentFile, include).toURI().toURL()
+                include.startsWith("/") -> File(include).toURI().toURL()
+                else -> File(template.parentFile, include).toURI().toURL()
+            }
+
+            try {
+                sb.appendln(includeURL.readText())
+            } catch (e: FileNotFoundException) {
+                errorMsg("Failed to resolve //INCLUDE '${include}'")
+                System.err.println(e.message?.lines()!!.map { it.prependIndent("[ERROR] ") })
+
+                quit(1)
+            }
+        } else {
+            // if it's not a directive we simply skip emit the line as it is
+            sb.appendln(it)
+        }
+    }
+
+    return createTmpScript(sb.toString())
+}
+
+
+// basic launcher for testing
+fun main(args: Array<String>) {
+    System.err.println(resolveIncludes(File(args[0])))
+}
+
+/**
+# Usage Example
+cd $KSCRIPT_HOME
+gradle shadowJar
+resolve_inc() { kotlin -classpath build/libs/kscript-0.1-SNAPSHOT-all.jar kscript.app.ResolveIncludesKt "$@";}
+resolve_inc /Users/brandl/projects/kotlin/kscript/test/resources/includes/include_variations.kts
+cat $(resolve_inc /Users/brandl/projects/kotlin/kscript/test/resources/includes/include_variations.kts 2>&1)
+ */

test/resources/includes/include_3.kt

@@ -0,0 +1 @@
+fun include_3() = println("include_3")

test/resources/includes/include_4.kt

@@ -0,0 +1 @@
+fun include_4() = println("include_4")

test/resources/includes/include_variations.kts

@@ -0,0 +1,16 @@
+println("Let's resolve includes!")
+
+//INCLUDE rel_includes/include_1.kt
+//INCLUDE ./rel_includes//include_2.kt
+
+//INCLUDE ../includes/include_3.kt
+//INCLUDE include_4.kt
+
+include_1()
+include_2()
+include_3()
+include_4()
+
+
+
+println("wow, so many includes")

test/resources/includes/rel_includes/include_1.kt

@@ -0,0 +1 @@
+fun include_1() = println("include_1")

test/resources/includes/rel_includes/include_2.kt

@@ -0,0 +1 @@
+fun include_2() = println("include_2")