Merge pull request #808 from clementbirkle/main

Fix Parsing of Optional Types Annotations in DataIterableAnnotation
spatie · Jul 25, 2024 · d1f9731 · d1f9731
2 parents c62de25 + 478c669
commit d1f9731
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 1 deletion.
diff --git a/src/Support/Annotations/DataIterableAnnotationReader.php b/src/Support/Annotations/DataIterableAnnotationReader.php
@@ -61,7 +61,7 @@ protected function get(
  );
 
  preg_match_all(
- "/{$kindPattern}(?<collectionClass>{$fqsenPattern})<(?:{$keyPattern}\s*?,\s*?)?(?<dataClass>{$fqsenPattern})>{$parameterPattern}/i",
+ "/{$kindPattern}(?<collectionClass>{$fqsenPattern})<(?:{$keyPattern}\s*?,\s*?)?(?<dataClass>{$fqsenPattern})>(?:{$typesPattern})*{$parameterPattern}/i",
  $comment,
  $collectionMatches,
  );

diff --git a/tests/Fakes/CollectionDataAnnotationsData.php b/tests/Fakes/CollectionDataAnnotationsData.php
@@ -14,6 +14,7 @@
  * @property array<\Spatie\LaravelData\Tests\Fakes\SimpleData> $propertyQ
  * @property \Spatie\LaravelData\Tests\Fakes\SimpleData[] $propertyR
  * @property array<SimpleData> $propertyS
+ * @property \Illuminate\Support\Collection<\Spatie\LaravelData\Tests\Fakes\SimpleData>|null $propertyT
  */
 class CollectionDataAnnotationsData
 {
@@ -67,6 +68,11 @@ class CollectionDataAnnotationsData
 
  public array $propertyS;
 
+ public ?array $propertyT;
+
+ /** @var \Illuminate\Support\Collection<\Spatie\LaravelData\Tests\Fakes\SimpleData>|null */
+ public ?array $propertyU;
+
  /**
  * @param \Spatie\LaravelData\Tests\Fakes\SimpleData[]|null $paramA
  * @param null|\Spatie\LaravelData\Tests\Fakes\SimpleData[] $paramB
@@ -78,6 +84,7 @@ class CollectionDataAnnotationsData
  * @param array<SimpleData> $paramH
  * @param array<int,SimpleData> $paramJ
  * @param array<int, SimpleData> $paramI
+ * @param \Spatie\LaravelData\DataCollection<\Spatie\LaravelData\Tests\Fakes\SimpleData>|null $paramK
  */
  public function method(
  array $paramA,
@@ -89,6 +96,7 @@ public function method(
  array $paramG,
  array $paramJ,
  array $paramI,
+ ?array $paramK,
  ) {
 
  }

diff --git a/tests/Fakes/CollectionNonDataAnnotationsData.php b/tests/Fakes/CollectionNonDataAnnotationsData.php
@@ -11,6 +11,7 @@
  * @property \Spatie\LaravelData\Tests\Fakes\Enums\DummyBackedEnum[] $propertyM
  * @property array<\Spatie\LaravelData\Tests\Fakes\Enums\DummyBackedEnum> $propertyN
  * @property array<DummyBackedEnum> $propertyO
+ * @property array<DummyBackedEnum>|null $propertyQ
  */
 class CollectionNonDataAnnotationsData
 {
@@ -58,6 +59,11 @@ class CollectionNonDataAnnotationsData
  /** @var \Illuminate\Support\Collection<Error> */
  public Collection $propertyP;
 
+ public array $propertyQ;
+
+ /** @var \Illuminate\Support\Collection<Error>|null */
+ public ?Collection $propertyR;
+
  /**
  * @param \Spatie\LaravelData\Tests\Fakes\Enums\DummyBackedEnum[]|null $paramA
  * @param null|\Spatie\LaravelData\Tests\Fakes\Enums\DummyBackedEnum[] $paramB
@@ -69,6 +75,7 @@ class CollectionNonDataAnnotationsData
  * @param array<DummyBackedEnum> $paramH
  * @param array<int,DummyBackedEnum> $paramJ
  * @param array<int, DummyBackedEnum> $paramI
+ * @param \Spatie\LaravelData\DataCollection<\Spatie\LaravelData\Tests\Fakes\Enums\DummyBackedEnum>|null $paramK
  */
  public function method(
  array $paramA,
@@ -80,6 +87,7 @@ public function method(
  array $paramG,
  array $paramJ,
  array $paramI,
+ ?array $paramK,
  ) {
 
  }

diff --git a/tests/Support/Annotations/DataIterableAnnotationReaderTest.php b/tests/Support/Annotations/DataIterableAnnotationReaderTest.php
@@ -81,6 +81,11 @@ function (string $property, ?DataIterableAnnotation $expected) {
  'property' => 'propertyM',
  'expected' => new DataIterableAnnotation(SimpleData::class, isData: true),
  ];
+
+ yield 'propertyU' => [
+ 'property' => 'propertyU',
+ 'expected' => new DataIterableAnnotation(SimpleData::class, isData: true),
+ ];
 });
 
 it('can get the data class for a data collection by class annotation', function () {
@@ -93,6 +98,7 @@ function (string $property, ?DataIterableAnnotation $expected) {
  new DataIterableAnnotation(SimpleData::class, isData: true, property: 'propertyQ'),
  new DataIterableAnnotation(SimpleData::class, isData: true, property: 'propertyR'),
  new DataIterableAnnotation(SimpleData::class, isData: true, property: 'propertyS'),
+ new DataIterableAnnotation(SimpleData::class, isData: true, property: 'propertyT'),
  ]);
 });
 
@@ -110,6 +116,7 @@ function (string $property, ?DataIterableAnnotation $expected) {
  new DataIterableAnnotation(SimpleData::class, isData: true, property: 'paramH'),
  new DataIterableAnnotation(SimpleData::class, isData: true, keyType: 'int', property: 'paramJ'),
  new DataIterableAnnotation(SimpleData::class, isData: true, keyType: 'int', property: 'paramI'),
+ new DataIterableAnnotation(SimpleData::class, isData: true, property: 'paramK'),
  ]);
 });
 
@@ -185,6 +192,11 @@ function (string $property, ?DataIterableAnnotation $expected) {
  'property' => 'propertyP',
  'expected' => new DataIterableAnnotation(Error::class, isData: true),
  ];
+
+ yield 'propertyR' => [
+ 'property' => 'propertyR',
+ 'expected' => new DataIterableAnnotation(Error::class, isData: true),
+ ];
 });
 
 it('can get the iterable class for a collection by class annotation', function () {
@@ -194,6 +206,7 @@ function (string $property, ?DataIterableAnnotation $expected) {
  new DataIterableAnnotation(DummyBackedEnum::class, isData: false, property: 'propertyM'),
  new DataIterableAnnotation(DummyBackedEnum::class, isData: false, property: 'propertyN'),
  new DataIterableAnnotation(DummyBackedEnum::class, isData: false, property: 'propertyO'),
+ new DataIterableAnnotation(DummyBackedEnum::class, isData: false, property: 'propertyQ'),
  ]);
 });
 
@@ -211,6 +224,7 @@ function (string $property, ?DataIterableAnnotation $expected) {
  new DataIterableAnnotation(DummyBackedEnum::class, isData: false, property: 'paramH'),
  new DataIterableAnnotation(DummyBackedEnum::class, isData: false, keyType: 'int', property: 'paramJ'),
  new DataIterableAnnotation(DummyBackedEnum::class, isData: false, keyType: 'int', property: 'paramI'),
+ new DataIterableAnnotation(DummyBackedEnum::class, isData: false, property: 'paramK'),
  ]);
 });