Merge pull request #6 from olekjs/dev-release-v1.5.0

Dev release v1.5.0

Author: olekjs

src/Contracts/Collectionable.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Olekjs\Elasticsearch\Contracts;
+
+use Illuminate\Support\Collection;
+
+interface Collectionable
+{
+    public function toCollect(): Collection;
+}

src/Dto/SearchResponseDto.php

@@ -3,15 +3,17 @@
 namespace Olekjs\Elasticsearch\Dto;
 
 use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Support\Collection;
+use Olekjs\Elasticsearch\Contracts\Collectionable;
 use Olekjs\Elasticsearch\Contracts\ResponseDtoInterface;
 
-class SearchResponseDto implements ResponseDtoInterface, Arrayable
+class SearchResponseDto implements ResponseDtoInterface, Arrayable, Collectionable
 {
     public function __construct(
         private readonly int $took,
         private readonly bool $isTimedOut,
         private readonly ShardsResponseDto $shards,
-        private readonly SearchHitsDto $results,
+        private readonly SearchHitsDto $result,
     ) {
     }
 
@@ -25,9 +27,9 @@ public function getIsTimedOut(): bool
         return $this->isTimedOut;
     }
 
-    public function getResults(): SearchHitsDto
+    public function getResult(): SearchHitsDto
     {
-        return $this->results;
+        return $this->result;
     }
 
     public function getShards(): ShardsResponseDto
@@ -41,7 +43,17 @@ public function toArray(): array
             'took' => $this->getTook(),
             'is_timed_out' => $this->getIsTimedOut(),
             'shards' => $this->getShards()->toArray(),
-            'results' => $this->getResults()->toArray(),
+            'results' => $this->getResult()->toArray(),
         ];
     }
+
+    public function toCollect(): Collection
+    {
+        $hits = array_map(
+            fn(SearchHitDto $searchHitDto) => $searchHitDto->getSource(),
+            $this->getResult()->getHits()
+        );
+
+        return Collection::make($hits);
+    }
 }

src/Utils/SearchResponse.php

@@ -22,7 +22,7 @@ public static function from(Response $response, array $data = []): SearchRespons
                 failed: data_get($response, '_shards.failed'),
                 skipped: data_get($response, '_shards.skipped'),
             ),
-            results: new SearchHitsDto(
+            result: new SearchHitsDto(
                 total: data_get($response, 'hits.total'),
                 maxScore: data_get($response, 'hits.max_score'),
                 hits: array_map(

tests/Integration/ClientTest.php

@@ -2,9 +2,11 @@
 
 namespace Olekjs\Elasticsearch\Tests\Integration;
 
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Http;
 use Olekjs\Elasticsearch\Client;
 use Olekjs\Elasticsearch\Dto\PaginateResponseDto;
+use Olekjs\Elasticsearch\Dto\SearchHitDto;
 use Olekjs\Elasticsearch\Dto\SearchResponseDto;
 use Olekjs\Elasticsearch\Exceptions\ConflictResponseException;
 use Olekjs\Elasticsearch\Exceptions\DeleteResponseException;
@@ -43,10 +45,10 @@ public function testSearchMethod(): void
 
         $this->assertFalse($result->getIsTimedOut());
 
-        $this->assertSame(['value' => 5, 'relation' => 'eq'], $result->getResults()->getTotal());
-        $this->assertSame(1.0, $result->getResults()->getMaxScore());
+        $this->assertSame(['value' => 5, 'relation' => 'eq'], $result->getResult()->getTotal());
+        $this->assertSame(1.0, $result->getResult()->getMaxScore());
 
-        foreach ($result->getResults()->getHits() as $hit) {
+        foreach ($result->getResult()->getHits() as $hit) {
             $this->assertSame('hello', $hit->getIndex());
             $this->assertSame('183865906814918156', $hit->getId());
             $this->assertSame(1.0, $hit->getScore());
@@ -447,9 +449,9 @@ public function testEmptyResponseInSearchMethod(): void
 
         $this->assertFalse($result->getIsTimedOut());
 
-        $this->assertSame(['value' => 0, 'relation' => 'eq'], $result->getResults()->getTotal());
-        $this->assertNull($result->getResults()->getMaxScore());
-        $this->assertEmpty($result->getResults()->getHits());
+        $this->assertSame(['value' => 0, 'relation' => 'eq'], $result->getResult()->getTotal());
+        $this->assertNull($result->getResult()->getMaxScore());
+        $this->assertEmpty($result->getResult()->getHits());
     }
 
     public function testSearchWhereInMethod(): void
@@ -473,10 +475,10 @@ public function testSearchWhereInMethod(): void
 
         $this->assertFalse($result->getIsTimedOut());
 
-        $this->assertSame(['value' => 2, 'relation' => 'eq'], $result->getResults()->getTotal());
-        $this->assertSame(1.0, $result->getResults()->getMaxScore());
+        $this->assertSame(['value' => 2, 'relation' => 'eq'], $result->getResult()->getTotal());
+        $this->assertSame(1.0, $result->getResult()->getMaxScore());
 
-        foreach ($result->getResults()->getHits() as $hit) {
+        foreach ($result->getResult()->getHits() as $hit) {
             $this->assertSame('hello', $hit->getIndex());
             $this->assertSame('183865906814918156', $hit->getId());
             $this->assertSame(1.0, $hit->getScore());
@@ -505,10 +507,10 @@ public function testSearchWhereKeywordMethod(): void
 
         $this->assertFalse($result->getIsTimedOut());
 
-        $this->assertSame(['value' => 1, 'relation' => 'eq'], $result->getResults()->getTotal());
-        $this->assertSame(1.6739764, $result->getResults()->getMaxScore());
+        $this->assertSame(['value' => 1, 'relation' => 'eq'], $result->getResult()->getTotal());
+        $this->assertSame(1.6739764, $result->getResult()->getMaxScore());
 
-        foreach ($result->getResults()->getHits() as $hit) {
+        foreach ($result->getResult()->getHits() as $hit) {
             $this->assertSame('hello', $hit->getIndex());
             $this->assertSame('183865906814918156', $hit->getId());
             $this->assertSame(1.6739764, $hit->getScore());
@@ -537,10 +539,10 @@ public function testSearchWhereLikeMethod(): void
 
         $this->assertFalse($result->getIsTimedOut());
 
-        $this->assertSame(['value' => 1, 'relation' => 'eq'], $result->getResults()->getTotal());
-        $this->assertSame(1.0, $result->getResults()->getMaxScore());
+        $this->assertSame(['value' => 1, 'relation' => 'eq'], $result->getResult()->getTotal());
+        $this->assertSame(1.0, $result->getResult()->getMaxScore());
 
-        foreach ($result->getResults()->getHits() as $hit) {
+        foreach ($result->getResult()->getHits() as $hit) {
             $this->assertSame('hello', $hit->getIndex());
             $this->assertSame('183865906814918156', $hit->getId());
             $this->assertSame(1.0, $hit->getScore());
@@ -657,4 +659,27 @@ public function testPaginateMethod(): void
 
         $this->assertInstanceOf(SearchResponseDto::class, $result->getDocuments());
     }
+
+    public function testSearchResponseCanBeConvertedToCollection(): void
+    {
+        Http::fake(function () {
+            return Http::response(
+                file_get_contents('tests/Responses/search_success_response.json')
+            );
+        });
+
+        $client = new Client();
+
+        $result = $client->search('hello', [
+            'query' => [
+                'match_all' => (object)[]
+            ]
+        ]);
+
+        $this->assertInstanceOf(Collection::class, $result->toCollect());
+
+        foreach ($result->toCollect() as $source) {
+            $this->assertSame(['hello' => 'world'], $source);
+        }
+    }
 }

tests/Unit/DtosTest.php

@@ -11,10 +11,11 @@
 use Olekjs\Elasticsearch\Dto\ShardsResponseDto;
 use PHPUnit\Framework\TestCase;
 use Illuminate\Contracts\Support\Arrayable;
+use Olekjs\Elasticsearch\Contracts\Collectionable;
 
 class DtosTest extends TestCase
 {
-    public function testDtosAreArrayableMethod(): void
+    public function testDtosAreArrayable(): void
     {
         $dtos = [
             FindResponseDto::class,
@@ -32,4 +33,11 @@ public function testDtosAreArrayableMethod(): void
             $this->assertContains(Arrayable::class, $interfaces);
         }
     }
+
+    public function testSearchResponseIsCollectionable(): void
+    {
+        $interfaces = class_implements(SearchResponseDto::class);
+
+        $this->assertContains(Collectionable::class, $interfaces);
+    }
 }