Added attribute for marking forms and fieldsets as having customised …

…type
kynx · Feb 24, 2024 · 048c90a · 048c90a
1 parent 6e377d9
commit 048c90a
Show file tree

Hide file tree

Showing 8 changed files with 161 additions and 9 deletions.
diff --git a/psalm.xml b/psalm.xml
@@ -19,6 +19,7 @@
     <issueHandlers>
         <MissingTemplateParam>
             <errorLevel type="suppress">
+                <directory name="test/Form/Asset"/>
                 <directory name="test/Locator/Asset"/>
             </errorLevel>
         </MissingTemplateParam>

diff --git a/src/Attribute/PsalmTypeCustomised.php b/src/Attribute/PsalmTypeCustomised.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kynx\Laminas\FormShape\Attribute;
+
+use Attribute;
+
+/**
+ * Marks a form or fieldset as having a custom type
+ *
+ * The class will be loaded and any child fieldsets will be processed, but changes will not be written to disk. Provide
+ * the `@psalm-type` so it can be imported by other forms and fieldsets.
+ */
+#[Attribute(Attribute::TARGET_CLASS)]
+final readonly class PsalmTypeCustomised
+{
+    public function __construct(public string $psalmType)
+    {
+    }
+}
diff --git a/src/Attribute/PsalmTypeIgnore.php b/src/Attribute/PsalmTypeIgnore.php
@@ -6,6 +6,12 @@
 
 use Attribute;
 
+/**
+ * Marks a form or fieldset as ignored
+ *
+ * Ignored elements are not loaded from the `FormElementManager` and no child fieldsets will be processed. You typically
+ * only want to use this if the form cannot actually be loaded in a normal way.
+ */
 #[Attribute(Attribute::TARGET_CLASS)]
 final class PsalmTypeIgnore
 {

diff --git a/src/Form/FormProcessor.php b/src/Form/FormProcessor.php
@@ -4,6 +4,8 @@
 
 namespace Kynx\Laminas\FormShape\Form;
 
+use Kynx\Laminas\FormShape\Attribute\PsalmTypeCustomised;
+use Kynx\Laminas\FormShape\Attribute\PsalmTypeIgnore;
 use Kynx\Laminas\FormShape\ExceptionInterface;
 use Kynx\Laminas\FormShape\InputFilter\ImportType;
 use Kynx\Laminas\FormShape\Locator\FormFile;
@@ -17,7 +19,6 @@
 use ReflectionClass;
 
 use function array_merge;
-use function count;
 use function sprintf;
 
 /**
@@ -55,8 +56,8 @@ public function process(
             $types = $this->processFieldsets($formFiles, $listener);
         }
 
-        $this->processForms($formFiles, $types, $listener, $removeGetDataReturn);
-        $listener->finally(count($formFiles));
+        $processed = $this->processForms($formFiles, $types, $listener, $removeGetDataReturn);
+        $listener->finally($processed);
     }
 
     /**
@@ -87,10 +88,12 @@ private function processForms(
         array $types,
         ProgressListenerInterface $listener,
         bool $removeGetDataReturn
-    ): void {
+    ): int {
+        $count = 0;
         foreach ($formFiles as $formFile) {
-            $this->processForm($formFile, $types, $listener, $removeGetDataReturn);
+            $count += $this->processForm($formFile, $types, $listener, $removeGetDataReturn);
         }
+        return $count;
     }
 
     /**
@@ -101,9 +104,13 @@ private function processForm(
         array $types,
         ProgressListenerInterface $listener,
         bool $removeGetDataReturn
-    ): void {
+    ): int {
         try {
             $union = $this->formVisitor->visit($formFile->form, $types);
+            if ($this->getCustomType($formFile->reflection) !== null) {
+                return 0;
+            }
+
             $this->fileWriter->write($formFile->reflection, $union, $types, $removeGetDataReturn);
             $listener->success($formFile->reflection);
         } catch (ExceptionInterface $e) {
@@ -112,8 +119,10 @@ private function processForm(
                 $formFile->reflection->getName(),
                 $e->getMessage()
             ));
-            return;
+            return 0;
         }
+
+        return 1;
     }
 
     /**
@@ -126,11 +135,18 @@ private function processFieldset(
         ProgressListenerInterface $listener
     ): array {
         $reflection = new ReflectionClass($fieldset);
+        if (! $this->canProcess($reflection)) {
+            return [];
+        }
 
         try {
             $union    = $this->fieldsetVisitor->visit($fieldset, $types);
-            $typeName = $this->fileWriter->write($reflection, $union, $types);
-            $listener->success($reflection);
+            $typeName = $this->getCustomType($reflection);
+
+            if ($typeName === null) {
+                $typeName = $this->fileWriter->write($reflection, $union, $types);
+                $listener->success($reflection);
+            }
         } catch (ExceptionInterface $e) {
             $listener->error(sprintf(
                 "Error processing %s: %s",
@@ -165,4 +181,20 @@ private function getFieldsets(FieldsetInterface $fieldset): array
 
         return $fieldsets;
     }
+
+    private function canProcess(ReflectionClass $reflection): bool
+    {
+        return $reflection->getAttributes(PsalmTypeIgnore::class) === [];
+    }
+
+    private function getCustomType(ReflectionClass $reflection): ?string
+    {
+        $attributes = $reflection->getAttributes(PsalmTypeCustomised::class);
+        if ($attributes === []) {
+            return null;
+        }
+
+        $attribute = $attributes[0]->newInstance();
+        return $attribute->psalmType;
+    }
 }
diff --git a/test/Form/Asset/CustomFieldset.php b/test/Form/Asset/CustomFieldset.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KynxTest\Laminas\FormShape\Form\Asset;
+
+use Kynx\Laminas\FormShape\Attribute\PsalmTypeCustomised;
+use Laminas\Form\Fieldset;
+
+#[PsalmTypeCustomised('TCustomType')]
+final class CustomFieldset extends Fieldset
+{
+}
diff --git a/test/Form/Asset/CustomForm.php b/test/Form/Asset/CustomForm.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KynxTest\Laminas\FormShape\Form\Asset;
+
+use Kynx\Laminas\FormShape\Attribute\PsalmTypeCustomised;
+use Laminas\Form\Form;
+
+#[PsalmTypeCustomised('TFormType')]
+final class CustomForm extends Form
+{
+}
diff --git a/test/Form/Asset/IgnoredFieldset.php b/test/Form/Asset/IgnoredFieldset.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace KynxTest\Laminas\FormShape\Form\Asset;
+
+use Kynx\Laminas\FormShape\Attribute\PsalmTypeIgnore;
+use Laminas\Form\Fieldset;
+
+#[PsalmTypeIgnore]
+final class IgnoredFieldset extends Fieldset
+{
+}
diff --git a/test/Form/FormProcessorTest.php b/test/Form/FormProcessorTest.php
@@ -15,6 +15,9 @@
 use Kynx\Laminas\FormShape\Locator\FormFile;
 use Kynx\Laminas\FormShape\Locator\FormLocatorInterface;
 use KynxTest\Laminas\FormShape\Form\Asset\ChildFieldset;
+use KynxTest\Laminas\FormShape\Form\Asset\CustomFieldset;
+use KynxTest\Laminas\FormShape\Form\Asset\CustomForm;
+use KynxTest\Laminas\FormShape\Form\Asset\IgnoredFieldset;
 use KynxTest\Laminas\FormShape\Form\Asset\TestFieldset;
 use KynxTest\Laminas\FormShape\Writer\MockWriter;
 use Laminas\Form\Element\Collection;
@@ -286,4 +289,54 @@ public function testProcessDoesNotRemoveGetDataReturn(): void
         $written = $this->fileWriter->written[0];
         self::assertFalse($written['remove-getdata']);
     }
+
+    public function testProcessDoesNotWriteCustomisedForm(): void
+    {
+        $form = new CustomForm();
+        $form->add(new Text('bar'));
+
+        $reflection = new ReflectionClass($form);
+        $this->formLocator->method('locate')
+            ->willReturn([new FormFile($reflection, $form)]);
+
+        $this->processor->process(['foo'], $this->listener, true, false);
+        self::assertCount(0, $this->fileWriter->written);
+    }
+
+    public function testProcessDoesNotProcessIgnoredFieldset(): void
+    {
+        $form     = new Form();
+        $fieldset = new IgnoredFieldset('foo');
+        $fieldset->add(new Text('bar'));
+        $form->add($fieldset);
+
+        $reflection = new ReflectionClass($form);
+        $this->formLocator->method('locate')
+            ->willReturn([new FormFile($reflection, $form)]);
+
+        $this->processor->process(['foo'], $this->listener);
+        self::assertCount(1, $this->fileWriter->written);
+    }
+
+    public function testProcessUsesCustomType(): void
+    {
+        $expected = new Union([
+            new TKeyedArray([
+                'foo' => new Union([new TTypeAlias(CustomFieldset::class, 'TCustomType')]),
+            ]),
+        ]);
+        $form     = new Form();
+        $fieldset = new CustomFieldset('foo');
+        $fieldset->add(new Text('bar'));
+        $form->add($fieldset);
+
+        $reflection = new ReflectionClass($form);
+        $this->formLocator->method('locate')
+            ->willReturn([new FormFile($reflection, $form)]);
+
+        $this->processor->process(['foo'], $this->listener);
+        self::assertCount(1, $this->fileWriter->written);
+        $written = $this->fileWriter->written[0];
+        self::assertEquals($expected, $written['type']);
+    }
 }