Merge pull request #111 from algolia/feature/query-rule-alternative

Query Rule Alternatives

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/model/rule/Alternatives.kt

@@ -0,0 +1,35 @@
+package com.algolia.search.model.rule
+
+import com.algolia.search.serialize.asJsonInput
+import kotlinx.serialization.Decoder
+import kotlinx.serialization.Encoder
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializer
+import kotlinx.serialization.internal.BooleanSerializer
+import kotlinx.serialization.json.JsonLiteral
+
+
+public sealed class Alternatives {
+
+    public object True : Alternatives()
+
+    public object False : Alternatives()
+
+    @Serializer(Alternatives::class)
+    companion object : KSerializer<Alternatives> {
+
+        override fun serialize(encoder: Encoder, obj: Alternatives) {
+            when (obj) {
+                is Alternatives.True -> BooleanSerializer.serialize(encoder, true)
+                is Alternatives.False -> BooleanSerializer.serialize(encoder, false)
+            }
+        }
+
+        override fun deserialize(decoder: Decoder): Alternatives {
+            return when (val element = decoder.asJsonInput()) {
+                is JsonLiteral -> if (element.boolean) Alternatives.True else Alternatives.False
+                else -> throw Exception("Unsupported Type")
+            }
+        }
+    }
+}

src/commonMain/kotlin/com/algolia/search/model/rule/Condition.kt

@@ -1,5 +1,6 @@
 package com.algolia.search.model.rule
 
+import com.algolia.search.serialize.KeyAlternatives
 import com.algolia.search.serialize.KeyAnchoring
 import com.algolia.search.serialize.KeyContext
 import com.algolia.search.serialize.KeyPattern
@@ -16,5 +17,9 @@ public data class Condition(
      * same context is specified at query time (using the ruleContexts parameter). When absent, the rule is generic
      * and always applies (provided that its other conditions are met, of course).
      */
-    @SerialName(KeyContext) val context: String? = null
+    @SerialName(KeyContext) val context: String? = null,
+    /**
+     *  Indicates if the rule can be applied with alternatives.
+     */
+    @SerialName(KeyAlternatives) val alternative: Alternatives? = null
 )

src/commonMain/kotlin/com/algolia/search/serialize/Keys.kt

@@ -362,4 +362,5 @@ public const val KeySuburb = "suburb"
 public const val KeyVillage = "village"
 public const val KeySimilarQuery = "similarQuery"
 public const val KeyEnableABTest = "enableABTest"
-public const val KeyIndexLanguages = "indexLanguages"
+public const val KeyAlternatives = "alternatives"
+public const val KeyIndexLanguages = "indexLanguages"

src/commonTest/kotlin/serialize/TestKeys.kt

@@ -353,6 +353,7 @@ internal class TestKeys {
         KeyVillage shouldEqual "village"
         KeySimilarQuery shouldEqual "similarQuery"
         KeyEnableABTest shouldEqual "enableABTest"
+        KeyAlternatives shouldEqual "alternatives"
         KeyIndexLanguages shouldEqual "indexLanguages"
     }
 }

src/commonTest/kotlin/serialize/rule/TestAlternatives.kt

@@ -0,0 +1,14 @@
+package serialize.rule
+
+import com.algolia.search.model.rule.Alternatives
+import kotlinx.serialization.json.JsonLiteral
+import serialize.TestSerializer
+
+
+internal class TestAlternatives : TestSerializer<Alternatives>(Alternatives) {
+
+    override val items = listOf(
+        Alternatives.True to JsonLiteral(true),
+        Alternatives.False to JsonLiteral(false)
+    )
+}

src/commonTest/kotlin/serialize/rule/TestCondition.kt

@@ -1,13 +1,11 @@
 package serialize.rule
 
 import attributeA
+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
-import com.algolia.search.serialize.JsonNoDefaults
-import com.algolia.search.serialize.KeyAnchoring
-import com.algolia.search.serialize.KeyIs
-import com.algolia.search.serialize.KeyPattern
+import com.algolia.search.serialize.*
 import kotlinx.serialization.json.json
 import serialize.TestSerializer
 import unknown
@@ -18,17 +16,21 @@ internal class TestCondition : TestSerializer<Condition>(Condition.serializer(),
     override val items = listOf(
         Condition(
             anchoring = Anchoring.Is,
-            pattern = Pattern.Facet(attributeA)
+            pattern = Pattern.Facet(attributeA),
+            alternative = Alternatives.True
         ) to json {
             KeyAnchoring to KeyIs
             KeyPattern to "{facet:$attributeA}"
+            KeyAlternatives to true
         },
         Condition(
             anchoring = Anchoring.Is,
-            pattern = Pattern.Literal(unknown)
+            pattern = Pattern.Literal(unknown),
+            alternative = Alternatives.False
         ) to json {
             KeyAnchoring to KeyIs
             KeyPattern to unknown
+            KeyAlternatives to false
         }
     )
 }

src/commonTest/resources/rule_edits.json

@@ -3,7 +3,8 @@
     "objectID": "query_edits",
     "condition": {
       "anchoring": "is",
-      "pattern": "mobile phone"
+      "pattern": "mobile phone",
+      "alternatives": true
     },
     "consequence": {
       "params": {