Extend compatibility with newer version of psr/log:"^1.1.2|^2.0|^3.0"

.gitignore

@@ -7,3 +7,4 @@
 /vendor/
 .phpunit.result.cache
 .phpcs-cache
+.idea

composer.json

@@ -35,7 +35,7 @@
         "php": "~8.0.0 || ~8.1.0 || ~8.2.0",
         "laminas/laminas-servicemanager": "^3.3.0",
         "laminas/laminas-stdlib": "^3.0",
-        "psr/log": "^1.1.2"
+        "psr/log": "^1.1.2|^2.0|^3.0"
     },
     "require-dev": {
         "ext-dom": "*",

docs/book/installation.md

@@ -0,0 +1,5 @@
+# This Is Only a Placeholder
+
+The content of this page can be found under:
+
+https://github.com/laminas/documentation-theme/blob/master/theme/pages/installation.html

mkdocs.yml

@@ -3,6 +3,7 @@ site_dir: docs/html
 nav:
     - Home: index.md
     - Introduction: intro.md
+    - Installation: installation.md
     - Reference:
       - Writers: writers.md
       - Filters: filters.md
@@ -15,3 +16,6 @@ site_description: 'Robust, composite logger with filtering, formatting, and PSR-
 repo_url: 'https://github.com/laminas/laminas-log'
 extra:
     project: Components
+    installation:
+      config_provider_class: 'Laminas\Log\ConfigProvider'
+      module_class: 'Laminas\Log\Module'

src/PsrLoggerAdapter.php

@@ -22,17 +22,15 @@ class PsrLoggerAdapter extends PsrAbstractLogger
 {
     /**
      * Laminas\Log logger
-     *
-     * @var LoggerInterface
      */
-    protected $logger;
+    protected LoggerInterface $logger;
 
     /**
      * Map PSR-3 LogLevels to priority
      *
      * @var array
      */
-    protected $psrPriorityMap = [
+    protected array $psrPriorityMap = [
         LogLevel::EMERGENCY => Logger::EMERG,
         LogLevel::ALERT     => Logger::ALERT,
         LogLevel::CRITICAL  => Logger::CRIT,
@@ -53,10 +51,8 @@ public function __construct(LoggerInterface $logger)
 
     /**
      * Returns composed LoggerInterface instance.
-     *
-     * @return LoggerInterface
      */
-    public function getLogger()
+    public function getLogger(): LoggerInterface
     {
         return $this->logger;
     }
@@ -67,16 +63,17 @@ public function getLogger()
      * @param mixed  $level
      * @param string $message
      * @param array  $context
-     * @return void
      * @throws InvalidArgumentException If log level is not recognized.
      */
-    public function log($level, $message, array $context = [])
+    public function log($level, $message, array $context = []): void
     {
         if (! array_key_exists($level, $this->psrPriorityMap)) {
-            throw new InvalidArgumentException(sprintf(
-                '$level must be one of PSR-3 log levels; received %s',
-                var_export($level, true)
-            ));
+            throw new InvalidArgumentException(
+                sprintf(
+                    '$level must be one of PSR-3 log levels; received %s',
+                    var_export($level, true)
+                )
+            );
         }
 
         $priority = $this->psrPriorityMap[$level];

test/Psr/DummyTest.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasTest\Log\Psr;
+
+/**
+ * This class is internal and does not follow the BC promise.
+ *
+ * Do NOT use this class in any way.
+ *
+ * @internal
+ */
+class DummyTest
+{
+    public function __toString()
+    {
+        return 'DummyTest';
+    }
+}

test/PsrLoggerAdapterTest.php

@@ -4,24 +4,29 @@
 
 namespace LaminasTest\Log;
 
+use DateTime;
 use Laminas\Log\Logger;
 use Laminas\Log\PsrLoggerAdapter;
 use Laminas\Log\Writer\Mock as MockWriter;
+use LogicException;
+use PHPUnit\Framework\TestCase;
 use Psr\Log\InvalidArgumentException;
+use Psr\Log\LoggerInterface as PsrLoggerInterface;
 use Psr\Log\LogLevel;
-use Psr\Log\Test\LoggerInterfaceTest;
 
 use function array_flip;
 use function array_map;
+use function fclose;
+use function fopen;
 
 /**
  * @coversDefaultClass \Laminas\Log\PsrLoggerAdapter
  * @covers ::<!public>
  */
-class PsrLoggerAdapterTest extends LoggerInterfaceTest
+class PsrLoggerAdapterTest extends TestCase
 {
     /** @var array */
-    protected $psrPriorityMap = [
+    protected array $psrPriorityMap = [
         LogLevel::EMERGENCY => Logger::EMERG,
         LogLevel::ALERT     => Logger::ALERT,
         LogLevel::CRITICAL  => Logger::CRIT,
@@ -32,17 +37,20 @@ class PsrLoggerAdapterTest extends LoggerInterfaceTest
         LogLevel::DEBUG     => Logger::DEBUG,
     ];
 
+    private ?MockWriter $mockWriter = null;
+
     /**
      * Provides logger for LoggerInterface compat tests
      *
      * @return PsrLoggerAdapter
      */
-    public function getLogger()
+    public function getLogger(): PsrLoggerInterface
     {
         $this->mockWriter = new MockWriter();
         $logger           = new Logger();
         $logger->addProcessor('psrplaceholder');
         $logger->addWriter($this->mockWriter);
+
         return new PsrLoggerAdapter($logger);
     }
 
@@ -55,18 +63,20 @@ public function getLogger()
      *
      * @return string[]
      */
-    public function getLogs()
+    public function getLogs(): array
     {
         $prefixMap = array_flip($this->psrPriorityMap);
+
         return array_map(function ($event) use ($prefixMap) {
             $prefix = $prefixMap[$event['priority']];
+
             return $prefix . ' ' . $event['message'];
         }, $this->mockWriter->events);
     }
 
     protected function tearDown(): void
     {
-        unset($this->mockWriter);
+        $this->mockWriter = null;
     }
 
     /**
@@ -91,7 +101,7 @@ public function testPsrLogLevelsMapsToPriorities($logLevel, $priority): void
         $context = ['bar' => 'baz'];
 
         $logger = $this->getMockBuilder(Logger::class)
-            ->setMethods(['log'])
+            ->onlyMethods(['log'])
             ->getMock();
         $logger->expects($this->once())
             ->method('log')
@@ -110,7 +120,7 @@ public function testPsrLogLevelsMapsToPriorities($logLevel, $priority): void
      *
      * @return array
      */
-    public function logLevelsToPriorityProvider()
+    public function logLevelsToPriorityProvider(): array
     {
         $return = [];
         foreach ($this->psrPriorityMap as $level => $priority) {
@@ -125,4 +135,97 @@ public function testThrowsOnInvalidLevel()
         $this->expectException(InvalidArgumentException::class);
         $logger->log('invalid level', 'Foo');
     }
+
+    public function testImplements()
+    {
+        $this->assertInstanceOf(PsrLoggerInterface::class, $this->getLogger());
+    }
+
+    /**
+     * @dataProvider provideLevelsAndMessages
+     */
+    public function testLogsAtAllLevels($level, $message)
+    {
+        $logger = $this->getLogger();
+        $logger->{$level}($message, ['user' => 'Bob']);
+        $logger->log($level, $message, ['user' => 'Bob']);
+
+        $expected = [
+            $level . ' message of level ' . $level . ' with context: Bob',
+            $level . ' message of level ' . $level . ' with context: Bob',
+        ];
+        $this->assertEquals($expected, $this->getLogs());
+    }
+
+    public function provideLevelsAndMessages(): array
+    {
+        return [
+            LogLevel::EMERGENCY => [LogLevel::EMERGENCY, 'message of level emergency with context: {user}'],
+            LogLevel::ALERT     => [LogLevel::ALERT, 'message of level alert with context: {user}'],
+            LogLevel::CRITICAL  => [LogLevel::CRITICAL, 'message of level critical with context: {user}'],
+            LogLevel::ERROR     => [LogLevel::ERROR, 'message of level error with context: {user}'],
+            LogLevel::WARNING   => [LogLevel::WARNING, 'message of level warning with context: {user}'],
+            LogLevel::NOTICE    => [LogLevel::NOTICE, 'message of level notice with context: {user}'],
+            LogLevel::INFO      => [LogLevel::INFO, 'message of level info with context: {user}'],
+            LogLevel::DEBUG     => [LogLevel::DEBUG, 'message of level debug with context: {user}'],
+        ];
+    }
+
+    public function testContextReplacement()
+    {
+        $logger = $this->getLogger();
+        $logger->info('{Message {nothing} {user} {foo.bar} a}', ['user' => 'Bob', 'foo.bar' => 'Bar']);
+
+        $expected = ['info {Message {nothing} Bob Bar a}'];
+        $this->assertEquals($expected, $this->getLogs());
+    }
+
+    public function testObjectCastToString()
+    {
+        $dummy = $this->createPartialMock(Psr\DummyTest::class, ['__toString']);
+        $dummy->expects($this->once())
+            ->method('__toString')
+            ->will($this->returnValue('DUMMY'));
+
+        $this->getLogger()->warning($dummy);
+
+        $expected = ['warning DUMMY'];
+        $this->assertEquals($expected, $this->getLogs());
+    }
+
+    public function testContextCanContainAnything()
+    {
+        $closed = fopen('php://memory', 'r');
+        fclose($closed);
+
+        $context = [
+            'bool'     => true,
+            'null'     => null,
+            'string'   => 'Foo',
+            'int'      => 0,
+            'float'    => 0.5,
+            'nested'   => ['with object' => new Psr\DummyTest()],
+            'object'   => new DateTime(),
+            'resource' => fopen('php://memory', 'r'),
+            'closed'   => $closed,
+        ];
+
+        $this->getLogger()->warning('Crazy context data', $context);
+
+        $expected = ['warning Crazy context data'];
+        $this->assertEquals($expected, $this->getLogs());
+    }
+
+    public function testContextExceptionKeyCanBeExceptionOrOtherValues()
+    {
+        $logger = $this->getLogger();
+        $logger->warning('Random message', ['exception' => 'oops']);
+        $logger->critical('Uncaught Exception!', ['exception' => new LogicException('Fail')]);
+
+        $expected = [
+            'warning Random message',
+            'critical Uncaught Exception!',
+        ];
+        $this->assertEquals($expected, $this->getLogs());
+    }
 }

test/WriterPluginManagerTest.php

@@ -4,6 +4,7 @@
 
 namespace LaminasTest\Log;
 
+use Laminas\Log\Writer\FirePhp;
 use Laminas\Log\WriterPluginManager;
 use Laminas\ServiceManager\ServiceManager;
 use PHPUnit\Framework\TestCase;
@@ -21,6 +22,6 @@ protected function setUp(): void
     public function testInvokableClassFirephp(): void
     {
         $firephp = $this->plugins->get('firephp');
-        $this->assertInstanceOf('Laminas\Log\Writer\Firephp', $firephp);
+        $this->assertInstanceOf(FirePhp::class, $firephp);
     }
 }