Update CI to enforce PSR12

Author: devdot

.github/workflows/php.yml

@@ -31,6 +31,9 @@ jobs:
 
     - name: Install dependencies
       run: composer install --prefer-dist --no-progress
+    
+    - name: PHP Lint
+      run: vendor/bin/phpcs --standard=PSR12 -n src
 
     - name: PHPUnit tests
       run: vendor/bin/phpunit tests

.gitlab-ci.yml

@@ -1,20 +1,22 @@
-# Select image from https://hub.docker.com/_/php
-image: thomasschaller/php-test:8.1
+default:
+  image: serversideup/php:8.1-cli
+
+stages:
+  - test
 
-# cache vendor files for increased performance
 cache:
   paths:
-    - vendor/
-
-before_script:
-  # Install dependencies
-  # - bash ci/docker_install.sh > /dev/null
-  - composer install
+   - vendor/
 
-phpunit:
+test_phpunit:
+  stage: test
   script:
+    - composer install
     - vendor/bin/phpunit tests
 
-phpstan:
+test_quality:
+  stage: test
   script:
-    - vendor/bin/phpstan analyze src --level=9
+    - composer install
+    - vendor/bin/phpcs --standard=PSR12 -n src
+    - vendor/bin/phpstan analyse src --level=9

captainhook.json

@@ -2,6 +2,10 @@
     "pre-commit": {
         "enabled": true,
         "actions": [
+            {
+                "action": "vendor/bin/phpcbf --standard=PSR12 src",
+                "options": []
+            },
             {
                 "action": "vendor/bin/phpunit tests",
                 "options": []

composer.json

@@ -26,6 +26,7 @@
         "phpunit/phpunit": "^10",
         "monolog/monolog": "2.*",
         "phpstan/phpstan": "^1.10",
-        "captainhook/captainhook": "^5.16"
+        "captainhook/captainhook": "^5.16",
+        "squizlabs/php_codesniffer": "^3.7"
     }
 }

composer.lock

@@ -2,10 +2,12 @@
 
 namespace Devdot\Monolog\Exceptions;
 
-class FileNotFoundException extends \Exception {
-    public function __construct(string $filename) {
+class FileNotFoundException extends \Exception
+{
+    public function __construct(string $filename)
+    {
         parent::__construct(
-            'File not found: '.$filename,
+            'File not found: ' . $filename,
         );
     }
 }

src/Exceptions/FileNotFoundException.php

@@ -2,10 +2,12 @@
 
 namespace Devdot\Monolog\Exceptions;
 
-class LogParsingException extends \Exception {
-    public function __construct(string $filename, string $extra = null) {
+class LogParsingException extends \Exception
+{
+    public function __construct(string $filename, string $extra = null)
+    {
         parent::__construct(
-            'Failed to parse '.$filename.($extra ? PHP_EOL.$extra : '')
+            'Failed to parse ' . $filename . ($extra ? PHP_EOL . $extra : '')
         );
     }
 }

src/Exceptions/LogParsingException.php

@@ -2,8 +2,10 @@
 
 namespace Devdot\Monolog\Exceptions;
 
-class ParserNotReadyException extends \Exception {
-    public function __construct() {
+class ParserNotReadyException extends \Exception
+{
+    public function __construct()
+    {
         parent::__construct(
             'Parser is not ready!'
         );

src/Exceptions/ParserNotReadyException.php

@@ -9,13 +9,15 @@
  * @author Thomas Kuschan
  * @copyright (c) 2023
  */
-class Log extends \ArrayIterator implements \ArrayAccess {
+class Log extends \ArrayIterator implements \ArrayAccess
+{
     /**
      * Create a Log from a group of records
      * @param LogRecord ...$records One or more log entries
      * @no-named-arguments This will disallow named parameters and force $records to array<int, LogRecord>
      */
-    public function __construct(LogRecord ...$records) {
+    public function __construct(LogRecord ...$records)
+    {
         parent::__construct($records);
     }
 
@@ -24,9 +26,11 @@ public function __construct(LogRecord ...$records) {
      * @param bool $ascending Sorting order, defaults to false (meaning it sorts descending)
      * @return void
      */
-    public function sortByDatetime(bool $ascending = false): void {
-        if (count($this) == 0)
+    public function sortByDatetime(bool $ascending = false): void
+    {
+        if (count($this) == 0) {
             return;
+        }
 
         // get the stored elements and rebuild the log
         $array = $this->getArrayCopy();
@@ -39,12 +43,13 @@ public function sortByDatetime(bool $ascending = false): void {
         if ($ascending) {
             $array = array_reverse($array);
         }
-        
+
         // finally set this array as the new content for us
         parent::__construct($array);
     }
 
-    public function current(): LogRecord {
+    public function current(): LogRecord
+    {
         return parent::current();
     }
 
@@ -54,14 +59,16 @@ public function current(): LogRecord {
      * @throws \OutOfBoundsException When the offset is not defined
      * @return LogRecord
      */
-    public function offsetGet(mixed $offset): LogRecord {
-        if(parent::offsetExists($offset)) {
+    public function offsetGet(mixed $offset): LogRecord
+    {
+        if (parent::offsetExists($offset)) {
             $offset = parent::offsetGet($offset);
-            if ($offset !== null)
+            if ($offset !== null) {
                 return $offset;
+            }
         }
         // exit with exception
-        throw new \OutOfBoundsException('Undefined array key '.$offset);
+        throw new \OutOfBoundsException('Undefined array key ' . $offset);
     }
 
     /**
@@ -71,7 +78,8 @@ public function offsetGet(mixed $offset): LogRecord {
      * @throws \LogicException Always
      * @return void
      */
-    public function offsetSet(mixed $offset, mixed $value): void {
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
         // we do not support setting in any way
         throw new \LogicException('Unsupported operation');
     }
@@ -82,7 +90,8 @@ public function offsetSet(mixed $offset, mixed $value): void {
      * @throws \LogicException Always
      * @return void
      */
-    public function offsetUnset(mixed $offset): void {
+    public function offsetUnset(mixed $offset): void
+    {
         throw new \LogicException('Unsupported operation');
     }
 }

src/Log.php

@@ -8,7 +8,8 @@
  * @author Thomas Kuschan
  * @copyright (c) 2023
  */
-class LogRecord implements \ArrayAccess {
+class LogRecord implements \ArrayAccess
+{
     /**
      * Create a LogRecord to hold a single log entry.
      * @param \DateTimeImmutable $datetime
@@ -23,27 +24,31 @@ public function __construct(
         public readonly string $channel,
         public readonly string $level,
         public readonly string $message,
-        public readonly array|\stdClass|string|NULL $context = [],
-        public readonly array|\stdClass|string|NULL $extra = [],
+        public readonly array|\stdClass|string|null $context = [],
+        public readonly array|\stdClass|string|null $extra = [],
     ) {
     }
 
-    public function offsetSet(mixed $offset, mixed $value): void {
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
         // we do not support setting in any way
         throw new \LogicException('Unsupported operation');
     }
 
-    public function &offsetGet(mixed $offset): mixed {
+    public function &offsetGet(mixed $offset): mixed
+    {
         // avoid returning readonly props by ref as this is illegal
         $copy = $this->{$offset};
         return $copy;
     }
 
-    public function offsetExists(mixed $offset): bool {
+    public function offsetExists(mixed $offset): bool
+    {
         return isset($this->{$offset});
     }
 
-    public function offsetUnset(mixed $offset): void {
+    public function offsetUnset(mixed $offset): void
+    {
         throw new \LogicException('Unsupported operation');
     }
 }