feat!: throw exception when trying to set unknown properties

Author: viduc

src/BuildableWithArgUnpacking.php

@@ -4,6 +4,8 @@
 
 namespace Buildotter\Core;
 
+use Buildotter\Core\Exception\UnknownPropertyException;
+
 trait BuildableWithArgUnpacking
 {
     /**
@@ -12,10 +14,17 @@ trait BuildableWithArgUnpacking
     public function with(...$values): static
     {
         $r = new \ReflectionClass(static::class);
+        $properties = $r->getProperties();
+
+        $propertyNames = \array_map(static fn($p) => $p->getName(), $properties);
+        $invalidArguments = \array_diff(\array_keys($values), $propertyNames);
+        if ([] !== $invalidArguments) {
+            throw UnknownPropertyException::new($invalidArguments, static::class);
+        }
 
         $clone = $r->newInstanceWithoutConstructor();
 
-        foreach ($r->getProperties() as $property) {
+        foreach ($properties as $property) {
             $field = $property->name;
             $clone->$field = match (\array_key_exists($field, $values)) {
                 true => (static function () use ($values, $field) {

src/BuildableWithArray.php

@@ -4,6 +4,8 @@
 
 namespace Buildotter\Core;
 
+use Buildotter\Core\Exception\UnknownPropertyException;
+
 trait BuildableWithArray
 {
     /**
@@ -12,10 +14,17 @@ trait BuildableWithArray
     public function with(array $values): static
     {
         $r = new \ReflectionClass(static::class);
+        $properties = $r->getProperties();
+
+        $propertyNames = \array_map(static fn($p) => $p->getName(), $properties);
+        $invalidArguments = \array_diff(\array_keys($values), $propertyNames);
+        if ([] !== $invalidArguments) {
+            throw UnknownPropertyException::new($invalidArguments, static::class);
+        }
 
         $clone = $r->newInstanceWithoutConstructor();
 
-        foreach ($r->getProperties() as $property) {
+        foreach ($properties as $property) {
             $field = $property->name;
             $clone->$field = match (\array_key_exists($field, $values)) {
                 true => (static function () use ($values, $field) {

src/Exception/UnknownPropertyException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Buildotter\Core\Exception;
+
+final class UnknownPropertyException extends \InvalidArgumentException
+{
+    /**
+     * @param array<string|int> $properties
+     */
+    public static function new(array $properties, string $class): self
+    {
+        return new self(
+            \sprintf(
+                'The following properties do not exist in "%s": "%s".',
+                $class,
+                \implode('", "', $properties),
+            ),
+        );
+    }
+}

tests/BuildatableTest.php

@@ -7,6 +7,7 @@
 use Buildotter\Core\BuildableWithArgUnpacking;
 use Buildotter\Core\BuildableWithArray;
 use Buildotter\Core\Buildatable;
+use Buildotter\Core\Exception\UnknownPropertyException;
 use PHPUnit\Framework\TestCase;
 use function PHPUnit\Framework\assertEquals;
 
@@ -39,6 +40,59 @@ public function test_it_is_buildatable_with_arg_unpacking(): void
             $fooBuiltWithArgsUnpacking,
         );
     }
+
+    public function test_it_is_not_buildatable_with_bad_arg_unpacking(): void
+    {
+        $this->expectException(UnknownPropertyException::class);
+        $this->expectExceptionMessage('The following properties do not exist in "Buildotter\Tests\Core\FooBuilderWithArgUnpacking": "0", "doesNotExist", "doesNotExistEither".');
+
+        FooBuilderWithArgUnpacking::new()
+            ->with(
+                random()->word(),
+                doesNotExist: random()->word(),
+                number: random()->randomNumber(),
+                doesNotExistEither: random()->word(),
+            )
+            ->build();
+    }
+
+    public function test_it_is_not_buildatable_with_bad_arg_unpacking_2(): void
+    {
+        $this->expectException(UnknownPropertyException::class);
+        $this->expectExceptionMessage('The following properties do not exist in "Buildotter\Tests\Core\FooBuilderWithArgUnpacking": "doesNotExist".');
+
+        FooBuilderWithArgUnpacking::new()
+            ->named(random()->name())
+            ->with(doesNotExist: random()->word())
+            ->with(doesNotExistEither: random()->word())
+            ->build();
+    }
+
+    public function test_it_is_not_buildatable_with_bad_arg_array(): void
+    {
+        $this->expectException(UnknownPropertyException::class);
+        $this->expectExceptionMessage('The following properties do not exist in "Buildotter\Tests\Core\FooBuilderWithArray": "doesNotExist", "doesNotExistEither".');
+
+        FooBuilderWithArray::new()
+            ->with([
+                'doesNotExist' => random()->word(),
+                'number' => random()->randomNumber(),
+                'doesNotExistEither' => random()->word(),
+            ])
+            ->build();
+    }
+
+    public function test_it_is_not_buildatable_with_bad_arg_array_2(): void
+    {
+        $this->expectException(UnknownPropertyException::class);
+        $this->expectExceptionMessage('The following properties do not exist in "Buildotter\Tests\Core\FooBuilderWithArray": "doesNotExist".');
+
+        FooBuilderWithArray::new()
+            ->named(random()->name())
+            ->with(['doesNotExist' => random()->word()])
+            ->with(['doesNotExistEither' => random()->word()])
+            ->build();
+    }
 }
 
 final class Foo