refactor: modernise package for PHP 8.4 — final classes, readonly, typed properties

final:
- Subscriber, SubscribableServiceProvider, FakeSubscriber
- UnsubscribeController, LegacyUnsubscribeController
- UserUnsubscribed, UserUnsubscribing

SubscribableMailMessage and the SubscribableNotification trait are left
open — the composable design depends on subclassing.

readonly / constructor property promotion:
- Events use public readonly constructor promotion; $user type corrected
  from the misleading Illuminate\Foundation\Auth\User to object
- UnsubscribeController and LegacyUnsubscribeController use private readonly
- Subscriber promotes $app to private readonly

Typed callable properties:
- Subscriber's five handler properties are now private \Closure|null
- parseHandler() returns \Closure via \Closure::fromCallable(), using
  Str::parseCallback()'s second argument for the default method name
- Invocation uses first-class callable style: ($this->onFoo)($args)

Other cleanup:
- $hander typo corrected to $handler throughout
- Missing return types added (routeName, checkSubscriptionStatus, etc.)
- Protected visibility on Subscriber/FakeSubscriber internals tightened
  to private (no subclassing possible on final classes)
- Redundant @param/@return docblocks removed where signatures suffice
- SubscribableServiceProvider::register() simplified to a short closure
- FakeSubscriber gains assertCheckedSubscriptionStatus() so tests that
  previously used Subscriber::shouldReceive() (incompatible with final)
  can still verify argument routing via the fake

https://claude.ai/code/session_01R4pAjWwGY8xKspsdU8xnsy

Author: claude

src/Controllers/LegacyUnsubscribeController.php

@@ -6,14 +6,14 @@
 use Illuminate\Routing\Controller;
 use YlsIdeas\SubscribableNotifications\Subscriber;
 
-class LegacyUnsubscribeController extends Controller
+final class LegacyUnsubscribeController extends Controller
 {
     public function __construct(private readonly Subscriber $subscriber)
     {
         $this->middleware('signed');
     }
 
-    public function __invoke(Request $request, $subscriberId, ?string $mailingList = null)
+    public function __invoke(Request $request, mixed $subscriberId, ?string $mailingList = null): mixed
     {
         return app(UnsubscribeController::class)(
             $request,

src/Controllers/UnsubscribeController.php

@@ -4,43 +4,20 @@
 
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Http\Request;
-use Illuminate\Http\Response;
 use Illuminate\Routing\Controller;
 use YlsIdeas\SubscribableNotifications\Contracts\CanUnsubscribe;
 use YlsIdeas\SubscribableNotifications\Events\UserUnsubscribed;
 use YlsIdeas\SubscribableNotifications\Events\UserUnsubscribing;
 use YlsIdeas\SubscribableNotifications\Subscriber;
 
-/**
- * Class UnsubscribeController.
- */
-class UnsubscribeController extends Controller
+final class UnsubscribeController extends Controller
 {
-    /**
-     * @var Subscriber
-     */
-    protected $subscriber;
-
-    /**
-     * UnsubscribeController constructor.
-     * @param Subscriber $subscriber
-     */
-    public function __construct(Subscriber $subscriber)
+    public function __construct(private readonly Subscriber $subscriber)
     {
         $this->middleware('signed');
-        $this->subscriber = $subscriber;
     }
 
-    /**
-     * Handle the incoming request.
-     *
-     * @param Request $request
-     * @param string $subscriberType
-     * @param mixed $subscriberId
-     * @param string|null $mailingList
-     * @return Response
-     */
-    public function __invoke(Request $request, string $subscriberType, $subscriberId, ?string $mailingList = null)
+    public function __invoke(Request $request, string $subscriberType, mixed $subscriberId, ?string $mailingList = null): mixed
     {
         $modelClass = Relation::getMorphedModel($subscriberType) ?? $subscriberType;
 
@@ -68,7 +45,6 @@ public function __invoke(Request $request, string $subscriberType, $subscriberId
 
         event(new UserUnsubscribed($subscriber, $mailingList));
 
-        // RFC 8058: one-click POST must not redirect; return 204 No Content
         if ($request->isMethod('post')) {
             return response('', 204);
         }

src/Events/UserUnsubscribed.php

@@ -2,22 +2,10 @@
 
 namespace YlsIdeas\SubscribableNotifications\Events;
 
-use Illuminate\Foundation\Auth\User;
-
-class UserUnsubscribed
+final class UserUnsubscribed
 {
-    /**
-     * @var User
-     */
-    public $user;
-    /**
-     * @var string|null
-     */
-    public $mailingList;
-
-    public function __construct($user, ?string $mailingList = null)
-    {
-        $this->user = $user;
-        $this->mailingList = $mailingList;
-    }
+    public function __construct(
+        public readonly object $user,
+        public readonly ?string $mailingList = null,
+    ) {}
 }

src/Events/UserUnsubscribing.php

@@ -2,22 +2,10 @@
 
 namespace YlsIdeas\SubscribableNotifications\Events;
 
-use Illuminate\Foundation\Auth\User;
-
-class UserUnsubscribing
+final class UserUnsubscribing
 {
-    /**
-     * @var User
-     */
-    public $user;
-    /**
-     * @var string|null
-     */
-    public $mailingList;
-
-    public function __construct($user, ?string $mailingList = null)
-    {
-        $this->user = $user;
-        $this->mailingList = $mailingList;
-    }
+    public function __construct(
+        public readonly object $user,
+        public readonly ?string $mailingList = null,
+    ) {}
 }

src/Facades/Subscriber.php

@@ -26,7 +26,7 @@
  */
 class Subscriber extends Facade
 {
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return \YlsIdeas\SubscribableNotifications\Subscriber::class;
     }

src/MailSubscriber.php

@@ -9,10 +9,6 @@
 
 trait MailSubscriber
 {
-    /**
-     * @param string|null $mailingList
-     * @return string
-     */
     public function unsubscribeLink(?string $mailingList = null): string
     {
         return URL::signedRoute(
@@ -25,10 +21,6 @@ public function unsubscribeLink(?string $mailingList = null): string
         );
     }
 
-    /**
-     * @param Notification $notification
-     * @return bool
-     */
     public function mailSubscriptionStatus(Notification $notification): bool
     {
         $list = $notification instanceof AppliesToMailingList

src/SubscribableServiceProvider.php

@@ -2,14 +2,13 @@
 
 namespace YlsIdeas\SubscribableNotifications;
 
-use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Notifications\Events\NotificationSending;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider;
 use YlsIdeas\SubscribableNotifications\Contracts\CheckNotifiableSubscriptionStatus;
 use YlsIdeas\SubscribableNotifications\Contracts\CheckSubscriptionStatusBeforeSendingNotifications;
 
-class SubscribableServiceProvider extends ServiceProvider
+final class SubscribableServiceProvider extends ServiceProvider
 {
     public function boot(): void
     {
@@ -40,9 +39,6 @@ public function boot(): void
 
     public function register(): void
     {
-        $this->app->singleton(Subscriber::class, function (Application $app) {
-            /** @phpstan-ignore-next-line */
-            return new Subscriber($app);
-        });
+        $this->app->singleton(Subscriber::class, fn () => new Subscriber($this->app));
     }
 }

src/Subscriber.php

@@ -4,57 +4,35 @@
 
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\Eloquent\Relations\Relation;
-use Illuminate\Http\Response;
 use Illuminate\Support\Str;
 
-class Subscriber
+final class Subscriber
 {
-    public $uri = 'unsubscribe/{subscriberType}/{subscriberId}/{mailingList?}';
-    public $hander = '\YlsIdeas\SubscribableNotifications\Controllers\UnsubscribeController';
-    public $routeName = 'unsubscribe';
+    public string $uri = 'unsubscribe/{subscriberType}/{subscriberId}/{mailingList?}';
+    public string $handler = '\YlsIdeas\SubscribableNotifications\Controllers\UnsubscribeController';
+    public string $routeName = 'unsubscribe';
 
     /** Morph type stored when legacyRoutes() is called — used by LegacyUnsubscribeController. */
     public ?string $legacySubscriberType = null;
-    /**
-     * @var callable
-     */
-    protected $onUnsubscribeFromMailingList;
-    /**
-     * @var callable
-     */
-    protected $onUnsubscribeFromAllMailingLists;
-    /**
-     * @var callable
-     */
-    protected $onCompletion;
-    /**
-     * @var callable
-     */
-    protected $onCheckSubscriptionStatusForMailingLists;
-    /**
-     * @var callable
-     */
-    protected $onCheckSubscriptionStatusForAllMailingLists;
-
-    /**
-     * @var Application
-     */
-    protected $app;
-
-    public function __construct(Application $app)
-    {
-        $this->app = $app;
-    }
 
-    public function routes($router = null): void
+    private ?\Closure $onUnsubscribeFromMailingList = null;
+    private ?\Closure $onUnsubscribeFromAllMailingLists = null;
+    private ?\Closure $onCompletion = null;
+    private ?\Closure $onCheckSubscriptionStatusForMailingLists = null;
+    private ?\Closure $onCheckSubscriptionStatusForAllMailingLists = null;
+
+    public function __construct(private readonly Application $app)
+    {}
+
+    public function routes(mixed $router = null): void
     {
         $router = $router ?? $this->app->make('router');
-        $router->match(['GET', 'POST'], $this->uri, $this->hander)
+        $router->match(['GET', 'POST'], $this->uri, $this->handler)
             ->name($this->routeName)
             ->where('subscriberType', '[^\d/][^/]*');
     }
 
-    public function legacyRoutes(string $defaultModel, $router = null): void
+    public function legacyRoutes(string $defaultModel, mixed $router = null): void
     {
         $router = $router ?? $this->app->make('router');
 
@@ -68,110 +46,69 @@ public function legacyRoutes(string $defaultModel, $router = null): void
         )->name($this->routeName . '.legacy');
     }
 
-    /**
-     * @return string
-     */
-    public function routeName()
+    public function routeName(): string
     {
         return $this->routeName;
     }
 
-    /**
-     * @param string|callable $handler
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
-     */
-    public function onUnsubscribeFromMailingList($handler)
+    public function onUnsubscribeFromMailingList(string|callable $handler): void
     {
         $this->onUnsubscribeFromMailingList = $this->parseHandler($handler);
     }
 
-    /**
-     * @param string|callable $handler
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
-     */
-    public function onUnsubscribeFromAllMailingLists($handler)
+    public function onUnsubscribeFromAllMailingLists(string|callable $handler): void
     {
         $this->onUnsubscribeFromAllMailingLists = $this->parseHandler($handler);
     }
 
-    /**
-     * @param string|callable $handler
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
-     */
-    public function onCompletion($handler)
+    public function onCompletion(string|callable $handler): void
     {
         $this->onCompletion = $this->parseHandler($handler);
     }
 
-    /**
-     * @param string|callable $handler
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
-     */
-    public function onCheckSubscriptionStatusOfAllMailingLists($handler)
+    public function onCheckSubscriptionStatusOfAllMailingLists(string|callable $handler): void
     {
         $this->onCheckSubscriptionStatusForAllMailingLists = $this->parseHandler($handler);
     }
 
-    /**
-     * @param string|callable $handler
-     * @throws \Illuminate\Contracts\Container\BindingResolutionException
-     */
-    public function onCheckSubscriptionStatusOfMailingList($handler)
+    public function onCheckSubscriptionStatusOfMailingList(string|callable $handler): void
     {
         $this->onCheckSubscriptionStatusForMailingLists = $this->parseHandler($handler);
     }
 
-    /**
-     * @param mixed $user
-     * @param string $mailingList
-     */
-    public function unsubscribeFromMailingList($user, string $mailingList)
+    public function unsubscribeFromMailingList(mixed $user, string $mailingList): void
     {
-        call_user_func($this->onUnsubscribeFromMailingList, $user, $mailingList);
+        ($this->onUnsubscribeFromMailingList)($user, $mailingList);
     }
 
-    /**
-     * @param mixed $user
-     */
-    public function unsubscribeFromAllMailingLists($user)
+    public function unsubscribeFromAllMailingLists(mixed $user): void
     {
-        call_user_func($this->onUnsubscribeFromAllMailingLists, $user);
+        ($this->onUnsubscribeFromAllMailingLists)($user);
     }
 
-    /**
-     * @param mixed $user
-     * @param string|null $mailingList
-     * @return Response
-     */
-    public function complete($user, ?string $mailingList = null)
+    public function complete(mixed $user, ?string $mailingList = null): mixed
     {
-        return call_user_func($this->onCompletion, $user, $mailingList);
+        return ($this->onCompletion)($user, $mailingList);
     }
 
-    /**
-     * @param mixed $user
-     * @param string|null $mailingList
-     * @return bool
-     */
-    public function checkSubscriptionStatus($user, ?string $mailingList = null)
+    public function checkSubscriptionStatus(mixed $user, ?string $mailingList = null): bool
     {
         if ($mailingList !== null) {
-            return (bool) call_user_func($this->onCheckSubscriptionStatusForAllMailingLists, $user) &&
-                (bool) call_user_func($this->onCheckSubscriptionStatusForMailingLists, $user, $mailingList);
+            return (bool) ($this->onCheckSubscriptionStatusForAllMailingLists)($user)
+                && (bool) ($this->onCheckSubscriptionStatusForMailingLists)($user, $mailingList);
         }
 
-        return (bool) call_user_func($this->onCheckSubscriptionStatusForAllMailingLists, $user);
+        return (bool) ($this->onCheckSubscriptionStatusForAllMailingLists)($user);
     }
 
-    protected function parseHandler(string|callable$handler): callable
+    private function parseHandler(string|callable $handler): \Closure
     {
         if (is_string($handler)) {
-            $parsed = Str::parseCallback($handler);
-            $parsed[0] = $this->app->make($parsed[0]);
+            [$class, $method] = Str::parseCallback($handler, '__invoke');
 
-            return $parsed;
+            return \Closure::fromCallable([$this->app->make($class), $method]);
         }
 
-        return $handler;
+        return \Closure::fromCallable($handler);
     }
 }