Improve Exception names

Author: nyamsprod

src/Field.php

@@ -51,11 +51,11 @@ public function __construct(HandledRequestCache|Item|StructuredFieldProvider|Str
      *
      * @param array<string, string> $server
      *
-     * @throws Exception If the field is not found
+     * @throws OffsetOutOfBoundsException If the field is not found
      */
     public static function fromSapi(array $server = [], string $name = self::SAPI_NAME): self
     {
-        array_key_exists($name, $server) || throw new IndexOutOfBounds('The field `'.$name.'` is not present.');
+        array_key_exists($name, $server) || throw new OffsetOutOfBoundsException('The field `'.$name.'` is not present.');
 
         return self::fromHttpValue($server[$name]);
     }
@@ -248,17 +248,17 @@ public function offsetExists(mixed $offset): bool
      */
     public function offsetGet(mixed $offset): HandledRequestCache
     {
-        return $this->nth($offset) ?? throw new IndexOutOfBounds('Offset '.$offset.' does not exist in the request cache.');
+        return $this->nth($offset) ?? throw new OffsetOutOfBoundsException('Offset '.$offset.' does not exist in the request cache.');
     }
 
     public function offsetUnset(mixed $offset): void
     {
-        throw new ReadOnlyAccess(self::class.' instances are read-only and cannot be modified using '.ArrayAccess::class.' methods.');
+        throw new ReadOnlyAccessException(self::class.' instances are read-only and cannot be modified using '.ArrayAccess::class.' methods.');
     }
 
     public function offsetSet(mixed $offset, mixed $value): void
     {
-        throw new ReadOnlyAccess(self::class.' instances are read-only and cannot be modified using '.ArrayAccess::class.' methods.');
+        throw new ReadOnlyAccessException(self::class.' instances are read-only and cannot be modified using '.ArrayAccess::class.' methods.');
     }
 
     /**

src/Forward.php

@@ -22,7 +22,7 @@ public function __construct(
         public bool $stored = false,
     ) {
         if (null !== $this->statusCode && ($this->statusCode < 100 || $this->statusCode >= 600)) {
-            throw new InvalidSyntax('The forward statusCode must be a valid HTTP status code when present.');
+            throw new InvalidSyntaxException('The forward statusCode must be a valid HTTP status code when present.');
         }
     }
 
@@ -34,8 +34,8 @@ public static function fromReason(ForwardedReason|Token|string $reason): self
     private static function filterReason(ForwardedReason|Token|string $reason): ForwardedReason
     {
         return match (true) {
-            is_string($reason) => ForwardedReason::tryFromToken(Token::tryFromString($reason)) ?? throw new InvalidSyntax('`'.$reason.'` is an invalid forward reason.'),
-            $reason instanceof Token => ForwardedReason::tryFromToken($reason) ?? throw new InvalidSyntax('`'.$reason->toString().'` is an invalid forward reason.'),
+            is_string($reason) => ForwardedReason::tryFromToken(Token::tryFromString($reason)) ?? throw new InvalidSyntaxException('`'.$reason.'` is an invalid forward reason.'),
+            $reason instanceof Token => ForwardedReason::tryFromToken($reason) ?? throw new InvalidSyntaxException('`'.$reason->toString().'` is an invalid forward reason.'),
             default => $reason,
         };
     }

src/ForwardedReason.php

@@ -33,7 +33,7 @@ public function toToken(): Token
 
     public static function fromToken(Token|Stringable|string $token): self
     {
-        return self::tryFromToken($token) ?? throw new InvalidSyntax('The token represents an invalid value.');
+        return self::tryFromToken($token) ?? throw new InvalidSyntaxException('The token represents an invalid value.');
     }
 
     public static function tryFromToken(Token|Stringable|string|null $token): ?self

src/HandledRequestCache.php

@@ -30,12 +30,12 @@ private function __construct(
         public Token|string|null $detail,
     ) {
         match (true) {
-            !Type::Token->supports($this->servedBy) && !Type::String->supports($this->servedBy) => throw new InvalidSyntax('The handled request cache identifier must be a Token or a string.'),
-            null !== $this->forward && $this->hit => throw new InvalidSyntax('The handled request cache can not be both a hit and forwarded.'),
-            null === $this->forward && !$this->hit => throw new InvalidSyntax('The handled request cache must be a hit or forwarded.'),
-            null !== $this->key && !Type::String->supports($this->key) => throw new InvalidSyntax('The `key` parameter must be a string or null.'),
-            null !== $this->ttl && !Type::Integer->supports($this->ttl) => throw new InvalidSyntax('The `ttl` parameter must be a integer or null.'),
-            null !== $this->detail && !Type::String->supports($this->detail) && !Type::Token->supports($this->detail)  => throw new InvalidSyntax('The `detail` parameter must be a string or a Token when present.'),
+            !Type::Token->supports($this->servedBy) && !Type::String->supports($this->servedBy) => throw new InvalidSyntaxException('The handled request cache identifier must be a Token or a string.'),
+            null !== $this->forward && $this->hit => throw new InvalidSyntaxException('The handled request cache can not be both a hit and forwarded.'),
+            null === $this->forward && !$this->hit => throw new InvalidSyntaxException('The handled request cache must be a hit or forwarded.'),
+            null !== $this->key && !Type::String->supports($this->key) => throw new InvalidSyntaxException('The `key` parameter must be a string or null.'),
+            null !== $this->ttl && !Type::Integer->supports($this->ttl) => throw new InvalidSyntaxException('The `ttl` parameter must be a integer or null.'),
+            null !== $this->detail && !Type::String->supports($this->detail) && !Type::Token->supports($this->detail)  => throw new InvalidSyntaxException('The `detail` parameter must be a string or a Token when present.'),
             default => null,
         };
     }
@@ -54,7 +54,7 @@ public static function serverIdentifierAsString(string $identifier): self
     public static function serverIdentifierAsToken(Token|string $identifier): self
     {
         if (!$identifier instanceof Token) {
-            $identifier = Token::tryFromString($identifier) ?? throw new InvalidSyntax('The handled request cache identifier must be a valid Token.');
+            $identifier = Token::tryFromString($identifier) ?? throw new InvalidSyntaxException('The handled request cache identifier must be a valid Token.');
         }
 
         return new self($identifier, hit: true, forward: null, ttl:null, key:null, detail: null);
@@ -66,14 +66,14 @@ public static function serverIdentifierAsToken(Token|string $identifier): self
     public static function fromHttpValue(StructuredFieldProvider|Item|Stringable|string $item, ?int $statusCode = null): self
     {
         if (null !== $statusCode && ($statusCode < 100 || $statusCode > 599)) {
-            throw new InvalidSyntax('The default forward status code must be a valid HTTP status code when present.');
+            throw new InvalidSyntaxException('The default forward status code must be a valid HTTP status code when present.');
         }
 
         if ($item instanceof StructuredFieldProvider) {
             $className = $item::class;
             $item = $item->toStructuredField();
             if (!$item instanceof Item) {
-                throw new InvalidSyntax('The structured field provider `'.$className.'` must return an '.Item::class.' data type.');
+                throw new InvalidSyntaxException('The structured field provider `'.$className.'` must return an '.Item::class.' data type.');
             }
         }
 
@@ -83,7 +83,7 @@ public static function fromHttpValue(StructuredFieldProvider|Item|Stringable|str
 
         $validation = self::validator()->validate($item);
         if ($validation->isFailed()) {
-            throw new InvalidSyntax('The submitted item is an invalid handled request cache status', previous: $validation->errors->toException());
+            throw new InvalidSyntaxException('The submitted item is an invalid handled request cache status', previous: $validation->errors->toException());
         }
 
         /** @var ValidatedItem $validatedItem */
@@ -187,7 +187,7 @@ public function wasHit(): self
     public function wasForwarded(Forward|ForwardedReason|Token|string $forward): self
     {
         $forward = match (true) {
-            is_string($forward) => Forward::fromReason(ForwardedReason::tryFrom($forward) ?? throw new InvalidSyntax('The submitted string is not a valid server identifier.')),
+            is_string($forward) => Forward::fromReason(ForwardedReason::tryFrom($forward) ?? throw new InvalidSyntaxException('The submitted string is not a valid server identifier.')),
             $forward instanceof Token => Forward::fromReason(ForwardedReason::fromToken($forward)),
             $forward instanceof ForwardedReason => Forward::fromReason($forward),
             default => $forward,
@@ -240,7 +240,7 @@ public function withDetailAsString(?string $detail): self
     public function withDetailAsToken(Token|string|null $detail): self
     {
         if (is_string($detail)) {
-            $detail = Token::tryFromString($detail) ?? throw new InvalidSyntax('The handled request cache detail must be a valid Token.');
+            $detail = Token::tryFromString($detail) ?? throw new InvalidSyntaxException('The handled request cache detail must be a valid Token.');
         }
 
         return match (true) {

src/IndexOutOfBounds.php src/InvalidSyntaxException.phpsrc/IndexOutOfBounds.php renamed to src/InvalidSyntaxException.php

@@ -4,6 +4,6 @@
 
 namespace Bakame\Http\CacheStatus;
 
-class IndexOutOfBounds extends Exception
+class InvalidSyntaxException extends Exception
 {
 }

src/ReadOnlyAccess.php src/OffsetOutOfBoundsException.phpsrc/ReadOnlyAccess.php renamed to src/OffsetOutOfBoundsException.php

@@ -4,6 +4,6 @@
 
 namespace Bakame\Http\CacheStatus;
 
-class ReadOnlyAccess extends Exception
+class OffsetOutOfBoundsException extends Exception
 {
 }

src/InvalidSyntax.php src/ReadOnlyAccessException.phpsrc/InvalidSyntax.php renamed to src/ReadOnlyAccessException.php

@@ -4,6 +4,6 @@
 
 namespace Bakame\Http\CacheStatus;
 
-class InvalidSyntax extends Exception
+class ReadOnlyAccessException extends Exception
 {
 }