Fix compatibility to JMS Serializer 5, remove ContainerAwareInterface…

… usage and define requirement better (#91) * Add requirement to doctrine orm * Do not install phpstan and php-cs-fixer for tests * Fix jms serializer compatibility * Fix PHPStan issues * Fix code style * Fix phpstan baseline
sulu · Jun 6, 2024 · 1166ef2 · 1166ef2
1 parent 8ecc5e7
commit 1166ef2
Show file tree

Hide file tree

Showing 40 changed files with 178 additions and 516 deletions.
diff --git a/.github/workflows/test-application.yaml b/.github/workflows/test-application.yaml
@@ -43,6 +43,20 @@ jobs:
                       env:
                           SYMFONY_DEPRECATIONS_HELPER: weak
 
+                    - php-version: '8.2'
+                      dependency-versions: 'highest'
+                      php-extensions: 'mysql, imagick'
+                      tools: 'composer:v2'
+                      env:
+                          SYMFONY_DEPRECATIONS_HELPER: weak
+
+                    - php-version: '8.3'
+                      dependency-versions: 'highest'
+                      php-extensions: 'mysql, imagick'
+                      tools: 'composer:v2'
+                      env:
+                          SYMFONY_DEPRECATIONS_HELPER: weak
+
         services:
             mysql:
                 image: 'mysql:5.7'
@@ -65,6 +79,9 @@ jobs:
                   tools: '${{ matrix.tools }}'
                   coverage: none
 
+            - name: Remove not required tooling for tests
+              run: composer remove php-cs-fixer/shim "*phpstan*" --dev
+
             - name: Install composer dependencies
               uses: ramsey/composer-install@v1
               with:

diff --git a/Admin/RedirectAdmin.php b/Admin/RedirectAdmin.php
@@ -134,9 +134,6 @@ public function configureViews(ViewCollection $viewCollection): void
         );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSecurityContexts()
     {
         return [

diff --git a/Command/ImportCommand.php b/Command/ImportCommand.php
@@ -35,9 +35,6 @@ public function __construct(FileImport $import)
         $this->import = $import;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function configure(): void
     {
         $this->addArgument('fileName', InputArgument::REQUIRED)
@@ -49,9 +46,6 @@ public function configure(): void
             );
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function execute(InputInterface $input, OutputInterface $output)
     {
         $progressBar = new ProgressBar($output);

diff --git a/Controller/RedirectRouteImportController.php b/Controller/RedirectRouteImportController.php
@@ -14,6 +14,7 @@
 use Sulu\Bundle\RedirectBundle\Admin\RedirectAdmin;
 use Sulu\Bundle\RedirectBundle\Import\Converter\ConverterNotFoundException;
 use Sulu\Bundle\RedirectBundle\Import\FileImportInterface;
+use Sulu\Bundle\RedirectBundle\Import\ImportException;
 use Sulu\Bundle\RedirectBundle\Import\Item;
 use Sulu\Bundle\RedirectBundle\Import\Reader\ReaderNotFoundException;
 use Sulu\Component\Security\SecuredControllerInterface;
@@ -47,17 +48,11 @@ public function __construct(FileImportInterface $import, $importPath)
         $this->importPath = $importPath;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSecurityContext(): string
     {
         return RedirectAdmin::SECURITY_CONTEXT;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getLocale(Request $request)
     {
         return $request->get('locale', null);
@@ -94,7 +89,15 @@ public function postAction(Request $request)
     /**
      * Import given file and returns serializable response.
      *
-     * @return array
+     * @return array{
+     *     fileName: string,
+     *     total: int,
+     *     exceptions: array<array{
+     *         exception: null|ImportException,
+     *         lineNumber: int,
+     *         lineContent: string,
+     *     }>,
+     * }
      */
     private function importFile(File $file)
     {

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -21,9 +21,6 @@
  */
 class Configuration implements ConfigurationInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder('sulu_redirect');

diff --git a/DependencyInjection/SuluRedirectExtension.php b/DependencyInjection/SuluRedirectExtension.php
@@ -28,9 +28,6 @@ class SuluRedirectExtension extends Extension implements PrependExtensionInterfa
 {
     use PersistenceExtensionTrait;
 
-    /**
-     * {@inheritdoc}
-     */
     public function prepend(ContainerBuilder $container): void
     {
         if ($container->hasExtension('jms_serializer')) {
@@ -91,9 +88,6 @@ public function prepend(ContainerBuilder $container): void
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();

diff --git a/Entity/RedirectRoute.php b/Entity/RedirectRoute.php
@@ -52,107 +52,71 @@ class RedirectRoute implements RedirectRouteInterface, AuditableInterface
      */
     protected $target;
 
-    /**
-     * {@inheritdoc}
-     */
     public function getId()
     {
         return $this->id;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setId($id)
     {
         $this->id = $id;
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function isEnabled()
     {
         return $this->enabled;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setEnabled($enabled)
     {
         $this->enabled = $enabled;
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getStatusCode()
     {
         return $this->statusCode;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setStatusCode($statusCode)
     {
         $this->statusCode = $statusCode;
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSource()
     {
         return $this->source;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setSource($source)
     {
         $this->source = mb_strtolower('/' . ltrim($source, '/'));
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSourceHost()
     {
         return $this->sourceHost;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setSourceHost($sourceHost)
     {
         $this->sourceHost = empty($sourceHost) ? null : mb_strtolower($sourceHost);
 
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getTarget()
     {
         return $this->target;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setTarget($target)
     {
         $this->target = $target;

diff --git a/Entity/RedirectRouteRepository.php b/Entity/RedirectRouteRepository.php
@@ -21,9 +21,6 @@
  */
 class RedirectRouteRepository extends EntityRepository implements RedirectRouteRepositoryInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function findById($id)
     {
         /** @var RedirectRouteInterface|null $redirectRoute */
@@ -32,9 +29,6 @@ public function findById($id)
         return $redirectRoute;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function findEnabledBySource($source, $sourceHost = null)
     {
         $queryBuilder = $this->createFindBySourceQueryBuilder($source, $sourceHost);
@@ -43,27 +37,18 @@ public function findEnabledBySource($source, $sourceHost = null)
         return $queryBuilder->getQuery()->getOneOrNullResult();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function findBySource($source, $sourceHost = null)
     {
         $queryBuilder = $this->createFindBySourceQueryBuilder($source, $sourceHost);
 
         return $queryBuilder->getQuery()->getOneOrNullResult();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function persist(RedirectRouteInterface $entity): void
     {
         $this->_em->persist($entity);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function remove(RedirectRouteInterface $entity): void
     {
         $this->_em->remove($entity);

diff --git a/GoneSubscriber/GoneDocumentSubscriber.php b/GoneSubscriber/GoneDocumentSubscriber.php
@@ -25,6 +25,8 @@
 
 /**
  * This gone subscriber listens for removed pages.
+ *
+ * @internal this is a internal listener which should not be used directly
  */
 class GoneDocumentSubscriber implements EventSubscriberInterface
 {
@@ -77,9 +79,6 @@ public function __construct(
         $this->environment = $environment;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents()
     {
         return [
@@ -113,7 +112,7 @@ public function createRedirects(RemoveEvent $event): void
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     protected function getUrls(BasePageDocument $document)
     {
@@ -166,7 +165,7 @@ protected function getUrls(BasePageDocument $document)
      * @param string $webspaceKey
      * @param string $locale
      *
-     * @return array
+     * @return string[]
      */
     protected function getHistoryUrls(
         ResourceLocatorStrategyInterface $resourceLocatorStrategy,

diff --git a/GoneSubscriber/GoneEntitySubscriber.php b/GoneSubscriber/GoneEntitySubscriber.php
@@ -16,21 +16,31 @@
 use Doctrine\ORM\Events;
 use Sulu\Bundle\RedirectBundle\Entity\RedirectRoute;
 use Sulu\Bundle\RedirectBundle\Exception\RedirectRouteNotUniqueException;
-use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManager;
+use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManagerInterface;
 use Sulu\Bundle\RouteBundle\Model\RouteInterface;
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 
 /**
  * This gone subscriber listens for removed route entities.
+ *
+ * @internal this is a internal listener which should not be used directly
  */
 class GoneEntitySubscriber implements EventSubscriber, ContainerAwareInterface
 {
     use ContainerAwareTrait;
 
     /**
-     * {@inheritdoc}
+     * @var RedirectRouteManagerInterface
      */
+    private $redirectRouteManager;
+
+    public function __construct(
+        RedirectRouteManagerInterface $redirectRouteManager
+    ) {
+        $this->redirectRouteManager = $redirectRouteManager;
+    }
+
     public function getSubscribedEvents()
     {
         return [
@@ -42,8 +52,7 @@ public function preRemove(LifecycleEventArgs $event): void
     {
         $route = $event->getObject();
 
-        $routeManager = $this->getRedirectRouteManager();
-        if (!$route instanceof RouteInterface || null === $routeManager) {
+        if (!$route instanceof RouteInterface) {
             return;
         }
 
@@ -53,21 +62,9 @@ public function preRemove(LifecycleEventArgs $event): void
         $redirectRoute->setSource($route->getPath());
 
         try {
-            $routeManager->save($redirectRoute);
+            $this->redirectRouteManager->save($redirectRoute);
         } catch (RedirectRouteNotUniqueException $exception) {
             // do nothing when there already exists a redirect route
         }
     }
-
-    /**
-     * @return RedirectRouteManager|null
-     */
-    private function getRedirectRouteManager()
-    {
-        if (null === $this->container) {
-            return null;
-        }
-
-        return $this->container->get('sulu_redirect.redirect_route_manager');
-    }
 }