Code cleanup and modernization

Author: Rafikooo

.github/workflows/build.yml

@@ -52,7 +52,6 @@ jobs:
             -
                 name: Remove analyse dependencies
                 run: |
-                    composer remove vimeo/psalm --dev --no-update
                     composer remove sylius-labs/coding-standard --dev --no-update
                     composer remove rector/rector --dev --no-update
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2021 Paweł Jędrzejewski
+Copyright (c) 2011 Sylius Sp. z o.o.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

composer.json

@@ -60,7 +60,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.2-dev"
+            "dev-master": "2.5-dev"
         }
     },
     "autoload": {

src/Command/AssetsInstallCommand.php

@@ -15,6 +15,7 @@
 
 use Sylius\Bundle\ThemeBundle\Asset\Installer\AssetsInstallerInterface;
 use Sylius\Bundle\ThemeBundle\Asset\Installer\OutputAwareInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
@@ -25,6 +26,7 @@
 /**
  * Command that places themes web assets into a given directory.
  */
+#[AsCommand(name: 'sylius:theme:assets:install', description: 'Installs themes web assets under a public web directory')]
 final class AssetsInstallCommand extends Command
 {
     private AssetsInstallerInterface $assetsInstaller;
@@ -33,7 +35,7 @@ final class AssetsInstallCommand extends Command
 
     public function __construct(AssetsInstallerInterface $assetsInstaller, string $projectDir)
     {
-        parent::__construct(null);
+        parent::__construct();
 
         $this->assetsInstaller = $assetsInstaller;
         $this->projectDir = $projectDir;
@@ -42,13 +44,11 @@ public function __construct(AssetsInstallerInterface $assetsInstaller, string $p
     protected function configure(): void
     {
         $this
-            ->setName('sylius:theme:assets:install')
             ->setDefinition([
                 new InputArgument('target', InputArgument::OPTIONAL, 'The target directory'),
             ])
             ->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlinks the assets instead of copying it')
             ->addOption('relative', null, InputOption::VALUE_NONE, 'Make relative symlinks')
-            ->setDescription('Installs themes web assets under a public web directory')
             ->setHelp($this->getHelpMessage())
         ;
     }

src/Command/ListCommand.php

@@ -14,30 +14,24 @@
 namespace Sylius\Bundle\ThemeBundle\Command;
 
 use Sylius\Bundle\ThemeBundle\Repository\ThemeRepositoryInterface;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+#[AsCommand(name: 'sylius:theme:list', description: 'Shows list of detected themes.')]
 final class ListCommand extends Command
 {
     private ThemeRepositoryInterface $themeRepository;
 
     public function __construct(ThemeRepositoryInterface $themeRepository)
     {
-        parent::__construct(null);
+        parent::__construct();
 
         $this->themeRepository = $themeRepository;
     }
 
-    protected function configure(): void
-    {
-        $this
-            ->setName('sylius:theme:list')
-            ->setDescription('Shows list of detected themes.')
-        ;
-    }
-
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $themes = $this->themeRepository->findAll();

src/Loader/CircularDependencyFoundException.php

@@ -20,7 +20,7 @@ final class CircularDependencyFoundException extends \DomainException
     /**
      * @param ThemeInterface[] $themes
      */
-    public function __construct(array $themes, ?\Exception $previous = null)
+    public function __construct(array $themes, ?\Throwable $previous = null)
     {
         $cycle = $this->getCycleFromArray($themes);
 

src/Translation/ThemeAwareTranslator.php

@@ -33,18 +33,15 @@ final class ThemeAwareTranslator implements TranslatorInterface, TranslatorBagIn
     public function __construct(TranslatorInterface $translator, ThemeContextInterface $themeContext)
     {
         foreach ([LocaleAwareInterface::class, TranslatorBagInterface::class] as $interface) {
-            /** @psalm-suppress DocblockTypeContradiction Better safe than sorry */
             if (!$translator instanceof $interface) {
-                /** @psalm-suppress NoValue Better safe than sorry */
                 throw new \InvalidArgumentException(sprintf(
                     'The translator "%s" must implement %s.',
-                    get_class($translator),
+                    $translator::class,
                     $interface,
                 ));
             }
         }
 
-        /** @psalm-suppress InvalidPropertyAssignmentValue */
         $this->translator = $translator;
         $this->themeContext = $themeContext;
     }
@@ -60,9 +57,6 @@ public function __call(string $method, array $arguments)
         return $translator->$method(...$arguments);
     }
 
-    /**
-     * @psalm-suppress MissingParamType Two interfaces defining the same method
-     */
     public function trans($id, array $parameters = [], $domain = null, $locale = null): string
     {
         return $this->translator->trans($id, $parameters, $domain, $this->transformLocale($locale));
@@ -101,10 +95,6 @@ public function getCatalogue($locale = null): MessageCatalogueInterface
         return $this->translator->getCatalogue($locale);
     }
 
-    /**
-     * @psalm-suppress MissingParamType
-     * @psalm-suppress MissingReturnType
-     */
     public function warmUp($cacheDir, ?string $buildDir = null): array
     {
         if ($this->translator instanceof WarmableInterface) {

src/Translation/Translator.php

@@ -28,10 +28,8 @@ final class Translator extends BaseTranslator implements WarmableInterface
         'debug' => false,
     ];
 
-    /** @psalm-suppress PropertyNotSetInConstructor It is set in the constructor though */
     private TranslatorLoaderProviderInterface $loaderProvider;
 
-    /** @psalm-suppress PropertyNotSetInConstructor It is set in the constructor though */
     private TranslatorResourceProviderInterface $resourceProvider;
 
     private bool $resourcesLoaded = false;
@@ -59,18 +57,13 @@ public function __construct(
         parent::__construct($locale, $this->provideMessageFormatter($messageFormatterOrSelector), $this->options['cache_dir'], $this->options['debug']);
     }
 
-    /**
-     * @psalm-suppress MissingParamType
-     * @psalm-suppress MissingReturnType
-     */
     public function warmUp($cacheDir, ?string $buildDir = null): array
     {
         // skip warmUp when translator doesn't use cache
         if (null === $this->options['cache_dir']) {
             return [];
         }
 
-        /** @psalm-suppress InternalMethod */
         $locales = array_merge(
             $this->getFallbackLocales(),
             [$this->getLocale()],
@@ -182,7 +175,6 @@ private function provideMessageFormatter($messageFormatterOrSelector): MessageFo
         if ($messageFormatterOrSelector instanceof MessageSelector) {
             @trigger_error(sprintf('Passing a "%s" instance into the "%s" as a third argument is deprecated since Sylius 1.2 and will be removed in 2.0. Inject a "%s" implementation instead.', MessageSelector::class, __METHOD__, MessageFormatterInterface::class), \E_USER_DEPRECATED);
 
-            /** @psalm-suppress InvalidArgument */
             return new MessageFormatter($this, $messageFormatterOrSelector);
         }
 
@@ -194,7 +186,7 @@ private function provideMessageFormatter($messageFormatterOrSelector): MessageFo
             'Expected an instance of "%s" or "%s", got "%s"!',
             MessageFormatterInterface::class,
             MessageSelector::class,
-            is_object($messageFormatterOrSelector) ? get_class($messageFormatterOrSelector) : gettype($messageFormatterOrSelector),
+            is_object($messageFormatterOrSelector) ? $messageFormatterOrSelector::class : gettype($messageFormatterOrSelector),
         ));
     }
 }

src/Twig/Loader/ThemedTemplateLoader.php

@@ -16,7 +16,6 @@
 use Sylius\Bundle\ThemeBundle\Context\ThemeContextInterface;
 use Sylius\Bundle\ThemeBundle\Twig\Locator\TemplateLocatorInterface;
 use Sylius\Bundle\ThemeBundle\Twig\Locator\TemplateNotFoundException;
-use Symfony\Component\Templating\TemplateReferenceInterface;
 use Twig\Loader\LoaderInterface as TwigLoaderInterface;
 use Twig\Source;
 
@@ -38,76 +37,52 @@ public function __construct(
         $this->themeContext = $themeContext;
     }
 
-    /**
-     * @param string|TemplateReferenceInterface $name
-     */
     public function getSourceContext($name): Source
     {
         try {
             $path = $this->locateTemplate($name);
 
-            /** @psalm-suppress RedundantCastGivenDocblockType */
             return new Source((string) file_get_contents($path), (string) $name, $path);
-        } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
-            /** @psalm-suppress PossiblyInvalidArgument */
+        } catch (TemplateNotFoundException $exception) {
             return $this->decoratedLoader->getSourceContext($name);
         }
     }
 
-    /**
-     * @param string|TemplateReferenceInterface $name
-     */
     public function getCacheKey($name): string
     {
         try {
             return $this->locateTemplate($name);
-        } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
-            /** @psalm-suppress PossiblyInvalidArgument */
+        } catch (TemplateNotFoundException $exception) {
             return $this->decoratedLoader->getCacheKey($name);
         }
     }
 
     /**
-     * @param string|TemplateReferenceInterface $name
      * @param int $time
      */
     public function isFresh($name, $time): bool
     {
         try {
             return filemtime($this->locateTemplate($name)) <= $time;
-        } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
-            /** @psalm-suppress PossiblyInvalidArgument */
+        } catch (TemplateNotFoundException $exception) {
             return $this->decoratedLoader->isFresh($name, $time);
         }
     }
 
-    /**
-     * @param string|TemplateReferenceInterface $name
-     */
     public function exists($name): bool
     {
         try {
             return stat($this->locateTemplate($name)) !== false;
-        } catch (TemplateNotFoundException | \InvalidArgumentException $exception) {
-            /** @psalm-suppress PossiblyInvalidArgument */
+        } catch (TemplateNotFoundException $exception) {
             return $this->decoratedLoader->exists($name);
         }
     }
 
     /**
-     * @psalm-assert string $template
-     *
-     * @param string|TemplateReferenceInterface $template
-     *
-     * @throws TemplateNotFoundException|\InvalidArgumentException
+     * @throws TemplateNotFoundException
      */
-    private function locateTemplate($template): string
+    private function locateTemplate(string $template): string
     {
-        if ($template instanceof TemplateReferenceInterface) {
-            // Symfony 4.x still pushes TemplateReferenceInterface to Twig loader (especially when warming up cache)
-            throw new \InvalidArgumentException(sprintf('Instances of "%s" are not supported.', TemplateReferenceInterface::class));
-        }
-
         $theme = $this->themeContext->getTheme();
 
         if ($theme === null) {