Merge pull request #93 from perplorm/console_fixes

Console fixes

Author: mringler

bin/perpl

@@ -0,0 +1,4 @@
+#!/usr/bin/env php
+<?php
+
+require(__DIR__ . '/perpl.php');

bin/perpl.bat

@@ -0,0 +1,9 @@
+@echo off
+
+if "%PHPBIN%" == "" set PHPBIN=php
+if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH
+GOTO RUN
+:USE_PEAR_PATH
+set PHPBIN=%PHP_PEAR_PHP_BIN%
+:RUN
+"%PHPBIN%" "bin\perpl" %*

bin/perpl.php

@@ -0,0 +1,37 @@
+<?php
+
+if (!class_exists(\Symfony\Component\Console\Application::class)) {
+    $autoloadFileCandidates = [
+        __DIR__ . '/../../../autoload.php',
+        __DIR__ . '/../autoload.php',
+        __DIR__ . '/../autoload.php.dist',
+    ];
+    foreach ($autoloadFileCandidates as $file) {
+        if (file_exists($file)) {
+            require_once $file;
+
+            break;
+        }
+    }
+}
+
+use Propel\Generator\Application;
+use Propel\Runtime\Propel;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Finder\Finder;
+
+$finder = new Finder();
+$finder->files()->name('*.php')->in(__DIR__ . '/../src/Propel/Generator/Command')->depth(0);
+
+$app = new Application('Perpl', Propel::VERSION);
+
+$ns = '\\Propel\\Generator\\Command\\';
+
+foreach ($finder as $file) {
+    $r = new \ReflectionClass($ns . $file->getBasename('.php'));
+    if ($r->isSubclassOf(Command::class) && !$r->isAbstract()) {
+        $app->addCommands([$r->newInstance()]); // Using addCommands for BC with Symfony <8.0
+    }
+}
+
+$app->run();

bin/propel.bat

@@ -6,4 +6,4 @@ GOTO RUN
 :USE_PEAR_PATH
 set PHPBIN=%PHP_PEAR_PHP_BIN%
 :RUN
-"%PHPBIN%" "bin\propel" %*
+"%PHPBIN%" "bin\perpl" %*

bin/propel.php

@@ -1,37 +1,3 @@
 <?php
 
-if (!class_exists(\Symfony\Component\Console\Application::class)) {
-    $autoloadFileCandidates = [
-        __DIR__ . '/../../../autoload.php',
-        __DIR__ . '/../autoload.php',
-        __DIR__ . '/../autoload.php.dist',
-    ];
-    foreach ($autoloadFileCandidates as $file) {
-        if (file_exists($file)) {
-            require_once $file;
-
-            break;
-        }
-    }
-}
-
-use Propel\Generator\Application;
-use Propel\Runtime\Propel;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Finder\Finder;
-
-$finder = new Finder();
-$finder->files()->name('*.php')->in(__DIR__ . '/../src/Propel/Generator/Command')->depth(0);
-
-$app = new Application('Propel', Propel::VERSION);
-
-$ns = '\\Propel\\Generator\\Command\\';
-
-foreach ($finder as $file) {
-    $r = new \ReflectionClass($ns . $file->getBasename('.php'));
-    if ($r->isSubclassOf(Command::class) && !$r->isAbstract()) {
-        $app->addCommands([$r->newInstance()]); // Using addCommands for BC with Symfony <8.0
-    }
-}
-
-$app->run();
+require(__DIR__ . '/perpl.php');

composer.json

@@ -59,6 +59,7 @@
         }
     },
     "bin": [
+        "bin/perpl",
         "bin/propel"
     ],
     "scripts": {

src/Propel/Common/Config/ConfigurationManager.php

@@ -25,11 +25,6 @@
  */
 class ConfigurationManager
 {
-    /**
-     * @var string
-     */
-    public const CONFIG_FILE_NAME = 'propel';
-
     /**
      * @var int
      */
@@ -72,6 +67,8 @@ public function __construct(?string $path = null, ?array $extraConf = [])
     }
 
     /**
+     * @deprecated Use aptly named {@see ConfigurationManager::getConfig()}
+     *
      * Return the whole configuration array
      *
      * @return array
@@ -82,6 +79,18 @@ public function get(): array
     }
 
     /**
+     * Return the whole configuration array
+     *
+     * @return array
+     */
+    public function getConfig(): array
+    {
+        return $this->config;
+    }
+
+    /**
+     * @deprecated Access config props (including full sections) through {@see static::getConfigProperty()}
+     *
      * Return a specific section of the configuration array.
      * It ca be useful to get, in example, only 'generator' values.
      *
@@ -106,28 +115,77 @@ public function getSection(string $section): ?array
      * is expressed by:
      * <code>'database.adapter.mysql.tableType</code>
      *
-     * @param string $name The name of property, expressed as a dot separated level hierarchy
+     * @psalm-return ($isRequired ? array|int|bool|string : array|scalar|null)
+     *
+     * @param string $path The name of property, expressed as a dot separated level hierarchy
+     * @param bool $isRequired
      *
+     * @throws \Propel\Common\Config\Exception\InvalidConfigurationException
      * @throws \Propel\Common\Config\Exception\InvalidArgumentException
      *
-     * @return mixed The configuration property
+     * @return array|string|int|bool|null The configuration property
      */
-    public function getConfigProperty(string $name)
+    public function getConfigProperty(string $path, bool $isRequired = false): array|int|bool|string|null
     {
-        if ($name === '') {
+        if ($path === '') {
             throw new InvalidArgumentException('Invalid empty configuration property name.');
         }
 
-        $keys = explode('.', $name);
-        $output = $this->get();
+        $keys = explode('.', $path);
+        $section = $this->getConfig();
         foreach ($keys as $key) {
-            if (!array_key_exists($key, $output)) {
-                return null;
+            if (array_key_exists($key, $section)) {
+                $section = $section[$key];
+
+                continue;
             }
-            $output = $output[$key];
+
+            if ($isRequired) {
+                throw new InvalidConfigurationException("Cannot resolve config property '$path': No value at '$key'");
+            }
+
+            return null;
         }
 
-        return $output;
+        if ($isRequired && ($section === null || $section === '')) {
+            throw new InvalidConfigurationException("Required config property '$path' cannot be empty, but is: " . var_export($section, true));
+        }
+
+        return $section;
+    }
+
+    /**
+     * Type-safe access of {@see static::getConfigProperty()}.
+     *
+     * @psalm-return ($isRequired ? string : string|null)
+     *
+     * @param string $path The name of property, expressed as a dot separated level hierarchy
+     * @param bool $isRequired
+     *
+     * @throws \Propel\Common\Config\Exception\InvalidConfigurationException
+     *
+     * @return string|null The configuration property
+     */
+    public function getConfigPropertyString(string $path, bool $isRequired = false): string|null
+    {
+        $val = $this->getConfigProperty($path, $isRequired);
+        if ($val === null || is_string($val)) {
+            return $val;
+        }
+
+        throw new InvalidConfigurationException("Configuration item `$path` is expected to contain a string, but is " . var_export($val, true));
+    }
+
+    /**
+     * Return a specific configuration property.
+     *
+     * @param string $path The name of property, expressed as a dot separated level hierarchy
+     *
+     * @return array|string|int|bool The configuration property
+     */
+    public function getConfigPropertyRequired(string $path): array|int|bool|string
+    {
+        return $this->getConfigProperty($path, true) ?? '';
     }
 
     /**
@@ -215,7 +273,7 @@ protected function process(array $extraConf = []): void
         try {
             $this->config = $processor->processConfiguration($configuration, $this->config);
         } catch (SymfonyInvalidConfigurationException $e) {
-            throw new InvalidConfigurationException('Could not process configuration. Please check the property in error message: ' . $e->getMessage());
+            throw new InvalidConfigurationException('Invalid configuration: ' . $e->getMessage());
         }
         $this->cleanupSlaveConnections();
         $this->cleanupConnections();
@@ -239,11 +297,16 @@ private function getConfigFileNamesFromDirectory(string $path): array
         ];
         $dirs = array_filter($dirs, 'is_dir');
 
-        $fileGlob = self::CONFIG_FILE_NAME . '.{php,inc,ini,properties,yaml,yml,xml,json}{,.dist}';
+        $fileGlob = 'p{rope,erp}l.{php,inc,ini,properties,yaml,yml,xml,json}{,.dist}';
         $finder = new Finder();
         $finder->in($dirs)->depth(0)->files()->name($fileGlob);
         $orderedConfigFileNames = [];
         foreach ($finder as $file) {
+            $realPath = $file->getRealPath();
+            $isExecutable = array_any(['propel', 'perpl'], fn ($cmd) => str_ends_with($realPath, "/bin/{$cmd}.php"));
+            if ($isExecutable) {
+                continue;
+            }
             $precedence = ($file->getExtension() === 'dist') ? self::PRECEDENCE_DIST : self::PRECEDENCE_NORMAL;
             if (isset($orderedConfigFileNames[$precedence])) {
                 $messageSplits = [

src/Propel/Generator/Application.php

@@ -23,9 +23,12 @@ class Application extends SymfonyApplication
     #[\Override]
     public function doRun(InputInterface $input, OutputInterface $output): int
     {
-        if (extension_loaded('xdebug')) {
+        $command = $input->getFirstArgument();
+        $xdebugNoWarn = in_array($command, ['completion', '_complete']);
+
+        if (!$xdebugNoWarn && extension_loaded('xdebug')) {
             $output->writeln(
-                '<comment>You are running propel with xdebug enabled. This has a major impact on runtime performance.</comment>' . "\n",
+                '<comment>You are running perpl with xdebug enabled. This has a major impact on runtime performance.</comment>' . "\n",
             );
         }
 

src/Propel/Generator/Behavior/Archivable/ArchivableBehaviorObjectBuilderModifier.php

@@ -127,7 +127,7 @@ public function preDelete(AbstractOMBuilder $builder): ?string
         if ($this->behavior->isArchiveOnDelete()) {
             return $this->behavior->renderTemplate('objectPreDelete', [
                 'queryClassName' => $builder->getQueryClassName(),
-                'isAddHooks' => $builder->getGeneratorConfig()->get()['generator']['objectModel']['addHooks'],
+                'isAddHooks' => (bool)$builder->getGeneratorConfig()->getConfigProperty('generator.objectModel.addHooks'),
             ]);
         }
 

src/Propel/Generator/Builder/DataModelBuilder.php

@@ -176,16 +176,26 @@ public function getTable(): Table
      * <code>'database.adapter.mysql.tableType</code>
      *
      * @param string $name
+     * @param bool $isRequired
      *
-     * @return string|null
+     * @return array|scalar|null
      */
-    public function getBuildProperty(string $name): ?string
+    public function getBuildProperty(string $name, bool $isRequired = false): mixed
     {
-        if ($this->getGeneratorConfig()) {
-            return $this->getGeneratorConfig()->getConfigProperty($name);
-        }
+        return $this->getGeneratorConfig()?->getConfigProperty($name, $isRequired);
+    }
 
-        return null;
+    /**
+     * @psalm-return ($isRequired ? string : string|null)
+     *
+     * @param string $name
+     * @param bool $isRequired
+     *
+     * @return string|null
+     */
+    public function getBuildPropertyString(string $name, bool $isRequired = false): string|null
+    {
+        return $this->getGeneratorConfig()->getConfigPropertyString($name, $isRequired);
     }
 
     /**
@@ -325,7 +335,7 @@ public function quoteIdentifier(string $text): string
      */
     public function prefixClassName(string $identifier): string
     {
-        return $this->getBuildProperty('generator.objectModel.classPrefix') . $identifier;
+        return $this->getBuildPropertyString('generator.objectModel.classPrefix', true) . $identifier;
     }
 
     /**
@@ -707,6 +717,6 @@ public function resolveColumnDateTimeClass(Column $column): string
             return $column->getPhpType();
         }
 
-        return $this->getBuildProperty('generator.dateTime.dateTimeClass') ?: '\DateTime';
+        return $this->getBuildPropertyString('generator.dateTime.dateTimeClass') ?: '\DateTime';
     }
 }