[Feature] Update exception hierarchy (#8)

* Update exception hierarchy

Author: ArtARTs36

CHANGELOG.MD

@@ -16,3 +16,8 @@ v0.1.2
 * [Feature] Add rule "OnTargetBranchRule"
 * Add property "sourceBranch" to MergeRequest object
 * Add property "targetBranch" to MergeRequest object
+
+v0.1.3
+--------------------
+* [Feature] Update exception hierarchy. Parent: MergeRequestLinterException
+* [Feature] Add ServerUnexpectedResponseException

src/Ci/System/InteractsWithResponse.php

@@ -3,6 +3,7 @@
 namespace ArtARTs36\MergeRequestLinter\Ci\System;
 
 use ArtARTs36\MergeRequestLinter\Exception\InvalidCredentialsException;
+use ArtARTs36\MergeRequestLinter\Exception\ServerUnexpectedResponseException;
 use Psr\Http\Message\ResponseInterface;
 
 trait InteractsWithResponse
@@ -14,9 +15,13 @@ trait InteractsWithResponse
     protected function validateResponse(ResponseInterface $response, string $ciName): void
     {
         if ($response->getStatusCode() === 401 || $response->getStatusCode() === 403) {
-            throw InvalidCredentialsException::fromCiName($ciName);
+            throw InvalidCredentialsException::fromResponse($ciName, $response->getBody()->getContents());
         } elseif ($response->getStatusCode() !== 200) {
-            throw new \RuntimeException($ciName . ' returns response with code '. $response->getStatusCode());
+            throw ServerUnexpectedResponseException::create(
+                $ciName,
+                $response->getStatusCode(),
+                $response->getBody()->getContents()
+            );
         }
     }
 

src/Ci/System/SystemFactory.php

@@ -40,7 +40,7 @@ public function create(string $ciName): CiSystem
         $targetClass = $this->ciMap[$ciName] ?? null;
 
         if ($targetClass === null) {
-            throw new CiNotSupported();
+            throw CiNotSupported::fromCiName($ciName);
         }
 
         if (! $this->config->getCredentials()->has($targetClass)) {

src/Contracts/CiSystem.php

@@ -3,6 +3,7 @@
 namespace ArtARTs36\MergeRequestLinter\Contracts;
 
 use ArtARTs36\MergeRequestLinter\Exception\InvalidCredentialsException;
+use ArtARTs36\MergeRequestLinter\Exception\ServerUnexpectedResponseException;
 use ArtARTs36\MergeRequestLinter\Request\MergeRequest;
 
 /**
@@ -23,6 +24,7 @@ public function isMergeRequest(): bool;
     /**
      * Get current merge request
      * @throws InvalidCredentialsException
+     * @throws ServerUnexpectedResponseException
      */
     public function getMergeRequest(): MergeRequest;
 }

src/Exception/CiNotSupported.php

@@ -2,7 +2,10 @@
 
 namespace ArtARTs36\MergeRequestLinter\Exception;
 
-class CiNotSupported extends \RuntimeException
+class CiNotSupported extends MergeRequestLinterException
 {
-    //
+    public static function fromCiName(string $ciName): self
+    {
+        return new self('CI "' . $ciName . '" not supported');
+    }
 }

src/Exception/ConfigInvalidException.php

@@ -2,7 +2,7 @@
 
 namespace ArtARTs36\MergeRequestLinter\Exception;
 
-class ConfigInvalidException extends \RuntimeException
+class ConfigInvalidException extends MergeRequestLinterException
 {
     public static function fromKey(string $key): self
     {

src/Exception/EnvironmentDataKeyNotFound.php

@@ -4,7 +4,7 @@
 
 use Throwable;
 
-class EnvironmentDataKeyNotFound extends \RuntimeException
+class EnvironmentDataKeyNotFound extends MergeRequestLinterException
 {
     public function __construct(protected string $dataKey, int $code = 0, Throwable $previous = null)
     {

src/Exception/InvalidCredentialsException.php

@@ -8,4 +8,9 @@ public static function fromCiName(string $ciName): self
     {
         return new self("Given invalid credentials for $ciName");
     }
+
+    public static function fromResponse(string $ciName, string $response): self
+    {
+        return new self("Given invalid credentials for $ciName. Server returns: ". $response);
+    }
 }

src/Exception/LintException.php

@@ -2,7 +2,7 @@
 
 namespace ArtARTs36\MergeRequestLinter\Exception;
 
-abstract class LintException extends \Exception
+abstract class LintException extends MergeRequestLinterException
 {
     //
 }

src/Exception/MergeRequestLinterException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Exception;
+
+abstract class MergeRequestLinterException extends \RuntimeException
+{
+    //
+}

src/Exception/ServerUnexpectedResponseException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Exception;
+
+final class ServerUnexpectedResponseException extends MergeRequestLinterException
+{
+    public static function create(string $ciName, int $status, string $response): self
+    {
+        return new self($ciName . ' returns response with code ' . $status . '. Response: ' . $response);
+    }
+}