Merge pull request #4 from chadicus/master

Add ExceptionWithContext

Author: chadicus

src/ExceptionWithContext.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace TraderInteractive\Exceptions;
+
+use Throwable;
+
+/**
+ * Exception with variable context.
+ */
+class ExceptionWithContext extends \Exception
+{
+    /**
+     * @var array
+     */
+    private $context;
+
+    /**
+     * Construct a new instance of the exception.
+     *
+     * @param string $message The exception message.
+     * @param array  $context Any local context information.
+     */
+    public function __construct(string $message, array $context = [], int $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+        $this->context = $context;
+    }
+
+    /**
+     * Returns the specified context array associated with this exception.
+     *
+     * @return array
+     */
+    public function getContext() : array
+    {
+        return $this->context;
+    }
+}

tests/ExceptionWithContextTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace TraderInteractiveTest\Exceptions;
+
+use PHPUnit\Framework\TestCase;
+use TraderInteractive\Exceptions\ExceptionWithContext;
+
+/**
+ * @coversDefaultClass \TraderInteractive\Exceptions\ExceptionWithContext
+ */
+final class ExceptionWithContextTest extends TestCase
+{
+    /**
+     * @test
+     * @covers ::getContext
+     *
+     * @return void
+     */
+    public function contextIsOptional()
+    {
+        $this->assertSame([], (new ExceptionWithContext('a message'))->getContext());
+    }
+
+    /**
+     * @test
+     * @covers ::getContext
+     *
+     * @return void
+     */
+    public function getContextReturnsExpectedValues()
+    {
+        $context = ['foo' => 'bar'];
+        $this->assertSame($context, (new ExceptionWithContext('a message', $context))->getContext());
+    }
+
+    /**
+     * @test
+     * @covers ::__construct
+     *
+     * @return void
+     */
+    public function exceptionInheritsParentProperties()
+    {
+        $this->assertSame(2, (new ExceptionWithContext('a message', [], 2))->getCode());
+    }
+}