feat(areabrick-overview): display template location for all bricks (#34)

.github/workflows/qa.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
   workflow_dispatch:
 
 permissions:

.github/workflows/tests.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "main" ]
   workflow_dispatch:
 
 permissions:
@@ -23,8 +22,10 @@ jobs:
             dependencies: "lowest"
           - php-version: "8.1"
             dependencies: "highest"
+            tests: --fail-on-risky
           - php-version: "8.2"
             dependencies: "highest"
+            tests: --fail-on-risky
 
     steps:
       - name: Git Checkout
@@ -40,5 +41,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
+        run: composer tests -- ${{ matrix.tests }}

composer.json

@@ -32,6 +32,7 @@
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.62",
     "jangregor/phpstan-prophecy": "^1.0.2",
+    "laminas/laminas-zendframework-bridge": "^1.8",
     "phpspec/prophecy-phpunit": "^2.2",
     "phpstan/phpstan": "^1.11.10",
     "phpstan/phpstan-phpunit": "^1.4",
@@ -52,6 +53,9 @@
     }
   },
   "autoload-dev": {
+    "classmap": [
+      "tests/app/TestKernel.php"
+    ],
     "psr-4": {
       "Neusta\\Pimcore\\AreabrickConfigBundle\\Tests\\": "tests/"
     }

config/pimcore/config.yaml

@@ -7,13 +7,13 @@ neusta_converter:
     neusta_pimcore_areabrick_config.brick.converter:
       target: Neusta\Pimcore\AreabrickConfigBundle\Bricks\Model\Brick
       populators:
+        - Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator\BrickTemplateLocationPopulator
         - Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator\BrickPagePopulator
       properties:
         id: ~
         name: ~
         version: ~
         description: ~
-        template: ~
 
     neusta_pimcore_areabrick_config.page.converter:
       target: Neusta\Pimcore\AreabrickConfigBundle\Bricks\Model\Page

config/services.yaml

@@ -8,7 +8,7 @@ services:
       $brickConverter: '@neusta_pimcore_areabrick_config.brick.converter'
     tags: [ 'controller.service_arguments' ]
 
-  Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator\BrickPageEditModeUrlPopulator: ~
+  Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator\BrickTemplateLocationPopulator: ~
 
   Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator\BrickPagePopulator:
     arguments:

phpunit.xml.dist

@@ -8,7 +8,6 @@
     bootstrap="tests/bootstrap.php"
     cacheResultFile=".phpunit.cache/test-results"
     colors="true"
-    failOnRisky="true"
     failOnWarning="true"
 >
     <php>

src/Bricks/Populator/BrickTemplateLocationPopulator.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator;
+
+use Neusta\ConverterBundle\Converter\Context\GenericContext;
+use Neusta\ConverterBundle\Populator;
+use Neusta\Pimcore\AreabrickConfigBundle\Bricks\Model\Brick;
+use Pimcore\Document\Editable\EditableHandler;
+use Pimcore\Extension\Document\Areabrick\AbstractAreabrick;
+
+/**
+ * @implements Populator<AbstractAreabrick, Brick, GenericContext>
+ */
+final class BrickTemplateLocationPopulator implements Populator
+{
+    private readonly \Closure $resolveTemplate;
+
+    public function __construct(EditableHandler $editableHandler)
+    {
+        $this->resolveTemplate = (new \ReflectionMethod($editableHandler, 'resolveBrickTemplate'))->getClosure($editableHandler);
+    }
+
+    public function populate(object $target, object $source, ?object $ctx = null): void
+    {
+        // Todo: remove the second parameter when Pimcore 10 support is dropped
+        $target->template = ($this->resolveTemplate)($source, 'view');
+    }
+}

tests/Integration/Bricks/Populator/BrickTemplateLocationPopulatorTest.php

@@ -0,0 +1,42 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\AreabrickConfigBundle\Tests\Integration\Bricks\Populator;
+
+use Neusta\Pimcore\AreabrickConfigBundle\Bricks\Model\Brick;
+use Neusta\Pimcore\AreabrickConfigBundle\Bricks\Populator\BrickTemplateLocationPopulator;
+use Pimcore\Extension\Document\Areabrick\AreabrickManagerInterface;
+use Pimcore\Test\KernelTestCase;
+
+final class BrickTemplateLocationPopulatorTest extends KernelTestCase
+{
+    /**
+     * @test
+     */
+    public function itPopulatesCustomTemplates(): void
+    {
+        $container = self::getContainer();
+        $populator = $container->get(BrickTemplateLocationPopulator::class);
+        $source = $container->get(AreabrickManagerInterface::class)->getBrick('custom-template');
+        $target = new Brick();
+
+        $populator->populate($target, $source);
+
+        self::assertSame('custom-template-areabrick/index.html.twig', $target->template);
+    }
+
+    /**
+     * @test
+     */
+    public function itPopulatesDefaultTemplateLocations(): void
+    {
+        $container = self::getContainer();
+        $populator = $container->get(BrickTemplateLocationPopulator::class);
+        $source = $container->get(AreabrickManagerInterface::class)->getBrick('global-template-location');
+        $target = new Brick();
+
+        $populator->populate($target, $source);
+
+        self::assertSame('areas/global-template-location/view.html.twig', $target->template);
+    }
+}

tests/app/config/services.yaml

@@ -0,0 +1,8 @@
+services:
+  Neusta\Pimcore\AreabrickConfigBundle\Tests\app\src\Document\Areabrick\CustomTemplate:
+    tags:
+      - { name: pimcore.area.brick, id: custom-template }
+
+  Neusta\Pimcore\AreabrickConfigBundle\Tests\app\src\Document\Areabrick\GlobalTemplateLocation:
+    tags:
+      - { name: pimcore.area.brick, id: global-template-location }

tests/app/src/Document/Areabrick/CustomTemplate.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\AreabrickConfigBundle\Tests\app\src\Document\Areabrick;
+
+use Pimcore\Extension\Document\Areabrick\AbstractAreabrick;
+
+final class CustomTemplate extends AbstractAreabrick
+{
+    public function getTemplate(): ?string
+    {
+        return 'custom-template-areabrick/index.html.twig';
+    }
+
+    public function getTemplateLocation(): string
+    {
+        return '';
+    }
+
+    public function getTemplateSuffix(): string
+    {
+        return '';
+    }
+}

tests/app/src/Document/Areabrick/GlobalTemplateLocation.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\AreabrickConfigBundle\Tests\app\src\Document\Areabrick;
+
+use Pimcore\Extension\Document\Areabrick\AbstractAreabrick;
+
+final class GlobalTemplateLocation extends AbstractAreabrick
+{
+    public function getTemplate(): ?string
+    {
+        return null;
+    }
+
+    public function getTemplateLocation(): string
+    {
+        return self::TEMPLATE_LOCATION_GLOBAL;
+    }
+
+    public function getTemplateSuffix(): string
+    {
+        return self::TEMPLATE_SUFFIX_TWIG;
+    }
+}

tests/app/templates/areas/global-template-location/view.html.twig

@@ -0,0 +1 @@
+Global Template Location Areabrick

tests/app/templates/custom-template-areabrick/index.html

@@ -0,0 +1 @@
+Custom Template Areabrick