Merge pull request #791 from cakephp/allow-underscore

Allow column names to start with underscore
cakephp · Nov 1, 2021 · e559b5f · e559b5f
2 parents cbeae91 + 887cafb
commit e559b5f
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 22 deletions.
diff --git a/src/Command/FixtureCommand.php b/src/Command/FixtureCommand.php
@@ -22,7 +22,6 @@
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
-use Cake\Console\Exception\StopException;
 use Cake\Core\Configure;
 use Cake\Database\Exception;
 use Cake\Database\Schema\TableSchemaInterface;
@@ -168,7 +167,7 @@ protected function bake(string $model, string $useTable, Arguments $args, Consol
             $data = $this->readSchema($model, $useTable);
         }
 
-        $this->validateNames($data);
+        $this->validateNames($data, $io);
 
         if ($modelImport === null) {
             $schema = $this->_generateSchema($data);
@@ -214,15 +213,16 @@ public function readSchema(string $name, string $table): TableSchemaInterface
      * Validates table and column names are supported.
      *
      * @param \Cake\Database\Schema\TableSchemaInterface $schema Table schema
+     * @param \Cake\Console\ConsoleIo $io Console io
      * @return void
      * @throws \Cake\Console\Exception\StopException When table or column names are not supported
      */
-    public function validateNames(TableSchemaInterface $schema): void
+    public function validateNames(TableSchemaInterface $schema, ConsoleIo $io): void
     {
         foreach ($schema->columns() as $column) {
-            if (!is_string($column) || !ctype_alpha($column[0])) {
-                throw new StopException(sprintf(
-                    'Unable to bake table with integer column names or names that start with digits. Found `%s`.',
+            if (!is_string($column) || (!ctype_alpha($column[0]) && $column[0] !== '_')) {
+                $io->abort(sprintf(
+                    'Unable to bake model. Table column names must start with a letter or underscore. Found `%s`.',
                     (string)$column
                 ));
             }

diff --git a/src/Command/ModelCommand.php b/src/Command/ModelCommand.php
@@ -21,7 +21,6 @@
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
-use Cake\Console\Exception\StopException;
 use Cake\Core\Configure;
 use Cake\Database\Connection;
 use Cake\Database\Driver\Sqlserver;
@@ -109,7 +108,7 @@ public function bake(string $name, Arguments $args, ConsoleIo $io): void
     {
         $table = $this->getTable($name, $args);
         $tableObject = $this->getTableObject($name, $table);
-        $this->validateNames($tableObject->getSchema());
+        $this->validateNames($tableObject->getSchema(), $io);
         $data = $this->getTableContext($tableObject, $table, $name, $args, $io);
         $this->bakeTable($tableObject, $data, $args, $io);
         $this->bakeEntity($tableObject, $data, $args, $io);
@@ -121,15 +120,16 @@ public function bake(string $name, Arguments $args, ConsoleIo $io): void
      * Validates table and column names are supported.
      *
      * @param \Cake\Database\Schema\TableSchemaInterface $schema Table schema
+     * @param \Cake\Console\ConsoleIo $io Console io
      * @return void
      * @throws \Cake\Console\Exception\StopException When table or column names are not supported
      */
-    public function validateNames(TableSchemaInterface $schema): void
+    public function validateNames(TableSchemaInterface $schema, ConsoleIo $io): void
     {
         foreach ($schema->columns() as $column) {
-            if (!is_string($column) || !ctype_alpha($column[0])) {
-                throw new StopException(sprintf(
-                    'Unable to bake table with integer column names or names that start with digits. Found `%s`.',
+            if (!is_string($column) || (!ctype_alpha($column[0]) && $column[0] !== '_')) {
+                $io->abort(sprintf(
+                    'Unable to bake model. Table column names must start with a letter or underscore. Found `%s`.',
                     (string)$column
                 ));
             }

diff --git a/tests/TestCase/Command/FixtureCommandTest.php b/tests/TestCase/Command/FixtureCommandTest.php
@@ -18,7 +18,7 @@
 
 use Bake\Command\FixtureCommand;
 use Bake\Test\TestCase\TestCase;
-use Cake\Console\Exception\StopException;
+use Cake\Console\ConsoleIo;
 use Cake\Console\Shell;
 use Cake\Core\Plugin;
 use Cake\Database\Driver\Postgres;
@@ -60,17 +60,33 @@ public function setUp(): void
     /**
      * Tests validating supported table and column names.
      */
-    public function testValidateNames(): void
+    public function testValidateNamesWithValid(): void
+    {
+        $command = new FixtureCommand();
+        $command->connection = 'test';
+
+        $schema = $command->readSchema('Car', 'car');
+        $schema->addColumn('_valid', ['type' => 'string', 'length' => null]);
+
+        $io = $this->createMock(ConsoleIo::class);
+        $io->expects($this->never())->method('abort');
+        $command->validateNames($schema, $io);
+    }
+
+    /**
+     * Tests validating supported table and column names.
+     */
+    public function testValidateNamesWithInvalid(): void
     {
         $command = new FixtureCommand();
         $command->connection = 'test';
 
         $schema = $command->readSchema('Car', 'car');
         $schema->addColumn('0invalid', ['type' => 'string', 'length' => null]);
 
-        $this->expectException(StopException::class);
-        $this->expectExceptionMessage('Unable to bake table with integer column names or names that start with digits. Found `0invalid`');
-        $command->validateNames($schema);
+        $io = $this->createMock(ConsoleIo::class);
+        $io->expects($this->once())->method('abort');
+        $command->validateNames($schema, $io);
     }
 
     /**

diff --git a/tests/TestCase/Command/ModelCommandTest.php b/tests/TestCase/Command/ModelCommandTest.php
@@ -21,7 +21,6 @@
 use Cake\Command\Command;
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
-use Cake\Console\Exception\StopException;
 use Cake\Core\Configure;
 use Cake\Core\Plugin;
 use Cake\Database\Driver\Mysql;
@@ -164,17 +163,33 @@ public function testGetTableObjectPrefix()
     /**
      * Tests validating supported table and column names.
      */
-    public function testValidateNames(): void
+    public function testValidateNamesWithValid(): void
+    {
+        $command = new ModelCommand();
+        $command->connection = 'test';
+
+        $schema = $command->getTableObject('TodoItems', 'todo_items')->getSchema();
+        $schema->addColumn('_valid', ['type' => 'string', 'length' => null]);
+
+        $io = $this->createMock(ConsoleIo::class);
+        $io->expects($this->never())->method('abort');
+        $command->validateNames($schema, $io);
+    }
+
+    /**
+     * Tests validating supported table and column names.
+     */
+    public function testValidateNamesWithInvalid(): void
     {
         $command = new ModelCommand();
         $command->connection = 'test';
 
         $schema = $command->getTableObject('TodoItems', 'todo_items')->getSchema();
         $schema->addColumn('0invalid', ['type' => 'string', 'length' => null]);
 
-        $this->expectException(StopException::class);
-        $this->expectExceptionMessage('Unable to bake table with integer column names or names that start with digits. Found `0invalid`');
-        $command->validateNames($schema);
+        $io = $this->createMock(ConsoleIo::class);
+        $io->expects($this->once())->method('abort');
+        $command->validateNames($schema, $io);
     }
 
     /**