org.kiwiproject.changelog.config.ConfigHelpers.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of changelog-generator Show documentation
Generates GitHub change logs.
There is a newer version: 1.0.3
package org.kiwiproject.changelog.config

import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator
import io.github.oshai.kotlinlogging.KotlinLogging
import org.kiwiproject.changelog.config.external.ExternalChangelogConfig
import org.kiwiproject.json.LoggingDeserializationProblemHandler
import org.kiwiproject.yaml.YamlHelper
import java.io.File

private val LOG = KotlinLogging.logger {}

private const val ASSORTED = "Assorted"
private const val CONFIG_FILE_NAME = ".kiwi-changelog.yml"

internal object ConfigHelpers {

    fun mappingsToMap(mappings: List): Map {
        return mappings
            .asSequence()
            .map { opt -> opt.split(":") }
            .map { parts -> parts[0] to parts[1] }
            .toMap()
    }

    fun externalConfig(
        currentDirectory: File,
        userHomeDirectory: File,
        configFile: String?,
        ignoreConfigFiles: Boolean
    ): ExternalChangelogConfig {
        val externalConfigYaml = externalConfigYaml(
            currentDirectory,
            userHomeDirectory,
            configFile,
            ignoreConfigFiles
        )
        return externalConfig(externalConfigYaml)
    }

    private fun externalConfigYaml(
        currentDirectory: File,
        userHomeDirectory: File,
        configFile: String?,
        ignoreConfigFiles: Boolean
    ): String? {
        val configYaml: String? = configFile?.let { File(it).readText() }
        if (configYaml != null) {
            return configYaml
        }

        if (ignoreConfigFiles) {
            LOG.debug { "No explicit config file, and option to ignore standard config file locations was specified" }
            return null
        }

        val wellKnownConfig1 = File(currentDirectory, CONFIG_FILE_NAME)
        val wellKnownConfig2 = File(currentDirectory.parent, CONFIG_FILE_NAME)
        val wellKnownConfig3 = File(userHomeDirectory, CONFIG_FILE_NAME)

        LOG.debug {
            "Checking for external configuration in locations: $wellKnownConfig1, $wellKnownConfig2, $wellKnownConfig3"
        }

        return listOf(wellKnownConfig1, wellKnownConfig2, wellKnownConfig3)
            .firstOrNull { it.exists() }
            ?.readText()
    }

    fun externalConfig(externalConfigYaml: String?): ExternalChangelogConfig {
        return when (externalConfigYaml) {
            null -> ExternalChangelogConfig()
            else -> {
                // TODO How to report deserialization problems? Just the WARN log? Add to ExternalChangelogConfig?
                val yamlFactory = YAMLFactory().disable(YAMLGenerator.Feature.SPLIT_LINES)
                val mapper = ObjectMapper(yamlFactory)
                val handler = LoggingDeserializationProblemHandler()
                mapper.addHandler(handler)
                YamlHelper(mapper).toObject(externalConfigYaml, ExternalChangelogConfig::class.java)
            }
        }
    }

    fun buildCategoryConfig(
        labelToCategoryMappings: List,
        categoryToEmojiMappings: List,
        categoryOrder: List,
        defaultCategory: String?,
        externalConfig: ExternalChangelogConfig
    ): CategoryConfig {
        // Merge label-to-category CLI arguments and external configuration, preferring CLI arguments
        val cliLabelToCategoryMappings = mappingsToMap(labelToCategoryMappings)
        val mergedLabelToCategoryMappings = externalConfig.labelCategoryMap() + cliLabelToCategoryMappings

        // Merge category-to-emoji CLI arguments and external configuration, preferring CLI arguments
        val cliCategoryToEmojiMappings = mappingsToMap(categoryToEmojiMappings)
        val mergedCategoryToEmojiMappings = externalConfig.categoryEmojiMap() + cliCategoryToEmojiMappings

        // Compute final order for categories. CLI order takes precedence.
        val finalCategoryOrder = LinkedHashSet(categoryOrder.toList() + externalConfig.categoryOrder()).toList()

        // Get the default category, preferring CLI to external config, and falling back if neither provided
        val finalDefaultCategory = defaultCategory ?: externalConfig.defaultCategory() ?: ASSORTED

        return CategoryConfig(
            finalDefaultCategory,
            mergedLabelToCategoryMappings,
            finalCategoryOrder,
            mergedCategoryToEmojiMappings
        )
    }
}