com.commercetools.rmf.validators.PackageDefinedRule.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ctp-validators Show documentation

RAML API client code generators based on the REST Modeling Framework. https://github.com/vrapio/rest-modeling-framework

There is a newer version: 1.0.0-20241120142200

package com.commercetools.rmf.validators

import io.vrap.rmf.raml.model.modules.Library
import io.vrap.rmf.raml.model.types.AnyType
import io.vrap.rmf.raml.model.types.BuiltinType
import io.vrap.rmf.raml.model.types.TypeTemplate
import org.eclipse.emf.common.util.Diagnostic
import java.util.*

@ValidatorSet
class PackageDefinedRule(severity: RuleSeverity, options: List? = null) : TypesRule(severity, options) {

    private val exclude: List =
        (options?.filter { ruleOption -> ruleOption.type.lowercase(Locale.getDefault()) == RuleOptionType.EXCLUDE.toString() }?.map { ruleOption -> ruleOption.value }?.plus("") ?: defaultExcludes)

    override fun caseAnyType(type: AnyType): List {
        val validationResults: MutableList = ArrayList()
        if (type.name != null && type !is TypeTemplate && exclude.contains(type.name).not() && !BuiltinType.of(type.name).isPresent()) {
            val packageAnno = type.getAnnotation("package", true)

            if (packageAnno == null ) {
                if (type.eContainer() is Library || (type.isInlineType && type.type.eContainer() is Library)) {
                    val currentType = when (type.isInlineType) {
                        true -> type.type
                        else -> type
                    }
                    if ((currentType.eContainer() as Library).getAnnotation("package") == null) {
                        validationResults.add(create(currentType.eContainer(), "Library type \"{0}\" must have package annotation defined", currentType.name))
                    }
                } else {
                    validationResults.add(create(type, "Type \"{0}\" must have package annotation defined", type.name))
                }
            }
        }

        return validationResults
    }

    companion object : ValidatorFactory {
        private val defaultExcludes by lazy { listOf("") }

        @JvmStatic
        override fun create(options: List?): PackageDefinedRule {
            return PackageDefinedRule(RuleSeverity.ERROR, options)
        }

        @JvmStatic
        override fun create(severity: RuleSeverity, options: List?): PackageDefinedRule {
            return PackageDefinedRule(severity, options)
        }
    }
}