Allow baking enums.

docs/en/usage.rst

@@ -31,9 +31,11 @@ You can get the list of available bake command by running ``bin/cake bake --help
     - bake behavior
     - bake cell
     - bake command
+    - bake command_helper
     - bake component
     - bake controller
     - bake controller all
+    - bake enum
     - bake fixture
     - bake fixture all
     - bake form

src/Command/EnumCommand.php

@@ -0,0 +1,95 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         3.1.0
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Bake\Command;
+
+use Cake\Console\Arguments;
+use Cake\Console\ConsoleOptionParser;
+use InvalidArgumentException;
+
+/**
+ * Enum code generator.
+ */
+class EnumCommand extends SimpleBakeCommand
+{
+    /**
+     * Task name used in path generation.
+     *
+     * @var string
+     */
+    public string $pathFragment = 'Model/Enum/';
+
+    /**
+     * @inheritDoc
+     */
+    public function name(): string
+    {
+        return 'enum';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function fileName(string $name): string
+    {
+        return $name . '.php';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function template(): string
+    {
+        return 'Bake.Model/enum';
+    }
+
+    /**
+     * Get template data.
+     *
+     * @param \Cake\Console\Arguments $arguments The arguments for the command
+     * @return array
+     * @phpstan-return array<string, mixed>
+     */
+    public function templateData(Arguments $arguments): array
+    {
+        $data = parent::templateData($arguments);
+        $data['backingType'] = $arguments->getOption('backing-type');
+
+        return $data;
+    }
+
+    /**
+     * Gets the option parser instance and configures it.
+     *
+     * @param \Cake\Console\ConsoleOptionParser $parser The option parser to update.
+     * @return \Cake\Console\ConsoleOptionParser
+     */
+    public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
+    {
+        $parser = $this->_setCommonOptions($parser);
+
+        $parser->setDescription(
+            'Bake backed enums for use in models.'
+        )->addOption('backing-type', [
+            'help' => 'The return type for the backed enum class',
+            'default' => 'string',
+            'choices' => ['string', 'int'],
+            'short' => 'b',
+        ]);
+
+        return $parser;
+    }
+}

templates/bake/Model/enum.twig

@@ -0,0 +1,34 @@
+{#
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         3.1.0
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+#}
+{{ element('Bake.file_header', {
+    namespace: "#{namespace}\\Model\\Enum",
+    classImports: [
+        'Cake\\Database\\Type\\EnumLabelInterface',
+        'Cake\\Utility\\Inflector',
+    ],
+}) }}
+
+{{ DocBlock.classDescription(name, 'Enum', [])|raw }}
+enum {{ name }}: {{ backingType }} implements EnumLabelInterface
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return Inflector::humanize(Inflector::underscore($this->name));
+    }
+}

tests/TestCase/Command/EnumCommandTest.php

@@ -0,0 +1,71 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         3.1.0
+ * @license       https://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Bake\Test\TestCase\Command;
+
+use Bake\Test\TestCase\TestCase;
+use Cake\Console\CommandInterface;
+use Cake\Core\Plugin;
+
+/**
+ * EnumCommandTest class
+ */
+class EnumCommandTest extends TestCase
+{
+    /**
+     * setup method
+     *
+     * @return void
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->_compareBasePath = Plugin::path('Bake') . 'tests' . DS . 'comparisons' . DS . 'Model' . DS;
+        $this->setAppNamespace('Bake\Test\App');
+    }
+
+    /**
+     * test baking an enum
+     *
+     * @return void
+     */
+    public function testBakeEnum()
+    {
+        $this->generatedFile = APP . 'Model/Enum/FooBar.php';
+        $this->exec('bake enum FooBar', ['y']);
+
+        $this->assertExitCode(CommandInterface::CODE_SUCCESS);
+        $this->assertFileExists($this->generatedFile);
+        $result = file_get_contents($this->generatedFile);
+        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
+    }
+
+    /**
+     * test baking an enum with int return type
+     *
+     * @return void
+     */
+    public function testBakeEnumBackedInt()
+    {
+        $this->generatedFile = APP . 'Model/Enum/FooBar.php';
+        $this->exec('bake enum FooBar -b int', ['y']);
+
+        $this->assertExitCode(CommandInterface::CODE_SUCCESS);
+        $this->assertFileExists($this->generatedFile);
+        $result = file_get_contents($this->generatedFile);
+        $this->assertSameAsFile(__FUNCTION__ . '.php', $result);
+    }
+}

tests/comparisons/Model/testBakeEnum.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace Bake\Test\App\Model\Enum;
+
+use Cake\Database\Type\EnumLabelInterface;
+use Cake\Utility\Inflector;
+
+/**
+ * FooBar Enum
+ */
+enum FooBar: string implements EnumLabelInterface
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return Inflector::humanize(Inflector::underscore($this->name));
+    }
+}

tests/comparisons/Model/testBakeEnumBackedInt.php

@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace Bake\Test\App\Model\Enum;
+
+use Cake\Database\Type\EnumLabelInterface;
+use Cake\Utility\Inflector;
+
+/**
+ * FooBar Enum
+ */
+enum FooBar: int implements EnumLabelInterface
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return Inflector::humanize(Inflector::underscore($this->name));
+    }
+}