Move templates into own root level. (propelorm#1848)

* Move templates into own root level.

* Clean up excludePaths

phpcs.xml

@@ -12,8 +12,6 @@
 
     <file>src/</file>
 
-    <exclude-pattern>*/templates/*</exclude-pattern>
-
     <rule ref="Spryker"/>
 
     <rule ref="vendor/spryker/code-sniffer/SprykerStrict/ruleset.xml">

phpstan.neon

@@ -7,17 +7,6 @@ parameters:
     reportUnmatchedIgnoredErrors: false
     paths:
         - '%rootDir%/../../../src/'
-    excludePaths:
-        - '%rootDir%/../../../src/Propel/Generator/Command/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/AggregateColumn/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/AggregateMultipleColumns/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/I18n/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Builder/Om/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/Validate/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/Archivable/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/Delegate/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/Sortable/templates/*'
-        - '%rootDir%/../../../src/Propel/Generator/Behavior/NestedSet/templates/*'
     ignoreErrors:
         - '#Call to an undefined method .+Collection::.+Array\(\)#'
         -

psalm.xml

@@ -11,9 +11,6 @@
 >
     <projectFiles>
         <directory name="src/Propel/"/>
-        <ignoreFiles>
-            <directory name="src/Propel/Generator/Command/templates/" />
-        </ignoreFiles>
     </projectFiles>
 
     <issueHandlers>

src/Propel/Common/Util/PathTrait.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * MIT License. This file is part of the Propel package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Propel\Common\Util;
+
+use RuntimeException;
+
+trait PathTrait
+{
+    /**
+     * Template paths are by convention in
+     * - templates/
+     * - besides src/ folder (which is required to detect root path)
+     *
+     * Note:
+     * - Propel/Generator/ prefix is removed from the path
+     *
+     * Examples:
+     * - Behavior/BehaviorName/
+     * - Builder/Om/
+     * - Command/
+     * - Manager/
+     *
+     * @param string $path
+     *
+     * @throws \RuntimeException
+     *
+     * @return string
+     */
+    protected function getTemplatePath(string $path): string
+    {
+        $srcPos = strpos($path, DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR);
+        if ($srcPos === false) {
+            throw new RuntimeException('Cannot find root of repository. Please manually set a template path to file.');
+        }
+
+        $root = substr($path, 0, $srcPos) . DIRECTORY_SEPARATOR;
+
+        $pathElements = explode(DIRECTORY_SEPARATOR, $path);
+        $pathElements = array_reverse($pathElements);
+
+        $elements = [];
+        foreach ($pathElements as $element) {
+            if ($element === 'src') {
+                break;
+            }
+
+            $elements[] = $element;
+        }
+
+        $elements = array_reverse($elements);
+        // Propel/Generator/ prefixes are just noise and filtered out
+        if ($elements[0] === 'Propel') {
+            array_shift($elements);
+        }
+        if ($elements[0] === 'Generator') {
+            array_shift($elements);
+        }
+
+        return $root . 'templates' . DIRECTORY_SEPARATOR . implode(DIRECTORY_SEPARATOR, $elements) . DIRECTORY_SEPARATOR;
+    }
+}

src/Propel/Generator/Builder/Om/AbstractOMBuilder.php

@@ -8,6 +8,7 @@
 
 namespace Propel\Generator\Builder\Om;
 
+use Propel\Common\Util\PathTrait;
 use Propel\Generator\Builder\DataModelBuilder;
 use Propel\Generator\Builder\Util\PropelTemplate;
 use Propel\Generator\Exception\InvalidArgumentException;
@@ -29,6 +30,8 @@
  */
 abstract class AbstractOMBuilder extends DataModelBuilder
 {
+    use PathTrait;
+
     /**
      * Declared fully qualified classnames, to build the 'namespace' statements
      * according to this table's namespace.
@@ -1054,20 +1057,24 @@ public function getBehaviorContentBase(string $contentName, string $modifier): ?
      *
      * @param string $filename
      * @param array $vars
-     * @param string $templateDir
+     * @param string|null $templatePath
      *
      * @throws \Propel\Generator\Exception\InvalidArgumentException
      *
      * @return string
      */
-    public function renderTemplate(string $filename, array $vars = [], string $templateDir = '/templates/'): string
+    public function renderTemplate(string $filename, array $vars = [], ?string $templatePath = null): string
     {
-        $filePath = __DIR__ . $templateDir . $filename;
+        if ($templatePath === null) {
+            $templatePath = $this->getTemplatePath(__DIR__);
+        }
+
+        $filePath = $templatePath . $filename;
         if (!file_exists($filePath)) {
             // try with '.php' at the end
             $filePath = $filePath . '.php';
             if (!file_exists($filePath)) {
-                throw new InvalidArgumentException(sprintf('Template "%s" not found in "%s" directory', $filename, __DIR__ . $templateDir));
+                throw new InvalidArgumentException(sprintf('Template `%s` not found in `%s` directory', $filename, $templatePath));
             }
         }
         $template = new PropelTemplate();

src/Propel/Generator/Builder/Om/TableMapLoaderScriptBuilder.php

@@ -8,6 +8,7 @@
 
 namespace Propel\Generator\Builder\Om;
 
+use Propel\Common\Util\PathTrait;
 use Propel\Generator\Builder\Util\PropelTemplate;
 use Propel\Generator\Config\GeneratorConfigInterface;
 use Propel\Generator\Model\Table;
@@ -18,6 +19,8 @@
  */
 class TableMapLoaderScriptBuilder
 {
+    use PathTrait;
+
     /**
      * @var string
      */
@@ -95,7 +98,9 @@ protected function getFullyQualifiedTableMapClassName(Table $table): string
      */
     protected function renderTemplate(array $vars): string
     {
-        $filePath = implode(DIRECTORY_SEPARATOR, [__DIR__, 'templates', 'tableMapLoaderScript.php']);
+        $templatePath = $this->getTemplatePath(__DIR__);
+
+        $filePath = $templatePath . 'tableMapLoaderScript.php';
         $template = new PropelTemplate();
         $template->setTemplateFile($filePath);
 

src/Propel/Generator/Command/InitCommand.php

@@ -13,6 +13,7 @@
 use Propel\Runtime\Adapter\AdapterFactory;
 use Propel\Runtime\Connection\ConnectionFactory;
 use Propel\Runtime\Connection\Exception\ConnectionException;
+use RuntimeException;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -269,18 +270,25 @@ private function initDsn(ConsoleHelper $consoleHelper, string $rdbms)
      * @param \Symfony\Component\Console\Output\OutputInterface $output
      * @param array<string, mixed> $options
      *
+     * @throws \RuntimeException
+     *
      * @return void
      */
     private function generateProject(OutputInterface $output, array $options): void
     {
+        $templatesPath = dirname(__FILE__, 5) . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR;
+        if (!is_dir($templatesPath)) {
+            throw new RuntimeException(sprintf('Cannot find templates path `%s`', $templatesPath));
+        }
+
         $schema = new PropelTemplate();
-        $schema->setTemplateFile(__DIR__ . '/templates/schema.xml.php');
+        $schema->setTemplateFile($templatesPath . 'Command/schema.xml.php');
 
         $config = new PropelTemplate();
-        $config->setTemplateFile(__DIR__ . '/templates/propel.' . $options['format'] . '.php');
+        $config->setTemplateFile($templatesPath . 'Command/propel.' . $options['format'] . '.php');
 
         $distConfig = new PropelTemplate();
-        $distConfig->setTemplateFile(__DIR__ . '/templates/propel.' . $options['format'] . '.dist.php');
+        $distConfig->setTemplateFile($templatesPath . 'Command/propel.' . $options['format'] . '.dist.php');
 
         if (!isset($options['schema'])) {
             $options['schema'] = $schema->render($options);

src/Propel/Generator/Manager/MigrationManager.php

@@ -11,6 +11,7 @@
 use Exception;
 use PDO;
 use PDOException;
+use Propel\Common\Util\PathTrait;
 use Propel\Generator\Builder\Util\PropelTemplate;
 use Propel\Generator\Exception\InvalidArgumentException;
 use Propel\Generator\Model\Column;
@@ -29,6 +30,8 @@
  */
 class MigrationManager extends AbstractManager
 {
+    use PathTrait;
+
     /**
      * @var array
      */
@@ -422,8 +425,10 @@ public function getMigrationClassBody(array $migrationsUp, array $migrationsDown
             'connectionToVariableName' => $connectionToVariableName,
         ];
 
+        $templatePath = $this->getTemplatePath(__DIR__);
+
         $template = new PropelTemplate();
-        $filePath = implode(DIRECTORY_SEPARATOR, [__DIR__, 'templates', 'migration_template.php']);
+        $filePath = $templatePath . 'migration_template.php';
         $template->setTemplateFile($filePath);
 
         return $template->render($vars);
@@ -435,7 +440,7 @@ public function getMigrationClassBody(array $migrationsUp, array $migrationsDown
      * @param array $migrationsUp
      * @param array $migrationsDown
      *
-     * @return array
+     * @return array<string, string>
      */
     protected static function buildConnectionToVariableNameMap(array $migrationsUp, array $migrationsDown): array
     {

src/Propel/Generator/Model/Behavior.php

@@ -9,6 +9,7 @@
 namespace Propel\Generator\Model;
 
 use InvalidArgumentException;
+use Propel\Common\Util\PathTrait;
 use Propel\Generator\Builder\Util\PropelTemplate;
 use Propel\Generator\Exception\LogicException;
 use ReflectionObject;
@@ -21,6 +22,8 @@
  */
 class Behavior extends MappingModel
 {
+    use PathTrait;
+
     /**
      * The table object on which the behavior is applied.
      *
@@ -345,23 +348,27 @@ public function isTableModified(): bool
      *
      * @param string $filename
      * @param array $vars
-     * @param string $templateDir
+     * @param string|null $templatePath
      *
      * @throws \InvalidArgumentException
      *
      * @return string
      */
-    public function renderTemplate(string $filename, array $vars = [], string $templateDir = '/templates/'): string
+    public function renderTemplate(string $filename, array $vars = [], ?string $templatePath = null): string
     {
-        $filePath = $this->getDirname() . $templateDir . $filename;
+        if ($templatePath === null) {
+            $templatePath = $this->getTemplatePath($this->getDirname());
+        }
+
+        $filePath = $templatePath . $filename;
         if (!file_exists($filePath)) {
             // try with '.php' at the end
             $filePath = $filePath . '.php';
             if (!file_exists($filePath)) {
                 throw new InvalidArgumentException(sprintf(
-                    'Template "%s" not found in "%s" directory',
+                    'Template `%s` not found in `%s` directory',
                     $filename,
-                    $this->getDirname() . $templateDir,
+                    $templatePath,
                 ));
             }
         }