Add support for Symfony UX Turbo

Author: dunglas

.github/workflows/ci.yaml

@@ -65,6 +65,17 @@ jobs:
                 ports:
                     - 3306
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+            mercure:
+                image: dunglas/mercure
+                env:
+                    SERVER_NAME: :1337
+                    MERCURE_PUBLISHER_JWT_KEY: '!ChangeMe!'
+                    MERCURE_SUBSCRIBER_JWT_KEY: '!ChangeMe!'
+                    MERCURE_EXTRA_DIRECTIVES: |
+                        anonymous
+                        cors_origins *
+                ports:
+                    - 1337:1337
 
         continue-on-error: ${{ matrix.allow-failures }}
 

src/Doctrine/EntityClassGenerator.php

@@ -33,7 +33,7 @@ public function __construct(Generator $generator, DoctrineHelper $doctrineHelper
         $this->doctrineHelper = $doctrineHelper;
     }
 
-    public function generateEntityClass(ClassNameDetails $entityClassDetails, bool $apiResource, bool $withPasswordUpgrade = false, bool $generateRepositoryClass = true): string
+    public function generateEntityClass(ClassNameDetails $entityClassDetails, bool $apiResource, bool $withPasswordUpgrade = false, bool $generateRepositoryClass = true, bool $broadcast = false): string
     {
         $repoClassDetails = $this->generator->createClassNameDetails(
             $entityClassDetails->getRelativeName(),
@@ -50,6 +50,7 @@ public function generateEntityClass(ClassNameDetails $entityClassDetails, bool $
                 'repository_full_class_name' => $repoClassDetails->getFullName(),
                 'repository_class_name' => $repoClassDetails->getShortName(),
                 'api_resource' => $apiResource,
+                'broadcast' => $broadcast,
                 'should_escape_table_name' => $this->doctrineHelper->isKeyword($tableName),
                 'table_name' => $tableName,
             ]

src/Maker/MakeEntity.php

@@ -35,6 +35,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Question\ConfirmationQuestion;
 use Symfony\Component\Console\Question\Question;
+use Symfony\UX\Turbo\Attribute\Broadcast;
 
 /**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
@@ -84,6 +85,7 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
         $command
             ->addArgument('name', InputArgument::OPTIONAL, sprintf('Class name of the entity to create or update (e.g. <fg=yellow>%s</>)', Str::asClassName(Str::getRandomTerm())))
             ->addOption('api-resource', 'a', InputOption::VALUE_NONE, 'Mark this class as an API Platform resource (expose a CRUD API for it)')
+            ->addOption('broadcast', 'b', InputOption::VALUE_NONE, 'Add the ability to broadcast entity updates using Symfony UX Turbo?')
             ->addOption('regenerate', null, InputOption::VALUE_NONE, 'Instead of adding new fields, simply generate the methods (e.g. getter/setter) for existing fields')
             ->addOption('overwrite', null, InputOption::VALUE_NONE, 'Overwrite any existing getter/setter methods')
             ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeEntity.txt'))
@@ -127,6 +129,18 @@ class_exists(ApiResource::class) &&
 
             $input->setOption('api-resource', $value);
         }
+
+        if (
+            !$input->getOption('broadcast') &&
+            class_exists(Broadcast::class) &&
+            !class_exists($this->generator->createClassNameDetails($value, 'Entity\\')->getFullName())
+        ) {
+            $description = $command->getDefinition()->getOption('broadcast')->getDescription();
+            $question = new ConfirmationQuestion($description, false);
+            $value = $io->askQuestion($question);
+
+            $input->setOption('broadcast', $value);
+        }
     }
 
     public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator)
@@ -148,11 +162,27 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
 
         $classExists = class_exists($entityClassDetails->getFullName());
         if (!$classExists) {
+            $broadcast = $input->getOption('broadcast');
             $entityPath = $this->entityClassGenerator->generateEntityClass(
                 $entityClassDetails,
-                $input->getOption('api-resource')
+                $input->getOption('api-resource'),
+                false,
+                true,
+                $broadcast
             );
 
+            if ($broadcast) {
+                $shortName = $entityClassDetails->getShortName();
+                $generator->generateTemplate(
+                    sprintf('broadcast/%s.stream.html.twig', $shortName),
+                    'doctrine/broadcast_twig_template.tpl.php',
+                    [
+                        'class_name' => Str::asSnakeCase($shortName),
+                        'class_name_plural' => Str::asSnakeCase(Str::singularCamelCaseToPluralCamelCase($shortName)),
+                    ]
+                );
+            }
+
             $generator->writeChanges();
         }
 
@@ -280,6 +310,13 @@ public function configureDependencies(DependencyBuilder $dependencies, InputInte
             );
         }
 
+        if (null !== $input && $input->getOption('broadcast')) {
+            $dependencies->addClassDependency(
+                Broadcast::class,
+                'ux-turbo-mercure'
+            );
+        }
+
         ORMDependencyBuilder::buildDependencies($dependencies);
     }
 

src/Resources/help/MakeEntity.txt

@@ -9,6 +9,11 @@ automatically be available for this entity class:
 
 <info>php %command.full_name% --api-resource</info>
 
+Symfony can also broadcast all changes made to the entity to the client using Symfony
+UX Turbo.
+
+<info>php %command.full_name% --broadcast</info>
+
 You can also generate all the getter/setter/adder/remover methods
 for the properties of existing entities:
 

src/Resources/skeleton/doctrine/Entity.tpl.php

@@ -6,9 +6,13 @@
 <?php endif ?>
 use <?= $repository_full_class_name ?>;
 use Doctrine\ORM\Mapping as ORM;
+<?php if ($broadcast): ?>use Symfony\UX\Turbo\Attribute\Broadcast;
+<?php endif ?>
 
 /**
 <?php if ($api_resource && !$use_attributes): ?> * @ApiResource()
+<?php endif ?>
+<?php if ($broadcast && !$use_attributes): ?> * @Broadcast()
 <?php endif ?>
  * @ORM\Entity(repositoryClass=<?= $repository_class_name ?>::class)
 <?php if ($should_escape_table_name): ?> * @ORM\Table(name="`<?= $table_name ?>`")
@@ -17,6 +21,9 @@
 <?php if ($api_resource && $use_attributes): ?>
 #[ApiResource]
 <?php endif ?>
+<?php if ($broadcast && $use_attributes): ?>
+#[Broadcast]
+<?php endif ?>
 class <?= $class_name."\n" ?>
 {
     /**

src/Resources/skeleton/doctrine/broadcast_twig_template.tpl.php

@@ -0,0 +1,22 @@
+{# Learn how to use Turbo Streams: https://github.com/symfony/ux-turbo#broadcast-doctrine-entities-update #}
+{% block create %}
+<turbo-stream action="append" target="<?= $class_name_plural ?>">
+    <template>
+        <div id="{{ '<?= $class_name ?>_' ~ id }}">
+            #{{ id }} created
+        </div>
+    </template>
+</turbo-stream>
+{% endblock %}
+
+{% block update %}
+<turbo-stream action="update" target="<?= $class_name ?>_{{ id }}">
+    <template>
+        #{{ id }} updated
+    </template>
+</turbo-stream>
+{% endblock %}
+
+{% block remove %}
+<turbo-stream action="remove" target="<?= $class_name ?>_{{ id }}"></turbo-stream>
+{% endblock %}

tests/Maker/MakeEntityTest.php

@@ -564,5 +564,34 @@ public function getTestDetails()
             ->configureDatabase()
             ->updateSchemaAfterCommand(),
         ];
+
+        yield 'entity_new_broadcast' => [MakerTestDetails::createTest(
+            $this->getMakerInstance(MakeEntity::class),
+            [
+                // entity class name
+                'User',
+                // Mark the entity as broadcasted
+                'y',
+                // add not additional fields
+                '',
+            ])
+            ->setRequiredPhpVersion(70200)
+            ->addExtraDependencies('ux-turbo-mercure')
+            ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeEntity')
+            ->configureDatabase()
+            ->addReplacement(
+                '.env',
+                'https://127.0.0.1:8000/.well-known/mercure',
+                'http://127.0.0.1:1337/.well-known/mercure'
+            )
+            ->updateSchemaAfterCommand()
+            ->assert(function (string $output, string $directory) {
+                $this->assertFileExists($directory.'/src/Entity/User.php');
+
+                $content = file_get_contents($directory.'/src/Entity/User.php');
+                $this->assertStringContainsString('use Symfony\UX\Turbo\Attribute\Broadcast;', $content);
+                $this->assertStringContainsString(\PHP_VERSION_ID >= 80000 ? '#[Broadcast]' : '@Broadcast', $content);
+            }),
+        ];
     }
 }