feat: Criando exception padronizada de Unexpected Error (#4)

* feat: Criando exception padronizada de Unexpected Error

* feat: documentando classe de exceptions inesperadas

* fix: Ajustando Versão na doc

---------

Co-authored-by: gsousadev <[email protected]>

Author: gsousadev

README.md

@@ -1,6 +1,6 @@
 # Laravel Problem Detail Exceptions
 
-[![Versão](https://img.shields.io/badge/vers%C3%A3o-1.0.1-beta)](https://github.com/seu-usuario/sua-lib/releases)
+[![Versão](https://img.shields.io/badge/vers%C3%A3o-1.1.0-beta)](https://github.com/seu-usuario/sua-lib/releases)
 [![Licença](https://img.shields.io/badge/licen%C3%A7a-MIT-green)](https://opensource.org/licenses/MIT)
 
 Esse projeto tem por objetivo prover uma biblioteca Laravel que permite implementar de maneira simples e rápida um padrão de exceptions, seguindo os conceitos da [RFC de problem details](https://datatracker.ietf.org/doc/html/rfc7807)
@@ -23,7 +23,7 @@ Após a publicação do pacote deve ser criado um arquivo de configuração para
 
 ## Configurando
 
-Este pacote permite algumas configurações de customização. Para isso deve-se user o arquivo ```problem-detail-exceptions.php```
+Este pacote permite algumas configurações de customização. Para isso deve-se user o arquivo `problem-detail-exceptions.php`
 
 Para ter dados coerentes dentro do fluxo é importante ter duas variáveis de ambiente implementadas:
 - **PROBLEM_DETAIL_EXCEPTION_APP_NAME** : Indica o nome que pode aparecer nos logs referente ao nome do projeto ou app que o pacote esta sendo usado.
@@ -61,7 +61,7 @@ enum ExceptionsFieldsEnum: string
 ```
 
 
-## Usando
+## Criando Exceptions Customizadas
 
 Para usar o pacote recomendamos que sejam criadas excessões extendendo da classe `Gsousadev\LaravelProblemDetailExceptions\Exceptions\ProblemDetailException` conforme a classe de exemplo abaixo:
 
@@ -137,6 +137,47 @@ try {
 }
 ```
 
+## Padronizando Exceptions
+
+Existe uma classe que pode ser usada em conjunto com o Handler de Exceptions do Laravel para permitir que todas as 
+exceptions lançadas e que passem pelo handler possam ser transformadas e normalizadas no padrão 'Problem Detail'. 
+Isso permite que a aplicação que tenham excetions em formatos diferentes possa rapidamente padronizar a saida dessas 
+exceptions para Logs e Requisições HTTP. Geralmente o arquivo de Handler do laravel esta localizado aqui 
+`App\Exceptions\Handler.php`. Podemos implementar a classe conforme o exemplo abaixo:
+
+
+```php
+
+<?php
+
+namespace App\Exceptions;
+
+use Gsousadev\LaravelProblemDetailExceptions\Exceptions\ProblemDetailException;
+use Gsousadev\LaravelProblemDetailExceptions\Exceptions\UnexpectedException;
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Throwable;
+
+class Handler extends ExceptionHandler
+{
+    public function register()
+    {
+        $this->renderable(function (Throwable $e) {
+            if (!$e instanceof ProblemDetailException) {
+                throw new UnexpectedException($e);
+            }
+        });
+    }
+
+    public function report(Throwable $e)
+    {
+        if ($e instanceof ProblemDetailException) {
+            parent::report($e);
+        }
+    }
+}
+
+```
+
 ## Contribuindo
 
 O projeto esta em fase de construção da ideia inicial, mas apontamentos de melhorias são muito importantes para o 

src/Exceptions/UnexpectedException.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gsousadev\LaravelProblemDetailExceptions\Exceptions;
+
+use Symfony\Component\HttpFoundation\Response;
+
+class UnexpectedException extends ProblemDetailException
+{
+    public function __construct(
+        \Throwable $e
+    ) {
+        $details = [
+            'exception_code'    => $e->getCode(),
+            'exception_line'    => $e->getLine(),
+            'exception_message' => $e->getMessage(),
+            'exception_file'    => $e->getFile()
+        ];
+
+        $statusCode = $this->getValidStatusCode($e);
+
+        parent::__construct(
+            title       : $statusCode == Response::HTTP_INTERNAL_SERVER_ERROR ? "Erro Inesperado" : $e->getMessage(),
+            detail      : json_encode($details),
+            userTitle   : 'Ocorreu um erro inesperado',
+            userMessage : 'Entre em contato com o administrador do sistema',
+            httpStatus  : $statusCode,
+            internalCode: "UNEXPECTED_ERROR",
+            previous    : $e
+        );
+    }
+
+    private function getValidStatusCode(\Throwable $e)
+    {
+        if (method_exists($e, 'getStatusCode') &&
+            in_array($e->getStatusCode(), array_keys(Response::$statusTexts))) {
+            return $e->getStatusCode();
+        }
+
+        return in_array($e->getCode(), array_keys(Response::$statusTexts)) ?
+            $e->getCode() :
+            Response::HTTP_INTERNAL_SERVER_ERROR;
+    }
+}

tests/Unit/ProblemDetailExceptionTest.php renamed to tests/Unit/ConfigTest.php

@@ -4,27 +4,28 @@
 
 use Gsousadev\LaravelProblemDetailExceptions\Enums\ExceptionsFieldsEnum;
 use Gsousadev\LaravelProblemDetailExceptions\Exceptions\ServerException;
+use Gsousadev\LaravelProblemDetailExceptions\Exceptions\UnexpectedException;
 use Orchestra\Testbench\TestCase;
 
-class ProblemDetailExceptionTest extends TestCase
+class ConfigTest extends TestCase
 {
     public function testShouldReturnFieldsByConfig()
     {
         config()->set('problem-detail-exceptions.app_name', 'TEST');
         config()->set('problem-detail-exceptions.enable_log_in_exception', false);
         config()->set('problem-detail-exceptions.available_fields_list', [
-            ExceptionsFieldsEnum::MESSAGE,
+            ExceptionsFieldsEnum::TITLE,
             ExceptionsFieldsEnum::STATUS
         ]);
         config()->set('problem-detail-exceptions.renderable_fields_list', [
             ExceptionsFieldsEnum::STATUS
         ]);
 
-        $exception = new ServerException();
+        $exception = new UnexpectedException(new \Exception('Teste Erro Sem Mapeamento', 0));
 
         $this->assertEquals(
             [
-                'message' => 'Erro interno do servidor - O servidor encontrou um erro interno e não foi capaz de completar sua requisição',
+                'title' => 'Erro Inesperado',
                 'status'  => '500'
             ],
             $exception->toArray()