Merge pull request #3 from jonathanjfshaw/support-ints

Allow integer log levels

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
 
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: 8.0
                   coverage: none
                   tools: composer:v2, cs2pr
 
@@ -34,17 +34,6 @@ jobs:
                 stable: [true]
                 coverage: [true]
                 composer-flags: ['', '--prefer-lowest']
-                include:
-                    - php: '7.4'
-                      psrlog: '^1.0'
-                      stable: true
-                      coverage: true
-                      composer-flags: ''
-                    - php: '7.4'
-                      psrlog: '^1.0'
-                      stable: true
-                      coverage: true
-                      composer-flags: '--prefer-lowest'
 
         steps:
             - uses: actions/checkout@v2
@@ -80,7 +69,7 @@ jobs:
 
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: 8.0
                   coverage: none
                   tools: composer:v2
 
@@ -97,7 +86,7 @@ jobs:
 
             - uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: 8.0
                   coverage: none
                   tools: composer:v2
 

CHANGELOG.md

@@ -4,6 +4,22 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
 
 ## [Unreleased][unreleased]
 
+### Added
+
+ - Added support for custom string- and int-based log levels (#2)
+
+### Changed
+
+ - Minimum PHP version is now 8.0
+
+### Fixed
+
+ - Fixed `log()` not throwing the correct exception when an invalid log level is passed
+
+### Removed
+
+ - Removed support for PHP 7.4
+
 ## [1.1.0] - 2022-04-27
 
 ### Fixed
@@ -15,6 +31,6 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
 
 **Initial commit!**
 
-[Unreleased]: https://github.com/colinodell/psr-testlogger/compare/v1.1.0...main
+[unreleased]: https://github.com/colinodell/psr-testlogger/compare/v1.1.0...main
 [1.1.0]: https://github.com/colinodell/psr-testlogger/compare/v1.0.0...main
 [1.0.0]: https://github.com/colinodell/psr-testlogger/releases/tag/v1.0.0

README.md

@@ -13,7 +13,7 @@ PSR-3 compliant test logger based on psr/log v1's, but compatible with v2 and v3
 
 ## 📦 Installation
 
-This project requires PHP 7.4 or higher.  To install it via Composer simply run:
+This project requires PHP 8.0 or higher.  To install it via Composer simply run:
 
 ``` bash
 $ composer require --dev colinodell/psr-testlogger

composer.json

@@ -19,7 +19,7 @@
         "source": "https://github.com/colinodell/psr-testlogger"
     },
     "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.0",
         "psr/log": "^1.0 || ^2.0 || ^3.0"
     },
     "provide": {

src/TestLogger.php

@@ -5,7 +5,7 @@
 namespace ColinODell\PsrTestLogger;
 
 use Psr\Log\AbstractLogger;
-use Psr\Log\LogLevel;
+use Psr\Log\InvalidArgumentException;
 
 /**
  * Used for testing purposes.
@@ -62,7 +62,7 @@ final class TestLogger extends AbstractLogger
     /** @var array<int, array<string, mixed>> */
     public array $records = [];
 
-    /** @var array<int|string, array<int, array<string, mixed>>> */
+    /** @var array<string|int, array<int, array<string, mixed>>> */
     public array $recordsByLevel = [];
 
     /**
@@ -72,6 +72,10 @@ final class TestLogger extends AbstractLogger
      */
     public function log($level, $message, array $context = []): void
     {
+        if (! (\is_string($level) || \is_int($level))) {
+            throw new InvalidArgumentException('Unsupported log level. The psr-testlogger library only supports string and integer log levels; passed ' . \print_r($level, true));
+        }
+
         $record = [
             'level' => $level,
             'message' => $message,
@@ -82,19 +86,15 @@ public function log($level, $message, array $context = []): void
         $this->records[]                          = $record;
     }
 
-    /**
-     * @param LogLevel::* $level
-     */
-    public function hasRecords(string $level): bool
+    public function hasRecords(string|int $level): bool
     {
         return isset($this->recordsByLevel[$level]);
     }
 
     /**
      * @param string|array<string, mixed> $record
-     * @param LogLevel::*                 $level
      */
-    public function hasRecord($record, string $level): bool
+    public function hasRecord(string|array $record, string|int $level): bool
     {
         if (\is_string($record)) {
             $record = ['message' => $record];
@@ -109,20 +109,14 @@ public function hasRecord($record, string $level): bool
         }, $level);
     }
 
-    /**
-     * @param LogLevel::* $level
-     */
-    public function hasRecordThatContains(string $message, string $level): bool
+    public function hasRecordThatContains(string $message, string|int $level): bool
     {
         return $this->hasRecordThatPasses(static function (array $rec) use ($message) {
-            return \strpos($rec['message'], $message) !== false;
+            return \str_contains($rec['message'], $message);
         }, $level);
     }
 
-    /**
-     * @param LogLevel::* $level
-     */
-    public function hasRecordThatMatches(string $regex, string $level): bool
+    public function hasRecordThatMatches(string $regex, string|int $level): bool
     {
         return $this->hasRecordThatPasses(static function ($rec) use ($regex) {
             return \preg_match($regex, $rec['message']) > 0;
@@ -131,9 +125,8 @@ public function hasRecordThatMatches(string $regex, string $level): bool
 
     /**
      * @param callable(array<string, mixed>, int): bool $predicate
-     * @param LogLevel::*                               $level
      */
-    public function hasRecordThatPasses(callable $predicate, string $level): bool
+    public function hasRecordThatPasses(callable $predicate, string|int $level): bool
     {
         if (! isset($this->recordsByLevel[$level])) {
             return false;
@@ -164,7 +157,7 @@ public function __call(string $method, array $args): bool
             }
         }
 
-        throw new \BadMethodCallException('Call to undefined method ' . static::class . '::' . $method . '()');
+        throw new \BadMethodCallException('Call to undefined method ' . self::class . '::' . $method . '()');
     }
 
     public function reset(): void

tests/unit/TestLoggerTest.php

@@ -6,6 +6,7 @@
 
 use ColinODell\PsrTestLogger\TestLogger;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\InvalidArgumentException;
 use Psr\Log\LogLevel;
 
 final class TestLoggerTest extends TestCase
@@ -136,6 +137,67 @@ public function testCallMagicMethodThatDoesNotExist(): void
         $logger->someMethodThatDoesNotExist(); // @phpstan-ignore-line
     }
 
+    /**
+     * @dataProvider provideInvalidLogLevels
+     */
+    public function testLogWithUnsupportedLevel(mixed $invalidLogLevel): void
+    {
+        $logger = new TestLogger();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Unsupported log level');
+
+        $logger->log($invalidLogLevel, 'Test');
+    }
+
+    /**
+     * @return iterable<string, array{0: mixed}>
+     */
+    public function provideInvalidLogLevels(): iterable
+    {
+        yield 'null' => [null];
+        yield 'bool' => [true];
+        yield 'float' => [1.0];
+        yield 'array' => [[]];
+        yield 'object' => [new \stdClass()];
+        yield 'resource' => [\fopen('php://memory', 'r')];
+        yield 'callable' => [static fn () => null];
+    }
+
+    public function testCustomLogLevels(): void
+    {
+        $recordsToLog = [
+            0 => 'Emergency',
+            1 => 'Alert',
+            2 => 'Critical',
+            3 => 'Error',
+            4 => 'Warning',
+            5 => 'Notice',
+            6 => 'Informational',
+            7 => 'Debug',
+            'super low priority' => 'Super Low Priority',
+        ];
+
+        $logger = new TestLogger();
+
+        foreach ($recordsToLog as $level => $message) {
+            $logger->log($level, $message);
+            $this->assertTrue($logger->hasRecord($message, $level));
+        }
+
+        $this->assertCount(\count($recordsToLog), $logger->records);
+
+        // Custom log levels don't work with the magic methods
+        $this->assertFalse($logger->hasEmergencyRecords());
+        $this->assertFalse($logger->hasAlertRecords());
+        $this->assertFalse($logger->hasCriticalRecords());
+        $this->assertFalse($logger->hasErrorRecords());
+        $this->assertFalse($logger->hasWarningRecords());
+        $this->assertFalse($logger->hasNoticeRecords());
+        $this->assertFalse($logger->hasInfoRecords());
+        $this->assertFalse($logger->hasDebugRecords());
+    }
+
     /**
      * @return iterable<array<mixed>>
      */