Zwischenstand

This commit is contained in:
Hartmut Bauer committed 2025-12-20 14:52:09 +01:00
1 parent c81f3ea29e
commit 907e8c7770
20 files changed
+1043 -105

No files matched your search

+1
View File
@@ -5,6 +5,7 @@
<option name="linkedExternalProjectsSettings">
<GradleProjectSettings>
<option name="externalProjectPath" value="$PROJECT_DIR$" />
<option name="gradleJvm" value="#JAVA_HOME" />
<option name="modules">
<set>
<option value="$PROJECT_DIR$" />
-5
View File
@@ -1,5 +0,0 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
</profile>
</component>
+4 -3
View File
@@ -7,10 +7,11 @@
<option name="jvmTarget" value="21" />
</component>
<component name="KotlinCommonCompilerArguments">
<option name="apiVersion" value="2.1" />
<option name="languageVersion" value="2.1" />
<option name="apiVersion" value="2.3" />
<option name="languageVersion" value="2.3" />
</component>
<component name="KotlinJpsPluginSettings">
<option name="version" value="2.1.10" />
<option name="externalSystemId" value="Gradle" />
<option name="version" value="2.3.0" />
</component>
</project>
+1 -19
View File
@@ -4,23 +4,5 @@
<component name="FrameworkDetectionExcludesConfiguration">
<file type="web" url="file://$PROJECT_DIR$" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" project-jdk-name="21" project-jdk-type="JavaSDK" />
<component name="ScriptDefinitionSettings">
<option name="settings">
<list>
<ScriptDefinitionSetting>
<option name="definitionId" value="org.jetbrains.kotlin.mainKts.MainKtsScript" />
</ScriptDefinitionSetting>
<ScriptDefinitionSetting>
<option name="definitionId" value="kotlin.Any" />
</ScriptDefinitionSetting>
<ScriptDefinitionSetting>
<option name="definitionId" value="kotlin.Any" />
</ScriptDefinitionSetting>
</list>
</option>
</component>
<component name="TaskProjectConfiguration">
<server type="Redmine" url="https://redmine.keinekekse.net" />
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_25" project-jdk-name="21" project-jdk-type="JavaSDK" />
</project>
+14 -1
View File
@@ -1,3 +1,7 @@
@file:OptIn(ExperimentalKotlinGradlePluginApi::class)
import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
plugins {
kotlin("jvm") version masterLibs.versions.kotlinVersion
`java-library`
@@ -16,7 +20,9 @@ repositories {
maven("https://nexus.keinekekse.net/repository/maven-public/")
}
dependencies {}
dependencies {
implementation(masterLibs.kotlinxSerialization)
}
java {
toolchain {
@@ -25,6 +31,13 @@ java {
withSourcesJar()
}
kotlin {
jvmToolchain(masterLibs.versions.javaVersion.get().toInt())
// compilerOptions {
// languageVersion.set(org.jetbrains.kotlin.gradle.dsl.KotlinVersion.KOTLIN_2_3)
// }
}
/* Generierte Dokka-Doku als javadoc.jar ausgeben (s.a. "publishing")
tasks.register<Jar>("dokkaJar") {
group = "build"
+2 -2
View File
@@ -1,3 +1,3 @@
#auto generated
#Sun Mar 09 18:10:28 CET 2025
build.number=66
#Sat Dec 20 00:41:12 CET 2025
build.number=103
+1
View File
@@ -0,0 +1 @@
../../gradle/version-catalog/gradle/libs.versions.toml
Binary file not shown.
+1 -1
View File
@@ -1,6 +1,6 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
Vendored
+3 -6
View File
@@ -1,7 +1,7 @@
#!/bin/sh
#
# Copyright © 2015-2021 the original authors.
# Copyright © 2015 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -114,7 +114,6 @@ case "$( uname )" in #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
@@ -172,7 +171,6 @@ fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
@@ -205,15 +203,14 @@ fi
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
"$@"
# Stop when "xargs" is not available.
Vendored
+1 -2
View File
@@ -70,11 +70,10 @@ goto fail
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
:end
@rem End local scope for the variables with windows NT shell
+3 -2
View File
@@ -7,7 +7,7 @@ pluginManagement {
plugins {
// Apply the foojay-resolver plugin to allow automatic download of JDKs
id("org.gradle.toolchains.foojay-resolver-convention") version "0.9.0"
id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
}
rootProject.name = "util"
@@ -18,7 +18,8 @@ dependencyResolutionManagement {
}
versionCatalogs {
create("masterLibs") {
from("net.keinekekse:version-catalog:55")
// from(files("gradle/masterlibs.versions.toml"))
from("net.keinekekse:version-catalog:100")
}
}
}
@@ -0,0 +1,669 @@
package net.keinekekse.args
import net.keinekekse.args.AbstractCommandLineParser.Companion.NAME_PATTERN
import net.keinekekse.args.AbstractCommandLineParser.Companion.SHORT_NAME_PATTERN
import net.keinekekse.util.ValueDelegate
import kotlin.system.exitProcess
class ArgumentParserException(message: String) : RuntimeException(message) {
companion object {
const val ERROR_MSG = "\n*** ERROR parsing arguments: %s\n"
fun optionExists(name: String) = ArgumentParserException("Option '$name' already exists.")
fun commandExists(name: String) =
ArgumentParserException("Command or alias '$name' already exists.")
fun unknownOption(name: String) = ArgumentParserException("Unknown option '$name'.")
fun unknownCommand(name: String) = ArgumentParserException("Unknown command '$name'.")
fun optionRequiresValue(name: String) =
ArgumentParserException("Option '$name' requires a value.")
fun optionNoValue(name: String) =
ArgumentParserException("Option '$name' does not accept a value.")
fun optionRequired(name: String) = ArgumentParserException("Option '$name' is required.")
fun commandRequired() = ArgumentParserException("At least on command is required.")
fun invalidLongValue(value: String) =
ArgumentParserException("Value '$value' is not a long integer.")
fun invalidShortName(name: String) =
ArgumentParserException("Option short name '$name' is invalid.")
fun invalidName(name: String) = ArgumentParserException("Option name '$name' is invalid.")
fun invalidCommand(name: String) =
ArgumentParserException("Command name '$name' is invalid.")
fun noMoreOptions() = ArgumentParserException("Options can't be added after parsing.")
fun noMoreParsing() = ArgumentParserException("Arguments have already been parsed.")
}
}
class ParameterValue : ValueDelegate<List<String>> {
override var value: List<String>? = null
}
class OptionValue<T> : ValueDelegate<T> {
override var value: T? = null
fun isEmpty() = value == null
}
data class OptionConfig(
val name: String,
val shortName: Char? = null,
val description: String,
val required: Boolean = false,
)
interface OptionConverter<T> {
fun convert(value: String): T
}
sealed class OptionType<T>(
val converter: OptionConverter<T>,
val hasParameter: Boolean = true,
) {
companion object {
private class StringConverter : OptionConverter<String> {
override fun convert(value: String) = value
}
private class LongConverter : OptionConverter<Long> {
override fun convert(value: String) = value.toLongOrNull()
?: throw ArgumentParserException.invalidLongValue(value)
}
private class BooleanConverter : OptionConverter<Boolean> {
override fun convert(value: String) = value == "true"
}
}
open fun createOption(config: OptionConfig): Option<T> = Option(config, this)
fun convertAndSet(value: String, opt: Option<T>) {
opt.setValue(converter.convert(value))
}
object STRING : OptionType<String>(StringConverter())
object LONG : OptionType<Long>(LongConverter())
object BOOLEAN : OptionType<Boolean>(BooleanConverter(), hasParameter = false) {
override fun createOption(config: OptionConfig): Option<Boolean> {
return super.createOption(config).apply { setValue(false) }
}
}
}
data class Option<T>(
val config: OptionConfig,
val type: OptionType<T>,
) {
val optionValue = OptionValue<T>()
fun setValue(value: T) {
optionValue.value = value
}
fun isEmpty() = optionValue.isEmpty()
}
interface AddOptions {
val options: List<Option<Any>>
fun stringOption(config: OptionConfig): OptionValue<String>
fun longOption(config: OptionConfig): OptionValue<Long>
fun boolOption(config: OptionConfig): OptionValue<Boolean>
fun <T> createOption(config: OptionConfig, type: OptionType<T>): OptionValue<T>
}
/**
* Represents a command in a command-line interface that can have options and aliases.
*
* A `Command` is identified by its name and can optionally have a description and alternative names (aliases).
* It also supports adding and managing options that customize its behavior.
*
* @property name The unique name of the command.
* @property description A brief description explaining the purpose of the command.
* @property aliases A list of alternative names (aliases) that can also invoke the command.
*
* @constructor Creates a new `Command` instance with the specified name, description, and optional aliases.
*/
class Command(
val name: String,
val description: String,
val aliases: List<String> = emptyList<String>(),
) : AddOptions {
override val options = mutableListOf<Option<Any>>()
var isSet = false
internal set
/**
* Adds a string-based option to the command configuration.
*
* This method creates a command-line option that accepts a string value, based on the provided
* configuration. The configuration includes details such as the option's name, description,
* and whether it is required.
*
* @param config the configuration object containing details about the string option to be created
* @return an `OptionValue` instance representing the value of the string option
*/
override fun stringOption(config: OptionConfig): OptionValue<String> =
createOption(config, OptionType.STRING)
/**
* Creates a command-line option that accepts a `Long` value based on the provided configuration.
*
* This method utilizes the specified configuration to define details such as the option's name,
* description, and whether it is required. It then generates an option that expects a `Long` value.
*
* @param config the configuration object containing details about the long option to be created
* @return an `OptionValue<Long>` instance representing the value of the long option
*/
override fun longOption(config: OptionConfig): OptionValue<Long> =
createOption(config, OptionType.LONG)
/**
* Creates a command-line option that accepts a Boolean value based on the provided configuration.
*
* This method uses the specified configuration to define details such as the option's name,
* description, and whether it is required. The resulting option accepts a Boolean value, with
* `false` being the default if the option is not explicitly provided in the command-line arguments.
*
* @param config the configuration object containing details about the Boolean option to be created
* @return an `OptionValue<Boolean>` instance representing the value of the Boolean option
*/
override fun boolOption(config: OptionConfig): OptionValue<Boolean> =
createOption(
config.copy(required = false),
OptionType.BOOLEAN
)
override fun <T> createOption(
config: OptionConfig,
type: OptionType<T>,
): OptionValue<T> {
DefaultOptionValidator.validateOption(config, options)
@Suppress("UNCHECKED_CAST")
return type.createOption(config).also { options.add(it as Option<Any>) }.optionValue
}
override operator fun equals(other: Any?): Boolean {
if (other is String) {
return name == other || aliases.contains(other)
}
return super.equals(other)
}
override fun hashCode(): Int {
var result = isSet.hashCode()
result = 31 * result + name.hashCode()
result = 31 * result + description.hashCode()
result = 31 * result + aliases.hashCode()
result = 31 * result + options.hashCode()
return result
}
}
class CommandList(commands: MutableList<Command> = mutableListOf<Command>()) :
MutableList<Command> by commands {
operator fun contains(name: String) = this.any { it.equals(name) }
operator fun get(name: String) =
this.find { it.equals(name) } ?: throw ArgumentParserException.unknownCommand(name)
}
/**
* Parses and handles command-line arguments for commands and their associated options.
*
* The `CommandCommandLineParser` is a specialized parser designed to handle top-level commands,
* each potentially with its own set of options and arguments. It extends `AbstractCommandLineParser`
* to incorporate functionality for parsing commands alongside their arguments and options.
*
* Example:
* ```
* val arguments = CommandCommandLineParser("some info text")
*
* val cmdImport = arguments.addCommand("import", "description", listOf("imp", "in"))
* val auto by cmdImport.boolOption(OptionConfig("auto",'a',"description",false))
*
* // more option & commands ...
*
* val files by arguments.parametersList()
* arguments.parse(args)
*
* when {
* cmdImport.isSet -> {
*
* ```
*
* @constructor accepts a help string that is used to display usage instructions, adding context
* for the users of the command-line tool.
* @param helpString A message string to display as guidance for the tool usage.
*/
class CommandCommandLineParser(private val helpString: String) :
AbstractCommandLineParser(helpString) {
private val commands = CommandList()
/**
* Holds the currently active command after the command-line arguments are parsed.
*
* This variable is updated when a valid command is identified and processed by the parser.
* If no valid command is found during parsing, it remains null.
* This property is read-only externally and can only be set internally by the parser.
*/
var command: Command? = null
private set
override val helpFormatter = CommandHelpFormatter(commands, helpString)
init {
addCommand("help", "Display this help message.")
}
/**
* Adds a new command with the specified name, description, and optional aliases.
*
* This method registers a command to the parser, allowing it to be identified by its name or aliases.
* Throws an exception if commands cannot be added or if the name or aliases conflict with existing commands.
*
* @param name The unique name of the command to be added.
* @param description A brief description of the command.
* @param aliases An optional list of alternative names (aliases) for the command. Defaults to an empty list.
* @return A `Command` instance that can be used to add option for this command.
*/
fun addCommand(name: String, description: String, aliases: List<String> = emptyList()) =
try {
if (isParsed) throw ArgumentParserException.noMoreOptions()
if (commands.contains(name) || aliases.any { commands.contains(it) })
throw ArgumentParserException.commandExists(name)
Command(name, description, aliases).also { commands.add(it) }
} catch (e: ArgumentParserException) {
handleParsingError(e)
}
/**
* Parses an array of command-line arguments and validates the command and its options.
*
* The method processes the first argument as the command and checks whether it is valid.
* If the command is recognized and exists within the predefined set of allowed commands,
* its associated options are then parsed. If an error occurs during parsing, appropriate
* error handling is invoked.
*
* @param args The array of command-line arguments to be parsed. The first element is treated
* as the primary command, and the rest are interpreted as its options.
*/
override fun parse(args: Array<String>) {
if (args.isEmpty()) {
handleParsingError(ArgumentParserException.commandRequired())
}
val cmd = args[0]
if (!argumentParser.parseCommand(cmd)) {
handleParsingError(ArgumentParserException.invalidCommand(cmd))
}
if (cmd !in commands) {
handleParsingError(ArgumentParserException.unknownCommand(cmd))
} else {
parseArguments(args.drop(1).toTypedArray(), commands[cmd].options)
commands[cmd].isSet = true
command = commands[cmd]
}
}
}
/**
* A command-line parser specifically designed to parse and manage options provided
* via command-line arguments. It extends the `AbstractCommandLineParser` and implements
* the `AddOptions` interface.
*
* This parser supports different types of options including string, long, and boolean,
* and ensures validation during the parsing process. It also auto-registers a help option
* to display the usage of the parser.
*
* Example:
* ```
* val arguments = OptionCommandLineParser("some info text")
* val author by arguments.stringOption(OptionConfig("author", 'a', "some author", true))
*
* // more options ...
*
* val files by arguments.parametersList()
* arguments.parse(args)
*
* if (author != null) {
*```
*
* @constructor Creates an `OptionCommandLineParser` with a custom help string.
* @param helpString Descriptive text that is displayed when the help option is invoked.
*/
class OptionCommandLineParser(private val helpString: String) :
AbstractCommandLineParser(helpString), AddOptions {
override val options = mutableListOf<Option<Any>>()
override val helpFormatter = OptionHelpFormatter(options, helpString)
init {
boolOption(OptionConfig("help", 'h', "Display this help message"))
}
/**
* Creates and registers a string-based command-line option based on the provided configuration.
*
* @param config The configuration object containing the name, short name, description,
* and requirements for the string option.
* @return An instance of OptionValue that delegates access to the parsed value of the option.
*/
override fun stringOption(config: OptionConfig): OptionValue<String> =
createOption(config, OptionType.STRING)
/**
* Creates and registers a command-line option that parses and returns a `Long` value.
*
* @param config The configuration object containing the name, short name, description,
* and requirements for the long option.
* @return An instance of `OptionValue<Long>` that provides access to the parsed value
* of the long option.
*/
override fun longOption(config: OptionConfig): OptionValue<Long> =
createOption(config, OptionType.LONG)
/**
* Creates and registers a command-line option that parses and returns a `Boolean` value.
*
* @param config The configuration object containing the name, short name, description,
* and requirements for the boolean option.
* @return An instance of `OptionValue<Boolean>` that provides access to the parsed value
* of the boolean option.
*/
override fun boolOption(config: OptionConfig): OptionValue<Boolean> =
createOption(
config.copy(required = false),
OptionType.BOOLEAN
)
override fun <T> createOption(
config: OptionConfig,
type: OptionType<T>,
): OptionValue<T> {
try {
if (isParsed) throw ArgumentParserException.noMoreOptions()
DefaultOptionValidator.validateOption(config, options)
@Suppress("UNCHECKED_CAST")
return type.createOption(config).also { options.add(it as Option<Any>) }.optionValue
} catch (e: ArgumentParserException) {
handleParsingError(e)
}
}
/**
* Parses the provided array of command-line arguments.
*
* This method processes the input arguments, identifies the options and parameters
* based on the argument parser's configuration, and validates the required options.
* If the arguments have already been parsed, it raises an exception.
* In case of errors during parsing or validation, an error message is displayed
* and the help information is shown.
*
* @param args The array of command-line arguments to be parsed.
*/
override fun parse(args: Array<String>) {
parseArguments(args, options)
}
}
abstract class AbstractCommandLineParser(private val helpString: String) {
private val parameters = ParameterValue()
protected var isParsed = false
protected val argumentParser: ArgumentParser = DefaultArgumentParser()
protected abstract val helpFormatter: HelpFormatter
companion object {
const val NAME = """[a-zA-Z][\w-]+"""
const val SHORT_NAME = """[a-zA-Z]"""
val ARGUMENT_PATTERN = """^(?:-(${SHORT_NAME})|--(${NAME}))(?:=(.+)|$)$""".toRegex()
val NAME_PATTERN = """^${NAME}$""".toRegex()
val SHORT_NAME_PATTERN = """^${SHORT_NAME}$""".toRegex()
}
/**
* Returns the list of parameters provided to the argument parser.
*
* The parameters are parsed from the command-line input following the provided argument options.
* This method allows accessing any additional parameters that are not directly associated with
* the defined options.
*
* @return A list of strings representing the positional parameters passed after all options.
*/
fun parametersList() = parameters
abstract fun parse(args: Array<String>)
protected fun parseArguments(args: Array<String>, options: MutableList<Option<Any>>) {
if (isParsed) throw ArgumentParserException.noMoreParsing()
try {
argumentParser.parseArguments(args, options, parameters)
isParsed = true
DefaultOptionValidator.validateRequiredOptions(options)
handleHelpOption(options)
} catch (e: ArgumentParserException) {
handleParsingError(e)
}
}
fun showHelp(errorMessage: String = ""): Nothing {
helpFormatter.show()
if (errorMessage.isNotEmpty()) {
println()
println(errorMessage)
println()
}
exitProcess(0)
}
private fun handleHelpOption(options: MutableList<Option<Any>>) {
if (findOption("help", options)?.optionValue?.value == true) {
showHelp()
}
}
private fun findOption(name: String, options: MutableList<Option<Any>>): Option<Any>? =
if (name.length > 1) options.find { it.config.name == name }
else options.find { it.config.shortName == name[0] }
protected fun handleParsingError(e: ArgumentParserException): Nothing {
showHelp(ArgumentParserException.ERROR_MSG.format(e.message))
}
// argument parsing
interface ArgumentParser {
fun parseArguments(
args: Array<String>,
options: List<Option<Any>>,
parameters: ParameterValue,
)
fun parseCommand(cmd: String): Boolean
}
private class DefaultArgumentParser : ArgumentParser {
override fun parseArguments(
args: Array<String>,
options: List<Option<Any>>,
parameters: ParameterValue,
) {
var index = 0
parameters.value = emptyList()
while (index < args.size) {
val parseResult = parseArgument(args[index])
if (parseResult != null) {
val (key, value) = parseResult
index += handleOption(key, value, args, index, options)
index++
} else {
parameters.value = args.drop(index)
break
}
}
}
override fun parseCommand(cmd: String) =
NAME_PATTERN.matches(cmd)
private fun parseArgument(arg: String): Pair<String, String>? =
ARGUMENT_PATTERN.matchEntire(arg)?.groupValues?.let { Pair(it[1] + it[2], it[3]) }
private fun handleOption(
key: String,
value: String,
args: Array<String>,
index: Int,
options: List<Option<Any>>,
): Int {
val option = options.find {
it.config.name == key || it.config.shortName?.toString() == key
} ?: throw ArgumentParserException.unknownOption(key)
return when {
option.type.hasParameter -> handleParameterOption(option, value, args, index)
else -> handleFlagOption(option, value)
}
}
private fun handleParameterOption(
option: Option<Any>,
value: String,
args: Array<String>,
index: Int,
): Int = when {
value.isNotBlank() -> {
option.type.convertAndSet(value, option)
0
}
index < args.size - 1 && !ARGUMENT_PATTERN.matches(args[index + 1]) -> {
option.type.convertAndSet(args[index + 1], option)
1
}
else -> throw ArgumentParserException.optionRequiresValue(option.config.name)
}
private fun handleFlagOption(option: Option<Any>, value: String): Int {
if (value.isNotBlank()) {
throw ArgumentParserException.optionNoValue(option.config.name)
}
option.type.convertAndSet("true", option)
return 0
}
}
// help output
protected interface HelpFormatter {
fun show(indent: String = "")
}
protected class CommandHelpFormatter(
protected val commands: CommandList,
private val infoMessage: String,
) : HelpFormatter {
override fun show(indent: String) {
println()
println(infoMessage)
for (cmd in commands) {
val aliases = buildString {
if (cmd.aliases.isNotEmpty()) append(
"|'${
cmd.aliases.joinToString("'|'")
}'"
)
}
OptionHelpFormatter(
cmd.options,
"Command '${cmd.name}'${aliases}: ${cmd.description}"
).show(" ")
println()
}
}
}
protected class OptionHelpFormatter(
private val options: List<Option<Any>>,
private val infoMessage: String,
) : HelpFormatter {
override fun show(indent: String) {
println(infoMessage)
if (options.isNotEmpty()) {
if (indent.isEmpty()) println("Options:")
printOptions(indent)
}
}
private fun printOptions(indent: String) {
val maxNameLength = calculateMaxNameLength() + 4 + indent.length
options.forEach { printOption(it, maxNameLength, indent) }
}
private fun calculateMaxNameLength(): Int =
options.maxOfOrNull { opt ->
opt.config.name.length + 2 + (opt.config.shortName?.let { 4 } ?: 0)
} ?: 0
private fun printOption(option: Option<Any>, maxNameLength: Int, indent: String) {
val shortName = option.config.shortName?.let { "-$it, " } ?: ""
val optionText = StringBuilder()
.append(indent)
.append(shortName)
.append("--")
.append(option.config.name)
.padEnd(maxNameLength)
println("$optionText ${option.config.description}")
}
}
}
// option validation
private interface OptionValidator {
fun validateOption(config: OptionConfig, existingOptions: List<Option<Any>>)
fun validateRequiredOptions(options: List<Option<Any>>)
}
private object DefaultOptionValidator : OptionValidator {
override fun validateOption(config: OptionConfig, existingOptions: List<Option<Any>>) {
validateOptionName(config.name)
validateShortName(config.shortName)
validateOptionUniqueness(config, existingOptions)
}
override fun validateRequiredOptions(options: List<Option<Any>>) {
val emptyNames = options.filter { it.config.required && it.isEmpty() }
.joinToString(", ") { it.config.name }
if (emptyNames.isNotEmpty()) throw ArgumentParserException.optionRequired(emptyNames)
}
private fun validateOptionName(name: String) {
if (!name.matches(NAME_PATTERN)) {
throw ArgumentParserException.invalidName(name)
}
}
private fun validateShortName(shortName: Char?) {
if (shortName != null && !shortName.toString().matches(SHORT_NAME_PATTERN)) {
throw ArgumentParserException.invalidShortName(shortName.toString())
}
}
private fun validateOptionUniqueness(
config: OptionConfig,
existingOptions: List<Option<Any>>,
) {
val nameExists = existingOptions.any { it.config.name == config.name }
val shortNameExists = config.shortName?.let { shortName ->
existingOptions.any { it.config.shortName == shortName }
} ?: false
if (nameExists || shortNameExists) {
throw ArgumentParserException.optionExists(config.name)
}
}
}
@@ -0,0 +1,54 @@
package net.keinekekse.config
import net.keinekekse.version.Version
import java.io.File
/**
* Abstract base class for initialization configuration.
* Provides version information and configuration file management.
*
* @property configFileName Name of the configuration file to use
*/
abstract class AbstractInitConfig(
val configFileName: String = DEFAULT_CONFIG_FILENAME,
) {
// abstract fun start()
/** Current application version */
val applicationVersion: Version by lazy { Version(this::class.java) }
/** Library version information */
val libraryVersion: Version by lazy { Version(Version::class.java) }
/** Configuration directory path */
val configDirectory: String by lazy {
buildPath(
System.getProperty(USER_HOME_PROPERTY),
CONFIG_DIR,
applicationVersion.name
)
}
/** Current working directory */
val workingDirectory: String by lazy {
System.getProperty(USER_DIR_PROPERTY) + File.separator
}
/** User-specific configuration */
val userConfig by lazy {
UserConfigProperties(buildPath(configDirectory, configFileName))
}
/** System-wide configuration */
val systemConfig = SystemConfigProperties
private fun buildPath(vararg parts: String): String =
parts.joinToString(File.separator)
companion object {
private const val DEFAULT_CONFIG_FILENAME = "config.properties"
private const val CONFIG_DIR = ".config"
private const val USER_HOME_PROPERTY = "user.home"
private const val USER_DIR_PROPERTY = "user.dir"
}
}
@@ -7,6 +7,7 @@ private const val CONFIG_FILE_NAME = "config.properties"
private const val ERROR_LOADING_CONFIG = "Could not load configuration from $CONFIG_FILE_NAME"
// TODO mit WAR testen wg. Pfad zu config.properties
/**
* Projekt-Properties
*
@@ -14,27 +15,27 @@ private const val ERROR_LOADING_CONFIG = "Could not load configuration from $CON
* (-> in ```main/resources``` anlegen)
*
* ```
* val prop: String = ConfigProperties.get("some.prop")
* val prop: String = ConfigProperties["some.prop"] ?: "default"
*
* ```
*/
object ConfigProperties {
object SystemConfigProperties {
private val properties = Properties()
operator fun get(key: String): String? = properties.getProperty(key)
init {
loadConfigFile()
}
private fun loadConfigFile() {
val configFileStream: InputStream? =
javaClass.classLoader.getResourceAsStream(CONFIG_FILE_NAME)
if (configFileStream == null) {
throw IllegalStateException(ERROR_LOADING_CONFIG)
}
configFileStream.use {
properties.load(it)
getConfigStream().use { stream ->
properties.load(stream)
}
}
fun get(key: String): String = properties.getProperty(key)
private fun getConfigStream(): InputStream {
return javaClass.classLoader.getResourceAsStream(CONFIG_FILE_NAME)
?: throw IllegalStateException(ERROR_LOADING_CONFIG)
}
}
@@ -0,0 +1,144 @@
package net.keinekekse.config
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.json.Json
import java.io.File
import java.io.FileNotFoundException
import java.util.*
/**
* Manages user-specific configuration properties from a file.
* Creates the configuration file if it doesn't exist.
*
* @property configPath Path to the configuration file
* @throws FileNotFoundException if the configuration file cannot be created or accessed
*/
class UserConfigProperties(private val configPath: String) {
private companion object {
const val ERROR_CREATE_CONFIG = "Failed to create configuration file"
const val ERROR_LOAD_CONFIG = "Failed to load configuration from file"
}
private val properties = Properties()
init {
loadProperties()
}
/**
* Returns the value associated with the given key from the properties.
*
* @param key The property key
* @return The property value or null if the key doesn't exist
*/
operator fun get(key: String): String? = properties.getProperty(key)
private fun loadProperties() {
ensureConfigFileExists()
try {
File(configPath).inputStream().use { stream ->
properties.load(stream)
}
} catch (e: Exception) {
throw FileNotFoundException("$ERROR_LOAD_CONFIG: ${e.message}")
}
}
private fun ensureConfigFileExists() {
val configFile = File(configPath)
if (!configFile.exists()) {
try {
configFile.parentFile?.mkdirs()
if (!configFile.createNewFile()) {
throw FileNotFoundException(ERROR_CREATE_CONFIG)
}
} catch (e: Exception) {
throw FileNotFoundException("$ERROR_CREATE_CONFIG: ${e.message}")
}
}
}
}
/**
* Handles JSON file reading and parsing with a relaxed configuration.
* Supports comments, case-insensitive enum parsing, and ignores unknown keys.
*
* ```
* val obj: T = JsonConfig.parseFromFile<T>("config.json")
* // or
* val json = JsonConfig.read("config.json")
* val obj: T = JsonConfig.parse<T>(json)
* ```
*/
object JsonConfig {
private const val FILE_NOT_FOUND = "File not found: "
private const val FILE_READ_ERROR = "Failed to read file: "
/**
* JSON parser configuration optimized for flexibility and ease of use.
*/
@OptIn(ExperimentalSerializationApi::class)
val jsonConfiguration = Json {
ignoreUnknownKeys = true
allowComments = true
decodeEnumsCaseInsensitive = true
}
/**
* Custom exception for JSON-related operations
*/
class JsonConfigException(message: String, cause: Throwable? = null) :
RuntimeException(message, cause)
/**
* Reads content from a JSON file.
* @param filePath Path to the JSON file
* @return String content of the file
* @throws JsonConfigException if the file doesn't exist or cannot be read
*/
fun read(filePath: String): String {
val jsonFile = File(filePath)
return when {
!jsonFile.exists() -> throw JsonConfigException(FILE_NOT_FOUND + filePath)
else -> try {
jsonFile.readText()
} catch (e: Exception) {
throw JsonConfigException(FILE_READ_ERROR + filePath, e)
}
}
}
/* TODO exceptions hier fangen?
JSON Exceptions:
malformed, falscher Datentyp: JsonDecodingException
missing: MissingFieldException
unbekannter Name für enum: SerializationException
wenn ein key mehrmals vorkommt, wird nur das letzte gelesen (kein Fehler!)
*/
/**
* Parses a JSON string into the specified type.
* @param json JSON string to parse
* @return Parsed object of type T
*/
inline fun <reified T> parse(json: String): T =
jsonConfiguration.decodeFromString<T>(json)
/**
* Parses a JSON file located at the given path into an object of the specified type.
*
* @param T The type of the object to parse.
* @param filePath The path to the JSON file to parse.
* @return An object of type T parsed from the JSON file.
* @throws JsonConfigException If the file doesn't exist, can't be read,
* or if there's an error during parsing.
*/
inline fun <reified T> parseFromFile(filePath: String): T {
val json = read(filePath)
return parse(json)
}
}
+8 -6
View File
@@ -6,12 +6,8 @@ import java.util.concurrent.TimeUnit
class CommandExecutionException(message: String) : Exception(message)
private const val IO_EXCEPTION_CODE = 0x10000
private const val INTERRUPTED_EXCEPTION_CODE = 0x10001
private const val GENERIC_EXCEPTION_CODE = 0x10002
/**
* Runs program in list [arguments] and saves result to [stdout], [stderr] and [rc].
* Runs program in list [arguments] and outputs results to [stdout], [stderr] and [rc].
*
* A return code of >=0x10000 in [rc] signals an exception with the stack trace
* in [stderr].
@@ -20,7 +16,7 @@ private const val GENERIC_EXCEPTION_CODE = 0x10002
* val runResult = ExecutionResult(listOf("ebook-meta", "/path/to/epub", "--title", "New Title"))
* println("RC = ${runResult.rc}")
* ```
* @param arguments program and arguments to run
* @param arguments program and arguments to run as [List]
* @param throwAtError throw exception at `rc != 0` (defaults to true)
* @param workingDir working directory for the program (defaults to ".")
* @param timeoutSec timeout in seconds (defaults to 60)
@@ -41,6 +37,12 @@ class ExecutionResult(
val stderr: String
val rc: Int
companion object {
private const val IO_EXCEPTION_CODE = 0x10000
private const val INTERRUPTED_EXCEPTION_CODE = 0x10001
private const val GENERIC_EXCEPTION_CODE = 0x10002
}
init {
val executionResult = try {
executeProcess()
@@ -0,0 +1,41 @@
package net.keinekekse.util
import kotlin.reflect.KProperty
/**
* A delegate interface that provides a mechanism to access a value of type `T` via delegation.
*
* This interface allows the value to be retrieved indirectly through property delegation while
* abstracting the underlying property storage mechanism. It is particularly useful when implementing
* custom delegation logic for properties.
*
* @param T the type of the value to be delegated.
*
* ```
* val myValue: T? by MyValueDelegate()
* ```
*/
interface ValueDelegate<T> {
var value: T?
operator fun getValue(thisRef: Any?, property: KProperty<*>): T? = value
}
/**
* A mutable delegate interface that extends the capabilities of [ValueDelegate].
*
* This interface enables both retrieving and setting a value of type `T` through property delegation,
* providing a mechanism to modify the delegated property in addition to accessing it.
*
* @param T the type of the value to be delegated.
*
* ```
* var myValue: T? by MyMutableValueDelegate()
* ```
*
* @see ValueDelegate
*/
interface MutableValueDelegate<T> : ValueDelegate<T> {
operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T?) {
this.value = value
}
}
@@ -0,0 +1,27 @@
package net.keinekekse.util
/**
* Checks if a network connection to the specified host and port is possible within the given timeout.
*
* @param host the host to connect to
* @param port the port to connect to on the host
* @param timeoutMs the timeout in milliseconds for the connection attempt, default is 1000ms
* @return true if the connection is successful, false otherwise
*/
fun isConnectionPossible(host: String, port: Int, timeoutMs: Int = 1000): Boolean {
return try {
java.net.Socket().use { socket ->
socket.connect(java.net.InetSocketAddress(host, port), timeoutMs)
true
}
} catch (e: Exception) {
when (e) {
is java.net.ConnectException,
is java.net.SocketTimeoutException,
is java.net.UnknownHostException,
-> false
else -> throw e
}
}
}
@@ -1,14 +1,10 @@
package net.keinekekse.version
import java.io.File
import java.io.IOException
import java.net.URI
import java.time.Instant
import java.time.format.DateTimeFormatter
import java.time.format.DateTimeParseException
import java.util.*
import java.util.concurrent.ConcurrentHashMap
import java.util.jar.Manifest
import java.util.regex.Pattern
/**
@@ -19,9 +15,15 @@ import java.util.regex.Pattern
*
* Fürs Setzen der Werte in der MANIFEST.MF ist das Gradle version-plugin verantwortlich.
*
* Das Auslesen der Datei funktioniert für .jar (liegt in /META-INF) und .war (liegt in
* /WEB-INF/classes/META-INF) die auf einem Wildfly-Server deployed wurden (für alles Andere wäre es
* zu testen)
* Das Version-Plugin setzt folgende Werte
* ```
* Implementation-Title = name;displayName;description
* Implementation-Vendor = copyright
* Implementation-Version = version;buildNumber;Instant.now()
* ```
* Dadurch könne die Werte über die Standardfunktionen, wie z.B. [Package.implementationTitle],
* geholt werden. Das erübrigt eigene Routinen für das Finden der MANIFEST.MF, auf die per
* [Class.getPackage] zugegriffen werden kann.
*
* @param clazz Klasse aus der jeweiligen .jar oder .war
*
@@ -31,56 +33,65 @@ import java.util.regex.Pattern
* ```
*/
class Version(clazz: Class<*>) {
val versionObject: VersionNumber
private val attributes: MutableMap<String, String>
init {
val manifestPath = determineManifestPath(clazz)
attributes = loadManifestAttributes(manifestPath)
val manifest = determineManifestPath(clazz)
attributes = loadManifestAttributes(manifest)
versionObject = initializeVersionNumbers()
}
// TODO noch nicht für WAR getestet!!
private fun determineManifestPath(clazz: Class<*>): String {
val classResourcePath = clazz.getResource("${clazz.simpleName}.class")?.toString() ?: ""
val baseFolder = if (classResourcePath.contains(WEB_INF_PATH)) {
classResourcePath.substringBefore(WEB_INF_PATH) + MANIFEST_FILE_PATH
} else {
classResourcePath.substringBefore(
clazz.name.replace(
'.',
File.separatorChar
) + CLASS_EXTENSION
) + MANIFEST_FILE_PATH
}
return baseFolder
private fun determineManifestPath(clazz: Class<*>): Package? {
return clazz.`package`
// val classResourcePath = clazz.getResource("${clazz.simpleName}.class")?.toString() ?: ""
// val baseFolder = if (classResourcePath.contains(WEB_INF_PATH)) {
// classResourcePath.substringBefore(WEB_INF_PATH) + MANIFEST_FILE_PATH
// } else {
// classResourcePath.substringBefore(
// clazz.name.replace(
// '.',
// File.separatorChar
// ) + CLASS_EXTENSION
// ) + MANIFEST_FILE_PATH
// }
// return baseFolder
}
private fun loadManifestAttributes(manifestPath: String): MutableMap<String, String> {
private fun loadManifestAttributes(manifest: Package?): MutableMap<String, String> {
val attributes = ConcurrentHashMap<String, String>()
val implTitle = (manifest?.implementationTitle ?: "").split(";")
attributes.put(PROP_NAME, implTitle.getOrNull(0) ?: "")
attributes.put(PROP_DISPLAYNAME, implTitle.getOrNull(1) ?: "")
attributes.put(PROP_DESCRIPTION, implTitle.getOrNull(2) ?: "")
try {
URI(manifestPath).toURL().openStream().use {
val manifest = Manifest(it)
manifest.mainAttributes.forEach { key, value ->
attributes[key.toString()] = value.toString()
}
}
} catch (e: IOException) {
throw RuntimeException("Failed to read MANIFEST.MF at $manifestPath", e)
}
val version = (manifest?.implementationVersion ?: "").split(";")
attributes.put(PROP_VERSION, version.getOrNull(0) ?: "")
attributes.put(PROP_BUILD_NUMBER, version.getOrNull(1) ?: "")
attributes.put(PROP_BUILD_TIMESTAMP, version.getOrNull(2) ?: "")
attributes.put(PROP_COPYRIGHT, manifest?.implementationVendor ?: "")
// try {
// URI(manifestPath).toURL().openStream().use {
// val manifest = Manifest(it)
// manifest.mainAttributes.forEach { key, value ->
// attributes[key.toString()] = value.toString()
// }
// }
// } catch (e: IOException) {
// throw RuntimeException("Failed to read MANIFEST.MF at $manifestPath", e)
// }
return attributes
}
private fun initializeVersionNumbers(): VersionNumber {
return VersionNumber(
private fun initializeVersionNumbers(): VersionNumber =
VersionNumber(
attributes[PROP_VERSION] ?: "",
attributes[PROP_BUILD_TIMESTAMP] ?: "",
attributes[PROP_BUILD_NUMBER] ?: ""
)
}
val infoString: String
get() = "$displayname $fullVersion $copyright"
@@ -122,7 +133,7 @@ class Version(clazz: Class<*>) {
get() = versionObject.buildTimestamp
companion object {
private const val PROP_NAME = "module-name"
private const val PROP_NAME = "name"
private const val PROP_DISPLAYNAME = "displayname"
private const val PROP_COPYRIGHT = "copyright"
private const val PROP_DESCRIPTION = "description"
@@ -130,9 +141,9 @@ class Version(clazz: Class<*>) {
private const val PROP_BUILD_TIMESTAMP = "build-timestamp"
private const val PROP_BUILD_NUMBER = "build-number"
private const val MANIFEST_FILE_PATH = "META-INF/MANIFEST.MF"
private const val CLASS_EXTENSION = ".class"
private const val WEB_INF_PATH = "WEB-INF/classes"
// private const val MANIFEST_FILE_PATH = "META-INF/MANIFEST.MF"
// private const val CLASS_EXTENSION = ".class"
// private const val WEB_INF_PATH = "WEB-INF/classes"
}
}
@@ -201,11 +212,10 @@ class VersionNumber(val version: String, timestamp: String, buildNumber: String
private fun parseVersionComponent(value: String?) = value?.toIntOrNull() ?: 0
private fun resolveBuildMetadata(extractedBuild: String): String {
return if (extractedBuild.isNotEmpty()) extractedBuild else buildEpochSeconds.toString()
}
private fun resolveBuildMetadata(extractedBuild: String): String =
if (extractedBuild.isNotEmpty()) extractedBuild else buildEpochSeconds.toString()
private fun initializeBuildTimestamp(timestamp: String) {
private fun initializeBuildTimestamp(timestamp: String) =
try {
val instant = Instant.parse(timestamp)
val date = instant.atZone(TimeZone.getDefault().toZoneId())
@@ -214,5 +224,5 @@ class VersionNumber(val version: String, timestamp: String, buildNumber: String
} catch (e: DateTimeParseException) {
buildTimestamp = "Invalid timestamp"
}
}
}