Merge branch 'kscript4'

# Conflicts:
#	build.gradle.kts

Author: holgerbrandl

CHANGES.md

@@ -0,0 +1,50 @@
+* Improved test_suite.sh
+  * Automatic setting up of test environment (assert.sh, test directories) 
+  * Automatic compilation
+  * idea - script to help to test idea use cases
+  * Script setup_environment.sh can be used for local testing
+  * Some script tests moved to Unit Tests 
+
+* Improved Unit Tests
+  * Several new Unit tests
+  * New Unit Tests can be created much easier (Major point why modularization makes sense)
+ 
+* Improved Logging
+  * Silent mode / Development mode logging
+
+* Modularisation of source code
+  * Removed duplication
+  * Code divided in logical pieces and moved to packages 
+  * Script resolution creates immutable objects
+
+* Build script
+  * Updated Gradle to version 7.3 and shadowJar to 6.1.0
+  * Fixes in build file
+
+* Performance
+  * Much less IO operations - that should contribute to better performance
+
+* Updated Kotlin to 1.5.31, but only for compiler, not kotlin-scripting. It's far from optimal, but it is not possible to move fully to Kotlin 1.5 or even 1.6, because of the issues with resolution of artifacts in latest kotlin-scripting. I have put report here: https://youtrack.jetbrains.com/issue/KT-49511
+
+* Fixed a lot of IDE warnings in code
+
+* Packaging - gradle file converted to Kotlin; still does not work, but it was like that before anyway
+
+* Changes for kscript dir allow simple implementation of config file if needed. (.kscript/kscript.config); Not implemented by me, but might be useful e.g. for storing preambles
+
+INCOMPATIBLE CHANGES:
+* In annotations the only allowed delimiter is coma "," (to allow options with arguments, separated by space)
+* Resolution of env variables is more restrictive - only vars expected by kscript can be resolved (for security - it's not good to include arbitrary strings from user env into the script)
+* Reworked caching mechanism
+* Dropped cache for resolution of artifacts - I can not observe change in resolution time. In fact .m2 repository is already kind of cache, so it should not be needed to add another one.  
+
+SUGGESTIONS:
+* I would drop old annotations based on comments or at least depreciate them 
+* It's worthy to consider dropping ability to reference script by $HOME and by '/'. It will break other scripts if used in web scripts.
+* There might be duplicate names when loading even different files from URI. Then when the idea project creates source dir it will fail: e.g. idea project from include_variations.kts. Requires some other way of setting up IDEA project.
+
+SUGGESTIONS - MERGE:
+* Please do "Squash Merge" - there is a lot of changes and experiments in code - no reason to keep them in log
+* One test in ScriptResolverTest is @Disabled. It should be enabled and committed again after merge, so that references to URLs are correct
+* I would suggest to do release of kscript 4.0-beta for better tests of new implementation.
+* 

NEWS.md

@@ -237,4 +237,4 @@ Other changes
 
 ## v1.0
 
-Initial Release
+Initial Release

README.md

@@ -483,6 +483,10 @@ On the other hand this doesn't embed dependencies within the script("fat jar"),
 FAQ
 ---
 
+### How to edit kscript in VS Code?
+
+See https://magnusgunnarsson.se/offentlig/kscript-in-visual-studio-code-vsc/ for a walkthrough and the required editor configuration.
+
 ### Why is `kscript` not calling the main method in my `.kts` script?
 
 There is [no need](https://kotlinlang.org/docs/tutorials/command-line.html#using-the-command-line-to-run-scripts) for a `main` method in a Kotlin script. Kotlin `*.kts` scripts can be more simplistic compared to more common kotlin `*.kt` source files. The former work without a `main` method by directly running the provided code from top to bottom. E.g.

build.gradle.kts

@@ -1,9 +1,13 @@
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+
+val kotlinVersion: String = "1.6.20"
 
 plugins {
-    kotlin("jvm") version "1.4.32"
+    kotlin("jvm") version "1.6.20"
     application
-    id("com.github.johnrengelman.shadow") version "5.2.0"
+    id("com.github.johnrengelman.shadow") version "6.1.0"
 }
 
 repositories {
@@ -12,23 +16,49 @@ repositories {
 
 group = "com.github.holgerbrandl.kscript.launcher"
 
-//val kotlinVersion: String by rootProject.extra
-val kotlinVersion: String ="1.4.32"
+tasks.test {
+    useJUnitPlatform()
+
+    testLogging {
+        events(TestLogEvent.FAILED); exceptionFormat = TestExceptionFormat.FULL
+    }
+}
+
+tasks.withType<Test> {
+    addTestListener(object : TestListener {
+        override fun beforeSuite(suite: TestDescriptor) { logger.quiet("\nTest class: ${suite.displayName}") }
+        override fun beforeTest(testDescriptor: TestDescriptor) {}
+        override fun afterTest(testDescriptor: TestDescriptor, result: TestResult) {
+            logger.quiet("${String.format( "%-60s - %-10s", testDescriptor.name, result.resultType )} ")
+        }
+
+        override fun afterSuite(suite: TestDescriptor, result: TestResult) {}
+    })
+}
+
 val launcherClassName: String ="kscript.app.KscriptKt"
 
 dependencies {
-    compile("com.offbytwo:docopt:0.6.0.20150202")
+    implementation("com.offbytwo:docopt:0.6.0.20150202")
 
     implementation("org.jetbrains.kotlin:kotlin-scripting-common:$kotlinVersion")
     implementation("org.jetbrains.kotlin:kotlin-reflect:$kotlinVersion")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.0-RC3")
+
     implementation("org.jetbrains.kotlin:kotlin-scripting-jvm:$kotlinVersion")
     implementation("org.jetbrains.kotlin:kotlin-scripting-dependencies:$kotlinVersion")
     implementation("org.jetbrains.kotlin:kotlin-scripting-dependencies-maven:$kotlinVersion")
 
-    compile("org.slf4j:slf4j-nop:1.7.30")
+    implementation("commons-io:commons-io:2.11.0")
+    implementation("commons-codec:commons-codec:1.15")
+
+    implementation("org.slf4j:slf4j-nop:1.7.32")
+
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.8.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-params:5.8.2")
+    testImplementation("com.willowtreeapps.assertk:assertk-jvm:0.25")
+    testImplementation("io.mockk:mockk:1.12.1")
 
-    testImplementation("junit:junit:4.12")
-    testImplementation( "io.kotlintest:kotlintest:2.0.7")
     testImplementation(kotlin("script-runtime"))
 }
 

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists