Merge bdf-form-attribute

.github/workflows/php.yml

@@ -97,7 +97,7 @@ jobs:
       with:
         php-version: 8.4
         extensions: json
-        ini-values: date.timezone=Europe/Paris
+        ini-values: date.timezone=Europe/Paris, opcache.jit=disable
 
     - name: Install Infection
       run: |

.gitignore

@@ -1,4 +1,5 @@
 /.idea
 /vendor
 /composer.lock
+.phpunit.result.cache
 infection.log

composer.json

@@ -1,11 +1,13 @@
 {
   "name": "b2pweb/bdf-form",
   "description": "Simple and flexible form library",
+  "keywords": ["attributes", "PHP 8", "form", "validator"],
   "type": "library",
   "license": "MIT",
   "authors": [
     {
-      "name": "Vincent Quatrevieux"
+      "name": "Vincent Quatrevieux",
+      "email": "vquatrevieux@b2pweb.com"
     }
   ],
   "autoload": {
@@ -15,19 +17,21 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Bdf\\Form\\": "tests"
+      "Bdf\\Form\\": "tests",
+      "Tests\\Form\\Attribute\\": "tests/Attribute"
     }
   },
   "require": {
     "php": "~8.4",
     "symfony/property-access": "~6.4|~7.0|~8.0",
-    "symfony/validator": "~6.4|~7.0|~8.0"
+    "symfony/validator": "~6.4|~7.0|~8.0",
+    "nette/php-generator": "~3.6|~4.0"
   },
   "require-dev": {
     "symfony/security-csrf": "~6.4|~7.0|~8.0",
     "giggsey/libphonenumber-for-php": "~8.0|~9.0",
     "phpunit/phpunit": "~13.0",
-    "vimeo/psalm": "~6.15.1",
+    "vimeo/psalm": "^6.16.0",
     "symfony/http-foundation": "~6.4|~7.0|~8.0",
     "symfony/form": "~6.4|~7.0|~8.0"
   },

src/Attribute/Aggregate/ArrayConstraint.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Bdf\Form\Attribute\Aggregate;
+
+use Attribute;
+use Bdf\Form\Aggregate\ArrayElementBuilder;
+use Bdf\Form\Attribute\AttributeForm;
+use Bdf\Form\Attribute\ChildBuilderAttributeInterface;
+use Bdf\Form\Attribute\Constraint\Satisfy;
+use Bdf\Form\Attribute\Processor\CodeGenerator\AttributesProcessorGenerator;
+use Bdf\Form\Attribute\Processor\CodeGenerator\ObjectInstantiation;
+use Bdf\Form\Child\ChildBuilderInterface;
+use Override;
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * Add a constraint on the whole array element
+ * Use Satisfy, or directly the constraint as attribute for add a constraint on one array item
+ *
+ * This attribute is equivalent to call :
+ * <code>
+ * $builder->array('values')->arrayConstraints(MyConstraint::class, $options);
+ * </code>
+ *
+ * Usage:
+ * <code>
+ * class MyForm extends AttributeForm
+ * {
+ *     #[ArrayConstraint(Unique::class, ['message' => 'My error'])]
+ *     private ArrayElement $values;
+ *
+ *     // or on PHP 8.1
+ *     #[ArrayConstraint(new Unique(['message' => 'My error']))]
+ *     private ArrayElement $values;
+ * }
+ * </code>
+ *
+ * @see Satisfy Attribute for add constraint for items
+ * @see ArrayElementBuilder::arrayConstraint() The called method
+ * @see CallbackArrayConstraint Use for a custom method validation
+ *
+ * @implements ChildBuilderAttributeInterface<ArrayElementBuilder>
+ * @api
+ */
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
+final readonly class ArrayConstraint implements ChildBuilderAttributeInterface
+{
+    public function __construct(
+        /**
+         * The constraint
+         *
+         * You can use a class name, and provider arguments on the next parameter,
+         * or directly use the constraint instance.
+         *
+         * When a constraint instance is used, in case of code generation,
+         * the constructor parameters will be deduced from public properties of the constraint.
+         * This may not work if the constraint has a complex constructor.
+         *
+         * @var Constraint
+         */
+        private Constraint $constraint,
+    ) {}
+
+    #[Override]
+    public function applyOnChildBuilder(AttributeForm $form, ChildBuilderInterface $builder): void
+    {
+        $builder->arrayConstraint($this->constraint);
+    }
+
+    #[Override]
+    public function generateCodeForChildBuilder(string $name, AttributesProcessorGenerator $generator, AttributeForm $form): void
+    {
+        $constraint = ObjectInstantiation::promotedProperties($this->constraint)->render($generator);
+        $generator->line('$?->arrayConstraint(?);', [$name, $constraint]);
+    }
+}

src/Attribute/Aggregate/ArrayTransformer.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Bdf\Form\Attribute\Aggregate;
+
+use Attribute;
+use Bdf\Form\Attribute\Element\Transformer;
+use Bdf\Form\Transformer\TransformerInterface;
+
+/**
+ * Add a transformer on the array element, using a transformer class
+ *
+ * This attribute will simply set the array flag to true on the {@see Transformer} attribute.
+ *
+ * This attribute is equivalent to call :
+ * <code>
+ * $builder->string('foo')->arrayTransformer(new MyTransformer(...$arguments));
+ * </code>
+ *
+ * Usage:
+ * <code>
+ * class MyForm extends AttributeForm
+ * {
+ *     #[ArrayTransformer(MyTransformer::class, ['foo', 'bar']), ElementType(IntegerElement::class)]
+ *     private ArrayElement $foo;
+ * }
+ * </code>
+ *
+ * @see ArrayElementBuilder::arrayTransformer() The called method
+ * @see CallbackTransformer For use custom methods as transformer instead of class
+ * @see Transformer To add a transformer the item of the array
+ *
+ * @api
+ */
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
+class ArrayTransformer extends Transformer
+{
+    /**
+     * @param class-string<TransformerInterface> $transformerClass The transformer class name
+     * @param array $constructorArguments Arguments to provide on the transformer constructor
+     */
+    public function __construct(string $transformerClass, array $constructorArguments = [])
+    {
+        parent::__construct($transformerClass, $constructorArguments, true);
+    }
+}

src/Attribute/Aggregate/AsArrayConstraint.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Bdf\Form\Attribute\Aggregate;
+
+use Attribute;
+use Bdf\Form\Aggregate\ArrayElementBuilder;
+use Bdf\Form\Attribute\ChildBuilderAttributeInterface;
+use Bdf\Form\Attribute\Processor\MethodChildBuilderAttributeInterface;
+use Bdf\Form\Constraint\Closure;
+use Override;
+use ReflectionMethod;
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * Define the annotated method as a custom constraint for an array element
+ *
+ *  Its prototype should be :
+ *    `public function ($value, ElementInterface $input): bool|string|array{code: string message: string}|null`
+ *
+ *   - Return true, or null (nothing) for a valid input
+ *   - Return false for invalid input, with the default error message (or the declared one)
+ *   - Return string for a custom error message
+ *   - Return array with error message and code
+ *
+ * This attribute is equivalent to call :
+ * <code>
+ * $builder->array('foo')->arrayConstraint([$this, 'validateFoo'], 'Foo is invalid');
+ * </code>
+ *
+ * Usage:
+ * <code>
+ * class MyForm extends AttributeForm
+ * {
+ *     private ArrayElement $foo;
+ *
+ *     #[AsArrayConstraint('foo', message: 'Foo is invalid')]
+ *     public function validateFoo(array $value, ElementInterface $input): bool
+ *     {
+ *         return count($value) % 5 > 2;
+ *     }
+ * }
+ * </code>
+ *
+ * @see ArrayElementBuilder::arrayConstraint() The called method
+ * @see Constraint
+ * @see Closure The used constraint
+ * @see ArrayConstraint Use for a class constraint
+ * @see CallbackArrayConstraint To annotate the property instead of the method
+ *
+ * @implements MethodChildBuilderAttributeInterface<ArrayElementBuilder>
+ *
+ * @api
+ */
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
+final readonly class AsArrayConstraint implements MethodChildBuilderAttributeInterface
+{
+    public function __construct(
+        /**
+         * The element property name to which the constraint is applied
+         *
+         * @var non-empty-string
+         * @readonly
+         */
+        private string $target,
+        /**
+         * The error message to use
+         * This option is used only if the validator return false, in other cases,
+         * the message returned by the validator will be used
+         *
+         * @var string|null
+         * @readonly
+         */
+        private ?string $message = null,
+    ) {
+    }
+
+    #[Override]
+    public function targetElements(): array
+    {
+        return [$this->target];
+    }
+
+    #[Override]
+    public function attribute(ReflectionMethod $method): ChildBuilderAttributeInterface
+    {
+        return new CallbackArrayConstraint($method->getName(), $this->message);
+    }
+}

src/Attribute/Aggregate/CallbackArrayConstraint.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace Bdf\Form\Attribute\Aggregate;
+
+use Attribute;
+use Bdf\Form\Aggregate\ArrayElementBuilder;
+use Bdf\Form\Attribute\AttributeForm;
+use Bdf\Form\Attribute\ChildBuilderAttributeInterface;
+use Bdf\Form\Attribute\Processor\CodeGenerator\AttributesProcessorGenerator;
+use Bdf\Form\Child\ChildBuilderInterface;
+use Bdf\Form\Constraint\Closure;
+use Nette\PhpGenerator\Literal;
+use Override;
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * Define a custom constraint for an array element, using a validation method
+ *
+ * This attribute is equivalent to call :
+ * <code>
+ * $builder->array('foo')->arrayConstraint([$this, 'validateFoo'], 'Foo is invalid');
+ * </code>
+ *
+ * Usage:
+ * <code>
+ * class MyForm extends AttributeForm
+ * {
+ *     #[CustomConstraint('validateFoo', message: 'Foo is invalid')]
+ *     private ArrayElement $foo;
+ *
+ *     public function validateFoo(array $value, ElementInterface $input): bool
+ *     {
+ *         return count($value) % 5 > 2;
+ *     }
+ * }
+ * </code>
+ *
+ * @see ArrayElementBuilder::arrayConstraint() The called method
+ * @see Constraint
+ * @see Closure The used constraint
+ * @see ArrayConstraint Use for a class constraint
+ *
+ * @implements ChildBuilderAttributeInterface<ArrayElementBuilder>
+ *
+ * @api
+ */
+#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
+final readonly class CallbackArrayConstraint implements ChildBuilderAttributeInterface
+{
+    public function __construct(
+        /**
+         * The method name to use as validator
+         * Must be a public method declared on the form class
+         *
+         * Its prototype should be :
+         * `public function (array $value, ElementInterface $input): bool|string|array{code: string message: string}|null`
+         *
+         * - Return true, or null (nothing) for a valid input
+         * - Return false for invalid input, with the default error message (or the declared one)
+         * - Return string for a custom error message
+         * - Return array with error message and code
+         *
+         * @var non-empty-string
+         * @readonly
+         */
+        private string $methodName,
+        /**
+         * The error message to use
+         * This option is used only if the validator return false, in other cases,
+         * the message returned by the validator will be used
+         *
+         * @var string|null
+         * @readonly
+         */
+        private ?string $message = null,
+    ) {}
+
+    #[Override]
+    public function applyOnChildBuilder(AttributeForm $form, ChildBuilderInterface $builder): void
+    {
+        $constraint = new Closure($form->{$this->methodName}(...), $this->message);
+
+        $builder->arrayConstraint($constraint);
+    }
+
+    #[Override]
+    public function generateCodeForChildBuilder(string $name, AttributesProcessorGenerator $generator, AttributeForm $form): void
+    {
+        $generator->use(Closure::class, 'ClosureConstraint');
+
+        $parameters = $this->message !== null
+            ? new Literal('$form->?(...), ?', [$this->methodName, $this->message])
+            : new Literal('$form->?(...)', [$this->methodName])
+        ;
+
+        $generator->line('$?->arrayConstraint(new ClosureConstraint(?));', [$name, $parameters]);
+    }
+}