Files
php-qml/framework/php/src/Maker/BridgeResourceMaker.php

170 lines
6.4 KiB
PHP
Raw Normal View History

Phase 2 sub-commit 4: make:bridge:resource maker Bundle picks up symfony/maker-bundle as require-dev. New BridgeResourceMaker under PhpQml\Bridge\Maker generates three files for a named resource: - src/Entity/<Name>.php — Doctrine entity with #[BridgeResource] and a UUIDv7 id by default. --int-id flips to auto-incrementing int IDs. - src/Controller/<Name>Controller.php — CRUD on /api/{plural} (list, create, update, delete) with serializer- normalised JSON responses. - {qml_path}/<Name>List.qml — starter ListView wrapped around a ReactiveListModel bound to the right topic and source URL. The Doctrine subscriber from sub-commit 2 picks the entity up automatically — no per-resource listener generated. The QML snippet target defaults to '../qml/' (relative to the Symfony project root) and is overridable via the maker's $qmlPath constructor arg. Templates live under src/Maker/templates/ as .tpl.php files using short-echo and alternative-syntax control structures by convention. PHPStan and php-cs-fixer skip them — the maker's Generator binds the template variables at render time. Skeleton picks up MakerBundle as a `dev` bundle and require-dev'd symfony/maker-bundle, so `bin/console make:bridge:resource Todo` works out-of-the-box. Verified: maker runs end-to-end against `Todo` and emits readable, syntactically valid output. composer quality (16 tests, 45 assertions, PHPStan clean, cs-fixer clean) stays green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 02:45:42 +02:00
<?php
declare(strict_types=1);
namespace PhpQml\Bridge\Maker;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping as ORM;
use PhpQml\Bridge\Attribute\BridgeResource;
use Symfony\Bundle\MakerBundle\ConsoleStyle;
use Symfony\Bundle\MakerBundle\DependencyBuilder;
use Symfony\Bundle\MakerBundle\Generator;
use Symfony\Bundle\MakerBundle\InputConfiguration;
use Symfony\Bundle\MakerBundle\Maker\AbstractMaker;
use Symfony\Bundle\MakerBundle\Str;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Attribute\Route;
Phase 3 sub-commit 5: maker-output snapshot test + phase closure framework/php/tests/snapshot/ holds reference output for every shipped maker (resource Todo, command MarkAllDone, window Todo). The run.sh script: - git-archives the skeleton into a temp dir - composer-installs against the bundle's real path - removes the existing maker outputs so the regenerators don't bail - runs the three makers - diffs each generated file against the matching baseline CI / make quality fail on any drift; if a template change is intended, the baselines must be regenerated in the same commit. Wired into: - framework/skeleton/Makefile's `quality` target (local/dev runs) - .gitea/workflows/ci.yml (CI runs after qmllint) Plus a few hardenings discovered while wiring this up: - The resource maker template now injects NormalizerInterface (not SerializerInterface — that interface lacks ::normalize()). All Todo controllers re-rendered to match. - The command maker template emits a $this->em->flush() so the injected EntityManager isn't a property.onlyWritten violation in PHPStan after the user fills in the body. - phpstan.neon and php-cs-fixer's Finder both exclude tests/snapshot so the baselines aren't auto-rewritten or analysed as live code. CI workflow now also installs FrankenPHP, builds the todo example, and runs the bridge-integration test from Phase 3 sub-commit 4. Phase 3 done. Outstanding follow-ups (deferred per spec): the qmltestrunner-driven QML unit tests, make:bridge:event, make:bridge:read-model, ReactiveObject pagination. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 16:03:41 +02:00
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
Phase 2 sub-commit 4: make:bridge:resource maker Bundle picks up symfony/maker-bundle as require-dev. New BridgeResourceMaker under PhpQml\Bridge\Maker generates three files for a named resource: - src/Entity/<Name>.php — Doctrine entity with #[BridgeResource] and a UUIDv7 id by default. --int-id flips to auto-incrementing int IDs. - src/Controller/<Name>Controller.php — CRUD on /api/{plural} (list, create, update, delete) with serializer- normalised JSON responses. - {qml_path}/<Name>List.qml — starter ListView wrapped around a ReactiveListModel bound to the right topic and source URL. The Doctrine subscriber from sub-commit 2 picks the entity up automatically — no per-resource listener generated. The QML snippet target defaults to '../qml/' (relative to the Symfony project root) and is overridable via the maker's $qmlPath constructor arg. Templates live under src/Maker/templates/ as .tpl.php files using short-echo and alternative-syntax control structures by convention. PHPStan and php-cs-fixer skip them — the maker's Generator binds the template variables at render time. Skeleton picks up MakerBundle as a `dev` bundle and require-dev'd symfony/maker-bundle, so `bin/console make:bridge:resource Todo` works out-of-the-box. Verified: maker runs end-to-end against `Todo` and emits readable, syntactically valid output. composer quality (16 tests, 45 assertions, PHPStan clean, cs-fixer clean) stays green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 02:45:42 +02:00
use Symfony\Component\Uid\Uuid;
/**
* `make:bridge:resource <Name>` generates the three files needed to
* expose a Doctrine entity as a reactive bridge resource:
*
* - src/Entity/<Name>.php `#[BridgeResource]` + `#[ORM\Entity]`
* - src/Controller/<Name>Controller.php CRUD on `/api/{plural}`
* - {qml_path}/<Name>List.qml starter `ReactiveListModel`
*
* The Doctrine subscriber installed by the bundle picks the entity up
* automatically no per-resource listener is generated. The QML snippet
* goes to `qml_path` (default: `../qml/`, configurable via the bundle's
* `qml_path` option in services.yaml).
*
* See PLAN.md §8 (*Custom makers*).
*/
final class BridgeResourceMaker extends AbstractMaker
{
public function __construct(
private readonly string $qmlPath = '../qml/',
) {
}
public static function getCommandName(): string
{
return 'make:bridge:resource';
}
public static function getCommandDescription(): string
{
return 'Generate a #[BridgeResource] entity, CRUD controller, and QML snippet.';
}
public function configureCommand(Command $command, InputConfiguration $inputConfig): void
{
$command
->addArgument(
'name',
InputArgument::OPTIONAL,
'Singular name of the resource (e.g. Todo).',
)
->addOption(
'int-id',
null,
InputOption::VALUE_NONE,
'Use auto-incrementing int IDs instead of the default UUIDv7.',
)
->setHelp(
"The maker creates three files:\n\n"
." • <info>src/Entity/Todo.php</info> — Doctrine entity tagged with #[BridgeResource]\n"
." • <info>src/Controller/TodoController.php</info> — CRUD on /api/todos\n"
." • <info>{qml_path}/TodoList.qml</info> — starter ReactiveListModel snippet\n\n"
."After the maker, run <info>bin/console make:migration</info> and apply it.\n"
);
}
public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void
{
if (null === $input->getArgument('name')) {
$name = $io->ask('What is the resource name (e.g. Todo)?', null, static function (?string $v): string {
if (null === $v || '' === trim($v)) {
throw new \RuntimeException('Resource name cannot be empty.');
}
return ucfirst(trim($v));
});
$input->setArgument('name', $name);
}
}
public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
{
$rawName = (string) $input->getArgument('name');
$useUuid = !(bool) $input->getOption('int-id');
$singular = ucfirst(Str::asCamelCase($rawName));
$pluralCamel = Str::singularCamelCaseToPluralCamelCase($singular);
$resource = strtolower($singular);
$pluralUnder = strtolower(preg_replace('/(?<!^)[A-Z]/', '_$0', $pluralCamel) ?? $pluralCamel);
$route = '/api/'.$pluralUnder;
$entityFqcn = $generator->createClassNameDetails(
$singular,
'Entity\\',
);
$controllerFqcn = $generator->createClassNameDetails(
$singular,
'Controller\\',
'Controller',
);
$vars = [
'singular' => $singular,
'plural' => $pluralUnder,
'resource' => $resource,
'route' => $route,
'entity_short' => $entityFqcn->getShortName(),
'entity_fqcn' => $entityFqcn->getFullName(),
'controller_fqcn' => $controllerFqcn->getFullName(),
'use_uuid' => $useUuid,
];
$generator->generateFile(
'src/Entity/'.$entityFqcn->getShortName().'.php',
__DIR__.'/templates/Entity.tpl.php',
$vars,
);
$generator->generateFile(
'src/Controller/'.$controllerFqcn->getShortName().'.php',
__DIR__.'/templates/Controller.tpl.php',
$vars,
);
// QML snippet — outside the Symfony project root, so we use a
// path relative to the project's working dir.
$qmlTarget = rtrim($this->qmlPath, '/').'/'.$singular.'List.qml';
$generator->generateFile(
$qmlTarget,
__DIR__.'/templates/QmlSnippet.tpl.php',
$vars,
);
$generator->writeChanges();
$this->writeSuccessMessage($io);
$io->text([
'Next:',
' 1) <info>bin/console make:migration</info>',
' 2) <info>bin/console doctrine:migrations:migrate -n</info>',
" 3) Use <info>{$singular}List.qml</info> from your QML.",
]);
}
public function configureDependencies(DependencyBuilder $dependencies): void
{
$dependencies->addClassDependency(ORM\Entity::class, 'doctrine/orm');
$dependencies->addClassDependency(BridgeResource::class, 'php-qml/bridge');
$dependencies->addClassDependency(Route::class, 'symfony/routing');
$dependencies->addClassDependency(JsonResponse::class, 'symfony/http-foundation');
$dependencies->addClassDependency(Request::class, 'symfony/http-foundation');
$dependencies->addClassDependency(EntityManagerInterface::class, 'doctrine/orm');
Phase 3 sub-commit 5: maker-output snapshot test + phase closure framework/php/tests/snapshot/ holds reference output for every shipped maker (resource Todo, command MarkAllDone, window Todo). The run.sh script: - git-archives the skeleton into a temp dir - composer-installs against the bundle's real path - removes the existing maker outputs so the regenerators don't bail - runs the three makers - diffs each generated file against the matching baseline CI / make quality fail on any drift; if a template change is intended, the baselines must be regenerated in the same commit. Wired into: - framework/skeleton/Makefile's `quality` target (local/dev runs) - .gitea/workflows/ci.yml (CI runs after qmllint) Plus a few hardenings discovered while wiring this up: - The resource maker template now injects NormalizerInterface (not SerializerInterface — that interface lacks ::normalize()). All Todo controllers re-rendered to match. - The command maker template emits a $this->em->flush() so the injected EntityManager isn't a property.onlyWritten violation in PHPStan after the user fills in the body. - phpstan.neon and php-cs-fixer's Finder both exclude tests/snapshot so the baselines aren't auto-rewritten or analysed as live code. CI workflow now also installs FrankenPHP, builds the todo example, and runs the bridge-integration test from Phase 3 sub-commit 4. Phase 3 done. Outstanding follow-ups (deferred per spec): the qmltestrunner-driven QML unit tests, make:bridge:event, make:bridge:read-model, ReactiveObject pagination. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 16:03:41 +02:00
$dependencies->addClassDependency(NormalizerInterface::class, 'symfony/serializer');
Phase 2 sub-commit 4: make:bridge:resource maker Bundle picks up symfony/maker-bundle as require-dev. New BridgeResourceMaker under PhpQml\Bridge\Maker generates three files for a named resource: - src/Entity/<Name>.php — Doctrine entity with #[BridgeResource] and a UUIDv7 id by default. --int-id flips to auto-incrementing int IDs. - src/Controller/<Name>Controller.php — CRUD on /api/{plural} (list, create, update, delete) with serializer- normalised JSON responses. - {qml_path}/<Name>List.qml — starter ListView wrapped around a ReactiveListModel bound to the right topic and source URL. The Doctrine subscriber from sub-commit 2 picks the entity up automatically — no per-resource listener generated. The QML snippet target defaults to '../qml/' (relative to the Symfony project root) and is overridable via the maker's $qmlPath constructor arg. Templates live under src/Maker/templates/ as .tpl.php files using short-echo and alternative-syntax control structures by convention. PHPStan and php-cs-fixer skip them — the maker's Generator binds the template variables at render time. Skeleton picks up MakerBundle as a `dev` bundle and require-dev'd symfony/maker-bundle, so `bin/console make:bridge:resource Todo` works out-of-the-box. Verified: maker runs end-to-end against `Todo` and emits readable, syntactically valid output. composer quality (16 tests, 45 assertions, PHPStan clean, cs-fixer clean) stays green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 02:45:42 +02:00
$dependencies->addClassDependency(Uuid::class, 'symfony/uid');
}
}