update: add support for Pimcore 11 (#30)

* update: add support for Pimcore 11

* update Pimcore requirement to ^10.5

* ci: remove PHP 8.2 + lowest from test matrix

.github/workflows/qa.yaml

@@ -22,7 +22,7 @@ jobs:
       - name: PHP Setup
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.1
+          php-version: 8.2
 
       - name: Validate composer.json
         run: composer validate --strict

.github/workflows/tests.yaml

@@ -20,9 +20,11 @@ jobs:
       matrix:
         include:
           - php-version: "8.1"
-            dependencies: "lowest"
+            dependencies: "lowest" # Pimcore 10.5.0
           - php-version: "8.1"
-            dependencies: "highest"
+            dependencies: "highest" # Pimcore 11.*
+          - php-version: "8.2"
+            dependencies: "highest" # Pimcore 11.*
 
     steps:
       - name: Git Checkout
@@ -38,5 +40,9 @@ jobs:
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
+      - name: Add Pimcore Admin UI
+        run: composer require --dev pimcore/admin-ui-classic-bundle --no-interaction
+        if: matrix.dependencies == 'highest'
+
       - name: Execute tests
         run: composer tests

.gitignore

@@ -2,13 +2,16 @@
 /composer.lock
 /vendor/
 
+# Docker Compose
+/compose.override.yaml
+
 # PHP-CS-Fixer
-.php-cs-fixer.cache
+/.php-cs-fixer.cache
 
 # PHPUnit
-.phpunit.result.cache
-/reports/
+/.phpunit.result.cache
 /.phpunit.cache/
+/reports/
 
 # Reveal JS
 /public/reveal.js-master/

compose.yaml

@@ -16,7 +16,7 @@ services:
       timeout: 10s
 
   php:
-    image: pimcore/pimcore:php8.1-v1.3
+    image: pimcore/pimcore:php8.2-latest
     volumes:
       - ./:/var/www/html/
     environment:

composer.json

@@ -18,14 +18,14 @@
     }
   },
   "require": {
-    "php": "~8.1",
-    "pimcore/pimcore": "^10.0",
-    "symfony/config": "^5.3",
-    "symfony/console": "^5.3",
-    "symfony/dependency-injection": "^5.3",
-    "symfony/event-dispatcher": "^5.2",
-    "symfony/finder": "^5.2",
-    "symfony/http-kernel": "^5.3"
+    "php": "~8.1.0 || ~8.2.0",
+    "pimcore/pimcore": "^10.5 || ^11.0",
+    "symfony/config": "^5.3 || ^6.0",
+    "symfony/console": "^5.3 || ^6.0",
+    "symfony/dependency-injection": "^5.3 || ^6.0",
+    "symfony/event-dispatcher": "^5.2 || ^6.0",
+    "symfony/finder": "^5.2 || ^6.0",
+    "symfony/http-kernel": "^5.3 || ^6.0"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.11",

config/services.yaml

@@ -1,19 +1,23 @@
 services:
-    _defaults:
-        autowire: true
-        autoconfigure: true
-        bind:
-            $revealJsPublicPath: '/bundles/neustapimcorepresentation/reveal.js-master'
+  _defaults:
+    autowire: true
+    autoconfigure: true
+    bind:
+      $revealJsPublicPath: '/bundles/neustapimcorepresentation/reveal.js-master'
 
-    Neusta\Pimcore\PresentationBundle\Controller\:
-        resource: '../src/Controller'
-        public: true
-        tags: ['controller.service_arguments']
+  Neusta\Pimcore\PresentationBundle\Controller\:
+    resource: '../src/Controller'
+    public: true
+    tags: [ 'controller.service_arguments' ]
 
-    Neusta\Pimcore\PresentationBundle\Renderer\SimplePresentationRenderer: ~
-    Neusta\Pimcore\PresentationBundle\Renderer\PresentationRenderer:
-        alias: Neusta\Pimcore\PresentationBundle\Renderer\SimplePresentationRenderer
-    Neusta\Pimcore\PresentationBundle\Renderer\SimpleSlideRenderer: ~
-    Neusta\Pimcore\PresentationBundle\Renderer\SlideRenderer:
-        alias: Neusta\Pimcore\PresentationBundle\Renderer\SimpleSlideRenderer
-    Neusta\Pimcore\PresentationBundle\Twig\PresentationExtension: ~
+  Neusta\Pimcore\PresentationBundle\EventListener\:
+    resource: '../src/EventListener'
+    tags: [ 'kernel.event_listener' ]
+
+  Neusta\Pimcore\PresentationBundle\Renderer\SimplePresentationRenderer: ~
+  Neusta\Pimcore\PresentationBundle\Renderer\PresentationRenderer:
+    alias: Neusta\Pimcore\PresentationBundle\Renderer\SimplePresentationRenderer
+  Neusta\Pimcore\PresentationBundle\Renderer\SimpleSlideRenderer: ~
+  Neusta\Pimcore\PresentationBundle\Renderer\SlideRenderer:
+    alias: Neusta\Pimcore\PresentationBundle\Renderer\SimpleSlideRenderer
+  Neusta\Pimcore\PresentationBundle\Twig\PresentationExtension: ~

src/EventListener/AdminAssetsListener.php

@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace Neusta\Pimcore\PresentationBundle\EventListener;
+
+use Pimcore\Event\BundleManager\PathsEvent;
+use Pimcore\Event\BundleManagerEvents;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class AdminAssetsListener implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            BundleManagerEvents::JS_PATHS => 'onJsPaths',
+        ];
+    }
+
+    public function onJsPaths(PathsEvent $event): void
+    {
+        $event->setPaths(array_merge($event->getPaths(), [
+            '/bundles/presentation/js/pimcore/startup.js',
+        ]));
+    }
+}

src/NeustaPimcorePresentationBundle.php

@@ -3,6 +3,7 @@
 namespace Neusta\Pimcore\PresentationBundle;
 
 use Pimcore\Extension\Bundle\AbstractPimcoreBundle;
+use Pimcore\Extension\Bundle\Installer\InstallerInterface;
 use Pimcore\Extension\Bundle\Traits\PackageVersionTrait;
 
 class NeustaPimcorePresentationBundle extends AbstractPimcoreBundle
@@ -14,14 +15,7 @@ public function getPath(): string
         return \dirname(__DIR__);
     }
 
-    public function getJsPaths()
-    {
-        return [
-            '/bundles/presentation/js/pimcore/startup.js',
-        ];
-    }
-
-    public function getInstaller()
+    public function getInstaller(): ?InstallerInterface
     {
         return new Installer();
     }

src/Renderer/SimpleSlideRenderer.php

@@ -15,7 +15,9 @@ public function renderSlide(Document $slide): string
     {
         $slideMarkup = $this->renderDocument($slide);
         foreach ($slide->getChildren() as $subSlide) {
-            $slideMarkup .= $this->renderSlide($subSlide);
+            if ($subSlide) {
+                $slideMarkup .= $this->renderSlide($subSlide);
+            }
         }
 
         return $slideMarkup;

tests/Renderer/SimplePresentationRendererTest.php

@@ -5,6 +5,7 @@
 use Neusta\Pimcore\PresentationBundle\Renderer\SimplePresentationRenderer;
 use Neusta\Pimcore\PresentationBundle\Renderer\SlideRenderer;
 use PHPUnit\Framework\TestCase;
+use Pimcore\Model\Document\Listing;
 use Pimcore\Model\Document\PageSnippet;
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -32,9 +33,11 @@ protected function setUp(): void
     public function renderPresentationWithoutSlidesRendersNothing(): void
     {
         $presentation = $this->prophesize(PageSnippet::class);
+        $documentListing = new Listing();
+        $documentListing->setData([]);
         $presentation
             ->getChildren()
-            ->willReturn([]);
+            ->willReturn($documentListing);
 
         $renderedPresentation = $this->presentationRenderer->renderPresentation($presentation->reveal());
 
@@ -53,12 +56,11 @@ public function eachSlideOfPresentationIsForwardedToSlideRenderer(): void
         $slide2 = $this->createSlideMock();
 
         $presentation = $this->prophesize(PageSnippet::class);
+        $documentListing = new Listing();
+        $documentListing->setData([$slide1, $slide2]);
         $presentation
             ->getChildren()
-            ->willReturn([
-                $slide1,
-                $slide2,
-            ]);
+            ->willReturn($documentListing);
 
         $this->slideRenderer
             ->renderSlide($slide1)