Merge branch 'main' into NonInteractive_formlogin

.github/workflows/ci-static-analysis.yaml

@@ -26,6 +26,8 @@ jobs:
             -
                 name: Install PHP
                 uses: "shivammathur/setup-php@v2"
+                with:
+                    php-version: 8.2
 
             -
                 name: Validate composer.json
@@ -58,6 +60,8 @@ jobs:
 
             -   name: Install PHP
                 uses: "shivammathur/setup-php@v2"
+                with:
+                    php-version: 8.2
 
             -   name: Install Composer Dependencies
                 uses: "ramsey/composer-install@v2"

.github/workflows/ci-windows.yaml

@@ -13,6 +13,7 @@ env:
     SYMFONY_PHPUNIT_DIR: "$HOME/symfony-bridge/.phpunit"
     MAKER_SKIP_MERCURE_TEST: 1
     MAKER_SKIP_PANTHER_TEST: 1
+    MAKER_TEST_WINDOWS: 1
     MAKER_DISABLE_FILE_LINKS: 1
     MAKER_ALLOW_DEV_DEPS_IN_APP: 0
     SYMFONY_VERSION: '7.0.x-dev'

.symfony.bundle.yaml

@@ -2,5 +2,5 @@ branches: ["main"]
 
 maintained_branches: ["main"]
 
-doc_dir: "src/Resources/doc"
+doc_dir: "docs"
 

_docs_build/build.php

@@ -30,7 +30,7 @@
         $outputDir = __DIR__.'/output';
         $buildConfig = (new BuildConfig())
             ->setSymfonyVersion('7.1')
-            ->setContentDir(__DIR__.'/../src/Resources/doc')
+            ->setContentDir(__DIR__.'/../docs')
             ->setOutputDir($outputDir)
             ->setImagesDir(__DIR__.'/output/_images')
             ->setImagesPublicPrefix('_images')

composer.json

@@ -16,6 +16,7 @@
         "php": ">=8.1",
         "doctrine/inflector": "^2.0",
         "nikic/php-parser": "^4.18|^5.0",
+        "php-cs-fixer/shim": "^v3.64",
         "symfony/config": "^6.4|^7.0",
         "symfony/console": "^6.4|^7.0",
         "symfony/dependency-injection": "^6.4|^7.0",

src/Resources/help/MakeDockerDatabase.txt → config/help/MakeDockerDatabase.txt

@@ -1,5 +1,5 @@
-The <info>%command.name%</info> command generates or updates databases services in compose.yaml
-
-<info>php %command.full_name%</info>
-
-Supports MySQL, MariaDB and PostgreSQL
+The <info>%command.name%</info> command generates or updates databases services in compose.yaml
+
+<info>php %command.full_name%</info>
+
+Supports MySQL, MariaDB and PostgreSQL

src/Resources/config/php-cs-fixer.config.php → config/php-cs-fixer.config.php

@@ -9,6 +9,14 @@
  * file that was distributed with this source code.
  */
 
+/*
+ * This PHP-CS-Fixer config file is used by the TemplateLinter for userland
+ * code when say make:controller is run. If a user does not have a php-cs-fixer
+ * config file, this one is used on the generated PHP files.
+ *
+ * It should not be confused by the root level .php-cs-fixer.dist.php config
+ * which is used to maintain the MakerBundle codebase itself.
+ */
 return (new PhpCsFixer\Config())
     ->setRules([
         '@Symfony' => true,

src/Resources/config/services.xml → config/services.xml

@@ -41,6 +41,7 @@
             </service>
 
             <service id="maker.template_linter" class="Symfony\Bundle\MakerBundle\Util\TemplateLinter">
+                <argument type="service" id="maker.file_manager" />
                 <argument>%env(default::string:MAKER_PHP_CS_FIXER_BINARY_PATH)%</argument>
                 <argument>%env(default::string:MAKER_PHP_CS_FIXER_CONFIG_PATH)%</argument>
             </service>

src/Resources/doc/index.rst → docs/index.rst

@@ -41,6 +41,9 @@ optional arguments and options. Check them out with the ``--help`` option:
 
     $ php bin/console make:controller --help
 
+.. caution::
+
+    ``make:entity`` requires ``doctrine/orm`` to be installed and configured. This maker support only ORM, not ODM.
 
 Linting Generated Code
 ______________________

phpunit.xml.dist

@@ -19,8 +19,12 @@
         <env name="SYMFONY_PHPUNIT_VERSION" value="9.6" />
         <env name="MAKER_SKIP_MERCURE_TEST" value="false"/>
         <env name="MAKER_SKIP_PANTHER_TEST" value="false" />
+        <env name="MAKER_TEST_WINDOWS" value="false" />
 <!--    Overrides process timeout when step debugging -->
 <!--    <env name="MAKER_PROCESS_TIMEOUT" value="null" /> -->
+<!--    Dump the CLI output for a test runner process immediately after running a test -->
+<!--    You should only set this to true when you need to debug the actual output of a maker command within a test -->
+<!--    <env name="MAKER_TEST_DUMP_OUTPUT" value="false" /> -->
     </php>
 
     <testsuites>

src/Generator.php

@@ -63,7 +63,7 @@ public function generateClass(string $className, string $templateName, array $va
         $targetPath = $this->fileManager->getRelativePathForFutureClass($className);
 
         if (null === $targetPath) {
-            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)));
+            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)));
         }
 
         $variables = array_merge($variables, [
@@ -81,27 +81,32 @@ public function generateClass(string $className, string $templateName, array $va
      *
      * @internal
      *
-     * @param string $templateName Template name in Resources/skeleton to use
+     * @param string $templateName Template name in the templates/ dir to use
      * @param array  $variables    Array of variables to pass to the template
+     * @param bool   $isController Set to true if generating a Controller that needs
+     *                             access to the TemplateComponentGenerator ("generator") in
+     *                             the twig template. e.g. to create route attributes for a route method
      *
      * @return string The path where the file will be created
      *
      * @throws \Exception
      */
-    final public function generateClassFromClassData(ClassData $classData, string $templateName, array $variables = []): string
+    final public function generateClassFromClassData(ClassData $classData, string $templateName, array $variables = [], bool $isController = false): string
     {
         $classData = $this->templateComponentGenerator->configureClass($classData);
         $targetPath = $this->fileManager->getRelativePathForFutureClass($classData->getFullClassName());
 
         if (null === $targetPath) {
-            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"', $classData->getFullClassName(), $classData->getClassName()));
+            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"', $classData->getFullClassName(), $classData->getClassName()));
         }
 
-        $variables = array_merge($variables, [
-            'class_data' => $classData,
-        ]);
+        $globalTemplateVars = ['class_data' => $classData];
 
-        $this->addOperation($targetPath, $templateName, $variables);
+        if ($isController) {
+            $globalTemplateVars['generator'] = $this->templateComponentGenerator;
+        }
+
+        $this->addOperation($targetPath, $templateName, array_merge($variables, $globalTemplateVars));
 
         return $targetPath;
     }
@@ -294,10 +299,14 @@ private function addOperation(string $targetPath, string $templateName, array $v
 
         $templatePath = $templateName;
         if (!file_exists($templatePath)) {
-            $templatePath = __DIR__.'/Resources/skeleton/'.$templateName;
+            $templatePath = \sprintf('%s/templates/%s', \dirname(__DIR__), $templateName);
 
             if (!file_exists($templatePath)) {
-                throw new \Exception(\sprintf('Cannot find template "%s"', $templateName));
+                $templatePath = $this->getTemplateFromLegacySkeletonPath($templateName);
+            }
+
+            if (!file_exists($templatePath)) {
+                throw new \Exception(\sprintf('Cannot find template "%s" in the templates/ dir.', $templateName));
             }
         }
 
@@ -306,4 +315,27 @@ private function addOperation(string $targetPath, string $templateName, array $v
             'variables' => $variables,
         ];
     }
+
+    /**
+     * @legacy - Remove when public generate methods become "internal" to MakerBundle in v2
+     */
+    private function getTemplateFromLegacySkeletonPath(string $templateName): string
+    {
+        $templatePath = $templateName;
+        if (!file_exists($templatePath)) {
+            $templatePath = __DIR__.'/Resources/skeleton/'.$templateName;
+
+            if (!file_exists($templatePath)) {
+                throw new \Exception(\sprintf('Cannot find template "%s"', $templateName));
+            }
+        }
+
+        @trigger_deprecation(
+            'symfony/maker-bundle',
+            '1.62.0',
+            'Storing templates in src/Resources/skeleton is deprecated. Store MakerBundle templates in the "~/templates/" dir instead.',
+        );
+
+        return $templatePath;
+    }
 }

src/Maker/AbstractMaker.php

@@ -55,4 +55,17 @@ protected function addDependencies(array $dependencies, ?string $message = null)
             $message
         );
     }
+
+    /**
+     * Get the help file contents needed for "setHelp()" of a maker.
+     *
+     * @param string $helpFileName the filename (omit path) of the help file located in config/help/
+     *                             e.g. MakeController.txt
+     *
+     * @internal
+     */
+    final protected function getHelpFileContents(string $helpFileName): string
+    {
+        return file_get_contents(\sprintf('%s/config/help/%s', \dirname(__DIR__, 2), $helpFileName));
+    }
 }

src/Maker/Common/CanGenerateTestsTrait.php

@@ -28,7 +28,7 @@ trait CanGenerateTestsTrait
 
     public function configureCommandWithTestsOption(Command $command): Command
     {
-        $testsHelp = file_get_contents(\dirname(__DIR__, 2).'/Resources/help/_WithTests.txt');
+        $testsHelp = file_get_contents(\dirname(__DIR__, 3).'/config/help/_WithTests.txt');
         $help = $command->getHelp()."\n".$testsHelp;
 
         $command

src/Maker/Common/UidTrait.php

@@ -34,7 +34,7 @@ trait UidTrait
      */
     protected function addWithUuidOption(Command $command): Command
     {
-        $uidHelp = file_get_contents(\dirname(__DIR__, 2).'/Resources/help/_WithUid.txt');
+        $uidHelp = file_get_contents(\dirname(__DIR__, 3).'/config/help/_WithUid.txt');
         $help = $command->getHelp()."\n".$uidHelp;
 
         $command

src/Maker/MakeAuthenticator.php

@@ -92,7 +92,8 @@ public static function getCommandDescription(): string
     public function configureCommand(Command $command, InputConfiguration $inputConfig): void
     {
         $command
-            ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeAuth.txt'));
+            ->setHelp($this->getHelpFileContents('MakeAuth.txt'))
+        ;
     }
 
     public function interact(InputInterface $input, ConsoleStyle $io, Command $command): void

src/Maker/MakeCommand.php

@@ -58,7 +58,7 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
     {
         $command
             ->addArgument('name', InputArgument::OPTIONAL, \sprintf('Choose a command name (e.g. <fg=yellow>app:%s</>)', Str::asCommand(Str::getRandomTerm())))
-            ->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeCommand.txt'))
+            ->setHelp($this->getHelpFileContents('MakeCommand.txt'))
         ;
     }