Run validation after finalization

Author: ajalt

CHANGELOG.md

@@ -2,25 +2,18 @@
 
 ## [Unreleased]
 ### Added
-- [Bash autocomplete script generation](https://ajalt.github.io/clikt/autocomplete/). A property named
-  `completionCandidates` has been added to `Argument` and `Option` interfaces, and corresponding
-  parameters have been added to the various implementation constructors, as well as the `convert`
-  functions. You can use this to control the values autocomplete that will be suggested.
-- [`option().split()`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/split.html),
-  and the corresponding
-  [`OptionWithValues.valueSplit`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/-option-with-values/value-split.html).
+- [Bash autocomplete script generation](https://ajalt.github.io/clikt/autocomplete/). A property named `completionCandidates` has been added to `Argument` and `Option` interfaces, and corresponding parameters have been added to the various implementation constructors, as well as the `convert` functions. You can use this to control the values autocomplete that will be suggested.
+- [`option().split()`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/split.html), and the corresponding [`OptionWithValues.valueSplit`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/-option-with-values/value-split.html).
 - Marking options as deprecated with [`option().deprecated()`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/deprecated.html)
 - You can manually set the pattern to split envvars on by passing a pattern to the `envvarSplit` parameter of [`option()`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/option.html)
 - [Option groups](https://ajalt.github.io/clikt/documenting/#grouping-options-in-help), [mutually exclusive groups](https://ajalt.github.io/clikt/options/#prompting-for-input), [co-occurring groups](https://ajalt.github.io/clikt/options/#co-occurring-option-groups), and [choice options with groups](https://ajalt.github.io/clikt/options/#choice-options-with-groups)
 
 ### Changed
-- If multiple `--` tokens are present on the command line, all subsequent occurrences after the first are now
-  parsed as positional arguments. Previously, subsequent `--` tokens were skipped.  
-- The `PlaintextHelpFormatter` has been replaced with `CliktHelpFormatter`, which is more
-  customizable. See [the docs](https://ajalt.github.io/clikt/documenting/) for more info, or the 
-  [new sample](samples/ansicolors/README.md) for an example of customizing help output to use ANSI colors.
-- Some of the properties and constructor parameters for [`OptionWithValues`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/-option-with-values/index.html) have changed.
+- If multiple `--` tokens are present on the command line, all subsequent occurrences after the first are now parsed as positional arguments. Previously, subsequent `--` tokens were skipped.  
+- The `PlaintextHelpFormatter` has been replaced with `CliktHelpFormatter`, which is more customizable. See [the docs](https://ajalt.github.io/clikt/documenting/) for more info, or the [new sample](samples/ansicolors/README.md) for an example of customizing help output to use ANSI colors.
+- Some of the properties and constructor parameters for [`OptionWithValues`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.options/-option-with-values/index.html) and [`ProcessedArgument`](https://ajalt.github.io/clikt/api/clikt/com.github.ajalt.clikt.parameters.arguments/-processed-argument/index.html) have changed.
 - The `OptionDelegate` interface has changed, and `GroupableOption` and `ParameterHolder` interfaces have been added to work with option groups.
+- [Parameter validation](https://ajalt.github.io/clikt/parameters/#parameter-validation) now occurs after all parameter delegates have set their values, so the lambdas passed to `validate` may reference other parameters. 
 
 ## [1.7.0] - 2019-03-23
 ### Added

build.gradle

@@ -30,7 +30,7 @@ subprojects {
         compile "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
         testImplementation 'junit:junit:4.12'
-        testImplementation 'io.kotlintest:kotlintest-assertions:3.1.10'
+        testImplementation 'io.kotlintest:kotlintest-assertions:3.3.2'
         testImplementation 'com.github.stefanbirkner:system-rules:1.18.0'
         testImplementation 'com.google.jimfs:jimfs:1.1'
     }

clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/arguments/Argument.kt

@@ -50,10 +50,18 @@ interface Argument {
     /**
      * Called after this command's argv is parsed to transform and store the argument's value.
      *
+     * You cannot refer to other parameter values during this call, since they might not have been
+     * finalized yet.
+     *
      * @param context The context for this parse
      * @param values A possibly empty list of values provided to this argument.
      */
     fun finalize(context: Context, values: List<String>)
+
+    /**
+     * Called after all of a command's parameters have been [finalize]d to perform validation of the final value.
+     */
+    fun postValidate(context: Context)
 }
 
 /** An argument that functions as a property delegate */
@@ -94,6 +102,7 @@ typealias ArgValidator<AllT> = ArgumentTransformContext.(AllT) -> Unit
  *
  * @property transformValue Called in [finalize] to transform each value provided to the argument.
  * @property transformAll Called in [finalize] to transform the list of values to the final type.
+ * @property transformValidator Called after all paramters have been [finalize]d to validate the result of [transformAll]
  */
 class ProcessedArgument<AllT, ValueT>(
         name: String,
@@ -103,7 +112,8 @@ class ProcessedArgument<AllT, ValueT>(
         override val helpTags: Map<String, String>,
         override val completionCandidates: CompletionCandidates,
         val transformValue: ArgValueTransformer<ValueT>,
-        val transformAll: ArgCallsTransformer<AllT, ValueT>
+        val transformAll: ArgCallsTransformer<AllT, ValueT>,
+        val transformValidator: ArgValidator<AllT>
 ) : ArgumentDelegate<AllT> {
     init {
         require(nvalues != 0) { "Arguments cannot have nvalues == 0" }
@@ -130,18 +140,36 @@ class ProcessedArgument<AllT, ValueT>(
         value = transformAll(ctx, values.map { transformValue(ctx, it) })
     }
 
+    override fun postValidate(context: Context) {
+        transformValidator(ArgumentTransformContext(this, context), value)
+    }
+
     /** Create a new argument that is a copy of this one with different transforms. */
     fun <AllT, ValueT> copy(
             transformValue: ArgValueTransformer<ValueT>,
             transformAll: ArgCallsTransformer<AllT, ValueT>,
+            validator: ArgValidator<AllT>,
             name: String = this.name,
             nvalues: Int = this.nvalues,
             required: Boolean = this.required,
             help: String = this.help,
             helpTags: Map<String, String> = this.helpTags,
             completionCandidates: CompletionCandidates = this.completionCandidates
     ): ProcessedArgument<AllT, ValueT> {
-        return ProcessedArgument(name, nvalues, required, help, helpTags, completionCandidates, transformValue, transformAll)
+        return ProcessedArgument(name, nvalues, required, help, helpTags, completionCandidates, transformValue, transformAll, validator)
+    }
+
+    /** Create a new argument that is a copy of this one with the same transforms. */
+    fun copy(
+            validator: ArgValidator<AllT> = this.transformValidator,
+            name: String = this.name,
+            nvalues: Int = this.nvalues,
+            required: Boolean = this.required,
+            help: String = this.help,
+            helpTags: Map<String, String> = this.helpTags,
+            completionCandidates: CompletionCandidates = this.completionCandidates
+    ): ProcessedArgument<AllT, ValueT> {
+        return ProcessedArgument(name, nvalues, required, help, helpTags, completionCandidates, transformValue, transformAll, validator)
     }
 }
 
@@ -150,6 +178,9 @@ internal typealias RawArgument = ProcessedArgument<String, String>
 @PublishedApi
 internal fun <T : Any> defaultAllProcessor(): ArgCallsTransformer<T, T> = { it.single() }
 
+@PublishedApi
+internal fun <T> defaultValidator(): ArgValidator<T> = {}
+
 /**
  * Create a property delegate argument.
  *
@@ -162,8 +193,22 @@ internal fun <T : Any> defaultAllProcessor(): ArgCallsTransformer<T, T> = { it.s
  * @param helpTags Extra information about this option to pass to the help formatter
  */
 @Suppress("unused")
-fun CliktCommand.argument(name: String = "", help: String = "", helpTags: Map<String, String> = emptyMap()): RawArgument {
-    return ProcessedArgument(name, 1, true, help, helpTags, CompletionCandidates.None, { it }, defaultAllProcessor())
+fun CliktCommand.argument(
+        name: String = "",
+        help: String = "",
+        helpTags: Map<String, String> = emptyMap()
+): RawArgument {
+    return ProcessedArgument(
+            name = name,
+            nvalues = 1,
+            required = true,
+            help = help,
+            helpTags = helpTags,
+            completionCandidates = CompletionCandidates.None,
+            transformValue = { it },
+            transformAll = defaultAllProcessor(),
+            transformValidator = defaultValidator()
+    )
 }
 
 /**
@@ -182,7 +227,7 @@ fun <AllInT, ValueT, AllOutT> ProcessedArgument<AllInT, ValueT>.transformAll(
         nvalues: Int? = null,
         required: Boolean? = null,
         transform: ArgCallsTransformer<AllOutT, ValueT>): ProcessedArgument<AllOutT, ValueT> {
-    return copy(transformValue, transform,
+    return copy(transformValue, transform, defaultValidator(),
             nvalues = nvalues ?: this.nvalues,
             required = required ?: this.required)
 }
@@ -316,7 +361,7 @@ inline fun <T : Any> RawArgument.convert(
             fail(err.message ?: "")
         }
     }
-    return copy(conv, defaultAllProcessor(), completionCandidates = completionCandidates)
+    return copy(conv, defaultAllProcessor(), defaultValidator(), completionCandidates = completionCandidates)
 }
 
 /**
@@ -335,9 +380,7 @@ inline fun <T : Any> RawArgument.convert(
  */
 fun <AllT : Any, ValueT> ProcessedArgument<AllT, ValueT>.validate(validator: ArgValidator<AllT>)
         : ArgumentDelegate<AllT> {
-    return copy(transformValue, {
-        transformAll(it).also { validator(ArgumentTransformContext(argument, context), it) }
-    })
+    return copy(validator)
 }
 
 /**
@@ -357,7 +400,5 @@ fun <AllT : Any, ValueT> ProcessedArgument<AllT, ValueT>.validate(validator: Arg
 @JvmName("nullableValidate")
 fun <AllT : Any, ValueT> ProcessedArgument<AllT?, ValueT>.validate(validator: ArgValidator<AllT>)
         : ArgumentDelegate<AllT?> {
-    return copy(transformValue, {
-        transformAll(it).also { if (it != null) validator(ArgumentTransformContext(argument, context), it) }
-    })
+    return copy({ if (it != null) validator(it) })
 }

clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/groups/ChoiceGroup.kt

@@ -8,8 +8,6 @@ import com.github.ajalt.clikt.core.MissingParameter
 import com.github.ajalt.clikt.parameters.internal.NullableLateinit
 import com.github.ajalt.clikt.parameters.options.Option
 import com.github.ajalt.clikt.parameters.options.RawOption
-import com.github.ajalt.clikt.parameters.options.option
-import com.github.ajalt.clikt.parameters.options.required
 import com.github.ajalt.clikt.parsers.OptionParser
 import kotlin.properties.ReadOnlyProperty
 import kotlin.reflect.KProperty
@@ -22,6 +20,7 @@ class ChoiceGroup<GroupT : OptionGroup, OutT>(
     override val groupName: String? = null
     override val groupHelp: String? = null
     private var value: OutT by NullableLateinit("Cannot read from option delegate before parsing command line")
+    private var chosenGroup: OptionGroup? = null
 
     override fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, OutT> {
         option.provideDelegate(thisRef, prop) // infer the option name and register it
@@ -52,8 +51,13 @@ class ChoiceGroup<GroupT : OptionGroup, OutT>(
                         context
                 )
         group.finalize(context, invocationsByOption.filterKeys { it in group.options })
+        chosenGroup = group
         value = transform(group)
     }
+
+    override fun postValidate(context: Context) {
+        chosenGroup?.options?.forEach { it.postValidate(context) }
+    }
 }
 
 /**
@@ -68,10 +72,7 @@ class ChoiceGroup<GroupT : OptionGroup, OutT>(
  * @see com.github.ajalt.clikt.parameters.types.choice
  */
 fun <T : OptionGroup> RawOption.groupChoice(choices: Map<String, T>): ChoiceGroup<T, T?> {
-    return ChoiceGroup(
-            copy(transformValue, transformEach, transformAll, completionCandidates = Fixed(choices.keys)),
-            choices
-    ) { it }
+    return ChoiceGroup(copy(completionCandidates = Fixed(choices.keys)), choices) { it }
 }
 
 /**

clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/groups/CoOccurringOptionGroup.kt

@@ -16,6 +16,7 @@ class CoOccurringOptionGroup<GroupT : OptionGroup, OutT>(
     override val groupName: String? get() = group.groupName
     override val groupHelp: String? get() = group.groupHelp
     private var value: OutT by NullableLateinit("Cannot read from option delegate before parsing command line")
+    private var occurred = false
 
     override fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, OutT> {
         thisRef.registerOptionGroup(this)
@@ -30,10 +31,14 @@ class CoOccurringOptionGroup<GroupT : OptionGroup, OutT>(
     override fun getValue(thisRef: CliktCommand, property: KProperty<*>): OutT = value
 
     override fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionParser.Invocation>>) {
-        val occurred = invocationsByOption.isNotEmpty()
+        occurred = invocationsByOption.isNotEmpty()
         if (occurred) group.finalize(context, invocationsByOption)
         value = transform(occurred, group, context)
     }
+
+    override fun postValidate(context: Context) {
+        if (occurred) group.postValidate(context)
+    }
 }
 
 /**

clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/groups/MutuallyExclusiveOption.kt

@@ -19,6 +19,19 @@ class MutuallyExclusiveOptions<OptT : Any, OutT>(
 
     private var value: OutT by NullableLateinit("Cannot read from group delegate before parsing command line")
 
+    override operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, OutT> {
+        thisRef.registerOptionGroup(this)
+
+        for (option in options) {
+            require(option.names.isNotEmpty()) { "must specify names for all options in a group" }
+            option.parameterGroup = this
+            option.groupName = groupName
+            thisRef.registerOption(option)
+        }
+
+        return this
+    }
+
     override fun getValue(thisRef: CliktCommand, property: KProperty<*>): OutT = value
 
     override fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionParser.Invocation>>) {
@@ -27,21 +40,20 @@ class MutuallyExclusiveOptions<OptT : Any, OutT>(
             option.finalize(context, invocations)
         }
 
+        for (option in options) {
+            if (option !in invocationsByOption) {
+                option.finalize(context, emptyList())
+            }
+        }
+
         val values = options.mapNotNull { it.value }
         value = transformAll(values)
     }
 
-    override operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, OutT> {
-        thisRef.registerOptionGroup(this)
-
+    override fun postValidate(context: Context) {
         for (option in options) {
-            require(option.names.isNotEmpty()) { "must specify names for all options in a group" }
-            option.parameterGroup = this
-            option.groupName = groupName
-            thisRef.registerOption(option)
+            option.postValidate(context)
         }
-
-        return this
     }
 
     fun <T> copy(transformAll: (List<OptT>) -> T) = MutuallyExclusiveOptions(options, groupName, groupHelp, transformAll)

clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/groups/ParameterGroup.kt

@@ -11,14 +11,6 @@ import kotlin.properties.ReadOnlyProperty
 import kotlin.reflect.KProperty
 
 interface ParameterGroup {
-    /**
-     * Called after this command's argv is parsed and all options are validated to validate the group constraints.
-     *
-     * @param context The context for this parse
-     * @param invocationsByOption The invocations of options in this group.
-     */
-    fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionParser.Invocation>>)
-
     /**
      * The name of the group, or null if parameters in the group should not be separated from other
      * parameters in the help output.
@@ -37,6 +29,19 @@ interface ParameterGroup {
             val h = groupHelp
             return if (n == null || h == null) null else HelpFormatter.ParameterHelp.Group(n, h)
         }
+
+    /**
+     * Called after this command's argv is parsed and all options are validated to validate the group constraints.
+     *
+     * @param context The context for this parse
+     * @param invocationsByOption The invocations of options in this group.
+     */
+    fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionParser.Invocation>>)
+
+    /**
+     * Called after all of a command's parameters have been [finalize]d to perform validation of the final values.
+     */
+    fun postValidate(context: Context)
 }
 
 interface ParameterGroupDelegate<out T> : ParameterGroup, ReadOnlyProperty<CliktCommand, T> {
@@ -92,6 +97,8 @@ open class OptionGroup(
         // Finalize options not provided on the command line so that they can apply default values etc.
         options.forEach { o -> if (o !in invocationsByOption) o.finalize(context, emptyList()) }
     }
+
+    override fun postValidate(context: Context) = options.forEach { it.postValidate(context) }
 }
 
 operator fun <T : OptionGroup> T.provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T> {

clikt/src/main/kotlin/com/github/ajalt/clikt/parameters/options/EagerOption.kt

@@ -28,6 +28,7 @@ class EagerOption(
     override val secondaryNames: Set<String> get() = emptySet()
     override val parser: OptionParser = FlagOptionParser
     override val metavar: String? get() = null
+    override fun postValidate(context: Context) {}
     override fun finalize(context: Context, invocations: List<OptionParser.Invocation>) {
         this.callback(OptionTransformContext(this, context))
     }