Run Rector to apply Laravel-focused upgrades and improve type safety

oddvalue · oddvalue · commit 5736cad5c50c · 2025-12-04T22:25:51.000Z
diff --git a/composer.json b/composer.json
@@ -18,6 +18,7 @@
     ],
     "require": {
         "php": "^8.0",
+        "driftingly/rector-laravel": "^2.1",
         "illuminate/contracts": "^11.0|^12.0",
         "spatie/laravel-package-tools": "^1.9.2"
     },
diff --git a/rector.php b/rector.php
@@ -3,8 +3,27 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use RectorLaravel\Set\LaravelSetList;
+use RectorLaravel\Set\LaravelSetProvider;
 
 return RectorConfig::configure()
+    ->withSetProviders(LaravelSetProvider::class)
+    ->withSets([
+        LaravelSetList::LARAVEL_ARRAYACCESS_TO_METHOD_CALL,
+        LaravelSetList::LARAVEL_ARRAY_STR_FUNCTION_TO_STATIC_CALL,
+        LaravelSetList::LARAVEL_CODE_QUALITY,
+        LaravelSetList::LARAVEL_COLLECTION,
+        LaravelSetList::LARAVEL_CONTAINER_STRING_TO_FULLY_QUALIFIED_NAME,
+        LaravelSetList::LARAVEL_ELOQUENT_MAGIC_METHOD_TO_QUERY_BUILDER,
+        LaravelSetList::LARAVEL_FACADE_ALIASES_TO_FULL_NAMES,
+        LaravelSetList::LARAVEL_FACTORIES,
+        LaravelSetList::LARAVEL_IF_HELPERS,
+        LaravelSetList::LARAVEL_LEGACY_FACTORIES_TO_CLASSES,
+    ])
+    ->withImportNames(
+        removeUnusedImports: true,
+    )
+    ->withComposerBased(laravel: true)
     ->withPaths([
         __DIR__ . '/config',
         __DIR__ . '/src',
@@ -18,5 +37,4 @@
         typeDeclarations: true,
         privatization: true,
         earlyReturn: true,
-        strictBooleans: true,
     );
diff --git a/src/Concerns/HasDrafts.php b/src/Concerns/HasDrafts.php
@@ -2,7 +2,7 @@
 
 namespace Oddvalue\LaravelDrafts\Concerns;
 
-use Illuminate\Contracts\Database\Query\Builder as QueryBuilder;
+use Closure;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
@@ -339,12 +339,12 @@ public function save(array $options = []): bool
         return parent::save($options);
     }
 
-    public static function savingAsDraft(string|\Closure $callback): void
+    public static function savingAsDraft(string|Closure $callback): void
     {
         static::registerModelEvent('savingAsDraft', $callback);
     }
 
-    public static function savedAsDraft(string|\Closure $callback): void
+    public static function savedAsDraft(string|Closure $callback): void
     {
         static::registerModelEvent('drafted', $callback);
     }
@@ -491,7 +491,7 @@ public function publisher(): MorphTo
     /**
      * @param Builder<Model> $query
      */
-    public function scopeCurrent(Builder $query): void
+    protected function scopeCurrent(Builder $query): void
     {
         /** @phpstan-ignore method.notFound, method.nonObject */
         $query->withDrafts()->where($this->getIsCurrentColumn(), true);
@@ -500,15 +500,15 @@ public function scopeCurrent(Builder $query): void
     /**
      * @param Builder<Model> $query
      */
-    public function scopeWithoutCurrent(Builder $query): void
+    protected function scopeWithoutCurrent(Builder $query): void
     {
         $query->where($this->getIsCurrentColumn(), false);
     }
 
     /**
      * @param Builder<Model> $query
      */
-    public function scopeExcludeRevision(Builder $query, int | Model $exclude): void
+    protected function scopeExcludeRevision(Builder $query, int | Model $exclude): void
     {
         $query->where($this->getKeyName(), '!=', is_int($exclude) ? $exclude : $exclude->getKey());
     }
@@ -517,7 +517,7 @@ public function scopeExcludeRevision(Builder $query, int | Model $exclude): void
      * @deprecated This doesn't actually work, will be removed in next version
      * @param Builder<Model> $query
      */
-    public function scopeWithoutSelf(Builder $query): void
+    protected function scopeWithoutSelf(Builder $query): void
     {
         /** @phpstan-ignore argument.type */
         $query->where('id', '!=', $this->id);
@@ -532,7 +532,7 @@ public function scopeWithoutSelf(Builder $query): void
     /**
      * @return static|null
      */
-    public function getDraftAttribute(): ?self
+    protected function getDraftAttribute(): ?self
     {
         if ($this->relationLoaded('drafts')) {
             /** @phpstan-ignore return.type */
diff --git a/src/Concerns/Publishes.php b/src/Concerns/Publishes.php
@@ -2,13 +2,15 @@
 
 namespace Oddvalue\LaravelDrafts\Concerns;
 
+use Closure;
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Oddvalue\LaravelDrafts\Scopes\PublishingScope;
 
 /**
- * @method static \Illuminate\Database\Eloquent\Builder<static>|\Illuminate\Database\Query\Builder withPublished(bool $withPublished = true)
- * @method static \Illuminate\Database\Eloquent\Builder<static>|\Illuminate\Database\Query\Builder onlyPublished()
- * @method static \Illuminate\Database\Eloquent\Builder<static>|\Illuminate\Database\Query\Builder withoutPublished()
+ * @method static Builder<static>|\Illuminate\Database\Query\Builder withPublished(bool $withPublished = true)
+ * @method static Builder<static>|\Illuminate\Database\Query\Builder onlyPublished()
+ * @method static Builder<static>|\Illuminate\Database\Query\Builder withoutPublished()
  */
 trait Publishes
 {
@@ -70,15 +72,15 @@ public function isPublished(): bool
     /**
      * Register a "published" model event callback with the dispatcher.
      */
-    public static function publishing(string|\Closure $callback): void
+    public static function publishing(string|Closure $callback): void
     {
         static::registerModelEvent('publishing', $callback);
     }
 
     /**
      * Register a "softDeleted" model event callback with the dispatcher.
      */
-    public static function published(string|\Closure $callback): void
+    public static function published(string|Closure $callback): void
     {
         static::registerModelEvent('published', $callback);
     }
diff --git a/src/Facades/LaravelDrafts.php b/src/Facades/LaravelDrafts.php
@@ -2,10 +2,11 @@
 
 namespace Oddvalue\LaravelDrafts\Facades;
 
+use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static \Illuminate\Contracts\Auth\Authenticatable getCurrentUser()
+ * @method static Authenticatable getCurrentUser()
  * @method static void previewMode(bool $previewMode = true)
  * @method static void disablePreviewMode()
  * @method static bool isPreviewModeEnabled()
diff --git a/src/LaravelDraftsServiceProvider.php b/src/LaravelDraftsServiceProvider.php
@@ -2,6 +2,7 @@
 
 namespace Oddvalue\LaravelDrafts;
 
+use Closure;
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Route;
@@ -28,8 +29,7 @@ public function packageRegistered(): void
     {
         $this->app->singleton(LaravelDrafts::class, fn (): LaravelDrafts => new LaravelDrafts());
 
-        /** @phpstan-ignore offsetAccess.nonOffsetAccessible, method.nonObject */
-        $this->app[Kernel::class]->prependToMiddlewarePriority(WithDraftsMiddleware::class);
+        $this->app->make(Kernel::class)->prependToMiddlewarePriority(WithDraftsMiddleware::class);
 
         Blueprint::macro('drafts', function (
             ?string $uuid = null,
@@ -87,7 +87,7 @@ public function packageRegistered(): void
             ]);
         });
 
-        Route::macro('withDrafts', function (\Closure $routes): void {
+        Route::macro('withDrafts', function (Closure $routes): void {
             Route::middleware(WithDraftsMiddleware::class)->group($routes);
         });
     }
diff --git a/src/Scopes/PublishingScope.php b/src/Scopes/PublishingScope.php
@@ -2,7 +2,6 @@
 
 namespace Oddvalue\LaravelDrafts\Scopes;
 
-use Illuminate\Contracts\Database\Query\Builder as QueryBuilder;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Scope;
diff --git a/tests/ConfigTest.php b/tests/ConfigTest.php
@@ -1,6 +1,10 @@
 <?php
 
 
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Oddvalue\LaravelDrafts\Concerns\HasDrafts;
 use Oddvalue\LaravelDrafts\Tests\app\Models\Post;
 
 it('can override columns via config', function (): void {
@@ -13,7 +17,7 @@
             'publisher_morph_name' => 'publisher_override',
         ],
     ]);
-    $post = Post::make();
+    $post = Post::query()->make();
 
     expect($post->getPublishedAtColumn())->toBe('published_at_override')
         ->and($post->getIsPublishedColumn())->toBe('is_published_override')
@@ -48,7 +52,7 @@
 
 it('honors column name overrides', function (): void {
 
-    $post = OverridePost::make([
+    $post = OverridePost::query()->make([
 
     ]);
     invade($post)->newRevision();
@@ -60,10 +64,11 @@
         ->and($post->getPublisherColumns())->toBe(['id' => 'publisher_override_id', 'type' => 'publisher_override_type']);
 });
 
-class OverridePost extends \Illuminate\Database\Eloquent\Model
+class OverridePost extends Model
 {
-    use \Oddvalue\LaravelDrafts\Concerns\HasDrafts;
-    use \Illuminate\Database\Eloquent\SoftDeletes;
+    use HasFactory;
+    use HasDrafts;
+    use SoftDeletes;
 
     public const PUBLISHED_AT = 'published_at_override';
 
diff --git a/tests/DraftableRelationsTest.php b/tests/DraftableRelationsTest.php
@@ -23,7 +23,7 @@
 
     expect($draft->fresh()->sections)->toHaveCount(2)
         ->and($post->fresh()->sections)->toHaveCount(2)
-        ->and(PostSection::count())->toBe(4);
+        ->and(PostSection::query()->count())->toBe(4);
 });
 
 it('can draft BelongsToMany relations', function (): void {
@@ -44,7 +44,7 @@
 
     expect($draft->fresh()->tags)->toHaveCount(2)
         ->and($post->fresh()->tags)->toHaveCount(2)
-        ->and(Tag::count())->toBe(2)
+        ->and(Tag::query()->count())->toBe(2)
         ->and(DB::table('post_tag')->count())->toBe(4);
 });
 
@@ -66,7 +66,7 @@
 
     expect($draft->fresh()->morphToTags)->toHaveCount(2)
         ->and($post->fresh()->morphToTags)->toHaveCount(2)
-        ->and(Tag::count())->toBe(2)
+        ->and(Tag::query()->count())->toBe(2)
         ->and(DB::table('taggables')->count())->toBe(4);
 });
 
@@ -88,5 +88,5 @@
 
     expect($draft->fresh()->section)->toBeInstanceOf(PostSection::class)
         ->and($post->fresh()->section)->toBeInstanceOf(PostSection::class)
-        ->and(PostSection::count())->toBe(2);
+        ->and(PostSection::query()->count())->toBe(2);
 });
diff --git a/tests/DraftsTest.php b/tests/DraftsTest.php
@@ -118,12 +118,12 @@
     $post->updateAsDraft(['title' => 'Baz']);
     $post->updateAsDraft(['title' => 'Qux']);
 
-    expect(Post::find($originalId)->title)->toBe('Foo')
+    expect(Post::query()->find($originalId)->title)->toBe('Foo')
         ->and(DB::table('posts')->count())->toBe(4);
 
     $post->publish()->save();
 
-    expect(Post::find($originalId)->title)->toBe('Qux');
+    expect(Post::query()->find($originalId)->title)->toBe('Qux');
 });
 
 it('can get all revisions excluding self', function (): void {
diff --git a/tests/LaravelDraftsTest.php b/tests/LaravelDraftsTest.php
@@ -1,5 +1,7 @@
 <?php
 
+use Oddvalue\LaravelDrafts\Facades\LaravelDrafts;
+
 it('gets the logged in user', function (): void {
-    $this->assertEquals($this->testUser, \Oddvalue\LaravelDrafts\Facades\LaravelDrafts::getCurrentUser());
+    $this->assertEquals($this->testUser, LaravelDrafts::getCurrentUser());
 });
diff --git a/tests/MiddlewareTest.php b/tests/MiddlewareTest.php
@@ -7,7 +7,7 @@
 use function Pest\Laravel\get;
 
 beforeEach(function (): void {
-    test()->post = Post::create(['title' => 'Hello World']);
+    test()->post = Post::query()->create(['title' => 'Hello World']);
     test()->draftPost = Post::createDraft(['title' => 'Hello World draft']);
 
     Route::middleware(['web'])->group(function (): void {
diff --git a/tests/PublishingTest.php b/tests/PublishingTest.php
@@ -1,5 +1,6 @@
 <?php
 
+use Oddvalue\LaravelDrafts\Facades\LaravelDrafts;
 use Oddvalue\LaravelDrafts\Tests\app\Models\Post;
 
 use function Spatie\PestPluginTestTime\testTime;
@@ -14,7 +15,7 @@
 
 it('can publish a draft model', function (): void {
     testTime()->freeze();
-    Post::create(['title' => 'Hello World']);
+    Post::query()->create(['title' => 'Hello World']);
     Post::withDrafts()->first()->save();
     $this->assertDatabaseHas('posts', [
         'published_at' => now()->toDateTimeString(),
@@ -23,7 +24,7 @@
 
 it('can publish a model', function (): void {
     testTime()->freeze();
-    Post::make(['title' => 'Hello World'])->save();
+    Post::query()->make(['title' => 'Hello World'])->save();
     $this->assertDatabaseHas('posts', [
         'title' => 'Hello World',
         'published_at' => now()->toDateTimeString(),
@@ -68,27 +69,27 @@
 });
 
 it('can publish a draft that is not the current one', function (): void {
-    \Oddvalue\LaravelDrafts\Facades\LaravelDrafts::withDrafts();
+    LaravelDrafts::withDrafts();
 
     Post::factory()->create(['title' => 'a']);
 
-    $post = Post::where('title', 'a')->first();
+    $post = Post::query()->where('title', 'a')->first();
     $post->title = 'b';
 
     $b = $post->saveAsDraft();
 
-    $post = Post::where('title', 'b')->first();
+    $post = Post::query()->where('title', 'b')->first();
     $post->title = 'c';
     $post->saveAsDraft();
 
-    expect(Post::where('title', 'a')->first()->isPublished())->toBeTrue();
-    expect(Post::where('title', 'c')->first()->isCurrent())->toBeTrue();
+    expect(Post::query()->where('title', 'a')->first()->isPublished())->toBeTrue();
+    expect(Post::query()->where('title', 'c')->first()->isCurrent())->toBeTrue();
 
-    $draftB = Post::where('title', 'b')->first();
+    $draftB = Post::query()->where('title', 'b')->first();
     $draftB->setLive();
     $draftB->save();
 
-    expect(Post::where('title', 'a')->first()->isPublished())->toBeFalse();
-    expect(Post::where('title', 'b')->first()->isPublished())->toBeTrue();
-    expect(Post::current()->count())->toBe(1);
+    expect(Post::query()->where('title', 'a')->first()->isPublished())->toBeFalse();
+    expect(Post::query()->where('title', 'b')->first()->isPublished())->toBeTrue();
+    expect(Post::query()->current()->count())->toBe(1);
 });
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/app/Models/PostSection.php b/tests/app/Models/PostSection.php
diff --git a/tests/app/Models/SoftDeletingPost.php b/tests/app/Models/SoftDeletingPost.php
diff --git a/tests/app/Models/Tag.php b/tests/app/Models/Tag.php
diff --git a/tests/app/Models/User.php b/tests/app/Models/User.php

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Oddvalue\LaravelDrafts\Concerns;`
`4`	`4`
`5`		`-use Illuminate\Contracts\Database\Query\Builder as QueryBuilder;`
	`5`	`+use Closure;`
`6`	`6`	`use Illuminate\Database\Eloquent\Builder;`
`7`	`7`	`use Illuminate\Database\Eloquent\Model;`
`8`	`8`	`use Illuminate\Database\Eloquent\Relations\BelongsToMany;`
`@@ -339,12 +339,12 @@ public function save(array $options = []): bool`
`339`	`339`	`return parent::save($options);`
`340`	`340`	`}`
`341`	`341`
`342`		`- public static function savingAsDraft(string\|\Closure $callback): void`
	`342`	`+ public static function savingAsDraft(string\|Closure $callback): void`
`343`	`343`	`{`
`344`	`344`	`static::registerModelEvent('savingAsDraft', $callback);`
`345`	`345`	`}`
`346`	`346`
`347`		`- public static function savedAsDraft(string\|\Closure $callback): void`
	`347`	`+ public static function savedAsDraft(string\|Closure $callback): void`
`348`	`348`	`{`
`349`	`349`	`static::registerModelEvent('drafted', $callback);`
`350`	`350`	`}`
`@@ -491,7 +491,7 @@ public function publisher(): MorphTo`
`491`	`491`	`/**`
`492`	`492`	`* @param Builder<Model> $query`
`493`	`493`	`*/`
`494`		`- public function scopeCurrent(Builder $query): void`
	`494`	`+ protected function scopeCurrent(Builder $query): void`
`495`	`495`	`{`
`496`	`496`	`/** @phpstan-ignore method.notFound, method.nonObject */`
`497`	`497`	`$query->withDrafts()->where($this->getIsCurrentColumn(), true);`
`@@ -500,15 +500,15 @@ public function scopeCurrent(Builder $query): void`
`500`	`500`	`/**`
`501`	`501`	`* @param Builder<Model> $query`
`502`	`502`	`*/`
`503`		`- public function scopeWithoutCurrent(Builder $query): void`
	`503`	`+ protected function scopeWithoutCurrent(Builder $query): void`
`504`	`504`	`{`
`505`	`505`	`$query->where($this->getIsCurrentColumn(), false);`
`506`	`506`	`}`
`507`	`507`
`508`	`508`	`/**`
`509`	`509`	`* @param Builder<Model> $query`
`510`	`510`	`*/`
`511`		`- public function scopeExcludeRevision(Builder $query, int \| Model $exclude): void`
	`511`	`+ protected function scopeExcludeRevision(Builder $query, int \| Model $exclude): void`
`512`	`512`	`{`
`513`	`513`	`$query->where($this->getKeyName(), '!=', is_int($exclude) ? $exclude : $exclude->getKey());`
`514`	`514`	`}`
`@@ -517,7 +517,7 @@ public function scopeExcludeRevision(Builder $query, int \| Model $exclude): void`
`517`	`517`	`* @deprecated This doesn't actually work, will be removed in next version`
`518`	`518`	`* @param Builder<Model> $query`
`519`	`519`	`*/`
`520`		`- public function scopeWithoutSelf(Builder $query): void`
	`520`	`+ protected function scopeWithoutSelf(Builder $query): void`
`521`	`521`	`{`
`522`	`522`	`/** @phpstan-ignore argument.type */`
`523`	`523`	`$query->where('id', '!=', $this->id);`
`@@ -532,7 +532,7 @@ public function scopeWithoutSelf(Builder $query): void`
`532`	`532`	`/**`
`533`	`533`	`* @return static\|null`
`534`	`534`	`*/`
`535`		`- public function getDraftAttribute(): ?self`
	`535`	`+ protected function getDraftAttribute(): ?self`
`536`	`536`	`{`
`537`	`537`	`if ($this->relationLoaded('drafts')) {`
`538`	`538`	`/** @phpstan-ignore return.type */`