refactor: use native types

Author: joostdebruijn

.gitignore

@@ -5,3 +5,4 @@ composer.phar
 composer.lock
 .phpunit.result.cache
 .phpunit.cache
+.phpstan.cache

composer.json

@@ -23,9 +23,12 @@
         "minishlink/web-push": "^9.0"
     },
     "require-dev": {
+        "laravel/pint": "^1.21",
         "mockery/mockery": "^1.0",
         "orchestra/testbench": "^9.0|^10.0",
-        "phpunit/phpunit": "^10.5|^11.5.3"
+        "larastan/larastan": "^3.1",
+        "phpunit/phpunit": "^10.5|^11.5.3",
+        "rector/rector": "^2.0"
     },
     "autoload": {
         "psr-4": {

phpstan-baseline.neon

@@ -0,0 +1,13 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Method NotificationChannels\\WebPush\\PushSubscription\:\:findByEndpoint\(\) should return static\(NotificationChannels\\WebPush\\PushSubscription\)\|null but returns NotificationChannels\\WebPush\\PushSubscription\|null\.$#'
+			identifier: return.type
+			count: 1
+			path: src/PushSubscription.php
+
+		-
+			message: '#^Method NotificationChannels\\WebPush\\Test\\User\:\:pushSubscriptions\(\) should return Illuminate\\Database\\Eloquent\\Relations\\MorphMany\<NotificationChannels\\WebPush\\PushSubscription, \$this\(NotificationChannels\\WebPush\\Test\\User\)\> but returns Illuminate\\Database\\Eloquent\\Relations\\MorphMany\<Illuminate\\Database\\Eloquent\\Model, \$this\(NotificationChannels\\WebPush\\Test\\User\)\>\.$#'
+			identifier: return.type
+			count: 1
+			path: tests/User.php

phpstan.neon

@@ -0,0 +1,14 @@
+includes:
+    - ./vendor/larastan/larastan/extension.neon
+    - ./phpstan-baseline.neon
+
+parameters:
+
+    paths:
+        - src
+        - tests
+        - migrations/create_push_subscriptions_table.php.stub
+
+    level: 5
+
+    tmpDir: .phpstan.cache

rector.php

@@ -0,0 +1,16 @@
+<?php
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ])
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true,
+        codingStyle: true,
+        typeDeclarations: true,
+    )
+    ->withPhpSets(php82: true);

src/Events/NotificationFailed.php

@@ -3,38 +3,18 @@
 namespace NotificationChannels\WebPush\Events;
 
 use Illuminate\Queue\SerializesModels;
+use Minishlink\WebPush\MessageSentReport;
+use NotificationChannels\WebPush\PushSubscription;
+use NotificationChannels\WebPush\WebPushMessage;
 
 class NotificationFailed
 {
     use SerializesModels;
 
-    /**
-     * @var \Minishlink\WebPush\MessageSentReport
-     */
-    public $report;
-
-    /**
-     * @var \NotificationChannels\WebPush\PushSubscription
-     */
-    public $subscription;
-
-    /**
-     * @var \NotificationChannels\WebPush\WebPushMessage
-     */
-    public $message;
-
     /**
      * Create a new event instance.
      *
-     * @param  \Minishlink\WebPush\MessageSentReport  $report
-     * @param  \NotificationChannels\WebPush\PushSubscription  $subscription
-     * @param  \NotificationChannels\WebPush\WebPushMessage  $message
      * @return void
      */
-    public function __construct($report, $subscription, $message)
-    {
-        $this->report = $report;
-        $this->subscription = $subscription;
-        $this->message = $message;
-    }
+    public function __construct(public MessageSentReport $report, public PushSubscription $subscription, public WebPushMessage $message) {}
 }

src/Events/NotificationSent.php

@@ -3,38 +3,18 @@
 namespace NotificationChannels\WebPush\Events;
 
 use Illuminate\Queue\SerializesModels;
+use Minishlink\WebPush\MessageSentReport;
+use NotificationChannels\WebPush\PushSubscription;
+use NotificationChannels\WebPush\WebPushMessage;
 
 class NotificationSent
 {
     use SerializesModels;
 
-    /**
-     * @var \Minishlink\WebPush\MessageSentReport
-     */
-    public $report;
-
-    /**
-     * @var \NotificationChannels\WebPush\PushSubscription
-     */
-    public $subscription;
-
-    /**
-     * @var \NotificationChannels\WebPush\WebPushMessage
-     */
-    public $message;
-
     /**
      * Create a new event instance.
      *
-     * @param  \Minishlink\WebPush\MessageSentReport  $report
-     * @param  \NotificationChannels\WebPush\PushSubscription  $subscription
-     * @param  \NotificationChannels\WebPush\WebPushMessage  $message
      * @return void
      */
-    public function __construct($report, $subscription, $message)
-    {
-        $this->report = $report;
-        $this->subscription = $subscription;
-        $this->message = $message;
-    }
+    public function __construct(public MessageSentReport $report, public PushSubscription $subscription, public WebPushMessage $message) {}
 }

src/HasPushSubscriptions.php

@@ -2,28 +2,25 @@
 
 namespace NotificationChannels\WebPush;
 
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+
 trait HasPushSubscriptions
 {
     /**
      *  Get all of the subscriptions.
      *
-     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
+     * @return \Illuminate\Database\Eloquent\Relations\MorphMany<PushSubscription, $this>
      */
-    public function pushSubscriptions()
+    public function pushSubscriptions(): MorphMany
     {
         return $this->morphMany(config('webpush.model'), 'subscribable');
     }
 
     /**
      * Update (or create) subscription.
-     *
-     * @param  string  $endpoint
-     * @param  string|null  $key
-     * @param  string|null  $token
-     * @param  string|null  $contentEncoding
-     * @return \NotificationChannels\WebPush\PushSubscription
      */
-    public function updatePushSubscription($endpoint, $key = null, $token = null, $contentEncoding = null)
+    public function updatePushSubscription(string $endpoint, ?string $key = null, ?string $token = null, ?string $contentEncoding = null): PushSubscription
     {
         $subscription = app(config('webpush.model'))->findByEndpoint($endpoint);
 
@@ -50,23 +47,17 @@ public function updatePushSubscription($endpoint, $key = null, $token = null, $c
 
     /**
      * Determine if the model owns the given subscription.
-     *
-     * @param  \NotificationChannels\WebPush\PushSubscription  $subscription
-     * @return bool
      */
-    public function ownsPushSubscription($subscription)
+    public function ownsPushSubscription(PushSubscription $subscription): bool
     {
         return (string) $subscription->subscribable_id === (string) $this->getKey() &&
                         $subscription->subscribable_type === $this->getMorphClass();
     }
 
     /**
      * Delete subscription by endpoint.
-     *
-     * @param  string  $endpoint
-     * @return void
      */
-    public function deletePushSubscription($endpoint)
+    public function deletePushSubscription(string $endpoint): void
     {
         $this->pushSubscriptions()
             ->where('endpoint', $endpoint)
@@ -76,9 +67,9 @@ public function deletePushSubscription($endpoint)
     /**
      * Get all of the subscriptions.
      *
-     * @return \Illuminate\Database\Eloquent\Collection
+     * @return \Illuminate\Database\Eloquent\Collection<\NotificationChannels\WebPush\PushSubscription>
      */
-    public function routeNotificationForWebPush()
+    public function routeNotificationForWebPush(): Collection
     {
         return $this->pushSubscriptions;
     }

src/PushSubscription.php

@@ -3,20 +3,20 @@
 namespace NotificationChannels\WebPush;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
+ * @property int|string $subscribable_id
+ * @property class-string $subscribable_type
  * @property string $endpoint
  * @property string|null $public_key
  * @property string|null $auth_token
  * @property string|null $content_encoding
- * @property \Illuminate\Database\Eloquent\Model $subscribable
  */
 class PushSubscription extends Model
 {
     /**
      * The attributes that are mass assignable.
-     *
-     * @var array
      */
     protected $fillable = [
         'endpoint',
@@ -28,16 +28,15 @@ class PushSubscription extends Model
     /**
      * Create a new model instance.
      *
-     * @param  array  $attributes
      * @return void
      */
     public function __construct(array $attributes = [])
     {
-        if (! isset($this->connection)) {
+        if ($this->connection === null) {
             $this->setConnection(config('webpush.database_connection'));
         }
 
-        if (! isset($this->table)) {
+        if ($this->table === null) {
             $this->setTable(config('webpush.table_name'));
         }
 
@@ -46,22 +45,17 @@ public function __construct(array $attributes = [])
 
     /**
      * Get the model related to the subscription.
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
      */
-    public function subscribable()
+    public function subscribable(): MorphTo
     {
         return $this->morphTo();
     }
 
     /**
-     * Find a subscription by the given endpint.
-     *
-     * @param  string  $endpoint
-     * @return static|null
+     * Find a subscription by the given endpoint.
      */
-    public static function findByEndpoint($endpoint)
+    public static function findByEndpoint(string $endpoint): ?static
     {
-        return static::where('endpoint', $endpoint)->first();
+        return static::firstWhere('endpoint', $endpoint);
     }
 }

src/ReportHandler.php

@@ -2,37 +2,23 @@
 
 namespace NotificationChannels\WebPush;
 
-use Illuminate\Contracts\Events\Dispatcher;
+use Minishlink\WebPush\MessageSentReport;
 use NotificationChannels\WebPush\Events\NotificationFailed;
 use NotificationChannels\WebPush\Events\NotificationSent;
 
 class ReportHandler implements ReportHandlerInterface
 {
-    /**
-     * @var \Illuminate\Contracts\Events\Dispatcher
-     */
-    protected $events;
-
     /**
      * Create a new report handler.
      *
-     * @param  \Illuminate\Contracts\Events\Dispatcher  $events
      * @return void
      */
-    public function __construct(Dispatcher $events)
-    {
-        $this->events = $events;
-    }
+    public function __construct(protected \Illuminate\Contracts\Events\Dispatcher $events) {}
 
     /**
      * Handle a message sent report.
-     *
-     * @param  \Minishlink\WebPush\MessageSentReport  $report
-     * @param  \NotificationChannels\WebPush\PushSubscription  $subscription
-     * @param  \NotificationChannels\WebPush\WebPushMessage  $message
-     * @return void
      */
-    public function handleReport($report, $subscription, $message)
+    public function handleReport(MessageSentReport $report, PushSubscription $subscription, WebPushMessage $message): void
     {
         if ($report->isSuccess()) {
             $this->events->dispatch(new NotificationSent($report, $subscription, $message));