better way to pass class info around

Author: jrushlow

src/Generator.php

@@ -14,6 +14,7 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
+use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassData;
 use Symfony\Bundle\MakerBundle\Util\PhpCompatUtil;
 use Symfony\Bundle\MakerBundle\Util\TemplateComponentGenerator;
 
@@ -60,16 +61,13 @@ public function generateClass(string $className, string $templateName, array $va
             throw new \LogicException(sprintf('Could not determine where to locate the new class "%s", maybe try with a full namespace like "\\My\\Full\\Namespace\\%s"', $className, Str::getShortClassName($className)));
         }
 
-        $isEntity = false;
-
-        if (\array_key_exists('_is_entity', $variables)) {
-            $isEntity = true;
+        if (\array_key_exists('class_data', $variables) && $variables['class_data'] instanceof ClassData) {
+            $this->templateComponentGenerator->configureClass($variables['class_data']);
         }
 
         $variables = array_merge($variables, [
             'class_name' => Str::getShortClassName($className),
             'namespace' => Str::getNamespace($className),
-            'final_class' => $this->templateComponentGenerator->getFinalDeclaration($isEntity),
         ]);
 
         $this->addOperation($targetPath, $templateName, $variables);

src/Maker/MakeVoter.php

@@ -15,6 +15,7 @@
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
+use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassData;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -46,6 +47,11 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
 
     public function generate(InputInterface $input, ConsoleStyle $io, Generator $generator): void
     {
+        $classMetaData = ClassData::create(
+            class: sprintf('App\Security\Voter\%sVoter', $input->getArgument('name')),
+            extendsClass: Voter::class,
+        );
+
         $voterClassNameDetails = $generator->createClassNameDetails(
             $input->getArgument('name'),
             'Security\\Voter\\',
@@ -55,7 +61,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
         $generator->generateClass(
             $voterClassNameDetails->getFullName(),
             'security/Voter.tpl.php',
-            []
+            ['class_data' => $classMetaData]
         );
 
         $generator->writeChanges();

src/Resources/skeleton/security/Voter.tpl.php

@@ -6,7 +6,7 @@
 use Symfony\Component\Security\Core\Authorization\Voter\Voter;
 use Symfony\Component\Security\Core\User\UserInterface;
 
-<?= $final_class ?>class <?= $class_name ?> extends Voter
+<?= $class_data->getClassDeclaration() ?>
 {
     public const EDIT = 'POST_EDIT';
     public const VIEW = 'POST_VIEW';

src/Util/ClassSource/Model/ClassData.php

@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Util\ClassSource\Model;
+
+use Symfony\Bundle\MakerBundle\Str;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+final class ClassData
+{
+    private function __construct(
+        public readonly string $className,
+        public readonly string $namespace,
+        public readonly ?string $extends,
+        public readonly bool $isEntity,
+        private bool $isFinal = true,
+    ) {
+    }
+
+    public static function create(string $class, ?string $extendsClass = null, bool $isEntity = false): self
+    {
+        return new self(
+            className: Str::getShortClassName($class),
+            namespace: Str::getNamespace($class),
+            extends: null === $extendsClass ? null : Str::getShortClassName($extendsClass),
+            isEntity: $isEntity
+        );
+    }
+
+    public function getClassDeclaration(): string
+    {
+        $extendsDeclaration = '';
+
+        if (null !== $this->extends) {
+            $extendsDeclaration = sprintf(' extends %s', $this->extends);
+        }
+
+        return sprintf('%sclass %s%s',
+            $this->isFinal ? 'final ' : '',
+            $this->className,
+            $extendsDeclaration,
+        );
+    }
+
+    public function setIsFinal(bool $isFinal): self
+    {
+        $this->isFinal = $isFinal;
+
+        return $this;
+    }
+}

src/Util/TemplateComponentGenerator.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\MakerBundle\Util;
 
+use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassData;
+
 /**
  * @author Jesse Rushlow <[email protected]>
  *
@@ -50,12 +52,12 @@ public function getPropertyType(ClassNameDetails $classNameDetails): ?string
         return sprintf('%s ', $classNameDetails->getShortName());
     }
 
-    public function getFinalDeclaration(bool $forEntity = false): string
+    public function configureClass(ClassData $classMetadata): ClassData
     {
-        if ($forEntity) {
-            return $this->generateFinalEntities ? 'final ' : '';
+        if ($classMetadata->isEntity) {
+            return $classMetadata->setIsFinal($this->generateFinalEntities);
         }
 
-        return $this->generateFinalClasses ? 'final ' : '';
+        return $classMetadata->setIsFinal($this->generateFinalClasses);
     }
 }

tests/Maker/MakeVoterTest.php

@@ -41,11 +41,11 @@ public function getTestDetails(): \Generator
             }),
         ];
 
-        yield 'it_makes_voter_final' => [$this->createMakerTest()
+        yield 'it_makes_voter_not_final' => [$this->createMakerTest()
             ->run(function (MakerTestRunner $runner) {
                 $runner->writeFile(
                     'config/packages/dev/maker.yaml',
-                    Yaml::dump(['when@dev' => ['maker' => ['generate_final_classes' => true]]])
+                    Yaml::dump(['when@dev' => ['maker' => ['generate_final_classes' => false]]])
                 );
 
                 $runner->runMaker(
@@ -55,7 +55,7 @@ public function getTestDetails(): \Generator
                     ]
                 );
 
-                $expectedVoterPath = \dirname(__DIR__).'/fixtures/make-voter/expected/final_FooBarVoter.php';
+                $expectedVoterPath = \dirname(__DIR__).'/fixtures/make-voter/expected/not_final_FooBarVoter.php';
                 $generatedVoter = $runner->getPath('src/Security/Voter/FooBarVoter.php');
 
                 self::assertSame(file_get_contents($expectedVoterPath), file_get_contents($generatedVoter));

tests/Util/ClassSource/ClassDataTest.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Tests\Util\ClassSource;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\MakerBundle\MakerBundle;
+use Symfony\Bundle\MakerBundle\Test\MakerTestKernel;
+use Symfony\Bundle\MakerBundle\Util\ClassSource\Model\ClassData;
+
+class ClassDataTest extends TestCase
+{
+    public function testStaticConstructor(): void
+    {
+        $meta = ClassData::create(MakerBundle::class);
+
+        // Sanity check in case Maker's NS changes
+        self::assertSame('Symfony\Bundle\MakerBundle\MakerBundle', MakerBundle::class);
+
+        self::assertSame('MakerBundle', $meta->className);
+        self::assertSame('Symfony\Bundle\MakerBundle', $meta->namespace);
+    }
+
+    public function testGetClassDeclaration(): void
+    {
+        $meta = ClassData::create(MakerBundle::class);
+
+        self::assertSame('final class MakerBundle', $meta->getClassDeclaration());
+    }
+
+    public function testIsFinal(): void
+    {
+        $meta = ClassData::create(MakerBundle::class);
+
+        // Default - isFinal - true
+        self::assertSame('final class MakerBundle', $meta->getClassDeclaration());
+
+        // Not Final - isFinal - false
+        $meta->setIsFinal(false);
+        self::assertSame('class MakerBundle', $meta->getClassDeclaration());
+    }
+
+    public function testGetClassDeclarationWithExtends(): void
+    {
+        $meta = ClassData::create(class: MakerBundle::class, extendsClass: MakerTestKernel::class);
+
+        self::assertSame('final class MakerBundle extends MakerTestKernel', $meta->getClassDeclaration());
+    }
+}

tests/Util/TemplateComponentGeneratorTest.php

@@ -94,6 +94,7 @@ public function routeTrailingNewLineDataProvider(): \Generator
      */
     public function testGetFinalClassDeclaration(bool $finalClass, bool $finalEntity, bool $isEntity, string $expectedResult): void
     {
+        $this->markTestIncomplete('We wont need this...');
         $generator = new TemplateComponentGenerator($finalClass, $finalEntity);
 
         self::assertSame($expectedResult, $generator->getFinalDeclaration($isEntity));

tests/fixtures/make-voter/expected/FooBarVoter.php

@@ -6,7 +6,7 @@
 use Symfony\Component\Security\Core\Authorization\Voter\Voter;
 use Symfony\Component\Security\Core\User\UserInterface;
 
-class FooBarVoter extends Voter
+final class FooBarVoter extends Voter
 {
     public const EDIT = 'POST_EDIT';
     public const VIEW = 'POST_VIEW';

tests/fixtures/make-voter/expected/final_FooBarVoter.php renamed to tests/fixtures/make-voter/expected/not_final_FooBarVoter.php

@@ -6,7 +6,7 @@
 use Symfony\Component\Security\Core\Authorization\Voter\Voter;
 use Symfony\Component\Security\Core\User\UserInterface;
 
-final class FooBarVoter extends Voter
+class FooBarVoter extends Voter
 {
     public const EDIT = 'POST_EDIT';
     public const VIEW = 'POST_VIEW';