[make:controller] generate final controller class

symfony · Aug 30, 2024 · e9192e4 · e9192e4
1 parent a3b7f14
commit e9192e4
Show file tree

Hide file tree

Showing 7 changed files with 113 additions and 20 deletions.
diff --git a/src/Maker/MakeController.php b/src/Maker/MakeController.php
@@ -17,8 +17,8 @@
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassData;
 use Symfony\Bundle\MakerBundle\Util\PhpCompatUtil;
-use Symfony\Bundle\MakerBundle\Util\UseStatementGenerator;
 use Symfony\Bundle\TwigBundle\TwigBundle;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -76,22 +76,48 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         $withTemplate = $this->isTwigInstalled() && !$input->getOption('no-template');
         $isInvokable = (bool) $input->getOption('invokable');
 
-        $useStatements = new UseStatementGenerator([
-            AbstractController::class,
-            $withTemplate ? Response::class : JsonResponse::class,
-            Route::class,
-        ]);
+        $controllerClass = $input->getArgument('controller-class');
 
-        $templateName = Str::asFilePath($controllerClassNameDetails->getRelativeNameWithoutSuffix())
+        $controllerClassData = ClassData::create(
+            class: '\\' === $controllerClass[0] ? substr($controllerClass, 1) : \sprintf('Controller\%s', $input->getArgument('controller-class')),
+            suffix: 'Controller',
+            extendsClass: AbstractController::class,
+            useStatements: [
+                $withTemplate ? Response::class : JsonResponse::class,
+                Route::class,
+            ]
+        );
+
+        //        dd([
+        //            $controllerClassNameDetails,
+        //            $controllerClassNameDetails->getRelativeName(),
+        //            $controllerClassNameDetails->getShortName(),
+        //            $controllerClassNameDetails->getFullName(),
+        //            $controllerClassNameDetails->getRelativeNameWithoutSuffix(),
+        //        ],
+        //            [
+        //                $controllerClassData,
+        //                $controllerClassData->getClassName(relative: true),
+        //                $controllerClassData->getClassName(),
+        //                $controllerClassData->getFullClassName(),
+        //                $controllerClassData->getClassName(relative: true, withoutSuffix: true),
+        //            ]
+        //        );
+
+        //        $templateName = Str::asFilePath($controllerClassNameDetails->getRelativeNameWithoutSuffix())
+        $templateName = Str::asFilePath($controllerClassData->getClassName(relative: true, withoutSuffix: true))
             .($isInvokable ? '.html.twig' : '/index.html.twig');
 
         $controllerPath = $generator->generateController(
-            $controllerClassNameDetails->getFullName(),
+            $controllerClassData->getFullClassName(),
             'controller/Controller.tpl.php',
             [
-                'use_statements' => $useStatements,
-                'route_path' => Str::asRoutePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
-                'route_name' => Str::asRouteName($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
+                'class_data' => $controllerClassData,
+                //                'use_statements' => $useStatements,
+                //                'route_path' => Str::asRoutePath($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
+                'route_path' => Str::asRoutePath($controllerClassData->getClassName(relative: true, withoutSuffix: true)),
+                'route_name' => Str::AsRouteName($controllerClassData->getClassName(relative: true, withoutSuffix: true)),
+                //                'route_name' => Str::asRouteName($controllerClassNameDetails->getRelativeNameWithoutSuffix()),
                 'method_name' => $isInvokable ? '__invoke' : 'index',
                 'with_template' => $withTemplate,
                 'template_name' => $templateName,
@@ -105,7 +131,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
                 [
                     'controller_path' => $controllerPath,
                     'root_directory' => $generator->getRootDirectory(),
-                    'class_name' => $controllerClassNameDetails->getShortName(),
+                    'class_name' => $controllerClassData->getClassName(),
                 ]
             );
         }

diff --git a/src/Resources/skeleton/controller/Controller.tpl.php b/src/Resources/skeleton/controller/Controller.tpl.php
@@ -1,10 +1,10 @@
 <?= "<?php\n" ?>
 
-namespace <?= $namespace; ?>;
+namespace <?= $class_data->getNamespace(); ?>;
 
-<?= $use_statements; ?>
+<?= $class_data->getUseStatements(); ?>
 
-class <?= $class_name; ?> extends AbstractController
+<?= $class_data->getClassDeclaration(); ?>
 {
 <?= $generator->generateRouteForControllerMethod($route_path, $route_name); ?>
     public function <?= $method_name ?>(): <?php if ($with_template) { ?>Response<?php } else { ?>JsonResponse<?php } ?>

diff --git a/src/Util/ClassSource/Model/ClassData.php b/src/Util/ClassSource/Model/ClassData.php
@@ -29,7 +29,11 @@ private function __construct(
         private UseStatementGenerator $useStatementGenerator,
         private bool $isFinal = true,
         private string $rootNamespace = 'App',
+        private ?string $classSuffix = null,
     ) {
+        if (str_starts_with(haystack: $this->namespace, needle: $this->rootNamespace)) {
+            $this->namespace = substr_replace(string: $this->namespace, replace: '', offset: 0, length: \strlen($this->rootNamespace) + 1);
+        }
     }
 
     public static function create(string $class, ?string $suffix = null, ?string $extendsClass = null, bool $isEntity = false, array $useStatements = []): self
@@ -52,12 +56,30 @@ className: Str::asClassName($className),
             extends: null === $extendsClass ? null : Str::getShortClassName($extendsClass),
             isEntity: $isEntity,
             useStatementGenerator: $useStatements,
+            classSuffix: $suffix,
         );
     }
 
-    public function getClassName(): string
+    public function getClassName(bool $relative = false, bool $withoutSuffix = false): string
     {
-        return $this->className;
+        if (!$withoutSuffix && !$relative) {
+            return $this->className;
+        }
+
+        if ($relative) {
+            $class = \sprintf('%s\%s', $this->namespace, $this->className);
+
+            $firstNsSeparatorPosition = stripos($class, '\\');
+            $class = substr_replace(string: $class, replace: '', offset: 0, length: $firstNsSeparatorPosition + 1);
+
+            if ($withoutSuffix) {
+                $class = Str::removeSuffix($class, $this->classSuffix);
+            }
+
+            return $class;
+        }
+
+        return Str::removeSuffix($this->className, $this->classSuffix);
     }
 
     public function getNamespace(): string

diff --git a/tests/Util/ClassSource/ClassDataTest.php b/tests/Util/ClassSource/ClassDataTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\MakerBundle\MakerBundle;
 use Symfony\Bundle\MakerBundle\Test\MakerTestKernel;
+use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
 use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassData;
 
 class ClassDataTest extends TestCase
@@ -91,4 +92,48 @@ public function namespaceDataProvider(): \Generator
         yield ['MyController', 'Maker', 'Maker', 'Maker\MyController'];
         yield ['Controller\MyController', 'Maker', 'Maker\Controller', 'Maker\Controller\MyController'];
     }
+
+    public function testGetClassName(): void
+    {
+        $class = ClassData::create(class: 'Controller\\Foo', suffix: 'Controller');
+        self::assertSame('FooController', $class->getClassName());
+        self::assertSame('Foo', $class->getClassName(relative: false, withoutSuffix: true));
+        self::assertSame('FooController', $class->getClassName(relative: true, withoutSuffix: false));
+        self::assertSame('Foo', $class->getClassName(relative: true, withoutSuffix: true));
+        self::assertSame('App\Controller\FooController', $class->getFullClassName());
+    }
+
+    public function testGetClassNameRelativeNamespace(): void
+    {
+        $class = ClassData::create(class: 'Controller\\Admin\\Foo', suffix: 'Controller');
+        self::assertSame('FooController', $class->getClassName());
+        self::assertSame('Foo', $class->getClassName(relative: false, withoutSuffix: true));
+        self::assertSame('Admin\FooController', $class->getClassName(relative: true, withoutSuffix: false));
+        self::assertSame('Admin\Foo', $class->getClassName(relative: true, withoutSuffix: true));
+        self::assertSame('App\Controller\Admin\FooController', $class->getFullClassName());
+    }
+
+    public function testGetClassNameWithAbsoluteNamespace(): void
+    {
+        $class = ClassData::create(class: '\\Foo\\Bar\\Admin\\Baz', suffix: 'Controller');
+        self::assertSame('BazController', $class->getClassName());
+        self::assertSame('Baz', $class->getClassName(relative: false, withoutSuffix: true));
+        //        self::assertSame('Admin\FooController', $class->getClassName(relative: true, withoutSuffix: false));
+        //        self::assertSame('Admin\Baz', $class->getClassName(relative: true, withoutSuffix: true));
+        self::assertSame('Foo\Bar\Admin\BazController', $class->getFullClassName());
+    }
+
+    //    public function testClassNameDetails(): void
+    //    {
+    //        $class = new ClassNameDetails(
+    //            fullClassName: 'Foo',
+    //            namespacePrefix: 'Controller\\',
+    //            suffix: 'Controller',
+    //        );
+    //
+    //        self::assertSame('FooController', $class->getFullName());
+    //        self::assertSame('MyController', $class->getShortName());
+    //        self::assertSame('My', $class->getRelativeNameWithoutSuffix());
+    //        self::assertSame('MyController', $class->getRelativeName());
+    //    }
 }
diff --git a/tests/fixtures/make-controller/tests/it_generates_a_controller.php b/tests/fixtures/make-controller/tests/it_generates_a_controller.php
@@ -4,7 +4,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
-class GeneratedControllerTest extends WebTestCase
+final class GeneratedControllerTest extends WebTestCase
 {
     public function testController()
     {

diff --git a/tests/fixtures/make-controller/tests/it_generates_a_controller_with_twig.php b/tests/fixtures/make-controller/tests/it_generates_a_controller_with_twig.php
@@ -4,7 +4,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
-class GeneratedControllerTest extends WebTestCase
+final class GeneratedControllerTest extends WebTestCase
 {
     public function testController()
     {

diff --git a/tests/fixtures/make-controller/tests/it_generates_an_invokable_controller.php b/tests/fixtures/make-controller/tests/it_generates_an_invokable_controller.php
@@ -4,7 +4,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
-class GeneratedControllerTest extends WebTestCase
+final class GeneratedControllerTest extends WebTestCase
 {
     public function testControllerValidity()
     {