org.cqfn.diktat.ruleset.generation.Generation.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diktat-rules Show documentation
The main diktat ruleset
There is a newer version: 1.2.5
/**
 * This file contains code for codegen: generating a list of WarningNames and adjusting current year for (c)opyright inspection tests.
 */

package org.cqfn.diktat.ruleset.generation

import org.cqfn.diktat.ruleset.constants.Warnings
import org.cqfn.diktat.ruleset.rules.chapter2.comments.HeaderCommentRule.Companion.afterCopyrightRegex
import org.cqfn.diktat.ruleset.rules.chapter2.comments.HeaderCommentRule.Companion.curYear
import org.cqfn.diktat.ruleset.rules.chapter2.comments.HeaderCommentRule.Companion.hyphenRegex

import com.squareup.kotlinpoet.FileSpec
import com.squareup.kotlinpoet.KModifier
import com.squareup.kotlinpoet.PropertySpec
import com.squareup.kotlinpoet.TypeSpec

import java.io.File

import kotlin.io.path.ExperimentalPathApi
import kotlin.io.path.createTempFile

/**
 * The comment that will be added to the generated sources file.
 */
private val autoGenerationComment =
        """
            | This document was auto generated, please don't modify it.
            | This document contains all enum properties from Warnings.kt as Strings.
        """.trimMargin()

fun main() {
    generateWarningNames()
    validateYear()
}

private fun generateWarningNames() {
    val enumValNames = Warnings.values().map { it.name }

    val propertyList = enumValNames.map {
        PropertySpec
            .builder(it, String::class)
            .addModifiers(KModifier.CONST)
            .initializer("\"$it\"")
            .build()
    }

    val fileBody = TypeSpec
        .objectBuilder("WarningNames")
        .addProperties(propertyList)
        .build()

    val kotlinFile = FileSpec
        .builder("generated", "WarningNames")
        .addType(fileBody)
        .indent("    ")
        .addComment(autoGenerationComment)
        .build()

    kotlinFile.writeTo(File("diktat-rules/src/main/kotlin"))  // fixme: need to add it to pom
}

@OptIn(ExperimentalPathApi::class)
private fun validateYear() {
    val files = File("diktat-rules/src/test/resources/test/paragraph2/header")
    files
        .listFiles()
        ?.filterNot { it.name.contains("CopyrightDifferentYearTest.kt") }
        ?.forEach { file ->
            val tempFile = createTempFile().toFile()
            tempFile.printWriter().use { writer ->
                file.forEachLine { line ->
                    writer.println(when {
                        line.contains(hyphenRegex) -> line.replace(hyphenRegex) {
                            val years = it.value.split("-")
                            "${years[0]}-$curYear"
                        }
                        line.contains(afterCopyrightRegex) -> line.replace(afterCopyrightRegex) {
                            val copyrightYears = it.value.split("(c)", "(C)", "©")
                            "${copyrightYears[0]}-$curYear"
                        }
                        else -> line
                    })
                }
            }
            file.delete()
            tempFile.renameTo(file)
        }
}