Merge pull request #20 from minenok/laravel-10

laravel 10 and strict types
mlanin · Apr 13, 2023 · e2a626d · e2a626d
2 parents c431ee1 + 1816514
commit e2a626d
Show file tree

Hide file tree

Showing 26 changed files with 162 additions and 305 deletions.
diff --git a/composer.json b/composer.json
@@ -1,41 +1,47 @@
 {
-    "name": "lanin/laravel-api-exceptions",
-    "description": "All in one solution for exception for JSON REST APIs on Laravel and Lumen.",
-    "keywords": ["laravel", "framework", "api", "exceptions", "json"],
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Maxim Lanin",
-            "email": "[email protected]",
-            "homepage": "https://blog.lanin.me"
-        }
-    ],
-    "require": {
-        "php": "^7.2|^8.0",
-        "illuminate/support": "^7.0|^8.0|^9.0"
-    },
-    "require-dev": {
-        "orchestra/testbench": "^5.0",
-        "phpunit/phpunit": "^8.0",
-        "mockery/mockery": "^1.0"
-    },
-    "autoload": {
-        "psr-4": {
-            "Lanin\\Laravel\\ApiExceptions\\": "src/"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Lanin\\Laravel\\ApiExceptions\\Tests\\": "tests/"
-        }
-    },
-    "minimum-stability": "dev",
-    "prefer-stable": true,
-    "extra": {
-        "laravel": {
-            "providers": [
-                "Lanin\\Laravel\\ApiExceptions\\ApiExceptionsServiceProvider"
-            ]
-        }
+  "name": "lanin/laravel-api-exceptions",
+  "description": "All in one solution for exception for JSON REST APIs on Laravel and Lumen.",
+  "keywords": [
+    "laravel",
+    "framework",
+    "api",
+    "exceptions",
+    "json"
+  ],
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Maxim Lanin",
+      "email": "[email protected]",
+      "homepage": "https://blog.lanin.me"
     }
+  ],
+  "require": {
+    "php": ">=8.1",
+    "illuminate/support": "^10.0"
+  },
+  "require-dev": {
+    "orchestra/testbench": "^8.3",
+    "phpunit/phpunit": ">=8.0",
+    "mockery/mockery": "^1.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Lanin\\Laravel\\ApiExceptions\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Lanin\\Laravel\\ApiExceptions\\Tests\\": "tests/"
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "extra": {
+    "laravel": {
+      "providers": [
+        "Lanin\\Laravel\\ApiExceptions\\ApiExceptionsServiceProvider"
+      ]
+    }
+  }
 }
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,22 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php"
+         colors="true" processIsolation="false" stopOnFailure="false"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" cacheDirectory=".phpunit.cache"
+         backupStaticProperties="false">
+    <coverage>
+        <include>
+            <directory suffix=".php">./src/</directory>
+        </include>
+    </coverage>
     <testsuites>
         <testsuite name="Package Test Suite">
             <directory suffix=".php">./tests/</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">./src/</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+</phpunit>
diff --git a/src/ApiException.php b/src/ApiException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions;
 
 use Illuminate\Contracts\Support\Arrayable;
@@ -10,59 +12,32 @@
 
 abstract class ApiException extends IdException implements Jsonable, \JsonSerializable, Arrayable
 {
-    protected $headers = [];
-
-    /**
-     * @param int $statusCode
-     * @param string $id
-     * @param string $message
-     * @param \Throwable|null $previous
-     * @param array $headers
-     */
-    public function __construct($statusCode = 0, $id = '', $message = '', ?\Throwable $previous = null, array $headers = [])
-    {
-        $this->headers = $headers;
-
+    public function __construct(
+        int $statusCode = 0,
+        string $id = '',
+        string $message = '',
+        ?\Throwable $previous = null,
+        protected array $headers = [],
+    ) {
         parent::__construct($id, $message, $previous, $statusCode);
     }
 
-    /**
-     * Return headers array.
-     *
-     * @return array
-     */
-    public function getHeaders()
+    public function getHeaders(): array
     {
         return $this->headers;
     }
 
-    /**
-     * Convert the object into something JSON serializable.
-     *
-     * @return array
-     */
-    public function jsonSerialize()
+    public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }
 
-    /**
-     * Convert exception to JSON.
-     *
-     * @param  int $options
-     * @return array
-     */
-    public function toJson($options = 0)
+    public function toJson($options = 0): string
     {
         return json_encode($this->toArray());
     }
 
-    /**
-     * Convert exception to array.
-     *
-     * @return array
-     */
-    public function toArray()
+    public function toArray(): array
     {
         $e = $this;
 
@@ -76,7 +51,7 @@ public function toArray()
 
         if ($e instanceof ApiException) {
             $meta = $this->getMeta();
-            if (! empty($meta)) {
+            if (!empty($meta)) {
                 $return['meta'] = $meta;
             }
         }
@@ -88,20 +63,16 @@ public function toArray()
         return $return;
     }
 
-    /**
-     * Prepare exception for report.
-     *
-     * @return string
-     */
-    public function toReport()
+    public function toReport(): self
     {
         return $this;
     }
 
     /**
      * Add extra info to the output.
-     *
-     * @return mixed
      */
-    public function getMeta() {}
+    public function getMeta(): array
+    {
+        return [];
+    }
 }
diff --git a/src/ApiExceptionsServiceProvider.php b/src/ApiExceptionsServiceProvider.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions;
 
 use Illuminate\Support\ServiceProvider;

diff --git a/src/BadRequestApiException.php b/src/BadRequestApiException.php
@@ -1,16 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions;
 
 use Lanin\Laravel\ApiExceptions\Contracts\DontReport;
 
 class BadRequestApiException extends ApiException implements DontReport
 {
-    /**
-     * @param string $message
-     * @param \Throwable|null $previous
-     */
-    public function __construct($message = '', ?\Throwable $previous = null)
+    public function __construct(string $message = '', ?\Throwable $previous = null)
     {
         if (empty($message)) {
             $message = 'The server cannot process the request due to its malformed syntax.';

diff --git a/src/ConflictApiException.php b/src/ConflictApiException.php
@@ -1,16 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions;
 
 use Lanin\Laravel\ApiExceptions\Contracts\DontReport;
 
 class ConflictApiException extends ApiException implements DontReport
 {
-    /**
-     * @param string $message
-     * @param \Throwable $previous
-     */
-    public function __construct($message = '', ?\Throwable $previous = null)
+    public function __construct(string $message = '', ?\Throwable $previous = null)
     {
         if (empty($message)) {
             $message = 'Request could not be processed because of conflict.';

diff --git a/src/Contracts/DontReport.php b/src/Contracts/DontReport.php
@@ -1,8 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions\Contracts;
 
 interface DontReport
 {
-
-}
+}
diff --git a/src/Contracts/ShowsPrevious.php b/src/Contracts/ShowsPrevious.php
@@ -1,8 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions\Contracts;
 
 interface ShowsPrevious
 {
-
-}
+}
diff --git a/src/Contracts/ShowsTrace.php b/src/Contracts/ShowsTrace.php
@@ -1,8 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions\Contracts;
 
 interface ShowsTrace
 {
-
-}
+}
diff --git a/src/ExceptionHandlerTrait.php b/src/ExceptionHandlerTrait.php
@@ -1,10 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Lanin\Laravel\ApiExceptions;
 
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
 use Illuminate\Validation\ValidationException;
 use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -14,22 +18,17 @@ trait ExceptionHandlerTrait
     /**
      * Report or log an exception.
      * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
-     *
-     * @param  \Throwable $e
-     * @return void
-     * @throws \Throwable
      */
-    public function report(\Throwable $e)
+    public function report(\Throwable $e): void
     {
         parent::report($e instanceof ApiException ? $e->toReport() : $e);
     }
 
     /**
      * Render an exception into an HTTP response.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Throwable  $e
-     * @return \Illuminate\Http\Response
+     * @param Request $request
+     * @return JsonResponse
      */
     public function render($request, \Throwable $e)
     {
@@ -42,11 +41,8 @@ public function render($request, \Throwable $e)
 
     /**
      * Define exception.
-     *
-     * @param  \Throwable $e
-     * @return ApiException
      */
-    protected function resolveException(\Throwable $e)
+    protected function resolveException(\Throwable $e): ApiException
     {
         switch (true) {
             case $e instanceof ApiException:
@@ -77,11 +73,8 @@ protected function resolveException(\Throwable $e)
 
     /**
      * Format error message for API response.
-     *
-     * @param  ApiException  $exception
-     * @return mixed
      */
-    protected function formatApiResponse(ApiException $exception)
+    protected function formatApiResponse(ApiException $exception): array
     {
         return $exception->toArray();
     }