Merge pull request #22 from GrahamCampbell/access

Allowed access to exceptions before transformation
GrahamCampbell · Jul 25, 2015 · 001880b · 001880b
2 parents 5266b1b + 5043547
commit 001880b
Show file tree

Hide file tree

Showing 16 changed files with 80 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGE LOG
 * Resolve all the config earlier
 * Made the html displayer responsive
 * Added exception levels
+* Allowed access to exceptions before transformation
 
 
 ## V3.2 (06/07/2015)

diff --git a/src/Displayers/DebugDisplayer.php b/src/Displayers/DebugDisplayer.php
@@ -68,11 +68,12 @@ public function contentType()
     /**
      * Can we display the exception?
      *
-     * @param \Exception $exception
+     * @param \Exception $original
+     * @param \Exception $transformed
      *
      * @return bool
      */
-    public function canDisplay(Exception $exception)
+    public function canDisplay(Exception $original, Exception $transformed)
     {
         return true;
     }

diff --git a/src/Displayers/DisplayerInterface.php b/src/Displayers/DisplayerInterface.php
@@ -42,11 +42,12 @@ public function contentType();
     /**
      * Can we display the exception?
      *
-     * @param \Exception $exception
+     * @param \Exception $original
+     * @param \Exception $transformed
      *
      * @return bool
      */
-    public function canDisplay(Exception $exception);
+    public function canDisplay(Exception $original, Exception $transformed);
 
     /**
      * Do we provide verbose information about the exception?

diff --git a/src/Displayers/HtmlDisplayer.php b/src/Displayers/HtmlDisplayer.php
@@ -101,11 +101,12 @@ public function contentType()
     /**
      * Can we display the exception?
      *
-     * @param \Exception $exception
+     * @param \Exception $original
+     * @param \Exception $transformed
      *
      * @return bool
      */
-    public function canDisplay(Exception $exception)
+    public function canDisplay(Exception $original, Exception $transformed)
     {
         return true;
     }

diff --git a/src/Displayers/JsonDisplayer.php b/src/Displayers/JsonDisplayer.php
@@ -73,11 +73,12 @@ public function contentType()
     /**
      * Can we display the exception?
      *
-     * @param \Exception $exception
+     * @param \Exception $original
+     * @param \Exception $transformed
      *
      * @return bool
      */
-    public function canDisplay(Exception $exception)
+    public function canDisplay(Exception $original, Exception $transformed)
     {
         return true;
     }

diff --git a/src/ExceptionHandler.php b/src/ExceptionHandler.php
@@ -109,14 +109,14 @@ protected function getLevel(Exception $exception)
     public function render($request, Exception $e)
     {
         $id = $this->container->make(ExceptionIdentifier::class)->identify($e);
-        $e = $this->getTransformed($e);
-        $flattened = FlattenException::create($e);
+        $transformed = $this->getTransformed($e);
+        $flattened = FlattenException::create($transformed);
         $code = $flattened->getStatusCode();
         $headers = $flattened->getHeaders();
 
-        $response = $this->getDisplayer($e)->display($e, $id, $code, $headers);
+        $response = $this->getDisplayer($e, $transformed)->display($transformed, $id, $code, $headers);
 
-        return $this->toIlluminateResponse($response, $e);
+        return $this->toIlluminateResponse($response, $transformed);
     }
 
     /**
@@ -138,15 +138,16 @@ protected function getTransformed(Exception $exception)
     /**
      * Get the displayer instance.
      *
-     * @param \Exception $exception
+     * @param \Exception $original
+     * @param \Exception $transformed
      *
      * @return \GrahamCampbell\Exceptions\Displayers\DisplayerInterface
      */
-    protected function getDisplayer(Exception $exception)
+    protected function getDisplayer(Exception $original, Exception $transformed)
     {
         $displayers = $this->make(array_get($this->config, 'displayers', []));
 
-        if ($filtered = $this->getFiltered($displayers, $exception)) {
+        if ($filtered = $this->getFiltered($displayers, $original, $transformed)) {
             return $filtered[0];
         }
 
@@ -157,14 +158,15 @@ protected function getDisplayer(Exception $exception)
      * Get the filtered list of displayers.
      *
      * @param \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[] $displayers
-     * @param \Exception                                                 $exception
+     * @param \Exception                                                 $original
+     * @param \Exception                                                 $transformed
      *
      * @return \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[]
      */
-    protected function getFiltered(array $displayers, Exception $exception)
+    protected function getFiltered(array $displayers, Exception $original, Exception $transformed)
     {
         foreach ($this->make(array_get($this->config, 'filters', [])) as $filter) {
-            $displayers = $filter->filter($displayers, $exception);
+            $displayers = $filter->filter($displayers, $original, $transformed);
         }
 
         return array_values($displayers);

diff --git a/src/Filters/CanDisplayFilter.php b/src/Filters/CanDisplayFilter.php
@@ -24,14 +24,15 @@ class CanDisplayFilter
      * Filter and return the displayers.
      *
      * @param \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[] $displayers
-     * @param \Exception                                                 $exception
+     * @param \Exception                                                 $original
+     * @param \Exception                                                 $transformed
      *
      * @return \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[]
      */
-    public function filter(array $displayers, Exception $exception)
+    public function filter(array $displayers, Exception $original, Exception $transformed)
     {
         foreach ($displayers as $index => $displayer) {
-            if (!$displayer->canDisplay($exception)) {
+            if (!$displayer->canDisplay($original, $transformed)) {
                 unset($displayers[$index]);
             }
         }

diff --git a/src/Filters/ContentTypeFilter.php b/src/Filters/ContentTypeFilter.php
@@ -44,11 +44,12 @@ public function __construct(Request $request)
      * Filter and return the displayers.
      *
      * @param \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[] $displayers
-     * @param \Exception                                                 $exception
+     * @param \Exception                                                 $original
+     * @param \Exception                                                 $transformed
      *
      * @return \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[]
      */
-    public function filter(array $displayers, Exception $exception)
+    public function filter(array $displayers, Exception $original, Exception $transformed)
     {
         foreach ($displayers as $index => $displayer) {
             if (!$this->request->accepts($displayer->contentType())) {

diff --git a/src/Filters/FilterInterface.php b/src/Filters/FilterInterface.php
@@ -24,9 +24,10 @@ interface FilterInterface
      * Filter and return the displayers.
      *
      * @param \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[] $displayers
-     * @param \Exception                                                 $exception
+     * @param \Exception                                                 $original
+     * @param \Exception                                                 $transformed
      *
      * @return \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[]
      */
-    public function filter(array $displayers, Exception $exception);
+    public function filter(array $displayers, Exception $original, Exception $transformed);
 }
diff --git a/src/Filters/VerboseFilter.php b/src/Filters/VerboseFilter.php
@@ -44,11 +44,12 @@ public function __construct(Config $config)
      * Filter and return the displayers.
      *
      * @param \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[] $displayers
-     * @param \Exception                                                 $exception
+     * @param \Exception                                                 $original
+     * @param \Exception                                                 $transformed
      *
      * @return \GrahamCampbell\Exceptions\Displayers\DisplayerInterface[]
      */
-    public function filter(array $displayers, Exception $exception)
+    public function filter(array $displayers, Exception $original, Exception $transformed)
     {
         if ($this->config->get('app.debug', false) !== true) {
             foreach ($displayers as $index => $displayer) {

diff --git a/tests/Displayers/DebugDisplayerTest.php b/tests/Displayers/DebugDisplayerTest.php
@@ -46,10 +46,11 @@ public function testClientError()
 
     public function testProperties()
     {
+        $exception = new Exception();
         $displayer = new DebugDisplayer();
 
         $this->assertTrue($displayer->isVerbose());
-        $this->assertTrue($displayer->canDisplay(new Exception()));
+        $this->assertTrue($displayer->canDisplay($exception, $exception));
         $this->assertSame('text/html', $displayer->contentType());
     }
 }
diff --git a/tests/Displayers/HtmlDisplayerTest.php b/tests/Displayers/HtmlDisplayerTest.php
@@ -11,6 +11,7 @@
 
 namespace GrahamCampbell\Tests\Exceptions\Displayers;
 
+use Exception;
 use GrahamCampbell\Exceptions\Displayers\HtmlDisplayer;
 use GrahamCampbell\Exceptions\ExceptionInfo;
 use GrahamCampbell\Tests\Exceptions\AbstractTestCase;
@@ -54,7 +55,7 @@ public function testProperties()
         $displayer = new HtmlDisplayer(new ExceptionInfo(__DIR__.'/../../resources/errors.json'), __DIR__.'/../../resources/error.html');
 
         $this->assertFalse($displayer->isVerbose());
-        $this->assertTrue($displayer->canDisplay(new HttpException(500)));
+        $this->assertTrue($displayer->canDisplay(new Exception(), new HttpException(500)));
         $this->assertSame('text/html', $displayer->contentType());
     }
 }
diff --git a/tests/Displayers/JsonDisplayerTest.php b/tests/Displayers/JsonDisplayerTest.php
@@ -14,6 +14,7 @@
 use GrahamCampbell\Exceptions\Displayers\JsonDisplayer;
 use GrahamCampbell\Exceptions\ExceptionInfo;
 use GrahamCampbell\TestBench\AbstractTestCase;
+use InvalidArgumentException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 
 /**
@@ -54,7 +55,7 @@ public function testProperties()
         $displayer = new JsonDisplayer(new ExceptionInfo(__DIR__.'/../../resources/errors.json'));
 
         $this->assertFalse($displayer->isVerbose());
-        $this->assertTrue($displayer->canDisplay(new HttpException(500)));
+        $this->assertTrue($displayer->canDisplay(new InvalidArgumentException(), new HttpException(500)));
         $this->assertSame('application/json', $displayer->contentType());
     }
 }
diff --git a/tests/Filters/CanDisplayFilterTest.php b/tests/Filters/CanDisplayFilterTest.php
@@ -29,11 +29,11 @@ public function testFirstIsRemoved()
     {
         $exception = new Exception();
         $html = Mockery::mock(HtmlDisplayer::class);
-        $html->shouldReceive('canDisplay')->once()->with($exception)->andReturn(false);
+        $html->shouldReceive('canDisplay')->once()->with($exception, $exception)->andReturn(false);
         $json = Mockery::mock(JsonDisplayer::class);
-        $json->shouldReceive('canDisplay')->once()->with($exception)->andReturn(true);
+        $json->shouldReceive('canDisplay')->once()->with($exception, $exception)->andReturn(true);
 
-        $displayers = (new CanDisplayFilter())->filter([$html, $json], $exception);
+        $displayers = (new CanDisplayFilter())->filter([$html, $json], $exception, $exception);
 
         $this->assertSame([$json], $displayers);
     }
@@ -42,11 +42,11 @@ public function testNoChange()
     {
         $exception = new Exception();
         $html = Mockery::mock(HtmlDisplayer::class);
-        $html->shouldReceive('canDisplay')->once()->with($exception)->andReturn(true);
+        $html->shouldReceive('canDisplay')->once()->with($exception, $exception)->andReturn(true);
         $json = Mockery::mock(JsonDisplayer::class);
-        $json->shouldReceive('canDisplay')->once()->with($exception)->andReturn(true);
+        $json->shouldReceive('canDisplay')->once()->with($exception, $exception)->andReturn(true);
 
-        $displayers = (new CanDisplayFilter())->filter([$html, $json], $exception);
+        $displayers = (new CanDisplayFilter())->filter([$html, $json], $exception, $exception);
 
         $this->assertSame([$html, $json], $displayers);
     }