org.toilelibre.libe.domaindrivendesignktrules.ADataClassCannotUseAMap.kt Maven / Gradle / Ivy

Go to download
package org.toilelibre.libe.domaindrivendesignktrules

import com.pinterest.ktlint.core.ast.isPartOf
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
import org.jetbrains.kotlin.psi.KtClass
import org.jetbrains.kotlin.psi.KtParameter
import org.jetbrains.kotlin.psi.psiUtil.getNonStrictParentOfType
import org.jetbrains.kotlin.psi.psiUtil.isAbstract
import org.jetbrains.kotlin.psi.stubs.elements.KtStubElementTypes

class ADataClassCannotUseAMap : Rule("data-class-cannot-use-a-map") {

    override fun beforeVisitChildNodes(
        node: ASTNode,
        autoCorrect: Boolean,
        emit: EmitFunction
    ) {
        if (node.elementType != KtStubElementTypes.VALUE_PARAMETER) {
            return
        }

        if (!node.isPartOf(KtStubElementTypes.PRIMARY_CONSTRUCTOR) &&
            !node.isPartOf(KtStubElementTypes.SECONDARY_CONSTRUCTOR)
        ) {
            return
        }

        val parameter = node.psi as KtParameter

        val owningClass = parameter.getNonStrictParentOfType(KtClass::class.java)

        if (owningClass?.isAbstract() == true) return

        val isDataClass = owningClass?.isData() ?: false || owningClass?.isEnum() ?: false

        if (!isDataClass || !parameter.hasValOrVar()) return

        if (parameter.typeReference?.text?.startsWith("Map") == true ||
            parameter.typeReference?.text?.startsWith("java.lang.Map") == true
        ) {
            emit.problemWith(node.startOffset, parameter.fqName?.asString() ?: "(not found)")
        }
    }

    private fun EmitFunction.problemWith(startOffset: Int, name: String) =
        this(
            startOffset,
            "This variable : $name is a map (we cannot accept map as data class members because marshalling / " +
                "unmarshalling has a lot of concerns)",
            false
        )
}