pref: enhance exception handling and add PHPStan analysis

Author: jiannei

README-EN.md

@@ -8,6 +8,8 @@
 
 ![Test](https://github.com/Jiannei/laravel-response/workflows/Test/badge.svg)
 [![Pest](https://img.shields.io/badge/Tests-Pest-green?style=flat)](https://pestphp.com)
+[![PHPStan](https://img.shields.io/badge/PHPStan-Level%206-brightgreen?style=flat)](https://phpstan.org)
+[![Code Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen?style=flat)](https://github.com/Jiannei/laravel-response)
 [![Pint](https://img.shields.io/badge/Code%20Style-Pint-orange?style=flat)](https://laravel.com/docs/pint)
 [![Latest Stable Version](https://poser.pugx.org/jiannei/laravel-response/v)](https://packagist.org/packages/jiannei/laravel-response)
 [![Total Downloads](https://poser.pugx.org/jiannei/laravel-response/downloads)](https://packagist.org/packages/jiannei/laravel-response)

README.md

@@ -8,6 +8,8 @@
 
 ![Test](https://github.com/Jiannei/laravel-response/workflows/Test/badge.svg)
 [![Pest](https://img.shields.io/badge/Tests-Pest-green?style=flat)](https://pestphp.com)
+[![PHPStan](https://img.shields.io/badge/PHPStan-Level%206-brightgreen?style=flat)](https://phpstan.org)
+[![Code Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen?style=flat)](https://github.com/Jiannei/laravel-response)
 [![Pint](https://img.shields.io/badge/Code%20Style-Pint-orange?style=flat)](https://laravel.com/docs/pint)
 [![Latest Stable Version](https://poser.pugx.org/jiannei/laravel-response/v)](https://packagist.org/packages/jiannei/laravel-response)
 [![Total Downloads](https://poser.pugx.org/jiannei/laravel-response/downloads)](https://packagist.org/packages/jiannei/laravel-response)

composer.json

@@ -16,7 +16,8 @@
         "orchestra/testbench": "^10.0.0",
         "pestphp/pest": "^3.5",
         "jiannei/laravel-enum": "dev-main",
-        "laravel/pint": "^1.18.1"
+        "laravel/pint": "^1.18.1",
+        "larastan/larastan": "^3.0"
     },
     "autoload": {
         "psr-4": {
@@ -40,7 +41,10 @@
     },
     "scripts": {
         "test": "vendor/bin/pest",
-        "style": "vendor/bin/pint"
+        "test-coverage": "vendor/bin/pest --coverage",
+        "test-coverage-html": "vendor/bin/pest --coverage-html coverage",
+        "style": "vendor/bin/pint",
+        "analyse": "vendor/bin/phpstan analyse"
     },
     "minimum-stability": "dev",
     "prefer-stable" : true,

phpstan.neon

@@ -0,0 +1,11 @@
+includes:
+    - vendor/larastan/larastan/extension.neon
+
+parameters:
+    level: 9
+    paths:
+        - src
+    ignoreErrors:
+        - '#Call to function is_(string|int)\(\) with .* will always evaluate to true#'
+        - '#Result of && is always false#'
+        - '#Possibly invalid array key type mixed#'

phpunit.xml

@@ -9,4 +9,9 @@
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
 </phpunit>

src/Contract/ResponseFormat.php

@@ -24,6 +24,8 @@ public function response(): JsonResponse;
 
     /**
      * Get formatted data.
+     *
+     * @return array<string, mixed>|null
      */
     public function get(): ?array;
 
@@ -32,20 +34,27 @@ public function get(): ?array;
      *
      * @return $this
      */
-    public function data(mixed $data = null, string $message = '', int|\BackedEnum $code = 200, $error = null): static;
+    public function data(mixed $data = null, string $message = '', int|\BackedEnum $code = 200, mixed $error = null): static;
 
     /**
      * Format paginator data.
+     *
+     * @param  AbstractPaginator<int|string, mixed>|AbstractCursorPaginator<int|string, mixed>|Paginator<int|string, mixed>  $resource
+     * @return array<string, mixed>
      */
     public function paginator(AbstractPaginator|AbstractCursorPaginator|Paginator $resource): array;
 
     /**
      * Format collection resource data.
+     *
+     * @return array<string, mixed>
      */
     public function resourceCollection(ResourceCollection $collection): array;
 
     /**
      * Format JsonResource Data.
+     *
+     * @return array<string, mixed>
      */
     public function jsonResource(JsonResource $resource): array;
 }

src/Http/Middleware/SetAcceptHeader.php

@@ -20,11 +20,12 @@ class SetAcceptHeader
     /**
      * Handle an incoming request.
      *
-     * @return \Illuminate\Http\Response
+     * @param  \Closure(\Illuminate\Http\Request): mixed  $next
+     * @return mixed
      */
     public function handle(Request $request, Closure $next, string $type = 'json')
     {
-        Str::contains($request->header('Accept'), $contentType = "application/$type") or
+        Str::contains($request->header('Accept') ?? '', $contentType = "application/$type") or
         $request->headers->set('Accept', $contentType);
 
         return $next($request);

src/Http/Middleware/ThrottleRequests.php

@@ -60,7 +60,7 @@ public function handle($request, Closure $next, $maxAttempts = 60, $decayMinutes
             throw $this->buildException($key, $maxAttempts);
         }
 
-        $this->limiter->hit($key, $decayMinutes * 60);
+        $this->limiter->hit($key, (int) ($decayMinutes * 60));
 
         $response = $next($request);
 
@@ -74,13 +74,12 @@ public function handle($request, Closure $next, $maxAttempts = 60, $decayMinutes
      * Resolve the number of attempts if the user is authenticated or not.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  int|string  $maxAttempts
      * @return int
      */
-    protected function resolveMaxAttempts($request, $maxAttempts)
+    protected function resolveMaxAttempts($request, int|string $maxAttempts)
     {
-        if (Str::contains($maxAttempts, '|')) {
-            $maxAttempts = explode('|', $maxAttempts, 2)[$request->user() ? 1 : 0];
+        if (Str::contains((string) $maxAttempts, '|')) {
+            $maxAttempts = explode('|', (string) $maxAttempts, 2)[$request->user() ? 1 : 0];
         }
 
         if (! is_numeric($maxAttempts) && $request->user()) {
@@ -101,10 +100,14 @@ protected function resolveMaxAttempts($request, $maxAttempts)
     protected function resolveRequestSignature($request)
     {
         if ($user = $request->user()) {
-            return sha1($user->getAuthIdentifier());
+            $identifier = $user->getAuthIdentifier();
+
+            return sha1(is_scalar($identifier) ? (string) $identifier : '');
         }
 
-        return sha1($request->fingerprint());
+        $fingerprint = $request->fingerprint();
+
+        return sha1((string) $fingerprint);
     }
 
     /**
@@ -163,7 +166,7 @@ protected function addHeaders(Response $response, $maxAttempts, $remainingAttemp
      * @param  int  $maxAttempts
      * @param  int  $remainingAttempts
      * @param  int|null  $retryAfter
-     * @return array
+     * @return array<string, mixed>
      */
     protected function getHeaders($maxAttempts, $remainingAttempts, $retryAfter = null)
     {

src/Providers/LaravelServiceProvider.php

@@ -38,7 +38,7 @@ class_exists($formatter) && is_subclass_of($formatter, ResponseFormat::class) =>
         });
     }
 
-    protected function setupConfig()
+    protected function setupConfig(): void
     {
         $path = dirname(__DIR__, 2).'/config/response.php';
 

src/Providers/LumenServiceProvider.php

@@ -13,7 +13,7 @@
 
 class LumenServiceProvider extends LaravelServiceProvider
 {
-    protected function setupConfig()
+    protected function setupConfig(): void
     {
         $path = dirname(__DIR__, 2).'/config/response.php';