Merge pull request #11 from bhulsman/master

Add generic collection support. Fixes #2

src/Property.php

@@ -70,7 +70,7 @@ protected function resolveTypeDefinition()
             return;
         }
 
-        preg_match('/\@var ([\w|\\\\]+)/', $docComment, $matches);
+        preg_match('/\@var ((?:(?:[\w|\\\\])+(?:\[\])?)+)/', $docComment, $matches);
 
         if (! count($matches)) {
             return;
@@ -108,6 +108,10 @@ protected function isValidType($value): bool
 
     protected function assertTypeEquals(string $type, $value): bool
     {
+        if (strpos($type, '[]') !== false) {
+            return $this->isValidGenericCollection($type, $value);
+        }
+
         if ($type === 'mixed' && $value !== null) {
             return true;
         }
@@ -118,4 +122,21 @@ protected function assertTypeEquals(string $type, $value): bool
 
         return gettype($value) === (self::$typeMapping[$type] ?? $type);
     }
+
+    protected function isValidGenericCollection(string $type, $collection): bool
+    {
+        if (! is_array($collection)) {
+            return false;
+        }
+
+        $valueType = str_replace('[]', '', $type);
+
+        foreach ($collection as $value) {
+            if (! $this->assertTypeEquals($valueType, $value)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
 }

src/ValueObjectError.php

@@ -23,6 +23,10 @@ public static function invalidType(Property $property, $value): ValueObjectError
             $value = get_class($value);
         }
 
+        if (is_array($value)) {
+            $value = 'array';
+        }
+
         $expectedTypes = implode(', ', $property->getTypes());
 
         return new self("Invalid type: expected {$property->getFqn()} to be of type {$expectedTypes}, instead got value `{$value}`.");

src/ValueObjectException.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Spatie\ValueObject;
+
+use Exception;
+
+class ValueObjectException extends Exception
+{
+    public static function unknownPublicProperty(string $name, string $className): ValueObjectException
+    {
+        return new self("Public property {$name} not found on {$className}");
+    }
+
+    public static function invalidType(
+        string $propertyName,
+        string $className,
+        string $expectedType,
+        $value
+    ): ValueObjectException {
+        if ($value === null) {
+            $value = 'null';
+        }
+
+        if (is_object($value)) {
+            $value = get_class($value);
+        }
+
+        if (is_array($value)) {
+            $value = 'array';
+        }
+
+        return new self("Invalid type: expected {$className}::{$propertyName} to be of type {$expectedType}; instead got value `{$value}`.");
+    }
+
+    public static function uninitialisedProperty(string $name): ValueObjectException
+    {
+        return new self("Non-nullable property `{$name}` has not been initialised.");
+    }
+}

tests/TestClasses/OtherClass.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Spatie\ValueObject\Tests\TestClasses;
+
+class OtherClass
+{
+}

tests/ValueObjectTest.php

@@ -5,6 +5,7 @@
 use Spatie\ValueObject\ValueObject;
 use Spatie\ValueObject\ValueObjectError;
 use Spatie\ValueObject\Tests\TestClasses\DummyClass;
+use Spatie\ValueObject\Tests\TestClasses\OtherClass;
 
 class ValueObjectTest extends TestCase
 {
@@ -151,6 +152,35 @@ public function classes_are_supported()
         };
     }
 
+    /** @test */
+    public function generic_collections_are_supported()
+    {
+        new class(['foo' => [new DummyClass()]]) extends ValueObject {
+            /** @var \Spatie\ValueObject\Tests\TestClasses\DummyClass[] */
+            public $foo;
+        };
+
+        $this->markTestSucceeded();
+
+        $this->expectException(ValueObjectError::class);
+
+        new class(['foo' => [new OtherClass()]]) extends ValueObject {
+            /** @var \Spatie\ValueObject\Tests\TestClasses\DummyClass[] */
+            public $foo;
+        };
+    }
+
+    /** @test */
+    public function an_exception_is_thrown_for_a_generic_collection_of_null()
+    {
+        $this->expectException(ValueObjectError::class);
+
+        new class(['foo' => [null]]) extends ValueObject {
+            /** @var string[] */
+            public $foo;
+        };
+    }
+
     /** @test */
     public function an_exception_is_thrown_when_property_was_not_initialised()
     {