Implement more general "apply defaults" functionality for host configurations

This commit is contained in:
Ilya Chernikov
2019-09-03 14:46:28 +02:00
parent e3187217ee
commit f350c24846
9 changed files with 71 additions and 29 deletions
+1
View File
@@ -524,6 +524,7 @@ tasks {
dependsOn("dist") dependsOn("dist")
dependsOn(":kotlin-script-util:test") dependsOn(":kotlin-script-util:test")
dependsOn(":kotlin-scripting-compiler:test") dependsOn(":kotlin-scripting-compiler:test")
dependsOn(":kotlin-scripting-common:test")
dependsOn(":kotlin-scripting-jvm-host-test:test") dependsOn(":kotlin-scripting-jvm-host-test:test")
dependsOn(":kotlin-scripting-jsr223-test:test") dependsOn(":kotlin-scripting-jsr223-test:test")
dependsOn(":kotlin-scripting-jvm-host-test:embeddableTest") dependsOn(":kotlin-scripting-jvm-host-test:embeddableTest")
+2 -1
View File
@@ -11,11 +11,12 @@ dependencies {
compileOnly(project(":kotlin-reflect-api")) compileOnly(project(":kotlin-reflect-api"))
compile(commonDep("org.jetbrains.kotlinx", "kotlinx-coroutines-core")) { isTransitive = false } compile(commonDep("org.jetbrains.kotlinx", "kotlinx-coroutines-core")) { isTransitive = false }
runtime(project(":kotlin-reflect")) runtime(project(":kotlin-reflect"))
testCompile(commonDep("junit"))
} }
sourceSets { sourceSets {
"main" { projectDefault() } "main" { projectDefault() }
"test" {} "test" { projectDefault() }
} }
publish() publish()
@@ -23,23 +23,23 @@ private abstract class DummyScriptTemplate
/** /**
* Creates compilation configuration from annotated script base class * Creates compilation configuration from annotated script base class
* @param baseClassType the annotated script base class to construct the configuration from * @param baseClassType the annotated script base class to construct the configuration from
* @param hostConfiguration scripting host configuration properties * @param baseHostConfiguration scripting host configuration properties
* @param contextClass optional context class to extract classloading strategy from * @param contextClass optional context class to extract classloading strategy from
* @param body optional configuration function to add more properties to the compilation configuration * @param body optional configuration function to add more properties to the compilation configuration
*/ */
fun createCompilationConfigurationFromTemplate( fun createCompilationConfigurationFromTemplate(
baseClassType: KotlinType, baseClassType: KotlinType,
hostConfiguration: ScriptingHostConfiguration, baseHostConfiguration: ScriptingHostConfiguration,
contextClass: KClass<*> = ScriptCompilationConfiguration::class, contextClass: KClass<*> = ScriptCompilationConfiguration::class,
body: ScriptCompilationConfiguration.Builder.() -> Unit = {} body: ScriptCompilationConfiguration.Builder.() -> Unit = {}
): ScriptCompilationConfiguration { ): ScriptCompilationConfiguration {
val templateClass: KClass<*> = baseClassType.getTemplateClass(hostConfiguration, contextClass) val templateClass: KClass<*> = baseClassType.getTemplateClass(baseHostConfiguration, contextClass)
val mainAnnotation: KotlinScript = templateClass.kotlinScriptAnnotation val mainAnnotation: KotlinScript = templateClass.kotlinScriptAnnotation
return ScriptCompilationConfiguration(scriptConfigInstance(mainAnnotation.compilationConfiguration)) { return ScriptCompilationConfiguration(scriptConfigInstance(mainAnnotation.compilationConfiguration)) {
hostConfiguration(hostConfiguration) hostConfiguration.update { it.withDefaultsFrom(baseHostConfiguration) }
propertiesFromTemplate(templateClass, baseClassType, mainAnnotation) propertiesFromTemplate(templateClass, baseClassType, mainAnnotation)
body() body()
} }
@@ -48,23 +48,23 @@ fun createCompilationConfigurationFromTemplate(
/** /**
* Creates evaluation configuration from annotated script base class * Creates evaluation configuration from annotated script base class
* @param baseClassType the annotated script base class to construct the configuration from * @param baseClassType the annotated script base class to construct the configuration from
* @param hostConfiguration scripting host configuration properties * @param baseHostConfiguration scripting host configuration properties
* @param contextClass optional context class to extract classloading strategy from * @param contextClass optional context class to extract classloading strategy from
* @param body optional configuration function to add more properties to the evaluation configuration * @param body optional configuration function to add more properties to the evaluation configuration
*/ */
fun createEvaluationConfigurationFromTemplate( fun createEvaluationConfigurationFromTemplate(
baseClassType: KotlinType, baseClassType: KotlinType,
hostConfiguration: ScriptingHostConfiguration, baseHostConfiguration: ScriptingHostConfiguration,
contextClass: KClass<*> = ScriptEvaluationConfiguration::class, contextClass: KClass<*> = ScriptEvaluationConfiguration::class,
body: ScriptEvaluationConfiguration.Builder.() -> Unit = {} body: ScriptEvaluationConfiguration.Builder.() -> Unit = {}
): ScriptEvaluationConfiguration { ): ScriptEvaluationConfiguration {
val templateClass: KClass<*> = baseClassType.getTemplateClass(hostConfiguration, contextClass) val templateClass: KClass<*> = baseClassType.getTemplateClass(baseHostConfiguration, contextClass)
val mainAnnotation = templateClass.kotlinScriptAnnotation val mainAnnotation = templateClass.kotlinScriptAnnotation
return ScriptEvaluationConfiguration(scriptConfigInstance(mainAnnotation.evaluationConfiguration)) { return ScriptEvaluationConfiguration(scriptConfigInstance(mainAnnotation.evaluationConfiguration)) {
hostConfiguration(hostConfiguration) hostConfiguration.update { it.withDefaultsFrom(baseHostConfiguration) }
body() body()
} }
} }
@@ -43,6 +43,16 @@ fun ScriptingHostConfiguration?.with(body: ScriptingHostConfiguration.Builder.()
return if (newConfiguration != this) newConfiguration else this return if (newConfiguration != this) newConfiguration else this
} }
/**
* Add the values not explicitly set in the receiver from the [defaults] configuration
*/
fun ScriptingHostConfiguration?.withDefaultsFrom(defaults: ScriptingHostConfiguration): ScriptingHostConfiguration =
when {
this == defaults || defaults.isEmpty() -> this ?: defaults
this == null || this.isEmpty() -> defaults
else -> ScriptingHostConfiguration(defaults, this)
}
/** /**
* The list of all dependencies required for the script base class and refinement callbacks * The list of all dependencies required for the script base class and refinement callbacks
*/ */
@@ -123,6 +123,10 @@ open class PropertiesCollection(protected var properties: Map<Key<*>, Any?> = em
} }
} }
fun <T> PropertiesCollection.Key<T>.update(body: (T?) -> T?) {
putIfNotNull(body(data[this]?.let { it as T }))
}
// generic for lists // generic for lists
fun <T> PropertiesCollection.Key<in List<T>>.putIfAny(vals: Iterable<T>?) { fun <T> PropertiesCollection.Key<in List<T>>.putIfAny(vals: Iterable<T>?) {
@@ -0,0 +1,42 @@
/*
* Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package kotlin.script.experimental.test
import junit.framework.TestCase
import org.junit.Test
import kotlin.script.experimental.host.ScriptingHostConfiguration
import kotlin.script.experimental.host.ScriptingHostConfigurationKeys
import kotlin.script.experimental.host.withDefaultsFrom
import kotlin.script.experimental.util.PropertiesCollection
class ConfigurationsTest : TestCase() {
@Test
fun testHostConfigWithDefaultsFrom() {
val c0 = ScriptingHostConfiguration()
val c1 = ScriptingHostConfiguration {
p1(1)
}
val c2 = ScriptingHostConfiguration {
p1(2)
p2("yes")
}
assertEquals(c1, c1.withDefaultsFrom(c0))
assertEquals(c1, c0.withDefaultsFrom(c1))
assertEquals(c1, c1.withDefaultsFrom(c1))
val c1c2 = c1.withDefaultsFrom(c2)
val c2c1 = c2.withDefaultsFrom(c1)
assertEquals(1, c1c2[ScriptingHostConfiguration.p1])
assertEquals("yes", c1c2[ScriptingHostConfiguration.p2])
assertEquals(2, c2c1[ScriptingHostConfiguration.p1])
}
}
private val ScriptingHostConfigurationKeys.p1 by PropertiesCollection.key<Int>(-1)
private val ScriptingHostConfigurationKeys.p2 by PropertiesCollection.key<String>("-")
@@ -1,16 +0,0 @@
/*
* Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package kotlin.script.experimental.jvmhost.impl
import kotlin.script.experimental.host.ScriptingHostConfiguration
import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration
fun ScriptingHostConfiguration.withDefaults(): ScriptingHostConfiguration =
if (this == defaultJvmScriptingHostConfiguration) {
this
} else {
ScriptingHostConfiguration(defaultJvmScriptingHostConfiguration, this)
}
@@ -11,15 +11,15 @@ import org.jetbrains.kotlin.scripting.compiler.plugin.ScriptJvmCompilerProxy
import org.jetbrains.kotlin.scripting.compiler.plugin.impl.ScriptJvmCompilerIsolated import org.jetbrains.kotlin.scripting.compiler.plugin.impl.ScriptJvmCompilerIsolated
import kotlin.script.experimental.api.* import kotlin.script.experimental.api.*
import kotlin.script.experimental.host.ScriptingHostConfiguration import kotlin.script.experimental.host.ScriptingHostConfiguration
import kotlin.script.experimental.host.withDefaultsFrom
import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration
import kotlin.script.experimental.jvmhost.impl.withDefaults
open class JvmScriptCompiler( open class JvmScriptCompiler(
baseHostConfiguration: ScriptingHostConfiguration = defaultJvmScriptingHostConfiguration, baseHostConfiguration: ScriptingHostConfiguration = defaultJvmScriptingHostConfiguration,
compilerProxy: ScriptJvmCompilerProxy? = null compilerProxy: ScriptJvmCompilerProxy? = null
) : ScriptCompiler { ) : ScriptCompiler {
val hostConfiguration = baseHostConfiguration.withDefaults() val hostConfiguration = baseHostConfiguration.withDefaultsFrom(defaultJvmScriptingHostConfiguration)
val compilerProxy: ScriptJvmCompilerProxy = compilerProxy ?: ScriptJvmCompilerIsolated(hostConfiguration) val compilerProxy: ScriptJvmCompilerProxy = compilerProxy ?: ScriptJvmCompilerIsolated(hostConfiguration)
@@ -13,8 +13,8 @@ import java.util.concurrent.locks.ReentrantReadWriteLock
import kotlin.concurrent.write import kotlin.concurrent.write
import kotlin.script.experimental.api.* import kotlin.script.experimental.api.*
import kotlin.script.experimental.host.ScriptingHostConfiguration import kotlin.script.experimental.host.ScriptingHostConfiguration
import kotlin.script.experimental.host.withDefaultsFrom
import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration import kotlin.script.experimental.jvm.defaultJvmScriptingHostConfiguration
import kotlin.script.experimental.jvmhost.impl.withDefaults
/** /**
* REPL Compilation wrapper for "legacy" REPL APIs defined in the org.jetbrains.kotlin.cli.common.repl package * REPL Compilation wrapper for "legacy" REPL APIs defined in the org.jetbrains.kotlin.cli.common.repl package
@@ -23,7 +23,7 @@ class JvmReplCompiler(
val scriptCompilationConfiguration: ScriptCompilationConfiguration, val scriptCompilationConfiguration: ScriptCompilationConfiguration,
val hostConfiguration: ScriptingHostConfiguration = defaultJvmScriptingHostConfiguration, val hostConfiguration: ScriptingHostConfiguration = defaultJvmScriptingHostConfiguration,
val replCompilerProxy: KJvmReplCompilerProxy = KJvmReplCompilerImpl( val replCompilerProxy: KJvmReplCompilerProxy = KJvmReplCompilerImpl(
hostConfiguration.withDefaults() hostConfiguration.withDefaultsFrom(defaultJvmScriptingHostConfiguration)
) )
) : ReplCompiler { ) : ReplCompiler {