refactor(Query): Unify Boolean attributes' handling and testing (#552)

## Boolean attributes handling

Although we first thought it would consist in `Move Boolean to boolean in the client`, exploration showed that we need to stick to `Boolean` instead: 

- Query's boolean attributes can either be _unset_, _true_ or _false_
- The default for each attribute is _not something we can rely on in the library_ (although sometimes it's mentioned in the docstring)
Consequently, we need our boolean getters to return either of three values: `Boolean.TRUE`, `Boolean.FALSE`, and `null` if unset. 

This means **getters should be implemented as `public @nullable Boolean getXXX()`**.

Likewise, the user should be able to unset an attribute's value, putting the `Query` in its default state for that attribute.

This means **setters should be implemented as `public @nonnull Query setXXX(@nullable Boolean xxx);`**.

This is implemented in 530c577, which refactors setters that were not compliant with this reasoning; and 68a955c, which adds appropriate annotations.

## Boolean attributes testing

Testing of our boolean attributes was inconsistent, sometimes testing `TRUE` and `FALSE` cases and sometimes only one of them. Adding a test for the `null` case was an opportunity to refactor those.

I went the following way:

- Extract the Boolean testing logic into [`testBooleanAttribute`](https://github.com/algolia/algoliasearch-client-android/blob/39a4dee0c71eac1db2f8a4a6a53905f1713e9a73/algoliasearch/src/test/java/com/algolia/search/saas/QueryTest.java#L874-L916), a generic method testing all cases of Boolean values for a given attribute
- Refactor Boolean tests to always use `testBooleanAttribute`. This makes the tests much more concise, more consistent, without any significant performance drawback (runnning 5 times `QueryTest` before and after this change results in a mean difference of `0.12`s).
- Reorganize tests into [regions for attribute types](https://github.com/algolia/algoliasearch-client-android/blob/39a4dee0c71eac1db2f8a4a6a53905f1713e9a73/algoliasearch/src/test/java/com/algolia/search/saas/QueryTest.java#L116). If we like the benefits of this new structure, I would apply it to each other attribute type.
- For mixed type attributes that can be Boolean (currently `ignorePlurals`), add assertions for the `null` case and keep it unchanged until further refactoring.

Author: PLNech

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

@@ -289,11 +289,12 @@ public Query(@NonNull Query other) {
      * search but not engine.
      */
     public @NonNull
-    Query setAdvancedSyntax(Boolean enabled) {
+    Query setAdvancedSyntax(@Nullable Boolean enabled) {
         return set(KEY_ADVANCED_SYNTAX, enabled);
     }
 
-    public Boolean getAdvancedSyntax() {
+    public @Nullable
+    Boolean getAdvancedSyntax() {
         return parseBoolean(get(KEY_ADVANCED_SYNTAX));
     }
 
@@ -304,11 +305,12 @@ public Boolean getAdvancedSyntax() {
      *                Defaults to true.
      */
     public @NonNull
-    Query setAllowTyposOnNumericTokens(Boolean enabled) {
+    Query setAllowTyposOnNumericTokens(@Nullable Boolean enabled) {
         return set(KEY_ALLOW_TYPOS_ON_NUMERIC_TOKENS, enabled);
     }
 
-    public Boolean getAllowTyposOnNumericTokens() {
+    public @Nullable
+    Boolean getAllowTyposOnNumericTokens() {
         return parseBoolean(get(KEY_ALLOW_TYPOS_ON_NUMERIC_TOKENS));
     }
 
@@ -318,11 +320,12 @@ public Boolean getAllowTyposOnNumericTokens() {
      * @param enabled If set to true, the results will return queryID which is needed for sending click | conversion events. Defaults to false.
      */
     public @NonNull
-    Query setClickAnalytics(Boolean enabled) {
+    Query setClickAnalytics(@Nullable Boolean enabled) {
         return set(KEY_CLICK_ANALYTICS, enabled);
     }
 
-    public Boolean getClickAnalytics() {
+    public @Nullable
+    Boolean getClickAnalytics() {
         return parseBoolean(get(KEY_CLICK_ANALYTICS));
     }
 
@@ -333,11 +336,12 @@ public Boolean getClickAnalytics() {
      *                analytics feature. Defaults to true.
      */
     public @NonNull
-    Query setAnalytics(Boolean enabled) {
+    Query setAnalytics(@Nullable Boolean enabled) {
         return set(KEY_ANALYTICS, enabled);
     }
 
-    public Boolean getAnalytics() {
+    public @Nullable
+    Boolean getAnalytics() {
         return parseBoolean(get(KEY_ANALYTICS));
     }
 
@@ -381,11 +385,12 @@ LatLng getAroundLatLng() {
      * geolocation)
      */
     public @NonNull
-    Query setAroundLatLngViaIP(Boolean enabled) {
+    Query setAroundLatLngViaIP(@Nullable Boolean enabled) {
         return set(KEY_AROUND_LAT_LNG_VIA_IP, enabled);
     }
 
-    public Boolean getAroundLatLngViaIP() {
+    public @Nullable
+    Boolean getAroundLatLngViaIP() {
         return parseBoolean(get(KEY_AROUND_LAT_LNG_VIA_IP));
     }
 
@@ -611,7 +616,7 @@ Boolean getFacetingAfterDistinct() {
      * @see <a href="https://www.algolia.com/doc/api-client/android/parameters/#facetingafterdistinct">facetingAfterDistinct's documentation</a>
      */
     public @NonNull
-    Query setFacetingAfterDistinct(Boolean enabled) {
+    Query setFacetingAfterDistinct(@Nullable Boolean enabled) {
         return set(KEY_FACETING_AFTER_DISTINCT, enabled);
     }
 
@@ -648,11 +653,11 @@ String getFilters() {
      * attribute.
      */
     public @NonNull
-    Query setGetRankingInfo(Boolean enabled) {
+    Query setGetRankingInfo(@Nullable Boolean enabled) {
         return set(KEY_GET_RANKING_INFO, enabled);
     }
 
-    public Boolean getGetRankingInfo() {
+    public @Nullable Boolean getGetRankingInfo() {
         return parseBoolean(get(KEY_GET_RANKING_INFO));
     }
 
@@ -820,7 +825,7 @@ public int hashCode() {
      * car/cars will be considered as equals). Defaults to false.
      */
     public @NonNull
-    Query setIgnorePlurals(boolean enabled) {
+    Query setIgnorePlurals(@Nullable Boolean enabled) {
         return set(KEY_IGNORE_PLURALS, enabled);
     }
 
@@ -1277,11 +1282,11 @@ public Integer getPage() {
      *                Algolia dashboard. When `false`, the search query is excluded from percentile computation.
      */
     public @NonNull
-    Query setPercentileComputation(boolean enabled) {
+    Query setPercentileComputation(@Nullable Boolean enabled) {
         return set(KEY_PERCENTILE_COMPUTATION, enabled);
     }
 
-    public Boolean getPercentileComputation() {
+    public @Nullable Boolean getPercentileComputation() {
         return parseBoolean(get(KEY_PERCENTILE_COMPUTATION));
     }
 
@@ -1372,11 +1377,12 @@ RemoveWordsIfNoResults getRemoveWordsIfNoResults() {
      *                to true.
      */
     public @NonNull
-    Query setReplaceSynonymsInHighlight(Boolean enabled) {
+    Query setReplaceSynonymsInHighlight(@Nullable Boolean enabled) {
         return set(KEY_REPLACE_SYNONYMS_IN_HIGHLIGHT, enabled);
     }
 
-    public Boolean getReplaceSynonymsInHighlight() {
+    public @Nullable
+    Boolean getReplaceSynonymsInHighlight() {
         return parseBoolean(get(KEY_REPLACE_SYNONYMS_IN_HIGHLIGHT));
     }
 
@@ -1389,11 +1395,12 @@ public Boolean getReplaceSynonymsInHighlight() {
      *                 only array items that matched at least partially are highlighted/snippeted.
      */
     public @NonNull
-    Query setRestrictHighlightAndSnippetArrays(boolean restrict) {
+    Query setRestrictHighlightAndSnippetArrays(@Nullable Boolean restrict) {
         return set(KEY_RESTRICT_HIGHLIGHT_AND_SNIPPET, restrict);
     }
 
-    public Boolean getRestrictHighlightAndSnippetArrays() {
+    public @Nullable
+    Boolean getRestrictHighlightAndSnippetArrays() {
         return parseBoolean(get(KEY_RESTRICT_HIGHLIGHT_AND_SNIPPET));
     }
 
@@ -1476,11 +1483,12 @@ public SortFacetValuesBy getSortFacetValuesBy() {
      * @param enabled False means that the total score of a record is the maximum score of an individual filter. Setting it to true changes the total score by adding together the scores of each filter found. Defaults to false.
      */
     public @NonNull
-    Query setSumOrFiltersScores(Boolean enabled) {
+    Query setSumOrFiltersScores(@Nullable Boolean enabled) {
         return set(KEY_SUM_OR_FILTERS_SCORES, enabled);
     }
 
-    public Boolean getSumOrFiltersScores() {
+    public @Nullable
+    Boolean getSumOrFiltersScores() {
         return parseBoolean(get(KEY_SUM_OR_FILTERS_SCORES));
     }
 
@@ -1491,11 +1499,12 @@ public Boolean getSumOrFiltersScores() {
      *                configuration. Defaults to true.
      */
     public @NonNull
-    Query setSynonyms(Boolean enabled) {
+    Query setSynonyms(@Nullable Boolean enabled) {
         return set(KEY_SYNONYMS, enabled);
     }
 
-    public Boolean getSynonyms() {
+    public @Nullable
+    Boolean getSynonyms() {
         return parseBoolean(get(KEY_SYNONYMS));
     }
 
@@ -1554,11 +1563,12 @@ ExactOnSingleWordQuery getExactOnSingleWordQuery() {
      *                Defaults to true.
      */
     public @NonNull
-    Query setEnableRules(Boolean enabled) {
+    Query setEnableRules(@Nullable Boolean enabled) {
         return set(KEY_ENABLE_RULES, enabled);
     }
 
-    public Boolean getEnableRules() {
+    public @Nullable
+    Boolean getEnableRules() {
         return parseBoolean(get(KEY_ENABLE_RULES));
     }
 

algoliasearch/src/main/java/com/algolia/search/saas/places/PlacesQuery.java

@@ -115,7 +115,7 @@ PlacesQuery setAroundLatLngViaIP(Boolean enabled) {
         return set(KEY_AROUND_LAT_LNG_VIA_IP, enabled);
     }
 
-    public Boolean getAroundLatLngViaIP() {
+    public @Nullable Boolean getAroundLatLngViaIP() {
         return parseBoolean(get(KEY_AROUND_LAT_LNG_VIA_IP));
     }