feat: add Laravel 12 support (#355)

* Bump dependencies for Laravel 12

* Update config.yml

* Update composer.json

* phpstan

* Update TestCase.php

---------

Co-authored-by: Shift <[email protected]>

Author: DevinCodes

.circleci/config.yml

@@ -95,5 +95,10 @@ workflows:
       - test:
           matrix:
             parameters:
-              version: ['8.2']
+              version: ['8.2', '8.3', '8.4']
               laravel: ['^11.0']
+      - test:
+          matrix:
+            parameters:
+              version: ['8.2', '8.3', '8.4']
+              laravel: ['^12.0']

composer.json

@@ -25,11 +25,11 @@
         "php": "^8.0",
         "ext-json": "*",
         "algolia/algoliasearch-client-php": "^3.0.0",
-        "illuminate/console": "^9.0|^10.0|^11.0",
-        "illuminate/contracts": "^9.0|^10.0|^11.0",
-        "illuminate/database": "^9.0|^10.0|^11.0",
-        "illuminate/filesystem": "^9.0|^10.0|^11.0",
-        "illuminate/support": "^9.0|^10.0|^11.0",
+        "illuminate/console": "^9.0|^10.0|^11.0|^12.0",
+        "illuminate/contracts": "^9.0|^10.0|^11.0|^12.0",
+        "illuminate/database": "^9.0|^10.0|^11.0|^12.0",
+        "illuminate/filesystem": "^9.0|^10.0|^11.0|^12.0",
+        "illuminate/support": "^9.0|^10.0|^11.0|^12.0",
         "laravel/scout": "^9.0|^10.0",
         "riimu/kit-phpencoder": "^2.4"
     },
@@ -39,10 +39,10 @@
     "require-dev": {
         "fakerphp/faker": "^1.13",
         "mockery/mockery": "^1.4",
-        "nunomaduro/larastan": "^1.0|^2.0",
-        "orchestra/testbench": "^4.9|^5.9|^6.6|^7.0|^8.0|^9.0",
-        "phpstan/phpstan": "^1.3",
-        "phpunit/phpunit": "^8.0|^9.0|^10.5",
+        "larastan/larastan": "^1.0|^2.0|^3.0",
+        "orchestra/testbench": "^4.9|^5.9|^6.6|^7.0|^8.0|^9.0|^10.0",
+        "phpstan/phpstan": "^1.3|^2.1",
+        "phpunit/phpunit": "^8.0|^9.0|^10.5|^11.5.3",
         "laravel/legacy-factories": "^1.1"
     },
     "autoload-dev": {

phpstan.neon.dist

@@ -1,5 +1,5 @@
 includes:
-    - vendor/nunomaduro/larastan/extension.neon
+    - vendor/larastan/larastan/extension.neon
 parameters:
     level: 5
     paths:

src/Exceptions/ModelNotDefinedInAggregatorException.php

@@ -21,7 +21,7 @@ class ModelNotDefinedInAggregatorException extends RuntimeException
     /**
      * {@inheritdoc}
      */
-    public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
+    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
     {
         if (empty($message)) {
             $message = 'Model not defined in aggregator.';

src/Exceptions/SettingsNotFound.php

@@ -21,7 +21,7 @@ class SettingsNotFound extends Exception
     /**
      * {@inheritdoc}
      */
-    public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
+    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
     {
         if (empty($message)) {
             $message = 'Settings not found.';

src/ScoutExtendedServiceProvider.php

@@ -125,7 +125,7 @@ private function registerCommands(): void
      */
     private function registerMacros(): void
     {
-        \Illuminate\Database\Eloquent\Builder::macro('transform', function (array $array, array $transformers = null) {
+        \Illuminate\Database\Eloquent\Builder::macro('transform', function (array $array, ?array $transformers = null) {
             foreach ($transformers ?? UpdateJob::getTransformers() as $transformer) {
                 $array = app($transformer)->transform($this->getModel(), $array);
             }

src/Searchable/AggregatorCollection.php

@@ -47,7 +47,7 @@ public function unsearchable(): void
     /**
      * Prepare the instance for serialization.
      *
-     * @return array []string
+     * @return string[]
      */
     public function __sleep()
     {

src/Searchable/ObjectIdEncrypter.php

@@ -37,7 +37,7 @@ class ObjectIdEncrypter
      *
      * @return string
      */
-    public static function encrypt($searchable, int $part = null): string
+    public static function encrypt($searchable, ?int $part = null): string
     {
         $scoutKey = method_exists($searchable, 'getScoutKey') ? $searchable->getScoutKey() : $searchable->getKey();
 
@@ -89,7 +89,7 @@ private static function getSearchableExploded(string $objectId): array
     {
         $parts = explode(self::$separator, $objectId);
 
-        if (! is_array($parts) || count($parts) < 2) {
+        if (count($parts) < 2) {
             throw new ShouldReimportSearchableException('ObjectID seems invalid. You may need to
                 re-import your data using the `scout-reimport` Artisan command.');
         }

src/Settings/LocalFactory.php

@@ -223,7 +223,7 @@ public function isCustomRanking(string $key, $value): bool
      */
     public function isDisableTypoToleranceOnAttributes(string $key, $value): bool
     {
-        return is_string($key) && Str::is(self::$disableTypoToleranceOnAttributesKeys, $key);
+        return Str::is(self::$disableTypoToleranceOnAttributesKeys, $key);
     }
 
     /**
@@ -236,7 +236,7 @@ public function isDisableTypoToleranceOnAttributes(string $key, $value): bool
      */
     public function isUnretrievableAttributes(string $key, $value): bool
     {
-        return is_string($key) && Str::is(self::$unretrievableAttributes, $key);
+        return Str::is(self::$unretrievableAttributes, $key);
     }
 
     /**

src/Splitters/HtmlSplitter.php

@@ -35,11 +35,11 @@ class HtmlSplitter implements SplitterContract
     /**
      * Creates a new instance of the class.
      *
-     * @param array $tags
+     * @param array|null $tags
      *
      * @return void
      */
-    public function __construct(array $tags = null)
+    public function __construct(?array $tags = null)
     {
         if ($tags !== null) {
             $this->tags = $tags;

tests/TestCase.php

@@ -81,7 +81,7 @@ protected function defaults(): array
         return $defaults;
     }
 
-    protected function assertLocalHas(array $settings, string $settingsPath = null): void
+    protected function assertLocalHas(array $settings, ?string $settingsPath = null): void
     {
         if ($settingsPath === null) {
             $settingsPath = config_path('scout-users.php');
@@ -145,7 +145,7 @@ protected function mockClient(): MockInterface
         return $clientMock;
     }
 
-    protected function mockIndex(string $model, array $settings = [], array $userData = null): MockInterface
+    protected function mockIndex(string $model, array $settings = [], ?array $userData = null): MockInterface
     {
         $indexMock = mock(SearchIndex::class);
         $indexName = class_exists($model) ? (new $model)->searchableAs() : $model;
@@ -173,7 +173,7 @@ protected function mockIndex(string $model, array $settings = [], array $userDat
         return $indexMock;
     }
 
-    protected function assertSettingsSet($indexMock, array $settings, array $userData = null): void
+    protected function assertSettingsSet($indexMock, array $settings, ?array $userData = null): void
     {
         if (! empty($settings)) {
             $indexMock->shouldReceive('setSettings')->once()->with($settings)->andReturn($this->mockResponse());