Merge pull request #125 from apisearch-io/fix/fixed-suggestions-format

Fixed suggestions format

Author: mmoreram

.circleci/config.yml

@@ -1,23 +1,32 @@
 version: 2
+
 jobs:
-  build:
+  php72:
     docker:
       - image: circleci/php:7.2-cli
 
     working_directory: ~/project
     steps:
       - checkout
-
       - run:
-          name: Install PHPUnit
+          name: Run tests / Symfony 4^3
           command: |
-            composer require phpunit/phpunit:7.5.17  --prefer-dist --prefer-stable --prefer-lowest --no-suggest
+            composer update -n --prefer-dist --prefer-stable --no-suggest
+            php vendor/bin/phpunit
 
       - run:
-          name: Run tests / Symfony 3^3
+          name: Run tests / Symfony 5^0
           command: |
+            composer update -n --prefer-dist --no-suggest
             php vendor/bin/phpunit
 
+  php74:
+    docker:
+      - image: circleci/php:7.4-cli
+
+    working_directory: ~/project
+    steps:
+      - checkout
       - run:
           name: Run tests / Symfony 4^3
           command: |
@@ -28,4 +37,11 @@ jobs:
           name: Run tests / Symfony 5^0
           command: |
             composer update -n --prefer-dist --no-suggest
-            php vendor/bin/phpunit
+            php vendor/bin/phpunit
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - php72
+      - php74

Result/Result.php

@@ -40,9 +40,9 @@ class Result implements HttpTransportable
     /**
      * @var array
      *
-     * Suggests
+     * Suggestions
      */
-    private $suggests = [];
+    private $suggestions = [];
 
     /**
      * @var Aggregations|null
@@ -103,7 +103,7 @@ public function __construct(
      * @param int               $totalItems
      * @param int               $totalHits
      * @param Aggregations|null $aggregations
-     * @param string[]          $suggests
+     * @param string[]          $suggestions
      * @param Item[]            $items
      *
      * @return Result
@@ -113,7 +113,7 @@ public static function create(
         int $totalItems,
         int $totalHits,
         ? Aggregations $aggregations,
-        array $suggests,
+        array $suggestions,
         array $items
     ): self {
         $result = new self(
@@ -123,7 +123,7 @@ public static function create(
         );
 
         $result->aggregations = $aggregations;
-        $result->suggests = $suggests;
+        $result->suggestions = $suggestions;
         $result->items = $items;
 
         return $result;
@@ -298,21 +298,45 @@ public function hasNotEmptyAggregation(string $name): bool
     /**
      * Add suggest.
      *
-     * @param string $suggest
+     * @param string $suggestion
+     *
+     * @deprecated Use addSuggestion instead
+     */
+    public function addSuggest(string $suggestion)
+    {
+        $this->addSuggestion($suggestion);
+    }
+
+    /**
+     * Add suggestion.
+     *
+     * @param string $suggestion
      */
-    public function addSuggest(string $suggest)
+    public function addSuggestion(string $suggestion)
     {
-        $this->suggests[$suggest] = $suggest;
+        $this->suggestions[$suggestion] = $suggestion;
     }
 
     /**
      * Get suggests.
      *
      * @return string[]
+     *
+     * @deprecated Use getSuggestions instead
      */
     public function getSuggests(): array
     {
-        return array_values($this->suggests);
+        return array_values($this->suggestions);
+    }
+
+    /**
+     * Get suggestions.
+     *
+     * @return string[]
+     */
+    public function getSuggestions(): array
+    {
+        return array_values($this->suggestions);
     }
 
     /**
@@ -372,7 +396,7 @@ public function toArray(): array
             'aggregations' => $this->aggregations instanceof Aggregations
                 ? $this->aggregations->toArray()
                 : null,
-            'suggests' => $this->suggests,
+            'suggests' => array_keys($this->suggestions),
             'subresults' => array_map(function (Result $result) {
                 return $result->toArray();
             }, $this->subresults),
@@ -401,7 +425,9 @@ public static function createFromArray(array $array): self
             isset($array['aggregations'])
                 ? Aggregations::createFromArray($array['aggregations'])
                 : null,
-            $array['suggests'] ?? [],
+            isset($array['suggests'])
+                ? array_combine($array['suggests'], $array['suggests'])
+                : [],
             array_map(function (array $item) {
                 return Item::createFromArray($item);
             }, $array['items'] ?? [])

Tests/Result/ResultTest.php

@@ -186,7 +186,7 @@ public function testCreateFromArrayAllValues()
         $this->assertEquals(10, $result->getTotalItems());
         $this->assertEquals(20, $result->getTotalHits());
         $this->assertInstanceof(Aggregation::class, $result->getAggregation('gogo'));
-        $this->assertEquals(['sug1', 'sug2'], $result->getSuggests());
+        $this->assertEquals(['sug1', 'sug2'], $result->getSuggestions());
         $this->assertCount(2, $result->getItems());
         $this->assertEquals('product', $result->getFirstItem()->getType());
     }
@@ -208,4 +208,21 @@ public function testMultiResult()
         $this->assertEquals(4, $subqueries['res2']->getTotalHits());
         $this->assertEquals(5, $subqueries['res3']->getTotalHits());
     }
+
+    /**
+     * Test suggests are a simple array.
+     */
+    public function testSuggest()
+    {
+        $result = new Result('aa', 1, 1);
+        $result->addSuggest('str1');
+        $result->addSuggestion('str1');
+        $result->addSuggestion('str2');
+
+        $this->assertEquals(['str1', 'str2'], $result->getSuggests());
+        $this->assertEquals($result->getSuggests(), $result->getSuggestions());
+        $this->assertEquals(['str1', 'str2'], $result->toArray()['suggests']);
+        $this->assertEquals(['str1', 'str2'], Result::createFromArray($result->toArray())->getSuggests());
+        $this->assertEquals(['str1', 'str2'], Result::createFromArray($result->toArray())->getSuggestions());
+    }
 }

composer.json

@@ -16,6 +16,9 @@
         "symfony/yaml": "^3.4 || ^4.0 || ^5.0",
         "nesbot/carbon": "^1.22 || ^2.0"
     },
+    "require-dev": {
+        "phpunit/phpunit": "7.5.17"
+    },
     "autoload": {
         "psr-4": {
             "Apisearch\\": ""