Remove symfony console $defaultName deprecation (#491)

axi · Alexis Urien · web-flow · commit d930db6015e0 · 2023-07-11T19:49:12.000+02:00
* - Remove symfony console $defaultName deprecation and use AsCommand Annotation
- Upgrade to PHP ^8.0
- Upgrade to symfony ^5.3

* Fix CI for PHP 8.0+

* Apply existing php-cs rules with php8+

* Fix CI

---------

Co-authored-by: Alexis Urien &lt;alexis@smiile.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,14 +10,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ '7.2', '7.3', '7.4', '8.0', '8.1' ]
+        php: ['8.0', '8.1', '8.2']
         strategy: [ 'highest' ]
         sf_version: ['']
         include:
-            - php: 7.4
+            - php: 8.0
               strategy: 'lowest'
-            - php: 7.3
-              sf_version: '4.*'
 
     steps:
       - name: Checkout code
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           coverage: none
 
       - name: Download dependencies
@@ -63,7 +63,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           coverage: none
 
       - name: Download dependencies
diff --git a/Catalogue/CatalogueManager.php b/Catalogue/CatalogueManager.php
@@ -67,12 +67,12 @@ public function getMessages(string $locale, string $domain): array
     /**
      * @param array $config {
      *
-     *      @var string $domain
-     *      @var string $locale
-     *      @var bool $isNew
-     *      @var bool $isObsolete
-     *      @var bool $isApproved
-     * }
+     * @var string $domain
+     * @var string $locale
+     * @var bool   $isNew
+     * @var bool   $isObsolete
+     * @var bool   $isApproved
+     *             }
      *
      * @return CatalogueMessage[]
      */
diff --git a/Catalogue/Operation/ReplaceOperation.php b/Catalogue/Operation/ReplaceOperation.php
@@ -150,12 +150,12 @@ private function doMergeMetadata(array $source, array $target): array
                         // If both arrays, do recursive call
                         $source[$key] = $this->doMergeMetadata($source[$key], $value);
                     }
-                // Else, use value form $source
+                    // Else, use value form $source
                 } else {
                     // Add new value
                     $source[$key] = $value;
                 }
-            // if sequential
+                // if sequential
             } elseif (!\in_array($value, $source, true)) {
                 $source[] = $value;
             }
diff --git a/Command/BundleTrait.php b/Command/BundleTrait.php
@@ -20,7 +20,7 @@ trait BundleTrait
     private function configureBundleDirs(InputInterface $input, Configuration $config): void
     {
         if ($bundleName = $input->getOption('bundle')) {
-            if (0 === strpos($bundleName, '@')) {
+            if (str_starts_with($bundleName, '@')) {
                 if (false === $pos = strpos($bundleName, '/')) {
                     $bundleName = substr($bundleName, 1);
                 } else {
diff --git a/Command/CheckMissingCommand.php b/Command/CheckMissingCommand.php
@@ -4,6 +4,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -17,10 +18,11 @@
 use Translation\Bundle\Service\ConfigurationManager;
 use Translation\Bundle\Service\Importer;
 
+#[AsCommand(
+    name: 'translation:check-missing'
+)]
 final class CheckMissingCommand extends Command
 {
-    protected static $defaultName = 'translation:check-missing';
-
     /**
      * @var ConfigurationManager
      */
@@ -58,7 +60,6 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Check that all translations for a given locale are extracted.')
             ->addArgument('locale', InputArgument::REQUIRED, 'The locale to check')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default');
diff --git a/Command/DeleteEmptyCommand.php b/Command/DeleteEmptyCommand.php
@@ -11,6 +11,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
@@ -26,13 +27,14 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
+#[AsCommand(
+    name: 'translation:delete-empty'
+)]
 class DeleteEmptyCommand extends Command
 {
     use BundleTrait;
     use StorageTrait;
 
-    protected static $defaultName = 'translation:delete-empty';
-
     /**
      * @var ConfigurationManager
      */
@@ -64,7 +66,6 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Delete all translations currently empty.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
             ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', null)
diff --git a/Command/DeleteObsoleteCommand.php b/Command/DeleteObsoleteCommand.php
@@ -11,6 +11,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
@@ -26,13 +27,14 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
+#[AsCommand(
+    name: 'translation:delete-obsolete'
+)]
 class DeleteObsoleteCommand extends Command
 {
     use BundleTrait;
     use StorageTrait;
 
-    protected static $defaultName = 'translation:delete-obsolete';
-
     /**
      * @var ConfigurationManager
      */
@@ -64,7 +66,6 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Delete all translations marked as obsolete.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
             ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', null)
diff --git a/Command/DownloadCommand.php b/Command/DownloadCommand.php
@@ -11,6 +11,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -26,13 +27,14 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
+#[AsCommand(
+    name: 'translation:download'
+)]
 class DownloadCommand extends Command
 {
     use BundleTrait;
     use StorageTrait;
 
-    protected static $defaultName = 'translation:download';
-
     private $configurationManager;
     private $cacheCleaner;
     private $catalogueWriter;
@@ -54,7 +56,6 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Replace local messages with messages from remote')
             ->setHelp(<<<EOT
 The <info>%command.name%</info> will erase all your local translations and replace them with translations downloaded from the remote.
@@ -138,7 +139,7 @@ public function cleanParameters(array $raw)
 
         foreach ($raw as $string) {
             // Assert $string looks like "foo:bar"
-            list($key, $value) = explode(':', $string, 2);
+            [$key, $value] = explode(':', $string, 2);
             $config[$key][] = $value;
         }
 
diff --git a/Command/ExtractCommand.php b/Command/ExtractCommand.php
@@ -11,6 +11,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -29,12 +30,13 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
+#[AsCommand(
+    name: 'translation:extract'
+)]
 class ExtractCommand extends Command
 {
     use BundleTrait;
 
-    protected static $defaultName = 'translation:extract';
-
     /**
      * @var CatalogueFetcher
      */
@@ -79,7 +81,6 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Extract translations from source code.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
             ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)
diff --git a/Command/StatusCommand.php b/Command/StatusCommand.php
@@ -11,6 +11,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -24,12 +25,13 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
+#[AsCommand(
+    name: 'translation:status'
+)]
 class StatusCommand extends Command
 {
     use BundleTrait;
 
-    protected static $defaultName = 'translation:status';
-
     /**
      * @var CatalogueCounter
      */
@@ -60,7 +62,6 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Show status about your translations.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
             ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)
diff --git a/Command/SyncCommand.php b/Command/SyncCommand.php
@@ -11,6 +11,7 @@
 
 namespace Translation\Bundle\Command;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -22,12 +23,13 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
+#[AsCommand(
+    name: 'translation:sync'
+)]
 class SyncCommand extends Command
 {
     use StorageTrait;
 
-    protected static $defaultName = 'translation:sync';
-
     public function __construct(StorageManager $storageManager)
     {
         $this->storageManager = $storageManager;
@@ -38,7 +40,6 @@ public function __construct(StorageManager $storageManager)
     protected function configure(): void
     {
         $this
-            ->setName(self::$defaultName)
             ->setDescription('Sync the translations with the remote storage')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
             ->addArgument('direction', InputArgument::OPTIONAL, 'Use "down" if local changes should be overwritten, otherwise "up"', 'down')
@@ -78,7 +79,7 @@ public function cleanParameters(array $raw)
 
         foreach ($raw as $string) {
             // Assert $string looks like "foo:bar"
-            list($key, $value) = explode(':', $string, 2);
+            [$key, $value] = explode(':', $string, 2);
             $config[$key][] = $value;
         }
 
diff --git a/Controller/WebUIController.php b/Controller/WebUIController.php
@@ -76,7 +76,7 @@ public function __construct(
     /**
      * Show a dashboard for the configuration.
      */
-    public function indexAction(?string $configName = null): Response
+    public function indexAction(string $configName = null): Response
     {
         if (!$this->isWebUIEnabled) {
             return new Response('You are not allowed here. Check your config.', Response::HTTP_BAD_REQUEST);
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -29,9 +29,6 @@ public function __construct(ContainerBuilder $container)
         $this->container = $container;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('translation');
diff --git a/DependencyInjection/TranslationExtension.php b/DependencyInjection/TranslationExtension.php
@@ -37,9 +37,6 @@
  */
 class TranslationExtension extends Extension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $container->setParameter('extractor_vendor_dir', $this->getExtractorVendorDirectory());
@@ -224,17 +221,11 @@ private function enableFallbackAutoTranslator(ContainerBuilder $container, array
         $container->setParameter('php_translation.translator_service.api_key', $config['fallback_translation']['api_key']);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getAlias(): string
     {
         return 'translation';
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getConfiguration(array $config, ContainerBuilder $container): Configuration
     {
         return new Configuration($container);
diff --git a/EditInPlace/Activator.php b/EditInPlace/Activator.php
@@ -32,7 +32,7 @@ final class Activator implements ActivatorInterface
     /**
      * @var Session|null
      */
-    private $session = null;
+    private $session;
 
     public function __construct(RequestStack $requestStack)
     {
@@ -81,9 +81,6 @@ public function deactivate(): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function checkRequest(Request $request = null): bool
     {
         if (null === $this->getSession() || !$this->getSession()->has(self::KEY)) {
diff --git a/Service/CacheClearer.php b/Service/CacheClearer.php
@@ -58,7 +58,7 @@ public function __construct(string $kernelCacheDir, $translator, Filesystem $fil
      *
      * @param string|null $locale optional filter to clear only one locale
      */
-    public function clearAndWarmUp(?string $locale = null): void
+    public function clearAndWarmUp(string $locale = null): void
     {
         $translationDir = sprintf('%s/translations', $this->kernelCacheDir);
 
diff --git a/Service/Importer.php b/Service/Importer.php
diff --git a/Translator/FallbackTranslator.php b/Translator/FallbackTranslator.php
diff --git a/Twig/EditInPlaceExtension.php b/Twig/EditInPlaceExtension.php
diff --git a/Twig/TranslationExtension.php b/Twig/TranslationExtension.php
diff --git a/composer.json b/composer.json

Original file line number	Diff line number	Diff line change
`@@ -150,12 +150,12 @@ private function doMergeMetadata(array $source, array $target): array`
`150`	`150`	`// If both arrays, do recursive call`
`151`	`151`	`$source[$key] = $this->doMergeMetadata($source[$key], $value);`
`152`	`152`	`}`
`153`		`- // Else, use value form $source`
	`153`	`+ // Else, use value form $source`
`154`	`154`	`} else {`
`155`	`155`	`// Add new value`
`156`	`156`	`$source[$key] = $value;`
`157`	`157`	`}`
`158`		`- // if sequential`
	`158`	`+ // if sequential`
`159`	`159`	`} elseif (!\in_array($value, $source, true)) {`
`160`	`160`	`$source[] = $value;`
`161`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ trait BundleTrait`
`20`	`20`	`private function configureBundleDirs(InputInterface $input, Configuration $config): void`
`21`	`21`	`{`
`22`	`22`	`if ($bundleName = $input->getOption('bundle')) {`
`23`		`- if (0 === strpos($bundleName, '@')) {`
	`23`	`+ if (str_starts_with($bundleName, '@')) {`
`24`	`24`	`if (false === $pos = strpos($bundleName, '/')) {`
`25`	`25`	`$bundleName = substr($bundleName, 1);`
`26`	`26`	`} else {`