commonMain.com.algolia.search.dsl.rule.DSLConditions.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("FunctionName", "PropertyName")

package com.algolia.search.dsl.rule

import com.algolia.search.dsl.DSL
import com.algolia.search.dsl.DSLParameters
import com.algolia.search.model.Attribute
import com.algolia.search.model.rule.Alternatives
import com.algolia.search.model.rule.Anchoring
import com.algolia.search.model.rule.Condition
import com.algolia.search.model.rule.Pattern

/**
 * DSL for building a [List] of [Condition]s.
 */
@DSLParameters
public class DSLConditions(
    private val conditions: MutableList = mutableListOf(),
) {

    public val Is: Anchoring.Is = Anchoring.Is
    public val StartsWith: Anchoring.StartsWith = Anchoring.StartsWith
    public val EndsWith: Anchoring.EndsWith = Anchoring.EndsWith
    public val Contains: Anchoring.Contains = Anchoring.Contains

    /**
     * Create a [Condition] with [anchoring], [pattern] and optional [context] and [alternative].
     */
    public fun condition(
        anchoring: Anchoring,
        pattern: Pattern,
        context: String? = null,
        alternative: Alternatives? = null,
        filters: String? = null,
    ): Condition {
        return Condition(anchoring, pattern, context, alternative, filters)
    }

    /**
     * Create a [Pattern.Literal] with a [value].
     */
    public fun Literal(value: String): Pattern.Literal {
        return Pattern.Literal(value)
    }

    /**
     * Convenience method.
     */
    public fun Facet(attribute: String): Pattern.Facet {
        return Facet(Attribute(attribute))
    }

    /**
     * Create a [Pattern.Facet] with an [attribute].
     */
    public fun Facet(attribute: Attribute): Pattern.Facet {
        return Pattern.Facet(attribute)
    }

    /**
     * Add [this] to [conditions]
     */
    public operator fun Condition.unaryPlus() {
        conditions += this
    }

    public companion object : DSL> {

        override operator fun invoke(block: DSLConditions.() -> Unit): List {
            return DSLConditions().apply(block).conditions
        }
    }
}