Better enforcement of FilterResponse properties

Author: jncarver

src/FilterResponse.php

@@ -2,16 +2,17 @@
 
 namespace TraderInteractive;
 
+use InvalidArgumentException;
 use TraderInteractive\Exceptions\ReadOnlyViolationException;
 
 /**
  * This object contains the various data returned by a filter action.
  *
- * @property-read bool        $success       TRUE if the filter was successful or FALSE if errors were encountered.
- * @property-read mixed       $filteredValue The input values after being filtered.
- * @property-read array       $errors        Any errors encountered during the filter process.
- * @property-read string|null $errorMessage  An error message generated from the errors. NULL if no errors.
- * @property-read mixed       $unknowns      The values that were unknown during filtering.
+ * @property bool        $success       TRUE if the filter was successful or FALSE if errors were encountered.
+ * @property mixed       $filteredValue The input values after being filtered.
+ * @property array       $errors        Any errors encountered during the filter process.
+ * @property string|null $errorMessage  An error message generated from the errors. NULL if no errors.
+ * @property mixed       $unknowns      The values that were unknown during filtering.
  */
 final class FilterResponse
 {
@@ -42,12 +43,20 @@ public function __construct(
 
     public function __get($name)
     {
-        return $this->response[$name];
+        if (array_key_exists($name, $this->response)) {
+            return $this->response[$name];
+        }
+
+        throw new InvalidArgumentException("Property '{$name}' does not exist");
     }
 
     public function __set($name, $value)
     {
-        throw new ReadOnlyViolationException("Property {$name} is read-only");
+        if (array_key_exists($name, $this->response)) {
+            throw new ReadOnlyViolationException("Property '{$name}' is read-only");
+        }
+
+        throw new InvalidArgumentException("Property '{$name}' does not exist");
     }
 
     /**

tests/FilterResponseTest.php

@@ -2,7 +2,9 @@
 
 namespace TraderInteractiveTest;
 
+use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
+use TraderInteractive\Exceptions\ReadOnlyViolationException;
 use TraderInteractive\FilterResponse;
 
 /**
@@ -65,6 +67,45 @@ public function constructDefault()
         $this->assertSame([], $response->unknowns);
     }
 
+    /**
+     * @test
+     * @covers ::__construct
+     */
+    public function gettingInvalidPropertyThrowsException()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage("Property 'foo' does not exist");
+
+        $response = new FilterResponse([]);
+        $response->foo;
+    }
+
+    /**
+     * @test
+     * @covers ::__construct
+     */
+    public function settingValidPropertyThrowsAnException()
+    {
+        $this->expectException(ReadOnlyViolationException::class);
+        $this->expectExceptionMessage("Property 'success' is read-only");
+
+        $response = new FilterResponse([]);
+        $response->success = false;
+    }
+
+    /**
+     * @test
+     * @covers ::__construct
+     */
+    public function settingInvalidPropertyThrowsAnException()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage("Property 'foo' does not exist");
+
+        $response = new FilterResponse([]);
+        $response->foo = false;
+    }
+
     /**
      * @test
      * @covers ::toArray