fix: errors and warnings

.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

src/Exceptions/InvalidResource.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Exceptions;
+
+/**
+ * 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 InvalidResource 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/Exceptions/ResourceNotFound.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Atoolo\Resource\Exceptions;
+
+/**
+ * This exception is used if no resource could be found via the specified
+ * location.
+ */
+class ResourceNotFound 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

@@ -4,6 +4,10 @@
 
 namespace Atoolo\Resource\Loader\SiteKit;
 
+/**
+ * Provides the behavior of a context needed to load a SiteKit resource.
+ * @codeCoverageIgnore
+ */
 class ContextStub
 {
     public function redirectToTranslation(

src/Loader/SiteKit/LifecylceStub.php

@@ -4,8 +4,15 @@
 
 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();
@@ -23,6 +30,9 @@ 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

@@ -4,20 +4,36 @@
 
 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 = [];
 
-    public function init($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

@@ -4,50 +4,85 @@
 
 namespace Atoolo\Resource\Loader;
 
-use Atoolo\Resource\Exceptions\InvalidData;
+use Atoolo\Resource\Exceptions\InvalidResource;
+use Atoolo\Resource\Exceptions\ResourceNotFound;
 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.
+ */
 class SiteKitLoader implements ResourceLoader
 {
-    public function __construct(private string $base)
-    {
+    public function __construct(
+        private readonly string $base
+    ) {
     }
 
     public function load(string $location): Resource
     {
-        $data = $this->loadRaw($this->base . '/' . $location);
+        $data = $this->loadRaw($location);
+
+        $this->validateData($location, $data);
 
-        $this->validateData($data);
+        $init = (array)$data['init'];
 
         return new Resource(
             $location,
-            (string)$data['init']['id'],
-            $data['init']['name'],
-            $data['init']['objectType'],
+            (string)$init['id'],  // @phpstan-ignore-line
+            $init['name'], // @phpstan-ignore-line
+            $init['objectType'], // @phpstan-ignore-line
             $data
         );
     }
 
-    private function loadRaw(string $file): array
+    /**
+     * @return array<string, mixed>
+     */
+    private function loadRaw(string $location): array
     {
+        $file = $this->base . '/' . $location;
+
         $context = new ContextStub();
         $lifecycle = new LifecylceStub();
-        return include $file;
+
+        $saveErrorReporting = error_reporting();
+
+        try {
+            error_reporting(E_ERROR | E_PARSE);
+            return require $file;
+        } catch (\ParseError $e) {
+            throw new InvalidResource($location, $e->getMessage(), 0, $e);
+        } catch (\Error $e) {
+            if (!file_exists($file)) {
+                throw new ResourceNotFound($location, $e->getMessage(), 0, $e);
+            }
+            throw new InvalidResource($location, $e->getMessage(), 0, $e);
+        } finally {
+            error_reporting($saveErrorReporting);
+        }
     }
 
-    private function validateData(array $data): void
+    /**
+     * @param array<string, mixed> $data
+     */
+    private function validateData(string $location, array $data): void
     {
-        if (!isset($data['init']['id'])) {
-            throw new InvalidData('id field missing');
+        $init = $data['init'];
+        if (!is_array($init)) {
+            throw new InvalidResource($location, 'missing init array');
+        }
+
+        if (!isset($init['id'])) {
+            throw new InvalidResource($location, 'id field missing');
         }
-        if (!isset($data['init']['name'])) {
-            throw new InvalidData('name field missing');
+        if (!isset($init['name'])) {
+            throw new InvalidResource($location, 'name field missing');
         }
-        if (!isset($data['init']['objectType'])) {
-            throw new InvalidData('objectType field missing');
+        if (!isset($init['objectType'])) {
+            throw new InvalidResource($location, 'objectType field missing');
         }
     }
 }

src/Resource.php

@@ -4,8 +4,15 @@
 
 namespace Atoolo\Resource;
 
+/**
+ * In the Atoolo context, resources are aggregated data from
+ * IES (Sitepark's content management system).
+ */
 class Resource
 {
+    /**
+     * @param array<string, mixed> $data
+     */
     public function __construct(
         private readonly string $location,
         private readonly string $id,
@@ -40,11 +47,14 @@ public function getData(string $name): mixed
         return $this->findData($this->data, $name);
     }
 
+    /**
+     * @param array<string, mixed> $data
+     */
     private function findData(array $data, string $name): mixed
     {
         $names = explode('.', $name);
         foreach ($names as $n) {
-            if (isset($data[$n])) {
+            if (is_array($data) && isset($data[$n])) {
                 $data = $data[$n];
             } else {
                 return null;

src/ResourceLoader.php

@@ -4,6 +4,10 @@
 
 namespace Atoolo\Resource;
 
+/**
+ * The ResourceLoader interface defines the method used to load resources from a
+ * given location.
+ */
 interface ResourceLoader
 {
     public function load(string $location): Resource;

test/Loader/SiteKitLoaderTest.php

@@ -2,7 +2,8 @@
 
 namespace Atoolo\Resource\Test\Loader;
 
-use Atoolo\Resource\Exceptions\InvalidData;
+use Atoolo\Resource\Exceptions\InvalidResource;
+use Atoolo\Resource\Exceptions\ResourceNotFound;
 use Atoolo\Resource\Loader\SiteKitLoader;
 use Atoolo\Resource\Resource;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -19,7 +20,7 @@ protected function setUp(): void
         $this->loader = new SiteKitLoader($base);
     }
 
-    public function testLoad(): void
+    public function testLoadValidResource(): void
     {
         $resource = $this->loader->load('validResource.php');
         $this->assertEquals(
@@ -29,21 +30,33 @@ public function testLoad(): void
         );
     }
 
+    public function testLoadMissingLocation(): void
+    {
+        $this->expectException(ResourceNotFound::class);
+        $this->loader->load('notfound.php');
+    }
+
+    public function testLoadResourceWithCompileError(): void
+    {
+        $this->expectException(InvalidResource::class);
+        $this->loader->load('compileError.php');
+    }
+
     public function testLoadWithMissingId(): void
     {
-        $this->expectException(InvalidData::class);
+        $this->expectException(InvalidResource::class);
         $this->loader->load('missingIdResource.php');
     }
 
     public function testLoadWithMissingName(): void
     {
-        $this->expectException(InvalidData::class);
+        $this->expectException(InvalidResource::class);
         $this->loader->load('missingNameResource.php');
     }
 
     public function testLoadWithMissingObjectType(): void
     {
-        $this->expectException(InvalidData::class);
+        $this->expectException(InvalidResource::class);
         $this->loader->load('missingObjectTypeResource.php');
     }
 }