Merge pull request #1718 from tarlepp/feat/as-command-attribute

Feat - Use `AsCommand` attribute
tarlepp · Mar 12, 2022 · fc3df7e · fc3df7e
2 parents 2126b10 + 9bb9571
commit fc3df7e
Show file tree

Hide file tree

Showing 18 changed files with 149 additions and 67 deletions.
diff --git a/src/Command/ApiKey/ApiKeyManagementCommand.php b/src/Command/ApiKey/ApiKeyManagementCommand.php
@@ -9,6 +9,7 @@
 namespace App\Command\ApiKey;
 
 use App\Command\Traits\ExecuteMultipleCommandTrait;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 
 /**
@@ -17,22 +18,24 @@
  * @package App\Command\ApiKey
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: 'api-key:management',
+    description: 'Console command to manage API keys',
+)]
 class ApiKeyManagementCommand extends Command
 {
     use ExecuteMultipleCommandTrait;
 
     public function __construct()
     {
-        parent::__construct('api-key:management');
-
-        $this->setDescription('Console command to manage API keys');
+        parent::__construct();
 
         $this->setChoices([
-            'api-key:list' => 'List API keys',
-            'api-key:create' => 'Create API key',
-            'api-key:edit' => 'Edit API key',
-            'api-key:change-token' => 'Change API key token',
-            'api-key:remove' => 'Remove API key',
+            ListApiKeysCommand::NAME => 'List API keys',
+            CreateApiKeyCommand::NAME => 'Create API key',
+            EditApiKeyCommand::NAME => 'Edit API key',
+            ChangeTokenCommand::NAME => 'Change API key token',
+            RemoveApiKeyCommand::NAME => 'Remove API key',
             '0' => 'Exit',
         ]);
     }

diff --git a/src/Command/ApiKey/ChangeTokenCommand.php b/src/Command/ApiKey/ChangeTokenCommand.php
@@ -11,6 +11,7 @@
 use App\Command\Traits\SymfonyStyleTrait;
 use App\Entity\ApiKey;
 use App\Resource\ApiKeyResource;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -22,17 +23,21 @@
  * @package App\Command\ApiKey
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Command to change token for existing API key',
+)]
 class ChangeTokenCommand extends Command
 {
     use SymfonyStyleTrait;
 
+    public const NAME = 'api-key:change-token';
+
     public function __construct(
         private ApiKeyResource $apiKeyResource,
         private ApiKeyHelper $apiKeyHelper,
     ) {
-        parent::__construct('api-key:change-token');
-
-        $this->setDescription('Command to change token for existing API key');
+        parent::__construct();
     }
 
     /**

diff --git a/src/Command/ApiKey/CreateApiKeyCommand.php b/src/Command/ApiKey/CreateApiKeyCommand.php
@@ -18,6 +18,7 @@
 use App\Resource\UserGroupResource;
 use App\Security\RolesService;
 use Matthias\SymfonyConsoleForm\Console\Helper\FormHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -30,11 +31,17 @@
  * @package App\Command\ApiKey
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Command to create new API key',
+)]
 class CreateApiKeyCommand extends Command
 {
     use ApiKeyUserManagementHelperTrait;
     use SymfonyStyleTrait;
 
+    public const NAME = 'api-key:create';
+
     /**
      * @var array<int, array<string, string>>
      */
@@ -52,9 +59,7 @@ public function __construct(
         private RolesService $rolesService,
         private RoleRepository $roleRepository,
     ) {
-        parent::__construct('api-key:create');
-
-        $this->setDescription('Command to create new API key');
+        parent::__construct();
     }
 
     public function getRolesService(): RolesService

diff --git a/src/Command/ApiKey/EditApiKeyCommand.php b/src/Command/ApiKey/EditApiKeyCommand.php
@@ -14,6 +14,7 @@
 use App\Form\Type\Console\ApiKeyType;
 use App\Resource\ApiKeyResource;
 use Matthias\SymfonyConsoleForm\Console\Helper\FormHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -25,17 +26,21 @@
  * @package App\Command\ApiKey
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Command to edit existing API key',
+)]
 class EditApiKeyCommand extends Command
 {
     use SymfonyStyleTrait;
 
+    public const NAME = 'api-key:edit';
+
     public function __construct(
         private ApiKeyResource $apiKeyResource,
         private ApiKeyHelper $apiKeyHelper,
     ) {
-        parent::__construct('api-key:edit');
-
-        $this->setDescription('Command to edit existing API key');
+        parent::__construct();
     }
 
     /**

diff --git a/src/Command/ApiKey/ListApiKeysCommand.php b/src/Command/ApiKey/ListApiKeysCommand.php
@@ -13,6 +13,7 @@
 use App\Resource\ApiKeyResource;
 use App\Security\RolesService;
 use Closure;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -28,15 +29,19 @@
  * @package App\Command\ApiKey
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Console command to list API keys',
+)]
 class ListApiKeysCommand extends Command
 {
+    public const NAME = 'api-key:list';
+
     public function __construct(
         private ApiKeyResource $apiKeyResource,
         private RolesService $rolesService,
     ) {
-        parent::__construct('api-key:list');
-
-        $this->setDescription('Console command to list API keys');
+        parent::__construct();
     }
 
     /**

diff --git a/src/Command/ApiKey/RemoveApiKeyCommand.php b/src/Command/ApiKey/RemoveApiKeyCommand.php
@@ -11,6 +11,7 @@
 use App\Command\Traits\SymfonyStyleTrait;
 use App\Entity\ApiKey;
 use App\Resource\ApiKeyResource;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -22,17 +23,21 @@
  * @package App\Command\ApiKey
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Console command to remove existing API key',
+)]
 class RemoveApiKeyCommand extends Command
 {
     use SymfonyStyleTrait;
 
+    public const NAME = 'api-key:remove';
+
     public function __construct(
         private ApiKeyResource $apiKeyResource,
         private ApiKeyHelper $apiKeyHelper,
     ) {
-        parent::__construct('api-key:remove');
-
-        $this->setDescription('Console command to remove existing API key');
+        parent::__construct();
     }
 
     /**

diff --git a/src/Command/User/CreateRolesCommand.php b/src/Command/User/CreateRolesCommand.php
@@ -13,6 +13,7 @@
 use App\Repository\RoleRepository;
 use App\Security\RolesService;
 use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -27,18 +28,22 @@
  * @package App\Command\User
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Console command to create roles to database',
+)]
 class CreateRolesCommand extends Command
 {
     use SymfonyStyleTrait;
 
+    public const NAME = 'user:create-roles';
+
     public function __construct(
         private EntityManagerInterface $entityManager,
         private RoleRepository $roleRepository,
         private RolesService $rolesService,
     ) {
-        parent::__construct('user:create-roles');
-
-        $this->setDescription('Console command to create roles to database');
+        parent::__construct();
     }
 
     /**

diff --git a/src/Command/User/CreateUserCommand.php b/src/Command/User/CreateUserCommand.php
@@ -18,6 +18,7 @@
 use App\Resource\UserResource;
 use App\Security\RolesService;
 use Matthias\SymfonyConsoleForm\Console\Helper\FormHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -30,11 +31,17 @@
  * @package App\Command\User
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Console command to create user to database',
+)]
 class CreateUserCommand extends Command
 {
     use ApiKeyUserManagementHelperTrait;
     use SymfonyStyleTrait;
 
+    public const NAME = 'user:create';
+
     private const PARAMETER_NAME = 'name';
     private const PARAMETER_DESCRIPTION = 'description';
 
@@ -74,9 +81,7 @@ public function __construct(
         private RolesService $rolesService,
         private RoleRepository $roleRepository,
     ) {
-        parent::__construct('user:create');
-
-        $this->setDescription('Console command to create user to database');
+        parent::__construct();
     }
 
     public function getRolesService(): RolesService

diff --git a/src/Command/User/CreateUserGroupCommand.php b/src/Command/User/CreateUserGroupCommand.php
@@ -16,6 +16,7 @@
 use App\Repository\RoleRepository;
 use App\Resource\UserGroupResource;
 use Matthias\SymfonyConsoleForm\Console\Helper\FormHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputInterface;
@@ -29,11 +30,17 @@
  * @package App\Command\User
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Console command to create user groups',
+)]
 class CreateUserGroupCommand extends Command
 {
     use GetApplicationTrait;
     use SymfonyStyleTrait;
 
+    public const NAME = 'user:create-group';
+
     /**
      * @var array<int, array<string, string>>
      */
@@ -52,9 +59,7 @@ public function __construct(
         private UserGroupResource $userGroupResource,
         private RoleRepository $roleRepository,
     ) {
-        parent::__construct('user:create-group');
-
-        $this->setDescription('Console command to create user groups');
+        parent::__construct();
     }
 
     protected function configure(): void

diff --git a/src/Command/User/EditUserCommand.php b/src/Command/User/EditUserCommand.php
@@ -14,6 +14,7 @@
 use App\Form\Type\Console\UserType;
 use App\Resource\UserResource;
 use Matthias\SymfonyConsoleForm\Console\Helper\FormHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -25,17 +26,21 @@
  * @package App\Command\User
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Command to edit existing user',
+)]
 class EditUserCommand extends Command
 {
     use SymfonyStyleTrait;
 
+    public const NAME = 'user:edit';
+
     public function __construct(
         private UserResource $userResource,
         private UserHelper $userHelper,
     ) {
-        parent::__construct('user:edit');
-
-        $this->setDescription('Command to edit existing user');
+        parent::__construct();
     }
 
     /**

diff --git a/src/Command/User/EditUserGroupCommand.php b/src/Command/User/EditUserGroupCommand.php
@@ -14,6 +14,7 @@
 use App\Form\Type\Console\UserGroupType;
 use App\Resource\UserGroupResource;
 use Matthias\SymfonyConsoleForm\Console\Helper\FormHelper;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -25,17 +26,21 @@
  * @package App\Command\User
  * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
  */
+#[AsCommand(
+    name: self::NAME,
+    description: 'Command to edit existing user group',
+)]
 class EditUserGroupCommand extends Command
 {
     use SymfonyStyleTrait;
 
+    public const NAME = 'user:edit-group';
+
     public function __construct(
         private UserGroupResource $userGroupResource,
         private UserHelper $userHelper,
     ) {
-        parent::__construct('user:edit-group');
-
-        $this->setDescription('Command to edit existing user group');
+        parent::__construct();
     }
 
     /**