NGSTACK-1000 upgrade bundle to ibexa v5

.github/workflows/tests.yml

@@ -15,15 +15,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.1']
-        symfony: ['~5.4.0']
+        php: ['8.3']
+        symfony: ['~7.3.0']
         phpunit: ['phpunit.xml']
         deps: ['normal']
-        include:
-          - php: '8.1'
-            symfony: '~5.4.0'
-            phpunit: 'phpunit.xml'
-            deps: 'low'
 
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -4,3 +4,4 @@ vendor
 composer.lock
 .idea
 build
+.phpunit.cache

.php-cs-fixer.php

@@ -29,6 +29,7 @@
         'single_line_comment_style' => false,
         'trailing_comma_in_multiline' => ['elements' => ['arrays', 'arguments', 'match', 'parameters']],
         'yoda_style' => false,
+        'fully_qualified_strict_types' => false,
 
         // Additional rules
         'date_time_immutable' => true,
@@ -39,7 +40,7 @@
             'import_functions' => true,
         ],
         'heredoc_indentation' => ['indentation' => 'same_as_start'],
-        'mb_str_functions' => true,
+        // 'mb_str_functions' => true,
         'native_constant_invocation' => true,
         'nullable_type_declaration_for_default_null_value' => true,
         'static_lambda' => true,

bundle/Handler/FieldType/Handler.php

@@ -15,12 +15,9 @@
 
 abstract class Handler extends BaseHandler
 {
-    protected FieldHelper $fieldHelper;
-
-    public function __construct(FieldHelper $fieldHelper)
-    {
-        $this->fieldHelper = $fieldHelper;
-    }
+    public function __construct(
+        protected FieldHelper $fieldHelper,
+    ) {}
 
     public function getMetaTags(string $tagName, array $params = []): array
     {

bundle/Handler/FieldType/Image.php

@@ -17,27 +17,19 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 
 use function ltrim;
-use function mb_strpos;
+use function str_starts_with;
 
 final class Image extends Handler
 {
-    private VariationHandler $imageVariationService;
-
-    private RequestStack $requestStack;
-
-    private LoggerInterface $logger;
-
     public function __construct(
         FieldHelper $fieldHelper,
-        VariationHandler $imageVariationService,
-        RequestStack $requestStack,
-        ?LoggerInterface $logger = null,
+        private readonly VariationHandler $imageVariationService,
+        private readonly RequestStack $requestStack,
+        private ?LoggerInterface $logger = null,
     ) {
         parent::__construct($fieldHelper);
 
-        $this->imageVariationService = $imageVariationService;
-        $this->requestStack = $requestStack;
-        $this->logger = $logger ?? new NullLogger();
+        $this->logger ??= new NullLogger();
     }
 
     protected function getFieldValue(Field $field, string $tagName, array $params = []): string
@@ -48,7 +40,7 @@ protected function getFieldValue(Field $field, string $tagName, array $params =
             try {
                 $variationUri = $this->imageVariationService->getVariation($field, $this->content->getVersionInfo(), $variationName)->uri;
 
-                if (mb_strpos($variationUri, '/') === 0 && ($request = $this->requestStack->getCurrentRequest()) !== null) {
+                if (str_starts_with($variationUri, '/') && ($request = $this->requestStack->getCurrentRequest()) !== null) {
                     $variationUri = $request->getUriForPath('/' . ltrim($variationUri, '/'));
                 }
 

bundle/Handler/Literal/CanonicalUrl.php

@@ -15,15 +15,10 @@
 
 final class CanonicalUrl implements HandlerInterface
 {
-    private RequestStack $requestStack;
-
-    private UrlGeneratorInterface $urlGenerator;
-
-    public function __construct(RequestStack $requestStack, UrlGeneratorInterface $urlGenerator)
-    {
-        $this->requestStack = $requestStack;
-        $this->urlGenerator = $urlGenerator;
-    }
+    public function __construct(
+        private readonly RequestStack $requestStack,
+        private readonly UrlGeneratorInterface $urlGenerator,
+    ) {}
 
     public function getMetaTags($tagName, array $params = []): array
     {

bundle/Handler/Literal/Url.php

@@ -15,12 +15,9 @@
 
 final class Url implements HandlerInterface
 {
-    private RequestStack $requestStack;
-
-    public function __construct(RequestStack $requestStack)
-    {
-        $this->requestStack = $requestStack;
-    }
+    public function __construct(
+        private readonly RequestStack $requestStack,
+    ) {}
 
     public function getMetaTags(string $tagName, array $params = []): array
     {

bundle/MetaTag/Collector.php

@@ -16,31 +16,24 @@
 
 final class Collector implements CollectorInterface
 {
-    private Registry $metaTagHandlers;
-
-    private ContentTypeService $contentTypeService;
-
-    private ConfigResolverInterface $configResolver;
-
-    public function __construct(Registry $metaTagHandlers, ContentTypeService $contentTypeService, ConfigResolverInterface $configResolver)
-    {
-        $this->metaTagHandlers = $metaTagHandlers;
-        $this->contentTypeService = $contentTypeService;
-        $this->configResolver = $configResolver;
-    }
+    public function __construct(
+        private readonly Registry $metaTagHandlers,
+        private readonly ContentTypeService $contentTypeService,
+        private readonly ConfigResolverInterface $configResolver,
+    ) {}
 
     public function collect(Content $content): array
     {
         $metaTags = [];
 
-        $allHandlers = $this->configResolver->hasParameter('global_handlers', 'netgen_open_graph') ?
-            $this->configResolver->getParameter('global_handlers', 'netgen_open_graph') :
-            [];
+        $allHandlers = $this->configResolver->hasParameter('global_handlers', 'netgen_open_graph')
+            ? $this->configResolver->getParameter('global_handlers', 'netgen_open_graph')
+            : [];
 
         $contentType = $this->contentTypeService->loadContentType($content->contentInfo->contentTypeId);
-        $contentTypeHandlers = $this->configResolver->hasParameter('content_type_handlers', 'netgen_open_graph') ?
-            $this->configResolver->getParameter('content_type_handlers', 'netgen_open_graph') :
-            [];
+        $contentTypeHandlers = $this->configResolver->hasParameter('content_type_handlers', 'netgen_open_graph')
+            ? $this->configResolver->getParameter('content_type_handlers', 'netgen_open_graph')
+            : [];
 
         if (isset($contentTypeHandlers[$contentType->identifier])) {
             $allHandlers = array_merge(
@@ -61,8 +54,8 @@ public function collect(Content $content): array
             foreach ($newMetaTags as $metaTag) {
                 if (!$metaTag instanceof Item) {
                     throw new LogicException(
-                        '\'' . $handler['handler'] . '\' handler returned wrong value.' .
-                        ' Expected \'Netgen\Bundle\OpenGraphBundle\MetaTag\Item\', got \'' . get_class($metaTag) . '\'.',
+                        '\'' . $handler['handler'] . '\' handler returned wrong value.'
+                        . ' Expected \'Netgen\Bundle\OpenGraphBundle\MetaTag\Item\', got \'' . get_class($metaTag) . '\'.',
                     );
                 }
 

bundle/MetaTag/Item.php

@@ -6,15 +6,10 @@
 
 final class Item
 {
-    private string $tagName;
-
-    private string $tagValue;
-
-    public function __construct(string $tagName, string $tagValue)
-    {
-        $this->tagName = $tagName;
-        $this->tagValue = $tagValue;
-    }
+    public function __construct(
+        private readonly string $tagName,
+        private readonly string $tagValue,
+    ) {}
 
     /**
      * Returns tag name.

bundle/Templating/Twig/Extension/NetgenOpenGraphRuntime.php

@@ -13,26 +13,18 @@
 
 final class NetgenOpenGraphRuntime
 {
-    private CollectorInterface $tagCollector;
-
-    private RendererInterface $tagRenderer;
-
-    private LoggerInterface $logger;
-
     private bool $throwExceptions = true;
 
     public function __construct(
-        CollectorInterface $tagCollector,
-        RendererInterface $tagRenderer,
-        ?LoggerInterface $logger = null,
+        private readonly CollectorInterface $tagCollector,
+        private readonly RendererInterface $tagRenderer,
+        private ?LoggerInterface $logger = null,
     ) {
-        $this->tagCollector = $tagCollector;
-        $this->tagRenderer = $tagRenderer;
-        $this->logger = $logger ?? new NullLogger();
+        $this->logger ??= new NullLogger();
     }
 
     /**
-     * Sets the flag that determines if the exceptions will thrown instead of logged.
+     * Sets the flag that determines if the exceptions will be thrown instead of logged.
      */
     public function setThrowExceptions(bool $throwExceptions = true): void
     {

composer.json

@@ -18,15 +18,15 @@
         }
     ],
     "require": {
-        "php": "^8.1",
-        "ibexa/core": "^4.4",
+        "php": "^8.3",
+        "ibexa/core": "^5.0",
         "twig/twig": "^3.0"
     },
     "require-dev": {
-        "ibexa/fieldtype-richtext": "^4.4",
-        "phpunit/phpunit": "^9.6",
-        "matthiasnoback/symfony-config-test": "^5.0",
-        "matthiasnoback/symfony-dependency-injection-test": "^5.0"
+        "ibexa/fieldtype-richtext": "^5.0",
+        "phpunit/phpunit": "^10.0",
+        "matthiasnoback/symfony-config-test": "^6.0",
+        "matthiasnoback/symfony-dependency-injection-test": "^6.0"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

phpunit.xml

@@ -1,12 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.4/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
          backupGlobals="false"
-         backupStaticAttributes="false"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
          colors="true"
-         verbose="true"
          processIsolation="false"
          stopOnFailure="false"
 >
@@ -15,18 +13,17 @@
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
+
+    <source>
+        <include>
             <directory suffix=".php">bundle</directory>
-            <exclude>
-                <directory>bundle/Resources</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+        </include>
+        <exclude>
+            <directory>bundle/Resources</directory>
+        </exclude>
+    </source>
+
     <logging>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
+        <junit outputFile="build/report.junit.xml"/>
     </logging>
 </phpunit>

tests/DependencyInjection/NetgenOpenGraphExtensionTest.php

@@ -6,12 +6,11 @@
 
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
 use Netgen\Bundle\OpenGraphBundle\DependencyInjection\NetgenOpenGraphExtension;
+use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 
 final class NetgenOpenGraphExtensionTest extends AbstractExtensionTestCase
 {
-    /**
-     * @doesNotPerformAssertions
-     */
+    #[DoesNotPerformAssertions]
     public function testItSetsValidContainerParameters(): void
     {
         $this->container->setParameter('ibexa.site_access.list', []);

tests/Handler/FieldType/ImageTest.php

@@ -129,12 +129,23 @@ public function testGettingTagsWithExceptionThrownByVariationHandler(): void
             ->method('getField')
             ->willReturn($this->field);
 
+        $this->fieldHelper->expects(self::once())
+            ->method('isFieldEmpty')
+            ->willReturn(false);
+
+        $this->variationHandler->expects(self::once())
+            ->method('getVariation')
+            ->willThrowException(new \Exception('Variation handler error'));
+
         $request = Request::create('/');
 
         $this->requestStack->expects(self::once())
             ->method('getCurrentRequest')
             ->willReturn($request);
 
+        $this->logger->expects(self::once())
+            ->method('error');
+
         $this->image->getMetaTags('some_tag', ['some_value', 'some_value_2', 'some_value_3']);
     }
 
@@ -221,6 +232,27 @@ public function testGettingTagsWithMultipleArgumentsInArray(): void
             ->method('getField')
             ->willReturn($this->field);
 
-        $this->image->getMetaTags('some_tag', ['some_value', 'some_value_2']);
+        $this->fieldHelper->expects(self::once())
+            ->method('isFieldEmpty')
+            ->willReturn(false);
+
+        $variation = new Variation(['uri' => '/some/uri']);
+
+        $this->variationHandler->expects(self::once())
+            ->method('getVariation')
+            ->willReturn($variation);
+
+        $request = Request::create('/');
+
+        $this->requestStack->expects(self::exactly(1))
+            ->method('getCurrentRequest')
+            ->willReturn($request);
+
+        $result = $this->image->getMetaTags('some_tag', ['some_value', 'some_value_2']);
+
+        self::assertCount(1, $result);
+        self::assertInstanceOf('Netgen\Bundle\OpenGraphBundle\MetaTag\Item', $result[0]);
+        self::assertSame('some_tag', $result[0]->getTagName());
+        self::assertSame('http://localhost/some/uri', $result[0]->getTagValue());
     }
 }