Merge pull request #124 from mringler/test_comparators

Build test reference files from attribute

Author: mringler

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

@@ -615,7 +615,7 @@ public function getUuidSwapFlagLiteral(): string
      */
     protected function generateTimestampBlock(): string
     {
-        if ($this->getBuildProperty('generator.objectModel.addTimeStamp')) {
+        if (!$this->getBuildProperty('generator.objectModel.addTimeStamp')) {
             return '';
         }
         $now = gmdate('c');

src/Propel/Generator/Builder/Om/ObjectBuilder/ColumnTypes/ColumnCodeProducer.php

@@ -160,7 +160,7 @@ public function getApplyDefaultValueStatement(): string
         $defaultValue = $this->getDefaultValueString();
         if ($this->column->isPhpObjectType()) {
             $assumedClassName = $this->declareClass($this->column->getPhpType());
-            $defaultValue = "new $assumedClassName($defaultValue )";
+            $defaultValue = "new $assumedClassName($defaultValue)";
         }
 
         return "

src/Propel/Generator/Builder/Om/ObjectBuilder/RelationCodeProducer/FkRelationCodeProducer.php

@@ -258,8 +258,7 @@ public function get{$relationIdentifierSingular}(?ConnectionInterface \$con = nu
         }
 
         return \$this->$varName;
-    }
-";
+    }\n";
     }
 
     /**

src/Propel/Generator/Builder/Om/ObjectBuilder/RelationCodeProducer/ManyToManyRelationCodeProducer.php

@@ -179,8 +179,7 @@ public function get{$targetIdentifierPlural}(?Criteria \$criteria = null, ?Conne
         }
 
         return \$this->$attributeName;
-    }
-";
+    }\n";
     }
 
     /**
@@ -308,7 +307,6 @@ protected function doAdd{$targetIdentifierSingular}($parameterDeclaration): void
         } elseif (!{$targetObject}->get{$ownIdentifierPlural}($targetGetterParameters)->contains(\$this)) {
             {$targetObject}->get{$ownIdentifierPlural}($targetGetterParameters)->push(\$this);
         }
-    }
-";
+    }\n";
     }
 }

src/Propel/Generator/Builder/Util/SchemaReader.php

@@ -4,6 +4,7 @@
 
 namespace Propel\Generator\Builder\Util;
 
+use Exception;
 use Propel\Generator\Config\AbstractGeneratorConfig;
 use Propel\Generator\Exception\SchemaException;
 use Propel\Generator\Model\Index;
@@ -24,7 +25,6 @@
 use function strpos;
 use function strtolower;
 use function version_compare;
-use function vsprintf;
 use function xml_error_string;
 use function xml_get_current_column_number;
 use function xml_get_current_line_number;
@@ -54,7 +54,7 @@ class SchemaReader
     private $schema;
 
     /**
-     * @var \XMLParser|resource
+     * @var \XMLParser
      */
     private $parser;
 
@@ -201,14 +201,13 @@ public function parseString(string $xmlString, ?string $xmlFile = null): ?Schema
         $this->parser = xml_parser_create();
         xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
         xml_set_element_handler($this->parser, [$this, 'startElement'], [$this, 'endElement']);
-        if (!xml_parse($this->parser, $xmlString)) {
-            throw new SchemaException(
-                sprintf(
-                    'XML error: %s at line %d',
-                    xml_error_string(xml_get_error_code($this->parser)),
-                    xml_get_current_line_number($this->parser),
-                ),
-            );
+        try {
+            $success = xml_parse($this->parser, $xmlString);
+        } catch (Exception $e) {
+            throw new SchemaException('XML parser failed at ' . $this->getLocationDescription() . ': ' . $e->getMessage(), 0, $e);
+        }
+        if (!$success) {
+            $this->throwParserError();
         }
         if (version_compare(phpversion(), '8.1', '<')) {
             xml_parser_free($this->parser);
@@ -221,7 +220,7 @@ public function parseString(string $xmlString, ?string $xmlFile = null): ?Schema
     }
 
     /**
-     * @param resource $parser
+     * @param \XMLParser $parser
      * @param string $tagName
      * @param array $attributes
      *
@@ -236,10 +235,7 @@ public function startElement($parser, string $tagName, array $attributes): void
             switch ($tagName) {
                 case 'database':
                     if ($this->isExternalSchema()) {
-                        $this->currentPackage = $attributes['package'] ?? null;
-                        if ($this->currentPackage === null) {
-                            $this->currentPackage = $this->defaultPackage;
-                        }
+                        $this->currentPackage = $attributes['package'] ?? $this->defaultPackage;
                     } else {
                         $this->currDB = $this->schema->addDatabase($attributes);
                     }
@@ -441,28 +437,27 @@ public function startElement($parser, string $tagName, array $attributes): void
     /**
      * @param string $tagName
      *
+     * @throws \Propel\Generator\Exception\SchemaException
+     *
      * @return void
      */
     protected function throwInvalidTagException(string $tagName): void
     {
-        $this->throwSchemaExceptionWithLocation('Unexpected tag <%s>', $tagName);
+        throw new SchemaException("Unexpected tag $tagName");
     }
 
     /**
-     * @param string $format
-     * @param mixed $args sprintf arguments
-     *
      * @throws \Propel\Generator\Exception\SchemaException
      *
      * @return void
      */
-    private function throwSchemaExceptionWithLocation(string $format, ...$args): void
+    protected function throwParserError(): void
     {
-        $format .= ' in %s';
-        $args[] = $this->getLocationDescription();
-        $message = vsprintf($format, $args);
+        $errorCode = xml_get_error_code($this->parser);
+        $errorMessage = xml_error_string($errorCode);
+        $location = $this->getLocationDescription();
 
-        throw new SchemaException($message);
+        throw new SchemaException("XML error: $errorMessage at $location");
     }
 
     /**
@@ -612,6 +607,8 @@ private function addAttributeToParameterListItem(array $attributes): void
     /**
      * Feeds the current parameter list to its parent and clears the collector.
      *
+     * @throws \Propel\Generator\Exception\SchemaException
+     *
      * @return void
      */
     private function finalizeParameterList(): void
@@ -620,7 +617,7 @@ private function finalizeParameterList(): void
         if ($parentTag === 'behavior') {
             $this->currBehavior->addParameter($this->currParameterListCollector);
         } else {
-            $this->throwSchemaExceptionWithLocation('Cannot add parameter list to tag <%s>', $parentTag);
+            throw new SchemaException("Cannot add parameter list to tag `$parentTag`");
         }
 
         $this->currParameterListCollector = null;
@@ -632,12 +629,14 @@ private function finalizeParameterList(): void
      * @param array $attributes
      * @param string $key
      *
+     * @throws \Propel\Generator\Exception\SchemaException
+     *
      * @return string the non-empty value
      */
     private function getExpectedValue(array $attributes, string $key): string
     {
         if (empty($attributes[$key])) {
-            $this->throwSchemaExceptionWithLocation('Parameter misses expected attribute "%s"', $key);
+            throw new SchemaException("Parameter misses expected attribute `$key`");
         }
 
         return $attributes[$key];

src/Propel/Generator/Command/AbstractCommand.php

@@ -101,7 +101,7 @@ protected function buildGeneratorConfig(?array $properties = null, ?InputInterfa
 
         $configDir = $input->getOption('config-dir');
         try {
-            return new GeneratorConfig($configDir, extraConf: $properties);
+            return new GeneratorConfig($configDir, $properties);
         } catch (InvalidConfigurationException $e) {
             $userMessage = $this->getInvalidConfigurationExceptionUserMessage($e->getMessage(), $configDir);
 

src/Propel/Generator/Config/QuickGeneratorConfig.php

@@ -4,6 +4,7 @@
 
 namespace Propel\Generator\Config;
 
+use Propel\Common\Config\ConfigurationManager;
 use Propel\Common\Pluralizer\PluralizerInterface;
 use Propel\Common\Pluralizer\StandardEnglishPluralizer;
 use Propel\Generator\Platform\PlatformInterface;
@@ -18,9 +19,7 @@ class QuickGeneratorConfig extends AbstractGeneratorConfig
      */
     public function __construct(?array $extraConf = [])
     {
-        if ($extraConf === null) {
-            $extraConf = [];
-        }
+        $extraConf = $extraConf === null ? [] : ConfigurationManager::deflateConfigurationArray($extraConf);
 
         //Creates a GeneratorConfig based on Propel default values plus the following
         $configs = [

src/Propel/Generator/Manager/ModelManager.php

@@ -92,7 +92,7 @@ public function build(): void
 
                     // If table has enumerated children (uses inheritance) then create the empty child stub classes if they don't already exist.
                     $col = $table->getChildrenColumn();
-                    if ($col && $col->isEnumeratedClasses()) {
+                    if ($col?->isEnumeratedClasses()) {
                         foreach ($col->getChildren() as $child) {
                             foreach ([BuilderType::QueryInheritance] as $target) {
                                 if (!$child->getAncestor() && $child->getClassName() === $table->getPhpName()) {

src/Propel/Generator/Model/Database.php

@@ -7,6 +7,7 @@
 use Propel\Generator\Config\AbstractGeneratorConfig;
 use Propel\Generator\Exception\EngineException;
 use Propel\Generator\Exception\InvalidArgumentException;
+use Propel\Generator\Exception\SchemaException;
 use Propel\Generator\Platform\PlatformInterface;
 use function array_search;
 use function count;
@@ -572,12 +573,16 @@ public function removeTable(Table $table): void
      * @param \Propel\Generator\Model\Table|array $table
      *
      * @throws \Propel\Generator\Exception\EngineException
+     * @throws \Propel\Generator\Exception\SchemaException
      *
      * @return \Propel\Generator\Model\Table
      */
     public function addTable($table): Table
     {
         if (!$table instanceof Table) {
+            if (empty($table['name'])) {
+                throw new SchemaException('Table misses required attribute `name`');
+            }
             $tbl = new Table($table['name']);
             $tbl->setDatabase($this);
             $tbl->loadMapping($table);

src/Propel/Generator/Model/Table.php

@@ -31,6 +31,7 @@
 use function strtolower;
 use function strtoupper;
 use function substr_replace;
+use function var_export;
 
 /**
  * Data about a table used in an application.
@@ -562,12 +563,16 @@ public function setBaseQueryClass(string $class): void
      * @param \Propel\Generator\Model\Column|array $col
      *
      * @throws \Propel\Generator\Exception\EngineException
+     * @throws \Propel\Generator\Exception\SchemaException
      *
      * @return \Propel\Generator\Model\Column
      */
     public function addColumn($col): Column
     {
         if (is_array($col)) {
+            if (empty($col['name'])) {
+                throw new SchemaException("Column on table `{$this->commonName}` misses required attribute `name` Attributes:" . var_export($col, true));
+            }
             $column = new Column($col['name']);
             $column->setTable($this);
             $column->loadMapping($col);