commonMain.com.algolia.search.model.settings.CustomRankingCriterion.kt Maven / Gradle / Ivy

Go to download
package com.algolia.search.model.settings

import com.algolia.search.helper.toAttribute
import com.algolia.search.model.Attribute
import com.algolia.search.model.internal.Raw
import com.algolia.search.serialize.internal.Key
import com.algolia.search.serialize.internal.regexAsc
import com.algolia.search.serialize.internal.regexDesc
import kotlinx.serialization.KSerializer
import kotlinx.serialization.Serializable
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.descriptors.SerialDescriptor
import kotlinx.serialization.encoding.Decoder
import kotlinx.serialization.encoding.Encoder

/**
 * [Documentation][https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/#custom-ranking]
 */
@Serializable(CustomRankingCriterion.Companion::class)
public sealed class CustomRankingCriterion(override val raw: String) : Raw {

    /**
     * Sort an [Attribute] value by ascending order.
     */
    public data class Asc(val attribute: Attribute) : CustomRankingCriterion("${Key.Asc}($attribute)")

    /**
     * Sort an [Attribute] value by descending order.
     */
    public data class Desc(val attribute: Attribute) : CustomRankingCriterion("${Key.Desc}($attribute)")

    public data class Other(override val raw: String) : CustomRankingCriterion(raw)

    override fun toString(): String {
        return raw
    }

    public companion object : KSerializer {

        private val serializer = String.serializer()

        override val descriptor: SerialDescriptor = serializer.descriptor

        override fun serialize(encoder: Encoder, value: CustomRankingCriterion) {
            serializer.serialize(encoder, value.raw)
        }

        override fun deserialize(decoder: Decoder): CustomRankingCriterion {
            val string = serializer.deserialize(decoder)

            val findAsc = regexAsc.find(string)
            val findDesc = regexDesc.find(string)

            return when {
                findAsc != null -> Asc(findAsc.groupValues[1].toAttribute())
                findDesc != null -> Desc(findDesc.groupValues[1].toAttribute())
                else -> Other(string)
            }
        }
    }
}