Add rector rule for constructor injection

platformsh · Nov 27, 2024 · 3a1b932 · 3a1b932
1 parent 1bfcfe5
commit 3a1b932
Show file tree

Hide file tree

Showing 177 changed files with 1,642 additions and 818 deletions.
diff --git a/rector.php b/rector.php
@@ -2,18 +2,14 @@
 
 declare(strict_types=1);
 
+use Platformsh\Cli\InjectCommandServicesRector;
 use Rector\Config\RectorConfig;
-use Rector\Symfony\Set\SymfonySetList;
-use Rector\Symfony\Symfony61\Rector\Class_\CommandConfigureToAttributeRector;
 
 return RectorConfig::configure()
     ->withPaths([
-        __DIR__ . '/src',
-        __DIR__ . '/tests',
-    ])
-    ->withSets([
-        SymfonySetList::SYMFONY_71,
+        __DIR__ . '/src/Command',
     ])
     ->withRules([
-        CommandConfigureToAttributeRector::class,
-    ]);
+        InjectCommandServicesRector::class,
+    ])
+    ->withImportNames(importShortClasses: false, removeUnusedImports: true);
diff --git a/src/Command/Activity/ActivityCancelCommand.php b/src/Command/Activity/ActivityCancelCommand.php
@@ -17,6 +17,10 @@
 #[AsCommand(name: 'activity:cancel', description: 'Cancel an activity')]
 class ActivityCancelCommand extends ActivityCommandBase
 {
+    public function __construct(private readonly ActivityLoader $activityLoader)
+    {
+        parent::__construct();
+    }
     /**
      * {@inheritdoc}
      */
@@ -43,8 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->validateInput($input, $input->getOption('all') || $input->getArgument('id'));
 
-        /** @var ActivityLoader $loader */
-        $loader = $this->getService('activity_loader');
+        $loader = $this->activityLoader;
 
         $executable = $this->config()->get('application.executable');
 

diff --git a/src/Command/Activity/ActivityGetCommand.php b/src/Command/Activity/ActivityGetCommand.php
@@ -16,6 +16,10 @@
 #[AsCommand(name: 'activity:get', description: 'View detailed information on a single activity')]
 class ActivityGetCommand extends ActivityCommandBase
 {
+    public function __construct(private readonly ActivityLoader $activityLoader, private readonly PropertyFormatter $propertyFormatter, private readonly Table $table)
+    {
+        parent::__construct();
+    }
     /**
      * {@inheritdoc}
      */
@@ -52,8 +56,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->validateInput($input, $input->getOption('all') || $input->getArgument('id'));
 
-        /** @var ActivityLoader $loader */
-        $loader = $this->getService('activity_loader');
+        $loader = $this->activityLoader;
 
         if ($this->hasSelectedEnvironment() && !$input->getOption('all')) {
             $apiResource = $this->getSelectedEnvironment();
@@ -84,10 +87,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
-        /** @var Table $table */
-        $table = $this->getService('table');
-        /** @var PropertyFormatter $formatter */
-        $formatter = $this->getService('property_formatter');
+        $table = $this->table;
+        $formatter = $this->propertyFormatter;
 
         $properties = $activity->getProperties();
 

diff --git a/src/Command/Activity/ActivityListCommand.php b/src/Command/Activity/ActivityListCommand.php
@@ -1,6 +1,7 @@
 <?php
 namespace Platformsh\Cli\Command\Activity;
 
+use Platformsh\Cli\Service\ActivityLoader;
 use Platformsh\Cli\Console\AdaptiveTableCell;
 use Platformsh\Cli\Console\ArrayArgument;
 use Platformsh\Cli\Service\ActivityMonitor;
@@ -31,6 +32,11 @@ class ActivityListCommand extends ActivityCommandBase
     ];
     private $defaultColumns = ['id', 'created', 'description', 'progress', 'state', 'result'];
 
+    public function __construct(private readonly ActivityLoader $activityLoader, private readonly PropertyFormatter $propertyFormatter, private readonly Table $table)
+    {
+        parent::__construct();
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -86,19 +92,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $apiResource = $project;
         }
 
-        /** @var \Platformsh\Cli\Service\ActivityLoader $loader */
-        $loader = $this->getService('activity_loader');
+        $loader = $this->activityLoader;
         $activities = $loader->loadFromInput($apiResource, $input);
         if ($activities === []) {
             $this->stdErr->writeln('No activities found');
 
             return 1;
         }
 
-        /** @var \Platformsh\Cli\Service\Table $table */
-        $table = $this->getService('table');
-        /** @var \Platformsh\Cli\Service\PropertyFormatter $formatter */
-        $formatter = $this->getService('property_formatter');
+        $table = $this->table;
+        $formatter = $this->propertyFormatter;
 
         $defaultColumns = $this->defaultColumns;
 

diff --git a/src/Command/Activity/ActivityLogCommand.php b/src/Command/Activity/ActivityLogCommand.php
@@ -1,6 +1,7 @@
 <?php
 namespace Platformsh\Cli\Command\Activity;
 
+use Platformsh\Cli\Service\ActivityLoader;
 use Platformsh\Cli\Console\ArrayArgument;
 use Platformsh\Cli\Service\ActivityMonitor;
 use Platformsh\Cli\Service\PropertyFormatter;
@@ -14,6 +15,10 @@
 #[AsCommand(name: 'activity:log', description: 'Display the log for an activity')]
 class ActivityLogCommand extends ActivityCommandBase
 {
+    public function __construct(private readonly ActivityLoader $activityLoader, private readonly ActivityMonitor $activityMonitor, private readonly PropertyFormatter $propertyFormatter)
+    {
+        parent::__construct();
+    }
     /**
      * {@inheritdoc}
      */
@@ -57,8 +62,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->validateInput($input, $input->getOption('all') || $input->getArgument('id'));
 
-        /** @var \Platformsh\Cli\Service\ActivityLoader $loader */
-        $loader = $this->getService('activity_loader');
+        $loader = $this->activityLoader;
 
         if ($this->hasSelectedEnvironment() && !$input->getOption('all')) {
             $apiResource = $this->getSelectedEnvironment();
@@ -89,8 +93,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
-        /** @var \Platformsh\Cli\Service\PropertyFormatter $formatter */
-        $formatter = $this->getService('property_formatter');
+        $formatter = $this->propertyFormatter;
 
         $this->stdErr->writeln([
             sprintf('<info>Activity ID: </info>%s', $activity->id),
@@ -109,8 +112,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $timestamps = $this->config()->getWithDefault('application.date_format', 'c');
         }
 
-        /** @var ActivityMonitor $monitor */
-        $monitor = $this->getService('activity_monitor');
+        $monitor = $this->activityMonitor;
         if ($refresh > 0 && !$this->runningViaMulti && !$activity->isComplete() && $activity->state !== Activity::STATE_CANCELLED) {
             $monitor->waitAndLog($activity, $refresh, $timestamps, false, $output);
 

diff --git a/src/Command/ApiCurlCommand.php b/src/Command/ApiCurlCommand.php
@@ -11,6 +11,11 @@ class ApiCurlCommand extends CommandBase
 {
     protected $hiddenInList = true;
 
+    public function __construct(private readonly CurlCli $curlCli)
+    {
+        parent::__construct();
+    }
+
     protected function configure()
     {
         CurlCli::configureInput($this->getDefinition());
@@ -24,8 +29,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         // (allowing for auto login).
         $this->api();
 
-        /** @var CurlCli $curl */
-        $curl = $this->getService('curl_cli');
+        $curl = $this->curlCli;
 
         return $curl->run($url, $input, $output);
     }

diff --git a/src/Command/App/AppConfigGetCommand.php b/src/Command/App/AppConfigGetCommand.php
@@ -1,6 +1,7 @@
 <?php
 namespace Platformsh\Cli\Command\App;
 
+use Platformsh\Cli\Service\PropertyFormatter;
 use Platformsh\Cli\Command\CommandBase;
 use Platformsh\Cli\Model\AppConfig;
 use Platformsh\Cli\Model\Host\LocalHost;
@@ -12,6 +13,10 @@
 #[AsCommand(name: 'app:config-get', description: 'View the configuration of an app')]
 class AppConfigGetCommand extends CommandBase
 {
+    public function __construct(private readonly PropertyFormatter $propertyFormatter)
+    {
+        parent::__construct();
+    }
     /**
      * {@inheritdoc}
      */
@@ -49,8 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 ->getConfig();
         }
 
-        /** @var \Platformsh\Cli\Service\PropertyFormatter $formatter */
-        $formatter = $this->getService('property_formatter');
+        $formatter = $this->propertyFormatter;
         $formatter->displayData($output, $appConfig->getNormalized(), $input->getOption('property'));
         return 0;
     }

diff --git a/src/Command/App/AppListCommand.php b/src/Command/App/AppListCommand.php
@@ -1,6 +1,8 @@
 <?php
 namespace Platformsh\Cli\Command\App;
 
+use Platformsh\Cli\Local\ApplicationFinder;
+use Platformsh\Cli\Service\PropertyFormatter;
 use Platformsh\Cli\Command\CommandBase;
 use Platformsh\Cli\Service\Table;
 use Platformsh\Client\Model\Deployment\EnvironmentDeployment;
@@ -15,6 +17,11 @@ class AppListCommand extends CommandBase
     private $tableHeader = ['Name', 'Type', 'disk' => 'Disk', 'Size', 'path' => 'Path'];
     private $defaultColumns = ['name', 'type'];
 
+    public function __construct(private readonly ApplicationFinder $applicationFinder, private readonly PropertyFormatter $propertyFormatter, private readonly Table $table)
+    {
+        parent::__construct();
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -63,8 +70,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $showLocalPath = false;
         $localApps = [];
         if (($projectRoot = $this->getProjectRoot()) && $this->selectedProjectIsCurrent() && $this->config()->has('service.app_config_file')) {
-            /** @var \Platformsh\Cli\Local\ApplicationFinder $finder */
-            $finder = $this->getService('app_finder');
+            $finder = $this->applicationFinder;
             $localApps = $finder->findApplications($projectRoot);
             $showLocalPath = true;
         }
@@ -86,8 +92,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $defaultColumns[] = 'path';
         }
 
-        /** @var \Platformsh\Cli\Service\PropertyFormatter $formatter */
-        $formatter = $this->getService('property_formatter');
+        $formatter = $this->propertyFormatter;
 
         $rows = [];
         foreach ($apps as $app) {
@@ -98,8 +103,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $rows[] = $row;
         }
 
-        /** @var \Platformsh\Cli\Service\Table $table */
-        $table = $this->getService('table');
+        $table = $this->table;
         if (!$table->formatIsMachineReadable()) {
             $this->stdErr->writeln(sprintf(
                 'Applications on the project <info>%s</info>, environment <info>%s</info>:',

diff --git a/src/Command/Auth/ApiTokenLoginCommand.php b/src/Command/Auth/ApiTokenLoginCommand.php
@@ -1,6 +1,8 @@
 <?php
 namespace Platformsh\Cli\Command\Auth;
 
+use Platformsh\Cli\Service\QuestionHelper;
+use Platformsh\Cli\Service\TokenConfig;
 use GuzzleHttp\Exception\BadResponseException;
 use GuzzleHttp\Utils;
 use League\OAuth2\Client\Token\AccessToken;
@@ -15,6 +17,10 @@
 class ApiTokenLoginCommand extends CommandBase
 {
 
+    public function __construct(private readonly QuestionHelper $questionHelper, private readonly TokenConfig $tokenConfig)
+    {
+        parent::__construct();
+    }
     protected function configure()
     {
         $service = $this->config()->get('service.name');
@@ -74,8 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return $apiToken;
         };
 
-        /** @var \Platformsh\Cli\Service\QuestionHelper $questionHelper */
-        $questionHelper = $this->getService('question_helper');
+        $questionHelper = $this->questionHelper;
         $question = new Question("Please enter an API token:\n> ");
         $question->setValidator($validator);
         $question->setMaxAttempts(5);
@@ -96,8 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     private function saveTokens($apiToken, AccessToken $accessToken) {
         $this->api()->logout();
 
-        /** @var \Platformsh\Cli\Service\TokenConfig $tokenConfig */
-        $tokenConfig = $this->getService('token_config');
+        $tokenConfig = $this->tokenConfig;
         $tokenConfig->storage()->storeToken($apiToken);
 
         $this->api()

diff --git a/src/Command/Auth/AuthInfoCommand.php b/src/Command/Auth/AuthInfoCommand.php
@@ -1,6 +1,7 @@
 <?php
 namespace Platformsh\Cli\Command\Auth;
 
+use Platformsh\Cli\Service\PropertyFormatter;
 use Platformsh\Cli\Command\CommandBase;
 use Platformsh\Cli\Service\Table;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -13,6 +14,10 @@
 #[AsCommand(name: 'auth:info', description: 'Display your account information')]
 class AuthInfoCommand extends CommandBase
 {
+    public function __construct(private readonly PropertyFormatter $propertyFormatter, private readonly Table $table)
+    {
+        parent::__construct();
+    }
     protected function configure()
     {
         $this
@@ -28,8 +33,7 @@ protected function configure()
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        /** @var \Platformsh\Cli\Service\PropertyFormatter $formatter */
-        $formatter = $this->getService('property_formatter');
+        $formatter = $this->propertyFormatter;
 
         if ($input->getOption('no-auto-login') && !$this->api()->isLoggedIn()) {
             $this->stdErr->writeln('Not logged in', OutputInterface::VERBOSITY_VERBOSE);
@@ -95,8 +99,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $header[] = $property;
             }
         }
-        /** @var \Platformsh\Cli\Service\Table $table */
-        $table = $this->getService('table');
+        $table = $this->table;
         $table->renderSimple($values, $header);
 
         if (!$table->formatIsMachineReadable() && ($this->config()->getSessionId() !== 'default' || count($this->api()->listSessionIds()) > 1)) {

diff --git a/src/Command/Auth/BrowserLoginCommand.php b/src/Command/Auth/BrowserLoginCommand.php
@@ -1,6 +1,7 @@
 <?php
 namespace Platformsh\Cli\Command\Auth;
 
+use Platformsh\Cli\Service\QuestionHelper;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\BadResponseException;
 use GuzzleHttp\Psr7\Request;
@@ -23,6 +24,10 @@
 #[AsCommand(name: 'auth:browser-login', description: 'Log in to via a browser', aliases: ['login'])]
 class BrowserLoginCommand extends CommandBase
 {
+    public function __construct(private readonly Url $url)
+    {
+        parent::__construct();
+    }
     protected function configure()
     {
         $applicationName = $this->config()->get('application.name');
@@ -79,7 +84,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 ));
 
                 if ($input->isInteractive()) {
-                    /** @var \Platformsh\Cli\Service\QuestionHelper $questionHelper */
+                    /** @var QuestionHelper $questionHelper */
                     $questionHelper = $this->getService('question_helper');
                     if (!$questionHelper->confirm('Log in anyway?', false)) {
                         return 1;
@@ -175,8 +180,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         // Open the local server URL in a browser (or print the URL).
-        /** @var \Platformsh\Cli\Service\Url $urlService */
-        $urlService = $this->getService('url');
+        $urlService = $this->url;
         if ($urlService->openUrl($localUrl, false)) {
             $this->stdErr->writeln(sprintf('Opened URL: <info>%s</info>', $localUrl));
             $this->stdErr->writeln('Please use the browser to log in.');