!!! FEATURE: Refactor for usage beyond fusion especially CPX

.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: build
+
+on:
+  push:
+      branches:
+        - 'main'
+  pull_request: ~
+
+jobs:
+    test:
+        name: "Test (PHP ${{ matrix.php-versions }}, Neos ${{ matrix.neos-versions }})"
+
+        strategy:
+            fail-fast: false
+            matrix:
+                php-versions: ['8.0', '8.1', '8.2', '8.3']
+                neos-versions: ['8.3']
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+              with:
+                  path: ${{ env.FLOW_FOLDER }}
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php-versions }}
+                  extensions: mbstring, xml, json, zlib, iconv, intl, pdo_sqlite
+                  ini-values: date.timezone="Africa/Tunis", opcache.fast_shutdown=0, apc.enable_cli=on
+
+            - name: Set Neos Version
+              run: composer require neos/neos ^${{ matrix.neos-versions }} --no-progress --no-interaction
+
+            - name: Run Tests
+              run: composer test

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
 .idea
 npm-debug.log
+composer.lock
+Packages
+vendor

Classes/Aspects/FusionCachingAspect.php

@@ -1,5 +1,28 @@
 <?php
-namespace Sitegeist\Monocle\Aspects;
+
+/**
+ * This file is part of the Sitegeist.Monocle package
+ *
+ * (c) 2020
+ * Martin Ficzel <ficzel@sitegeist.de>
+ * Wilhelm Behncke <behncke@sitegeist.de>
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+/**
+ * This file is part of the Sitegeist.Monocle package
+ *
+ * (c) 2020
+ * Martin Ficzel <ficzel@sitegeist.de>
+ * Wilhelm Behncke <behncke@sitegeist.de>
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
 
 /**
  * This file is part of the Sitegeist.Monocle package
@@ -13,6 +36,8 @@
  * source code.
  */
 
+namespace Sitegeist\Monocle\Aspects;
+
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Aop\JoinPointInterface;
 use Neos\Cache\Frontend\VariableFrontend;
@@ -38,7 +63,7 @@ class FusionCachingAspect
     public function cacheFusionConfigurationForPackageKey(JoinPointInterface $joinPoint)
     {
         $packageKey = $joinPoint->getMethodArgument('packageKey');
-        $cacheIdentifier = str_replace('.', '_', $packageKey);
+        $cacheIdentifier = str_replace(['.', ':'], '_', $packageKey);
 
         if ($this->fusionCache->has($cacheIdentifier)) {
             $fusionConfigurationArray = $this->fusionCache->get($cacheIdentifier);

Classes/Command/StyleguideCommandController.php

@@ -1,5 +1,28 @@
 <?php
-namespace Sitegeist\Monocle\Command;
+
+/**
+ * This file is part of the Sitegeist.Monocle package
+ *
+ * (c) 2020
+ * Martin Ficzel <ficzel@sitegeist.de>
+ * Wilhelm Behncke <behncke@sitegeist.de>
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+/**
+ * This file is part of the Sitegeist.Monocle package
+ *
+ * (c) 2020
+ * Martin Ficzel <ficzel@sitegeist.de>
+ * Wilhelm Behncke <behncke@sitegeist.de>
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
 
 /**
  * This file is part of the Sitegeist.Monocle package
@@ -13,8 +36,15 @@
  * source code.
  */
 
+namespace Sitegeist\Monocle\Command;
+
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
+use Sitegeist\Monocle\Domain\PrototypeDetails\PropSets\PropSetName;
+use Sitegeist\Monocle\Domain\PrototypeDetails\UseCases\UseCaseName;
+use Sitegeist\Monocle\Domain\StyleguideAddress;
+use Sitegeist\Monocle\Domain\StyleguideObjects\StyleguideObjectIdentifier;
+use Sitegeist\Monocle\Domain\StyleguideRepository;
 use Sitegeist\Monocle\Fusion\FusionService;
 use Sitegeist\Monocle\Fusion\FusionView;
 use Neos\Flow\Annotations as Flow;
@@ -30,102 +60,76 @@
  */
 class StyleguideCommandController extends CommandController
 {
-    use DummyControllerContextTrait, PackageKeyTrait;
+    #[Flow\Inject]
+    protected StyleguideRepository $styleguideRepository;
 
-    /**
-     * @Flow\Inject
-     * @var FusionService
-     */
-    protected $fusionService;
+    #[Flow\Inject]
+    protected ConfigurationService $configurationService;
 
     /**
-     * @Flow\Inject
-     * @var ConfigurationService
+     * Get a list of all available styleguides
+     *
+     * @param string $format Result encoding ``yaml`` and ``json`` are supported
      */
-    protected $configurationService;
+    public function listCommand($format = 'json'): void
+    {
+        $styleguides = $this->styleguideRepository->getAllStyleGuides();
+
+        $data = [];
+        foreach ($styleguides as $styleguide) {
+            $data[$styleguide->address->toString()] = $styleguide->name->value;
+        }
+        $this->outputData($data, $format);
+    }
 
     /**
      * Get a list of all configured default styleguide viewports
      *
      * @param string $format Result encoding ``yaml`` and ``json`` are supported
-     * @param string $packageKey site-package (defaults to first found)
+     * @param string $styleguide site-package (defaults to first found)
      */
-    public function viewportsCommand($format = 'json', $packageKey = null)
+    public function viewportsCommand(string $format = 'json', ?string $styleguide = null): void
     {
-        $sitePackageKey = $packageKey ?: $this->getDefaultSitePackageKey();
-        $viewportPresets = $this->configurationService->getSiteConfiguration($sitePackageKey, 'ui.viewportPresets');
+        $styleguide =  $styleguide ? $this->styleguideRepository->getStyleGuide(StyleguideAddress::fromString($styleguide)) : $this->styleguideRepository->getDefault();
+        $viewportPresets = $this->configurationService->getSiteConfiguration($styleguide->address->toString(), 'ui.viewportPresets');
         $this->outputData($viewportPresets, $format);
     }
 
     /**
      * Get all styleguide items currently available
      *
      * @param string $format Result encoding ``yaml`` and ``json`` are supported
-     * @param string $packageKey site-package (defaults to first found)
+     * @param string $styleguide site-package (defaults to first found)
      */
-    public function itemsCommand($format = 'json', $packageKey = null)
+    public function itemsCommand(string $format = 'json', ?string $styleguide = null): void
     {
-        $sitePackageKey = $packageKey ?: $this->getDefaultSitePackageKey();
-
-        $fusionAst = $this->fusionService->getMergedFusionObjectTreeForSitePackage($sitePackageKey);
-        $styleguideObjects = $this->fusionService->getStyleguideObjectsFromFusionAst($fusionAst);
-
+        $styleguide =  $styleguide ? $this->styleguideRepository->getStyleGuide(StyleguideAddress::fromString($styleguide)) : $this->styleguideRepository->getDefault();
+        $styleguideObjects =  $styleguide->getStyleguideObjectList();
+        $styleguideObjects = json_decode(json_encode($styleguideObjects, JSON_THROW_ON_ERROR), true, 512, JSON_THROW_ON_ERROR);
         $this->outputData($styleguideObjects, $format);
     }
 
     /**
      * Render a given fusion component to HTML
      *
-     * @param string $prototypeName The prototype name of the component
-     * @param string|null $packageKey site-package (defaults to first found)
+     * @param string $styleguide The prototype name of the component
+     * @param string $item site-package (defaults to first found)
      * @param string|null $useCase The useCase for the preview
      * @param string|null $propSet The propSet used for the preview
-     * @param string|null  $props Custom props for the preview
+     * @param string|null $props Custom props for the preview
      * @param string|null $locales Custom locales for the preview
      * @return void
      */
-    public function renderCommand($prototypeName, $packageKey = null, ?string $useCase = '__default', ?string $propSet = '__default', ?string $props = '', ?string $locales = '')
+    public function renderCommand(string $styleguide, string $item, ?string $useCase = '__default', ?string $propSet = '__default', ?string $props = '', ?string $locales = '')
     {
-        $sitePackageKey = $packageKey ?: $this->getDefaultSitePackageKey();
-        $convertedProps = json_decode($props, true) ?? [];
-        $convertedLocales = json_decode($locales, true) ?? [];
-
-        $controllerContext = $this->createDummyControllerContext();
-
-        $fusionView = new FusionView();
-        $fusionView->setControllerContext($controllerContext);
-        $fusionView->setPackageKey($sitePackageKey);
-
-        $fusionRootPath = $this->configurationService->getSiteConfiguration($sitePackageKey, ['cli', 'fusionRootPath']);
-
-        $fusionView->setPackageKey($sitePackageKey);
-        $fusionView->setFusionPath($fusionRootPath);
-
-        if ($useCase == '__default') {
-            $useCase = null;
-        }
-
-        if ($propSet == '__default') {
-            $propSet = null;
-        }
-
-        $fusionView->assignMultiple([
-            'sitePackageKey' => $packageKey,
-            'prototypeName' => $prototypeName,
-            'useCase' => $useCase,
-            'propSet' => $propSet,
-            'props' => $convertedProps,
-            'locales' => $convertedLocales
-        ]);
-        $result = $fusionView->render();
-        if ($result instanceof ResponseInterface) {
-            return (string) $result->getBody();
-        }
-        if ($result instanceof StreamInterface) {
-            return (string) $result;
-        }
-        // support for Neos 8.3
-        $this->output($result);
+        $styleguide = $this->styleguideRepository->getStyleGuide(StyleguideAddress::fromString($styleguide));
+        $styleguide->renderStyleguideObject(
+            StyleguideObjectIdentifier::fromString($item),
+            json_decode($props, true) ?? [],
+            $propSet ? PropSetName::fromString($propSet) : null,
+            $useCase ? UseCaseName::fromString($useCase) : null,
+            json_decode($locales, true) ?? []
+        );
     }
 
     protected function outputData($data, $format)