[Feature] Allow test exception handler to be used by packages

lindyhopchris · lindyhopchris · commit 4075baffb1b6 · 2018-05-11T10:42:43.000+01:00
Moves the dummy app test exception handler into the `Testing`
namespace. This means that it can also be used when testing
JSON API packages, e.g. when using `orchestra/testbench`.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ previously in the `has-many` adapter).
 - Moved the `FindsManyResources` trait from the `Store` namespace to `Adapter\Concerns`.
 - The `hydrateRelationships` method on the `AbstractResourceAdapter` is no longer abstract as it now
 contains the implementation that was previously on the Eloquent adapter.
+- The test exception handler has been moved from the dummy app to the `Testing` namespace. This means it
+can now be used when testing JSON API packages.
 
 ## [1.0.0-alpha.2] - 2018-05-06
 
diff --git a/src/Testing/TestExceptionHandler.php b/src/Testing/TestExceptionHandler.php
@@ -15,16 +15,38 @@
  * limitations under the License.
  */
 
-namespace DummyApp\Exceptions;
+namespace CloudCreativity\LaravelJsonApi\Testing;
 
 use CloudCreativity\LaravelJsonApi\Exceptions\HandlesErrors;
 use Exception;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Auth\AuthenticationException;
 use Neomerx\JsonApi\Exceptions\JsonApiException;
-use Orchestra\Testbench\Exceptions\Handler as BaseHandler;
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
 
-class Handler extends BaseHandler
+/**
+ * Class TestExceptionHandler
+ *
+ * This exception handler is intended for testing JSON API packages
+ * using the `orchestra/testbench` package. It ensures that JSON
+ * API exceptions are rendered and if the handler receives any other
+ * exceptions, they are re-thrown so that they appear in PHP Unit.
+ *
+ * Usage in a testbench test case is as follows:
+ *
+ * ```php
+ * protected function resolveApplicationExceptionHandler($app)
+ * {
+ *   $app->singleton(
+ *      \Illuminate\Contracts\Debug\ExceptionHandler::class,
+ *      \CloudCreativity\LaravelJsonApi\Testing\TestExceptionHandler::class
+ *   );
+ * }
+ * ```
+ *
+ * @package CloudCreativity\LaravelJsonApi
+ */
+class TestExceptionHandler extends ExceptionHandler
 {
 
     use HandlesErrors;
diff --git a/tests/lib/Integration/TestCase.php b/tests/lib/Integration/TestCase.php
@@ -21,6 +21,7 @@
 use CloudCreativity\LaravelJsonApi\Facades\JsonApi;
 use CloudCreativity\LaravelJsonApi\ServiceProvider;
 use CloudCreativity\LaravelJsonApi\Testing\MakesJsonApiRequests;
+use CloudCreativity\LaravelJsonApi\Testing\TestExceptionHandler;
 use DummyApp;
 use DummyApp\User;
 use DummyPackage;
@@ -88,7 +89,7 @@ protected function getPackageAliases($app)
      */
     protected function resolveApplicationExceptionHandler($app)
     {
-        $app->singleton(ExceptionHandler::class, DummyApp\Exceptions\Handler::class);
+        $app->singleton(ExceptionHandler::class, TestExceptionHandler::class);
     }
 
     /**
