Merge branch 'refs/heads/v5'

Author: babenkoivan

.github/workflows/code-style.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Install php and composer
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
           coverage: none
           tools: composer:v2
 

.github/workflows/static-analysis.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Install php and composer
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
           coverage: none
           tools: composer:v2
 

.github/workflows/test.yml

@@ -7,24 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [7.4, 8.0, 8.1]
+        php: [8.2]
         include:
-          - php: 7.4
-            scout: 8.0
-            testbench: 6.0
-            phpunit: 9.5
-            elastic-search: 8.0.0
-
-          - php: 8.0
-            scout: 9.0
-            testbench: 7.0
-            phpunit: 9.5
-            elastic-search: 8.4.0
-
-          - php: 8.1
+          - php: 8.2
             scout: 10.0
-            testbench: 8.0
-            phpunit: 9.5
+            testbench: 9.0
+            phpunit: 11.0
             elastic-search: 8.6.2
     steps:
       - name: Checkout code

.gitignore

@@ -3,6 +3,7 @@
 /vendor
 /composer.lock
 /phpunit.xml
+/.phpunit.cache
 /.phpunit.result.cache
 /.php_cs
 /.php_cs.cache

Makefile

@@ -12,7 +12,7 @@ MYSQL_USER := test
 MYSQL_PASSWORD := test
 
 ## elasticsearch config
-ES_VERSION ?= 8.2.0
+ES_VERSION ?= 8.6.0
 ES_CONTAINER_IMAGE := elasticsearch:${ES_VERSION}
 ES_CONTAINER_NAME := elastic-scout-driver-plus-elasticsearch
 ES_HOST_PORT := 29200

README.md

@@ -50,10 +50,12 @@ Elastic Scout Driver Plus supports:
 
 The current version of Elastic Scout Driver Plus has been tested with the following configuration:
 
-* PHP 7.4-8.x
+* PHP 8.2
 * Elasticsearch 8.x
-* Laravel 7.x-10.x
-* Laravel Scout 7.x-10.x
+* Laravel 11.x
+* Laravel Scout 10.x
+
+If your project uses older Laravel (or PHP) version check [the previous major version](https://github.com/babenkoivan/elastic-scout-driver-plus/tree/v4.7.0#compatibility) of the package.
 
 ## Installation
 

composer.json

@@ -38,14 +38,13 @@
         }
     },
     "require": {
-        "php": "^7.4 || ^8.0",
-        "babenkoivan/elastic-scout-driver": "^3.1",
-        "babenkoivan/elastic-adapter": "^3.4"
+        "php": "^8.2",
+        "babenkoivan/elastic-scout-driver": "^4.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5",
-        "orchestra/testbench": "^8.0",
-        "babenkoivan/elastic-migrations": "^3.3",
+        "phpunit/phpunit": "^11.0",
+        "orchestra/testbench": "^9.0",
+        "babenkoivan/elastic-migrations": "^4.0",
         "laravel/scout": "^10.0",
         "friendsofphp/php-cs-fixer": "^3.14",
         "phpstan/phpstan": "^1.10",

phpstan-baseline.neon

@@ -1,7 +1,7 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Method Elastic\\\\ScoutDriverPlus\\\\Builders\\\\SearchParametersBuilder\\:\\:resolveJoinedIndexName\\(\\) should return string but returns mixed\\.$#"
+			message: "#^Method Elastic\\\\ScoutDriverPlus\\\\Builders\\\\SearchParametersBuilder\\:\\:resolveJoinedIndexName\\(\\) should return string but returns string\\|null\\.$#"
 			count: 1
 			path: src/Builders/SearchParametersBuilder.php
 

phpstan.neon.dist

@@ -3,11 +3,11 @@ includes:
 
 parameters:
   level: max
-  checkMissingIterableValueType: false
-  checkGenericClassInNonGenericObjectType: false
   paths:
     - src
   ignoreErrors:
+    - identifier: missingType.iterableValue
+    - identifier: missingType.generics
     - '#Parameter .+? of method Illuminate\\Support\\Collection<.+?>::.+?\(\) expects .+? given#'
     - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Model::(getScoutKey|getScoutKeyName|getScoutModelsByIds|queryScoutModelsByIds|searchableAs|searchableUsing|scoutMetadata|pushSoftDeleteMetadata|toSearchableArray|withTrashed|searchableRouting)\(\)#'
     - '#Call to an undefined method Illuminate\\Support\\Collection::withSearchableRelations\(\)#'

phpunit.xml.dist

@@ -1,22 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.4/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          executionOrder="depends,defects"
-         forceCoversAnnotation="true"
-         beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
-         verbose="true"
-         colors="true">
-    <coverage processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-        <exclude>
-            <file>src/ServiceProvider.php</file>
-        </exclude>
-    </coverage>
+         colors="true"
+         cacheDirectory=".phpunit.cache"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="true">
     <testsuites>
         <testsuite name="unit">
             <directory suffix="Test.php">tests/Unit</directory>
@@ -35,4 +26,12 @@
         <env name="DB_PASSWORD" value="test"/>
         <env name="ELASTIC_HOST" value="127.0.0.1:29200"/>
     </php>
+    <source>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+        <exclude>
+            <file>src/ServiceProvider.php</file>
+        </exclude>
+    </source>
 </phpunit>

tests/Integration/Builders/BoolQueryBuilderTest.php

@@ -2,29 +2,40 @@
 
 namespace Elastic\ScoutDriverPlus\Tests\Integration\Builders;
 
+use Elastic\ScoutDriverPlus\Builders\AbstractParameterizedQueryBuilder;
 use Elastic\ScoutDriverPlus\Builders\BoolQueryBuilder;
+use Elastic\ScoutDriverPlus\Builders\MatchAllQueryBuilder;
+use Elastic\ScoutDriverPlus\Builders\TermQueryBuilder;
 use Elastic\ScoutDriverPlus\Exceptions\QueryBuilderValidationException;
+use Elastic\ScoutDriverPlus\Factories\ParameterFactory;
+use Elastic\ScoutDriverPlus\QueryParameters\ParameterCollection;
+use Elastic\ScoutDriverPlus\QueryParameters\Shared\FieldParameter;
+use Elastic\ScoutDriverPlus\QueryParameters\Shared\ValueParameter;
+use Elastic\ScoutDriverPlus\QueryParameters\Transformers\FlatArrayTransformer;
+use Elastic\ScoutDriverPlus\QueryParameters\Transformers\GroupedArrayTransformer;
+use Elastic\ScoutDriverPlus\QueryParameters\Validators\AllOfValidator;
+use Elastic\ScoutDriverPlus\QueryParameters\Validators\OneOfValidator;
+use Elastic\ScoutDriverPlus\Support\Arr;
 use Elastic\ScoutDriverPlus\Support\Query;
 use Elastic\ScoutDriverPlus\Tests\Integration\TestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 use stdClass;
 
-/**
- * @covers \Elastic\ScoutDriverPlus\Builders\AbstractParameterizedQueryBuilder
- * @covers \Elastic\ScoutDriverPlus\Builders\BoolQueryBuilder
- *
- * @uses   \Elastic\ScoutDriverPlus\Builders\MatchAllQueryBuilder
- * @uses   \Elastic\ScoutDriverPlus\Builders\TermQueryBuilder
- * @uses   \Elastic\ScoutDriverPlus\Factories\ParameterFactory
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\ParameterCollection
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\Shared\FieldParameter
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\Shared\ValueParameter
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\Transformers\FlatArrayTransformer
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\Transformers\GroupedArrayTransformer
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\Validators\AllOfValidator
- * @uses   \Elastic\ScoutDriverPlus\QueryParameters\Validators\OneOfValidator
- * @uses   \Elastic\ScoutDriverPlus\Support\Arr
- * @uses   \Elastic\ScoutDriverPlus\Support\Query
- */
+#[CoversClass(AbstractParameterizedQueryBuilder::class)]
+#[CoversClass(BoolQueryBuilder::class)]
+#[UsesClass(MatchAllQueryBuilder::class)]
+#[UsesClass(TermQueryBuilder::class)]
+#[UsesClass(ParameterFactory::class)]
+#[UsesClass(ParameterCollection::class)]
+#[UsesClass(FieldParameter::class)]
+#[UsesClass(ValueParameter::class)]
+#[UsesClass(FlatArrayTransformer::class)]
+#[UsesClass(GroupedArrayTransformer::class)]
+#[UsesClass(AllOfValidator::class)]
+#[UsesClass(OneOfValidator::class)]
+#[UsesClass(Arr::class)]
+#[UsesClass(Query::class)]
 final class BoolQueryBuilderTest extends TestCase
 {
     private BoolQueryBuilder $builder;

tests/Integration/Builders/DatabaseQueryBuilderTest.php

@@ -3,19 +3,22 @@
 namespace Elastic\ScoutDriverPlus\Tests\Integration\Builders;
 
 use Elastic\ScoutDriverPlus\Builders\DatabaseQueryBuilder;
+use Elastic\ScoutDriverPlus\Engine;
+use Elastic\ScoutDriverPlus\Factories\DocumentFactory;
+use Elastic\ScoutDriverPlus\Factories\RoutingFactory;
+use Elastic\ScoutDriverPlus\Searchable;
 use Elastic\ScoutDriverPlus\Tests\App\Author;
 use Elastic\ScoutDriverPlus\Tests\App\Book;
 use Elastic\ScoutDriverPlus\Tests\Integration\TestCase;
 use Illuminate\Database\Eloquent\Builder;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 
-/**
- * @covers \Elastic\ScoutDriverPlus\Builders\DatabaseQueryBuilder
- *
- * @uses \Elastic\ScoutDriverPlus\Engine
- * @uses \Elastic\ScoutDriverPlus\Factories\DocumentFactory
- * @uses \Elastic\ScoutDriverPlus\Factories\RoutingFactory
- * @uses \Elastic\ScoutDriverPlus\Searchable
- */
+#[CoversClass(DatabaseQueryBuilder::class)]
+#[UsesClass(Engine::class)]
+#[UsesClass(DocumentFactory::class)]
+#[UsesClass(RoutingFactory::class)]
+#[UsesClass(Searchable::class)]
 final class DatabaseQueryBuilderTest extends TestCase
 {
     public function test_query_with_model_that_supports_soft_deletes(): void

tests/Integration/Builders/SearchParametersBuilderTest.php

@@ -3,23 +3,27 @@
 namespace Elastic\ScoutDriverPlus\Tests\Integration\Builders;
 
 use Elastic\Adapter\Search\SearchParameters;
+use Elastic\ScoutDriverPlus\Builders\DatabaseQueryBuilder;
 use Elastic\ScoutDriverPlus\Builders\SearchParametersBuilder;
+use Elastic\ScoutDriverPlus\Engine;
 use Elastic\ScoutDriverPlus\Exceptions\NotSearchableModelException;
+use Elastic\ScoutDriverPlus\Factories\ParameterFactory;
+use Elastic\ScoutDriverPlus\Searchable;
+use Elastic\ScoutDriverPlus\Support\Conditionable;
 use Elastic\ScoutDriverPlus\Tests\App\Author;
 use Elastic\ScoutDriverPlus\Tests\App\Book;
 use Elastic\ScoutDriverPlus\Tests\Integration\TestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 use stdClass;
 
-/**
- * @covers \Elastic\ScoutDriverPlus\Builders\SearchParametersBuilder
- * @covers \Elastic\ScoutDriverPlus\Exceptions\NotSearchableModelException
- * @covers \Elastic\ScoutDriverPlus\Support\Conditionable
- *
- * @uses   \Elastic\ScoutDriverPlus\Builders\DatabaseQueryBuilder
- * @uses   \Elastic\ScoutDriverPlus\Engine
- * @uses   \Elastic\ScoutDriverPlus\Factories\ParameterFactory
- * @uses   \Elastic\ScoutDriverPlus\Searchable
- */
+#[CoversClass(SearchParametersBuilder::class)]
+#[CoversClass(NotSearchableModelException::class)]
+#[CoversClass(Conditionable::class)]
+#[UsesClass(DatabaseQueryBuilder::class)]
+#[UsesClass(Engine::class)]
+#[UsesClass(ParameterFactory::class)]
+#[UsesClass(Searchable::class)]
 final class SearchParametersBuilderTest extends TestCase
 {
     public function test_search_parameters_with_query_can_be_built(): void

tests/Integration/Decorators/HitTest.php

@@ -5,15 +5,15 @@
 use Elastic\Adapter\Search\Hit as BaseHit;
 use Elastic\ScoutDriverPlus\Decorators\Hit;
 use Elastic\ScoutDriverPlus\Factories\LazyModelFactory;
+use Elastic\ScoutDriverPlus\Searchable;
 use Elastic\ScoutDriverPlus\Tests\App\Book;
 use Elastic\ScoutDriverPlus\Tests\Integration\TestCase;
 use Illuminate\Database\Eloquent\Model;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 
-/**
- * @covers \Elastic\ScoutDriverPlus\Decorators\Hit
- *
- * @uses \Elastic\ScoutDriverPlus\Searchable
- */
+#[CoversClass(Hit::class)]
+#[UsesClass(Searchable::class)]
 final class HitTest extends TestCase
 {
     private Hit $hit;

tests/Integration/Decorators/SearchResultTest.php

@@ -7,20 +7,22 @@
 use Elastic\Adapter\Search\SearchResult as BaseSearchResult;
 use Elastic\ScoutDriverPlus\Decorators\Hit;
 use Elastic\ScoutDriverPlus\Decorators\SearchResult;
+use Elastic\ScoutDriverPlus\Decorators\Suggestion;
+use Elastic\ScoutDriverPlus\Factories\LazyModelFactory;
 use Elastic\ScoutDriverPlus\Factories\ModelFactory;
+use Elastic\ScoutDriverPlus\Searchable;
 use Elastic\ScoutDriverPlus\Tests\App\Book;
 use Elastic\ScoutDriverPlus\Tests\App\Model;
 use Elastic\ScoutDriverPlus\Tests\Integration\TestCase;
 use Illuminate\Database\Eloquent\Collection;
-
-/**
- * @covers \Elastic\ScoutDriverPlus\Decorators\SearchResult
- *
- * @uses   \Elastic\ScoutDriverPlus\Decorators\Hit
- * @uses   \Elastic\ScoutDriverPlus\Decorators\Suggestion
- * @uses   \Elastic\ScoutDriverPlus\Factories\LazyModelFactory
- * @uses   \Elastic\ScoutDriverPlus\Searchable
- */
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
+
+#[CoversClass(SearchResult::class)]
+#[UsesClass(Hit::class)]
+#[UsesClass(Suggestion::class)]
+#[UsesClass(LazyModelFactory::class)]
+#[UsesClass(Searchable::class)]
 final class SearchResultTest extends TestCase
 {
     private SearchResult $searchResult;

tests/Integration/Decorators/SuggestionTest.php

@@ -5,22 +5,25 @@
 use Elastic\Adapter\Search\Suggestion as BaseSuggestion;
 use Elastic\ScoutDriverPlus\Builders\DatabaseQueryBuilder;
 use Elastic\ScoutDriverPlus\Decorators\Suggestion;
+use Elastic\ScoutDriverPlus\Engine;
+use Elastic\ScoutDriverPlus\Factories\DocumentFactory;
 use Elastic\ScoutDriverPlus\Factories\ModelFactory;
+use Elastic\ScoutDriverPlus\Factories\RoutingFactory;
+use Elastic\ScoutDriverPlus\Searchable;
 use Elastic\ScoutDriverPlus\Tests\App\Author;
 use Elastic\ScoutDriverPlus\Tests\Integration\TestCase;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 
-/**
- * @covers \Elastic\ScoutDriverPlus\Decorators\Suggestion
- *
- * @uses   \Elastic\ScoutDriverPlus\Builders\DatabaseQueryBuilder
- * @uses   \Elastic\ScoutDriverPlus\Engine
- * @uses   \Elastic\ScoutDriverPlus\Factories\DocumentFactory
- * @uses   \Elastic\ScoutDriverPlus\Factories\ModelFactory
- * @uses   \Elastic\ScoutDriverPlus\Factories\RoutingFactory
- * @uses   \Elastic\ScoutDriverPlus\Searchable
- */
+#[CoversClass(Suggestion::class)]
+#[UsesClass(DatabaseQueryBuilder::class)]
+#[UsesClass(Engine::class)]
+#[UsesClass(DocumentFactory::class)]
+#[UsesClass(ModelFactory::class)]
+#[UsesClass(RoutingFactory::class)]
+#[UsesClass(Searchable::class)]
 final class SuggestionTest extends TestCase
 {
     private Collection $models;