Added exceptions

Author: WalterWoshid

src/Exception/StreamFilter/InvalidStreamException.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Okapi\CodeTransformer\Exception\StreamFilter;
+
+use Okapi\CodeTransformer\Exception\StreamFilterException;
+
+/**
+ * # Invalid Stream Exception
+ *
+ * This exception is thrown when the stream is invalid.
+ *
+ * @codeCoverageIgnore Not sure how to test this
+ */
+class InvalidStreamException extends StreamFilterException
+{
+    /**
+     * InvalidStreamException constructor.
+     */
+    public function __construct()
+    {
+        parent::__construct(
+            "The stream must be a valid resource.",
+        );
+    }
+}

src/Exception/StreamFilterException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Okapi\CodeTransformer\Exception;
+
+/**
+ * # Stream Filter Exception
+ *
+ * Base exception for all `StreamFilter` exceptions.
+ */
+abstract class StreamFilterException extends CodeTransformerException
+{
+}

src/Exception/Transformer/InvalidTransformerClassException.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Okapi\CodeTransformer\Exception\Transformer;
+
+use Okapi\CodeTransformer\Exception\TransformerException;
+
+/**
+ * # Invalid Transformer Class Exception
+ * 
+ * This exception is thrown when a transformer class does not extend the
+ * `Transformer` class.
+ */
+class InvalidTransformerClassException extends TransformerException
+{
+    /**
+     * Create a new `TransformerMissingInterfaceException` instance.
+     *
+     * @param class-string $transformerClass
+     */
+    public function __construct(string $transformerClass) {
+        parent::__construct(
+            message: "Transformer class '$transformerClass' does not extend the Transformer class.",
+        );
+    }
+}

src/Exception/Transformer/SyntaxError.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Okapi\CodeTransformer\Exception\Transformer;
+
+use Microsoft\PhpParser\Diagnostic;
+use Okapi\CodeTransformer\Exception\TransformerException;
+
+/**
+ * # Syntax Error
+ *
+ * This exception is thrown when the transformed code contains a syntax error.
+ */
+class SyntaxError extends TransformerException
+{
+    /**
+     * SyntaxError constructor.
+     *
+     * @param Diagnostic       $diagnostic
+     * @param string           $code
+     * @param SyntaxError|null $previous
+     */
+    public function __construct(
+        Diagnostic $diagnostic,
+        string $code,
+        ?SyntaxError $previous = null
+    ) {
+        parent::__construct(
+            "Syntax error in transformed code: $diagnostic->message\n\nFull code:\n$code",
+            previous: $previous,
+        );
+    }
+}

src/Exception/Transformer/TransformerNotFoundException.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Okapi\CodeTransformer\Exception\Transformer;
+
+use Okapi\CodeTransformer\Exception\TransformerException;
+
+/**
+ * # Transformer Not Found Exception
+ *
+ * This exception is thrown when an invalid transformer class is specified.
+ */
+class TransformerNotFoundException extends TransformerException
+{
+    /**
+     * Create a new instance of the exception.
+     *
+     * @param class-string $transformerClass
+     */
+    public function __construct(string $transformerClass)
+    {
+        parent::__construct(
+            message: "Transformer class '$transformerClass' does not exist.",
+        );
+    }
+}

src/Exception/TransformerException.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Okapi\CodeTransformer\Exception;
+
+/**
+ * # Transformer Exception
+ *
+ * This exception is thrown when a transformer fails to transform the code.
+ */
+abstract class TransformerException extends CodeTransformerException
+{
+}