Children_groups / Child_group feature (#49)

Author: webda2l

.devcontainer/devcontainer.json

@@ -8,10 +8,29 @@
       "extensions": [
         "bmewburn.vscode-intelephense-client",
         "xdebug.php-debug",
-        "getpsalm.psalm-vscode-plugin"
+        "SanderRonde.phpstan-vscode"
       ],
       "settings": {
-        "terminal.integrated.defaultProfile.linux": "bash"
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "intelephense.telemetry.enabled": false,
+        "workbench.colorCustomizations": {
+          "statusBar.background": "#ffa600d3",
+          "statusBar.noFolderBackground": "#ffa600d3",
+          "statusBar.debuggingBackground": "#ffa600d3",
+          "activityBar.activeBorder": "#ffa600d3",
+          "activityBarBadge.background": "#ffa600d3",
+          "badge.background": "#ffa600d3",
+          "focusBorder": "#ffa600d3",
+          "progressBar.background": "#ffa600d3",
+          "notificationCenter.border": "#ffa600d3",
+          "notificationsInfoIcon.foreground": "#ffa600d3",
+          "pickerGroup.border": "#ffa600d3",
+          "settings.modifiedItemIndicator": "#ffa600d3",
+          "panelTitle.activeBorder": "#ffa600d3",
+          "list.activeSelectionBackground": "#6e6e6e",
+          "list.inactiveSelectionBackground": "#6e6e6e",
+          "list.hoverBackground": "#6e6e6e",
+        },
       }
     }
   },

.github/workflows/ci.yml

@@ -4,12 +4,17 @@ on:
   push:
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -37,7 +42,9 @@ jobs:
     name: Static Analysis
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -55,8 +62,8 @@ jobs:
       - name: Install dependencies
         run: composer install --prefer-dist --no-progress
 
-      - name: Run psalm
-        run: vendor/bin/psalm
+      - name: Run phpstan
+        run: vendor/bin/phpstan analyse --memory-limit=2G
 
   tests:
     name: PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, deps ${{ matrix.composer_args }}
@@ -74,6 +81,7 @@ jobs:
             symfony: '7.3'
             composer_args: '--prefer-stable'
             stability: 'stable'
+            coverage: true
           - php: '8.4'
             symfony: '7.3'
             composer_args: '--prefer-lowest'
@@ -92,12 +100,15 @@ jobs:
             stability: 'dev'
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
+          coverage: pcov
 
       - name: Cache Composer dependencies
         uses: actions/cache@v4
@@ -120,6 +131,18 @@ jobs:
 
       - name: Install dependencies
         run: composer update ${{ matrix.composer_args }} --no-progress --no-scripts --no-plugins
-      
+
       - name: Run phpunit
-        run: vendor/bin/phpunit
+        run: |
+          if [[ "${{ matrix.coverage }}" == "true" ]]; then
+            mkdir -p build/logs
+            vendor/bin/phpunit --coverage-clover coverage.xml
+          else
+            vendor/bin/phpunit
+          fi
+
+      - name: Upload coverage to Codecov
+        if: matrix.coverage
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -5,6 +5,7 @@
 [![Total Downloads](https://poser.pugx.org/a2lix/auto-form-bundle/downloads)](https://packagist.org/packages/a2lix/auto-form-bundle)
 [![License](https://poser.pugx.org/a2lix/auto-form-bundle/license)](https://packagist.org/packages/a2lix/auto-form-bundle)
 [![Build Status](https://github.com/a2lix/AutoFormBundle/actions/workflows/ci.yml/badge.svg)](https://github.com/a2lix/AutoFormBundle/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/a2lix/AutoFormBundle/branch/main/graph/badge.svg)](https://codecov.io/gh/a2lix/AutoFormBundle)
 
 Stop writing boilerplate form code. This bundle provides a single, powerful `AutoType` form type that automatically generates a complete Symfony form from any PHP class.
 
@@ -135,6 +136,58 @@ class Product
 }
 ```
 
+### Conditional Fields with Groups
+
+You can conditionally include fields based on groups, similar to how Symfony's `validation_groups` work. This is useful for having different versions of a form (e.g., a "creation" version vs. an "edition" version).
+
+To enable this, pass a `children_groups` option to your form. This option specifies which groups of fields should be included.
+
+```php
+$form = $this->createForm(AutoType::class, $product, [
+    'children_groups' => ['product:edit'],
+]);
+```
+
+You can then assign fields to one or more groups using either form options or attributes.
+
+#### Via Form Options
+
+Use the `child_groups` option within the `children` configuration:
+
+```php
+// ...
+'children' => [
+    'name' => [
+        'child_groups' => ['product:edit', 'product:create'],
+    ],
+    'stock' => [
+        'child_groups' => ['product:edit'],
+    ],
+],
+// ...
+```
+
+In this example, if `children_groups` is set to `['product:edit']`, both `name` and `stock` will be included. If it's set to `['product:create']`, only `name` will be included.
+
+#### Via `#[AutoTypeCustom]` Attribute
+
+Use the `groups` property on the attribute:
+
+```php
+use A2lix\AutoFormBundle\Form\Attribute\AutoTypeCustom;
+
+class Product
+{
+    #[AutoTypeCustom(groups: ['product:edit', 'product:create'])]
+    public ?string $name = null;
+
+    #[AutoTypeCustom(groups: ['product:edit'])]
+    public ?int $stock = null;
+}
+```
+
+If no `children_groups` option is provided to the form, all fields are included by default, regardless of whether they have groups assigned.
+
 ## Advanced Recipes
 
 ### Creating a Compound Field with `inherit_data`

composer.json

@@ -29,13 +29,17 @@
         "doctrine/orm": "^3.5",
         "friendsofphp/php-cs-fixer": "^3.87",
         "kubawerlos/php-cs-fixer-custom-fixers": "^3.34",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
+        "phpstan/phpstan-strict-rules": "^2.0",
+        "phpstan/phpstan-symfony": "^2.0",
         "phpunit/phpunit": "^12.3",
         "rector/rector": "^2.1",
         "symfony/cache": "^7.3",
         "symfony/doctrine-bridge": "^7.3",
         "symfony/validator": "^7.3",
-        "symfony/var-dumper": "^7.3",
-        "vimeo/psalm": "^6.13"
+        "symfony/var-dumper": "^7.3"
     },
     "suggest": {
         "a2lix/translation-form-bundle": "For translation form"
@@ -44,8 +48,8 @@
         "cs-fixer": [
             "php-cs-fixer fix --verbose"
         ],
-        "psalm": [
-            "psalm"
+        "phpstan": [
+            "phpstan analyse --memory-limit=2G"
         ],
         "phpunit": [
             "phpunit"
@@ -54,7 +58,8 @@
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            "composer/package-versions-deprecated": true
+            "composer/package-versions-deprecated": true,
+            "phpstan/extension-installer": true
         }
     },
     "autoload": {

phpstan.neon

@@ -0,0 +1,20 @@
+parameters:
+    level: 10
+    paths:
+        - src
+        - tests
+    excludePaths:
+        - src/A2lixAutoFormBundle.php
+        - tests/Fixtures/*
+
+    # Stricter setup
+    checkTooWideReturnTypesInProtectedAndPublicMethods: true
+    checkUninitializedProperties: true
+    rememberPossiblyImpureFunctionValues: false
+    checkBenevolentUnionTypes: true
+    #reportPossiblyNonexistentGeneralArrayOffset: true
+    reportPossiblyNonexistentConstantArrayOffset: true
+    reportAlwaysTrueInLastCondition: true
+    reportAnyTypeWideningInVarTag: true
+    checkMissingOverrideMethodAttribute: true
+    checkMissingCallableSignature: true

psalm.xml

@@ -21,8 +21,6 @@ final class A2lixAutoFormBundle extends AbstractBundle
     #[\Override]
     public function configure(DefinitionConfigurator $definition): void
     {
-        /** @psalm-suppress UndefinedMethod */
-        /** @psalm-suppress MixedMethodCall */
         $definition->rootNode()
             ->children()
             ->arrayNode('children_excluded')

src/A2lixAutoFormBundle.php

@@ -11,37 +11,41 @@
 
 namespace A2lix\AutoFormBundle\Form\Attribute;
 
-use A2lix\AutoFormBundle\Form\Type\AutoType;
+use A2lix\AutoFormBundle\Form\Builder\AutoTypeBuilder;
 
 /**
- * @psalm-import-type ChildOptions from AutoType
+ * @phpstan-import-type ChildOptions from AutoTypeBuilder
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
 final readonly class AutoTypeCustom
 {
     /**
      * @param array<string, mixed> $options
      * @param class-string|null    $type
+     * @param list<string>|null    $groups
      */
     public function __construct(
         private array $options = [],
         private ?string $type = null,
         private ?string $name = null,
         private ?bool $excluded = null,
         private ?bool $embedded = null,
+        private ?array $groups = null,
     ) {}
 
     /**
      * @return ChildOptions
      */
     public function getOptions(): array
     {
+        /** @var ChildOptions */
         return [
             ...$this->options,
             ...(null !== $this->type ? ['child_type' => $this->type] : []),
             ...(null !== $this->name ? ['child_name' => $this->name] : []),
             ...(null !== $this->excluded ? ['child_excluded' => $this->excluded] : []),
             ...(null !== $this->embedded ? ['child_embedded' => $this->embedded] : []),
+            ...(null !== $this->groups ? ['child_groups' => $this->groups] : []),
         ];
     }
 }