com.commercetools.rmf.validators.BooleanPropertyNameRule.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.types.*
import org.eclipse.emf.common.util.Diagnostic
import java.util.*

//@ValidatorSet
class BooleanPropertyNameRule(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 caseObjectType(type: ObjectType): List {
        val validationResults: MutableList = ArrayList()

        type.properties.filter { property -> property.type.isBoolean() }.forEach { property ->
            if (exclude.contains("${type.name}:${property.name}").not()) {
                if (property.name.matches(Regex("^is[A-Z].*$"))) {
                    validationResults.add(error(type, "Property \"{0}\" of type \"{1}\" must not have \"is\" as a prefix", property.name, type.name))
                }
            }
        }
        return validationResults
    }

    private fun AnyType.isBoolean(): Boolean {
        return when(this) {
            is BooleanType -> true
            else -> false
        }
    }

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

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

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