From dd9eefb9adca1b5840bfb18e01582c5480ffd35e Mon Sep 17 00:00:00 2001
From: Aleksei Lebedev <1329824+LastDragon-ru@users.noreply.github.com>
Date: Sat, 18 May 2024 10:07:53 +0400
Subject: [PATCH] A bit better exceptions hierarchy.

---
 .../Exceptions/InstructionFailed.php            |  2 +-
 .../Exceptions/PreprocessingFailed.php          | 17 +++++++++++++++++
 ...eprocessFailed.php => PreprocessorError.php} |  2 +-
 .../src/Preprocessor/Preprocessor.php           |  9 +++++----
 4 files changed, 24 insertions(+), 6 deletions(-)
 create mode 100644 packages/documentator/src/Preprocessor/Exceptions/PreprocessingFailed.php
 rename packages/documentator/src/Preprocessor/Exceptions/{PreprocessFailed.php => PreprocessorError.php} (74%)

diff --git a/packages/documentator/src/Preprocessor/Exceptions/InstructionFailed.php b/packages/documentator/src/Preprocessor/Exceptions/InstructionFailed.php
index e980f3c39..edddfb0e8 100644
--- a/packages/documentator/src/Preprocessor/Exceptions/InstructionFailed.php
+++ b/packages/documentator/src/Preprocessor/Exceptions/InstructionFailed.php
@@ -5,7 +5,7 @@
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
 use Throwable;
 
-abstract class InstructionFailed extends PreprocessFailed {
+abstract class InstructionFailed extends PreprocessorError {
     public function __construct(
         private readonly Context $context,
         string $message,
diff --git a/packages/documentator/src/Preprocessor/Exceptions/PreprocessingFailed.php b/packages/documentator/src/Preprocessor/Exceptions/PreprocessingFailed.php
new file mode 100644
index 000000000..13b6922c2
--- /dev/null
+++ b/packages/documentator/src/Preprocessor/Exceptions/PreprocessingFailed.php
@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions;
+
+use LastDragon_ru\LaraASP\Documentator\PackageException;
+use Throwable;
+
+class PreprocessingFailed extends PackageException {
+    public function __construct(
+        Throwable $previous = null,
+    ) {
+        parent::__construct(
+            'Preprocessing failed.',
+            $previous,
+        );
+    }
+}
diff --git a/packages/documentator/src/Preprocessor/Exceptions/PreprocessFailed.php b/packages/documentator/src/Preprocessor/Exceptions/PreprocessorError.php
similarity index 74%
rename from packages/documentator/src/Preprocessor/Exceptions/PreprocessFailed.php
rename to packages/documentator/src/Preprocessor/Exceptions/PreprocessorError.php
index 3859397c7..66566e9fc 100644
--- a/packages/documentator/src/Preprocessor/Exceptions/PreprocessFailed.php
+++ b/packages/documentator/src/Preprocessor/Exceptions/PreprocessorError.php
@@ -4,6 +4,6 @@
 
 use LastDragon_ru\LaraASP\Documentator\PackageException;
 
-class PreprocessFailed extends PackageException {
+abstract class PreprocessorError extends PackageException {
     // empty
 }
diff --git a/packages/documentator/src/Preprocessor/Preprocessor.php b/packages/documentator/src/Preprocessor/Preprocessor.php
index a62ac8e71..e7e31f2f2 100644
--- a/packages/documentator/src/Preprocessor/Preprocessor.php
+++ b/packages/documentator/src/Preprocessor/Preprocessor.php
@@ -9,7 +9,8 @@
 use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Commands\Preprocess;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\PreprocessFailed;
+use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\PreprocessingFailed;
+use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\PreprocessorError;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeDocBlock\Instruction as IncludeDocBlock;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeDocumentList\Instruction as IncludeDocumentList;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeExample\Instruction as IncludeExample;
@@ -208,14 +209,14 @@ public function process(string $path, string $string): string {
                 subject : $string,
                 flags   : PREG_UNMATCHED_AS_NULL,
             );
-        } catch (PreprocessFailed $exception) {
+        } catch (PreprocessorError $exception) {
             throw $exception;
         } catch (Exception $exception) {
-            throw new PreprocessFailed('Preprocess failed.', $exception);
+            throw new PreprocessingFailed($exception);
         }
 
         if ($result === null) {
-            throw new PreprocessFailed('Unexpected error.');
+            throw new PreprocessingFailed();
         }
 
         return $result;