introduce a final class config param

Author: jrushlow

src/DependencyInjection/Configuration.php

@@ -24,6 +24,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $rootNode
             ->children()
                 ->scalarNode('root_namespace')->defaultValue('App')->end()
+                ->booleanNode('use_final_classes')->defaultFalse()->end()
             ->end()
         ;
 

src/DependencyInjection/MakerExtension.php

@@ -45,6 +45,9 @@ public function load(array $configs, ContainerBuilder $container): void
         $doctrineHelperDefinition = $container->getDefinition('maker.doctrine_helper');
         $doctrineHelperDefinition->replaceArgument(0, $rootNamespace.'\\Entity');
 
+        $componentGeneratorDefinition = $container->getDefinition('maker.template_component_generator');
+        $componentGeneratorDefinition->replaceArgument(0, $config['use_final_classes']);
+
         $container->registerForAutoconfiguration(MakerInterface::class)
             ->addTag(MakeCommandRegistrationPass::MAKER_TAG);
     }

src/Generator.php

@@ -63,6 +63,7 @@ public function generateClass(string $className, string $templateName, array $va
         $variables = array_merge($variables, [
             'class_name' => Str::getShortClassName($className),
             'namespace' => Str::getNamespace($className),
+            'final_class' => $this->templateComponentGenerator->getFinalDeclaration(),
         ]);
 
         $this->addOperation($targetPath, $templateName, $variables);

src/Resources/config/services.xml

@@ -80,6 +80,7 @@
             </service>
 
             <service id="maker.template_component_generator" class="Symfony\Bundle\MakerBundle\Util\TemplateComponentGenerator">
+               <argument /> <!-- use_final_classes -->
             </service>
         </services>
 </container>

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_name ?> extends Voter
+<?= $final_class ?>class <?= $class_name ?> extends Voter
 {
     public const EDIT = 'POST_EDIT';
     public const VIEW = 'POST_VIEW';

src/Util/TemplateComponentGenerator.php

@@ -18,6 +18,11 @@
  */
 final class TemplateComponentGenerator
 {
+    public function __construct(
+        private bool $generateFinalClasses,
+    ) {
+    }
+
     public function generateRouteForControllerMethod(string $routePath, string $routeName, array $methods = [], bool $indent = true, bool $trailingNewLine = true): string
     {
         $attribute = sprintf('%s#[Route(\'%s\', name: \'%s\'', $indent ? '    ' : null, $routePath, $routeName);
@@ -43,4 +48,9 @@ public function getPropertyType(ClassNameDetails $classNameDetails): ?string
     {
         return sprintf('%s ', $classNameDetails->getShortName());
     }
+
+    public function getFinalDeclaration(): string
+    {
+        return $this->generateFinalClasses ? 'final ' : '';
+    }
 }

tests/Maker/MakeVoterTest.php

@@ -14,6 +14,7 @@
 use Symfony\Bundle\MakerBundle\Maker\MakeVoter;
 use Symfony\Bundle\MakerBundle\Test\MakerTestCase;
 use Symfony\Bundle\MakerBundle\Test\MakerTestRunner;
+use Symfony\Component\Yaml\Yaml;
 
 class MakeVoterTest extends MakerTestCase
 {
@@ -32,6 +33,32 @@ public function getTestDetails(): \Generator
                         'FooBar',
                     ]
                 );
+
+                $expectedVoterPath = dirname(__DIR__).'/fixtures/make-voter/expected/FooBarVoter.php';
+                $generatedVoter = $runner->getPath('src/Security/Voter/FooBarVoter.php');
+
+                self::assertSame(file_get_contents($expectedVoterPath), file_get_contents($generatedVoter));
+            }),
+        ];
+
+        yield 'it_makes_voter_final' => [$this->createMakerTest()
+            ->run(function (MakerTestRunner $runner) {
+                $runner->writeFile(
+                    'config/packages/dev/maker.yaml',
+                    Yaml::dump(['maker' => ['use_final_classes' => true]])
+                );
+
+                $runner->runMaker(
+                    [
+                        // voter class name
+                        'FooBar',
+                    ]
+                );
+
+                $expectedVoterPath = dirname(__DIR__).'/fixtures/make-voter/expected/final_FooBarVoter.php';
+                $generatedVoter = $runner->getPath('src/Security/Voter/FooBarVoter.php');
+
+                self::assertSame(file_get_contents($expectedVoterPath), file_get_contents($generatedVoter));
             }),
         ];
     }

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

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Security\Voter;
+
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Authorization\Voter\Voter;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+class FooBarVoter extends Voter
+{
+    public const EDIT = 'POST_EDIT';
+    public const VIEW = 'POST_VIEW';
+
+    protected function supports(string $attribute, mixed $subject): bool
+    {
+        // replace with your own logic
+        // https://symfony.com/doc/current/security/voters.html
+        return in_array($attribute, [self::EDIT, self::VIEW])
+            && $subject instanceof \App\Entity\FooBar;
+    }
+
+    protected function voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token): bool
+    {
+        $user = $token->getUser();
+
+        // if the user is anonymous, do not grant access
+        if (!$user instanceof UserInterface) {
+            return false;
+        }
+
+        // ... (check conditions and return true to grant permission) ...
+        switch ($attribute) {
+            case self::EDIT:
+                // logic to determine if the user can EDIT
+                // return true or false
+                break;
+
+            case self::VIEW:
+                // logic to determine if the user can VIEW
+                // return true or false
+                break;
+        }
+
+        return false;
+    }
+}

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

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Security\Voter;
+
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Authorization\Voter\Voter;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+final class FooBarVoter extends Voter
+{
+    public const EDIT = 'POST_EDIT';
+    public const VIEW = 'POST_VIEW';
+
+    protected function supports(string $attribute, mixed $subject): bool
+    {
+        // replace with your own logic
+        // https://symfony.com/doc/current/security/voters.html
+        return in_array($attribute, [self::EDIT, self::VIEW])
+            && $subject instanceof \App\Entity\FooBar;
+    }
+
+    protected function voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token): bool
+    {
+        $user = $token->getUser();
+
+        // if the user is anonymous, do not grant access
+        if (!$user instanceof UserInterface) {
+            return false;
+        }
+
+        // ... (check conditions and return true to grant permission) ...
+        switch ($attribute) {
+            case self::EDIT:
+                // logic to determine if the user can EDIT
+                // return true or false
+                break;
+
+            case self::VIEW:
+                // logic to determine if the user can VIEW
+                // return true or false
+                break;
+        }
+
+        return false;
+    }
+}