feat: add psr log exception reporter implementation

Author: lindyhopchris

CHANGELOG.md

@@ -7,6 +7,8 @@ All notable changes to this project will be documented in this file. This projec
 
 ### Added
 
+- New `PsrLogExceptionReporter` provides a default exception reporter implementation that logs the exception as an
+  error.
 - Updated doc block for `Contracts::assert()` to add PHPStan assertion that the precondition is `true` if the method
   call does not throw.
 

docs/guide/infrastructure/exception-reporting.md

@@ -78,6 +78,13 @@ interface ExceptionReporter
 Your infrastructure layer should have an adapter that implements this port. This means you can tie your application
 layer to any logging service you are using.
 
+### PSR Log Implementation
+
+If all you need to do is log a reported exception as an error, we provide a default implementation that uses a PSR
+logger. The implementation is: `CloudCreativity\Modules\Infrastructure\ExceptionReporter\PsrLogExceptionReporter`
+
+Provide an instance of the PSR Log as the only constructor argument.
+
 ### Laravel Example
 
 For example, it is easy to implement this port in Laravel as it already provides an exception reporter. Our

src/Infrastructure/ExceptionReporter/PsrLogExceptionReporter.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * Copyright 2025 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\Modules\Infrastructure\ExceptionReporter;
+
+use CloudCreativity\Modules\Contracts\Application\Ports\Driven\ExceptionReporter;
+use Psr\Log\LoggerInterface;
+use Throwable;
+
+final class PsrLogExceptionReporter implements ExceptionReporter
+{
+    /**
+     * PsrLogExceptionReporter constructor.
+     *
+     * @param LoggerInterface $logger
+     */
+    public function __construct(private readonly LoggerInterface $logger)
+    {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function report(Throwable $ex): void
+    {
+        $this->logger->error(
+            $ex->getMessage() ?: 'Unexpected error: ' . $ex::class,
+            ['exception' => $ex],
+        );
+    }
+}

tests/Unit/Infrastructure/ExceptionReporter/PsrLogExceptionReporterTest.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * Copyright 2025 Cloud Creativity Limited
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+declare(strict_types=1);
+
+namespace CloudCreativity\Modules\Tests\Unit\Infrastructure\ExceptionReporter;
+
+use CloudCreativity\Modules\Contracts\Application\Ports\Driven\ExceptionReporter;
+use CloudCreativity\Modules\Infrastructure\ExceptionReporter\PsrLogExceptionReporter;
+use LogicException;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+
+class PsrLogExceptionReporterTest extends TestCase
+{
+    /**
+     * @var LoggerInterface&MockObject
+     */
+    private LoggerInterface&MockObject $logger;
+
+    /**
+     * @var PsrLogExceptionReporter
+     */
+    private PsrLogExceptionReporter $reporter;
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->logger = $this->createMock(LoggerInterface::class);
+        $this->reporter = new PsrLogExceptionReporter($this->logger);
+    }
+
+    /**
+     * @return void
+     */
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        unset($this->logger, $this->reporter);
+    }
+
+    public function testItReportsException(): void
+    {
+        $exception = new LogicException('Test exception');
+
+        $this->logger
+            ->expects($this->once())
+            ->method('error')
+            ->with(
+                $exception->getMessage(),
+                ['exception' => $exception],
+            );
+
+        $this->reporter->report($exception);
+
+        $this->assertInstanceOf(ExceptionReporter::class, $this->reporter);
+    }
+
+    public function testItReportsDefaultMessageIfExceptionHasEmptyMessage(): void
+    {
+        $exception = new LogicException();
+
+        $this->logger
+            ->expects($this->once())
+            ->method('error')
+            ->with(
+                'Unexpected error: LogicException',
+                ['exception' => $exception],
+            );
+
+        $this->reporter->report($exception);
+
+        $this->assertInstanceOf(ExceptionReporter::class, $this->reporter);
+    }
+}