Added support for custom maven repositories (fixes #22)

Author: holgerbrandl

NEWS.md

@@ -1,8 +1,14 @@
 ## v2.2
 
-* Logging of maven artifact downloads to stderr and high level status information (fixes [#23](https://github.com/holgerbrandl/kscript/issues/23))
+* Logging of maven artifact downloads to stderr (fixes [#23](https://github.com/holgerbrandl/kscript/issues/23))
 * Added `-s` / `--silent` to suppress all logging
 * Fixed [#55](https://github.com/holgerbrandl/kscript/issues/55): dependency resolution fails on travis ci and within docker containers
+* Added alternative `@DependsOnMaven(val artifactId: String)` annotaiton to declare dependencies. This has been implemented to make kscripts compatible with https://github.com/ligee/kotlin-jupyter
+* Added support for custom maven repositories (fixes [#22](https://github.com/holgerbrandl/kscript/issues/22))
+
+
+See [README.md](README.md) for usage details.
+
 
 ## v2.1
 

README.md

@@ -266,11 +266,20 @@ Using annotations instead of comment directives to configure scripts is cleaner
 ```kotlin
 #!/usr/bin/env kscript
 
-// declare dependencies
+// Declare dependencies
 @file:DependsOn("de.mpicbg.scicomp:kutils:0.4")
 @file:DependsOn("com.beust:klaxon:0.24", "com.github.kittinunf.fuel:fuel:1.3.1")
 
-// include helper scripts without deployment or prior compilation
+
+// To use a custom maven repository you can declare it with
+@file:MavenRepository("imagej-releases","http://maven.imagej.net/content/repositories/releases" )
+
+// For compatibility with https://github.com/ligee/kotlin-jupyter kscript supports also
+// Note that for compatibility reasons, only one locator argument is allowed here
+@file:DependsOnMaven("net.clearvolume:cleargl:2.0.1")
+
+
+// Include helper scripts without deployment or prior compilation
 @file:Include("util.kt")
 
 
@@ -286,7 +295,7 @@ print("1+1")
 
 To enable the use of these annotations in Intellij, the user must add the following artifact (hosted on jcenter) to the project dependencies:
 ```
-com.github.holgerbrandl:kscript-annotations:1.0
+com.github.holgerbrandl:kscript-annotations:1.1
 ```
 
 `kscript` will automatically detect an annotation-driven script, and if so will declare a dependency on this artifact internally.
@@ -340,6 +349,12 @@ In order to use cygwin you need to use windows paths to provide your scripts. Yo
 kscript $(cygpath -w /cygdrive/z/some/path/my_script.kts)
 ```
 
+
+## Can I use custom artifact repositories?
+
+Yes, via the `@MavenRepository` annotation. See [annotations section](#annotation-driven-script-configuration) or [custom_mvn_repo_annot](test/resources/custom_mvn_repo_annot.kts) for a complete example
+
+
 Support
 -------
 

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

@@ -188,7 +188,7 @@ fun numLines(str: String) = str.split("\r\n|\r|\n".toRegex()).dropLastWhile { it
 fun info(msg: String) = System.err.println(msg)
 
 
-fun launchIdeaWithKscriptlet(scriptFile: File, dependencies: List<String>): String {
+fun launchIdeaWithKscriptlet(scriptFile: File, dependencies: List<String>, customRepos: List<MavenRepo>): String {
     System.err.println("Setting up idea project from ${scriptFile}")
 
     //    val tmpProjectDir = createTempDir("edit_kscript", suffix="")
@@ -198,13 +198,14 @@ fun launchIdeaWithKscriptlet(scriptFile: File, dependencies: List<String>): Stri
 
     //  fixme use tmp instead of cachdir. Fails for now because idea gradle import does not seem to like tmp
     val tmpProjectDir = KSCRIPT_CACHE_DIR
-        .run { File(this, "kscript_tmp_project__${scriptFile.name}") }
+        .run { File(this, "kscript_tmp_project__${scriptFile.name}_${System.currentTimeMillis()}") }
         .apply { mkdir() }
     //    val tmpProjectDir = File("/Users/brandl/Desktop/")
     //            .run { File(this, "kscript_tmp_project") }
     //            .apply { mkdir() }
 
     val stringifiedDeps = dependencies.map { "    compile \"$it\"" }.joinToString("\n")
+    val stringifiedRepos = customRepos.map { "    maven {\n        url '${it.url}'\n    }\n" }.joinToString("\n")
 
     val gradleScript = """
 group 'com.github.holgerbrandl.kscript.editor'
@@ -221,7 +222,9 @@ $stringifiedDeps
 
 repositories {
     mavenCentral()
+    mavenLocal()
     jcenter()
+$stringifiedRepos
 }
 
 sourceSets {
@@ -233,7 +236,7 @@ sourceSets {
 }
 
 buildscript {
-    ext.kotlin_version = '1.1.4'
+    ext.kotlin_version = '1.1.60'
 
     repositories {
         jcenter()

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

@@ -8,7 +8,7 @@ val DEP_LOOKUP_CACHE_FILE = File(KSCRIPT_CACHE_DIR, "dependency_cache.txt")
 val CP_SEPARATOR_CHAR = if (System.getProperty("os.name").toLowerCase().contains("windows")) ";" else ":"
 
 
-fun resolveDependencies(depIds: List<String>, loggingEnabled: Boolean): String? {
+fun resolveDependencies(depIds: List<String>, customRepos: List<MavenRepo> = emptyList(), loggingEnabled: Boolean): String? {
 
     // if no dependencies were provided we stop here
     if (depIds.isEmpty()) {
@@ -51,6 +51,17 @@ fun resolveDependencies(depIds: List<String>, loggingEnabled: Boolean): String?
     """
     }
 
+    // see https://github.com/holgerbrandl/kscript/issues/22
+    val repoTags = customRepos.map {
+        """
+    <repository>
+            <id>${it.id}</id>
+            <url>${it.url}</url>
+    </repository>
+    """
+
+    }
+
     val pom = """
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -68,6 +79,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
             <id>jcenter</id>
             <url>http://jcenter.bintray.com/</url>
         </repository>
+        ${repoTags.joinToString("\n")}
     </repositories>
 
     <dependencies>
@@ -141,5 +153,5 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs
 
 // called by unit tests
 fun main(args: Array<String>) {
-    System.err.println(resolveDependencies(args.toList(), false))
+    System.err.println(resolveDependencies(args.toList(), loggingEnabled = false))
 }

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

@@ -117,16 +117,17 @@ fun main(args: Array<String>) {
 
     // Find all //DEPS directives and concatenate their values
     val dependencies = collectDependencies(scriptText)
+    val customRepos = collectRepos(scriptText)
 
 
     //  Create temopary dev environment
     if (docopt.getBoolean("idea")) {
-        println(launchIdeaWithKscriptlet(scriptFile, dependencies))
+        println(launchIdeaWithKscriptlet(scriptFile, dependencies, customRepos))
         exitProcess(0)
     }
 
 
-    val classpath = resolveDependencies(dependencies, loggingEnabled)
+    val classpath = resolveDependencies(dependencies, customRepos, loggingEnabled)
 
     // Extract kotlin arguments
     val kotlinOpts = collectRuntimeOptions(scriptText)
@@ -148,8 +149,8 @@ fun main(args: Array<String>) {
     // Even if we just need and support the //ENTRY directive in case of kt-class
     // files, we extract it here to fail if it was used in kts files.
     val entryDirective = scriptText
-            .find { it.contains("^//ENTRY ".toRegex()) }
-            ?.replace("//ENTRY ", "")?.trim()
+        .find { it.contains("^//ENTRY ".toRegex()) }
+        ?.replace("//ENTRY ", "")?.trim()
 
     errorIf(entryDirective != null && scriptFileExt == "kts") {
         "//ENTRY directive is just supported for kt class files"
@@ -164,8 +165,8 @@ fun main(args: Array<String>) {
 
     // Capitalize first letter and get rid of dashes (since this is what kotlin compiler is doing for the wrapper to create a valid java class name)
     val className = scriptFile.nameWithoutExtension
-            .replace("[.-]".toRegex(), "_")
-            .capitalize()
+        .replace("[.-]".toRegex(), "_")
+        .capitalize()
 
 
     // Define the entrypoint for the scriptlet jar
@@ -174,7 +175,7 @@ fun main(args: Array<String>) {
     } else {
         // extract package from kt-file
         val pckg = scriptText.find { it.startsWith("package ") }
-                ?.split("[ ]+".toRegex())?.get(1)?.run { this + "." }
+            ?.split("[ ]+".toRegex())?.get(1)?.run { this + "." }
 
         """${pckg ?: ""}${entryDirective ?: "${className}Kt"}"""
     }
@@ -244,44 +245,70 @@ fun main(args: Array<String>) {
 }
 
 fun collectDependencies(scriptText: List<String>): List<String> {
-    val deps = scriptText
-            .filter { it.startsWith("//DEPS ") }
-            .flatMap { it.split("[ ;,]+".toRegex()).drop(1) }
-            .map(String::trim)
-
-    val annotatonPrefix = "@file:DependsOn("
+    val dependsOnPrefix = "@file:DependsOn("
     var annotDeps = scriptText
-            .filter { it.startsWith(annotatonPrefix) }
-            .map { it.replaceFirst(annotatonPrefix, "").split(")")[0] }
-            .flatMap { it.split(",") }
-            .map { it.trim(' ', '"') }
+        .filter { it.startsWith(dependsOnPrefix) }
+        .map { it.replaceFirst(dependsOnPrefix, "").split(")")[0] }
+        .flatMap { it.split(",") }
+        .map { it.trim(' ', '"') }
+
+
+    val dependsOnMavenPrefix = "@file:DependsOnMaven("
+    annotDeps += scriptText
+        .filter { it.startsWith(dependsOnMavenPrefix) }
+        .map { it.replaceFirst(dependsOnMavenPrefix, "").split(")")[0] }
+        .map { it.trim(' ', '"') }
 
-    // if annotations are used add dependency
+
+    // if annotations are used add dependency on kscript-annotations
     if (scriptText.any { containsKscriptAnnotation(it) }) {
-        annotDeps += "com.github.holgerbrandl:kscript-annotations:1.0"
+        annotDeps += "com.github.holgerbrandl:kscript-annotations:1.1"
     }
 
+
+    // also extract classical comment directives
+    val deps = scriptText
+        .filter { it.startsWith("//DEPS ") }
+        .flatMap { it.split("[ ;,]+".toRegex()).drop(1) }
+        .map(String::trim)
+
     return (deps + annotDeps).distinct()
 }
 
+data class MavenRepo(val id: String, val url: String)
+
+fun collectRepos(scriptText: List<String>): List<MavenRepo> {
+    val dependsOnMavenPrefix = "@file:MavenRepository("
+    // only supported annotation format for now
+
+    // @file:MavenRepository("imagej", "http://maven.imagej.net/content/repositories/releases/")
+    return scriptText
+        .filter { it.startsWith(dependsOnMavenPrefix) }
+        .map { it.replaceFirst(dependsOnMavenPrefix, "").split(")")[0] }
+        .map { it.split(",").map { it.trim(' ', '"') }.let { MavenRepo(it[0], it[1]) } }
+
+    // todo add credential support https://stackoverflow.com/questions/36282168/how-to-add-custom-maven-repository-to-gradle
+}
+
 
 fun containsKscriptAnnotation(line: String) =
-        listOf("DependsOn", "KotlinOpts", "Include", "EntryPoint").any { line.startsWith("@file:${it}(") }
+    listOf("DependsOn", "KotlinOpts", "Include", "EntryPoint", "MavenRepository", "DependsOnMaven")
+        .any { line.startsWith("@file:${it}(") }
 
 
 fun collectRuntimeOptions(scriptText: List<String>): String {
     val koptsPrefix = "//KOTLIN_OPTS "
 
     var kotlinOpts = scriptText.
-            filter { it.startsWith(koptsPrefix) }.
-            map { it.replaceFirst(koptsPrefix, "").trim() }
+        filter { it.startsWith(koptsPrefix) }.
+        map { it.replaceFirst(koptsPrefix, "").trim() }
 
     //support for @file:KotlinOpts see #47
     val annotatonPrefix = "@file:KotlinOpts("
     kotlinOpts += scriptText
-            .filter { it.startsWith(annotatonPrefix) }
-            .map { it.replaceFirst(annotatonPrefix, "").split(")")[0] }
-            .map { it.trim(' ', '"') }
+        .filter { it.startsWith(annotatonPrefix) }
+        .map { it.replaceFirst(annotatonPrefix, "").split(")")[0] }
+        .map { it.trim(' ', '"') }
 
 
     // Append $KSCRIPT_KOTLIN_OPTS if defined in the parent environment

src/test/kotlin/Tests.kt

@@ -1,5 +1,7 @@
 import io.kotlintest.matchers.shouldBe
+import kscript.app.MavenRepo
 import kscript.app.collectDependencies
+import kscript.app.collectRepos
 import kscript.app.collectRuntimeOptions
 import org.junit.Test
 
@@ -13,14 +15,14 @@ class Tests {
     @Test
     fun directiveDependencyCollect() {
         val lines = listOf(
-                "//DEPS de.mpicbg.scicomp.joblist:joblist-kotlin:1.1, de.mpicbg.scicomp:kutils:0.7",
-                "//DEPS  log4j:log4j:1.2.14"
+            "//DEPS de.mpicbg.scicomp.joblist:joblist-kotlin:1.1, de.mpicbg.scicomp:kutils:0.7",
+            "//DEPS  log4j:log4j:1.2.14"
         )
 
         val expected = listOf(
-                "de.mpicbg.scicomp.joblist:joblist-kotlin:1.1",
-                "de.mpicbg.scicomp:kutils:0.7",
-                "log4j:log4j:1.2.14"
+            "de.mpicbg.scicomp.joblist:joblist-kotlin:1.1",
+            "de.mpicbg.scicomp:kutils:0.7",
+            "log4j:log4j:1.2.14"
         )
 
         collectDependencies(lines) shouldBe expected
@@ -29,28 +31,43 @@ class Tests {
     @Test
     fun mixedDependencyCollect() {
         val lines = listOf(
-                "//DEPS de.mpicbg.scicomp.joblist:joblist-kotlin:1.1, de.mpicbg.scicomp:kutils:0.7",
-                """@file:DependsOn("log4j:log4j:1.2.14")"""
+            "//DEPS de.mpicbg.scicomp.joblist:joblist-kotlin:1.1, de.mpicbg.scicomp:kutils:0.7",
+            """@file:DependsOn("log4j:log4j:1.2.14")"""
         )
 
         val expected = listOf(
-                "de.mpicbg.scicomp.joblist:joblist-kotlin:1.1",
-                "de.mpicbg.scicomp:kutils:0.7",
-                "log4j:log4j:1.2.14",
-                "com.github.holgerbrandl:kscript-annotations:1.0"
+            "de.mpicbg.scicomp.joblist:joblist-kotlin:1.1",
+            "de.mpicbg.scicomp:kutils:0.7",
+            "log4j:log4j:1.2.14",
+            "com.github.holgerbrandl:kscript-annotations:1.1"
         )
 
         collectDependencies(lines) shouldBe expected
     }
 
 
+    @Test
+    fun customRepo() {
+        val lines = listOf(
+            """@file:MavenRepository("imagej-releases", "http://maven.imagej.net/content/repositories/releases" ) // crazy comment""",
+            """@file:DependsOnMaven("net.clearvolume:cleargl:2.0.1")""",
+            """println("foo")"""
+        )
+
+        val expected = listOf(
+            MavenRepo("imagej-releases", "http://maven.imagej.net/content/repositories/releases")
+        )
+
+        collectRepos(lines) shouldBe expected
+    }
+
 
     // combine kotlin opts spread over multiple lines
     @Test
     fun optsCollect() {
         val lines = listOf(
-                "//KOTLIN_OPTS -foo 3 'some file.txt'",
-                "//KOTLIN_OPTS  --bar"
+            "//KOTLIN_OPTS -foo 3 'some file.txt'",
+            "//KOTLIN_OPTS  --bar"
         )
 
         collectRuntimeOptions(lines) shouldBe "-foo 3 'some file.txt' --bar"
@@ -59,8 +76,8 @@ class Tests {
     @Test
     fun annotOptsCollect() {
         val lines = listOf(
-                "//KOTLIN_OPTS -foo 3 'some file.txt'",
-                """@file:KotlinOpts("--bar")"""
+            "//KOTLIN_OPTS -foo 3 'some file.txt'",
+            """@file:KotlinOpts("--bar")"""
         )
 
         collectRuntimeOptions(lines) shouldBe "-foo 3 'some file.txt' --bar"

test/resources/custom_mvn_repo_annot.kts

@@ -0,0 +1,12 @@
+#!/usr/bin/env kscript
+
+@file:MavenRepository("imagej-releases","http://maven.imagej.net/content/repositories/releases" )
+
+@file:DependsOnMaven("net.clearvolume:cleargl:2.0.1")
+
+import cleargl.GLVector
+
+GLVector(1.3f)
+
+
+println("kscript with annotations rocks!")