com.commercetools.rmf.validators.QueryParameterPlaceholderAnnotationRule.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.elements.NamedElement
import io.vrap.rmf.raml.model.resources.Method
import io.vrap.rmf.raml.model.types.ObjectInstance
import org.eclipse.emf.common.util.Diagnostic
import java.util.ArrayList

@ValidatorSet
class QueryParameterPlaceholderAnnotationRule(severity: RuleSeverity, options: List? = null) : ResourcesRule(severity, options) {

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

    override fun caseMethod(method: Method): List {
        val validationResults: MutableList = ArrayList()

        method.queryParameters.forEach { queryParameter ->
            run {
                if (exclude.contains(queryParameter.name).not() && queryParameter.isPatternParameter()) {
                    if (queryParameter.getAnnotation("placeholderParam", true) == null) {
                        validationResults.add(error(queryParameter, "Property \"{0}\" must define placeholder annotation", queryParameter.name))
                    } else {
                        val annoValue = queryParameter.getAnnotation("placeholderParam",true).value;
                        when (annoValue) {
                            is ObjectInstance -> {
                                if (!(annoValue.value.find { propertyValue -> propertyValue.name == "paramName" } != null && annoValue.value.find { propertyValue -> propertyValue.name == "template" } != null && annoValue.value.find { propertyValue -> propertyValue.name == "placeholder" } != null))
                                    validationResults.add(error(queryParameter, "Placeholder object must have fields paramName, template and placeholder"))
                                val template = annoValue.getValue("template")?.value
                                val placeholder = annoValue.getValue("placeholder")?.value
                                if (template != null && placeholder != null) {
                                    if (!template.toString().contains(placeholder.toString())) validationResults.add(error(queryParameter, "Placeholder value \"<{0}>\" must be contained in the template \"{1}\"", placeholder, template))
                                }
                            }
                            else -> {
                                validationResults.add(error(queryParameter, "Property \"{0}\" must define object type for placeholder annotation", queryParameter.name))
                            }
                        }
                    }
                }
            }
        }
        return validationResults
    }

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

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

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

    fun NamedElement.isPatternParameter() = this.name.startsWith("/") && this.name.endsWith("/")
}