Merge pull request #1023 from cakephp/3.next-merge

merge 3.x => 3.next

.phive/phars.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="1.11.9" installed="1.11.9" location="./tools/phpstan" copy="false"/>
-  <phar name="psalm" version="5.25.0" installed="5.25.0" location="./tools/psalm" copy="false"/>
+  <phar name="phpstan" version="2.0.1" installed="2.0.1" location="./tools/phpstan" copy="false"/>
+  <phar name="psalm" version="5.26.1" installed="5.26.1" location="./tools/psalm" copy="false"/>
 </phive>

composer.json

@@ -22,7 +22,7 @@
     "require": {
         "php": ">=8.1",
         "brick/varexporter": "^0.5.0",
-        "cakephp/cakephp": "dev-5.next as 5.1.0",
+        "cakephp/cakephp": "^5.1",
         "cakephp/twig-view": "^2.0.0",
         "nikic/php-parser": "^5.0.0"
     },

docs/en/development.rst

@@ -129,7 +129,7 @@ looks like this::
         /**
         * Hook method for defining this command's option parser.
         *
-        * @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options
+        * @see https://book.cakephp.org/5/en/console-commands/commands.html#defining-arguments-and-options
         * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
         * @return \Cake\Console\ConsoleOptionParser The built parser.
         */
@@ -172,7 +172,7 @@ And the resultant baked class (**src/Command/FooCommand.php**) looks like this::
         /**
         * Hook method for defining this command's option parser.
         *
-        * @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options
+        * @see https://book.cakephp.org/5/en/console-commands/commands.html#defining-arguments-and-options
         * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
         * @return \Cake\Console\ConsoleOptionParser The built parser.
         */

docs/en/usage.rst

@@ -52,6 +52,18 @@ You can get the list of available bake command by running ``bin/cake bake --help
     To run a command, type `cake command_name [args|options]`
     To get help on a specific command, type `cake command_name --help`
 
+Bake Models
+===========
+
+Models are generically baked from the existing DB tables.
+The conventions here apply, so it will detect relations based on ``thing_id`` foreign keys to ``things`` tables with their ``id`` primary keys.
+
+For non-conventional relations, you can use references in the constraints / foreign key definitions for Bake to detect the relations, e.g.::
+
+    ->addForeignKey('billing_country_id', 'countries') // defaults to `id`
+    ->addForeignKey('shipping_country_id', 'countries', 'cid')
+
+
 Bake Themes
 ===========
 

docs/fr/development.rst

@@ -137,7 +137,7 @@ ressemble à ceci::
         /**
         * Méthode hook pour définir le parseur d'option de cette commande.
         *
-        * @see https://book.cakephp.org/4/fr/console-commands/commands.html#defining-arguments-and-options
+        * @see https://book.cakephp.org/5/fr/console-commands/commands.html#defining-arguments-and-options
         * @param \Cake\Console\ConsoleOptionParser $parser Le parseur à définir
         * @return \Cake\Console\ConsoleOptionParser Le parseur construit.
         */
@@ -181,7 +181,7 @@ ressemble à ceci::
         /**
         * Méthode hook pour définir le parseur d'option de cette commande.
         *
-        * @see https://book.cakephp.org/4/fr/console-commands/commands.html#defining-arguments-and-options
+        * @see https://book.cakephp.org/5/fr/console-commands/commands.html#defining-arguments-and-options
         * @param \Cake\Console\ConsoleOptionParser $parser Le parseur à définir
         * @return \Cake\Console\ConsoleOptionParser Le parseur construit.
         */

phpstan-baseline.neon

@@ -1,11 +1,19 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Instanceof between mixed and Cake\\\\Chronos\\\\Chronos will always evaluate to false\\.$#"
+			message: '#^Method Bake\\BakePlugin\:\:bootstrap\(\) has parameter \$app with generic interface Cake\\Core\\PluginApplicationInterface but does not specify its types\: TSubject$#'
+			identifier: missingType.generics
+			count: 1
+			path: src/BakePlugin.php
+
+		-
+			message: '#^Instanceof between mixed and Cake\\Chronos\\Chronos will always evaluate to false\.$#'
+			identifier: instanceof.alwaysFalse
 			count: 1
 			path: src/Command/FixtureCommand.php
 
 		-
-			message: "#^Dead catch \\- UnexpectedValueException is never thrown in the try block\\.$#"
+			message: '#^Dead catch \- UnexpectedValueException is never thrown in the try block\.$#'
+			identifier: catch.neverThrown
 			count: 1
 			path: src/Command/TestCommand.php

src/BakePlugin.php

@@ -50,7 +50,6 @@ class BakePlugin extends BasePlugin
     /**
      * Load the TwigView plugin.
      *
-     * @phpstan-ignore-next-line
      * @param \Cake\Core\PluginApplicationInterface $app The host application
      * @return void
      */
@@ -138,22 +137,20 @@ protected function findInPath(string $namespace, string $path): array
             if ($item->isDot() || $item->isDir()) {
                 continue;
             }
-            /** @psalm-var class-string<\Bake\Command\BakeCommand> $class */
             $class = $namespace . $item->getBasename('.php');
 
             if (!$hasSubfolder) {
                 try {
                     $reflection = new ReflectionClass($class);
-                /** @phpstan-ignore-next-line */
-                } catch (ReflectionException $e) {
+                } catch (ReflectionException) {
                     continue;
                 }
-                /** @psalm-suppress TypeDoesNotContainType */
                 if (!$reflection->isInstantiable() || !$reflection->isSubclassOf(BakeCommand::class)) {
                     continue;
                 }
             }
 
+            /** @var class-string<\Bake\Command\BakeCommand> $class */
             $candidates[$class::defaultName()] = $class;
         }
 

src/Command/AllCommand.php

@@ -21,6 +21,7 @@
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
 use Cake\Datasource\ConnectionManager;
+use Throwable;
 
 /**
  * Command for `bake all`
@@ -49,7 +50,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar
         $parser = $this->_setCommonOptions($parser);
 
         $parser = $parser->setDescription(
-            'Generate the model, controller, template, tests and fixture for a table.'
+            'Generate the model, controller, template, tests and fixture for a table.',
         )->addArgument('name', [
             'help' => 'Name of the table to generate code for.',
         ])->addOption('everything', [
@@ -83,20 +84,21 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
         /** @var \Cake\Database\Connection $connection */
         $connection = ConnectionManager::get($this->connection);
         $scanner = new TableScanner($connection);
-        if (empty($name) && !$args->getOption('everything')) {
+        $tables = $scanner->removeShadowTranslationTables($scanner->listUnskipped());
+
+        if (!$name && !$args->getOption('everything')) {
             $io->out('Choose a table to generate from the following:');
-            foreach ($scanner->listUnskipped() as $table) {
+            foreach ($tables as $table) {
                 $io->out('- ' . $this->_camelize($table));
             }
 
             return static::CODE_SUCCESS;
         }
-        if ($args->getOption('everything')) {
-            $tables = $scanner->listUnskipped();
-        } else {
+        if (!$args->getOption('everything')) {
             $tables = [$name];
         }
 
+        $errors = 0;
         foreach ($this->commands as $commandName) {
             /** @var \Cake\Command\Command $command */
             $command = new $commandName();
@@ -113,12 +115,27 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             foreach ($tables as $table) {
                 $parser = $command->getOptionParser();
                 $subArgs = new Arguments([$table], $options, $parser->argumentNames());
-                $command->execute($subArgs, $io);
+
+                try {
+                    $command->execute($subArgs, $io);
+                } catch (Throwable $e) {
+                    if (!$args->getOption('everything') || !$args->getOption('force')) {
+                        throw $e;
+                    }
+
+                    $message = sprintf('Error generating %s for %s: %s', $commandName, $table, $e->getMessage());
+                    $io->err('<error>' . $message . '</error>');
+                    $errors++;
+                }
             }
         }
 
-        $io->out('<success>Bake All complete.</success>', 1, ConsoleIo::NORMAL);
+        if ($errors) {
+            $io->out(sprintf('<warning>Bake All completed, but with %s errors.</warning>', $errors), 1, ConsoleIo::NORMAL);
+        } else {
+            $io->out('<success>Bake All complete.</success>', 1, ConsoleIo::NORMAL);
+        }
 
-        return static::CODE_SUCCESS;
+        return $errors ? static::CODE_ERROR : static::CODE_SUCCESS;
     }
 }

src/Command/FixtureAllCommand.php

@@ -86,7 +86,9 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
         $connection = ConnectionManager::get($args->getOption('connection') ?? 'default');
         $scanner = new TableScanner($connection);
         $fixture = new FixtureCommand();
-        foreach ($scanner->listUnskipped() as $table) {
+
+        $tables = $scanner->removeShadowTranslationTables($scanner->listUnskipped());
+        foreach ($tables as $table) {
             $fixtureArgs = new Arguments([$table], $args->getOptions(), ['name']);
             $fixture->execute($fixtureArgs, $io);
         }

src/Command/ModelAllCommand.php

@@ -83,7 +83,8 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
         /** @var \Cake\Database\Connection $connection */
         $connection = ConnectionManager::get($this->connection);
         $scanner = new TableScanner($connection);
-        foreach ($scanner->listUnskipped() as $table) {
+        $tables = $scanner->removeShadowTranslationTables($scanner->listUnskipped());
+        foreach ($tables as $table) {
             $this->getTableLocator()->clear();
             $modelArgs = new Arguments([$table], $args->getOptions(), ['name']);
             $this->modelCommand->execute($modelArgs, $io);

src/Command/ModelCommand.php

@@ -256,6 +256,8 @@ public function getAssociations(Table $table, Arguments $args, ConsoleIo $io): a
         $associations = $this->findHasMany($table, $associations);
         $associations = $this->findBelongsToMany($table, $associations);
 
+        $associations = $this->ensureAliasUniqueness($associations);
+
         return $associations;
     }
 
@@ -275,6 +277,7 @@ public function applyAssociations(Table $model, array $associations): void
         if (get_class($model) !== Table::class) {
             return;
         }
+
         foreach ($associations as $type => $assocs) {
             foreach ($assocs as $assoc) {
                 $alias = $assoc['alias'];
@@ -349,6 +352,7 @@ public function findBelongsTo(Table $model, array $associations, ?Arguments $arg
                 continue;
             }
 
+            $className = null;
             if ($fieldName === 'parent_id') {
                 $className = $this->plugin ? $this->plugin . '.' . $model->getAlias() : $model->getAlias();
                 $assoc = [
@@ -375,7 +379,7 @@ public function findBelongsTo(Table $model, array $associations, ?Arguments $arg
                     $allowAliasRelations = $args && $args->getOption('skip-relation-check');
                     $found = $this->findTableReferencedBy($schema, $fieldName);
                     if ($found) {
-                        $tmpModelName = Inflector::camelize($found);
+                        $className = ($this->plugin ? $this->plugin . '.' : '') . Inflector::camelize($found);
                     } elseif (!$allowAliasRelations) {
                         continue;
                     }
@@ -384,6 +388,9 @@ public function findBelongsTo(Table $model, array $associations, ?Arguments $arg
                     'alias' => $tmpModelName,
                     'foreignKey' => $fieldName,
                 ];
+                if ($className && $className !== $tmpModelName) {
+                    $assoc['className'] = $className;
+                }
                 if ($schema->getColumn($fieldName)['null'] === false) {
                     $assoc['joinType'] = 'INNER';
                 }
@@ -392,6 +399,7 @@ public function findBelongsTo(Table $model, array $associations, ?Arguments $arg
             if ($this->plugin && empty($assoc['className'])) {
                 $assoc['className'] = $this->plugin . '.' . $assoc['alias'];
             }
+
             $associations['belongsTo'][] = $assoc;
         }
 
@@ -1243,7 +1251,7 @@ public function bakeTable(Table $model, array $data, Arguments $args, ConsoleIo
     }
 
     /**
-     * Outputs the a list of possible models or controllers from database
+     * Outputs the list of possible models or controllers from database
      *
      * @return array<string>
      */
@@ -1262,7 +1270,7 @@ public function listAll(): array
     }
 
     /**
-     * Outputs the a list of unskipped models or controllers from database
+     * Outputs the list of unskipped models or controllers from database
      *
      * @return array<string>
      */
@@ -1546,4 +1554,43 @@ protected function bakeEnums(Table $model, array $data, Arguments $args, Console
             $enumCommand->execute($args, $io);
         }
     }
+
+    /**
+     * @param array<string, array<string, mixed>> $associations
+     * @return array<string, array<string, mixed>>
+     */
+    protected function ensureAliasUniqueness(array $associations): array
+    {
+        $existing = [];
+        foreach ($associations as $type => $associationsPerType) {
+            foreach ($associationsPerType as $k => $association) {
+                $alias = $association['alias'];
+                if (in_array($alias, $existing, true)) {
+                    $alias = $this->createAssociationAlias($association);
+                }
+                $existing[] = $alias;
+                if (empty($association['className'])) {
+                    $className = $this->plugin ? $this->plugin . '.' . $association['alias'] : $association['alias'];
+                    if ($className !== $alias) {
+                        $association['className'] = $className;
+                    }
+                }
+                $association['alias'] = $alias;
+                $associations[$type][$k] = $association;
+            }
+        }
+
+        return $associations;
+    }
+
+    /**
+     * @param array<string, mixed> $association
+     * @return string
+     */
+    protected function createAssociationAlias(array $association): string
+    {
+        $foreignKey = $association['foreignKey'];
+
+        return $this->_modelNameFromKey($foreignKey);
+    }
 }