Add model factory helper return types

Author: stevebauman

src/Factories/ModelFactory.php

@@ -4,8 +4,9 @@
 
 use DirectoryTree\OpenSearchAdapter\Search\Hit;
 use DirectoryTree\OpenSearchAdapter\Search\SearchResponse;
-use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Collection as SupportCollection;
 use Illuminate\Support\LazyCollection;
 use Laravel\Scout\Builder;
 
@@ -17,15 +18,15 @@ class ModelFactory implements ModelFactoryInterface
     /**
      * Create an Eloquent collection from an OpenSearch response.
      */
-    public function makeFromSearchResponse(SearchResponse $searchResponse, Builder $builder): Collection
+    public function makeFromSearchResponse(SearchResponse $searchResponse, Builder $builder): EloquentCollection
     {
         if (! $searchResponse->total()) {
             return $builder->model->newCollection();
         }
 
         $documentIds = $this->pluckDocumentIds($searchResponse);
 
-        /** @var Collection $models */
+        /** @var EloquentCollection $models */
         $models = $builder->model->getScoutModelsByIds($builder, $documentIds);
 
         return $this->sortModels($this->filterModels($models, $documentIds), $documentIds);
@@ -62,32 +63,28 @@ protected function pluckDocumentIds(SearchResponse $searchResponse): array
     }
 
     /**
-     * Remove models that are no longer present in the database.
-     *
-     * @template T
+     * Sort models into the same order as the OpenSearch response.
      *
-     * @param  T  $models
      * @param  array<int, string>  $documentIds
-     * @return T
      */
-    protected function filterModels($models, array $documentIds)
+    protected function sortModels(EloquentCollection|LazyCollection $models, array $documentIds): SupportCollection|EloquentCollection|LazyCollection
     {
-        return $models->filter(fn (Model $model) => in_array((string) $model->getScoutKey(), $documentIds, true))->values();
+        $documentIdPositions = array_flip($documentIds);
+
+        return $models->sortBy(
+            fn (Model $model) => $documentIdPositions[(string) $model->getScoutKey()]
+        )->values();
     }
 
     /**
-     * Sort models into the same order as the OpenSearch response.
-     *
-     * @template T
+     * Remove models that are no longer present in the database.
      *
-     * @param  T  $models
      * @param  array<int, string>  $documentIds
-     * @return T
      */
-    protected function sortModels($models, array $documentIds)
+    protected function filterModels(EloquentCollection|LazyCollection $models, array $documentIds): SupportCollection|EloquentCollection|LazyCollection
     {
-        $documentIdPositions = array_flip($documentIds);
-
-        return $models->sortBy(fn (Model $model) => $documentIdPositions[(string) $model->getScoutKey()])->values();
+        return $models->filter(
+            fn (Model $model) => in_array((string) $model->getScoutKey(), $documentIds, true)
+        )->values();
     }
 }

tests/Unit/Factories/ModelFactoryTest.php

@@ -8,6 +8,7 @@
 
 it('returns an empty collection for empty search responses', function () {
     $builder = new Builder(new Client, 'john');
+
     $response = new SearchResponse([
         'hits' => [
             'total' => ['value' => 0],