Merge pull request #184 from daniellienert/task/refactor-suggestion-result

!!! TASK: Adjust the result of getSuggestions

Author: daniellienert

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryBuilder.php

@@ -424,7 +424,7 @@ public function aggregation($name, array $aggregationDefinition, $parentPath = '
      *
      * nodes = ${Search....termSuggestions("aTerm")}
      *
-     * Access all suggestions data with {nodes.suggestions} in your fluid template
+     * Access all suggestions data with ${Search....getSuggestions()}
      *
      * @param string $text
      * @param string $field

Classes/Flowpack/ElasticSearch/ContentRepositoryAdaptor/Eel/ElasticSearchQueryResult.php

@@ -208,20 +208,32 @@ public function getAggregations()
     }
 
     /**
+     * Returns an array of type
+     * [
+     *     <suggestionName> => [
+     *         'text' => <term>
+     *         'options' => [
+     *              [
+     *               'text' => <suggestionText>
+     *               'score' => <score>
+     *              ],
+     *              [
+     *              ...
+     *              ]
+     *         ]
+     *     ]
+     * ]
+     *
      * @return array
      */
     public function getSuggestions()
     {
         $this->initialize();
-        if (count($this->result['suggest']) === 1) {
-            $suggestArray = current($this->result['suggest']);
-
-            if (count($suggestArray) === 1) {
-                return current($suggestArray);
-            }
+        if (array_key_exists('suggest', $this->result)) {
+            return $this->result['suggest'];
         }
 
-        return $this->result['suggest'];
+        return [];
     }
 
     /**

Tests/Functional/Eel/ElasticSearchQueryTest.php

@@ -208,24 +208,50 @@ public function fieldBasedAggregations()
         $this->assertEquals($expectedChickenBucket, $result[$aggregationTitle]['buckets'][0]);
     }
 
+    public function termSuggestionDataProvider()
+    {
+        return [
+            'singleWord' => [
+                'term' => 'chickn',
+                'expectedBestSuggestions' => [
+                    'chicken'
+                ]
+            ],
+            'multiWord' => [
+                'term' => 'chickn eggs',
+                'expectedBestSuggestions' => [
+                    'chicken',
+                    'egg'
+                ]
+            ],
+        ];
+    }
+
     /**
+     * @dataProvider termSuggestionDataProvider
      * @test
+     *
+     * @param string $term
+     * @param array $expectedBestSuggestions
      */
-    public function termSuggestion()
+    public function termSuggestion($term, $expectedBestSuggestions)
     {
-        $titleSuggestionKey = "chickn";
-
         $result = $this->getQueryBuilder()
             ->log($this->getLogMessagePrefix(__METHOD__))
-            ->termSuggestions($titleSuggestionKey, "title")
+            ->termSuggestions($term, 'title')
             ->execute()
             ->getSuggestions();
 
-        $this->assertArrayHasKey("options", $result);
-
-        $this->assertCount(1, $result['options']);
+        $this->assertArrayHasKey('suggestions', $result);
+        $this->assertTrue(is_array($result['suggestions']), 'Suggestions must be an array.');
+        $this->assertCount(count($expectedBestSuggestions), $result['suggestions']);
 
-        $this->assertEquals('chicken', $result['options'][0]['text']);
+        foreach ($expectedBestSuggestions as $key => $expectedBestSuggestion) {
+            $suggestion = $result['suggestions'][$key];
+            $this->assertArrayHasKey('options', $suggestion);
+            $this->assertCount(1, $suggestion['options']);
+            $this->assertEquals($expectedBestSuggestion, $suggestion['options'][0]['text']);
+        }
     }
 
     /**