Merge pull request #11 from tito10047/make-action

Add support for generating Action class and template in maker command

Author: tito10047

README.md

@@ -11,6 +11,24 @@
 
 A Symfony bundle that implements the **Single Directory Component (SDC)** methodology for Symfony UX. It bridges the gap between **AssetMapper** and **Twig Components** by providing a fully automated, convention-over-configuration workflow.
 
+## Real-world Usage & Developer Experience
+
+This bundle is actively used in production. Here are some real-world examples:
+- [formalitka.mostka.sk](https://formalitka.mostka.sk/)
+- [mostka.sk](https://mostka.sk/)
+- [ycon.cc](https://ycon.cc)
+
+### Developer Evaluation
+Working with UX SDC provides an excellent developer experience. A recommended project structure organizes the code into distinct functional areas:
+- **UI**: Generic interface elements (e.g., `Button`, `Spinner`, `Tabs`).
+- **Layout**: Structural page elements (e.g., `TopBar`, `Footer`, `FlashMessage`).
+- **Component**: Reusable feature blocks.
+- **Page**: Complete page components (e.g., `Homepage`, `AboutUs`).
+
+A significant advantage of this architecture is the ability to place Symfony controllers directly within the page-level SDC component directory (e.g., `HomepageAction.php`). The controller merely handles routing and renders the base layout, while all business and presentation logic remains encapsulated in isolated SDC components.
+
+Because the code is highly granular and strictly structured, AI tools work exceptionally well within this architecture, easily generating robust and creative design implementations.
+
 ## The Concept
 
 This bundle is inspired by the architectural challenges discussed in **["A Better Architecture for Your Symfony UX Twig Components"](https://hugo.alliau.me/blog/posts/a-better-architecture-for-your-symfony-ux-twig-components)** by **Hugo Alliaume**.
@@ -214,7 +232,54 @@ This will create:
 - `src/Component/UI/Alert/Alert.php` (PHP logic)
 - `src/Component/UI/Alert/Alert.html.twig` (Twig template)
 - `src/Component/UI/Alert/Alert.css` (CSS styles)
-- (Optional) `src/Component/Alert/Alert_controller.js` (Stimulus controller)
+- (Optional) `src/Component/UI/Alert/Alert_controller.js` (Stimulus controller)
+
+The maker supports options and interactive mode:
+- `--stimulus` to force generating a Stimulus controller (non-interactive mode will not create it unless explicitly set)
+- `--action` to generate a minimal controller action and a wrapper Twig template for the component
+
+Example with an action:
+
+```bash
+php bin/console make:sdc-component Page:Homepage --action
+```
+
+This will additionally create:
+- `src/Component/Page/Homepage/HomepageAction.php` (Symfony controller)
+- `src/Component/Page/Homepage/HomepageAction.html.twig` (page template rendering the component)
+
+Generated files contents:
+
+```php
+// src/Component/Page/Homepage/HomepageAction.php
+namespace App\Component\Page\Homepage;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Attribute\Route;
+
+class HomepageAction extends AbstractController
+{
+    #[Route('/en', name: 'app.homepage')]
+    public function index(): \Symfony\Component\HttpFoundation\Response
+    {
+        return $this->render('Page/Homepage/HomepageAction.html.twig');
+    }
+}
+```
+
+```twig
+{# src/Component/Page/Homepage/HomepageAction.html.twig #}
+{% extends 'layout.html.twig' %}
+
+{% block content %}
+    <twig:Page:Homepage:Homepage />
+{% endblock %}
+```
+
+In interactive mode, you will be asked:
+- for the component name (supports `:` or `/` separators, e.g. `UI:Alert` or `UI/Alert`)
+- whether to generate a Stimulus controller
+- whether to generate an Action class and template
 
 ---
 

src/Maker/MakeSdcComponent.php

@@ -48,6 +48,7 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
         $command
             ->addArgument('name', InputArgument::OPTIONAL, 'The name of the component (e.g. <alternate>Alert</alternate>)')
             ->addOption('stimulus', null, InputOption::VALUE_NONE, 'Whether to generate a Stimulus controller')
+            ->addOption('action', null, InputOption::VALUE_NONE, 'Whether to generate an action class and template')
             ->setHelp(<<<EOF
 The <info>make:sdc-component</info> command generates a new Single Directory Component (SDC).
 
@@ -56,6 +57,7 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
 - A Twig template
 - A CSS file
 - (Optional) A Stimulus controller
+- (Optional) An Action class and template
 
 Example:
 <info>php bin/console make:sdc-component UI:Alert</info>
@@ -80,6 +82,15 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             $withStimulus = $io->confirm('Do you want to generate a Stimulus controller?', true);
         }
 
+        if ($input->getOption('action')) {
+            $withAction = true;
+        } elseif (!$input->isInteractive()) {
+            // In non-interactive mode, do NOT generate Action unless explicitly requested
+            $withAction = false;
+        } else {
+            $withAction = $io->confirm('Do you want to generate an Action class and template?', false);
+        }
+
         $name = str_replace(['/', ':'], '\\', $name);
         $parts = explode('\\', $name);
         $componentName = Str::asClassName(array_pop($parts));
@@ -131,6 +142,27 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             );
         }
 
+        if ($withAction) {
+            $fullTwigComponentName = ($subPath ? str_replace('/', ':', $subPath) . ':' : '') . $componentName . ':' . $componentName;
+
+            $generator->generateClass(
+                $fullNamespace . '\\' . $componentName . '\\' . $componentName . 'Action',
+                __DIR__.'/../../templates/sdc/Action.tpl.php',
+                [
+                    'component_name' => $componentName,
+                    'sub_path' => $subPath,
+                ]
+            );
+
+            $generator->generateFile(
+                $directory . '/' . $componentName . '/' . $componentName . 'Action.html.twig',
+                __DIR__.'/../../templates/sdc/ActionTemplate.tpl.php',
+                [
+                    'full_twig_component_name' => $fullTwigComponentName,
+                ]
+            );
+        }
+
         $generator->writeChanges();
 
         $this->writeSuccessMessage($io);

templates/sdc/Action.tpl.php

@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the UX SDC Bundle
+ *
+ * (c) Jozef Môstka <https://github.com/tito10047/ux-sdc>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+?>
+<?= "<?php\n" ?>
+
+namespace <?= $namespace ?>;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Attribute\Route;
+
+class <?= $class_name ?> extends AbstractController
+{
+    #[Route('/en', name: 'app.<?= strtolower($component_name) ?>')]
+    public function index(): \Symfony\Component\HttpFoundation\Response
+    {
+        return $this->render('<?= ($sub_path ? $sub_path.'/' : '').$component_name ?>/<?= $component_name ?>Action.html.twig');
+    }
+}

templates/sdc/ActionTemplate.tpl.php

@@ -0,0 +1,5 @@
+{% extends 'layout.html.twig' %}
+
+{% block content %}
+    <twig:<?= $full_twig_component_name ?> />
+{% endblock %}

tests/Integration/Maker/MakeSdcComponentTest.php

@@ -26,13 +26,15 @@ protected function setUp(): void
         parent::setUp();
         $this->removeDir(self::getContainer()->getParameter('ux_sdc.ux_components_dir') . '/UI');
         $this->removeDir(self::getContainer()->getParameter('ux_sdc.ux_components_dir') . '/Alert');
+        $this->removeDir(self::getContainer()->getParameter('ux_sdc.ux_components_dir') . '/Page');
     }
 
     protected function tearDown(): void
     {
         parent::tearDown();
         $this->removeDir(self::getContainer()->getParameter('ux_sdc.ux_components_dir') . '/UI');
         $this->removeDir(self::getContainer()->getParameter('ux_sdc.ux_components_dir') . '/Alert');
+        $this->removeDir(self::getContainer()->getParameter('ux_sdc.ux_components_dir') . '/Page');
     }
 
     private function removeDir(string $dir): void
@@ -87,6 +89,63 @@ public function testMakeSdcComponent(): void
         $this->assertStringContainsString('tests/Integration/Fixtures/Component/UI/Alert/Alert.php', $display);
     }
 
+    public function testMakeSdcComponentWithAction(): void
+    {
+        self::bootKernel();
+        $application = new Application(self::$kernel);
+
+        $command = $application->find('make:sdc-component');
+        $tester = new CommandTester($command);
+
+        // UI:Homepage s voľbou --action
+        $tester->execute([
+            'name' => 'Page:Homepage',
+            '--action' => true,
+        ], [
+            'interactive' => false,
+        ]);
+
+        $tester->assertCommandIsSuccessful();
+
+        $baseDir = self::getContainer()->getParameter('ux_sdc.ux_components_dir');
+        $this->assertFileExists($baseDir . '/Page/Homepage/Homepage.php');
+        $this->assertFileExists($baseDir . '/Page/Homepage/HomepageAction.php');
+        $this->assertFileExists($baseDir . '/Page/Homepage/HomepageAction.html.twig');
+
+        $actionPhpContent = file_get_contents($baseDir . '/Page/Homepage/HomepageAction.php');
+        $this->assertStringContainsString('namespace Tito10047\UX\Sdc\Tests\Integration\Fixtures\Component\Page\Homepage;', $actionPhpContent);
+        $this->assertStringContainsString('class HomepageAction extends AbstractController', $actionPhpContent);
+        $this->assertStringContainsString('#[Route(\'/en\', name: \'app.homepage\')]', $actionPhpContent);
+        $this->assertStringContainsString('return $this->render(\'Page/Homepage/HomepageAction.html.twig\');', $actionPhpContent);
+
+        $actionTwigContent = file_get_contents($baseDir . '/Page/Homepage/HomepageAction.html.twig');
+        $this->assertStringContainsString('{% extends \'layout.html.twig\' %}', $actionTwigContent);
+        $this->assertStringContainsString('<twig:Page:Homepage:Homepage />', $actionTwigContent);
+    }
+
+    public function testMakeSdcComponentInteractiveWithAction(): void
+    {
+        self::bootKernel();
+        $application = new Application(self::$kernel);
+
+        $command = $application->find('make:sdc-component');
+        $tester = new CommandTester($command);
+
+        $tester->setInputs([
+            'Page:Homepage', // Component name
+            'n',             // Stimulus?
+            'y',             // Action?
+        ]);
+
+        $tester->execute([]);
+
+        $tester->assertCommandIsSuccessful();
+
+        $baseDir = self::getContainer()->getParameter('ux_sdc.ux_components_dir');
+        $this->assertFileExists($baseDir . '/Page/Homepage/HomepageAction.php');
+        $this->assertFileExists($baseDir . '/Page/Homepage/HomepageAction.html.twig');
+    }
+
     public function testMakeSdcComponentWithColonSeparator(): void
     {
         self::bootKernel();