feat(Query): implement ruleContexts and enableRules (#386)

Author: PLNech

algoliasearch/src/main/java/com/algolia/search/saas/Query.java

@@ -1205,6 +1205,23 @@ public String[] getRestrictSearchableAttributes() {
         return parseArray(get(KEY_RESTRICT_SEARCHABLE_ATTRIBUTES));
     }
 
+    private static final String KEY_RULE_CONTEXTS = "ruleContexts";
+
+    /**
+     * Set a list of contexts for which rules are enabled.
+     *
+     * Contextual rules matching any of these contexts are eligible, as well as generic rules.
+     * When empty, only generic rules are eligible.
+     * @param ruleContexts one or several contexts.
+     */
+    public @NonNull Query setRuleContexts(String... ruleContexts) {
+        return set(KEY_RULE_CONTEXTS, buildJSONArray(ruleContexts));
+    }
+
+    public @Nullable String[] getRuleContexts() {
+        return parseArray(get(KEY_RULE_CONTEXTS));
+    }
+
     private static final String KEY_SNIPPET_ELLIPSIS_TEXT = "snippetEllipsisText";
 
     /**
@@ -1328,6 +1345,21 @@ public Boolean getSynonyms() {
         return null;
     }
 
+    private static final String KEY_ENABLE_RULES = "enableRules";
+
+    /**
+     * @param enabled If set to false, rules processing is disabled: no rule will match the query.
+     *                Defaults to true.
+     */
+    public @NonNull Query setEnableRules(Boolean enabled) {
+        return set(KEY_ENABLE_RULES, enabled);
+    }
+
+    public Boolean getEnableRules() {
+        return parseBoolean(get(KEY_ENABLE_RULES));
+    }
+
+
     private static final String KEY_ALTERNATIVES_AS_EXACT = "alternativesAsExact";
 
     public @NonNull Query setAlternativesAsExact(@Nullable AlternativesAsExact[] types) {

algoliasearch/src/test/java/com/algolia/search/saas/QueryTest.java

@@ -837,6 +837,26 @@ public void responseFields() throws UnsupportedEncodingException {
         assertTrue("The built query should contain \"" + expected + "\", but contains _" + queryStr + "_.", queryStr.contains(expected));
     }
 
+    @Test
+    public void ruleContexts() {
+        Query query = new Query();
+        assertNull(query.getRuleContexts());
+        query.setRuleContexts("foo", "bar");
+        assertArrayEquals(new String[]{ "foo", "bar" }, query.getRuleContexts());
+        assertEquals("[\"foo\",\"bar\"]", query.get("ruleContexts"));
+        assertArrayEquals(query.getRuleContexts(), Query.parse(query.build()).getRuleContexts());
+    }
+
+    @Test
+    public void enableRules() {
+        Query query = new Query();
+        assertNull(query.getEnableRules());
+        query.setEnableRules(true);
+        assertEquals(Boolean.TRUE, query.getEnableRules());
+        assertEquals("true", query.get("enableRules"));
+        assertEquals(query.getEnableRules(), Query.parse(query.build()).getEnableRules());
+    }
+
 
     @Test
     public void facetingAfterDistinct() {