Always put provinces above results with same name like "x + deelgemeenten" to avoid a weird order

Author: bertramakers

src/Widget/RegionService.php

@@ -10,8 +10,10 @@
  */
 class RegionService
 {
-    private const SCORE_EXACT = 6; // Exact match
-    private const SCORE_EXACT_SUFFIX_PREFIX = 5; // Matches like `Regio X`, `Provincie X`, or `X + deelgemeenten` for search string `X`
+    private const SCORE_EXACT = 8; // Exact match
+    private const SCORE_PROVINCE = 7; // Exact match with "Provincie X"
+    private const SCORE_REGION = 6; // Exact match with "Regio X"
+    private const SCORE_TOWN_WITH_SUBMUNICIPALITIES = 5; // Exact match with "X + deelgemeenten"
     private const SCORE_TYPEAHEAD_COMPLETE = 4; // Typeahead match with a whitespace afterward, e.g. `Zele (Zele)` for search string `Zele`
     private const SCORE_TYPEAHEAD_PARTIAL = 3; // Typeahead match with a non-whitespace character afterward, e.g. `Zelem (Halen)` for search string `Zele`
     private const SCORE_SUBSTRING = 2; // If the search string is not at the start but after a ( or -, e.g. `Hypothetical example (Zele)` for search string `Zele`
@@ -72,14 +74,31 @@ public function getAutocompletResults($searchString, $language = 'nl')
                     continue;
                 }
 
-                // Exact matches with a known suffix / prefix like `Regio X`, `X + deelgemeenten`, ... get the 2nd
-                // highest score. (Keep in mind that everything is already converted to lowercase)
-                // Otherwise "Provincie Antwerpen" would get buried by all submunicipalities of Antwerpen
-                if ($compareString === 'regio ' . $searchString ||
-                    $compareString === $searchString . ' + deelgemeenten' ||
-                    $compareString === 'provincie ' . $searchString) {
+                // Next we look for exact matches with common prefixes/suffixes like
+                // "Provincie", "Regio", and "+ deelgemeenten"
+                // We give each one a slightly different score to avoid that province names that are also names of towns
+                // get mixed up in a weird order, for example we want to AVOID:
+                // 1. Limburg + deelgemeenten (= town in Wallonia)
+                // 2. Provincie Limburg (= Flemish province)
+                // 3. Limbourg (Limburg) (= earlier town in Wallonia)
+                // 4. Bilstain (Limburg) (= submunicipality in earlier town in Wallonia)
+                if ($compareString === 'provincie ' . $searchString) {
                     $matches[$region->key] = [
-                        'score' => self::SCORE_EXACT_SUFFIX_PREFIX,
+                        'score' => self::SCORE_PROVINCE,
+                        'name'  => $translatedRegion,
+                    ];
+                    continue;
+                }
+                if ($compareString === 'regio ' . $searchString) {
+                    $matches[$region->key] = [
+                        'score' => self::SCORE_REGION,
+                        'name'  => $translatedRegion,
+                    ];
+                    continue;
+                }
+                if ($compareString === $searchString . ' + deelgemeenten') {
+                    $matches[$region->key] = [
+                        'score' => self::SCORE_TOWN_WITH_SUBMUNICIPALITIES,
                         'name'  => $translatedRegion,
                     ];
                     continue;

test/Widget/RegionServiceTest.php

@@ -96,7 +96,7 @@ public function it_will_find_match_the_start_of_a_city_name()
     /**
      * @test
      */
-    public function it_will_find_match_provinces()
+    public function it_will_find_provinces()
     {
         $this->assertSame(
             [
@@ -109,6 +109,24 @@ public function it_will_find_match_provinces()
         );
     }
 
+    /**
+     * @test
+     */
+    public function it_puts_provinces_above_municipalities_with_the_same_name()
+    {
+        $this->assertSame(
+            [
+                'nis-70000' => 'Provincie Limburg',
+                'nis-63046' => 'Limburg + deelgemeenten',
+                'nis-63046A' => 'Limbourg (Limburg)',
+                'nis-63046B' => 'Bilstain (Limburg)',
+                'nis-63046C' => 'Goé (Limburg)',
+                'reg-limburgse-kempen' => 'Regio Limburgse Kempen',
+            ],
+            $this->regionService->getAutocompletResults('Limburg')
+        );
+    }
+
     /**
      * @test
      */

test/Widget/regions_sample.json

@@ -246,5 +246,29 @@
   {
     "name": "Bressoux (Luik)",
     "key": "nis-62063E"
+  },
+  {
+    "name": "Limburg + deelgemeenten",
+    "key": "nis-63046"
+  },
+  {
+    "name": "Limbourg (Limburg)",
+    "key": "nis-63046A"
+  },
+  {
+    "name": "Bilstain (Limburg)",
+    "key": "nis-63046B"
+  },
+  {
+    "name": "Go\u00e9 (Limburg)",
+    "key": "nis-63046C"
+  },
+  {
+    "name": "Provincie Limburg",
+    "key": "nis-70000"
+  },
+  {
+    "name": "Regio Limburgse Kempen",
+    "key": "reg-limburgse-kempen"
   }
 ]