feat: sitekit resource loader

.phplint.yml

@@ -1,6 +1,6 @@
 path: ./src
 jobs: 10
-cache: .cache/phplint.cache
+cache: var/cache/phplint.cache
 extensions:
     - php
 warning: false

phpstan.neon.dist

@@ -1,5 +1,5 @@
 parameters:
     level: 9
-    tmpDir: .cache/phpstan
+    tmpDir: var/cache/phpstan
     paths:
         - src

phpunit.xml

@@ -14,7 +14,7 @@
 		</report>
 	</coverage>
 
-	<testsuite name="atoolo-resource-loader">
+	<testsuite name="atoolo-resource">
 		<directory>test/</directory>
 	</testsuite>
 

src/Exception/InvalidResourceException.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Exception;
+
+/**
+ * This exception is used when a resource is invalid. This can have the
+ * following reasons:
+ *
+ * - If the resource is syntactically incorrect.
+ * - If the resource does not contain necessary data.
+ */
+class InvalidResourceException extends \RuntimeException
+{
+    public function __construct(
+        private readonly string $location,
+        string $message = "",
+        int $code = 0,
+        ?\Throwable $previous = null
+    ) {
+        parent::__construct(
+            $location . ': ' . $message,
+            $code,
+            $previous
+        );
+    }
+
+    public function getLocation(): string
+    {
+        return $this->location;
+    }
+}

src/Exception/ResourceNotFoundException.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Exception;
+
+/**
+ * This exception is used if no resource could be found via the specified
+ * location.
+ */
+class ResourceNotFoundException extends \RuntimeException
+{
+    public function __construct(
+        private readonly string $location,
+        string $message = "",
+        int $code = 0,
+        ?\Throwable $previous = null
+    ) {
+        parent::__construct(
+            $location . ': ' . $message,
+            $code,
+            $previous
+        );
+    }
+
+    public function getLocation(): string
+    {
+        return $this->location;
+    }
+}

src/Loader/SiteKit/ContextStub.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Loader\SiteKit;
+
+/**
+ * Provides the behavior of a context needed to load a SiteKit resource.
+ * @codeCoverageIgnore
+ */
+class ContextStub
+{
+    public function redirectToTranslation(
+        LifecylceStub $lifecylce,
+        string $path
+    ): mixed {
+        return null;
+    }
+}

src/Loader/SiteKit/LifecylceStub.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Loader\SiteKit;
+
+/**
+ * Provides the behavior of a lifecylce needed to load a SiteKit resource.
+ * @codeCoverageIgnore
+ */
+class LifecylceStub
+{
+    /**
+     * @param array<string, mixed> $data
+     */
+    public function init(array $data): ResourceStub
+    {
+        $resource = new ResourceStub();
+        $resource->init($data);
+        return $resource;
+    }
+
+    public function finish(ResourceStub $resource): bool
+    {
+        return false;
+    }
+
+    public function process(string $name, ResourceStub $resource): bool
+    {
+        return true;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function service(ResourceStub $resource): array
+    {
+        return $resource->getData();
+    }
+}

src/Loader/SiteKit/ResourceStub.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Loader\SiteKit;
+
+/**
+ * Provides the behavior of a resource needed to load a SiteKit resource.
+ * @codeCoverageIgnore
+ */
+class ResourceStub
+{
+    /**
+     * @var array<string, mixed>
+     */
+    private array $data = [];
+
+    /**
+     * @param array<string, mixed> $data
+     */
+    public function init(array $data): void
+    {
+        $this->data['init'] = $data;
+    }
+
+    /**
+     * @param array<string, mixed> $data
+     */
+    public function process(string $name, array $data): void
+    {
+        $this->data[$name] = $data;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}

src/Loader/SiteKitLoader.php

@@ -0,0 +1,151 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Loader;
+
+use Atoolo\Resource\Exception\InvalidResourceException;
+use Atoolo\Resource\Exception\ResourceNotFoundException;
+use Atoolo\Resource\Loader\SiteKit\ContextStub;
+use Atoolo\Resource\Loader\SiteKit\LifecylceStub;
+use Atoolo\Resource\Resource;
+use Atoolo\Resource\ResourceLoader;
+
+/**
+ * ResourceLoader that loads resources created with SiteKit aggregators.
+ * @phpstan-type InitData array{id: int, name: string, objectType: string}
+ * @phpstan-type ResourceData array{init: InitData}
+ */
+class SiteKitLoader implements ResourceLoader
+{
+    public function __construct(
+        private readonly string $basePath
+    ) {
+    }
+
+    /**
+     * @throws InvalidResourceException
+     * @throws ResourceNotFoundException
+     */
+    public function load(string $location): Resource
+    {
+        $data = $this->loadRaw($location);
+
+        $this->validateData($location, $data);
+
+        $init = $data['init'];
+
+        return new Resource(
+            $location,
+            (string)$init['id'],
+            $init['name'],
+            $init['objectType'],
+            $data
+        );
+    }
+
+    /**
+     * @return array<string, mixed> $data
+     */
+    private function loadRaw(string $location): array
+    {
+        $file = $this->basePath . '/' . $location;
+
+        /**
+         * $context and $lifecycle must be defined here, because for the SiteKit
+         * resource PHP files these variables must be provided for the require
+         * call.
+         */
+        $context = new ContextStub();
+        $lifecycle = new LifecylceStub();
+
+        $saveErrorReporting = error_reporting();
+
+        try {
+            error_reporting(E_ERROR | E_PARSE);
+            return require $file;
+        } catch (\ParseError $e) {
+            throw new InvalidResourceException(
+                $location,
+                $e->getMessage(),
+                0,
+                $e
+            );
+        } catch (\Error $e) {
+            if (!file_exists($file)) {
+                throw new ResourceNotFoundException(
+                    $location,
+                    $e->getMessage(),
+                    0,
+                    $e
+                );
+            }
+            throw new InvalidResourceException(
+                $location,
+                $e->getMessage(),
+                0,
+                $e
+            );
+        } finally {
+            error_reporting($saveErrorReporting);
+        }
+    }
+
+    /**
+     * @param array<string, mixed> $data
+     * @return ($data is ResourceData ? void : never)
+     */
+    private function validateData(string $location, array $data): void
+    {
+
+        /*
+         * Cannot be passed because this case cannot occur here. This would
+         * already lead to an error in ResourceStub. But is still included,
+         * that so no phpstan errors arise.
+         */
+        // @codeCoverageIgnoreStart
+        if (!isset($data['init']) || !is_array($data['init'])) {
+            throw new InvalidResourceException($location, 'init field missing');
+        }
+        // @codeCoverageIgnoreEnd
+
+        $init = $data['init'];
+
+        if (!isset($init['id'])) {
+            throw new InvalidResourceException(
+                $location,
+                'id field missing'
+            );
+        }
+        if (!is_int($init['id'])) {
+            throw new InvalidResourceException(
+                $location,
+                'id field not an int'
+            );
+        }
+        if (!isset($init['name'])) {
+            throw new InvalidResourceException(
+                $location,
+                'name field missing'
+            );
+        }
+        if (!is_string($init['name'])) {
+            throw new InvalidResourceException(
+                $location,
+                'name field not a string'
+            );
+        }
+        if (!isset($init['objectType'])) {
+            throw new InvalidResourceException(
+                $location,
+                'objectType field missing'
+            );
+        }
+        if (!is_string($init['objectType'])) {
+            throw new InvalidResourceException(
+                $location,
+                'objectType field not a string'
+            );
+        }
+    }
+}